harvested2 5.0.3

data/lib/harvest/behavior/activatable.rb

@@ -0,0 +1,31 @@
+module Harvest
+  module Behavior
+    
+    # Activate/Deactivate behaviors that can be brought into API collections
+    module Activatable
+      # Deactivates the item. Does nothing if the item is already deactivated
+      # 
+      # @param [Harvest::BaseModel] model the model you want to deactivate
+      # @return [Harvest::BaseModel] the deactivated model
+      def deactivate(model)
+        if model.active?
+          request(:post, credentials, "#{api_model.api_path}/#{model.to_i}/toggle")
+          model.is_active = false
+        end
+        model
+      end
+      
+      # Activates the item. Does nothing if the item is already activated
+      # 
+      # @param [Harvest::BaseModel] model the model you want to activate
+      # @return [Harvest::BaseModel] the activated model
+      def activate(model)
+        if !model.active?
+          request(:post, credentials, "#{api_model.api_path}/#{model.to_i}/toggle")
+          model.is_active = true
+        end
+        model
+      end
+    end
+  end
+end

data/lib/harvest/behavior/crud.rb

@@ -0,0 +1,80 @@
+module Harvest
+  module Behavior
+    module Crud
+      # Retrieves all items
+      # @return [Array<Harvest::BaseModel>] an array of models depending on where you're calling it from (e.g. [Harvest::Client] from Harvest::Base#clients)
+      def all(query_options = {})
+        response = request(:get, credentials, api_model.api_path, query: query_options)
+        response_parsed = api_model.to_json(response.parsed_response)
+
+        if response_parsed['total_pages'] > 1
+          counter = response_parsed['page']
+
+          while counter <= response_parsed['total_pages'] do
+            counter += 1
+            query_options = query_options.merge!({ 'page' => counter })
+
+            response_page = request(:get, credentials, api_model.api_path,
+              query: query_options)
+            page_result = api_model.to_json(response_page.parsed_response)
+            response_parsed[api_model.json_root.pluralize.to_s]
+              .concat(page_result[api_model.json_root.pluralize.to_s])
+          end
+        end
+
+        api_model.parse(response_parsed)
+      end
+
+      # Retrieves an item by id
+      # @overload find(id)
+      #   @param [Integer] the id of the item you want to retreive
+      # @overload find(id)
+      #   @param [String] id the String version of the id
+      # @overload find(model)
+      #   @param [Harvest::BaseModel] id you can pass a model and it will return a refreshed version
+      #
+      # @return [Harvest::BaseModel] the model depends on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
+      def find(id, query_options = {})
+        raise 'ID is required' unless id
+
+        response = request(:get, credentials, "#{api_model.api_path}/#{id}", query: query_options)
+        api_model.parse(response.parsed_response).first
+      end
+
+      # Creates an item
+      # @param [Harvest::BaseModel] model the item you want to create
+      # @return [Harvest::BaseModel] the created model depending on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
+      def create(model)
+        model = api_model.wrap(model)
+        response = request(:post, credentials, api_model.api_path, body: model.to_json)
+        model = api_model.parse(response.parsed_response).first
+        find(model.id)
+      end
+
+      # Updates an item
+      # @param [Harvest::BaseModel] model the model you want to update
+      # @return [Harvest::BaseModel] the created model depending on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
+      def update(model)
+        model = api_model.wrap(model)
+        response = request(:put, credentials, "#{api_model.api_path}/#{model.id}", body: model.to_json)
+        model = api_model.parse(response.parsed_response).first
+        find(model.id)
+      end
+
+      # Deletes an item
+      # @overload delete(model)
+      #  @param [Harvest::BaseModel] model the item you want to delete
+      # @overload delete(id)
+      #  @param [Integer] id the id of the item you want to delete
+      # @overload delete(id)
+      #  @param [String] id the String version of the id of the item you want to delete
+      #
+      # @return [Integer] the id of the item deleted
+      def delete(model)
+        model = api_model.wrap(model)
+        response = request(:delete, credentials, "#{api_model.api_path}/#{model.id}")
+        model.id
+      end
+    end
+  end
+end

data/lib/harvest/client.rb

@@ -0,0 +1,23 @@
+module Harvest
+  # The model that contains information about a client
+  #
+  # == Fields
+  # [+id+] (READONLY) the id of the client
+  # [+name+] (REQUIRED) the name of the client
+  # [+details+] the details of the client
+  # [+currency+] what type of currency is associated with the client
+  # [+currency_symbol+] what currency symbol is associated with the client
+  # [+active?+] true|false on whether the client is active
+  # [+highrise_id+] (READONLY) the highrise id associated with this client
+  # [+update_at+] (READONLY) the last modification timestamp
+  class Client < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/clients'
+
+    def is_active=(val)
+      self.active = val
+    end
+  end
+end

