harvested 3.0.0.rc1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d40d1bfd28ea226ff25aa4e6f6b78d6ce3df6d37
-  data.tar.gz: c3ebf97344f99de79afc0eae59dd6b0a6de43f7d
+  metadata.gz: c9671d7604da7b9da9bee9fd922b00cac9aa08a9
+  data.tar.gz: e0295ab8a592616dff967a03a43ec9b0c669d3b9
 SHA512:
-  metadata.gz: 2bc9034c02ad6d9ce05a8a2c70b545db1c8b5924085c674ec07093092c2d95c18f3af451240278e858398b6c445805615fa263f2d6892de82842e7bbe35d6ee3
-  data.tar.gz: bcea2bb7c21a00dba42ba7f666d79fe343b618f75a855b60f0c9cada27b39a4eed577c96181b843ba3cb50fdaef0acab99b8c73763a5879ddd009e85d2587848
+  metadata.gz: 5fac81456746627a0ff7372defcf6013ada70ae07e53013085c7844761b1a853c9f1f666af0d0fcdd3a83969a3b7d78c01b6b1ca499980e089301d2d5c56c154
+  data.tar.gz: d54e0f9f6b67aa16747cf2f527d954a5bdc42501819727396b43a2abb0a4d53423940d85e0ea5b5378b2c501e02e800e4a895090c8890460c2bcce3b0c75f581

data/HISTORY.md

@@ -3,6 +3,8 @@
   * Allow OAuth authentication (Thanks Brendan Loudermilk - @bloudermilk)
   * Allow expenses_by_project to be retrieved (Thanks Jordan Yeo - @jordanyeo)
   * Reports now pass through any remaining options (Thanks Philip Arndt - @parndt)
+  * No longer requires Hashie v1 as a dependency
+  * Fixes bug where project hints were not handled properly
 
 ## 2.0.0 - April 23, 2014
   * Every connection must be SSL

data/README.md

@@ -9,7 +9,7 @@ This is a Ruby wrapper for the [Harvest API](http://www.getharvest.com/api).
 ## Examples
 
 ```ruby
-harvest = Harvest.client('yoursubdomain', 'yourusername', 'yourpassword')
+harvest = Harvest.client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
 harvest.projects.all   # list out projects
 
 client = Harvest::Client.new(:name => "Billable Company LTD.")
@@ -21,7 +21,7 @@ You can also pass query options in as the last parameter on any objects `all` fi
 method, for example to find all the projects for client ID 12345:
 
 ```ruby
-harvest = Harvest.client('yoursubdomain', 'yourusername', 'yourpassword')
+harvest = Harvest.client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
 harvest.projects.all(nil, :client => 12345)
 ```
 
@@ -33,6 +33,10 @@ You can pass in any hash of query attributes you wish as per the
 
 You can find more examples in `/examples` and in the documentation for Harvest::Base
 
+## Permissions
+
+For most operations you need to be an Admin on the Harvest account. You can do few select things as normal users and project managers, but you will likely get errors.
+
 ## Hardy Client
 
 The guys at Harvest built a great API, but there are always dangers in writing code that depends on an API. For example, HTTP Timeouts, Occasional Bad Gateways, and Rate Limiting issues need to be accounted for.
@@ -40,13 +44,13 @@ The guys at Harvest built a great API, but there are always dangers in writing c
 Using `Harvested#client` your code needs to handle all these situations. However you can also use `Harvested#hardy_client` which will retry errors and wait for Rate Limit resets.
 
 ```ruby
-harvest = Harvest.hardy_client('yoursubdomain', 'yourusername', 'yourpassword')
+harvest = Harvest.hardy_client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')
 harvest.projects.all   # This will wait for the Rate Limit reset if you have gone over your limit
 ```
 
 ## Ruby support
 
-Harvested's tests are currently passing for 1.8.7, 1.9.2, JRuby 1.6.2, and Rubinius
+Harvested's tests are currently supports ruby 2.0+
 
 ## Links
 
@@ -72,8 +76,9 @@ 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
+3. Commit the changes without messing with the Rakefile, or Version
+4. Make an entry to HISTORY.md
+5. 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)*.
 
