Class: Forecasting::Models::ForecastRecord

Inherits:

Base

• Object
• Base
• Forecasting::Models::ForecastRecord

Defined in:

lib/forecasting/models/forecast_record.rb

Direct Known Subclasses

Assignment, Client, Milestone, Person, Placeholder, Project, RepeatedAssignmentSet, Role

Instance Attribute Summary

• #forecast_client ⇒ Forecasting::Model::Client readonly

Attributes inherited from Base

#attributes

Class Method Summary

• .get(id, opts = {}) ⇒ Object

  Retrieves an instance of the object by ID.

Instance Method Summary

• #create ⇒ Object
• #delete ⇒ Object
• #fetch ⇒ Forecasting::Models::Base

  It loads a new record from your Harvest account.

• #initialize(attrs, opts = {}) ⇒ ForecastRecord constructor

  A new instance of ForecastRecord.

• #save ⇒ Object
• #type ⇒ String

  It returns the model type.

• #update ⇒ Object

Methods inherited from Base

attributed, #to_hash

Constructor Details

#initialize(attrs, opts = {}) ⇒ ForecastRecord

Returns a new instance of ForecastRecord.

# File 'lib/forecasting/models/forecast_record.rb', line 7

def initialize(attrs, opts = {})
  @forecast_client = opts[:forecast_client] || Forecasting::Client.new(**opts)
  super(attrs)
end

Instance Attribute Details

#forecast_client ⇒ Forecasting::Model::Client (readonly)

Returns:

• (Forecasting::Model::Client)

# File 'lib/forecasting/models/forecast_record.rb', line 5

def forecast_client
  @forecast_client
end

Class Method Details

.get(id, opts = {}) ⇒ Object

Retrieves an instance of the object by ID

Parameters:

• id (Integer) —

  the id of the object to retrieve

• opts (Hash) (defaults to: {}) —

  options to pass along to the Forecasting::Client instance

# File 'lib/forecasting/models/forecast_record.rb', line 47

def self.get(id, opts = {})
  client = opts[:forecast_client] || Forecasting::Client.new(**opts)
  self.new({ 'id' => id }, opts).fetch
end

Instance Method Details

#create ⇒ Object

# File 'lib/forecasting/models/forecast_record.rb', line 16

def create
  forecast_client.create(self)
end

#delete ⇒ Object

# File 'lib/forecasting/models/forecast_record.rb', line 24

def delete
  forecast_client.delete(self)
end

#fetch ⇒ Forecasting::Models::Base

It loads a new record from your Harvest account.

Returns:

• (Forecasting::Models::Base)

# File 'lib/forecasting/models/forecast_record.rb', line 31

def fetch
  self.class.new(@forecast_client.get(path), forecast_client: @forecast_client)
end

#save ⇒ Object

# File 'lib/forecasting/models/forecast_record.rb', line 12

def save
  id.nil? ? create : update
end

#type ⇒ String

It returns the model type

Returns:

• (String)

# File 'lib/forecasting/models/forecast_record.rb', line 38

def type
  self.class.name.split("::").last.downcase
end

#update ⇒ Object

# File 'lib/forecasting/models/forecast_record.rb', line 20

def update
  forecast_client.update(self)
end