nexosis_api 2.0.0 → 2.0.1

data/lib/nexosis_api/column_role.rb

@@ -1,20 +1,20 @@
-module NexosisApi
-  # Constants for dataset column role
-  module ColumnRole
-    # No specific role, additional data which could be identified as target in a session
-    NONE = :none
-
-    # The timestamp column to use as the basis for a time-series session request
-    TIMESTAMP = :timestamp
-
-    # The target column for which to make predictions
-    TARGET = :target
-
-    # A feature to be included in analysis
-    FEATURE = :feature
-
-    # This column will be used to uniquely identify rows during
-    # update and delete operations, but will not be used as a feature.
-    KEY = :key
-  end
+module NexosisApi
+  # Constants for dataset column role
+  module ColumnRole
+    # No specific role, additional data which could be identified as target in a session
+    NONE = :none
+
+    # The timestamp column to use as the basis for a time-series session request
+    TIMESTAMP = :timestamp
+
+    # The target column for which to make predictions
+    TARGET = :target
+
+    # A feature to be included in analysis
+    FEATURE = :feature
+
+    # This column will be used to uniquely identify rows during
+    # update and delete operations, but will not be used as a feature.
+    KEY = :key
+  end
 end

data/lib/nexosis_api/column_type.rb

@@ -1,19 +1,23 @@
-module NexosisApi
-  # Constants for column data type
-  module ColumnType
-    # contains string data
-    STRING = :string
-
-    # contains numeric data
-    NUMERIC = :numeric
-
-    # contains boolean logical data (i.e. 1 and 0, true and false, etc.)
-    LOGICAL = :logical
-
-    # contains ISO-8601 compatible date 
-    DATE = :date
-
-    # Indicates a number which is not countable, or is not 'ordinal scaled' but 'ratio' or 'interval' scaled - i.e. a device measurement  
-    NUMERICMEASURE = :numericmeasure
-  end
-end
+module NexosisApi
+  # Constants for column data type
+  module ColumnType
+    # contains string data
+    STRING = :string
+
+    # contains numeric data
+    NUMERIC = :numeric
+
+    # contains boolean logical data (i.e. 1 and 0, true and false, etc.)
+    LOGICAL = :logical
+
+    # contains ISO-8601 compatible date 
+    DATE = :date
+
+    # Indicates a number which is not countable, or is not 'ordinal scaled' but 'ratio' or 'interval' scaled - i.e. a device measurement  
+    NUMERICMEASURE = :numericmeasure
+
+    # free-form text field.
+    # @note differs from string primarily in how the data will be prepared for analysis. Nominal values belong in string. Text to be analyzed as speech, writing, etc. belongs in text field.
+    TEXT = :text
+  end
+end

data/lib/nexosis_api/dataset_data.rb

@@ -1,22 +1,22 @@
-module NexosisApi
-  # class to hold the parsed results of a dataset
-  class DatasetData
-    def initialize(data_hash)
-      data_hash.each do |k, v|
-        if (k == 'data')
-          @data = v
-        elsif (k == 'links')
-          @links = v.reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
-        end
-      end
-    end
-
-    # Helpful links to more information about this dataset
-    # @return [Array of NexosisApi::Link]
-    attr_accessor :links
-
-    # The hash of data values from the dataset
-    # @return [Array of Hash] where each hash contains the dataset data
-    attr_accessor :data
-  end
-end
+module NexosisApi
+  # class to hold the parsed results of a dataset
+  class DatasetData
+    def initialize(data_hash)
+      data_hash.each do |k, v|
+        if (k == 'data')
+          @data = v
+        elsif (k == 'links')
+          @links = v.reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
+        end
+      end
+    end
+
+    # Helpful links to more information about this dataset
+    # @return [Array of NexosisApi::Link]
+    attr_accessor :links
+
+    # The hash of data values from the dataset
+    # @return [Array of Hash] where each hash contains the dataset data
+    attr_accessor :data
+  end
+end

data/lib/nexosis_api/dataset_jointarget.rb

