harvested2 5.0.3

data/lib/harvest/user.rb

@@ -0,0 +1,58 @@
+module Harvest
+  # The model that contains information about a task
+  #
+  # == Fields
+  # [+id+] (READONLY) the id of the user
+  # [+email+] the email of the user
+  # [+first_name+] the first name for the user
+  # [+last_name+] the last name for the user
+  # [+telephone+] the telephone for the user
+  # [+department] the department for the user
+  # [+has_access_to_all_future_projects+] whether the user should be added to future projects by default
+  # [+hourly_rate+] what the default hourly rate for the user is
+  # [+admin?+] whether the user is an admin
+  # [+contractor?+] whether the user is a contractor
+  # [+contractor?+] whether the user is a contractor
+  # [+timezone+] the timezone for the user.
+  class User < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/users'
+
+    delegate_methods(active?: :is_active,
+                     admin?: :is_admin,
+                     contractor?: :is_contractor)
+
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      args['is_admin'] = args.delete('admin') if args['admin']
+      self.timezone = args.delete('timezone') if args['timezone']
+      super
+    end
+
+    # Sets the timezone for the user. This can be done in a variety of ways.
+    #
+    # == Examples
+    #   user.timezone = :cst # the easiest way. CST, EST, MST, and PST are supported
+    #
+    #   user.timezone = 'america/chicago' # a little more verbose
+    #
+    #   user.timezone = 'Central Time (US & Canada)' # the most explicit way
+    def timezone=(timezone)
+      tz = timezone.to_s.downcase
+      case tz
+      when 'cst', 'cdt' then self.timezone = 'america/chicago'
+      when 'est', 'edt' then self.timezone = 'america/new_york'
+      when 'mst', 'mdt' then self.timezone = 'america/denver'
+      when 'pst', 'pdt' then self.timezone = 'america/los_angeles'
+      else
+        if Harvest::Timezones::MAPPING[tz]
+          self['timezone'] = Harvest::Timezones::MAPPING[tz]
+        else
+          self['timezone'] = timezone
+        end
+      end
+    end
+  end
+end

data/lib/harvest/user_assignment.rb

@@ -0,0 +1,27 @@
+module Harvest
+  class UserAssignment < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      self.user = args.delete('user') if args['user']
+      self.project = args.delete('project') if args['project']
+
+      super
+    end
+
+    def user=(user)
+      self['user_id'] = user['id']
+    end
+
+    def project=(project)
+      self['project_id'] = project['id']
+    end
+
+    def active?
+      !deactivated
+    end
+  end
+end

data/lib/harvest/version.rb

@@ -0,0 +1,3 @@
+module Harvest
+  VERSION = '5.0.3'
+end

data/lib/harvested2.rb