@@ -81,12 +86,6 @@ Note on running tests: most specs run against a live Harvest account. To run the
 
 The tests use [VCR](https://github.com/myronmarston/vcr) to cache the API responses. This is a great boon for running the tests offline. While uncommon, sometimes the Harvest API will send an erroneous response, VCR will cache it, and subsequent runs will use the incorrect cached response. In order to clear the cached responses, you can run the specs with the `VCR_REFRESH` environmental variable set to true (e.g. `VCR_REFRESH=true bundle exec 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.
-
 ## Notes on Harvest Estimates
 
 Estimates aren't currently supported due to lack of an API. If this opens up, harvested will include them.

data/examples/basics.rb

@@ -4,7 +4,7 @@ subdomain = 'yoursubdomain'
 username = 'yourusername'
 password = 'yourpassword'
 
-harvest = Harvest.hardy_client(subdomain, username, password)
+harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
 
 # Print out all users, clients, and projects on the account
 puts "Users:"
@@ -18,18 +18,18 @@ harvest.projects.all.each {|project| p project }
 
 # Create a Client add a Project to that Client, Add a Task to the Project, track some Time against the Project/Task, and then Run a report against all time I've submitted
 
-client = Harvest::Client.new(:name => 'SuprCorp')
+client = Harvest::Client.new(name: 'SuprCorp')
 client = harvest.clients.create(client)
 
-project = Harvest::Project.new(:name => 'SuprGlu', :client_id => client.id, :notes => 'Some notes about this project')
+project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
 project = harvest.projects.create(project)
 
 harvest.projects.create_task(project, 'Bottling Glue')
 task_assignment = harvest.task_assignments.all(project).first
 
-time_entry = Harvest::TimeEntry.new(:notes => 'Bottled glue today', :hours => 8, :spent_at => "04/11/2010", :project_id => project.id, :task_id => task_assignment.task_id)
+time_entry = Harvest::TimeEntry.new(notes: 'Bottled glue today', hours: 8, spent_at: "04/11/2010", project_id: project.id, task_id: task_assignment.task_id)
 time_entry = harvest.time.create(time_entry)
 
 entries = harvest.reports.time_by_project(project, Time.parse("04/11/2010"), Time.parse("04/12/2010"))
 puts "Entries:"
-entries.each {|e| p e}
+entries.each {|e| p e}

data/examples/clear_account.rb

@@ -1,28 +1,28 @@
 # This is commented out because it can be very dangerous if run against a production account
 
 # require "harvested"
-# 
+#
 # subdomain = 'yoursubdomain'
 # username = 'yourusername'
 # password = 'yourpassword'
-# 
-# api = Harvest.hardy_client(subdomain, username, password)
-# 
+#
+# api = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
+#
 # raise "Are you sure you want to do this? (comment out this exception if so)"
-# 
+#
 # api.users.all.each do |u|
 #   api.users.delete(u) if u.email != username
 # end
 # my_user = api.users.all.first
-# 
+#
 # api.reports.time_by_user(my_user, Time.parse('01/01/2000'), Time.now).each do |time|
 #   api.time.delete(time)
 # end
-# 
+#
 # api.reports.expenses_by_user(my_user, Time.parse('01/01/2000'), Time.now).each do |time|
 #   api.expenses.delete(time)
 # end
-# 
+#
 # %w(expenses expense_categories projects contacts clients tasks).each do |collection|
 #   api.send(collection).all.each {|m| api.send(collection).delete(m) }
-# end
+# end

data/examples/project_create_script.rb

@@ -13,7 +13,7 @@ subdomain = 'yoursubdomain'
 username = 'yourusername'
 password = 'yourpassword'
 
-harvest = Harvest.hardy_client(subdomain, username, password)
+harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
 
 puts "\nPlease search for a client by typing part of their name:"
 cname = gets.chomp
@@ -35,7 +35,7 @@ when 1..15
 		puts "  #{i+1}. #{c.name}"
 	end
 
-	client_index = gets.chomp.to_i - 1	
+	client_index = gets.chomp.to_i - 1
 else
 	puts "Too many client matches. Please try a more specific search term.\n"
 	abort
@@ -69,13 +69,13 @@ tasks = harvest.tasks.all.select { |t| use_tasks.include?(t.name) }
 
 # Create the project
 puts "Creating new project: \"#{project_name}\" for client: #{client.name}\n"
-project = Harvest::Project.new(:name => project_name, :client_id => client.id, :billable => billable, :notes => notes)
+project = Harvest::Project.new(name: project_name, client_id: client.id, billable: billable, notes: notes)
 project = harvest.projects.create(project)
 
 # Add all the project tasks to the project
 tasks.each do |t|
 	puts "  Adding Task: #{t.name}"
-	task_assignment = Harvest::TaskAssignment.new(:task_id => t.id, :project_id => project.id)
+	task_assignment = Harvest::TaskAssignment.new(task_id: t.id, project_id: project.id)
 	task_assignment = harvest.task_assignments.create(task_assignment)
 end
 
@@ -85,7 +85,7 @@ harvest.users.all.each do |u|
 	next unless u.is_active?
 
 	puts "  Adding User: #{u.first_name} #{u.last_name}"
-	user_assignment = Harvest::UserAssignment.new(:user_id => u.id, :project_id => project.id)
+	user_assignment = Harvest::UserAssignment.new(user_id: u.id, project_id: project.id)
 	harvest.user_assignments.create(user_assignment)
 end
 

data/examples/task_assignments.rb

@@ -4,14 +4,14 @@ subdomain = 'yoursubdomain'
 username = 'yourusername'
 password = 'yourpassword'
 
-harvest = Harvest.hardy_client(subdomain, username, password)
+harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
 
 # Create a Client add a Project to that Client
 
-client = Harvest::Client.new(:name => 'SuprCorp')
+client = Harvest::Client.new(name: 'SuprCorp')
 client = harvest.clients.create(client)
 
-project = Harvest::Project.new(:name => 'SuprGlu', :client_id => client.id, :notes => 'Some notes about this project')
+project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
 project = harvest.projects.create(project)
 
 # You can create an assign a task in one call
@@ -19,9 +19,9 @@ harvest.projects.create_task(project, 'Bottling Glue')
 puts "Assigned the task 'Bottling Glue' to the project 'SuprGlu'"
 
 # You can explicitly create the task and then assign it
-task = Harvest::Task.new(:name => 'Packaging Glue', :hourly_rate => 30, :billable => true)
+task = Harvest::Task.new(name: 'Packaging Glue', hourly_rate: 30, billable: true)
 task = harvest.tasks.create(task)
 
-task_assignment = Harvest::TaskAssignment.new(:task_id => task.id, :project_id => project.id)
+task_assignment = Harvest::TaskAssignment.new(task_id: task.id, project_id: project.id)
 task_assignment = harvest.task_assignments.create(task_assignment)
-puts "Assigned the task 'Packaging Glue' to the project 'SuprGlu'"
+puts "Assigned the task 'Packaging Glue' to the project 'SuprGlu'"

data/examples/user_assignments.rb

@@ -4,21 +4,21 @@ subdomain = 'yoursubdomain'
 username = 'userusername'
 password = 'yourpassword'
 
-harvest = Harvest.hardy_client(subdomain, username, password)
+harvest = Harvest.hardy_client(subdomain: subdomain, username: username, password: password)
 
 # Create a Client, Project, and a User then assign that User to that Project
 
-client = Harvest::Client.new(:name => 'SuprCorp')
+client = Harvest::Client.new(name: 'SuprCorp')
 client = harvest.clients.create(client)
 
-project = Harvest::Project.new(:name => 'SuprGlu', :client_id => client.id, :notes => 'Some notes about this project')
+project = Harvest::Project.new(name: 'SuprGlu', client_id: client.id, notes: 'Some notes about this project')
 project = harvest.projects.create(project)
 
 harvest.projects.create_task(project, 'Bottling Glue')
 
-user = Harvest::User.new(:first_name => 'Jane', :last_name => 'Doe', :email => 'jane@doe.com', :timezone => :est, :password => 'secure')
+user = Harvest::User.new(first_name: 'Jane', last_name: 'Doe', email: 'jane@doe.com', timezone: :est, password: 'secure')
 user = harvest.users.create(user)
 
-user_assignment = Harvest::UserAssignment.new(:user_id => user.id, :project_id => project.id)
+user_assignment = Harvest::UserAssignment.new(user_id: user.id, project_id: project.id)
 harvest.user_assignments.create(user_assignment)
-puts 'Assigned Jane Doe to the project "SuprGlu"'
+puts 'Assigned Jane Doe to the project "SuprGlu"'

data/harvested.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Harvest::VERSION
   spec.authors       = ["Zach Moazeni"]
   spec.email         = ["zach.moazeni@gmail.com"]
-  spec.summary      = "A Ruby Wrapper for the Harvest API http://www.getharvest.com/"
+  spec.summary       = "A Ruby Wrapper for the Harvest API http://www.getharvest.com/"
   spec.description   = "Harvested wraps the Harvest API concisely without the use of Rails dependencies. More information about the Harvest API can be found on their website (http://www.getharvest.com/api). For support hit up the Mailing List (http://groups.google.com/group/harvested)"
   spec.homepage      = "http://github.com/zmoazeni/harvested"
   spec.license       = "MIT"
@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
 
   spec.add_runtime_dependency('httparty')
-  spec.add_runtime_dependency('hashie', '~> 1')
+  spec.add_runtime_dependency('hashie')
   spec.add_runtime_dependency('json')
 end

data/lib/harvest/api/base.rb

@@ -48,7 +48,7 @@ module Harvest
           when 401
             raise Harvest::AuthenticationFailed.new(response, params)
           when 404
-            raise Harvest::NotFound.new(response, params)
+            raise Harvest::NotFound.new(response, params, "Do you have sufficient privileges?")
           when 500
             raise Harvest::ServerError.new(response, params)
           when 502

data/lib/harvest/api/projects.rb

@@ -10,7 +10,7 @@ module Harvest
       def all(*)
         super
       rescue NotFound => e
-        raise NotFound.new(e.response, e.params, "Do you have sufficient priveleges? If not, consider using time.trackable_projects instead.")
+        raise NotFound.new(e.response, e.params, "Do you have sufficient privileges? If not, consider using time.trackable_projects instead.")
       end
       
       # Creates and Assigns a task to the project

data/lib/harvest/model.rb

@@ -23,7 +23,7 @@ module Harvest
       def to_i; id; end
 
       def ==(other)
-        id == other.id
+        other.kind_of?(self.class) && id == other.id
       end
 
       def impersonated_user_id

data/lib/harvest/project.rb

@@ -33,16 +33,5 @@ module Harvest
         json[json_root].delete("hint_latest_record_at")
       end
     end
-
-    def self.parse(json)
-      json = String === json ? JSON.parse(json) : json
-      Array.wrap(json).each do |attrs|
-        # need to cleanup some attributes
-        project_attrs = attrs[json_root] || {}
-        project_attrs["hint_latest_record_at"]   = project_attrs.delete("hint-latest-record-at")
-        project_attrs["hint_earliest_record_at"] = project_attrs.delete("hint-earliest-record-at")
-      end
-      super(json)
-    end
   end
 end

data/lib/harvest/version.rb

@@ -1,3 +1,3 @@
 module Harvest
-  VERSION = "3.0.0.rc1"
+  VERSION = "3.0.0"
 end

data/spec/functional/account_spec.rb

@@ -4,10 +4,10 @@ describe 'account information' do
   it 'returns the rate limit when requested' do
     cassette('account1') do
       status = harvest.account.rate_limit_status
-      status.max_calls.should == 500
+      status.max_calls.should == 100
     end
   end
-  
+
   it 'returns the result of whoami' do
     cassette('account2') do
       user = harvest.account.who_am_i

data/spec/functional/reporting_spec.rb

@@ -32,6 +32,7 @@ describe 'harvest reporting' do
       harvest.reports.time_by_project(project2, Time.utc(2009, 12, 20), Time.utc(2009,12,30), billable: true).should == []
       harvest.reports.time_by_project(project2, Time.utc(2009, 12, 20), Time.utc(2009,12,30), billable: false).first.should == entry2
 
+      sleep 10
       harvest.reports.time_by_project(project1, Time.utc(2009, 12, 10), Time.utc(2009,12,30), {updated_since: Time.now.utc}).should == []
 
       harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).map(&:id).should == [entry1, entry2].map(&:id)
