harvested 1.0.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGIyYjlkMDdjZWI1MTRlMjZlZTk2MmI1OWVjNGY2ZDkxNDAyMTZjZg==
+  data.tar.gz: !binary |-
+    MDliY2MxNTEwMjFhZmE4NGZhMDJmYzhlNTBjM2JhYzU0MTAxMzAwZA==
+SHA512:
+  metadata.gz: !binary |-
+    NGM1NmJkOWVmNTVkNTRlMmFjMjY1ZjBkMWY4YzQ4YmNkYzU3M2FlY2JhZGY1
+    ZmVkNWRiMGU5YjI5NmJkZDZiMjk3Yjk1MjFhZmI3ZTVkZTQ0ZTFlZWNjNmVm
+    MGUyZTU5OGNjMGU2MmFiMzBjNTg4NWVmNDA4YjQ4ZGNiMWIyYTA=
+  data.tar.gz: !binary |-
+    MjU1NmUxMTY0M2I4OTgxOThlMzEwMDJkODdlMDQ2NmNhMDBhMWU5Njg4MjEw
+    YTg4MjFhZGE3OGYyNDE2NGViZTczNTZjMzA3N2ExZWU1MDQ4NWY0OWViOTFh
+    NDk4MDQ3NTRkNWQxZDU1M2JlNmZlZDQ3Yjg2NmE3NGExNmZhYjE=

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p429
+1.9.3

data/HISTORY

@@ -1,3 +1,8 @@
+1.2.0 - February 21, 2014
+  * Adds time.trackable_projects: projects that the current user can create entries for
+  * Show hint on error for projects.all as unprivileged user
+1.1.0 - December 13, 2013
+  * Adds ability to toggle timers (thanks Eli Fatsi - @efatsi)
 1.0.1 - June 21, 2013
   * Adds ability to pass updated_since paramter to report methods (thanks Pete McWilliams)
   * Adds ability to create time entries for a given user

data/README.md

@@ -87,11 +87,6 @@ Using [rvm](https://rvm.beginrescueend.com/) you can run the tests against the p
 
 Each runtime needs to be installed in rvm along with the bundler gem.
 
-## TODO
-
-* Write Documentation
-* Allow Timer Toggling
-
 ## Notes on Harvest Estimates
 
 Estimates aren't currently supported due to lack of an API. If this opens up, harvested will include them.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.2.0

data/harvested.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: harvested 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "harvested"
-  s.version = "1.0.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Zach Moazeni"]
-  s.date = "2013-06-21"
+  s.date = "2014-02-21"
   s.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)"
   s.email = "zach.moazeni@gmail.com"
   s.extra_rdoc_files = [
@@ -73,6 +75,7 @@ Gem::Specification.new do |s|
     "lib/harvest/task_assignment.rb",
     "lib/harvest/time_entry.rb",
     "lib/harvest/timezones.rb",
+    "lib/harvest/trackable_project.rb",
     "lib/harvest/user.rb",
     "lib/harvest/user_assignment.rb",
     "lib/harvested.rb",
@@ -99,6 +102,7 @@ Gem::Specification.new do |s|
     "spec/harvest/task_assignment_spec.rb",
     "spec/harvest/task_spec.rb",
     "spec/harvest/time_entry_spec.rb",
+    "spec/harvest/trackable_project_spec.rb",
     "spec/harvest/user_assignment_spec.rb",
     "spec/harvest/user_spec.rb",
     "spec/spec_helper.rb",
@@ -108,12 +112,11 @@ Gem::Specification.new do |s|
     "spec/test_rubies"
   ]
   s.homepage = "http://github.com/zmoazeni/harvested"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.2.1"
   s.summary = "A Ruby Wrapper for the Harvest API http://www.getharvest.com/"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0"])

data/lib/harvest/api/projects.rb

@@ -4,6 +4,14 @@ module Harvest
       api_model Harvest::Project
       
       include Harvest::Behavior::Crud
+
+      # Retrieves all projects. Note: this requires project manager or administrator authorization.
+      # @return [Harvest::Project]
+      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.")
+      end
       
       # Creates and Assigns a task to the project
       #

data/lib/harvest/api/time.rb

@@ -8,11 +8,18 @@ module Harvest
       end
       
       def all(date = ::Time.now, user = nil)
-        date = ::Time.parse(date) if String === date
-        response = request(:get, credentials, "/daily/#{date.yday}/#{date.year}", :query => of_user_query(user))
-        Harvest::TimeEntry.parse(JSON.parse(response.body)["day_entries"])
+        Harvest::TimeEntry.parse(daily(date, user)["day_entries"])
+      end
+
+      def trackable_projects(date = ::Time.now, user = nil)
+        Harvest::TrackableProject.parse(daily(date, user)["projects"])
       end
       
+      def toggle(id, user = nil)
+        response = request(:get, credentials, "/daily/timer/#{id}", :query => of_user_query(user))
+        Harvest::TimeEntry.parse(response.parsed_response).first
+      end
+
       def create(entry, user = nil)
         response = request(:post, credentials, '/daily/add', :body => entry.to_json, :query => of_user_query(user))
         Harvest::TimeEntry.parse(response.parsed_response).first
