harvested 0.3.3 → 0.4.0

data/lib/harvest/client.rb

@@ -10,21 +10,26 @@ module Harvest
   # [+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 < BaseModel
-    include HappyMapper
-  
+  class Client < Hashie::Dash
+    include Harvest::Model
+    
     api_path '/clients'
-  
-    element :id, Integer
-    element :active, Boolean
-    element :name, String
-    element :details, String
-    element :currency, String
-    element :currency_symbol, String, :tag => "currency-symbol"
-    element :cache_version, Integer, :tag => "cache-version"
-    element :updated_at, Time, :tag => "updated-at"
-    element :highrise_id, Integer, :tag => 'highrise-id'
+    
+
+    property :id
+    property :active
+    property :name
+    property :details
+    property :currency
+    property :currency_symbol
+    property :cache_version
+    property :created_at
+    property :updated_at
+    property :highrise_id
+    property :default_invoice_timeframe
+    property :last_invoice_kind
     
     alias_method :active?, :active
+    alias_method :is_active=, :active=
   end
 end

data/lib/harvest/contact.rb

@@ -11,19 +11,21 @@ module Harvest
   # [+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 < BaseModel
-    include HappyMapper
+  class Contact < Hashie::Dash
+    include Harvest::Model
     
     api_path '/contacts'
     
-    element :id, Integer
-    element :client_id, Integer, :tag => "client-id"
-    element :email, String
-    element :first_name, String, :tag => "first-name"
-    element :last_name, String, :tag => "last-name"
-    element :phone_office, String, :tag => "phone-office"
-    element :phone_mobile, String, :tag => "phone-mobile"
-    element :fax, String
-    element :title, String
+    property :id
+    property :client_id
+    property :email
+    property :first_name
+    property :last_name
+    property :phone_office
+    property :phone_mobile
+    property :fax
+    property :title
+    property :created_at
+    property :updated_at
   end
 end

data/lib/harvest/errors.rb

@@ -3,14 +3,16 @@ module Harvest
   
   class HTTPError < StandardError
     attr_reader :response
-    def initialize(response)
+    attr_reader :params
+
+    def initialize(response, params = {})
       @response = response
-      super
+      @params = params
+      super(response)
     end
     
     def to_s
-      hint = response.headers["hint"].nil? ? nil : response.headers["hint"].first
-      "#{self.class.to_s} : #{response.code}#{" - #{hint}" if hint}"
+      "#{self.class.to_s} : #{response.code} #{response.body}"
     end
   end
   

data/lib/harvest/expense.rb

@@ -1,19 +1,45 @@
 module Harvest
-  class Expense < BaseModel
-    include HappyMapper
-  
+  class Expense < Hashie::Dash
+    include Harvest::Model
+
     api_path '/expenses'
-  
-    element :id, Integer
-    element :notes, String
-    element :units, Integer
-    element :total_cost, Float, :tag => 'total-cost'
-    element :project_id, Integer, :tag => 'project-id'
-    element :expense_category_id, Integer, :tag => 'expense-category-id'
-    element :spent_at, Time, :tag => 'spent-at'
-    
+
+    property :id
+    property :notes
+    property :units
+    property :total_cost
+    property :project_id
+    property :expense_category_id
+    property :user_id
+    property :spent_at
+    property :created_at
+    property :updated_at
+    property :is_billed
+    property :is_closed
+    property :invoice_id
+    property :has_receipt
+    property :receipt_url
+
+    def initialize(args = {})
+      args          = args.stringify_keys
+      self.spent_at = args.delete("spent_at") if args["spent_at"]
+      super
+    end
+
     def spent_at=(date)
-      @spent_at = (String === date ? Time.parse(date) : date)
+      self["spent_at"] = (String === date ? Time.parse(date) : date)
+    end
+
+    def as_json(args = {})
+      super(args).stringify_keys.tap do |hash|
+        hash[json_root].update("spent_at" => (spent_at.nil? ? nil : spent_at.to_time.xmlschema))
+        hash[json_root].delete("has_receipt")
+        hash[json_root].delete("receipt_url")
+      end
     end