@@ -80,6 +81,7 @@ describe 'harvest reporting' do
       harvest.reports.expenses_by_project(project, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).first.should == expense
       harvest.reports.expenses_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).first.should == expense
 
+      sleep 10
       harvest.reports.expenses_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30), {updated_since: Time.now.utc}).should == []
 
       my_user = harvest.users.all.detect {|u| u.email == credentials["username"]}

data/spec/harvest/project_spec.rb

@@ -2,10 +2,4 @@ require 'spec_helper'
 
 describe Harvest::Project do
   it_behaves_like 'a json sanitizer', %w(hint_latest_record_at hint_earliest_record_at cache_version)
-    
-  it "cleans up weird attributes" do
-    project = Harvest::Project.parse('[{"project":{"hint-earliest-record-at":10, "hint-latest-record-at":20}}]').first
-    project.hint_earliest_record_at.should == 10
-    project.hint_latest_record_at.should == 20
-  end
-end
+end

data/spec/harvest/task_assignment_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Harvest::TaskAssignment do
   context "task_as_json" do
     it "generates the json for existing tasks" do
-      assignment = Harvest::TaskAssignment.new(:task => mock(:task, :to_i => 3))
+      assignment = Harvest::TaskAssignment.new(:task => double(:task, :to_i => 3))
       assignment.task_as_json.should == {"task" => {"id" => 3}}
     end
   end
