harvested 0.3.0

data/features/user_assignments.feature

@@ -0,0 +1,33 @@
+@clean
+Feature: User Assignments
+  
+  Scenario: Adding and Updating a User on a Project
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create a client with the following:
+    | name    | Client Projects                         |
+    | details | Building API Widgets across the country |
+    When I create a project for the client "Client Projects" with the following:
+    | name   | Test Project            |
+    | active | true                    |
+    | notes  | project to test the api |
+    Then there should be a project "Test Project"
+    When I create a user with the following:
+    | first_name            | Edgar          |
+    | last_name             | Ruth           |
+    | email                 | edgar@ruth.com |
+    | password              | mypassword     |
+    | password_confirmation | mypassword     |
+    Then there should be a user "edgar@ruth.com"
+    When I assign the user "edgar@ruth.com" to the project "Test Project"
+    Then the user "edgar@ruth.com" should be assigned to the project "Test Project"
+    When I update the user "edgar@ruth.com" on the project "Test Project" with the following:
+    | hourly_rate     | 50.0 |
+    | project_manager | true |
+    Then the user "edgar@ruth.com" on the project "Test Project" should have the following attributes:
+    | active?         | true |
+    | hourly_rate     | 50.0 |
+    | project_manager | true |
+    When I remove the user "edgar@ruth.com" from the project "Test Project"
+    Then the user "edgar@ruth.com" should not be assigned to the project "Test Project"
+      
+  Scenario: Removing a user from a project that has recorded hours

data/features/users.feature

@@ -0,0 +1,55 @@
+@clean
+Feature: Managing People
+
+  Scenario: Adding and Removing a User
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    When I create a user with the following:
+    | first_name            | Edgar          |
+    | last_name             | Ruth           |
+    | email                 | edgar@ruth.com |
+    | password              | mypassword     |
+    | password_confirmation | mypassword     |
+    | timezone              | cst            |
+    | admin                 | false          |
+    | telephone             | 444-4444       |
+    Then there should be a user "edgar@ruth.com"
+    When I update the user "edgar@ruth.com" with the following:
+    | first_name | Jonah |
+    | timezone   | pst   |
+    Then the user "edgar@ruth.com" should have the following attributes:
+    | first_name | Jonah                      |
+    | timezone   | Pacific Time (US & Canada) |
+    When I delete the user "edgar@ruth.com"
+    Then there should not be a user "edgar@ruth.com"
+    
+  Scenario: Activating and Deactivating a User
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    Then I create a user with the following:
+    | first_name            | Simon           |
+    | last_name             | Steel           |
+    | email                 | simon@steel.com |
+    | password              | mypassword      |
+    | password_confirmation | mypassword      |
+    | timezone              | cst             |
+    | admin                 | false           |
+    | telephone             | 444-4444        |
+    Then the user "simon@steel.com" should be activated
+    When I deactivate the user "simon@steel.com"
+    Then the user "simon@steel.com" should be deactivated
+    When I activate the user "simon@steel.com"
+    Then the user "simon@steel.com" should be activated
+    Then I delete the user "simon@steel.com"
+  
+  Scenario: Resetting a User's password
+    Given I am using the credentials from "./support/harvest_credentials.yml"
+    Then I create a user with the following:
+    | first_name            | Edgar          |
+    | last_name             | Ruth           |
+    | email                 | edgar@ruth.com |
+    | password              | mypassword     |
+    | password_confirmation | mypassword     |
+    | timezone              | cst            |
+    | admin                 | false          |
+    | telephone             | 444-4444       |
+    Then there should be a user "edgar@ruth.com"
+    Then I reset the password of "edgar@ruth.com"

data/lib/harvest/api/account.rb

@@ -0,0 +1,10 @@
+module Harvest
+  module API
+    class Account < Base
+      def rate_limit_status
+        response = request(:get, credentials, '/account/rate_limit_status')
+        Harvest::RateLimitStatus.parse(response.body)
+      end
+    end
+  end
+end

data/lib/harvest/api/base.rb

