README.md in zendesk2-0.0.14 vs README.md in zendesk2-0.0.15

- old
+ new

@@ -5,13 +5,13 @@ Ruby client for the [Zendesk V2 API](http://developer.zendesk.com/documentation/rest_api/introduction.html) using [cistern](https://github.com/lanej/cistern) and [faraday](https://github.com/technoweenie/faraday) ## Installation Add this line to your application's Gemfile: - - gem 'zendesk2' - +```ruby +gem 'zendesk2' +``` Or install it yourself as: $ gem install zendesk2 ## Usage @@ -48,110 +48,113 @@ * Categories * User * Ticket * Organization * Forums +* Topics All collection are accessed like so: ```ruby client.users.all -=> <Zendesk2::Client::Users - count=1779, - next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2", - previous_page_link=nil - [ - <Zendesk2::Client::User - id=125394183, - url="https://dev.zendesk.com/api/v2/users/125394183.json", +=> <Zendesk2::Client::Users + count=1779, + next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2", + previous_page_link=nil + [ + <Zendesk2::Client::User + id=125394183, + url="https://dev.zendesk.com/api/v2/users/125394183.json", ... - > - ] + > + ] ``` Collections also respond to `create` and `new` +```ruby +client.users.create(email: "ohhai@example.org", name: "lulz") +=> <Zendesk2::Client::User + id=234020811, + ... + url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json", + ... + email="ohhai@example.org", + > +``` - client.users.create(email: "ohhai@example.org", name: "lulz") - => <Zendesk2::Client::User - id=234020811, - ... - url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json", - ... - email="ohhai@example.org", - > - - - client.users.new(email: "ohhai@example.org") - => <Zendesk2::Client::User - id=nil, - ... - url=nil, - ... - email="ohhai@example.org", - ... - > - +```ruby +client.users.new(email: "ohhai@example.org") +=> <Zendesk2::Client::User + id=nil, + ... + url=nil, + ... + email="ohhai@example.org", + ... + > +``` #### Paging Paged collections respond to `next_page` and `previous_page` when appropriate. `page_size` and `page` can be passed directly to the collection to control size and index. - - page = client.users.all("per_page" => 1, "page" => 4) - => <Zendesk2::Client::Users - count=1780, - next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1", - previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1" - [ - <Zendesk2::Client::User - id=217761652, - url="https://dev.zendesk.com/api/v2/users/217761652.json", - external_id=nil, - name="Guy Dude", - ... - > - ] - - page.next_page - => <Zendesk2::Client::Users - count=1780, - next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1", - previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1" - [ - <Zendesk2::Client::User - id=217761742, - url="https://dev.zendesk.com/api/v2/users/217761742.json", - ... - name="epitaphical osteofibrous", - ... - > - ] - - page.previous_page - => <Zendesk2::Client::Users - count=1780, - next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1", - previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1" - [ - <Zendesk2::Client::User - id=217761652, - url="https://dev.zendesk.com/api/v2/users/217761652.json", - ... - name="Guy Dude", - ... - > - ] - +```ruby +page = client.users.all("per_page" => 1, "page" => 4) +=> <Zendesk2::Client::Users + count=1780, + next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1", + previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1" + [ + <Zendesk2::Client::User + id=217761652, + url="https://dev.zendesk.com/api/v2/users/217761652.json", + external_id=nil, + name="Guy Dude", + ... + > + ] +``` +```ruby +page.next_page +=> <Zendesk2::Client::Users + count=1780, + next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1", + previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1" + [ + <Zendesk2::Client::User + id=217761742, + url="https://dev.zendesk.com/api/v2/users/217761742.json", + ... + name="epitaphical osteofibrous", + ... + > + ] +``` +```ruby +page.previous_page +=> <Zendesk2::Client::Users + count=1780, + next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1", + previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1" + [ + <Zendesk2::Client::User + id=217761652, + url="https://dev.zendesk.com/api/v2/users/217761652.json", + ... + name="Guy Dude", + ... + > + ] +``` #### Models All models respond to `destroy` and `save` if applicable. `save` performs a 'create' operation if there is no identity provided or an 'update' if there is an identity. - - Zendesk2::Client::Ticket.new.save # performs a create - Zendesk2::Client::Ticket.new(id: 1).save # performs an update - +```ruby +Zendesk2::Client::Ticket.new.save # performs a create +Zendesk2::Client::Ticket.new(id: 1).save # performs an update +``` Attributes can be enumerated by the `attributes` method. ## Releasing - - $ gem install gem-release - $ gem bump -trv (major|minor|patch) + $ gem install gem-release + $ gem bump -trv (major|minor|patch) ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)