-end
+end

data/spec/harvest/user_assignment_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Harvest::UserAssignment do
   describe "#user_as_json" do
     it "should generate the xml for existing users" do
-      assignment = Harvest::UserAssignment.new(:user => mock(:user, :to_i => 3))
+      assignment = Harvest::UserAssignment.new(:user => double(:user, :to_i => 3))
       assignment.user_as_json.should == {"user" => {"id" => 3}}
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harvested
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0
 platform: ruby
 authors:
 - Zach Moazeni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,16 +28,16 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +153,6 @@ files:
 - spec/support/harvest_credentials.example.yml
 - spec/support/harvested_helpers.rb
 - spec/support/json_examples.rb
-- spec/test_rubies
 homepage: http://github.com/zmoazeni/harvested
 licenses:
 - MIT
@@ -169,9 +168,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -210,5 +209,4 @@ test_files:
 - spec/support/harvest_credentials.example.yml
 - spec/support/harvested_helpers.rb
 - spec/support/json_examples.rb
-- spec/test_rubies
 has_rdoc: 

data/spec/test_rubies

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-set -o verbose
-RBXOPT="-Xrbc.db" rvm ruby-1.8.7-p334,ruby-1.9.2-p180,rbx,jruby-1.6.2 exec bundle
-RBXOPT="-Xrbc.db" rvm ruby-1.8.7-p334,ruby-1.9.2-p180,rbx,jruby-1.6.2 exec bundle exec rake spec