@@ -0,0 +1,42 @@
+module Harvest
+  module API
+    class Base
+      attr_reader :credentials
+    
+      def initialize(credentials)
+        @credentials = credentials
+      end
+    
+      class << self
+        def api_model(klass)
+          class_eval <<-END
+            def api_model
+              #{klass}
+            end
+          END
+        end
+      end
+    
+      protected
+        def request(method, credentials, path, options = {})
+          response = HTTParty.send(method, "#{credentials.host}#{path}", :query => options[:query], :body => options[:body], :headers => {"Accept" => "application/xml", "Content-Type" => "application/xml; charset=utf-8", "Authorization" => "Basic #{credentials.basic_auth}", "User-Agent" => "Harvestable/#{Harvest::VERSION}"}.update(options[:headers] || {}), :format => :plain)
+          case response.code
+          when 200..201
+            response
+          when 400
+            raise Harvest::BadRequest.new(response)
+          when 404
+            raise Harvest::NotFound.new(response)
+          when 500
+            raise Harvest::ServerError.new(response)
+          when 502
+            raise Harvest::Unavailable.new(response)
+          when 503
+            raise Harvest::RateLimited.new(response)
+          else
+            raise Harvest::InformHarvest.new(response)
+          end
+        end
+    end
+  end
+end

data/lib/harvest/api/clients.rb

@@ -0,0 +1,10 @@
+module Harvest
+  module API
+    class Clients < Base
+      api_model Harvest::Client
+    
+      include Harvest::Behavior::Crud
+      include Harvest::Behavior::Activatable
+    end
+  end
+end

data/lib/harvest/api/contacts.rb

@@ -0,0 +1,19 @@
+module Harvest
+  module API
+    class Contacts < Base
+      api_model Harvest::Contact
+    
+      include Harvest::Behavior::Crud
+    
+      def all(client_id = nil)
+        response = if client_id
+          request(:get, credentials, "/clients/#{client_id}/contacts")
+        else
+          request(:get, credentials, "/contacts")
+        end
+      
+        api_model.parse(response.body)
+      end
+    end
+  end
+end

data/lib/harvest/api/expense_categories.rb

@@ -0,0 +1,9 @@
+module Harvest
+  module API
+    class ExpenseCategories < Base
+      api_model Harvest::ExpenseCategory
+      
+      include Harvest::Behavior::Crud
+    end
+  end
+end

data/lib/harvest/api/expenses.rb

@@ -0,0 +1,28 @@
+module Harvest
+  module API
+    class Expenses < Base
+      api_model Harvest::Expense
+      
+      include Harvest::Behavior::Crud
+      
+      def all(date = ::Time.now)
+        date = ::Time.parse(date) if String === date
+        response = request(:get, credentials, "#{api_model.api_path}/#{date.yday}/#{date.year}")
+        api_model.parse(response.body)
+      end
+      
+      
+      # This is currently broken, but will come back to it
+      def attach(expense, filename, receipt)
+        body = ""
+        body << "------------------------------b7edea381b46\r\n"
+        body << %Q{Content-Disposition: form-data; name="expense[receipt]"; filename="#{filename}"\r\n}
+        body << "Content-Type: image/png\r\n"
+        body << "\r\n#{receipt.read}\r\n"
+        body << "------------------------------b7edea381b46\r\n"
+        
+        request(:post, credentials, "#{api_model.api_path}/#{expense.to_i}/receipt", :headers => {'Content-Type' => 'multipart/form-data; boundary=------------------------------b7edea381b46'}, :body => body)
+      end
+    end
+  end
+end

data/lib/harvest/api/projects.rb

@@ -0,0 +1,39 @@
+module Harvest
+  module API
+    class Projects < Base
+      api_model Harvest::Project
+      
+      include Harvest::Behavior::Crud
+      
+      def create_task(project, task_name)
+        response = request(:post, credentials, "/projects/#{project.to_i}/task_assignments/add_with_create_new_task", :body => task_xml(task_name))
+        id = response.headers["location"].first.match(/\/.*\/(\d+)\/.*\/(\d+)/)[1]
+        find(id)
+      end
+      
+      def deactivate(project)
+        if project.active?
+          request(:put, credentials, "#{api_model.api_path}/#{project.to_i}/toggle", :headers => {'Content-Length' => '0'})
+          project.active = false
+        end
+        project
+      end
+    
+      def activate(project)
+        if !project.active?
+          request(:put, credentials, "#{api_model.api_path}/#{project.to_i}/toggle", :headers => {'Content-Length' => '0'})
+          project.active = true
+        end
+        project
+      end
+      
+      private
+        def task_xml(name)
+          builder = Builder::XmlMarkup.new
+          builder.task do |t|
+            t.name(name)
+          end
+        end
+    end
+  end
+end

