nexosis_api 2.0.0 → 2.0.1

data/lib/nexosis_api/session.rb

@@ -1,118 +1,118 @@
-module NexosisApi
-  # Class for parsing the results of a session based request
-  class Session
-    def initialize(session_hash)
-      val_map = { 'resultInterval' => :@result_interval,
-                  'dataSourceName' => :@datasource_name,
-                  'modelId' => :@model_id,
-                  'sessionId' => :@session_id,
-                  'availablePredictionIntervals' => :@prediction_intervals,
-                  'startDate' => :@start_date,
-                  'endDate' => :@end_date,
-                  'predictionDomain' => :@prediction_domain,
-                  'extraParameters' => :@extra_parameters,
-                  'targetColumn' => :@target_column,
-                  'statusHistory' => :@status_history }
-      session_hash.each do |k, v|
-        if (k == 'links')
-          @links = v.map { |l| NexosisApi::Link.new(l) }
-        elsif (k == 'columns')
-          @column_metadata = v.reject { |_key, value| value.nil? }
-                              .map do |col_key, col_val|
-                                NexosisApi::Column.new(col_key, v[col_key])
-                              end
-        elsif (k == 'requestedDate')
-          @requested_date = DateTime.parse(v)
-        elsif (k == 'messages')
-          @messages = v.map { |m| NexosisApi::Message.new(m) } unless v.empty?
-        else
-          instance_variable_set("@#{k}", v) unless v.nil?
-        end
-        instance_variable_set(val_map[k.to_s], v) unless val_map[k.to_s].nil?
-      end
-    end
-
-    # identifier for this sesssion
-    # @return [String]
-    # @since 1.4.0
-    attr_accessor :session_id
-
-    # What type of analysis was run during this session
-    # @return [String]
-    attr_accessor :type
-
-    # Is this session requested, started, or completed
-    # @return [String]
-    attr_accessor :status
-
-    # Date and status of each status this session has entered
-    # @return [Array of Hash]
-    # @note - each status object in array is form { date: 'date', status: 'status' }
-    attr_accessor :status_history
-
-    # reserved for future extensions
-    # @return [Hash]
-    # @note - included 'balance' parameter for classification models
-    attr_accessor :extra_parameters
-
-    # The column in the dataset for which this session ran predictions
-    # @return [String]
-    attr_accessor :target_column
-
-    # The start date of analysis in this session
-    # @return [DateTime]
-    # @since 1.4.0
-    attr_accessor :start_date
-    
-    # The end date of analysis in this session
-    # @return [DateTime]
-    # @since 1.4.0
-    attr_accessor :end_date
-    
-    # associated hypermedia
-    # @return [Array of NexosisApi::Link]
-    attr_accessor :links
-
-    # The column descriptors for the data in this session
-    #    will reflect either the metadata sent in, defaults form dataset, or inferred values
-    # @return[Array of NexosisApi::Column]
-    attr_accessor :column_metadata
-
-    # The requested result interval. Default is DAY if none was requested during session creation.
-    # @return [NexosisApi::TimeInterval]
-    attr_accessor :result_interval
-
-    # The name of the datasource used to run this session
-    # @return [String] - the dataset or view name
-    # @since 1.2.0
-    attr_accessor :datasource_name
-
-    # The date this session was orginally submitted
-    # @since 1.3.0
-    attr_accessor :requested_date
-
-    # The id of the model created by this session if any
-    # @return [String] a uuid/buid format unique string for the model
-    # @since 1.3.0
-    # @note This is always empty in time-series sessions (forecast/impact)
-    # The model id returned here should be used in all future calls
-    # to model endpoints - primarily the /models/{model_id}/predict endpoint.
-    attr_accessor :model_id
-
-    # An array of the prediction intervals available for this session's results
-    # @return [Array]
-    # @note - by default the .5 interval will be returned in results. Consult
-    #    this list for other intervals which can be requested.
-    # @since 1.4.0
-    attr_accessor :prediction_intervals
-
-    # The type of model if a model creation session
-    # @return [String]
-    # @since 1.4.1
-    attr_accessor :prediction_domain
-
-    # A list of warning or error messages optionally returned from session
-    # @return [Array of Message]
-    attr_accessor :messages
-  end
-end
+module NexosisApi
+  # Class for parsing the results of a session based request
+  class Session
+    def initialize(session_hash)
+      val_map = { 'resultInterval' => :@result_interval,
+                  'dataSourceName' => :@datasource_name,
+                  'modelId' => :@model_id,
+                  'sessionId' => :@session_id,
+                  'availablePredictionIntervals' => :@prediction_intervals,
+                  'startDate' => :@start_date,
+                  'endDate' => :@end_date,
+                  'predictionDomain' => :@prediction_domain,
+                  'extraParameters' => :@extra_parameters,
+                  'targetColumn' => :@target_column,
+                  'statusHistory' => :@status_history }
+      session_hash.each do |k, v|
+        if (k == 'links')
+          @links = v.map { |l| NexosisApi::Link.new(l) }
+        elsif (k == 'columns')
+          @column_metadata = v.reject { |_key, value| value.nil? }
+                              .map do |col_key, col_val|
+                                NexosisApi::Column.new(col_key, v[col_key])
+                              end
+        elsif (k == 'requestedDate')
+          @requested_date = DateTime.parse(v)
+        elsif (k == 'messages')
+          @messages = v.map { |m| NexosisApi::Message.new(m) } unless v.empty?
+        else
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+        instance_variable_set(val_map[k.to_s], v) unless val_map[k.to_s].nil?
+      end
+    end
+
+    # identifier for this sesssion
+    # @return [String]
+    # @since 1.4.0
+    attr_accessor :session_id
+
+    # What type of analysis was run during this session
+    # @return [String]
+    attr_accessor :type
+
+    # Is this session requested, started, or completed
+    # @return [String]
+    attr_accessor :status
+
+    # Date and status of each status this session has entered
+    # @return [Array of Hash]
+    # @note - each status object in array is form { date: 'date', status: 'status' }
+    attr_accessor :status_history
+
+    # reserved for future extensions
+    # @return [Hash]
+    # @note - included 'balance' parameter for classification models
+    attr_accessor :extra_parameters
+
+    # The column in the dataset for which this session ran predictions
+    # @return [String]
+    attr_accessor :target_column
+
+    # The start date of analysis in this session
+    # @return [DateTime]
+    # @since 1.4.0
+    attr_accessor :start_date
+    
+    # The end date of analysis in this session
+    # @return [DateTime]
+    # @since 1.4.0
+    attr_accessor :end_date
+    
+    # associated hypermedia
+    # @return [Array of NexosisApi::Link]
+    attr_accessor :links
+
+    # The column descriptors for the data in this session
+    #    will reflect either the metadata sent in, defaults form dataset, or inferred values
+    # @return[Array of NexosisApi::Column]
+    attr_accessor :column_metadata
+
+    # The requested result interval. Default is DAY if none was requested during session creation.
+    # @return [NexosisApi::TimeInterval]
+    attr_accessor :result_interval
+
+    # The name of the datasource used to run this session
+    # @return [String] - the dataset or view name
+    # @since 1.2.0
+    attr_accessor :datasource_name
+
+    # The date this session was orginally submitted
+    # @since 1.3.0
+    attr_accessor :requested_date
+
+    # The id of the model created by this session if any
+    # @return [String] a uuid/buid format unique string for the model
+    # @since 1.3.0
+    # @note This is always empty in time-series sessions (forecast/impact)
+    # The model id returned here should be used in all future calls
+    # to model endpoints - primarily the /models/{model_id}/predict endpoint.
+    attr_accessor :model_id
+
+    # An array of the prediction intervals available for this session's results
+    # @return [Array]
+    # @note - by default the .5 interval will be returned in results. Consult
+    #    this list for other intervals which can be requested.
+    # @since 1.4.0
+    attr_accessor :prediction_intervals
+
+    # The type of model if a model creation session
+    # @return [String]
+    # @since 1.4.1
+    attr_accessor :prediction_domain
+
+    # A list of warning or error messages optionally returned from session
+    # @return [Array of Message]
+    attr_accessor :messages
+  end
+end