+
+    alias_method :billed?, :is_billed
+    alias_method :closed?, :is_closed
+    alias_method :has_receipt?, :has_receipt
   end
-end
+end

data/lib/harvest/expense_category.rb

@@ -1,15 +1,16 @@
 module Harvest
-  class ExpenseCategory < BaseModel
-    include HappyMapper
-    
-    tag 'expense-category'
+  class ExpenseCategory < Hashie::Dash
+    include Harvest::Model
     api_path '/expense_categories'
     
-    element :id, Integer
-    element :name, String
-    element :unit_name, String, :tag => 'unit-name'
-    element :unit_price, Float, :tag => 'unit-price'
-    element :deactivated, Boolean
+    property :id
+    property :name
+    property :unit_name
+    property :unit_price
+    property :deactivated
+    property :created_at
+    property :updated_at
+    property :cache_version
     
     def active?
       !deactivated

data/lib/harvest/hardy_client.rb

@@ -59,7 +59,7 @@ module Harvest
           yield
         rescue Harvest::RateLimited => e
           seconds = if e.response.headers["retry-after"]
-            e.response.headers["retry-after"].first.to_i
+            e.response.headers["retry-after"].to_i
           else
             16
           end

data/lib/harvest/invoice.rb

@@ -0,0 +1,103 @@
+module Harvest
+  class Invoice < Hashie::Dash
+    include Harvest::Model
+    
+    api_path '/invoices'
+    
+    attr_reader :line_items
+    
+    property :id
+    property :subject
+    property :number
+    property :created_at
+    property :updated_at
+    property :issued_at
+    property :due_at
+    property :due_at_human_format
+    property :due_amount
+    property :notes
+    property :recurring_invoice_id
+    property :period_start
+    property :period_end
+    property :discount
+    property :discount_amount
+    property :client_key
+    property :amount
+    property :tax
+    property :tax2
+    property :tax_amount
+    property :tax2_amount
+    property :csv_line_items
+    property :client_id
+    property :estimate_id
+    property :purchase_order
+    property :retainer_id
+    property :currency
+    property :state
+    property :kind
+    property :import_hours
+    property :import_expenses
+    
+    def self.json_root; "doc"; end
+    # skip_json_root true
+    
+    def initialize(args = {})
+      @line_items = []
+      args            = args.stringify_keys
+      self.line_items = args.delete("csv_line_items")
+      self.line_items = args.delete("line_items")
+      super
+    end
+    
+    def line_items=(raw_or_rich)
+      unless raw_or_rich.nil?
+        @line_items = case raw_or_rich
+        when String
+          @line_items = decode_csv(raw_or_rich).map {|row| Harvest::LineItem.new(row) }
+        else
+          raw_or_rich
+        end
+      end
+    end
+    
+    def as_json(*options)
+      json = super(*options)
+      json[json_root]["csv_line_items"] = encode_csv(@line_items)
+      json
+    end
+    
+    private
+      def decode_csv(string)
+        csv = CSV.parse(string)
+        headers = csv.shift
+        csv.map! {|row| headers.zip(row) }
+        csv.map {|row| row.inject({}) {|h, tuple| h.update(tuple[0] => tuple[1]) } }
+      end
+      
+      def encode_csv(line_items)
+        if line_items.empty?
+          ""
+        else
+          header = %w(kind description quantity unit_price amount taxed taxed2 project_id)
+          
+          # writing this in stdlib so we don't force 1.8 users to install FasterCSV and make gem dependencies wierd
+          if RUBY_VERSION =~ /1.8/
+            csv_data = ""
+            CSV.generate_row(header, header.size, csv_data)
+            line_items.each do |item|
+              row_data = header.inject([]) {|row, attr| row << item[attr] } 
+              CSV.generate_row(row_data, row_data.size, csv_data)
+            end
+            csv_data
+          else
+            CSV.generate do |csv|
+              csv << header
+              line_items.each do |item|
+                csv << header.inject([]) {|row, attr| row << item[attr] } 
+              end
+            end
+          end
+        end
+      end
+  end
+end