data/lib/harvest/api/reports.rb

@@ -0,0 +1,39 @@
+module Harvest
+  module API
+    class Reports < Base
+      
+      def time_by_project(project, start_date, end_date, user = nil)
+        query = {:from => start_date.strftime("%Y%m%d"), :to => end_date.strftime("%Y%m%d")}
+        query[:user_id] = user.to_i if user
+        
+        response = request(:get, credentials, "/projects/#{project.to_i}/entries", :query => query)
+        Harvest::TimeEntry.parse(massage_xml(response.body))
+      end
+      
+      def time_by_user(user, start_date, end_date, project = nil)
+        query = {:from => start_date.strftime("%Y%m%d"), :to => end_date.strftime("%Y%m%d")}
+        query[:project_id] = project.to_i if project
+        
+        response = request(:get, credentials, "/people/#{user.to_i}/entries", :query => query)
+        Harvest::TimeEntry.parse(massage_xml(response.body))
+      end
+      
+      def expenses_by_user(user, start_date, end_date)
+        query = {:from => start_date.strftime("%Y%m%d"), :to => end_date.strftime("%Y%m%d")}
+        
+        response = request(:get, credentials, "/people/#{user.to_i}/expenses", :query => query)
+        Harvest::Expense.parse(response.body)
+      end
+      
+      private
+        def massage_xml(original_xml)
+          # this needs to be done because of the differences in dashes and underscores in the harvest api
+          xml = original_xml
+          %w(day-entry adjustment-record created-at project-id spent-at task-id timer-started-at updated-at user-id).each do |dash_field|
+            xml = xml.gsub(dash_field, dash_field.gsub("-", "_"))
+          end
+          xml
+        end
+    end
+  end
+end

data/lib/harvest/api/task_assignments.rb

@@ -0,0 +1,32 @@
+module Harvest
+  module API
+    class TaskAssignments < Base
+      
+      def all(project)
+        response = request(:get, credentials, "/projects/#{project.to_i}/task_assignments")
+        Harvest::TaskAssignment.parse(response.body)
+      end
+      
+      def find(project, id)
+        response = request(:get, credentials, "/projects/#{project.to_i}/task_assignments/#{id}")
+        Harvest::TaskAssignment.parse(response.body, :single => true)
+      end
+      
+      def create(task_assignment)
+        response = request(:post, credentials, "/projects/#{task_assignment.project_id}/task_assignments", :body => task_assignment.task_xml)
+        id = response.headers["location"].first.match(/\/.*\/(\d+)\/.*\/(\d+)/)[2]
+        find(task_assignment.project_id, id)
+      end
+      
+      def update(task_assignment)
+        request(:put, credentials, "/projects/#{task_assignment.project_id}/task_assignments/#{task_assignment.to_i}", :body => task_assignment.to_xml)
+        find(task_assignment.project_id, task_assignment.id)
+      end
+      
+      def delete(task_assignment)
+        request(:delete, credentials, "/projects/#{task_assignment.project_id}/task_assignments/#{task_assignment.to_i}")
+        task_assignment.id
+      end
+    end
+  end
+end

data/lib/harvest/api/tasks.rb

@@ -0,0 +1,9 @@
+module Harvest
+  module API
+    class Tasks < Base
+      api_model Harvest::Task
+    
+      include Harvest::Behavior::Crud
+    end
+  end
+end

data/lib/harvest/api/time.rb