@@ -1,19 +1,19 @@
-module NexosisApi
-  # Specifies the name of a dataset to use as the join datasource
-  # @see http://docs.nexosis.com/guides/views
-  # @since 1.2.3
-  class DatasetJoinTarget
-    def initialize(ds_join_hash)
-      @dataset_name = ds_join_hash['name'] unless ds_join_hash.nil?
-    end
-    
-    # The name of the dataset that will be participating in the join
-    # @return [String] name of the dataset provided for this join
-    attr_accessor :dataset_name
-    
-    # provides a custom hash to match api requests
-    def to_hash
-      { 'dataSet' => { 'name' => dataset_name } }
-    end
-  end
+module NexosisApi
+  # Specifies the name of a dataset to use as the join datasource
+  # @see http://docs.nexosis.com/guides/views
+  # @since 1.2.3
+  class DatasetJoinTarget
+    def initialize(ds_join_hash)
+      @dataset_name = ds_join_hash['name'] unless ds_join_hash.nil?
+    end
+    
+    # The name of the dataset that will be participating in the join
+    # @return [String] name of the dataset provided for this join
+    attr_accessor :dataset_name
+    
+    # provides a custom hash to match api requests
+    def to_hash
+      { 'dataSet' => { 'name' => dataset_name } }
+    end
+  end
 end

data/lib/nexosis_api/dataset_model.rb

@@ -1,26 +1,26 @@
-module NexosisApi
-  # Class to parse the model results calculated for a dataset
-  class DatasetModel
-    def initialize(data_hash)
-      data_hash.each do |k, v|
-        if k == 'championContest'
-          instance_variable_set("@#{k}", NexosisApi::AlgorithmSelection.new(v))
-        else
-          instance_variable_set("@#{k}", v) unless v.nil?
-        end
-      end
-    end
-
-    # The name of the dataset used in the evaluation
-    # @return [String]
-    attr_accessor :datasetName
-
-    # The column targeted for prediction
-    # @return [String] 
-    attr_accessor :targetColumn
-
-    # The details of the winning algorithm
-    # @return [NexosisApi::AlgorithmSelection]
-    attr_accessor :championContest
-  end
-end
+module NexosisApi
+  # Class to parse the model results calculated for a dataset
+  class DatasetModel
+    def initialize(data_hash)
+      data_hash.each do |k, v|
+        if k == 'championContest'
+          instance_variable_set("@#{k}", NexosisApi::AlgorithmSelection.new(v))
+        else
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+
+    # The name of the dataset used in the evaluation
+    # @return [String]
+    attr_accessor :datasetName
+
+    # The column targeted for prediction
+    # @return [String] 
+    attr_accessor :targetColumn
+
+    # The details of the winning algorithm
+    # @return [NexosisApi::AlgorithmSelection]
+    attr_accessor :championContest
+  end
+end

data/lib/nexosis_api/dataset_summary.rb

@@ -1,33 +1,33 @@
-module NexosisApi
-  # class to hold the parsed results of a dataset
-  class DatasetSummary
-    def initialize(data_hash)
-      data_hash.each do |k, v|
-        if (k == 'dataSetName')
-          @dataset_name = v unless v.nil?
-        elsif (k == 'columns')
-          @column_metadata = v.reject { |_key, value| value.nil? }
-                              .map do |col_key, col_val|
-                                NexosisApi::Column.new(col_key, col_val)
-                              end
-        end
-      end
-    end
-
-    # The name of the dataset uploaded and saved
-    # @return [String]
-    attr_accessor :dataset_name
-
-    # Descriptive information about the columns
-    # @return [Array of NexosisApi::Column]
-    attr_accessor :column_metadata
-
-    # Helper method which tells you whether or not this dataset has a column with timestamp role.
-    # @note Often helpful for implmenters as non-timeseries datasets
-    # cannot be sent to forecast or impact sessions
-    # @since 1.3.0
-    def timeseries?
-      !@column_metadata.select { |dc| dc.role == NexosisApi::ColumnRole::TIMESTAMP }.empty?
-    end
-  end
-end
+module NexosisApi
+  # class to hold the parsed results of a dataset
+  class DatasetSummary
+    def initialize(data_hash)
+      data_hash.each do |k, v|
+        if (k == 'dataSetName')
+          @dataset_name = v unless v.nil?
+        elsif (k == 'columns')
+          @column_metadata = v.reject { |_key, value| value.nil? }
+                              .map do |col_key, col_val|
+                                NexosisApi::Column.new(col_key, col_val)
+                              end
+        end
+      end
+    end
+
+    # The name of the dataset uploaded and saved
+    # @return [String]
+    attr_accessor :dataset_name
+
+    # Descriptive information about the columns
+    # @return [Array of NexosisApi::Column]
+    attr_accessor :column_metadata
+
+    # Helper method which tells you whether or not this dataset has a column with timestamp role.
+    # @note Often helpful for implmenters as non-timeseries datasets
+    # cannot be sent to forecast or impact sessions
+    # @since 1.3.0
+    def timeseries?
+      !@column_metadata.select { |dc| dc.role == NexosisApi::ColumnRole::TIMESTAMP }.empty?
+    end
+  end
+end

