harvested 0.6.0 → 0.6.1

data/HISTORY

@@ -1,3 +1,6 @@
+0.6.1 - August 22, 2012
+  * Adds options to "all" finder (thanks Mikel Lindsaar)
+  * Adds Unauthorized error type (thanks @bcobb)
 0.6.0 - August 22, 2012
   * Replaces Dash with Mash
 0.5.3 - August 21, 2012

data/README.md

@@ -1,6 +1,6 @@
 # Harvested: A Ruby Harvest API
 
-This is a Ruby wrapper for the [Harvest API](http://www.getharvest.com/).
+This is a Ruby wrapper for the [Harvest API](http://www.getharvest.com/api).
 
 ## Installation
 
@@ -17,6 +17,20 @@ client = harvest.clients.create(client)
 harvest.clients.find(client.id) # returns a Harvest::Client
 ```
 
+You can also pass query options in as the last parameter on any objects `all` finder
+method, for example to find all the projects for client ID 12345:
+
+```ruby
+harvest = Harvest.client('yoursubdomain', 'yourusername', 'yourpassword')
+harvest.projects.harvest.projects.all(nil, :client => 12345)
+```
+
+Note, the second parameter is a User ID field that is optional, but needs to be specified
+as nil if not included.
+
+You can pass in any hash of query attributes you wish as per the
+[Harvest API](http://www.getharvest.com/api) page.
+
 You can find more examples in `/examples` and in the documentation for Harvest::Base
 
 ## Hardy Client
@@ -50,20 +64,20 @@ http://github.com/zmoazeni/harvested/issues/
 2. If you don’t see anything, create an issue with information on how to reproduce it.
 
 If you want to contribute an enhancement or a fix:
- 
+
 1. Fork the project on github http://github.com/zmoazeni/harvested
 2. Make your changes with tests
 3. Commit the changes without messing with the Rakefile, VERSION, or history
 4. Send me a pull request
 
-Note on running tests: most specs run against a live Harvest account. To run the suite, sign up for a free trial account and fill out `/spec/support/harvest_credentials.yml` *(a sample harvest_credentials.example.yml has been included)*. 
+Note on running tests: most specs run against a live Harvest account. To run the suite, sign up for a free trial account and fill out `/spec/support/harvest_credentials.yml` *(a sample harvest_credentials.example.yml has been included)*.
 
 **DO NOT USE YOUR NORMAL CREDENTIALS IN `/spec/support/harvest_credentials.yml`!!!** The test suite blasts all the data before running (similiar to DatabaseCleaner).
 
 The tests use [VCR](https://github.com/myronmarston/vcr) to cache the test responses. This is a great boon for running the tests offline. While uncommon, sometimes the Harvest API will send an erroneous response and VCR will cache it, then subsequent runs will use the incorrect cached response. In order to ignore VCR you can run the specs by passing CACHE=false (e.g. `CACHE=false bundle rake spec`).
 
 Using [rvm](https://rvm.beginrescueend.com/) you can run the tests against the popular ruby runtimes by running:
-  
+
   ./spec/test_rubies
 
 Each runtime needs to be installed in rvm along with the bundler gem.

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/harvested.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "harvested"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zach Moazeni"]

data/lib/harvest/api/base.rb

@@ -43,6 +43,8 @@ module Harvest
             response
           when 400
             raise Harvest::BadRequest.new(response, params)
+          when 401
+            raise Harvest::AuthenticationFailed.new(response, params)
           when 404
             raise Harvest::NotFound.new(response, params)
           when 500
@@ -61,4 +63,4 @@ module Harvest
         end
     end
   end
-end
+end

data/lib/harvest/behavior/crud.rb

@@ -3,11 +3,12 @@ module Harvest
     module Crud
       # Retrieves all items
       # @return [Array<Harvest::BaseModel>] an array of models depending on where you're calling it from (e.g. [Harvest::Client] from Harvest::Base#clients)
-      def all(user = nil)
-        response = request(:get, credentials, api_model.api_path, :query => of_user_query(user))
+      def all(user = nil, query_options = {})
+        query = query_options.merge!(of_user_query(user))
+        response = request(:get, credentials, api_model.api_path, :query => query)
         api_model.parse(response.parsed_response)
       end
-      
+
       # Retrieves an item by id
       # @overload find(id)
       #   @param [Integer] the id of the item you want to retreive
@@ -15,13 +16,13 @@ module Harvest
       #   @param [String] id the String version of the id
       # @overload find(model)
       #   @param [Harvest::BaseModel] id you can pass a model and it will return a refreshed version
-      # 
+      #
       # @return [Harvest::BaseModel] the model depends on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
       def find(id, user = nil)
         response = request(:get, credentials, "#{api_model.api_path}/#{id}", :query => of_user_query(user))
         api_model.parse(response.parsed_response).first
       end
-      
+
       # Creates an item
       # @param [Harvest::BaseModel] model the item you want to create
       # @return [Harvest::BaseModel] the created model depending on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
@@ -31,7 +32,7 @@ module Harvest
         id = response.headers["location"].match(/\/.*\/(\d+)/)[1]
         find(id, model.impersonated_user_id)
       end
-      
+
       # Updates an item
       # @param [Harvest::BaseModel] model the model you want to update
       # @return [Harvest::BaseModel] the created model depending on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
@@ -40,7 +41,7 @@ module Harvest
         request(:put, credentials, "#{api_model.api_path}/#{model.to_i}", :body => model.to_json, :query => of_user_query(user))
         find(model.id)
       end
-      
+
       # Deletes an item
       # @overload delete(model)
       #  @param [Harvest::BaseModel] model the item you want to delete
@@ -48,7 +49,7 @@ module Harvest
       #  @param [Integer] id the id of the item you want to delete
       # @overload delete(id)
       #  @param [String] id the String version of the id of the item you want to delete
-      # 
+      #
       # @return [Integer] the id of the item deleted
       def delete(model, user = nil)
         request(:delete, credentials, "#{api_model.api_path}/#{model.to_i}", :query => of_user_query(user))

data/lib/harvest/errors.rb

@@ -22,4 +22,5 @@ module Harvest
   class InformHarvest < HTTPError; end
   class BadRequest < HTTPError; end
   class ServerError < HTTPError; end
-end
+  class AuthenticationFailed < HTTPError ; end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harvested
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -261,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3859920276334034236
+      hash: -3050275460586809448
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: