harvested 0.6.2 → 0.6.3

data/Gemfile

@@ -3,12 +3,15 @@ source :rubygems
 gem 'httparty'
 gem 'hashie', '~> 1'
 gem 'json'
+gem 'yard'
+gem 'redcarpet'
 
 group :development, :test do
-  gem  "rspec", "~> 2"
+  gem 'rspec', '~> 2'
   gem 'jruby-openssl', :platform => [:jruby], :require => false
-  gem  "webmock"
-  gem  "vcr"
+  gem 'webmock'
+  gem 'vcr'
   gem 'jeweler', :require => false
   gem 'debugger'
+  gem 'factory_girl'
 end

data/HISTORY

@@ -1,16 +1,20 @@
+0.6.3 - October 24, 2012
+  * Adds task activation (Thanks Mark Rickert - @markrickert)
+  * Adds basic invoice support (Thanks Jeffrey Lee - @jlee42)
+  * Adds basic invoice payment support (Thanks Adam Doeler - @releod)
 0.6.2 - August 25, 2012
-  * Fixing Mash constructor errors
+  * Fixes Mash constructor errors
 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
-  * Adding new fields has_timesheet_2012_beta and timesheet_2012_beta_control_group to Users (thanks Aldric Giacomoni)
+  * Adds new fields has_timesheet_2012_beta and timesheet_2012_beta_control_group to Users (thanks Aldric Giacomoni)
 0.5.2 - August 17, 2012
-  * Adding new field password_change_required to Users
+  * Adds new field password_change_required to Users
 0.5.1 - June 27, 2012
-  * Updating README and harvested_credentials.example.yml with warnings about normal accounts
+  * Updates README and harvested_credentials.example.yml with warnings about normal accounts
 0.5.0 - June 18, 2012
   * Bugfixes on User: https://github.com/zmoazeni/harvested/pull/26
   * Bugfixes on TimeEntry: https://github.com/zmoazeni/harvested/pull/25
@@ -18,30 +22,30 @@
   * Large rewrite of codebase
   * Rewrite of library to use JSON instead of XML
   * Rewrite of tests to use rspec instead of cucumber