@@ -27,6 +34,15 @@ module Harvest
         request(:delete, credentials, "/daily/delete/#{entry.to_i}", :query => of_user_query(user))
         entry.id
       end
+
+
+      private
+
+      def daily(date, user)
+        date = ::Time.parse(date) if String === date
+        response = request(:get, credentials, "/daily/#{date.yday}/#{date.year}", :query => of_user_query(user))
+        JSON.parse(response.body)
+      end
     end
   end
 end

data/lib/harvest/errors.rb

@@ -4,15 +4,17 @@ module Harvest
   class HTTPError < StandardError
     attr_reader :response
     attr_reader :params
+    attr_reader :hint
 
-    def initialize(response, params = {})
+    def initialize(response, params = {}, hint = nil)
       @response = response
       @params = params
+      @hint = hint
       super(response)
     end
     
     def to_s
-      "#{self.class.to_s} : #{response.code} #{response.body}"
+      "#{self.class.to_s} : #{response.code} #{response.body}" + (hint ? "\n#{hint}" : "")
     end
   end
   

data/lib/harvest/trackable_project.rb

@@ -0,0 +1,38 @@
+module Harvest
+
+  # The model for project-tasks combinations that can be added to the timesheet
+  #
+  # == Fields
+  # [+id+] the id of the project
+  # [+name+] the name of the project
+  # [+client+] the name of the client of the project
+  # [+client_id+] the client id of the project
+  # [+tasks+] trackable tasks for the project
+  class TrackableProject < Hashie::Mash
+    include Harvest::Model
+    
+    skip_json_root true
+
+    def initialize(args = {}, _ = nil)
+      args       = args.to_hash.stringify_keys
+      self.tasks = args.delete("tasks") if args["tasks"]
+      super
+    end
+    
+    def tasks=(tasks)
+      self["tasks"] = Task.parse(tasks)
+    end
+  
+    # The model for trackable tasks
+    #
+    # == Fields
+    # [+id+] the id of the task
+    # [+name+] the name of the task
+    # [+billable+] whether the task is billable by default
+    class Task < Hashie::Mash
+      include Harvest::Model
+      
+      skip_json_root true
+    end
+  end
+end

data/lib/harvested.rb

@@ -19,7 +19,7 @@ require 'harvest/timezones'
 require 'harvest/base'
 
 %w(crud activatable).each {|a| require "harvest/behavior/#{a}"}
-%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice invoice_payment).each {|a| require "harvest/#{a}"}
+%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice invoice_payment trackable_project).each {|a| require "harvest/#{a}"}
 %w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports invoice_categories invoices invoice_payments).each {|a| require "harvest/api/#{a}"}
 
 module Harvest

data/spec/functional/account_spec.rb

@@ -4,7 +4,7 @@ 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 == 100
+      status.max_calls.should == 500
     end
   end
   

data/spec/functional/invoice_spec.rb

@@ -23,7 +23,7 @@ describe 'harvest invoices' do
       invoice = harvest.invoices.create(invoice)
 
       invoice.subject.should == "Invoice for Joe's Stream Cleaning"
-      invoice.amount.should == "2400.0"
+      invoice.amount.should == 2400.0
       invoice.line_items.size.should == 1
 
       invoice.subject    = "Updated Invoice for Joe"
@@ -31,7 +31,7 @@ describe 'harvest invoices' do
 
       invoice = harvest.invoices.update(invoice)
       invoice.subject.should == "Updated Invoice for Joe"
-      invoice.amount.should == "4800.0"
+      invoice.amount.should == 4800.0
       invoice.line_items.size.should == 2
 
       harvest.invoices.delete(invoice)
@@ -75,13 +75,13 @@ describe 'harvest invoices' do
       invoice = harvest.invoices.create(invoice)
 
       invoice.subject.should == "Invoice for Frannie's Widgets"
-      invoice.amount.should == "2400.0"
+      invoice.amount.should == 2400.0
       invoice.line_items.size.should == 1
       invoice.due_at.should == "2011-05-31"
 
       invoice = harvest.invoices.find(invoice.id)
       invoice.subject.should == "Invoice for Frannie's Widgets"
-      invoice.amount.should == "2400.0"
+      invoice.amount.should == 2400.0
       invoice.line_items.size.should == 1
 
       invoices = harvest.invoices.all

data/spec/functional/tasks_spec.rb

@@ -8,11 +8,11 @@ describe 'harvest tasks' do
         "billable_by_default"    => true,
         "default_hourly_rate"    => 120
       )
-      task.default_hourly_rate.should == "120.0"
+      task.default_hourly_rate.should == 120.0
 
       task.default_hourly_rate = 140
       task = harvest.tasks.update(task)
-      task.default_hourly_rate.should == "140.0"
+      task.default_hourly_rate.should == 140.0
 
       harvest.tasks.delete(task)
       harvest.tasks.all.select {|t| t.name == "A crud task"}.should == []
@@ -53,7 +53,7 @@ describe 'harvest tasks' do
         
         assignment1.hourly_rate = 100
         assignment1 = harvest.task_assignments.update(assignment1)
