intervals_api 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28f792607ddeff3949904c3b1186bc2f11ab07f4
-  data.tar.gz: 44240e86774fb89dfa49ebe7f2b4dd3ec85310f8
+  metadata.gz: eec156a63df10bd5b4e6d4f8a5bd5822b9435a56
+  data.tar.gz: d6c41ed9462045a8793dc9e6f7a266d50cf8df05
 SHA512:
-  metadata.gz: c923f62f162a21b3d8cace555788685645b93394f46f1af29a99c3b28e1c86c159a3efc38e32f46a248034da49f57f2064567cc8c3a4b156d409fd3656ef5521
-  data.tar.gz: c337f295d3cf4ce33f724afa95e0320fb4a25a8ca0546fa85acfa65f9e5e58c4955705b877979b73927983d9a02bc2ff5dd52e94b82c25e164922e19dc4cbcfe
+  metadata.gz: 5fce195f0fbee76e49c09ea04673351f7a7311106255b8ac598cbdc81e618ec5a5ddb79e166cb5770289bc4f4a37cbf1d9a73122f4d61dc2daa4f224297c2dae
+  data.tar.gz: 42e2e017b1558aed5fe86f00ccd6849ee8b4bfc8574e879512dbaabd54062a4476db749128c8135b1d9315c16d52d00013c4899d9bab945ecb5b3bd710bcf87f

data/README.md

@@ -4,7 +4,9 @@ By [Staplegun](http://staplegun.us)
 ## Description
 
 This gem is a wrapper around the [Intervals](http://www.myintervals.com/) REST API which allows you to retrieve,
-create, update, and delete several different resources from their database.
+create, update, and delete several different resources from their database. All
+API requests are made with the help of the
+[HTTParty gem](https://github.com/jnunemaker/httparty).
 
 ## Usage
 
@@ -33,11 +35,19 @@ The endpoint resource you are querying
 Type: `Hash`
 Default: `{}`
 
-A hash of options that you wish to query by. This could be filter options for a
+A hash of options, such as filter options for a
 GET request, new object options for a POST request, etc.
 
-[View the Intervals documentation](http://www.myintervals.com/api/) to learn
-about which resources and query options are available to use
+Available keys (See in the examples how they're used):
+
+* *query*   - Query parameters that you wish to pass, typically via GET
+* *body*    - Data you wish to submit, typically via POST or PUT
+* *headers* - Request headers you wish to set
+
+[View the HTTParty gem](https://github.com/jnunemaker/httparty) to see more options
+about formatting your request, and
+[view the Intervals documentation](http://www.myintervals.com/api/) to learn
+about which resources are available to request.
 
 ### Response
 
@@ -54,14 +64,16 @@ response = intervals.get('/client/');
 
 ```ruby
 # Retrieve all active clients
-response = intervals.get('/client/', { active: true });
+response = intervals.get('/client/', query: {
+  active: true
+});
 ```
 
 #### Post
 
 ```ruby
 # Create a task request
-intervals.post('/request/', {
+intervals.post('/request/', body: {
   personid:     5,
   projectid:    6,
   title:        'Just an average title'
@@ -72,7 +84,7 @@ intervals.post('/request/', {
 
 ```ruby
 # Update a task request
-intervals.put('/request/1/', {
+intervals.put('/request/1/', body: {
   priorityid:   1,
   title:        "Here's an updated title"
 })

data/intervals_api.gemspec

@@ -12,5 +12,5 @@ Gem::Specification.new do |s|
   s.license       = "GPL"
 
   s.add_runtime_dependency 'recursive-open-struct', '~> 0.5', '>= 0.5.0'
-  s.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.1'
+  s.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.3'
 end

data/lib/intervals_api/request_handler.rb

@@ -15,7 +15,7 @@ module IntervalsAPI
       }
     end
 
-    %w(get post put delete options).each do |request_type|
+    %w(get post put delete).each do |request_type|
       define_method request_type do |url, options = {}|
 
         query_options = @default_options

data/lib/intervals_api/version.rb

@@ -1,3 +1,3 @@
 module IntervalsAPI
-  VERSION='1.5.1'
+  VERSION='1.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intervals_api
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - interactive@staplegun.us
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
@@ -39,7 +39,7 @@ dependencies:
         version: '0.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.13.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '0.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.13.3
 description: 
 email: 
 executables: []