data/lib/nexosis_api/session_contest.rb

@@ -1,30 +1,30 @@
-module NexosisApi
-  # Class to parse the algorithm contestants from a session
-  # @since 2.0.0
-  class SessionContest < Session
-    def initialize(contest_hash)
-      contest_hash.each do |k, v|
-        if k.to_s == 'champion'
-          instance_variable_set("@#{k}", NexosisApi::AlgorithmContestant.new(v))
-        elsif k.to_s == 'contestants'
-          instance_variable_set("@#{k}", v.map { |c| NexosisApi::AlgorithmContestant.new(c) })
-        elsif k.to_s == 'championMetric'
-          @champion_metric = v
-        end
-      end
-      super(contest_hash.reject { |key, _v| key == 'champion' || key == 'contestants' })
-    end
-
-    # The champion algorithm used
-    # @return [NexosisApi::AlgorithmContestant]
-    attr_accessor :champion
-
-    # All other algorithms which competed
-    # @return [Array of NexosisApi::AlgorithmContestant]
-    attr_accessor :contestants
-
-    # Name of metric used to determine champion algorithm
-    # @return [String] metric name
-    attr_accessor :champion_metric
-  end
-end
+module NexosisApi
+  # Class to parse the algorithm contestants from a session
+  # @since 2.0.0
+  class SessionContest < Session
+    def initialize(contest_hash)
+      contest_hash.each do |k, v|
+        if k.to_s == 'champion'
+          instance_variable_set("@#{k}", NexosisApi::AlgorithmContestant.new(v))
+        elsif k.to_s == 'contestants'
+          instance_variable_set("@#{k}", v.map { |c| NexosisApi::AlgorithmContestant.new(c) })
+        elsif k.to_s == 'championMetric'
+          @champion_metric = v
+        end
+      end
+      super(contest_hash.reject { |key, _v| key == 'champion' || key == 'contestants' })
+    end
+
+    # The champion algorithm used
+    # @return [NexosisApi::AlgorithmContestant]
+    attr_accessor :champion
+
+    # All other algorithms which competed
+    # @return [Array of NexosisApi::AlgorithmContestant]
+    attr_accessor :contestants
+
+    # Name of metric used to determine champion algorithm
+    # @return [String] metric name
+    attr_accessor :champion_metric
+  end
+end