-  * Brought in VCR to help cache test responses
-  * Implemented more reporting functionality
-  * Implemented most of the invoice functionality. Creating/Editing/Updating is disabled due to Harvest API issue
-  * Consolidated various forks (thanks Chris Ritterdorf, bricooke, Michelle Moon Lee, tkwong, Steve McKinney, and others that helped but aren't in the git log!)
+  * Brings in VCR to help cache test responses
+  * Implements more reporting functionality
+  * Implements most of the invoice functionality. Creating/Editing/Updating is disabled due to Harvest API issue
+  * Consolidates various forks (thanks Chris Ritterdorf, bricooke, Michelle Moon Lee, tkwong, Steve McKinney, and others that helped but aren't in the git log!)
   * Tests passing against MRI 1.8, 1.9, JRuby, and Rubinius
 0.3.3 - January 27, 2010
-  * Adding fields to TaskAssignment (Quilted)
+  * Adds fields to TaskAssignment (Quilted)
 0.3.2 - January 27, 2010
-  * Add of_user support to Time Entry (Benjamin Wong - tkwong)
+  * Adds of_user support to Time Entry (Benjamin Wong - tkwong)
 0.3.1 - October 14, 2010
-  * Updated docs removing :ssl => false since Harvest released SSL to everyone
-  * Added department to the User model (Steve McKinney - )
+  * Updates docs removing :ssl => false since Harvest released SSL to everyone
+  * Adds department to the User model (Steve McKinney - )
 0.3.0 - April 11, 2010
-  * Added users
-  * Added clients
-  * Added contacts
-  * Added expense categories
-  * Added expenses
-  * Added projects
-  * Added tasks
-  * Added task assignments
-  * Added user assignments
-  * Added time tracking
-  * Added reporting
-  * Added account information
-  * Added common errors
-  * Added Harvest#hardy_client
+  * Adds users
+  * Adds clients
+  * Adds contacts
+  * Adds expense categories
+  * Adds expenses
+  * Adds projects
+  * Adds tasks
+  * Adds task assignments
+  * Adds user assignments
+  * Adds time tracking
+  * Adds reporting
+  * Adds account information
+  * Adds common errors
+  * Adds Harvest#hardy_client

data/README.md

@@ -10,7 +10,7 @@ This is a Ruby wrapper for the [Harvest API](http://www.getharvest.com/api).
 
 ```ruby
 harvest = Harvest.client('yoursubdomain', 'yourusername', 'yourpassword')
-harvest.projects() # list out projects
+harvest.projects.all   # list out projects
 
 client = Harvest::Client.new(:name => "Billable Company LTD.")
 client = harvest.clients.create(client)
@@ -41,7 +41,7 @@ Using `Harvested#client` your code needs to handle all these situations. However
 
 ```ruby
 harvest = Harvest.hardy_client('yoursubdomain', 'yourusername', 'yourpassword')
-harvest.projects() # This will wait for the Rate Limit reset if you have gone over your limit
+harvest.projects.all   # This will wait for the Rate Limit reset if you have gone over your limit
 ```
 
 ## Ruby support
@@ -73,7 +73,7 @@ Note on running tests: most specs run against a live Harvest account. To run the
 
 **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`).
+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:
 

data/Rakefile

@@ -1,3 +1,5 @@
+$:.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'rake'
 require "bundler/setup"

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/examples/project_create_script.rb

@@ -0,0 +1,93 @@
+# File: project_create_script.rb
+# Date Created: 2012-10-08
+# Author(s): Mark Rickert (mjar81@gmail.com) / Skookum Digital Works - http://skookum.com
+#
+# Description: This example script takes user input from the command line and
+# creates a project based the selected options. It then assigns tasks from Harvest
+# to the project based on an array. After the tasks are added, it addes all the
+# currently active users to the project.
+
+require "harvested"
+
+subdomain = 'yoursubdomain'
+username = 'yourusername'
+password = 'yourpassword'
+
+harvest = Harvest.hardy_client(subdomain, username, password)
+
+puts "\nPlease search for a client by typing part of their name:"
+cname = gets.chomp
+
+# Filter out all the clients that don't match the typed string
+client_search_results = harvest.clients.all.select { |c| c.name.downcase.include?(cname) }
+
+case client_search_results.length
+when 0
+	puts "No client found.  Please try again.\n"
+	abort
+when 1
+	# Result is exactly 1. We got the client.
+	client_index = 0
+when 1..15
+	# Have the user select from a list of clients.
+	puts "Please select from the following results:\n"
+	client_search_results.each_with_index do |c, i|
+		puts "  #{i+1}. #{c.name}"
+	end
+
+	client_index = gets.chomp.to_i - 1	
+else
+	puts "Too many client matches. Please try a more specific search term.\n"
+	abort
+end
+
+client = client_search_results[client_index]
+
+puts "\nClient found: #{client.name}\n"
+puts "Please enter the project name:"
+project_name = gets.chomp
+
+puts "\nIs this project billable? (y/n)"
+billable = gets.chomp.downcase == "y"
+
+puts "\nAny project notes? (hit 'return' for none)"
+notes = gets.chomp
+
+puts "\nWhat sorts of tasks does this project need? Type \"p\" for project tasks or \"s\" for sales tasks.\n"
+task_types = gets.chomp
+
+# Determine what task list to use based on the project type.
+if task_types.downcase == "p"
+	# These are names of tasks that should already exist in Harvest
+	use_tasks = ["Client Communication", "Planning", "Design", "Development", "Testing/QA", "Documentation", "Deployment"]
+else
+	use_tasks = ["Sales Calls", "Client Meetings", "Travel", "Estimating"]
+end
+
+# Filter the list of actual tasks we want to add to the project.
+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.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.task_assignments.create(task_assignment)
+end
+
+puts
+# Add every active user to the project.
+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)
+	harvest.user_assignments.create(user_assignment)
+end
+
+puts "\nProject successfully created."
+puts "You can find the project here: http://#{subdomain}.harvestapp.com/projects/#{project.id}/edit\n\n"

data/harvested.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "harvested"
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zach Moazeni"]
-  s.date = "2012-08-25"
+  s.date = "2012-10-24"
   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 = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "examples/basics.rb",
     "examples/clear_account.rb",
+    "examples/project_create_script.rb",
     "examples/task_assignments.rb",
     "examples/user_assignments.rb",
     "harvested.gemspec",
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
     "lib/harvest/api/expense_categories.rb",
     "lib/harvest/api/expenses.rb",
     "lib/harvest/api/invoice_categories.rb",
+    "lib/harvest/api/invoice_payments.rb",
     "lib/harvest/api/invoices.rb",
     "lib/harvest/api/projects.rb",
     "lib/harvest/api/reports.rb",
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
     "lib/harvest/hardy_client.rb",
     "lib/harvest/invoice.rb",
     "lib/harvest/invoice_category.rb",
+    "lib/harvest/invoice_payment.rb",
     "lib/harvest/line_item.rb",
     "lib/harvest/model.rb",
     "lib/harvest/project.rb",
@@ -72,11 +75,13 @@ Gem::Specification.new do |s|
     "lib/harvest/user.rb",
     "lib/harvest/user_assignment.rb",
     "lib/harvested.rb",
+    "spec/factories.rb",
     "spec/functional/account_spec.rb",
     "spec/functional/clients_spec.rb",
     "spec/functional/errors_spec.rb",
     "spec/functional/expenses_spec.rb",
     "spec/functional/hardy_client_spec.rb",
+    "spec/functional/invoice_payments_spec.rb",
     "spec/functional/invoice_spec.rb",
     "spec/functional/project_spec.rb",
     "spec/functional/reporting_spec.rb",
@@ -87,6 +92,7 @@ Gem::Specification.new do |s|
     "spec/harvest/credentials_spec.rb",
     "spec/harvest/expense_category_spec.rb",
     "spec/harvest/expense_spec.rb",
+    "spec/harvest/invoice_payment_spec.rb",
     "spec/harvest/invoice_spec.rb",
     "spec/harvest/project_spec.rb",
     "spec/harvest/task_assignment_spec.rb",
@@ -102,7 +108,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/zmoazeni/harvested"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "1.8.24"
   s.summary = "A Ruby Wrapper for the Harvest API http://www.getharvest.com/"
 
   if s.respond_to? :specification_version then
@@ -112,33 +118,42 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
       s.add_runtime_dependency(%q<hashie>, ["~> 1"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<redcarpet>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2"])
       s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<vcr>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<hashie>, ["~> 1"])
       s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2"])
       s.add_dependency(%q<jruby-openssl>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<vcr>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<debugger>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
     s.add_dependency(%q<hashie>, ["~> 1"])
     s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2"])
     s.add_dependency(%q<jruby-openssl>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<vcr>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<debugger>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
   end
 end
 

data/lib/harvest/api/invoice_categories.rb

@@ -3,24 +3,24 @@ module Harvest
     class InvoiceCategories < Base
       api_model Harvest::InvoiceCategory
       include Harvest::Behavior::Crud
-      
+
       def find(*)
         raise "find is unsupported for InvoiceCategories"
       end
-      
+
       def create(model)
         model = api_model.wrap(model)
         response = request(:post, credentials, "#{api_model.api_path}", :body => model.to_json)
         id = response.headers["location"].match(/\/.*\/(\d+)/)[1]
         all.detect {|c| c.id == id.to_i }
       end
-      
+
       def update(model, user = nil)
         model = api_model.wrap(model)
         request(:put, credentials, "#{api_model.api_path}/#{model.to_i}", :body => model.to_json, :query => of_user_query(user))
         all.detect {|c| c.id == model.id }
       end
-      
+
     end
   end
-end
+end

data/lib/harvest/api/invoice_payments.rb

@@ -0,0 +1,31 @@
+module Harvest
+  module API
+    class InvoicePayments < Base
+      api_model Harvest::InvoicePayment
+      include Harvest::Behavior::Crud
+
+      def all(invoice)
+        response = request(:get, credentials, "/invoices/#{invoice.to_i}/payments")
+        api_model.parse(response.parsed_response)
+      end
+
+      def find(invoice, payment)
+        response = request(:get, credentials, "/invoices/#{invoice.to_i}/payments/#{payment.to_i}")
+        api_model.parse(response.parsed_response).first
+      end
+
+      def create(payment)
+        payment = api_model.wrap(payment)
+        response = request(:post, credentials, "/invoices/#{payment.invoice_id}/payments", :body => payment.to_json)
+        id = response.headers["location"].match(/\/.*\/(\d+)\/.*\/(\d+)/)[2]
+        find(payment.invoice_id, id)
+      end
+
+      def delete(payment)
+        request(:delete, credentials, "/invoices/#{payment.invoice_id}/payments/#{payment.to_i}")
+        payment.id
+      end
+
+    end
+  end
+end

data/lib/harvest/api/invoices.rb

@@ -3,14 +3,33 @@ module Harvest
     class Invoices < Base
       api_model Harvest::Invoice
       include Harvest::Behavior::Crud
-      
-      def create(*)
-        raise "Creating and updating invoices are not implemented due to API issues"
-      end
-      
-      def update(*)
-        raise "Creating and updating invoices are not implemented due to API issues"
+
+      # == Retrieves invoices
+      #
+      # == Available options
+      # - :status - invoices by status
+      # - :page
+      # - :updated_since
+      # - :timeframe (must be a nested hash with :to and :from)
+      #
+      # @overload all()
+      # @overload all(options)
+      #   @param [Hash] filtering options
+      #
+      # @return [Array<Harvest::Invoice>] an array of invoices
+      def all(options = {})
+        query = {}
+        query[:status]        = options[:status]        if options[:status]
+        query[:page]          = options[:page]          if options[:page]
+        query[:updated_since] = options[:updated_since] if options[:updated_since]
+        if options[:timeframe]
+          query[:from] = options[:timeframe][:from]
+          query[:to]   = options[:timeframe][:to]
+        end
+
+        response = request(:get, credentials, "/invoices", :query => query)
+        api_model.parse(response.parsed_response)
       end
     end
   end
-end
+end

data/lib/harvest/api/tasks.rb

@@ -4,6 +4,33 @@ module Harvest
       api_model Harvest::Task
 
       include Harvest::Behavior::Crud
+
+      # Deactivating tasks is not yet supported by the Harvest API.
+
+      # Deactivates the task. Does nothing if the task is already deactivated
+      # 
+      # @param [Harvest::Task] task the task you want to deactivate
+      # @return [Harvest::Task] the deactivated task
+      #def deactivate(task)
+      #  if task.active?
+      #    request(:post, credentials, "#{api_model.api_path}/#{task.to_i}/deactivate", :headers => {'Content-Length' => '0'})
+      #    task.active = false
+      #  end
+      #  task
+      #end
+      
+      # Activates the task. Does nothing if the task is already activated
+      # 
+      # @param [Harvest::Task] task the task you want to activate
+      # @return [Harvest::Task] the activated task
+      def activate(task)
+        if !task.active?
+          request(:post, credentials, "#{api_model.api_path}/#{task.to_i}/activate", :headers => {'Content-Length' => '0'})
+          task.active = true
+        end
+        task
+      end
+
     end
   end
 end