@@ -0,0 +1,32 @@
+module Harvest
+  module API
+    class Time < Base
+      
+      def find(id)
+        response = request(:get, credentials, "/daily/show/#{id}")
+        Harvest::TimeEntry.parse(response.body, :single => true)
+      end
+      
+      def all(date = ::Time.now)
+        date = ::Time.parse(date) if String === date
+        response = request(:get, credentials, "/daily/#{date.yday}/#{date.year}")
+        Harvest::TimeEntry.parse(response.body)
+      end
+      
+      def create(entry)
+        response = request(:post, credentials, '/daily/add', :body => entry.to_xml)
+        Harvest::TimeEntry.parse(response.body).first
+      end
+      
+      def update(entry)
+        request(:put, credentials, "/daily/update/#{entry.to_i}", :body => entry.to_xml)
+        find(entry.id)
+      end
+      
+      def delete(entry)
+        request(:delete, credentials, "/daily/delete/#{entry.to_i}")
+        entry.id
+      end
+    end
+  end
+end

data/lib/harvest/api/user_assignments.rb

@@ -0,0 +1,32 @@
+module Harvest
+  module API
+    class UserAssignments < Base
+      
+      def all(project)
+        response = request(:get, credentials, "/projects/#{project.to_i}/user_assignments")
+        Harvest::UserAssignment.parse(response.body)
+      end
+      
+      def find(project, id)
+        response = request(:get, credentials, "/projects/#{project.to_i}/user_assignments/#{id}")
+        Harvest::UserAssignment.parse(response.body, :single => true)
+      end
+      
+      def create(user_assignment)
+        response = request(:post, credentials, "/projects/#{user_assignment.project_id}/user_assignments", :body => user_assignment.user_xml)
+        id = response.headers["location"].first.match(/\/.*\/(\d+)\/.*\/(\d+)/)[2]
+        find(user_assignment.project_id, id)
+      end
+      
+      def update(user_assignment)
+        request(:put, credentials, "/projects/#{user_assignment.project_id}/user_assignments/#{user_assignment.id}", :body => user_assignment.to_xml)
+        find(user_assignment.project_id, user_assignment.id)
+      end
+      
+      def delete(user_assignment)
+        request(:delete, credentials, "/projects/#{user_assignment.project_id}/user_assignments/#{user_assignment.to_i}")
+        user_assignment.id
+      end
+    end
+  end
+end

data/lib/harvest/api/users.rb

@@ -0,0 +1,15 @@
+module Harvest
+  module API
+    class Users < Base
+      api_model Harvest::User
+    
+      include Harvest::Behavior::Crud
+      include Harvest::Behavior::Activatable
+    
+      def reset_password(user)
+        request(:post, credentials, "#{api_model.api_path}/#{user.to_i}/reset_password")
+        user
+      end
+    end
+  end
+end

data/lib/harvest/base.rb

@@ -0,0 +1,59 @@
+module Harvest
+  class Base
+    attr_reader :request, :credentials
+    
+    def initialize(subdomain, username, password, options = {})
+      options[:ssl] = true if options[:ssl].nil?
+      @credentials = Credentials.new(subdomain, username, password, options[:ssl])
+      raise InvalidCredentials unless credentials.valid?
+    end
+    
+    def account
+      @account ||= Harvest::API::Account.new(credentials)
+    end
+    
+    def clients
+      @clients ||= Harvest::API::Clients.new(credentials)
+    end
+    
+    def contacts
+      @contacts ||= Harvest::API::Contacts.new(credentials)
+    end
+    
+    def projects
+      @projects ||= Harvest::API::Projects.new(credentials)
+    end
+    
+    def tasks
+      @tasks ||= Harvest::API::Tasks.new(credentials)
+    end
+    
+    def users
+      @users ||= Harvest::API::Users.new(credentials)
+    end
+    
+    def task_assignments
+      @task_assignments ||= Harvest::API::TaskAssignments.new(credentials)
+    end
+    
+    def user_assignments
+      @user_assignments ||= Harvest::API::UserAssignments.new(credentials)
+    end
+    
+    def expense_categories
+      @expense_categories ||= Harvest::API::ExpenseCategories.new(credentials)
+    end
+    
+    def expenses
+      @expenses ||= Harvest::API::Expenses.new(credentials)
+    end
+    
+    def time
+      @time ||= Harvest::API::Time.new(credentials)
+    end
+    
+    def reports
+      @reports ||= Harvest::API::Reports.new(credentials)
+    end
+  end
+end