harvested2 5.0.3

data/lib/harvest/invoice_category.rb

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

data/lib/harvest/invoice_message.rb

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

data/lib/harvest/invoice_payment.rb

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

data/lib/harvest/line_item.rb

@@ -0,0 +1,21 @@
+module Harvest
+  class LineItem < Hashie::Mash
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      self.project = args.delete('project') if args['project']
+      super
+    end
+
+    def project=(project)
+      self['project_id'] = project['id']
+    end
+
+    def active?
+      !deactivated
+    end
+
+    def line_item_as_json
+      { 'line_item' => { 'id' => line_item_id } }
+    end
+  end
+end

data/lib/harvest/model.rb

@@ -0,0 +1,133 @@
+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 ==(other)
+        other.kind_of?(self.class) && 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
+        objects = skip_json_root? && parsed[json_root.pluralize] || parsed
+        Array.wrap(objects).map { |attrs| new(attrs) }
+      end
+
+      def json_root
+        Harvest::Model::Utility.underscore(
+          Harvest::Model::Utility.demodulize(to_s))
+      end
+
+      def to_json(json)
+        parsed = String === json ? JSON.parse(json) : json
+      end
+
+      def wrap(model_or_attrs)
+        case model_or_attrs
+        when Hashie::Mash
+          model_or_attrs
+        when Hash
+          new(model_or_attrs)
+        else
+          model_or_attrs
+        end
+      end
+
+      def delegate_methods(options)
+        raise "no methods given" if options.empty?
+        options.each do |source, dest|
+          class_eval <<-EOV
+            def #{source}
+              #{dest}
+            end
+          EOV
+        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

data/lib/harvest/project.rb

@@ -0,0 +1,41 @@
+module Harvest
+
+  # The model that contains information about a project
+  #
+  # == Fields
+  # [+id+] (READONLY) the id of the project
+  # [+name+] (REQUIRED) the name of the project
+  # [+client_id+] (REQUIRED) the client id of the project
+  # [+code+] the project code
+  # [+notes+] the project notes
+  # [+active?+] true|false whether the project is active
+  # [+billable?+] true|false where the project is billable
+  # [+budget_by+] how the budget is calculated for the project +project|project_cost|task|person|nil+
+  # [+budget+] what the budget is for the project (based on budget_by)
+  # [+bill_by+] how to bill the project +Tasks|People|Project|nil+
+  # [+hourly_rate+] what the hourly rate for the project is based on +bill_by+
+  # [+notify_when_over_budget?+] whether the project will send notifications when it goes over budget
+  # [+over_budget_notification_percentage+] what percentage of the budget the project has to be before it sends a notification. Based on +notify_when_over_budget?+
+  # [+show_budget_to_all?+] whether the project's budget is shown to employees and contractors
+  # [+basecamp_id+] (READONLY) the id of the basecamp project associated to the project
+  # [+highrise_deal_id+] (READONLY) the id of the highrise deal associated to the project
+  # [+active_task_assignments_count+] (READONLY) the number of active task assignments
+  # [+created_at+] (READONLY) when the project was created
+  # [+updated_at+] (READONLY) when the project was updated
+  class Project < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/projects'
+
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      self.client = args.delete('client') if args['client']
+      super
+    end
+
+    def client=(client)
+      self['client_id'] = client['id']
+    end
+  end
+end

data/lib/harvest/receipt.rb

@@ -0,0 +1,12 @@
+module Harvest
+  # The model that contains information about a task
+  #
+  # == Fields
+  # [+url+] URL file
+  # [+file_name+] file name
+  # [+file_size+] size of the image
+  # [+content_type+] image/gif
+  class Receipt < Hashie::Mash
+    include Harvest::Model
+  end
+end

data/lib/harvest/task.rb

@@ -0,0 +1,21 @@
+module Harvest
+  # The model that contains information about a task
+  #
+  # == Fields
+  # [+id+] (READONLY) the id of the task
+  # [+name+] (REQUIRED) the name of the task
+  # [+billable+] whether the task is billable by default
+  # [+deactivated+] whether the task is deactivated
+  # [+hourly_rate+] what the default hourly rate for the task is
+  # [+default?+] whether to add this task to new projects by default
+  class Task < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/tasks'
+
+    def active?
+      !deactivated
+    end
+  end
+end

data/lib/harvest/task_assignment.rb

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

data/lib/harvest/time_entry.rb

