forecasting 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb8ec26fd106cae648d103e0d55a3eac43a84950932903c964263597641dae1
-  data.tar.gz: cc0ff4974048deca834309b5c652bd776ba6ef78454f7cf5cbe1afeeb85dc4cf
+  metadata.gz: 28606e4981727f588e0ab9a027bcea84cd3f25563d2ab031b2eeb075455d42be
+  data.tar.gz: e68359ad5b0452f3c60f5d5d4c00a7cf9f03311da0d277b7832c88a3115dfc68
 SHA512:
-  metadata.gz: bf01d135878f0a0fe617787f0b4f73404b5cbc71b0fe6ea7c460b47bb8e097f25265925d9a50e78dc5bd17386d32773d8e86428ed2ad414e293d2b1975296f5a
-  data.tar.gz: f58e4883da565c2388e6baa5b6b09498574e5e214cbc21d1e0cff0b9d696462db230c07b3406500ee6583faa5f680960bc78670a66570805d688fb4fd3b080f1
+  metadata.gz: 37dccf7bdca14315ec3810be2bc6de1123827b5388a903dee7b5f2f9501a064c3772a10afc0cb5fa5dee12c7da0335b9f7e82a80927052c8f20376f4fdb233d9
+  data.tar.gz: da4002bc71187fe2084fee8c377de963805f93a7ba79e0a7489cd6f275ff8985b688ca805823282da145334cdd0684eb113ffb8e9e0c1f553e6bb40cdfae937e

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 **Bug Fixes**
 
+## Version 0.2.0 - Jan 30, 2023
+
+**Notes**
+
+- Refactored Forecasting::Models::Base and Forecasting::Models::ForecastRecord
+
 ## Version 0.1.0 - Jan 29, 2023
 
 **Notes**

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/forecasting.svg)](https://badge.fury.io/rb/forecasting)
 [![Tests](https://github.com/NeomindLabs/forecasting/actions/workflows/ruby.yml/badge.svg)](https://github.com/NeomindLabs/forecasting/actions/workflows/ruby.yml)
-[![Code Climate](https://codeclimate.com/github/NeomindLabs/forecasting/badges/gpa.svg)](https://codeclimate.com/github/NeomindLabs/forecasting)
 
 A Ruby gem to interact with the Harvest Forecast API. Please note that there is currently [no official public API](https://help.getharvest.com/forecast/faqs/faq-list/api). This API client has been made by inspecting network requests using the Forecast website. This library is based on the excellent [Harvesting](https://github.com/fastruby/harvesting) gem.
 

data/lib/forecasting/client.rb

@@ -17,12 +17,12 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Account]
   def account(id:)
-    Forecasting::Models::Account.new(get("accounts/#{id}")["account"])
+    Forecasting::Models::Account.new(get("accounts/#{id}")["account"], forecast_client: self)
   end
 
   # @return [Forecasting::Models::Assignment]
   def assignment(id:)
-    Forecasting::Models::Assignment.new(get("assignments/#{id}")["assignment"], forecast_client: self)
+    Forecasting::Models::Assignment.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Assignment>]
@@ -34,7 +34,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Client]
   def client(id:)
-    Forecasting::Models::Client.new(get("clients/#{id}")["client"], forecast_client: self)
+    Forecasting::Models::Client.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Client>]
@@ -46,7 +46,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::FtuxState]
   def ftux_state
-    Forecasting::Models::FtuxState.new(get("ftux_state")["ftux_state"])
+    Forecasting::Models::FtuxState.new(get("ftux_state")["ftux_state"], forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::FutureScheduledHours>]
@@ -59,7 +59,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Milestone]
   def milestone(id:)
-    Forecasting::Models::Milestone.new(get("milestones/#{id}")["milestone"], forecast_client: self)
+    Forecasting::Models::Milestone.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Milestone>]
@@ -71,7 +71,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Person]
   def person(id:)
