tapajos/highrise

# Highrise (master) [![Build Status](https://snap-ci.com/tapajos/highrise/branch/master/build_image)](https://snap-ci.com/tapajos/highrise/branch/master) [![Code Climate](https://codeclimate.com/github/tapajos/highrise.png)](https://codeclimate.com/github/tapajos/highrise)

## What is it?

This gem provides a set of classes to access information on [Highrise][h] via the published [API][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][ar] documentation for more information.

## Installing
```bash
    gem install highrise
```
### Dependencies (see <code>highrise.gemspec</code> or run <code>bundle check</code>)

### Documentation

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

  [Cookbook][cookbook]

### Configure your key
```ruby
    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
```ruby
    @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][mit].

## Bugs, Issues, Kudos and Catcalls

Comments are welcome. Send your feedback through the [issue tracker on GitHub][i]

If you have fixes: Submit via pull requests. Do not include version changes to the
version file.

## Authors

* [Marcos Tapajós][tapajos]
* [Ken Mayer][kmayer]

## [Contributors][list]


[api]: http://developer.37signals.com/highrise
[ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
[c]:  http://api.rubyonrails.org/classes/ActiveSupport/Cache
[h]:  http://www.highrisehq.com/
[i]:  https://github.com/tapajos/highrise/issues
[kmayer]: https://github.com/kmayer
[mit]: http://www.opensource.org/licenses/mit-license.php
[cookbook]: https://github.com/tapajos/highrise/wiki/Cookbook
[rdoc]: http://rdoc.info/projects/tapajos/highrise
[tapajos]: http://www.improveit.com.br/en/company/tapajos
[list]: https://github.com/tapajos/highrise/graphs/contributors
[]