highrise

by tapajos

tapajos / highrise

Ruby wrapper around Highrise API.

127 Stars 78 Forks Last release: Not found MIT License 267 Commits 21 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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 configinitializershighrise.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

Contributors

[]

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.