harvest-ruby-v2 0.2.0

data/lib/harvest/resourcefactory.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'harvest/resources'
+
+module Harvest
+  # Conversion for hash to Struct including nested items.
+  # TODO: Refactor for figuring out what Struct should be used
+  class NoValidStruct < ArgumentError
+  end
+
+  class ResourceFactory
+    def resource(klass, data)
+      data ||= {}
+      send(klass.to_sym, data)
+    end
+
+    def message_recipient(data)
+      data ||= {}
+      Struct::MessageRecipient.new(data)
+    end
+
+    def company(data)
+      data ||= {}
+      Struct::Company.new(data)
+    end
+
+    def estimate(data)
+      data ||= {}
+      convert_estimate_line_items(convert_client(Struct::Estimate.new(data)))
+    end
+
+    def estimate_line_item(data)
+      data ||= {}
+      Struct::EstimateLineItem.new(data)
+    end
+
+    def estimate_message(data)
+      data ||= {}
+      Struct::EstimateMessage.new(data)
+    end
+
+    def estimate_item_category(data)
+      data ||= {}
+      Struct::EstimateItemCategory.new(data)
+    end
+
+    def expense_category(data)
+      data ||= {}
+      Struct::ExpenseCategory.new(data)
+    end
+
+    def expense(data)
+      data ||= {}
+      Struct::Expense.new(data)
+    end
+
+    def invoice(data)
+      data ||= {}
+      Struct::Invoice.new(data)
+    end
+
+    def invoice_line_item(data)
+      data ||= {}
+      Struct::InvoiceLineItem.new(data)
+    end
+
+    def invoice_message(data)
+      data ||= {}
+      Struct::InvoiceMessage.new(data)
+    end
+
+    def invoice_payment(data)
+      data ||= {}
+      Struct::InvoicePayment.new(data)
+    end
+
+    def invoice_item_category(data)
+      data ||= {}
+      Struct::InvoiceItemCategory.new(data)
+    end
+
+    def project_assignment(data)
+      data ||= {}
+      unless data.nil?
+        convert_dates(
+          convert_project_client(
+            convert_task_assignments(
+              Struct::ProjectAssignment.new(data)
+            )
+          )
+        )
+      end
+    end
+
+    def project(data)
+      data ||= {}
+      convert_dates(Struct::Project.new(data)) unless data.nil?
+    end
+
+    def client(data)
+      data ||= {}
+      convert_dates(Struct::ResourceClient.new(data)) unless data.nil?
+    end
+
+    def task_assignment(data)
+      data ||= {}
+      convert_dates(convert_task(Struct::TaskAssignment.new(data))) unless data.nil?
+    end
+
+    def task(data)
+      data ||= {}
+      convert_dates(Struct::Task.new(data)) unless data.nil?
+    end
+
+    def user(data)
+      data ||= {}
+      convert_dates(Struct::User.new(data)) unless data.nil?
+    end
+
+    def user_assignment(data)
+      data ||= {}
+      convert_dates(Struct::UserAssignment.new(data)) unless data.nil?
+    end
+
+    def time_entry_external_reference(data)
+      data ||= {}
+      Struct::TimeEntryExternalReference.new(data)
+    end
+
+    def time_entry(data)
+      data ||= {}
+      convert_dates(
+        convert_project_client(
+          convert_task_assignment(
+            convert_task(
+              convert_user_assignment(
+                convert_user(
+                  convert_external_reference(
+                    Struct::TimeEntry.new(data)
+                  )
+                )
+              )
+            )
+          )
+        )
+      )
+    end
+
+    private
+
+    def convert_estimate_line_items(data)
+      unless data.line_items.nil?
+        data.line_items = data.line_items.map { |ta| estimate_line_item(ta) }
+      end
+      data
+    end
+
+    def convert_external_reference(data)
+      data.external_reference = time_entry_external_reference(data.external_reference)
+      data
+    end
+
+    def convert_user(data)
+      data.user ||= {}
+      data.user = user(data.user) unless data.nil?
+      data
+    end
+
+    def convert_user_assignment(data)
+      data.user_assignment ||= {}
+      data.user_assignment = user_assignment(data.user_assignment) unless data.nil?
+      data
+    end
+
+    def convert_task_assignment(data)
+      data.task_assignment ||= {}
+
+      data.task_assignment = task_assignment(data.task_assignment) unless data.task_assignment.nil?
+      data
+    end
+
+    def convert_task_assignments(data)
+      unless data.task_assignments.nil?
+        data.task_assignments = data.task_assignments.map { |ta| task_assignment(ta) }
+      end
+      data
+    end
+
+    def convert_task(data)
+      data.task ||= {}
+      data.task = task(data.task) unless data.task.nil?
+      data
+    end
+
+    # @param data [Struct] passed a struct which contains an attribute client
+    def convert_client(data)
+      data.client = client(data.client)
+      data
+    end
+
+    def convert_project(data)
+      data.project = project(data.project)
+      data
+    end
+
+    def convert_project_client(data)
+      convert_project(convert_client(data))
+    end
+
+    def convert_dates(data)
+      %i[created_at updated_at sent_at accepted_at declined_at].each do |key|
+        if data.members.include?(key) && !data.method(key).call.nil?
+          data.method("#{key}=").call(DateTime.strptime(data.method(key).call))
+        end
+      end
+      data
+    end
+  end
+end

