README.md

Highrise (master)

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

• Marcos Tapajós
• Ken Mayer

Contributors

[]