forecasting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edb8ec26fd106cae648d103e0d55a3eac43a84950932903c964263597641dae1
+  data.tar.gz: cc0ff4974048deca834309b5c652bd776ba6ef78454f7cf5cbe1afeeb85dc4cf
+SHA512:
+  metadata.gz: bf01d135878f0a0fe617787f0b4f73404b5cbc71b0fe6ea7c460b47bb8e097f25265925d9a50e78dc5bd17386d32773d8e86428ed2ad414e293d2b1975296f5a
+  data.tar.gz: f58e4883da565c2388e6baa5b6b09498574e5e214cbc21d1e0cff0b9d696462db230c07b3406500ee6583faa5f680960bc78670a66570805d688fb4fd3b080f1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### Unreleased
+
+**Notes**
+
+**Bug Fixes**
+
+## Version 0.1.0 - Jan 29, 2023
+
+**Notes**
+
+- Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Jordan Owens
+Copyright (c) 2018 Ernesto Tagwerker
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Forecasting
+
+[![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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forecasting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forecasting
+
+## Usage
+
+In order to start using this gem you will need your personal token and an account id:
+
+You can find these details over here: https://id.getharvest.com/developers
+
+If you don't specify values for `access_token` or `account_id`, it will default to these environment variables:
+
+* `ENV['FORECAST_ACCESS_TOKEN']`
+* `ENV['FORECAST_ACCOUNT_ID']`
+
+```ruby
+# $ export FORECST_ACCESS_TOKEN=xxx
+# $ export FORECAST_ACCOUNT_ID=12345678
+client = Forecasting::Client.new
+client.whoami
+=> #<Forecasting::Models::User:0x000000010488e370 @attributes={"id"=>212737, ... }>
+```
+
+If the access token or account id is invalid a `Forecasting::AuthenticationError` will be raised:
+
+```ruby
+client = Forcasting::Client.new(access_token: "foo", account_id: "bar")
+client.whoami
+=> #<Forecasting::AuthenticationError: {"reason":"non-existent-token","account_id":"bar"}>
+```
+
+With a valid access token and account id:
+
+```ruby
+client = Forecasting::Client.new(access_token: "<your token here>", account_id: "<your account id here>")
+user = client.whoami
+#<Forecasting::Models::User:0x000000010e238ac0 @attributes={"id"=>212737, ... }>
+
+user.id
+# => 212737
+```
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/forecasting/client.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+require "http"
+require "json"
+
+class Forecasting::Client
+  DEFAULT_HOST = "https://api.forecastapp.com"
+
+  attr_accessor :access_token, :account_id, :host
+
+  def initialize(access_token: ENV['FORECAST_ACCESS_TOKEN'],
+                 account_id: ENV['FORECAST_ACCOUNT_ID'],
+                 host: DEFAULT_HOST)
+    @access_token = access_token
+    @account_id = account_id
+    @host = host
+  end
+
+  # @return [Forecasting::Models::Account]
+  def account(id:)
+    Forecasting::Models::Account.new(get("accounts/#{id}")["account"])
+  end
+
+  # @return [Forecasting::Models::Assignment]
+  def assignment(id:)
+    Forecasting::Models::Assignment.new(get("assignments/#{id}")["assignment"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Assignment>]
+  def assignments(opts = {})
+    get("assignments", opts)["assignments"].map do |entry|
+      Forecasting::Models::Assignment.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Client]
+  def client(id:)
+    Forecasting::Models::Client.new(get("clients/#{id}")["client"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Client>]
+  def clients(opts = {})
+    get("clients", opts)["clients"].map do |entry|
+      Forecasting::Models::Client.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::FtuxState]
+  def ftux_state
+    Forecasting::Models::FtuxState.new(get("ftux_state")["ftux_state"])
+  end
+
+  # @return [Array<Forecasting::Models::FutureScheduledHours>]
+  def future_scheduled_hours(opts = {})
+    start_date = opts.delete(:start_date) || Time.now.strftime("%Y-%m-%d")
+    get("aggregate/future_scheduled_hours/#{start_date}", opts)["future_scheduled_hours"].map do |entry|
+      Forecasting::Models::FutureScheduledHours.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Milestone]
+  def milestone(id:)
+    Forecasting::Models::Milestone.new(get("milestones/#{id}")["milestone"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Milestone>]
+  def milestones(opts = {})
+    get("milestones", opts)["milestones"].map do |entry|
+      Forecasting::Models::Milestone.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Person]
+  def person(id:)
+    Forecasting::Models::Person.new(get("people/#{id}")["person"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Person>]
+  def people(opts = {})
+    get("people", opts)["people"].map do |entry|
+      Forecasting::Models::Person.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Placeholder]
+  def placeholder(id:)
+    Forecasting::Models::Placeholder.new(get("placeholders/#{id}")["placeholder"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Placeholder>]
+  def placeholders(opts = {})
+    get("placeholders", opts)["placeholders"].map do |entry|
+      Forecasting::Models::Placeholder.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Projects]
+  def project(id:)
+    Forecasting::Models::Project.new(get("projects/#{id}")["project"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Project>]
+  def projects(opts = {})
+    get("projects", opts)["projects"].map do |entry|
+      Forecasting::Models::Project.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Array<Forecasting::Models::RemainingBudgetedHours>]
+  def remaining_budgeted_hours(opts = {})
+    get("aggregate/remaining_budgeted_hours", opts)["remaining_budgeted_hours"].map do |entry|
+      Forecasting::Models::RemainingBudgetedHours.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::RepeatedAssignmentSet]
+  def repeated_assignment_set(id:)
+    Forecasting::Models::RepeatedAssignmentSet.new(get("repeated_assignment_sets/#{id}")["repeated_assignment_set"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::RepeatedAssignmentSet>]
+  def repeated_assignment_sets(opts = {})
+    get("repeated_assignment_sets", opts)["repeated_assignment_sets"].map do |entry|
+      Forecasting::Models::RepeatedAssignmentSet.new(entry, forecast_client: self)
+    end
+  end
+
+  # @return [Forecasting::Models::Role]
+  def role(id:)
+    Forecasting::Models::Role.new(get("roles/#{id}")["role"], forecast_client: self)
+  end
+
+  # @return [Array<Forecasting::Models::Role>]
+  def roles(opts = {})
+    get("roles", opts)["roles"].map do |entry|
+      Forecasting::Models::Role.new(entry, forecast_client: self)
+    end
+  end
+  
+  # @return [Forecasting::Models::Subscription]
+  def subscription
+    Forecasting::Models::Subscription.new(get("billing/subscription")["subscription"])
+  end
+
+  # @return [Forecasting::Models::UserConnection]
+  def user_connections(opts = {})
+    get("user_connections", opts)["user_connections"].map do |entry|
+      Forecasting::Models::UserConnection.new(entry)
+    end
+  end
+
+  # @return [Forecasting::Models::User]
+  def whoami
+    Forecasting::Models::User.new(get("whoami")["current_user"])
+  end
+
+  # Creates an `entity` in your Harvest account.
+  #
+  # @param entity [Harvesting::Models::Base] A new record in your Harvest account
+  # @return [Harvesting::Models::Base] A subclass of `Harvesting::Models::Base` updated with the response from Harvest
+  def create(entity)
+    url = "#{host}/#{entity.path}"
+    uri = URI(url)
+    response = http_response(:post, uri, body: payload(entity))
+    entity.attributes = JSON.parse(response.body)[entity.type]
+    entity
+  end
+
+  # Updates an `entity` in your Harvest account.
+  #
+  # @param entity [Harvesting::Models::Base] An existing record in your Harvest account
+  # @return [Harvesting::Models::Base] A subclass of `Harvesting::Models::Base` updated with the response from Harvest
+  def update(entity)
+    url = "#{host}/#{entity.path}"
+    uri = URI(url)
+    response = http_response(:patch, uri, body: payload(entity))
+    entity.attributes = JSON.parse(response.body)[entity.type]
+    entity
+  end
+
+  # It removes an `entity` from your Harvest account.
+  #
+  # @param entity [Harvesting::Models::Base] A record to be removed from your Harvest account
+  # @return [Hash]
+  # @raise [UnprocessableRequest] When HTTP response is not 200 OK
+  def delete(entity)
+    url = "#{host}/#{entity.path}"
+    uri = URI(url)
+    response = http_response(:delete, uri)
+    raise Forecasting::Errors::UnprocessableRequest.new(response.to_s) unless response.code.to_i == 200
+
+    JSON.parse(response.body)
+  end
+
+  # Performs a GET request and returned the parsed JSON as a Hash.
+  #
+  # @param path [String] path to be combined with `host`
+  # @param opts [Hash] key/values will get passed as HTTP (GET) parameters
+  # @return [Hash]
+  def get(path, opts = {})
+    url = "#{host}/#{path}"
+    url += "?#{opts.map {|k, v| "#{k}=#{v}"}.join("&")}" if opts.any?
+    uri = URI(url)
+    response = http_response(:get, uri)
+    JSON.parse(response.body)
+  end
+
+  private
+
+  def payload(entity)
+    {
+      entity.type => entity.to_hash
+    }
+  end
+
+  def http_response(method, uri, opts = {})
+    response = nil
+
+    http = HTTP["User-Agent" => "Forecasting Ruby Gem",
+                "Authorization" => "Bearer #{access_token}",
+                "Forecast-Account-ID" => account_id]
+    params = {}
+    if opts[:body]
+      params[:json] = opts[:body]
+    end
+    response = http.send(method, uri, params)
+
+    raise Forecasting::AuthenticationError.new(response.to_s) if auth_error?(response)
+    raise Forecasting::UnprocessableRequest.new(response.to_s) if response.code.to_i == 422
+    raise Forecasting::RequestNotFound.new(uri) if response.code.to_i == 404
+    raise Forecasting::RateLimitExceeded.new(response.to_s) if response.code.to_i == 429
+
+    response
+  end
+
+  def auth_error?(response)
+    response.code.to_i == 403 || response.code.to_i == 401
+  end
+end

data/lib/forecasting/errors.rb

@@ -0,0 +1,16 @@
+module Forecasting
+  class AuthenticationError < StandardError
+  end
+
+  class UnprocessableRequest < StandardError
+  end
+
+  class RequestNotFound < StandardError
+    def initialize(uri)
+      super("The page you were looking for may have been moved or the address misspelled: #{uri}")
+    end
+  end
+
+  class RateLimitExceeded < StandardError
+  end
+end

data/lib/forecasting/models/account.rb

@@ -0,0 +1,20 @@
+module Forecasting
+  module Models
+    class Account < Base
+      attributed :id,
+                 :name,
+                 :weekly_capacity,
+                 :harvest_subdomain,
+                 :harvest_link,
+                 :harvest_name,
+                 :weekends_enabled,
+                 :created_at
+
+      def color_labels
+        attributes["color_labels"].map do |entry|
+          ColorLabel.new(entry)
+        end
+      end
+    end
+  end
+end

data/lib/forecasting/models/address.rb

@@ -0,0 +1,12 @@
+module Forecasting
+  module Models
+    class Address < Base
+      attributed :line_1,
+                 :line_2,
+                 :city,
+                 :state,
+                 :postal_code,
+                 :country
+    end
+  end
+end

data/lib/forecasting/models/assignment.rb

@@ -0,0 +1,34 @@
+module Forecasting
+  module Models
+    class Assignment < ForecastRecord
+      attributed :id,
+                 :start_date,
+                 :end_date,
+                 :allocation,
+                 :notes,
+                 :project_id,
+                 :person_id,
+                 :placeholder_id,
+                 :repeated_assignment_set_id,
+                 :active_on_days_off,
+                 :updated_at,
+                 :updated_by_id
+
+      def path
+        @attributes['id'].nil? ? "milestones" : "milestones/#{@attributes['id']}"
+      end
+      
+      def project
+        forecast_client.project(id: project_id)
+      end
+
+      def person
+        forecast_client.person(id: person_id)
+      end
+
+      def placeholder
+        forecast_client.placeholder(id: placeholder_id)
+      end
+    end
+  end
+end

data/lib/forecasting/models/base.rb

@@ -0,0 +1,64 @@
+module Forecasting
+  module Models
+    class Base
+      # @return [Hash]
+      attr_accessor :attributes
+
+      def initialize(attrs)
+        @attributes = attrs.dup
+        @models = {}
+      end
+
+      # It returns keys and values for all the attributes of this record.
+      #
+      # @return [Hash]
+      def to_hash
+        @attributes
+      end
+
+
+      # Class method to define attribute methods for accessing attributes for
+      # a record
+      #
+      # It needs to be used like this:
+      #
+      #     class User < ForecastRecord
+      #       attributed :id,
+      #                  :title,
+      #                  :first_name
+      #       ...
+      #     end
+      #
+      # @param attribute_names [Array] A list of attributes
+      def self.attributed(*attribute_names)
+        attribute_names.each do |attribute_name|
+          define_method(attribute_name) do
+            @attributes[__method__.to_s]
+          end
+          define_method("#{attribute_name}=") do |value|
+            @attributes[__method__.to_s.chop] = value
+          end
+        end
+      end
+
+      # Class method to define nested resources for a record.
+      #
+      # It needs to be used like this:
+      #
+      #     class Project < Base
+      #       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] || {})
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forecasting/models/card.rb

@@ -0,0 +1,10 @@
+module Forecasting
+  module Models
+    class Card < Base
+      attributed :brand,
+                 :last_four,
+                 :expiry_month,
+                 :expiry_year
+    end
+  end
+end

data/lib/forecasting/models/client.rb

@@ -0,0 +1,17 @@
+module Forecasting
+  module Models
+    # A client record from your Harvest account.
+    class Client < ForecastRecord
+      attributed :id,
+                 :name,
+                 :harvest_id,
+                 :archived,
+                 :updated_at,
+                 :updated_by_id
+
+      def path
+        @attributes['id'].nil? ? "clients" : "clients/#{@attributes['id']}"
+      end
+    end
+  end
+end

data/lib/forecasting/models/color_label.rb

@@ -0,0 +1,7 @@
+module Forecasting
+  module Models
+    class ColorLabel < Base
+      attributed :name, :label
+    end
+  end
+end

data/lib/forecasting/models/discount.rb

@@ -0,0 +1,8 @@
+module Forecasting
+  module Models
+    class Discount < Base
+      attributed :monthly_percentage,
+                 :yearly_percentage
+    end
+  end
+end

data/lib/forecasting/models/forecast_record.rb

@@ -0,0 +1,74 @@
+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
+      end
+
+      def create
+        forecast_client.create(self)
+      end
+
+      def update
+        forecast_client.update(self)
+      end
+
+      def delete
+        forecast_client.delete(self)
+      end
+
+      # It loads a new record from your Harvest account.
+      #
+      # @return [Forecasting::Models::Base]
+      def fetch
+        self.class.new(@forecast_client.get(path), forecast_client: @forecast_client)
+      end
+
+      # It returns the model type
+      #
+      # @return [String]
+      def type
+        self.class.name.split("::").last.downcase
+      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 `Forecasting::Client`
+      #   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
+        end
+      end
+    end
+  end
+end

data/lib/forecasting/models/ftux_state.rb

@@ -0,0 +1,7 @@
+module Forecasting
+  module Models
+    class FtuxState < Base
+      attributed :account_creator, :step
+    end
+  end
+end

data/lib/forecasting/models/future_scheduled_hours.rb

@@ -0,0 +1,30 @@
+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
+
+      def person
+        forecast_client.person(id: person_id)
+      end
+
+      def placeholder
+        forecast_client.placeholder(id: placeholder_id)
+      end
+    end
+  end
+end

data/lib/forecasting/models/milestone.rb

@@ -0,0 +1,20 @@
+module Forecasting
+  module Models
+    class Milestone < ForecastRecord
+      attributed :id,
+                 :name,
+                 :date,
+                 :project_id,
+                 :updated_at,
+                 :updated_by_id
+
+      def path
+        @attributes['id'].nil? ? "milestones" : "milestones/#{@attributes['id']}"
+      end
+      
+      def project
+        forecast_client.project(id: project_id)
+      end
+    end
+  end
+end

data/lib/forecasting/models/person.rb

@@ -0,0 +1,27 @@
+module Forecasting
+  module Models
+    class Person < ForecastRecord
+      attributed :id,
+                 :first_name,
+                 :last_name,
+                 :email,
+                 :login,
+                 :admin,
+                 :archived,
+                 :subscribed,
+                 :avatar_url,
+                 :roles,
+                 :updated_at,
+                 :updated_by_id,
+                 :harvest_user_id,
+                 :weekly_capacity,
+                 :working_days,
+                 :color_blind,
+                 :personal_feed_token_id
+
+      def path
+        @attributes['id'].nil? ? "people" : "people/#{@attributes['id']}"
+      end
+    end
+  end
+end

data/lib/forecasting/models/placeholder.rb

@@ -0,0 +1,16 @@
+module Forecasting
+  module Models
+    class Placeholder < ForecastRecord
+      attributed :id,
+                 :name,
+                 :archived,
+                 :roles,
+                 :updated_at,
+                 :updated_by_id
+
+      def path
+        @attributes['id'].nil? ? "placeholders" : "placeholders/#{@attributes['id']}"
+      end
+    end
+  end
+end

data/lib/forecasting/models/project.rb

@@ -0,0 +1,28 @@
+module Forecasting
+  module Models
+    # A project record from your Harvest account.
+    class Project < ForecastRecord
+      attributed :id,
+                 :name,
+                 :code,
+                 :color,
+                 :notes,
+                 :start_date,
+                 :end_date,
+                 :harvest_id,
+                 :archived,
+                 :updated_at,
+                 :updated_by_id,
+                 :client_id,
+                 :tags
+
+      def path
+        @attributes['id'].nil? ? "projects" : "projects/#{@attributes['id']}"
+      end
+      
+      def client
+        forecast_client.client(id: client_id)
+      end
+    end
+  end
+end

data/lib/forecasting/models/remaining_budgeted_hours.rb

@@ -0,0 +1,23 @@
+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
+    end
+  end
+end

data/lib/forecasting/models/repeated_assignment_set.rb

@@ -0,0 +1,20 @@
+module Forecasting
+  module Models
+    class RepeatedAssignmentSet < ForecastRecord
+      attributed :id,
+                 :first_start_date,
+                 :last_end_date,
+                 :assignment_ids
+
+      def path
+        @attributes['id'].nil? ? "repeated_assignment_sets" : "repeated_assignment_sets/#{@attributes['id']}"
+      end
+      
+      def assignments
+        assignment_ids.map do |assignment_id|
+          forecast_client.assignment(id: assignment_id)
+        end
+      end
+    end
+  end
+end

data/lib/forecasting/models/role.rb

@@ -0,0 +1,27 @@
+module Forecasting
+  module Models
+    class Role < ForecastRecord
+      attributed :id,
+                 :name,
+                 :placeholder_ids,
+                 :person_ids,
+                 :harvest_role_id
+
+      def path
+        @attributes['id'].nil? ? "roles" : "roles/#{@attributes['id']}"
+      end
+      
+      def placeholders
+        placeholder_ids.map do |placeholder_id|
+          forecast_client.placeholder(id: placeholder_id)
+        end
+      end
+
+      def people
+        person_ids.map do |person_id|
+          forecast_client.person(id: person_id)
+        end
+      end
+    end
+  end
+end

data/lib/forecasting/models/subscription.rb

@@ -0,0 +1,24 @@
+module Forecasting
+  module Models
+    class Subscription < Base
+      attributed :id,
+                 :next_billing_date,
+                 :days_until_next_billing_date,
+                 :amount,
+                 :amount_per_person,
+                 :receipt_recipient,
+                 :status,
+                 :purchase_people,
+                 :interval,
+                 :paid_by_invoice,
+                 :placeholder_limit,
+                 :invoiced,
+                 :days_until_due,
+                 :balance,
+                 :sales_tax_exempt,
+                 :sales_tax_percentage
+
+      modeled address: Address, card: Card, discounts: Discount
+    end
+  end
+end

data/lib/forecasting/models/user.rb

@@ -0,0 +1,7 @@
+module Forecasting
+  module Models
+    class User < Base
+      attributed :id, :account_ids
+    end
+  end
+end

data/lib/forecasting/models/user_connection.rb

@@ -0,0 +1,13 @@
+module Forecasting
+  module Models
+    class UserConnection < Base
+      attributed :id,
+                 :person_id,
+                 :last_active_at
+
+      def person
+        forecast_client.person(id: person_id)
+      end
+    end
+  end
+end

data/lib/forecasting/version.rb

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

data/lib/forecasting.rb

@@ -0,0 +1,29 @@
+# framework
+require_relative "forecasting/version"
+require_relative "forecasting/errors"
+require_relative "forecasting/models/base"
+require_relative "forecasting/models/forecast_record"
+# forecast records
+require_relative "forecasting/models/account"
+require_relative "forecasting/models/address"
+require_relative "forecasting/models/assignment"
+require_relative "forecasting/models/card"
+require_relative "forecasting/models/client"
+require_relative "forecasting/models/discount"
+require_relative "forecasting/models/ftux_state"
+require_relative "forecasting/models/future_scheduled_hours"
+require_relative "forecasting/models/milestone"
+require_relative "forecasting/models/person"
+require_relative "forecasting/models/placeholder"
+require_relative "forecasting/models/project"
+require_relative "forecasting/models/remaining_budgeted_hours"
+require_relative "forecasting/models/repeated_assignment_set"
+require_relative "forecasting/models/role"
+require_relative "forecasting/models/subscription"
+require_relative "forecasting/models/user_connection"
+require_relative "forecasting/models/user"
+# API client
+require_relative "forecasting/client"
+
+module Forecasting
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: forecasting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Owens
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Interact with the Forecast API from your Ruby application
+email:
+- jordan@neomindlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/forecasting.rb
+- lib/forecasting/client.rb
+- lib/forecasting/errors.rb
+- lib/forecasting/models/account.rb
+- lib/forecasting/models/address.rb
+- lib/forecasting/models/assignment.rb
+- lib/forecasting/models/base.rb
+- lib/forecasting/models/card.rb
+- lib/forecasting/models/client.rb
+- lib/forecasting/models/color_label.rb
+- lib/forecasting/models/discount.rb
+- lib/forecasting/models/forecast_record.rb
+- lib/forecasting/models/ftux_state.rb
+- lib/forecasting/models/future_scheduled_hours.rb
+- lib/forecasting/models/milestone.rb
+- lib/forecasting/models/person.rb
+- lib/forecasting/models/placeholder.rb
+- lib/forecasting/models/project.rb
+- lib/forecasting/models/remaining_budgeted_hours.rb
+- lib/forecasting/models/repeated_assignment_set.rb
+- lib/forecasting/models/role.rb
+- lib/forecasting/models/subscription.rb
+- lib/forecasting/models/user.rb
+- lib/forecasting/models/user_connection.rb
+- lib/forecasting/version.rb
+homepage: https://github.com/NeomindLabs/forecasting
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.20
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the Forecast API
+test_files: []