data/lib/nexosis_api/http_exception.rb

@@ -1,29 +1,29 @@
-module NexosisApi
-  # encapsulate errors from the Nexosis API
-  class HttpException < StandardError
-    attr_reader :message,:action,:response,:request
-    def initialize(message = "", action = nil, http_obj)
-      base_message = message
-      full_message = nil
-      if(http_obj.is_a?(Hash))
-        base_message.prepend(http_obj['message'].concat(': ')) unless http_obj['message'].nil?
-        @action = action
-      elsif(http_obj.instance_of?(HTTParty::Response))
-        full_message = http_obj.parsed_response['message']
-        full_message = full_message.concat(' || Details: ').concat(http_obj.parsed_response['errorDetails'].to_s) unless http_obj.parsed_response['errorDetails'].nil?
-        @type = http_obj.parsed_response['errorType']
-        @response = http_obj.response
-        @request = http_obj.request
-        @code = http_obj.code
-      end
-      full_message ||= base_message
-      @message = full_message
-    end
-
-    attr_reader :code
-    attr_reader :response
-    attr_reader :request
-    attr_reader :message
-    attr_reader :type
-  end
+module NexosisApi
+  # encapsulate errors from the Nexosis API
+  class HttpException < StandardError
+    attr_reader :message,:action,:response,:request
+    def initialize(message = "", action = nil, http_obj)
+      base_message = message
+      full_message = nil
+      if(http_obj.is_a?(Hash))
+        base_message.prepend(http_obj['message'].concat(': ')) unless http_obj['message'].nil?
+        @action = action
+      elsif(http_obj.instance_of?(HTTParty::Response))
+        full_message = http_obj.parsed_response['message']
+        full_message = full_message.concat(' || Details: ').concat(http_obj.parsed_response['errorDetails'].to_s) unless http_obj.parsed_response['errorDetails'].nil?
+        @type = http_obj.parsed_response['errorType']
+        @response = http_obj.response
+        @request = http_obj.request
+        @code = http_obj.code
+      end
+      full_message ||= base_message
+      @message = full_message
+    end
+
+    attr_reader :code
+    attr_reader :response
+    attr_reader :request
+    attr_reader :message
+    attr_reader :type
+  end
 end

data/lib/nexosis_api/impact_metric.rb

@@ -1,22 +1,22 @@
-module NexosisApi
-  # Class to parse the metric results of an impact analysis
-  class ImpactMetric
-    def initialize(metric_hash)
-      metric_hash.each do |k, v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-
-    # Statistical value used to determine the significance of the impact.
-    # @return [Float]
-    attr_accessor :pValue
-
-    # Total absolute effect of the event on the dataset.
-    # @return [Float]
-    attr_accessor :absoluteEffect
-
-    # Percentage impact of the event on the dataset.
-    # @return [Float]
-    attr_accessor :relativeEffect
-  end
-end
+module NexosisApi
+  # Class to parse the metric results of an impact analysis
+  class ImpactMetric
+    def initialize(metric_hash)
+      metric_hash.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # Statistical value used to determine the significance of the impact.
+    # @return [Float]
+    attr_accessor :pValue
+
+    # Total absolute effect of the event on the dataset.
+    # @return [Float]
+    attr_accessor :absoluteEffect
+
+    # Percentage impact of the event on the dataset.
+    # @return [Float]
+    attr_accessor :relativeEffect
+  end
+end

data/lib/nexosis_api/imports_response.rb

