harvesting 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1673fee5f8b50a00750256df7dea9b8143b4afbead80fbdf431cd2ecd19c6a1c
-  data.tar.gz: 5cb711e920654119f73ade9d2a9cc32a71ff869630b9a6d2ee0f48003cd743b5
+  metadata.gz: 420911f1f064b300fb9db0e3490a23cee246fd1e8f885ac631558818a9afa761
+  data.tar.gz: cbf6caa05a4092e344e1638dab33081478a973282d3d1a9f2ed3cb30ec75f7ab
 SHA512:
-  metadata.gz: 36d93fb5fdea77d42429d5e9116a12409e480746a261ce6f615987fa2c47b04e13f95a160eebcdea0314df78dd937b9353d8bafb21d8f44c8e64fa3f72928913
-  data.tar.gz: 3ba6fa74a9e549fb2bfb49f4cbde3e6b7c46fcb30564dbe9d0da14d1b0f03e8bd14e1f018b43c0667888f42b82c99ea89fb78da91c647039e9b5e616fe7c3486
+  metadata.gz: 3b9a22eb96ff64f1f0947b22d026311635419b29616e56a01baca381fac7ff0d61cbe1ff29597d24d461fb1a58d92db4edf755ac7c5ac206b71002e5bc3442f7
+  data.tar.gz: 398e22c481a9f56e543beebb87a0b0572e725e8f2dd5eb61ea78176bec5f56d6afac652e1a9477754eb608fc612fe45d212fed8fb2034e1724997cce017855a1

data/.env.sample

@@ -0,0 +1,7 @@
+HARVEST_FIRST_NAME=John
+HARVEST_LAST_NAME=Smith
+HARVEST_ACCOUNT_ID=<replace me with a test account>
+HARVEST_NON_ADMIN_ACCOUNT_ID=<replace me with a test account>
+HARVEST_ACCESS_TOKEN=<replace me with a test account>
+HARVEST_NON_ADMIN_ACCESS_TOKEN=<replace me with a test account>
+HARVEST_ADMIN_FULL_NAME=<replace me with a test account>

data/.gitignore

@@ -7,6 +7,9 @@
 /spec/reports/
 /tmp/
 
+# environment variables
+.env
+
 # rspec failure tracking
 .rspec_status
 
@@ -18,3 +21,6 @@
 
 # ruby versions
 .ruby-version
+
+.idea/
+harvesting.iml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    harvesting (0.1.0)
+    harvesting (0.2.0)
       http (~> 3.3, >= 3.3)
 
 GEM
@@ -16,6 +16,7 @@ GEM
     diff-lcs (1.3)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.5.0)
     ffi (1.9.23)
     formatador (0.2.5)
     guard (2.14.2)
@@ -92,6 +93,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   byebug (~> 10.0, >= 10.0)
+  dotenv (~> 2.5, >= 2.5)
   guard-rspec (~> 4.7, >= 4.7)
   harvesting!
   rake (~> 10.0)

data/README.md

@@ -92,6 +92,41 @@ this:
     project = projects.first
     > => #<Harvesting::Models::Project:0x007ff718e1c618 @attributes={"id"=>17367712, "name"=>"Foo", "code"=>"", "is_active"=>true, "is_billable"=>true, "is_fixed_fee"=>false, "bill_by"=>"none", "budget"=>nil, "budget_by"=>"none", "budget_is_monthly"=>false, "notify_when_over_budget"=>false, "over_budget_notification_percentage"=>80.0, "show_budget_to_all"=>false, "created_at"=>"2018-05-13T03:30:06Z", ... >
 