data/lib/harvest/company.rb

@@ -0,0 +1,8 @@
+module Harvest
+  class Company < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/company'
+  end
+end

data/lib/harvest/contact.rb

@@ -0,0 +1,20 @@
+module Harvest
+  # The model that contains information about a client contact
+  #
+  # == Fields
+  # [+id+] (READONLY) the id of the contact
+  # [+client_id+] (REQUIRED) the id of the client this contact is associated with
+  # [+first_name+] (REQUIRED) the first name of the contact
+  # [+last_name+] (REQUIRED) the last name of the contact
+  # [+email+] the email of the contact
+  # [+title+] the title of the contact
+  # [+phone_office+] the office phone number of the contact
+  # [+phone_moble+] the moble phone number of the contact
+  # [+fax+] the fax number of the contact
+  class Contact < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/contacts'
+  end
+end

data/lib/harvest/credentials.rb

@@ -0,0 +1,34 @@
+module Harvest
+  class BasicAuthCredentials
+    def initialize(access_token: nil, account_id: nil)
+      @access_token = access_token
+      @account_id = account_id
+    end
+
+    def set_authentication(request_options)
+      request_options[:headers] ||= {}
+      request_options[:headers]['Authorization'] = "Bearer #{@access_token}"
+      request_options[:headers]['Harvest-Account-ID'] = @account_id
+    end
+
+    def host
+      'https://api.harvestapp.com/v2'
+    end
+  end
+
+  class OAuthCredentials
+    def initialize(access_token: nil, client_id: nil)
+      @access_token = access_token
+      @client_id = client_id
+    end
+
+    def set_authentication(request_options)
+      request_options[:query] ||= {}
+      request_options[:query]["access_token"] = @access_token
+    end
+
+    def host
+      'https://api.harvestapp.com/v2'
+    end
+  end
+end

data/lib/harvest/errors.rb

@@ -0,0 +1,27 @@
+module Harvest
+  class HTTPError < StandardError
+    attr_reader :response
+    attr_reader :params
+    attr_reader :hint
+
+    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}" +
+        (hint ? "\n#{hint}" : "")
+    end
+  end
+
+  class RateLimited < HTTPError; end
+  class NotFound < HTTPError; end
+  class Unavailable < HTTPError; end
+  class InformHarvest < HTTPError; end
+  class BadRequest < HTTPError; end
+  class ServerError < HTTPError; end
+  class AuthenticationFailed < HTTPError ; end
+end

data/lib/harvest/expense.rb

@@ -0,0 +1,54 @@
+module Harvest
+  class Expense < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/expenses'
+
+    delegate_methods(billed?: :is_billed,
+                     closed?: :is_closed)
+
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      self.receipt = args.delete('receipt') if args['receipt']
+      self.user = args.delete('user') if args['user']
+      self.project = args.delete('project') if args['project']
+      self.client = args.delete('client') if args['client']
+      self.spent_date = args.delete('spent_date') if args['spent_date']
+      self.user_assignment = args.delete('user_assignment') if args['user_assignment']
+      self.expense_category = args.delete('expense_category') if args['expense_category']
+      super
+    end
+
+    def receipt=(receipt)
+      self['receipt_id'] = receipt['id']
+      self['receipt_file_name'] = receipt['file_name']
+      self['receipt_file_size'] = receipt['file_size']
+      self['receipt_content_type'] = receipt['content_type']
+    end
+
+    def user=(user)
+      self['user_id'] = user['id']
+    end
+
+    def project=(project)
+      self['project_id'] = project['id']
+    end
+
+    def client=(client)
+      self['client_id'] = client['id']
+    end
+
+    def spent_date=(date)
+      self['spent_date'] = Date.parse(date.to_s)
+    end
+
+    def user_assignment=(user_assignment)
+      self['user_assignment_id'] = user_assignment['id']
+    end
+
+    def expense_category=(expense_category)
+      self['expense_category_id'] = expense_category['id']
+    end
+  end
+end

data/lib/harvest/expense_category.rb

@@ -0,0 +1,10 @@
+module Harvest
+  class ExpenseCategory < Hashie::Mash
+    include Harvest::Model
+    api_path '/expense_categories'
+
+    def active?
+      !deactivated
+    end
+  end
+end

data/lib/harvest/hardy_client.rb