@@ -0,0 +1,96 @@
+require 'httparty'
+require 'base64'
+require 'delegate'
+require 'hashie'
+require 'json'
+require 'time'
+require 'csv'
+
+require 'ext/array'
+require 'ext/hash'
+require 'ext/date'
+require 'ext/time'
+
+require 'harvest/version'
+require 'harvest/credentials'
+require 'harvest/errors'
+require 'harvest/hardy_client'
+require 'harvest/timezones'
+
+require 'harvest/base'
+
+%w(crud activatable).each { |a| require "harvest/behavior/#{a}" }
+
+%w(model client contact project task user task_assignment
+user_assignment expense_category expense time_entry invoice_category
+line_item invoice invoice_payment
+invoice_message).each { |a| require "harvest/#{a}" }
+
+%w(base account clients contacts projects tasks users task_assignments
+user_assignments expense_categories expenses time_entry
+invoice_categories invoices invoice_payments
+invoice_messages).each { |a| require "harvest/api/#{a}" }
+
+module Harvest
+  class << self
+
+    # Creates a standard client that will raise all errors it encounters
+    #
+    # == Options
+    # * Basic Authentication V2
+    #   * +:access_token+ - Your Harvest access_token
+    #   * +:account_id+ - Your Harvest account_id
+    #   * +:client_id+ - An OAuth 2.0 access token
+    #
+    # == Examples
+    #   Harvest.client(access_token: 'token', account_id: '123')
+    #   Harvest.client(access_token: 'myaccesstoken', client_id: '1')
+    #
+    # @return [Harvest::Base]
+    def client(access_token: nil, account_id: nil, client_id: nil)
+      Harvest::Base.new(access_token: access_token, account_id: account_id,
+        client_id: client_id)
+    end
+
+    # Creates a hardy client that will retry common HTTP errors
+    # it encounters and sleep() if it determines it is over your rate limit
+    #
+    # == Options
+    # * Basic Authentication
+    #   * +:access_token+ - Your Harvest access_token
+    #   * +:account_id+ - Your Harvest account_id
+    #   * +:client_id+ - An OAuth 2.0 access token
+    #   * +:retry+ - How many times the hardy client should retry errors.
+    #              Set to +5+ by default.
+    #
+    # == Examples
+    #   Harvest.hardy_client(access_token: 'token', account_id: '123', retry: 3)
+    #
+    #   Harvest.hardy_client(access_token: 'myaccesstoken', client_id: '1',
+    #                        retries: 3)
+    #
+    # == Errors
+    # The hardy client will retry the following errors
+    # * Harvest::Unavailable
+    # * Harvest::InformHarvest
+    # * Net::HTTPError
+    # * Net::HTTPFatalError
+    # * Errno::ECONNRESET
+    #
+    # == Rate Limits
+    # The hardy client will make as many requests as it can until it detects it
+    # has gone over the rate limit. Then it will +sleep()+ for the how ever
+    # long it takes for the limit to reset. You can find more information about
+    # the Rate Limiting at http://www.getharvest.com/api
+    #
+    # @return [Harvest::HardyClient] a Harvest::Base wrapped in a Harvest::HardyClient
+    # @see Harvest::Base
+    def hardy_client(access_token: nil, account_id: nil, client_id: nil, retries: 5)
+      Harvest::HardyClient.new(client(
+        access_token: access_token,
+        account_id: account_id,
+        client_id: client_id),
+        retries)
+    end
+  end
+end

data/spec/factories/client.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+  factory :client, class: Harvest::Client do
+    name 'John Doe'
+    details "Steam Cleaning across the country"
+
+    trait :active do
+      active true
+    end
+
+    trait :deactive do
+      active false
+    end
+  end
+end

data/spec/factories/contact.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :contact, class: Harvest::Contact do
+    client
+    email 'jane@example.com'
+    first_name 'Jane'
+    last_name 'Doe'
+  end
+end

data/spec/factories/expense.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :expense, class: Harvest::Expense do
+    notes 'Drive to Chicago'
+    total_cost 75.0
+    spent_at Time.utc(2009, 12, 28)
+    expense_category
+    project
+  end
+end
+

data/spec/factories/expenses_category.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :expense_category, class: Harvest::ExpenseCategory do
+    name 'Mileage'
+    unit_price 100
+    unit_name 'mile'
+  end
+end

data/spec/factories/invoice.rb

@@ -0,0 +1,25 @@
+FactoryBot.define do
+  factory :invoice, class: Harvest::Invoice do
+    sequence(:id)
+    subject "Invoice for Joe's Stream Cleaning"
+    amount 2400.0
+    issued_at '2014-01-01'
+    due_at "2011-03-31"
+    due_at_human_format 'upon receipt'
+    currency 'United States Dollars - USD'
+    number '1000'
+    notes 'Some notes go here'
+    period_end '2013-03-31'
+    period_start '2013-02-26'
+    kind 'free_form'
+    state 'draft'
+    purchase_order nil
+    tax nil
+    tax2 nil
+    import_hours 'no'
+    import_expenses 'no'
+
+    client
+  end
+end
+

data/spec/factories/invoice_category.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :invoice_category, class: Harvest::InvoiceCategory do
+    name 'New Category'
+  end
+end

data/spec/factories/invoice_message.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :invoice_message, class: Harvest::InvoiceMessage do
+    body 'The message body goes here'
+    recipients 'john@example.com, jane@example.com'
+    attach_pdf true
+    send_me_a_copy true
+    include_pay_pal_link true
+  end
+end

data/spec/factories/invoice_payment.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :invoice_payment, class: Harvest::InvoicePayment do
+    paid_at Time.now
+    amount 0.00
+    notes 'Payment received'
+  end
+end

data/spec/factories/line_item.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :line_item, class: Harvest::LineItem do
+    kind 'Service'
+    description 'Description'
+    quantity 200
+    unit_price '12.00'
+    project
+  end
+end

data/spec/factories/project.rb

@@ -0,0 +1,15 @@
+FactoryBot.define do
+  factory :project, class: Harvest::Project do
+    name 'Project Test'
+    notes 'project to test the api'
+    client
+
+    trait :active do
+      active true
+    end
+
+    trait :deactive do
+      active false
+    end
+  end
+end