data/lib/nexosis_api/session_response.rb

@@ -1,33 +1,33 @@
-require 'nexosis_api/session'
-
-module NexosisApi
-  # Class to parse the results from a new session
-  class SessionResponse < Session
-    def initialize(forecast_hash)
-      val_map = {
-        'Nexosis-Account-DataSetCount-Allotted' => :@datasets_allotted,
-        'Nexosis-Account-DataSetCount-Current' => :@datasets_current,
-        'Nexosis-Account-PredictionCount-Allotted' => :@predictions_allotted,
-        'Nexosis-Account-PredictionCount-Current' => :@predictions_current,
-        'Nexosis-Account-SessionCount-Allotted' => :@sessions_allotted,
-        'Nexosis-Account-SessionCount-Current' => :@sessions_current
-      }
-      forecast_hash.each do |k, v|
-        if (k == 'session')
-          super(v) unless v.nil?
-        else
-          instance_variable_set(val_map[k], v) unless val_map[k].nil?
-        end
-      end
-    end
-
-    attr_reader :datasets_allotted
-    attr_reader :datasets_allotted
-    attr_reader :datasets_current
-    attr_reader :predictions_allotted
-    attr_reader :predictions_current
-    attr_reader :sessions_allotted
-    attr_reader :sessions_current
-    
-  end
-end
+require 'nexosis_api/session'
+
+module NexosisApi
+  # Class to parse the results from a new session
+  class SessionResponse < Session
+    def initialize(forecast_hash)
+      val_map = {
+        'Nexosis-Account-DataSetCount-Allotted' => :@datasets_allotted,
+        'Nexosis-Account-DataSetCount-Current' => :@datasets_current,
+        'Nexosis-Account-PredictionCount-Allotted' => :@predictions_allotted,
+        'Nexosis-Account-PredictionCount-Current' => :@predictions_current,
+        'Nexosis-Account-SessionCount-Allotted' => :@sessions_allotted,
+        'Nexosis-Account-SessionCount-Current' => :@sessions_current
+      }
+      forecast_hash.each do |k, v|
+        if (k == 'session')
+          super(v) unless v.nil?
+        else
+          instance_variable_set(val_map[k], v) unless val_map[k].nil?
+        end
+      end
+    end
+
+    attr_reader :datasets_allotted
+    attr_reader :datasets_allotted
+    attr_reader :datasets_current
+    attr_reader :predictions_allotted
+    attr_reader :predictions_current
+    attr_reader :sessions_allotted
+    attr_reader :sessions_current
+    
+  end
+end