data/lib/harvest/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'harvest/resources/message'
+require 'harvest/resources/company'
+require 'harvest/resources/user'
+require 'harvest/resources/task_assignment'
+require 'harvest/resources/user_assignment'
+require 'harvest/resources/timeentry'
+require 'harvest/resources/estimates'
+require 'harvest/resources/client'
+require 'harvest/resources/expenses'
+require 'harvest/resources/task'
+require 'harvest/resources/project'
+require 'harvest/resources/project_assignment'
+require 'harvest/resources/invoices'

data/lib/harvest/resources/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the client.
+    # @param name [String]
+    #   A textual description of the client.
+    # @param is_active [Boolean]
+    #   Whether the client is active or archived.
+    # @param address [String]
+    #   The physical address for the client.
+    # @param statement_key [String]
+    #   Used to build a URL to your client's invoice dashboard:
+    # @param currency [String]
+    #   The currency code associated with this client.
+    # @param created_at [DateTime]
+    #   Date and time the client was created.
+    # @param updated_at [DateTime]
+    #   Date and time the client was last updated.
+    ResourceClient = Struct.new(
+      'ResourceClient',
+      :id,
+      :name,
+      :is_active,
+      :address,
+      :statement_key,
+      :currency,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/company.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param base_uri [String]
+    #   The Harvest URL for the company.
+    # @param full_domain [String]
+    #   The Harvest domain for the company.
+    # @param name [String]
+    #   The name of the company.
+    # @param is_active [Boolean]
+    #   Whether the company is active or archived.
+    # @param week_start_day [String]
+    #   The week day used as the start of the week. Returns one of: Saturday, Sunday, or Monday.
+    # @param wants_timestamp_timers [Boolean]
+    #   Whether time is tracked via duration or start and end times.
+    # @param time_format [String]
+    #   The format used to display time in Harvest. Returns either decimal or hours_minutes.
+    # @param plan_type [String]
+    #   The type of plan the company is on. Examples: trial, free, or simple-v4
+    # @param clock [String]
+    #   Used to represent whether the company is using a 12-hour or 24-hour clock.
+    #   Returns either 12h or 24h.
+    # @param decimal_symbol [String]
+    #   Symbol used when formatting decimals.
+    # @param thousands_separator [String]
+    #   Separator used when formatting numbers.
+    # @param color_scheme [String]
+    #   The color scheme being used in the Harvest web client.
+    # @param weekly_capacity [Integer]
+    #   The weekly capacity in seconds.
+    # @param expense_feature [Boolean]
+    #   Whether the expense module is enabled.
+    # @param invoice_feature [Boolean]
+    #   Whether the invoice module is enabled.
+    # @param estimate_feature [Boolean]
+    #   Whether the estimate module is enabled.
+    # @param approval_feature [Boolean]
+    #   Whether the approval module is enabled.
+    Company = Struct.new(
+      'Company',
+      :base_uri,
+      :full_domain,
+      :name,
+      :is_active,
+      :week_start_day,
+      :wants_timestamp_timers,
+      :time_format,
+      :plan_type,
+      :clock,
+      :decimal_symbol,
+      :thousands_separator,
+      :color_scheme,
+      :weekly_capacity,
+      :expense_feature,
+      :invoice_feature,
+      :estimate_feature,
+      :approval_feature,
+      keyword_init: true
+    )
+  end
+end

data/lib/harvest/resources/estimates.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Resources
+    # @param id [Integer]
+    #   Unique ID for the estimate.
+    # @param client [Struct]
+    #   An object containing estimate's client id and name.
+    # @param line_items [List]
+    #   Array of estimate line items.
+    # @param creator [Struct]
+    #   An object containing the id and name of the person that created the estimate.
+    # @param client_key [String]
+    #   Used to build a URL to the public web invoice for your client:
+    # @param number [String]
+    #   If no value is set, the number will be automatically generated.
+    # @param purchase_order [String]
+    #   The purchase order number.
+    # @param amount [decimal]
+    #   The total amount for the estimate, including any discounts and taxes.
+    # @param tax [decimal]
+    #   This percentage is applied to the subtotal, including line items and
+    #   discounts.
+    # @param tax_amount [decimal]
+    #   The first amount of tax included, calculated from tax. If no tax is
+    #   defined, this value will be null.
+    # @param tax2 [decimal]
+    #   This percentage is applied to the subtotal, including line items and
+    #   discounts.
+    # @param tax2_amount [decimal]
+    #   The amount calculated from tax2.
+    # @param discount [decimal]
+    #   This percentage is subtracted from the subtotal.
+    # @param discount_amount [decimal]
+    #   The amount calcuated from discount.
+    # @param subject [String]
+    #   The estimate subject.
+    # @param notes [String]
+    #   Any additional notes included on the estimate.
+    # @param currency [String]
+    #   The currency code associated with this estimate.
+    # @param state [String]
+    #   The current state of the estimate: draft, sent, accepted, or declined.
+    # @param issue_date [Date]
+    #   Date the estimate was issued.
+    # @param sent_at [DateTime]
+    #   Date and time the estimate was sent.
+    # @param accepted_at [DateTime]
+    #   Date and time the estimate was accepted.
+    # @param declined_at [DateTime]
+    #   Date and time the estimate was declined.
+    # @param created_at [DateTime]
+    #   Date and time the estimate was created.
+    # @param updated_at [DateTime]
+    #   Date and time the estimate was last updated.
+    Estimate = Struct.new(
+      'Estimate',
+      :id,
+      :client,
+      :line_items,
+      :creator,
+      :client_key,
+      :number,
+      :purchase_order,
+      :amount,
+      :tax,
+      :tax_amount,
+      :tax2,
+      :tax2_amount,
+      :discount,
+      :discount_amount,
+      :subject,
+      :notes,
+      :currency,
+      :state,
+      :issue_date,
+      :sent_at,
+      :accepted_at,
+      :declined_at,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the line item.
+    # @param kind [String]
+    #   The name of an estimate item category.
+    # @param description [String]
+    #   Text description of the line item.
+    # @param quantity [Integer]
+    #   The unit quantity of the item.
+    # @param unit_price [decimal]
+    #   The individual price per unit.
+    # @param amount [decimal]
+    #   The line item subtotal (quantity * unit_price).
+    # @param taxed [Boolean]
+    #   Whether the estimate's tax percentage applies to this line item.
+    # @param taxed2 [Boolean]
+    #   Whether the estimate's tax2 percentage applies to this line item.
+    EstimateLineItem = Struct.new(
+      'EstimateLineItem',
+      :id,
+      :kind,
+      :description,
+      :quantity,
+      :unit_price,
+      :amount,
+      :taxed,
+      :taxed2,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the message.
+    # @param sent_by [String]
+    #   Name of the user that created the message.
+    # @param sent_by_email [String]
+    #   Email of the user that created the message.
+    # @param sent_from [String]
+    #   Name of the user that the message was sent from.
+    # @param sent_from_email [String]
+    #   Email of the user that message was sent from.
+    # @param recipients [List]
+    #   Array of estimate message recipients.
+    # @param subject [String]
+    #   The message subject.
+    # @param body [String]
+    #   The message body.
+    # @param send_me_a_copy [Boolean]
+    #   Whether to email a copy of the message to the current user.
+    # @param event_type [String]
+    #   The type of estimate event that occurred with the message: send, accept,
+    #   decline, re-open, view, or invoice.
+    # @param created_at [DateTime]
+    #   Date and time the message was created.
+    # @param updated_at [DateTime]
+    #   Date and time the message was last updated.
+    EstimateMessage = Struct.new(
+      'EstimateMessage',
+      :id,
+      :sent_by,
+      :sent_by_email,
+      :sent_from,
+      :sent_from_email,
+      :recipients,
+      :subject,
+      :body,
+      :send_me_a_copy,
+      :event_type,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+
+    # @param id [Integer]
+    #   Unique ID for the estimate item category.
+    # @param name [String]
+    #   The name of the estimate item category.
+    # @param created_at [DateTime]
+    #   Date and time the estimate item category was created.
+    # @param updated_at [DateTime]
+    #   Date and time the estimate item category was last updated.
+    EstimateItemCategory = Struct.new(
+      'EstimateItemCategory',
+      :id,
+      :name,
+      :created_at,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end