Class: Quandl::Client::Superset

Inherits:
Base
  • Object
show all
Defined in:
lib/quandl/client/models/superset.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

her_api, models, models_use_her_api!, url_with_version, use

Class Method Details

.exampleObject



13
14
15
# File 'lib/quandl/client/models/superset.rb', line 13

def self.example
  self.new( code: "EXAMPLE", name: "Superset Name", description: "Superset description", column_codes: ['SOURCE.DATASET.1'], column_names: ['Column Name'] )
end

Instance Method Details

#column_codes_should_be_valid!Object (protected)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/quandl/client/models/superset.rb', line 23

def column_codes_should_be_valid!
  # must be an array
  unless column_codes.respond_to?(:each)
    # failure
    self.errors.add( :column_codes, "expected an array, but got #{column_codes.class}.")
    # nothing more to do
    return false
  end
  # check each code
  column_codes.each do |code|
    # is the code valid?
    next if code =~ /#{Quandl::Pattern.code}\.#{Quandl::Pattern.code}\.[0-9]+/
    # otherwise report error
    self.errors.add( :column_codes, "Code '#{code}' is invalid. Expected: /#{Quandl::Pattern.code.to_example}.#{Quandl::Pattern.code.to_example}.INTEGER/" )
    # nothing more to do here
    return false
  end
  # success
  true
end

#dataObject



17
18
19
# File 'lib/quandl/client/models/superset.rb', line 17

def data
  @data ||= Quandl::Client::Dataset::Data.with_id(id)
end