data/lib/nexosis_api/session_result.rb

@@ -1,27 +1,27 @@
-module NexosisApi
-  # Class for parsing the results of a completed session
-  class SessionResult < Session
-    def initialize(session_hash)
-      session_hash.each do |k, v|
-        if k.to_s == 'metrics' && session_hash['type'] == 'impact'
-          instance_variable_set("@#{k}", NexosisApi::ImpactMetric.new(v)) unless v.nil?
-        elsif k.to_s == 'metrics'
-          @metrics = v.map { |key, value| NexosisApi::Metric.new(key.to_s, value) } unless v.nil?
-        elsif k.to_s == 'data'
-          @data = v
-        end
-      end
-      super(session_hash.reject { |k, _v| k.to_s == 'data' || k.to_s == 'metrics' })
-    end
-
-    # The impact analysis if this session type is impact
-    # @return [NexosisApi::ImpactMetric]
-    attr_accessor :metrics
-
-    # The result data in a hash with the name of the target column
-    # @return [Array of Hash]
-    # @note When retrieving a model creation session this field
-    # will contain the test data and results.
-    attr_accessor :data
-  end
-end
+module NexosisApi
+  # Class for parsing the results of a completed session
+  class SessionResult < Session
+    def initialize(session_hash)
+      session_hash.each do |k, v|
+        if k.to_s == 'metrics' && session_hash['type'] == 'impact'
+          instance_variable_set("@#{k}", NexosisApi::ImpactMetric.new(v)) unless v.nil?
+        elsif k.to_s == 'metrics'
+          @metrics = v.map { |key, value| NexosisApi::Metric.new(key.to_s, value) } unless v.nil?
+        elsif k.to_s == 'data'
+          @data = v
+        end
+      end
+      super(session_hash.reject { |k, _v| k.to_s == 'data' || k.to_s == 'metrics' })
+    end
+
+    # The impact analysis if this session type is impact
+    # @return [NexosisApi::ImpactMetric]
+    attr_accessor :metrics
+
+    # The result data in a hash with the name of the target column
+    # @return [Array of Hash]
+    # @note When retrieving a model creation session this field
+    # will contain the test data and results.
+    attr_accessor :data
+  end
+end

data/lib/nexosis_api/session_selection_metrics.rb

