harvested 0.3.0

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+spec.opts
+
+## PROJECT::SPECIFIC
+features/support/harvest_credentials.yml

data/HISTORY

@@ -0,0 +1,16 @@
+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
+  

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Zach Moazeni
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Harvested: A Ruby Harvest API
+
+This is a Ruby wrapper for the [Harvest API](http://www.getharvest.com/).
+
+## Installation
+
+    gem install harvested
+
+## Examples
+
+    harvest = Harvest.client('yoursubdomain', 'yourusername', 'yourpassword', :ssl => false) # you can enable SSL if your account supports it
+    harvest.projects() # list out projects
+    
+    client = Harvest::Client.new(:name => "Billable Company LTD.")
+    client = harvest.clients.create(client)
+    harvest.clients.find(client.id) # returns a Harvest::Client
+
+You can find more examples in `/examples`
+
+## 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.
+
+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.
+
+    harvest = Harvest.hardy_client('yoursubdomain', 'yourusername', 'yourpassword', :ssl => false)
+    harvest.projects() # This will wait for the Rate Limit reset if you have gone over your limit
+
+## Links
+
+* [Harvest API Documentation](http://www.getharvest.com/api)
+* [Source Code for Harvested](http://github.com/zmoazeni/harvested)
+* [Pivotal Tracker for Harvested](http://www.pivotaltracker.com/projects/63260)
+* [Mailing List for Harvested](http://groups.google.com/group/harvested)
+
+## How to Contribute
+
+If you find what looks like a bug:
+
+1. Check the GitHub issue tracker to see if anyone else has had the same issue.
+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 cucumber features run against a live Harvest account. To run the suite, sign up for a free trial account and fill out `/features/support/harvest_credentials.yml` *(a sample harvest_credentials.example.yml has been included)*. The tests use the hardy_client so they will wait for a rate limit reset when they detect the limit has been hit.
+
+## TODO
+
+* Write Documentation
+* Implement Invoices
+* Allow Timer Toggling
+
+Other Roadmap items can be found on [Pivotal Tracker](http://www.pivotaltracker.com/projects/63260)
+
+## Notes on Harvest Estimates
+
+Estimates aren't currently supported due to lack of an API. If this opens up, harvested will include them.
+
+## Copyright
+
+Copyright (c) 2010 Zach Moazeni. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "harvested"
+    gem.summary = %Q{A Ruby Wrapper for the Harvest API http://www.getharvest.com/}
+    gem.description = %Q{Harvested wraps the Harvest API concisely without the use of Rails dependencies. More information about the Harvest API can be found at http://www.getharvest.com/api}
+    gem.email = "zach.moazeni@gmail.com"
+    gem.homepage = "http://github.com/zmoazeni/harvested"
+    gem.authors = ["Zach Moazeni"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_development_dependency "ruby-debug", ">= 0"
+    gem.add_development_dependency "fakeweb", ">= 0"
+    gem.add_dependency "httparty", ">= 0"
+    gem.add_dependency "happymapper", ">= 0"
+    gem.add_dependency "builder", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  p e
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => %w(spec features)

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/examples/basics.rb

@@ -0,0 +1,35 @@
+require "harvested"
+
+subdomain = 'yoursubdomain'
+username = 'yourusername'
+password = 'yourpassword'
+
+harvest = Harvest.hardy_client(subdomain, username, password, :ssl => false)
+
+# Print out all users, clients, and projects on the account
+puts "Users:"
+harvest.users.all.each {|u| p u }
+
+puts "Clients:"
+harvest.clients.all.each {|c| p c }
+
+puts "Projects:"
+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.clients.create(client)
+
+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.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}

data/examples/clear_account.rb

@@ -0,0 +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, :ssl => false)
+# 
+# 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

data/examples/task_assignments.rb

@@ -0,0 +1,27 @@
+require "harvested"
+
+subdomain = 'yoursubdomain'
+username = 'yourusername'
+password = 'yourpassword'
+
+harvest = Harvest.hardy_client(subdomain, username, password, :ssl => false)
+
+# Create a Client add a Project to that Client
+
+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.projects.create(project)
+
+# You can create an assign a task in one call
+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.tasks.create(task)
+
+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'"

data/examples/user_assignments.rb

@@ -0,0 +1,24 @@
+require "harvested"
+
+subdomain = 'yoursubdomain'
+username = 'userusername'
+password = 'yourpassword'
+
+harvest = Harvest.hardy_client(subdomain, username, password, :ssl => false)
+
+# Create a Client, Project, and a User then assign that User to that Project
+
+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.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', :password_confirmation => 'secure')
+user = harvest.users.create(user)
+
+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"'

data/features/account.feature

@@ -0,0 +1,7 @@
+@clean
+Feature: Account API
+
+  Scenario: Requesting Rate Limit
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I request the current rate limit I should get the following:
+    | max_calls | 40 |

data/features/client_contacts.feature

@@ -0,0 +1,23 @@
+@clean
+Feature: Managing Client Contacts
+
+  Scenario: Adding, Updating, and Removing a Contact
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    And I create a client with the following:
+    | name    | Client Contacts                         |
+    | details | Building API Widgets across the country |
+    When I create a contact for the client "Client Contacts" with the following:
+    | email        | jane@doe.com |
+    | first_name   | Jane         |
+    | last_name    | Doe          |
+    | phone_office | 555.123.4567 |
+    | phone_mobile | 555.333.1111 |
+    | fax          | 555.222.1111 |
+    Then there should be a contact "jane@doe.com"
+    And there should be a contact "jane@doe.com" for the client "Client Contacts"
+    When I update the contact "jane@doe.com" with the following:
+    | last_name | Smith |
+    Then the contact "jane@doe.com" should have the following attributes:
+    | last_name | Smith |
+    When I delete the contact "jane@doe.com"
+    Then there should not be a contact "jane@doe.com"

data/features/clients.feature

@@ -0,0 +1,29 @@
+@clean
+Feature: Managing Clients
+
+  Scenario: Adding, Updating, and Removing a Client
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create a client with the following:
+    | name    | Client                                  |
+    | details | Building API Widgets across the country |
+    Then there should be a client "Client"
+    When I update the client "Client" with the following:
+    | name    | Updated Client                      |
+    | details | Building API Widgets in the Midwest |
+    Then the client "Updated Client" should have the following attributes:
+    | details | Building API Widgets in the Midwest |
+    When I delete the client "Updated Client"
+    Then there should not be a client "Updated Client"
+
+  Scenario: Activating and Deactivating a Client
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create a client with the following:
+    | name    | Client                                  |
+    | details | Building API Widgets across the country |
+    Then the client "Client" should be activated
+    When I deactivate the client "Client"
+    Then the client "Client" should be deactivated
+    When I activate the client "Client"
+    Then the client "Client" should be activated
+    Then I delete the client "Client"
+    

data/features/errors.feature

@@ -0,0 +1,25 @@
+@disconnected
+Feature: Handling Harvest Errors
+
+  Scenario: Raising Bad Responses
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    
+    Given the next request will receive a bad request response
+    When I make a request with the standard client
+    Then a 400 error should be raised
+    
+    Given the next request will receive a not found response
+    When I make a request with the standard client
+    Then a 404 error should be raised
+    
+    Given the next request will receive a bad gateway response
+    When I make a request with the standard client
+    Then a 502 error should be raised
+    
+    Given the next request will receive a server error response
+    When I make a request with the standard client
+    Then a 500 error should be raised
+    
+    Given the next request will receive a rate limit response
+    When I make a request with the standard client
+    Then a 503 error should be raised

data/features/expense_categories.feature

@@ -0,0 +1,21 @@
+@clean
+Feature: Expense Categories
+
+  Scenario: Adding, Updating, and Removing an Expense Category
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create an expense category with the following:
+    | name       | Mileage |
+    | unit_name  | Miles   |
+    | unit_price | 0.485   |
+    Then there should be an expense category "Mileage"
+    When I update the expense category "Mileage" with the following:
+    | unit_name   | Kilometers |
+    | deactivated | true       |
+    | unit_price  | 1.2        |
+    Then the expense category "Mileage" should have the following attributes:
+    | unit_name   | Kilometers |
+    | unit_price  | 1.2        |
+    | deactivated | true       |
+    | active?     | false      |
+    When I delete the expense category "Mileage"
+    Then there should not be an expense category "Mileage"

data/features/expenses.feature

@@ -0,0 +1,55 @@
+@clean
+Feature: Expenses
+
+  Scenario: Adding, Updating, and Removing an Expenses
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create an expense category with the following:
+    | name       | Mileage |
+    | unit_name  | Miles   |
+    | unit_price | 0.485   |
+    Then there should be an expense category "Mileage"
+    When I create a client with the following:
+    | name | Expense Client |
+    When I create a project for the client "Expense Client" with the following:
+    | name | Test Project |
+    When I create an expense for the project "Test Project" with the category "Mileage" with the following:
+    | notes      | Drive to Chicago |
+    | total_cost | 75.00            |
+    | spent_at   | 12/28/2009       |
+    Then there should be an expense "Drive to Chicago" on "12/28/2009"
+    And the expense "Drive to Chicago" on "12/28/2009" should have the following attributes:
+    | total_cost | 75.0 |
+    | units      | 1    |
+    When I update the expense "Drive to Chicago" on "12/28/2009" with the following:
+    | total_cost | 50 |
+    Then the expense "Drive to Chicago" on "12/28/2009" should have the following attributes:
+    | total_cost | 50.0 |
+    | units      | 1    |
+    When I update the expense "Drive to Chicago" on "12/28/2009" with the following:
+    | total_cost |   |
+    | units      | 3 |
+    Then the expense "Drive to Chicago" on "12/28/2009" should have the following attributes:
+    | total_cost | 1.46 |
+    | units      | 3    |
+    When I delete the expense "Drive to Chicago" on "12/28/2009"
+    Then there should not be an expense "Drive to Chicago" on "12/28/2009"
+  
+  @wip
+  Scenario: Attaching a receipt to an Expense
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create an expense category with the following:
+    | name       | Mileage |
+    | unit_name  | Miles   |
+    | unit_price | 0.485   |
+    Then there should be an expense category "Mileage"
+    When I create a client with the following:
+    | name | Expense Client |
+    When I create a project for the client "Expense Client" with the following:
+    | name | Test Project |
+    When I create an expense for the project "Test Project" with the category "Mileage" with the following:
+    | notes      | Drive to Chicago |
+    | total_cost | 75.00            |
+    | spent_at   | 12/28/2009       |
+    Then there should be an expense "Drive to Chicago" on "12/28/2009"
+    When I attach the receipt "./support/fixtures/receipt.png" to the expense "Drive to Chicago" on "12/28/2009"
+    Then there should be a receipt "./support/fixtures/receipt.png" attached to the expense "Drive to Chicago" on "12/28/2009"