-    Forecasting::Models::Person.new(get("people/#{id}")["person"], forecast_client: self)
+    Forecasting::Models::Person.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Person>]
@@ -83,7 +83,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Placeholder]
   def placeholder(id:)
-    Forecasting::Models::Placeholder.new(get("placeholders/#{id}")["placeholder"], forecast_client: self)
+    Forecasting::Models::Placeholder.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Placeholder>]
@@ -95,7 +95,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Projects]
   def project(id:)
-    Forecasting::Models::Project.new(get("projects/#{id}")["project"], forecast_client: self)
+    Forecasting::Models::Project.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Project>]
@@ -114,7 +114,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::RepeatedAssignmentSet]
   def repeated_assignment_set(id:)
-    Forecasting::Models::RepeatedAssignmentSet.new(get("repeated_assignment_sets/#{id}")["repeated_assignment_set"], forecast_client: self)
+    Forecasting::Models::RepeatedAssignmentSet.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::RepeatedAssignmentSet>]
@@ -126,7 +126,7 @@ class Forecasting::Client
 
   # @return [Forecasting::Models::Role]
   def role(id:)
-    Forecasting::Models::Role.new(get("roles/#{id}")["role"], forecast_client: self)
+    Forecasting::Models::Role.get(id, forecast_client: self)
   end
 
   # @return [Array<Forecasting::Models::Role>]
@@ -138,19 +138,19 @@ class Forecasting::Client
   
   # @return [Forecasting::Models::Subscription]
   def subscription
-    Forecasting::Models::Subscription.new(get("billing/subscription")["subscription"])
+    Forecasting::Models::Subscription.new(get("billing/subscription")["subscription"], forecast_client: self)
   end
 
   # @return [Forecasting::Models::UserConnection]
   def user_connections(opts = {})
     get("user_connections", opts)["user_connections"].map do |entry|
-      Forecasting::Models::UserConnection.new(entry)
+      Forecasting::Models::UserConnection.new(entry, forecast_client: self)
     end
   end
 
   # @return [Forecasting::Models::User]
   def whoami
-    Forecasting::Models::User.new(get("whoami")["current_user"])
+    Forecasting::Models::User.new(get("whoami")["current_user"], forecast_client: self)
   end
 
   # Creates an `entity` in your Harvest account.

data/lib/forecasting/errors.rb

@@ -13,4 +13,7 @@ module Forecasting
 
   class RateLimitExceeded < StandardError
   end
+
+  class MethodNotImplemented < StandardError
+  end
 end

data/lib/forecasting/models/assignment.rb

@@ -15,7 +15,7 @@ module Forecasting
                  :updated_by_id
 
       def path
-        @attributes['id'].nil? ? "milestones" : "milestones/#{@attributes['id']}"
+        @attributes['id'].nil? ? "assignments" : "assignments/#{@attributes['id']}"
       end
       
       def project

data/lib/forecasting/models/base.rb

@@ -1,10 +1,14 @@
 module Forecasting
   module Models
     class Base
+      # @return [Forecasting::Client]
+      attr_reader :forecast_client
+
       # @return [Hash]
       attr_accessor :attributes
 
-      def initialize(attrs)
+      def initialize(attrs, opts = {})
+        @forecast_client = opts[:forecast_client] || Forecasting::Client.new(**opts)
         @attributes = attrs.dup
         @models = {}
       end
@@ -16,7 +20,6 @@ module Forecasting
         @attributes
       end
 
-
       # Class method to define attribute methods for accessing attributes for
       # a record
       #
@@ -55,7 +58,7 @@ module Forecasting
         opts.each do |attribute_name, model|
           attribute_name_string = attribute_name.to_s
           define_method(attribute_name_string) do
-            @models[attribute_name_string] ||= model.new(@attributes[attribute_name_string] || {})
+            @models[attribute_name_string] ||= model.new(@attributes[attribute_name_string] || {}, forecast_client: forecast_client)
           end
         end
       end

data/lib/forecasting/models/forecast_record.rb

