harvesting 0.1.0 → 0.5.1

data/lib/harvesting/models/harvest_record_collection.rb

@@ -0,0 +1,43 @@
+require 'forwardable'
+
+module Harvesting
+  module Models
+    class HarvestRecordCollection < Base
+      include Harvesting::Enumerable
+      extend Forwardable
+
+      attributed :per_page,
+                 :total_pages,
+                 :total_entries,
+                 :next_page,
+                 :previous_page,
+                 :page,
+                 :links
+
+      attr_reader :entries
+
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs, opts)
+        @query_opts = query_opts
+        @api_page = attrs
+      end
+
+      def page
+        @attributes['page']
+      end
+
+      def size
+        total_entries
+      end
+
+      def next_page_query_opts
+        @query_opts.merge(page: page + 1)
+      end
+
+      def fetch_next_page
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/harvesting/models/invoice.rb

@@ -0,0 +1,44 @@
+module Harvesting
+  module Models
+    # An invoice record from your Harvest account.
+    #
+    # For more information: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/
+    class Invoice < HarvestRecord
+      attributed :id,
+                 :client_key,
+                 :number,
+                 :purchase_order,
+                 :amount,
+                 :due_amount,
+                 :tax,
+                 :tax_amount,
+                 :tax2,
+                 :tax2_amount,
+                 :discount,
+                 :discount_amount,
+                 :subject,
+                 :notes,
+                 :currency,
+                 :state,
+                 :period_start,
+                 :period_end,
+                 :issue_date,
+                 :due_date,
+                 :payment_term,
+                 :sent_at,
+                 :paid_at,
+                 :paid_date,
+                 :closed_at,
+                 :created_at,
+                 :updated_at
+
+      def line_items
+        @line_items ||= @attributes['line_items'].map { |line_item_attributes| LineItem.new line_item_attributes, { harvest_client: harvest_client } }
+      end
+
+      def path
+        @attributes['id'].nil? ? "invoices" : "invoices/#{@attributes['id']}"
+      end
+    end
+  end
+end

data/lib/harvesting/models/invoices.rb

@@ -0,0 +1,17 @@
+module Harvesting
+  module Models
+    class Invoices < HarvestRecordCollection
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "invoices" }, query_opts, opts)
+        @entries = attrs["invoices"].map do |entry|
+          Invoice.new(entry, harvest_client: opts[:harvest_client])
+        end
+      end
+
+      def fetch_next_page
+        @entries += harvest_client.invoices(next_page_query_opts).entries
+        @attributes['page'] = page + 1
+      end
+    end
+  end
+end

data/lib/harvesting/models/line_item.rb

@@ -0,0 +1,19 @@
+module Harvesting
+  module Models
+    # A line item on an invoice from your Harvest account.
+    #
+    # For more information: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/
+    class LineItem < HarvestRecord
+      attributed :id,
+                 :kind,
+                 :description,
+                 :quantity,
+                 :unit_price,
+                 :amount,
+                 :taxed,
+                 :taxed2
+
+      modeled project: Project
+    end
+  end
+end

data/lib/harvesting/models/project.rb

@@ -1,8 +1,10 @@
 module Harvesting
   module Models
-    class Project < Base
+    # A project record from your Harvest account.
+    #
+    # For more information: https://help.getharvest.com/api-v2/projects-api/projects/projects/
+    class Project < HarvestRecord
       attributed :id,
-                 :client,
                  :name,
                  :code,
                  :is_active,
@@ -12,6 +14,7 @@ module Harvesting
                  :hourly_rate,
                  :budget,
                  :budget_by,
+                 :budget_is_monthly,
                  :notify_when_over_budget,
                  :over_budget_notification_percentage,
                  :over_budget_notification_date,
@@ -25,8 +28,30 @@ module Harvesting
                  :created_at,
                  :updated_at
 
+      modeled client: Client
+
       def path
