Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby wrapper around Highrise API.
Ruby
Branch: rails-3
Pull request Compare This branch is even with tapajos:rails-3.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
autotest
examples
lib
spec
.gitignore
Gemfile
Gemfile.lock
MIT-LICENSE
README.mkdn
Rakefile
highrise.gemspec

README.mkdn

Highrise (3.0.0)

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

Configure your key

require 'highrise'

Highrise::Base.site = 'http://your_site.highrisehq.com'
Highrise::Base.user = 'api-auth-token'

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

Contributors

  • [Nicolas Bianco][slainer86]
  • [Luis Gustavo][luisbebop]
  • [Thiago Lelis][ThiagoLelis]
  • Denis Odorcic

References

Something went wrong with that request. Please try again.