@@ -1,21 +1,21 @@
-module NexosisApi
-  # Class to parse the session selection metrics from a particular session
-  # @since 2.0.0
-  class SessionSelectionMetrics < Session
-    def initialize(metrics_hash)
-      if !metrics_hash['metricSets'].nil?
-        @dataset_properties = metrics_hash['metricSets'][0]['dataSetProperties'] unless metrics_hash['metricSets'][0]['dataSetProperties'].nil?
-        @metrics = metrics_hash['metricSets'][0]['metrics'] unless metrics_hash['metricSets'][0]['metrics'].nil?
-      end
-      super(metrics_hash.reject { |k, _v| k == 'metricSets' })
-    end
-
-    # transformations performed on dataset prior to algorithm run
-    # @return [Array] string list of transformations
-    attr_reader :dataset_properties
-
-    # dataset metrics describing some properties of it
-    # @return [Hash] name value pairs of dataset metrics
-    attr_reader :metrics
-  end
+module NexosisApi
+  # Class to parse the session selection metrics from a particular session
+  # @since 2.0.0
+  class SessionSelectionMetrics < Session
+    def initialize(metrics_hash)
+      if !metrics_hash['metricSets'].nil?
+        @dataset_properties = metrics_hash['metricSets'][0]['dataSetProperties'] unless metrics_hash['metricSets'][0]['dataSetProperties'].nil?
+        @metrics = metrics_hash['metricSets'][0]['metrics'] unless metrics_hash['metricSets'][0]['metrics'].nil?
+      end
+      super(metrics_hash.reject { |k, _v| k == 'metricSets' })
+    end
+
+    # transformations performed on dataset prior to algorithm run
+    # @return [Array] string list of transformations
+    attr_reader :dataset_properties
+
+    # dataset metrics describing some properties of it
+    # @return [Hash] name value pairs of dataset metrics
+    attr_reader :metrics
+  end
 end

data/lib/nexosis_api/time_interval.rb

@@ -1,15 +1,15 @@
-module NexosisApi
-  # constants for the date/time interval (e.g. Day, Hour) at which predictions should be generated. 
-  module TimeInterval
-    # results summarized by hour
-    HOUR = :hour
-    # results summarized by day. Default option.
-    DAY = :day
-    # results summarized by week
-    WEEK = :week
-    # results summarized by month
-    MONTH = :month
-    # results summarized by year
-    YEAR = :year
-  end
-end
+module NexosisApi
+  # constants for the date/time interval (e.g. Day, Hour) at which predictions should be generated. 
+  module TimeInterval
+    # results summarized by hour
+    HOUR = :hour
+    # results summarized by day. Default option.
+    DAY = :day
+    # results summarized by week
+    WEEK = :week
+    # results summarized by month
+    MONTH = :month
+    # results summarized by year
+    YEAR = :year
+  end
+end

data/lib/nexosis_api/view_data.rb

@@ -1,14 +1,14 @@
-module NexosisApi
-  # Class to hold the parsed results of a view data retrieval
-  # @since 1.2.0
-  class ViewData < ViewDefinition
-    def initialize(viewdata_hash)
-      @data = viewdata_hash['data']
-      super(viewdata_hash.reject { |k| k == 'data' })
-    end
-
-    # An array of hashes representing the processed data of the view
-    # @return [Array of Hash] - one hash per row of data where key = column name
-    attr_accessor :data
-  end
-end
+module NexosisApi
+  # Class to hold the parsed results of a view data retrieval
+  # @since 1.2.0
+  class ViewData < ViewDefinition
+    def initialize(viewdata_hash)
+      @data = viewdata_hash['data']
+      super(viewdata_hash.reject { |k| k == 'data' })
+    end
+
+    # An array of hashes representing the processed data of the view
+    # @return [Array of Hash] - one hash per row of data where key = column name
+    attr_accessor :data
+  end
+end

data/lib/nexosis_api/view_definition.rb