@@ -0,0 +1,57 @@
+module Harvest
+  class TimeEntry < Hashie::Mash
+    include Harvest::Model
+
+    skip_json_root true
+    api_path '/time_entries'
+
+    delegate_methods(closed?: :is_closed,
+                     billed?: :is_billed)
+
+    def initialize(args = {}, _ = nil)
+      args = args.stringify_keys
+      self.user = args.delete('user') if args['user']
+      self.task = args.delete('task') if args['task']
+      self.client = args.delete('client') if args['client']
+      self.project = args.delete('project') if args['project']
+      self.spent_date = args.delete('spent_date') if args['spent_date']
+      self.user_assignment = args.delete('user_assignment') if args['user_assignment']
+      self.task_assignment = args.delete('task_assignment') if args['task_assignment']
+      super
+    end
+
+    def user=(user)
+      self['user_id'] = user['id']
+    end
+
+    def client=(client)
+      self['client_id'] = client['id']
+    end
+
+    def project=(project)
+      self['project_id'] = project['id']
+    end
+
+    def task=(task)
+      self['task_id'] = task['id']
+    end
+
+    def user_assignment=(user_assignment)
+      self['user_assignment_id'] = user_assignment['id']
+    end
+
+    def task_assignment=(task_assignment)
+      self['task_assignment_id'] = task_assignment['id']
+    end
+
+    def spent_date=(date)
+      self['spent_date'] = Date.parse(date.to_s)
+    end
+
+    def as_json(args = {})
+      super(args).to_hash.stringify_keys.tap do |hash|
+        hash.update('spent_date' => (spent_date.nil? ? nil : spent_date.xmlschema))
+      end
+    end
+  end
+end

data/lib/harvest/timezones.rb