@@ -0,0 +1,80 @@
+module Harvest
+  class HardyClient < Delegator
+    def initialize(client, max_retries)
+      super(client)
+      @_sd_obj = @client = client
+      @max_retries = max_retries
+      (@client.public_methods - Object.public_instance_methods).each do |name|
+        instance_eval <<-END
+          def #{name}(*args)
+            wrap_collection do
+              @client.send('#{name}', *args)
+            end
+          end
+        END
+      end
+    end
+
+    def __getobj__; @_sd_obj; end
+    def __setobj__(obj); @_sd_obj = obj; end
+
+    def wrap_collection
+      collection = yield
+      HardyCollection.new(collection, self, @max_retries)
+    end
+
+    class HardyCollection < Delegator
+      def initialize(collection, client, max_retries)
+        super(collection)
+        @_sd_obj = @collection = collection
+        @client = client
+        @max_retries = max_retries
+        (@collection.public_methods - Object.public_instance_methods).each do |name|
+          instance_eval <<-END
+            def #{name}(*args)
+              retry_rate_limits do
+                @collection.send('#{name}', *args)
+              end
+            end
+          END
+        end
+      end
+
+      def __getobj__; @_sd_obj; end
+      def __setobj__(obj); @_sd_obj = obj; end
+
+      def retry_rate_limits
+        retries = 0
+
+        retry_func = lambda do |e|
+          if retries < @max_retries
+            retries += 1
+            true
+          else
+            raise e
+          end
+        end
+
+        begin
+          yield
+        rescue Harvest::RateLimited => e
+          seconds = if e.response.headers['retry-after']
+            e.response.headers['retry-after'].to_i
+          else
+            16
+          end
+          sleep(seconds)
+          retry
+        rescue Harvest::Unavailable, Harvest::InformHarvest => e
+          would_retry = retry_func.call(e)
+          sleep(16) if @client.account.rate_limit_status.over_limit?
+          retry if would_retry
+        rescue Net::HTTPError, Net::HTTPFatalError => e
+          retry if retry_func.call(e)
+        rescue SystemCallError => e
+          retry if e.is_a?(Errno::ECONNRESET) && retry_func.call(e)
+        end
+      end
+    end
+  end
+end

data/lib/harvest/invoice.rb

@@ -0,0 +1,75 @@
+module Harvest
+
+  # == Fields
+  # [+due_at+] when the invoice is due
+  # [+due_at_human_format+] when the invoice is due in human representation (e.g., due upon receipt) overrides +due_at+
+  # [+client_id+] (REQUIRED) the client id of the invoice
+  # [+currency+] the invoice currency
+  # [+issued_at+] when the invoice was issued
+  # [+subject+] subject line for the invoice
+  # [+notes+] notes on the invoice
+  # [+number+] invoice number
+  # [+kind+] (REQUIRED) the type of the invoice +free_form|project|task|people|detailed+
+  # [+projects_.idnvoice+] comma separated project ids to gather data from
+  # [+import_hours+] import hours from +project|task|people|detailed+ one of +yes|no+
+  # [+import_expenses+] import expenses from +project|task|people|detailed+ one of +yes|no+
+  # [+period_start+] start of the invoice period
+  # [+period_end+] end of the invoice period
+  # [+expense_period_start+] start of the invoice expense period
+  # [+expense_period_end+] end of the invoice expense period
+  # [+created_at+] (READONLY) when the invoice was created
+  # [+updated_at+] (READONLY) when the invoice was updated
+  # [+id+] (READONLY) the id of the invoice
+  # [+amount+] (READONLY) the amount of the invoice
+  # [+due_amount+] (READONLY) the amount due on the invoice
+  # [+created_by_id+] who created the invoice
+  # [+purchase_order+] purchase order number/text
+  # [+client_key+] unique client key
+  # [+state+] (READONLY) state of the invoice
+  # [+tax+] applied tax percentage
+  # [+tax2+] applied tax 2 percentage
+  # [+tax_amount+] amount to tax
+  # [+tax_amount2+] amount to tax 2
+  # [+discount_amount+] discount amount to apply to invoice
+  # [+discount_type+] discount type
+  # [+recurring_invoice_id+] the id of the original invoice
+  # [+estimate_id+] id of the related estimate
+  # [+retainer_id+] id of the related retainer
+  class Invoice < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/invoices'
+
+    attr_reader :line_items
+
+    def initialize(args = {}, _ = nil)
+      if args
+        args = args.stringify_keys
+        self.client = args.delete('client') if args['client']
+        self.creator = args.delete('creator') if args['creator']
+        self.line_items = args.delete('line_items') if args['line_items']
+        self.line_items = [] if self.line_items.nil?
+        super
+      end
+    end
+
+    def client=(client)
+      self['client_id'] = client['id']
+    end
+
+    def creator=(creator)
+      self['creator_id'] = creator['id']
+    end
+
+    def line_items=(line_items)
+      @line_items = line_items.map do |row|
+        Harvest::LineItem.new(row)
+      end || []
+    end
+
+    def invoice_as_json
+      { 'invoice' => { 'id' => invoice_id } }
+    end
+  end
+end