@@ -1,64 +1,64 @@
-module NexosisApi
-  # class to hold the parsed results of a view
-  # @since 1.2.0
-  class ViewDefinition
-    def initialize(view_hash)
-      view_hash.each do |k, v|
-        if k == 'viewName'
-          @view_name = v unless v.nil?
-        elsif k == 'dataSetName'
-          @dataset_name = v unless v.nil?
-        elsif k == 'columns'
-          next if v.nil?
-          @column_metadata = v.reject { |value| value.nil? } .map { |col_name, col_hash| NexosisApi::Column.new(col_name, col_hash)}
-        elsif k == 'joins'
-          next if v.nil?
-          @joins = v.reject(&:nil?).map { |join| NexosisApi::Join.new(join) }
-        elsif k == 'isTimeSeries'
-          @is_timeseries = v
-        end
-      end
-    end
-
-    # The name of the view uploaded and saved
-    # @return [String]
-    attr_accessor :view_name
-
-    # The name of the dataset on the left of the join
-    # @return [String]
-    attr_accessor :dataset_name
-
-    # Descriptive information about the columns
-    # @return [Array of NexosisApi::Column]
-    attr_accessor :column_metadata
-
-    # The join configuration for this view
-    # @return [Array of NexosisApi::Join]
-    attr_accessor :joins
-
-    # Is this view based on time series data?
-    # @since 1.3.0
-    attr_accessor :is_timeseries
-    
-    # Is this view based on time series data?
-    # @since 1.3.0
-    alias_method :timeseries?, :is_timeseries
-
-    # Provides a custom hash which matches json of api request
-    def to_json
-      hash = {}
-      hash['dataSetName'] = dataset_name
-      if column_metadata.nil? == false
-        hash['columns'] = {}
-        column_metadata.each do |column|
-          hash['columns'].merge!(column.to_hash)
-        end
-      end
-      hash['joins'] = []
-      joins.each do |join|
-        hash['joins'] << join.to_hash
-      end
-      hash.to_json
-    end
-  end
-end
+module NexosisApi
+  # class to hold the parsed results of a view
+  # @since 1.2.0
+  class ViewDefinition
+    def initialize(view_hash)
+      view_hash.each do |k, v|
+        if k == 'viewName'
+          @view_name = v unless v.nil?
+        elsif k == 'dataSetName'
+          @dataset_name = v unless v.nil?
+        elsif k == 'columns'
+          next if v.nil?
+          @column_metadata = v.reject { |value| value.nil? } .map { |col_name, col_hash| NexosisApi::Column.new(col_name, col_hash)}
+        elsif k == 'joins'
+          next if v.nil?
+          @joins = v.reject(&:nil?).map { |join| NexosisApi::Join.new(join) }
+        elsif k == 'isTimeSeries'
+          @is_timeseries = v
+        end
+      end
+    end
+
+    # The name of the view uploaded and saved
+    # @return [String]
+    attr_accessor :view_name
+
+    # The name of the dataset on the left of the join
+    # @return [String]
+    attr_accessor :dataset_name
+
+    # Descriptive information about the columns
+    # @return [Array of NexosisApi::Column]
+    attr_accessor :column_metadata
+
+    # The join configuration for this view
+    # @return [Array of NexosisApi::Join]
+    attr_accessor :joins
+
+    # Is this view based on time series data?
+    # @since 1.3.0
+    attr_accessor :is_timeseries
+    
+    # Is this view based on time series data?
+    # @since 1.3.0
+    alias_method :timeseries?, :is_timeseries
+
+    # Provides a custom hash which matches json of api request
+    def to_json
+      hash = {}
+      hash['dataSetName'] = dataset_name
+      if column_metadata.nil? == false
+        hash['columns'] = {}
+        column_metadata.each do |column|
+          hash['columns'].merge!(column.to_hash)
+        end
+      end
+      hash['joins'] = []
+      joins.each do |join|
+        hash['joins'] << join.to_hash
+      end
+      hash.to_json
+    end
+  end
+end