data/spec/factories/task.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :task, class: Harvest::Task do
+    name 'A crud task'
+    billable_by_default true
+    default_hourly_rate 120
+  end
+end
+

data/spec/factories/task_assignment.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :task_assignment, class: Harvest::TaskAssignment do
+    hourly_rate 120
+    project
+    task
+  end
+end
+

data/spec/factories/time_entry.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :time_entry, class: Harvest::TimeEntry do
+    notes 'Test api support'
+    hours 3
+    spent_date '2009/12/28'
+    task
+    project
+
+    trait :started do
+      timer_started_at '2009/12/28'
+    end
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,19 @@
+FactoryBot.define do
+  factory :user, class: Harvest::User do
+    sequence(:id)
+    first_name 'Edgar'
+    last_name 'Ruth'
+    email 'edgar@ruth.com'
+    timezone 'cst'
+    is_admin 'false'
+    telephone '444-4444'
+
+    trait :active do
+      is_active true
+    end
+
+    trait :deactive do
+      is_active false
+    end
+  end
+end

data/spec/factories/user_assigment.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :user_assignment, class: Harvest::UserAssignment do
+    hourly_rate 120
+    project
+    user
+  end
+end

data/spec/functional/clients_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe 'harvest clients' do
+  let(:harvest) { Harvest.client(access_token: 'mytoken', account_id: '123') }
+
+  describe 'clients' do
+    let(:client) { create(:client) }
+    let(:client_attributes) { FactoryBot.attributes_for(:client) }
+
+    context 'allows to add clients' do
+      before do
+        allow(harvest.clients).to receive(:create).and_return(client)
+      end
+
+      it 'returns true' do
+        expect(client.name).to eql(client_attributes[:name])
+      end
+    end
+
+    context 'allows to update clients' do
+      before do
+        allow(harvest.clients).to receive(:update).and_return(client)
+        client.name = "Joe and Frank's Steam Cleaning"
+        client = harvest.clients.update(client)
+      end
+
+      it 'returns true' do
+        expect(client.name).to eql("Joe and Frank's Steam Cleaning")
+      end
+    end
+
+    context 'allows to remove clients' do
+      before do
+        allow(harvest.clients).to receive(:delete).and_return([])
+        allow(harvest.clients).to receive(:all).and_return([])
+        harvest.clients.delete(client)
+      end
+
+      it 'returns true' do
+        expect(harvest.clients.all.select do |p|
+          p.name == "Joe and Frank's Steam Cleaning"
+        end).to eql([])
+      end
+    end
+
+    context 'allows activating and deactivating clients' do
+      let(:active_client) { create(:client, :active) }
+      let(:deactive_client) { create(:client, :deactive) }
+
+      before do
+        allow(harvest.clients).to receive(:deactivate)
+          .and_return(deactive_client)
+        allow(harvest.clients).to receive(:activate)
+          .and_return(active_client)
+      end
+
+      it 'should be active' do
+        expect(active_client).to be_active
+      end
+
+      it 'should be deactive' do
+        client = harvest.clients.deactivate(client)
+        expect(deactive_client).not_to be_active
+      end
+
+      it 'should reactive a client' do
+        client = harvest.clients.activate(client)
+        expect(active_client).to be_active
+      end
+    end
+  end
+
+  describe 'contacts' do
+    let(:client) { create(:client) }
+    let(:contact) { create(:contact, client: client) }
+    let(:contact_attributes) { FactoryBot.attributes_for(:contact) }
+
+    context 'allows to add contacts' do
+      before do
+        allow(harvest.contacts).to receive(:create)
+          .and_return(contact)
+        contact = harvest.contacts.create(contact_attributes)
+      end
+
+      it 'should be true' do
+        expect(contact.client_id).to eql(client.id)
+        expect(contact.email).to eql('jane@example.com')
+      end
+    end
+
+    context 'allows to delete contacts' do
+      before do
+        allow(harvest.contacts).to receive(:delete).and_return([])
+        allow(harvest.contacts).to receive(:all).and_return([])
+        contact = harvest.contacts.delete(contact)
+      end
+
+      it 'should return empty' do
+        expect(harvest.contacts.all.select do |e|
+          e.email == 'jane@example.com'
+        end).to eql([])
+      end
+    end
+  end
+end