-        id.nil? ? "projects" : "projects/#{id}"
+        @attributes['id'].nil? ? "projects" : "projects/#{@attributes['id']}"
+      end
+      
+      def to_hash
+        { client_id: client.id }.merge(super)
+      end
+
+      def time_entries
+        harvest_client.time_entries(project_id: self.id)
+      end
+
+      # Provides access to the user assignments that are associated with this
+      # project.
+      def user_assignments
+        harvest_client.user_assignments(project_id: self.id)
+      end
+
+      # Provides access to the task assignments that are associated with this
+      # project.
+      def task_assignments
+        harvest_client.task_assignments(project_id: self.id)
       end
     end
   end

data/lib/harvesting/models/project_task_assignment.rb

@@ -0,0 +1,33 @@
+module Harvesting
+  module Models
+    # A task assignment record from your Harvest account.
+    #
+    # For more information: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/
+    class ProjectTaskAssignment < HarvestRecord
+      attributed :id,
+                 :is_active,
+                 :billable,
+                 :hourly_rate,
+                 :budget,
+                 :created_at,
+                 :updated_at
+
+      modeled project: Project,
+              task: Task
+
+      def path
+        base_url = "projects/#{project.id}/task_assignments"
+        id.nil? ? base_url : "#{base_url}/#{id}"
+      end
+
+      # def project_id
+      #   # TODO: handle case where project's id is part of json object
+      #   @attributes["project_id"]
+      # end
+      
+      def to_hash
+        { project_id: project.id, task_id: task.id }.merge(super)
+      end
+    end
+  end
+end

data/lib/harvesting/models/project_task_assignments.rb

@@ -0,0 +1,18 @@
+module Harvesting
+  module Models
+    class ProjectTaskAssignments < HarvestRecordCollection
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "task_assignments" }, query_opts, opts)
+        @entries = attrs["task_assignments"].map do |entry|
+          ProjectTaskAssignment.new(entry, harvest_client: opts[:harvest_client])
+        end
+      end
+
+      def fetch_next_page
+        @entries += harvest_client.task_assignments(next_page_query_opts).entries
+        @attributes['page'] = page + 1
+      end
+
+    end
+  end
+end

data/lib/harvesting/models/project_user_assignment.rb

@@ -0,0 +1,25 @@
+module Harvesting
+  module Models
+    class ProjectUserAssignment < HarvestRecord
+      attributed :id,
+                 :is_active,
+                 :is_project_manager,
+                 :hourly_rate,
+                 :budget,
+                 :created_at,
+                 :updated_at
+
+      modeled project: Project,
+              user: User
+
+      def path
+        base_url = "projects/#{project.id}/user_assignments"
+        @attributes['id'].nil? ? base_url : "#{base_url}/#{@attributes['id']}"
+      end
+
+      def to_hash
+        { project_id: project.id, user_id: user.id }.merge(super)
+      end
+    end
+  end
+end

data/lib/harvesting/models/project_user_assignments.rb

@@ -0,0 +1,19 @@
+module Harvesting
+  module Models
+    class ProjectUserAssignments < HarvestRecordCollection
+
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "user_assignments" }, query_opts, opts)
+        @entries = attrs["user_assignments"].map do |entry|
+          ProjectUserAssignment.new(entry, harvest_client: opts[:harvest_client])
+        end
+      end
+
+      def fetch_next_page
+        @entries += harvest_client.user_assignments(next_page_query_opts).entries
+        @attributes['page'] = page + 1
+      end
+
+    end
+  end
+end

data/lib/harvesting/models/projects.rb

@@ -1,44 +1,17 @@
 module Harvesting
   module Models
-    class Projects < Base
-      include Harvesting::Enumerable
-      extend Forwardable
+    class Projects < HarvestRecordCollection
 
-      attributed :per_page,
-                 :total_pages,
-                 :total_entries,
-                 :next_page,
-                 :previous_page,
-                 :page,
-                 :links
-
-      attr_reader :entries
-
-      def initialize(attrs, opts = {})
-        super(attrs.reject {|k,v| k == "projects" }, opts)
-        @api_page = attrs
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "projects" }, query_opts, opts)
         @entries = attrs["projects"].map do |entry|
-          Project.new(entry, client: opts[:client])
+          Project.new(entry, harvest_client: opts[:harvest_client])
         end
       end
 
