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.

    gem install highrise

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

Cookbook

    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.

    @tags = Highrise::Tag.find(:all)

    @people = Highrise::Person.find_all_across_pages(:params => {:tag_id => 12345})

    @person.tag!("VIP")

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

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.

• Marcos Tapajós
• Ken Mayer

[]