Code Monkey home page Code Monkey logo

highrise's Introduction

Highrise (master) Build Status Code Climate

What is it?

This gem provides a set of classes to access information on Highrise via the published API:

Account, Comment, Company, Deal, DealCategory, Email, Group, Case, Membership,
Note, Party, Person, Recording, Subject, Tag, Task, TaskCategory and User.

All these classes are inherited from ActiveResouce::Base. Refer to the ActiveResouce documentation for more information.

Installing

    gem install highrise

Dependencies (see highrise.gemspec or run bundle check)

Documentation

I'm on rdoc.info (or am I?)

Cookbook

Configure your key

    require 'highrise'
    
    Highrise::Base.site = 'https://your_site.highrisehq.com'
    Highrise::Base.user = 'api-auth-token'
    Highrise::Base.format = :xml

If you are using this in a Rails application, putting this code in a config/initializers/highrise.rb file is recommended. See config_initializers_highrise.rb in the examples/ directory.

Usage

    @tags = Highrise::Tag.find(:all)
    
    @people = Highrise::Person.find_all_across_pages(:params => {:tag_id => 12345})
    
    @person.tag!("VIP")

License

This code is free to be used under the terms of the MIT license.

Bugs, Issues, Kudos and Catcalls

Comments are welcome. Send your feedback through the issue tracker on GitHub

If you have fixes: Submit via pull requests. Do not include version changes to the version file.

Authors

[]

highrise's People

Contributors

amartinfraguas avatar andymorris avatar basvodde avatar bmsatierf avatar chrmod avatar demonbane avatar dior001 avatar jeremy avatar kmayer avatar luisbebop avatar minhajuddin avatar odorcicd avatar rogerio-augusto avatar tapajos avatar thiagolelis avatar tjsousa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.