@@ -1,79 +1,74 @@
-module NexosisApi
-  # class to parse results from an imports call
-  class ImportsResponse
-    def initialize(response_hash)
-      response_hash.each do |k, v|
-        if(k == 'importId')
-          @import_id = v
-        elsif(k == 'requestedDate')
-          @requested_date = v
-        elsif(k == 'columns')
-          columns = []
-          next if v.nil?
-          v.keys.each do |col_key|
-            columns << NexosisApi::Column.new(col_key, v[col_key])
-          end
-          @column_metadata = columns
-        elsif(k == 'links')
-          links = []
-          v.each { |l| links << NexosisApi::Link.new(l) }
-          instance_variable_set("@#{k}", links) unless v.nil?
-        elsif k == 'dataSetName'
-          @datasource_name = v
-        else
-          instance_variable_set("@#{k}", v) unless v.nil?
-        end
-      end
-    end
-
-    # The unique identifier for this import request
-    # @return [String]
-    attr_accessor :import_id
-
-    # Where the import was requested from - S3, Azure, or Url
-    # @return [String]
-    attr_accessor :type, :s3 
-    
-    # The current status of the import request
-    # @return [String]
-    # @note The import will be performed in a FIFO queue. Check back on status before attempting to start a session using the dataset.
-    attr_accessor :status
-
-    # Date and status of each status this session has entered
-    # @return [Hash]
-    # @since 1.3.0
-    attr_accessor :statusHistory
-
-    # echo back the dataset name provided
-    # @return [String]
-    # @deprecated use datasource_name instead
-    attr_accessor :dataSetName
-
-    # echo back the name of the data source uploaded
-    # @return [String]
-    # @since 1.3.0
-    attr_accessor :datasource_name
-
-    # The S3 parameters used to import a dataset
-    # @return [Hash]
-    # For an S3 response the keys of this hash should be 'bucket', 'path', and 'region'
-    attr_accessor :parameters
-
-    # The date of the import request
-    # @return [DateTime]
-    attr_accessor :requested_date
-
-    # Additional details. Normally empty.
-    # @return [Array]
-    attr_accessor :messages
-
-    # 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
-
-    # associated hypermedia
-    # @return [Array of NexosisApi::Link]
-    attr_accessor :links
-  end
-end
+module NexosisApi
+  # class to parse results from an imports call
+  class ImportsResponse
+    def initialize(response_hash)
+      response_hash.each do |k, v|
+        if(k == 'importId')
+          @import_id = v
+        elsif(k == 'requestedDate')
+          @requested_date = v
+        elsif(k == 'columns')
+          columns = []
+          next if v.nil?
+          v.keys.each do |col_key|
+            columns << NexosisApi::Column.new(col_key, v[col_key])
+          end
+          @column_metadata = columns
+        elsif(k == 'links')
+          links = []
+          v.each { |l| links << NexosisApi::Link.new(l) }
+          instance_variable_set("@#{k}", links) unless v.nil?
+        elsif k == 'dataSetName'
+          @datasource_name = v
+        else
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+
+    # The unique identifier for this import request
+    # @return [String]
+    attr_accessor :import_id
+
+    # Where the import was requested from - S3, Azure, or Url
+    # @return [String]
+    attr_accessor :type, :s3 
+    
+    # The current status of the import request
+    # @return [String]
+    # @note The import will be performed in a FIFO queue. Check back on status before attempting to start a session using the dataset.
+    attr_accessor :status
+
+    # Date and status of each status this session has entered
+    # @return [Hash]
+    # @since 1.3.0
+    attr_accessor :statusHistory
+
+    # echo back the name of the data source uploaded
+    # @return [String]
+    # @since 1.3.0
+    attr_accessor :datasource_name
+
+    # The S3 parameters used to import a dataset
+    # @return [Hash]
+    # For an S3 response the keys of this hash should be 'bucket', 'path', and 'region'
+    attr_accessor :parameters
+
+    # The date of the import request
+    # @return [DateTime]
+    attr_accessor :requested_date
+
+    # Additional details. Normally empty.
+    # @return [Array]
+    attr_accessor :messages
+
+    # 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
+
+    # associated hypermedia
+    # @return [Array of NexosisApi::Link]
+    attr_accessor :links
+  end
+end