-        assignment1.hourly_rate.should == "100.0"
+        assignment1.hourly_rate.should == 100.0
 
         harvest.task_assignments.delete(assignment1)
         all_assignments = harvest.task_assignments.all(project)

data/spec/functional/time_tracking_spec.rb

@@ -49,5 +49,49 @@ describe 'harvest time tracking' do
     end
   end
 
-  it 'allows toggling of timers'
+  it 'allows toggling of timers' do
+    cassette("time_tracking3") do
+      client = harvest.clients.create("name" => "Jane's Used Car Shop")
+      project = harvest.projects.create("name" => "Tracking Project", "client_id" => client.id)
+      harvest.projects.create_task(project, "A billable task")
+      task = harvest.tasks.all.detect {|t| t.name == "A billable task"}
+
+      entry = harvest.time.create("notes" => "Test api support", "hours" => 3, "spent_at" => "2009/12/28", "task_id" => task.id, "project_id" => project.id)
+
+      # start existing timer
+      started_entry = harvest.time.toggle(entry.id)
+      started_entry.timer_started_at.should_not be_nil
+
+      # stop started timer
+      stopped_entry = harvest.time.toggle(started_entry.id)
+      stopped_entry.timer_started_at.should be_nil
+    end
+  end
+
+  it 'allows retrieving trackable projects and tasks' do
+    cassette("time_tracking4") do
+      client = harvest.clients.create("name" => "Bobby's Coffee Shop")
+      project = harvest.projects.create("name" => "Bobby's Trackable Project", "client_id" => client.id)
+      harvest.projects.create_task(project, "A billable task for Bobby")
+
+      trackable_projects = harvest.time.trackable_projects
+      trackable_project = trackable_projects.find {|p| p.name == "Bobby's Trackable Project" }
+      trackable_projects.first.client.should == "Bobbys Coffee Shop"
+      trackable_projects.first.tasks.first.name.should == "A billable task for Bobby"
+    end
+  end
+
+  it 'allows for absence of trackable projects' do
+    cassette("time_tracking5") do
+      user = harvest.users.create(
+        "email"      => "gary@example.com",
+        "first_name" => "Gary",
+        "last_name"  => "Doe",
+        "password"   => "secure"
+      )
+
+      trackable_projects = harvest.time.trackable_projects(Time.now, user)
+      trackable_projects.should == []
+    end
+  end
 end

data/spec/functional/users_spec.rb

@@ -92,7 +92,7 @@ describe 'harvest users' do
 
         assignment.hourly_rate = 100
         assignment = harvest.user_assignments.update(assignment)
-        assignment.hourly_rate.should == "100.0"
+        assignment.hourly_rate.should == 100.0
 
         harvest.user_assignments.delete(assignment)
         all_assignments = harvest.user_assignments.all(project)

data/spec/harvest/trackable_project_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Harvest::TrackableProject do
+  it "creates task objects" do
+    projects = Harvest::TrackableProject.parse('[{"tasks":[{"id":123}]}]').first
+    projects.tasks.first.id.should == 123
+  end
+end

data/spec/support/harvested_helpers.rb

@@ -37,7 +37,7 @@ module HarvestedHelpers
     # we store expenses on this date in the tests
     harvest.expenses.all(Time.utc(2009, 12, 28)).each {|e| harvest.expenses.delete(e) }
 
-    %w(expense_categories projects invoices contacts clients tasks).each do |collection|
+    %w(expense_categories time projects invoices contacts clients tasks).each do |collection|
       harvest.send(collection).all.each {|m| harvest.send(collection).delete(m) }
     end
   end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: harvested
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: !binary |-
+    MS4yLjA=
 platform: ruby
 authors:
 - Zach Moazeni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,23 +28,22 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: !binary |-
+          MQ==
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: !binary |-
+          MQ==
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +51,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,23 +58,22 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: !binary |-
+          Mg==
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: !binary |-
+          Mg==
 - !ruby/object:Gem::Dependency
   name: jruby-openssl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +81,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +88,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +95,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +102,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +109,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +116,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +123,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -142,7 +130,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +137,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,7 +144,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -166,7 +151,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -174,7 +158,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -182,7 +165,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -190,7 +172,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -198,7 +179,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -269,6 +249,7 @@ files:
 - lib/harvest/task_assignment.rb
 - lib/harvest/time_entry.rb
 - lib/harvest/timezones.rb
+- lib/harvest/trackable_project.rb
 - lib/harvest/user.rb
 - lib/harvest/user_assignment.rb
 - lib/harvested.rb
@@ -295,6 +276,7 @@ files:
 - spec/harvest/task_assignment_spec.rb
 - spec/harvest/task_spec.rb
 - spec/harvest/time_entry_spec.rb
+- spec/harvest/trackable_project_spec.rb
 - spec/harvest/user_assignment_spec.rb
 - spec/harvest/user_spec.rb
 - spec/spec_helper.rb
@@ -304,29 +286,25 @@ files:
 - spec/test_rubies
 homepage: http://github.com/zmoazeni/harvested
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4545923220079875304
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby Wrapper for the Harvest API http://www.getharvest.com/
 test_files: []