@@ -1,13 +1,6 @@
 module Forecasting
   module Models
     class ForecastRecord < Base
-      # @return [Forecasting::Model::Client]
-      attr_reader :forecast_client
-
-      def initialize(attrs, opts = {})
-        @forecast_client = opts[:forecast_client] || Forecasting::Client.new(**opts)
-        super(attrs)
-      end
 
       def save
         id.nil? ? create : update
@@ -25,11 +18,10 @@ module Forecasting
         forecast_client.delete(self)
       end
 
-      # It loads a new record from your Harvest account.
-      #
-      # @return [Forecasting::Models::Base]
+      # It loads a new record from your Harvest account.  #
+      # @return [Forecasting::Models::ForecastRecord]
       def fetch
-        self.class.new(@forecast_client.get(path), forecast_client: @forecast_client)
+        self.class.new(forecast_client.get(path), forecast_client: forecast_client)
       end
 
       # It returns the model type
@@ -39,6 +31,10 @@ module Forecasting
         self.class.name.split("::").last.downcase
       end
 
+      def path
+        raise Forecasting::MethodNotImplemented
+      end
+
       # Retrieves an instance of the object by ID
       #
       # @param id [Integer] the id of the object to retrieve
@@ -46,27 +42,8 @@ module Forecasting
       #   instance
       def self.get(id, opts = {})
         client = opts[:forecast_client] || Forecasting::Client.new(**opts)
-        self.new({ 'id' => id }, opts).fetch
-      end
-
-      protected
-
-      # Class method to define nested resources for a record.
-      #
-      # It needs to be used like this:
-      #
-      #     class Project < ForecastRecord
-      #       modeled client: Client
-      #       ...
-      #     end
-      #
-      # @param opts [Hash] key = symbol that needs to be the same as the one returned by the Harvest API. value = model class for the nested resource.
-      def self.modeled(opts = {})
-        opts.each do |attribute_name, model|
-          attribute_name_string = attribute_name.to_s
-          define_method(attribute_name_string) do
-            @models[attribute_name_string] ||= model.new(@attributes[attribute_name_string] || {}, forecast_client: forecast_client)
-          end
+        self.new({ 'id' => id }, opts).tap do |record|
+          record.attributes = client.get(record.path)
         end
       end
     end

data/lib/forecasting/models/future_scheduled_hours.rb

@@ -1,19 +1,11 @@
 module Forecasting
   module Models
     class FutureScheduledHours < Base
-      # @return [Forecasting::Model::Client]
-      attr_reader :forecast_client
-
       attributed :project_id,
                  :person_id,
                  :placeholder_id,
                  :allocation
 
-      def initialize(attrs, opts = {})
-        @forecast_client = opts[:forecast_client] || Forecasting::Client.new(**opts)
-        super(attrs)
-      end
-
       def project
         forecast_client.project(id: project_id)
       end

data/lib/forecasting/models/remaining_budgeted_hours.rb

@@ -1,20 +1,12 @@
 module Forecasting
   module Models
     class RemainingBudgetedHours < Base
-      # @return [Forecasting::Model::Client]
-      attr_reader :forecast_client
-
       attributed :project_id,
                  :budget_by,
                  :budget_is_monthly,
                  :hours,
                  :response_code
 
-      def initialize(attrs, opts = {})
-        @forecast_client = opts[:forecast_client] || Forecasting::Client.new(**opts)
-        super(attrs)
-      end
-
       def project
         forecast_client.project(id: project_id)
       end

data/lib/forecasting/version.rb

@@ -1,3 +1,3 @@
 module Forecasting
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forecasting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jordan Owens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Interact with the Forecast API from your Ruby application
+description: Interact with the Harvest Forecast API from your Ruby application
 email:
 - jordan@neomindlabs.com
 executables: []
@@ -109,5 +109,5 @@ requirements: []
 rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
-summary: Ruby wrapper for the Forecast API
+summary: Ruby wrapper for the Harvest Forecast API
 test_files: []