-      # def each
-      #   @entries.each_with_index do |time_entry, index|
-      #     yield(time_entry)
-      #   end
-      # end
-      def page
-        @attributes['page']
-      end
-
-      def size
-        total_entries
-      end
-
       def fetch_next_page
-        new_page = page + 1
-        @entries += client.projects(page: new_page).entries
-        @attributes['page'] = new_page
+        @entries += harvest_client.projects(next_page_query_opts).entries
+        @attributes['page'] = page + 1
       end
     end
   end

data/lib/harvesting/models/task.rb

@@ -1,9 +1,12 @@
 module Harvesting
   module Models
-    class Task < Base
+    # A task record from your Harvest account.
+    #
+    # For more information: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/
+    class Task < HarvestRecord
       attributed :id,
                  :name,
-                 :billable_by_default, 
+                 :billable_by_default,
                  :default_hourly_rate,
                  :is_default,
                  :is_active,
@@ -11,7 +14,7 @@ module Harvesting
                  :updated_at
 
       def path
-        id.nil? ? "tasks" : "tasks/#{id}"
+        @attributes['id'].nil? ? "tasks" : "tasks/#{@attributes['id']}"
       end
     end
   end

data/lib/harvesting/models/tasks.rb

@@ -1,44 +1,17 @@
 module Harvesting
   module Models
-    class Tasks < Base
-      include Harvesting::Enumerable
-      extend Forwardable
+    class Tasks < HarvestRecordCollection
 
-      attributed :per_page,
-                 :total_pages,
-                 :total_entries,
-                 :next_page,
-                 :previous_page,
-                 :page,
-                 :links
-
-      attr_reader :entries
-
-      def initialize(attrs, opts = {})
-        super(attrs.reject {|k,v| k == "tasks" }, opts)
-        @api_page = attrs
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "tasks" }, query_opts, opts)
         @entries = attrs["tasks"].map do |entry|
-          Task.new(entry, client: opts[:client])
+          Task.new(entry, harvest_client: opts[:harvest_client])
         end
       end
 
-      # def each
-      #   @entries.each_with_index do |time_entry, index|
-      #     yield(time_entry)
-      #   end
-      # end
-      def page
-        @attributes['page']
-      end
-
-      def size
-        total_entries
-      end
-
       def fetch_next_page
-        new_page = page + 1
-        @entries += client.tasks(page: new_page).entries
-        @attributes['page'] = new_page
+        @entries += harvest_client.tasks(next_page_query_opts).entries
+        @attributes['page'] = page + 1
       end
     end
   end

data/lib/harvesting/models/time_entries.rb

@@ -1,44 +1,17 @@
 module Harvesting
   module Models
-    class TimeEntries < Base
-      include Harvesting::Enumerable
-      extend Forwardable
+    class TimeEntries < HarvestRecordCollection
 
-      attributed :per_page,
-                 :total_pages,
-                 :total_entries,
-                 :next_page,
-                 :previous_page,
-                 :page,
-                 :links
-
-      attr_reader :entries
-
-      def initialize(attrs, opts = {})
-        super(attrs.reject {|k,v| k == "time_entries" }, opts)
-        @api_page = attrs
+      def initialize(attrs, query_opts = {}, opts = {})
+        super(attrs.reject {|k,v| k == "time_entries" }, query_opts, opts)
         @entries = attrs["time_entries"].map do |entry|
-          TimeEntry.new(entry, client: opts[:client])
+          TimeEntry.new(entry, harvest_client: opts[:harvest_client])
         end
       end
 
-      # def each
-      #   @entries.each_with_index do |time_entry, index|
-      #     yield(time_entry)
-      #   end
-      # end
-      def page
-        @attributes['page']
-      end
-
-      def size
-        total_entries
-      end
-
       def fetch_next_page
-        new_page = page + 1
-        @entries += @client.time_entries(page: new_page).entries
-        @attributes['page'] = new_page
+        @entries += harvest_client.time_entries(next_page_query_opts).entries
+        @attributes['page'] = page + 1
       end
     end
   end