+### Nested Attributes
+
+The Harvest v2 API embeds some data in JSON objects. You can access nested attributes quite naturally.
+For example, to access the user id for a time entry instance, `entry`, use:
+
+    entry.user.id
+
+Or to access the name of the client on a project instance, `project`:
+
+    project.client.name
+
+## Tips
+
+### Deleting All Items
+
+When you need to delete all items, care needs to be taken, because the API uses pagination. The following code will only delete data from _every other_ page.
+
+```
+# WARNING - only deletes every other page
+client.time_entries.each do |time_entry|
+  time_entry.delete
+end
+```
+
+While iterating over items from the first page, all of those items will be deleted. This will result in moving items from the second page onto the first page. If there are only two pages, then the second page will be empty. If there are more than two pages, then the second page will now contain items which would have previously appeared on the third page. Deleting those items will move the items from the fourth page on to the third page, and so on.
+
+Instead you need to make sure you get access to all of the time entry objects before you try to delete any of them. The easiest way to do this is to convert the `Enumerable` instance into an `Array`, by calling `#to_a`, before you iterate over it.
+
+```
+# GOOD - This should do what you want
+client.time_entries.to_a.each do |time_entry|
+  time_entry.delete
+end
+```
+
 ## Roadmap
 
 There are many things to be developed for this gem. For now they are tracked here: [TODO.md](https://github.com/ombulabs/harvesting/blob/master/TODO.md)
@@ -102,21 +137,73 @@ You can find more info [here](RELEASE_NOTES.md)
 
 ## Development
 
-### Without Docker
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    ./bin/setup
+    rake
 
-### With Docker
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Using Docker
 
 This setup allows you to create a completely isolated development environment for working on this gem. The version of ruby used for development and the gems that it depends on will remain inside the container.
 
 After checking out the repo, run `docker-compose build` to create the `gem` container. Running `docker-compose run gem bash` will get you a bash session inside the container. From there, you can follow the instructions in the "Without Docker" section above.
 
+### Running Tests
+
+The tests in this project use the [VCR gem](https://github.com/vcr/vcr) to record and playback all interactions with the Harvest API. This allows you to run the test suite without having an account at Harvest for testing.
+
+If you add a test that requires making an additional API call, then you'll need to make adjustments to the `.env` file to provide account details that are required by the test suite.
+
+*WARNING*: The test suite is destructive. It deletes all entities from the account before it runs. _DO NOT_ run it against a Harvest account which contains information that you need to preserve. Instead, create a Harvest account for testing.
+
+If you need to refresh the VCR cassettes, the easiest way is to delete all of the files located under [`fixtures/vcr_cassettes`](fixtures/vcr_cassettes). The next time the test suite is run, VCR will make actual calls against the Harvest API and record the responses into updated cassette files.
+
+Effort has been taken to ensure that private information is excluded from the recorded cassettes. To adjust this further, add additional `filter_sensitive_data` calls to [`spec/spec_helper.rb`](spec/spec_helper.rb).
+
+### Models
+
+The models in this project reflect the Harvest v2 API endpoints:
+
+ * client
+ * contact
+ * task
+ * task_assignment
+ * project
+ * user
+ * time_entry
+
+There are also models for the Harvest v2 API collection endpoints:
+
+ * clients
+ * contacts
+ * tasks
+ * task_assignments
+ * projects
+ * users
+ * time_entries
+
+These collection models handle the Harvest v2 API pagination automatically, making it easy to enumerate through all the instances of each type.
+
+The models try to reduce code duplication through base class helper functions to automatically define accessors for the attributes included in each type returned by the Harvest v2 API.
+The `Harvesting::Base::attributed` method will define accessors for each simple attribute included in an array passed as an argument. Data is returned from these accessors as strings.
+
+Some data is returned from Harvest as nested JSON (e.g. time_entry.project.name). A base class helper to expose this using the available models
+is also present. The `Harvesting::Base::modeled` method will define accessors for each object attribute included in options. Both the name of the attribute and the model to use in accessing that data is supplied.
+Data is returned from these accessors as model objects.
+
+NOTE: Nesting model objects requires that the nested model types be defined before the nesting model type. E.g. if `project` contains a nested `client`, then `client` must be defined *before* `project` in the `harvesting.rb` include list.
+
+## Releases
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+We follow semantic versioning for version numbers: [https://semver.org](https://semver.org)
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ombulabs/harvesting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ombulabs/harvesting](https://github.com/ombulabs/harvesting). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/RELEASE_NOTES.md

@@ -1,10 +1,18 @@
 # RELEASE NOTES
 
-## Version 0.1.0 - Sep 04, 2018
+### Version 0.3.0 - Jan 22, 2018
 
 **Notes**
 
-- Initial release
+- Support for users: https://github.com/ombulabs/harvesting/pull/9
+- Support for fetching single records: https://github.com/ombulabs/harvesting/pull/14 and https://github.com/ombulabs/harvesting/pull/22
+- Nested models make it easier to access data: https://github.com/ombulabs/harvesting/pull/15
+- Better architecture for collections: https://github.com/ombulabs/harvesting/pull/18
+
+**Bug Fixes**
+
+- Correct pagination support: https://github.com/ombulabs/harvesting/pull/17
+- Added documentation: https://github.com/ombulabs/harvesting/pull/30
 
 ### Version 0.2.0 - Oct 18, 2018
 
@@ -18,3 +26,9 @@
 
 - Fixes issues with specs: https://github.com/ombulabs/harvesting/pull/2
 - Fixed https://github.com/ombulabs/harvesting/issues/6 with https://github.com/ombulabs/harvesting/pull/7
+
+## Version 0.1.0 - Sep 04, 2018
+
+**Notes**
+
+- Initial release

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "dotenv/load"
 require "harvesting"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/bin/setup

@@ -6,3 +6,8 @@ set -vx
 bundle install
 
 # Do any other automated setup that you need to do here
+
+if [ ! -f .env ]; then
+  cp .env.sample .env
+  echo "Make sure that .env has valid values."
+fi

data/harvesting.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug", "~> 10.0", ">= 10.0"
   spec.add_development_dependency "vcr", "~> 4.0", ">= 4.0"
   spec.add_development_dependency "webmock", "~> 3.4", ">= 3.4"
+  spec.add_development_dependency "dotenv", "~> 2.5", ">= 2.5"
 end

data/lib/harvesting.rb

@@ -1,16 +1,25 @@
+# framework
 require "harvesting/version"
 require "harvesting/enumerable"
 require "harvesting/errors"
 require "harvesting/models/base"
-require "harvesting/models/user"
-require "harvesting/models/contact"
+require "harvesting/models/harvest_record"
+require "harvesting/models/harvest_record_collection"
+# harvest records
 require "harvesting/models/client"
-require "harvesting/models/projects"
+require "harvesting/models/user"
 require "harvesting/models/project"
-require "harvesting/models/tasks"
+require "harvesting/models/invoice"
 require "harvesting/models/task"
-require "harvesting/models/time_entries"
+require "harvesting/models/task_assignment"
 require "harvesting/models/time_entry"
+# harvest record collections
+require "harvesting/models/tasks"
+require "harvesting/models/users"
+require "harvesting/models/contact"
+require "harvesting/models/time_entries"
+require "harvesting/models/projects"
+# API client
 require "harvesting/client"
 
 module Harvesting

data/lib/harvesting/client.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 require "http"
 require "json"
 
@@ -9,9 +8,7 @@ module Harvesting
 
     attr_accessor :access_token, :account_id
 
-    #
     # @param opts
-    #
     def initialize(access_token: ENV['HARVEST_ACCESS_TOKEN'], account_id: ENV['HARVEST_ACCOUNT_ID'])
       @access_token = access_token.to_s
       @account_id = account_id.to_s
@@ -38,15 +35,26 @@ module Harvesting
     end
 
     def time_entries(opts = {})
-      Harvesting::Models::TimeEntries.new(get("time_entries", opts), client: self)
+      Harvesting::Models::TimeEntries.new(get("time_entries", opts), opts, client: self)
     end
 
     def projects(opts = {})
-      Harvesting::Models::Projects.new(get("projects", opts), client: self)
+      Harvesting::Models::Projects.new(get("projects", opts), opts, client: self)
     end
 
     def tasks(opts = {})
-      Harvesting::Models::Tasks.new(get("tasks", opts), client: self)
+      Harvesting::Models::Tasks.new(get("tasks", opts), opts, client: self)
+    end
+
+
+    def users(opts = {})
+      Harvesting::Models::Users.new(get("users", opts), opts, client: self)
+    end
+
+    def invoices
+      get("invoices")["invoices"].map do |result|
+        Harvesting::Models::Invoice.new(result, client: self)
+      end
     end
 
     def create(entity)
@@ -65,7 +73,12 @@ module Harvesting
       entity
     end
 
-    private
+    def delete(entity)
+      url = "#{DEFAULT_HOST}/#{entity.path}"
+      uri = URI(url)
+      response = http_response(:delete, uri)
+      raise UnprocessableRequest(response.to_s) unless response.code.to_i == 200
+    end
 
     def get(path, opts = {})
       url = "#{DEFAULT_HOST}/#{path}"
@@ -75,10 +88,12 @@ module Harvesting
       JSON.parse(response.body)
     end
 
+    private
+
     def http_response(method, uri, opts = {})
       response = nil
 
-      http = HTTP["User-Agent" => "Ruby Harvest API Sample",
+      http = HTTP["User-Agent" => "Harvesting Ruby Gem",
                   "Authorization" => "Bearer #{@access_token}",
                   "Harvest-Account-ID" => @account_id]
       params = {}

data/lib/harvesting/models/base.rb

@@ -2,36 +2,64 @@ module Harvesting
   module Models
     class Base
       attr_accessor :attributes
-      attr_reader :client
+      attr_reader :harvest_client
 
       def initialize(attrs, opts = {})
+        @models = {}
         @attributes = attrs.dup
-        @client = opts[:client] || Harvesting::Client.new(opts)
+        @harvest_client = opts[:client] || Harvesting::Client.new(opts)
       end
 
       def self.attributed(*attribute_names)
         attribute_names.each do |attribute_name|
-          Harvesting::Models::Base.send :define_method, attribute_name.to_s do
+          define_method(attribute_name) do
             @attributes[__method__.to_s]
           end
         end
       end
 
+      def self.modeled(opts = {})
+        opts.each do |attribute_name, model|
+          attribute_name_string = attribute_name.to_s
+          Harvesting::Models::Base.send :define_method, attribute_name_string do
+            @models[attribute_name_string] ||= model.new(@attributes[attribute_name_string] || {}, client: harvest_client)
+          end
+        end
+      end
+
       def save
         id.nil? ? create : update
       end
 
       def create
-        @client.create(self)
+        @harvest_client.create(self)
       end
 
       def update
-        @client.update(self)
+        @harvest_client.update(self)
+      end
+
+      def delete
+        @harvest_client.delete(self)
       end
 
       def to_hash
         @attributes
       end
+
+      def fetch
+        self.class.new(@harvest_client.get(path), client: @harvest_client)
+      end
+
+      # Retrieves an instance of the object by ID
+      #
+      # @param id [Integer] the id of the object to retrieve
+      # @param opts [Hash] options to pass along to the `Harvesting::Client`
+      #   instance
+      def self.get(id, opts = {})
+        client = opts[:client] || Harvesting::Client.new(opts)
+        self.new({ 'id' => id }, opts).fetch
+      end
     end
   end
 end

data/lib/harvesting/models/client.rb

@@ -1,6 +1,6 @@
 module Harvesting
   module Models
-    class Client < Base
+    class Client < HarvestRecord
       attributed :id,
                  :name,
                  :is_active,
@@ -9,6 +9,9 @@ module Harvesting
                  :updated_at,
                  :currency
 
+      def path
+        @attributes['id'].nil? ? "clients" : "clients/#{@attributes['id']}"
+      end
     end
   end
 end

data/lib/harvesting/models/contact.rb

@@ -1,6 +1,6 @@
 module Harvesting
   module Models
-    class Contact < Base
+    class Contact < HarvestRecord
       attributed :id,
                  :title,
                  :first_name,
@@ -11,6 +11,16 @@ module Harvesting
                  :fax,
                  :created_at,
                  :updated_at
+
+      modeled client: Client
+
+      def path
+        @attributes['id'].nil? ? "contacts" : "contacts/#{@attributes['id']}"
+      end
+
+      def to_hash
+        { client_id: client.id }.merge(super)
+      end
     end
   end
 end

data/lib/harvesting/models/harvest_record.rb

@@ -0,0 +1,18 @@
+module Harvesting
+  module Models
+    class HarvestRecord < Base
+
+      def save
+        id.nil? ? create : update
+      end
+
+      def create
+        harvest_client.create(self)
+      end
+
+      def update
+        harvest_client.update(self)
+      end
+    end
+  end
+end

data/lib/harvesting/models/harvest_record_collection.rb

@@ -0,0 +1,41 @@
+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,37 @@
+module Harvesting
+  module Models
+    class Invoice < HarvestRecord
+      attributed :id,
+                 :client_key,
+                 :line_items,
+                 :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 path
+        @attributes['id'].nil? ? "invoices" : "invoices/#{@attributes['id']}"
+      end
+    end
+  end
+end

data/lib/harvesting/models/project.rb

@@ -1,8 +1,7 @@
 module Harvesting
   module Models
-    class Project < Base
+    class Project < HarvestRecord
       attributed :id,
-                 :client,
                  :name,
                  :code,
                  :is_active,
@@ -12,6 +11,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 +25,14 @@ 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
     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])
         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,6 +1,6 @@
 module Harvesting
   module Models
-    class Task < Base
+    class Task < HarvestRecord
       attributed :id,
                  :name,
                  :billable_by_default, 
@@ -11,7 +11,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/task_assignment.rb

@@ -0,0 +1,31 @@
+module Harvesting
+  module Models
+    class TaskAssignment < 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/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])
         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])
         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

