Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Ruby wrapper around Highrise API.

branch: master
README.mkdn

Highrise (2.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, Email, Group, Case, Membership, Note, Person, Subject, Tag, Task, User. 

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

Installing

gem install highrise

Dependencies (see the Rakefile or run rake check_dependencies)

Documentation

I'm on rdoc.info and here're some metrics

Configure your key

require 'rubygems'
require 'highrise'

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

and, if you want caching:

Highrise::Base.connection.cache_store= <your normal ActiveSupport::Caching options>

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

Authors

Contributors

Special Thanks

Rails Envy Podcast Episode #77 for mentioning How to Cache Anything With ActiveSupport on the very day I started writing the cache code. Thank you, Rein for writing an excellent tutorial and posting your source on GitHub.

Something went wrong with that request. Please try again.