data/lib/harvest/invoice_category.rb

@@ -0,0 +1,18 @@
+module Harvest
+  class InvoiceCategory < Hashie::Dash
+    include Harvest::Model
+    
+    api_path '/invoice_item_categories'
+    def self.json_root; "category"; end
+    
+    property :id
+    property :name
+    property :created_at
+    property :updated_at
+    property :use_as_expense
+    property :use_as_service
+    
+    alias_method :use_as_expense?, :use_as_expense
+    alias_method :use_as_service?, :use_as_service
+  end
+end

data/lib/harvest/line_item.rb

@@ -0,0 +1,12 @@
+module Harvest
+  class LineItem < Hashie::Dash
+    property :kind
+    property :description
+    property :quantity
+    property :unit_price
+    property :amount
+    property :taxed
+    property :taxed2
+    property :project_id
+  end
+end

data/lib/harvest/model.rb

@@ -0,0 +1,120 @@
+module Harvest
+  module Model
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.send :extend, ClassMethods
+    end
+    
+    module InstanceMethods
+      def to_json(*args)
+        as_json(*args).to_json(*args)
+      end
+      
+      def as_json(args = {})
+        inner_json = self.to_hash.stringify_keys
+        inner_json.delete("cache_version")
+        if self.class.skip_json_root?
+          inner_json
+        else
+          { self.class.json_root => inner_json }
+        end
+      end
+      
+      def to_i; id; end
+      
+      def ==(other)
+        id == other.id
+      end
+      
+      def impersonated_user_id
+        if respond_to?(:of_user) && respond_to?(:user_id)
+          of_user || user_id
+        elsif !respond_to?(:of_user) && respond_to?(:user_id)
+          user_id
+        elsif respond_to?(:of_user)
+          of_user
+        end
+      end
+      
+      def json_root
+        self.class.json_root
+      end
+    end
+    
+    module ClassMethods
+      # This sets the API path so the API collections can use them in an agnostic way
+      # @return [void]
+      def api_path(path = nil)
+        @_api_path ||= path
+      end
+      
+      def skip_json_root(skip = nil)
+        @_skip_json_root ||= skip
+      end
+      
+      def skip_json_root?
+        @_skip_json_root == true
+      end
+      
+      def parse(json)
+        parsed = String === json ? JSON.parse(json) : json
+        Array.wrap(parsed).map {|attrs| skip_json_root? ? new(attrs) : new(attrs[json_root])}
+      end
+      
+      def json_root
+        Harvest::Model::Utility.underscore(
+          Harvest::Model::Utility.demodulize(to_s)
+        )
+      end
+      
+      def wrap(model_or_attrs)
+        case model_or_attrs
+        when Hashie::Dash
+          model_or_attrs
+        when Hash
+          new(model_or_attrs)
+        else
+          model_or_attrs
+        end
+      end
+    end
+    
+    module Utility
+      class << self
+        
+        # Both methods are shamelessly ripped from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/inflections.rb
+        
+        # Removes the module part from the expression in the string.
+        #
+        # Examples:
+        #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize # => "Inflections"
+        #   "Inflections".demodulize
+        def demodulize(class_name_in_module)
+          class_name_in_module.to_s.gsub(/^.*::/, '')
+        end
+        
+        # Makes an underscored, lowercase form from the expression in the string.
+        #
+        # Changes '::' to '/' to convert namespaces to paths.
+        #
+        # Examples:
+        #   "ActiveRecord".underscore         # => "active_record"
+        #   "ActiveRecord::Errors".underscore # => active_record/errors
+        #
+        # As a rule of thumb you can think of +underscore+ as the inverse of +camelize+,
+        # though there are cases where that does not hold:
+        #
+        #   "SSLError".underscore.camelize # => "SslError"
+        def underscore(camel_cased_word)
+          word = camel_cased_word.to_s.dup
+          word.gsub!(/::/, '/')
+          word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
+    end
+  end
+end