data/lib/harvesting/models/time_entry.rb

@@ -1,12 +1,10 @@
 module Harvesting
   module Models
-    class TimeEntry < Base
+    class TimeEntry < HarvestRecord
       attributed :id,
                  :spent_date,
                  :hours,
                  :notes,
-                 :created_at,
-                 :updated_at,
                  :is_locked,
                  :locked_reason,
                  :is_closed,
@@ -15,22 +13,31 @@ module Harvesting
                  :started_time,
                  :ended_time,
                  :is_running,
-                 :invoice,
-                 :external_reference,
                  :billable,
                  :budgeted,
                  :billable_rate,
                  :cost_rate,
-                 :project_id,
-                 :task_id
+                 :invoice,
+                 :external_reference,
+                 :created_at,
+                 :updated_at,
+                 :user_assignment # temporarily return the hash itself until the model is added
+
+      modeled project: Project,
+              user: User,
+              task: Task,
+              client: Client,
+              task_assignment: TaskAssignment
+
 
       def path
-        id.nil? ? "time_entries" : "time_entries/#{id}"
+        @attributes['id'].nil? ? "time_entries" : "time_entries/#{@attributes['id']}"
       end
 
-      def user
-        Models::User.new(@attributes['user'], client: @client)
+      def to_hash
+        { project_id: project.id, task_id: task.id, user_id: user.id }.merge(super)
       end