@@ -0,0 +1,130 @@
+module Harvest
+  # shamelessly ripped from Rails: http://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb
+  module Timezones
+    MAPPING = {
+      'pacific/midway'                  =>   'Midway Island',
+      'pacific/pago_pago'               =>   'Samoa',
+      'pacific/honolulu'                =>   'Hawaii',
+      'america/juneau'                  =>   'Alaska',
+      'america/los_angeles'             =>   'Pacific Time (US & Canada)',
+      'america/tijuana'                 =>   'Tijuana',
+      'america/denver'                  =>   'Mountain Time (US & Canada)',
+      'america/phoenix'                 =>   'Arizona',
+      'america/chihuahua'               =>   'Chihuahua',
+      'america/mazatlan'                =>   'Mazatlan',
+      'america/chicago'                 =>   'Central Time (US & Canada)',
+      'america/regina'                  =>   'Saskatchewan',
+      'america/mexico_city'             =>   'Mexico City',
+      'america/monterrey'               =>   'Monterrey',
+      'america/guatemala'               =>   'Central America',
+      'america/new_york'                =>   'Eastern Time (US & Canada)',
+      'america/indiana/indianapolis'    =>   'Indiana (East)',
+      'america/bogota'                  =>   'Bogota',
+      'america/lima'                    =>   'Lima',
+      'america/halifax'                 =>   'Atlantic Time (Canada)',
+      'america/caracas'                 =>   'Caracas',
+      'america/la_paz'                  =>   'La Paz',
+      'america/santiago'                =>   'Santiago',
+      'america/st_johns'                =>   'Newfoundland',
+      'america/sao_paulo'               =>   'Brasilia',
+      'america/argentina/buenos_aires'  =>   'Buenos Aires',
+      'america/argentina/san_juan'      =>   'Georgetown',
+      'america/godthab'                 =>   'Greenland',
+      'atlantic/south_georgia'          =>   'Mid-Atlantic',
+      'atlantic/azores'                 =>   'Azores',
+      'atlantic/cape_verde'             =>   'Cape Verde Is.',
+      'europe/dublin'                   =>   'Dublin',
+      'europe/lisbon'                   =>   'Lisbon',
+      'europe/london'                   =>   'London',
+      'africa/casablanca'               =>   'Casablanca',
+      'africa/monrovia'                 =>   'Monrovia',
+      'etc/utc'                         =>   'UTC',
+      'europe/belgrade'                 =>   'Belgrade',
+      'europe/bratislava'               =>   'Bratislava',
+      'europe/budapest'                 =>   'Budapest',
+      'europe/ljubljana'                =>   'Ljubljana',
+      'europe/prague'                   =>   'Prague',
+      'europe/sarajevo'                 =>   'Sarajevo',
+      'europe/skopje'                   =>   'Skopje',
+      'europe/warsaw'                   =>   'Warsaw',
+      'europe/zagreb'                   =>   'Zagreb',
+      'europe/brussels'                 =>   'Brussels',
+      'europe/copenhagen'               =>   'Copenhagen',
+      'europe/madrid'                   =>   'Madrid',
+      'europe/paris'                    =>   'Paris',
+      'europe/amsterdam'                =>   'Amsterdam',
+      'europe/berlin'                   =>   'Berlin',
+      'europe/rome'                     =>   'Rome',
+      'europe/stockholm'                =>   'Stockholm',
+      'europe/vienna'                   =>   'Vienna',
+      'africa/algiers'                  =>   'West Central Africa',
+      'europe/bucharest'                =>   'Bucharest',
+      'africa/cairo'                    =>   'Cairo',
+      'europe/helsinki'                 =>   'Helsinki',
+      'europe/kiev'                     =>   'Kyev',
+      'europe/riga'                     =>   'Riga',
+      'europe/sofia'                    =>   'Sofia',
+      'europe/tallinn'                  =>   'Tallinn',
+      'europe/vilnius'                  =>   'Vilnius',
+      'europe/athens'                   =>   'Athens',
+      'europe/istanbul'                 =>   'Istanbul',
+      'europe/minsk'                    =>   'Minsk',
+      'asia/jerusalem'                  =>   'Jerusalem',
+      'africa/harare'                   =>   'Harare',
+      'africa/johannesburg'             =>   'Pretoria',
+      'europe/moscow'                   =>   'Moscow',
+      'asia/kuwait'                     =>   'Kuwait',
+      'asia/riyadh'                     =>   'Riyadh',
+      'africa/nairobi'                  =>   'Nairobi',
+      'asia/baghdad'                    =>   'Baghdad',
+      'asia/tehran'                     =>   'Tehran',
+      'asia/muscat'                     =>   'Muscat',
+      'asia/baku'                       =>   'Baku',
+      'asia/tbilisi'                    =>   'Tbilisi',
+      'asia/yerevan'                    =>   'Yerevan',
+      'asia/kabul'                      =>   'Kabul',
+      'asia/yekaterinburg'              =>   'Ekaterinburg',
+      'asia/karachi'                    =>   'Karachi',
+      'asia/tashkent'                   =>   'Tashkent',
+      'asia/kolkata'                    =>   'Kolkata',
+      'asia/katmandu'                   =>   'Kathmandu',
+      'asia/dhaka'                      =>   'Dhaka',
+      'asia/colombo'                    =>   'Sri Jayawardenepura',
+      'asia/almaty'                     =>   'Almaty',
+      'asia/novosibirsk'                =>   'Novosibirsk',
+      'asia/rangoon'                    =>   'Rangoon',
+      'asia/bangkok'                    =>   'Bangkok',
+      'asia/jakarta'                    =>   'Jakarta',
+      'asia/krasnoyarsk'                =>   'Krasnoyarsk',
+      'asia/shanghai'                   =>   'Beijing',
+      'asia/chongqing'                  =>   'Chongqing',
+      'asia/hong_kong'                  =>   'Hong Kong',
+      'asia/urumqi'                     =>   'Urumqi',
+      'asia/kuala_lumpur'               =>   'Kuala Lumpur',
+      'asia/singapore'                  =>   'Singapore',
+      'asia/taipei'                     =>   'Taipei',
+      'australia/perth'                 =>   'Perth',
+      'asia/irkutsk'                    =>   'Irkutsk',
+      'asia/ulaanbaatar'                =>   'Ulaan Bataar',
+      'asia/seoul'                      =>   'Seoul',
+      'asia/tokyo'                      =>   'Tokyo',
+      'asia/yakutsk'                    =>   'Yakutsk',
+      'australia/darwin'                =>   'Darwin',
+      'australia/adelaide'              =>   'Adelaide',
+      'australia/melbourne'             =>   'Melbourne',
+      'australia/sydney'                =>   'Sydney',
+      'australia/brisbane'              =>   'Brisbane',
+      'australia/hobart'                =>   'Hobart',
+      'asia/vladivostok'                =>   'Vladivostok',
+      'pacific/guam'                    =>   'Guam',
+      'pacific/port_moresby'            =>   'Port Moresby',
+      'asia/magadan'                    =>   'Magadan',
+      'pacific/noumea'                  =>   'New Caledonia',
+      'pacific/fiji'                    =>   'Fiji',
+      'asia/kamchatka'                  =>   'Kamchatka',
+      'pacific/majuro'                  =>   'Marshall Is.',
+      'pacific/auckland'                =>   'Auckland',
+      'pacific/tongatapu'               =>   "Nuku'alofa"
+    }
+  end
+end