+
     end
   end
 end

data/lib/harvesting/models/user.rb

@@ -1,25 +1,31 @@
 module Harvesting
   module Models
-    class User < Base
+    class User < HarvestRecord
       attributed :id,
                  :first_name,
                  :last_name,
                  :email,
                  :telephone,
                  :timezone,
-                 :weekly_capacity,
                  :has_access_to_all_future_projects,
                  :is_contractor,
                  :is_admin,
                  :is_project_manager,
                  :can_see_rates,
-                 :can_create_projects,
                  :can_create_invoices,
+                 :can_create_projects,
                  :is_active,
-                 :created_at,
-                 :updated_at,
+                 :weekly_capacity,
+                 :default_hourly_rate,
+                 :cost_rate,
                  :roles,
-                 :avatar_url
+                 :avatar_url,
+                 :created_at,
+                 :updated_at
+
+      def path
+        @attributes['id'].nil? ? "users" : "users/#{@attributes['id']}"
+      end
     end
   end
 end

data/lib/harvesting/models/users.rb

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

data/lib/harvesting/version.rb

@@ -1,3 +1,3 @@
 module Harvesting
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,33 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: harvesting
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
@@ -76,82 +76,102 @@ dependencies:
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Interact with the Harvest API v2.0 from your Ruby application
 email:
 - ernesto+github@ombulabs.com
@@ -159,6 +179,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -182,13 +203,18 @@ files:
 - lib/harvesting/models/base.rb
 - lib/harvesting/models/client.rb
 - lib/harvesting/models/contact.rb
+- lib/harvesting/models/harvest_record.rb
+- lib/harvesting/models/harvest_record_collection.rb
+- lib/harvesting/models/invoice.rb
 - lib/harvesting/models/project.rb
 - lib/harvesting/models/projects.rb
 - lib/harvesting/models/task.rb
+- lib/harvesting/models/task_assignment.rb
 - lib/harvesting/models/tasks.rb
 - lib/harvesting/models/time_entries.rb
 - lib/harvesting/models/time_entry.rb
 - lib/harvesting/models/user.rb
+- lib/harvesting/models/users.rb
 - lib/harvesting/version.rb
 homepage: https://github.com/ombulabs/harvesting
 licenses:
@@ -210,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Harvest API v2.0