nexosis_api 1.1.2 → 1.2.0

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(metricHash)
-           metricHash.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,66 +1,66 @@
-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::DatasetColumn.new(col_key, v[col_key])
-                    end
-                    @column_metadata = columns
-                elsif(k == "links")
-					links = Array.new
-					v.each do |l| links << NexosisApi::Link.new(l) end
-					instance_variable_set("@#{k}", links) unless v.nil?
-                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
-
-        # Currently always s3
-        # @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
-
-        # echo back the dataset name provided
-        # @return [String]
-        attr_accessor :dataSetName
-
-        # 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::DatasetColumn]
-        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?
+        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
+
+    # Currently always s3
+    # @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
+
+    # echo back the dataset name provided
+    # @return [String]
+    attr_accessor :dataSetName
+
+    # 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

data/lib/nexosis_api/join.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module NexosisApi
+  # class to hold a join defintion initialized by a hash of join values
+  class Join
+    def initialize(join_hash)
+      join_hash.each do |k, v|
+        if k == 'dataSet'
+          @dataset_name = v['name'] unless v.nil?
+        elsif k == 'columnOptions'
+          @column_options = v unless v.nil?
+        elsif k == 'joins'
+          joins = []
+          next if v.nil?
+          v.each do |join|
+            joins << NexosisApi::Join.new(join)
+            @joins = joins
+          end
+        end
+      end
+    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
+
+    # The optional column definition for the join which
+    # defines how columns should be used from the joined dataset
+    # @return [Array of NexosisApi::ColumnOptions] column options definition
+    attr_accessor :column_options
+
+    # Optional additional data source to be joined to this data source
+    # @return [Array of NexosisApi::Join] zero or more additional joins
+    attr_accessor :joins
+
+    def to_hash
+      hash = {}
+      hash['dataSet'] = { name: dataset_name }
+      if column_options.nil? == false
+        hash['columns'] = {}
+        column_options.each do |column|
+          hash['columns'].merge!(column.to_hash)
+        end
+      end
+      if joins.nil? == false
+        hash['joins'] = []
+        joins.each do |join|
+          hash['joins'] << join.to_hash
+        end
+      end
+      hash
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/nexosis_api/link.rb

@@ -1,18 +1,18 @@
-module NexosisApi
-    # Class to parse hypermedia resutls
-    class Link
-        def initialize(linkHash)
-           linkHash.each do |k,v|
-               instance_variable_set("@#{k}", v) unless v.nil?
-           end
-        end
-
-        # relation type of the link
-        # @return [String]
-        attr_accessor :rel
-
-        # resource url
-        # @return [String]
-        attr_accessor :href
-    end
-end
+module NexosisApi
+  # Class to parse hypermedia resutls
+  class Link
+    def initialize(link_hash)
+      link_hash.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # relation type of the link
+    # @return [String]
+    attr_accessor :rel
+
+    # resource url
+    # @return [String]
+    attr_accessor :href
+  end
+end

data/lib/nexosis_api/metric.rb

@@ -1,22 +1,22 @@
-module NexosisApi
-    # Class to parse algorithm metrics from model results
-    class Metric
-        def initialize(metricHash)
-           metricHash.each do |k,v|
-               instance_variable_set("@#{k}", v) unless v.nil?
-           end
-        end
-
-        # Friendly name of the metric
-        # @return [String]
-        attr_accessor :name
-
-        # Identifier for metric type
-        # @return [String]
-        attr_accessor :code
-
-        # Calculated metric
-        # @return [Float]
-        attr_accessor :value
-    end
+module NexosisApi
+  # Class to parse algorithm metrics from model results
+  class Metric
+    def initialize(metric_hash)
+      metric_hash.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # Friendly name of the metric
+    # @return [String]
+    attr_accessor :name
+
+    # Identifier for metric type
+    # @return [String]
+    attr_accessor :code
+
+    # Calculated metric
+    # @return [Float]
+    attr_accessor :value
+  end
 end

data/lib/nexosis_api/session.rb

@@ -1,80 +1,88 @@
-module NexosisApi
-    # Class for parsing the results of a session based request
-    class Session
-		def initialize(sessionHash)
-			sessionHash.each do |k,v|
-				if(k == "links")
-					links = Array.new
-					v.each do |l| links << NexosisApi::Link.new(l) end
-					instance_variable_set("@#{k}", links) unless v.nil?
-				elsif(k == "isEstimate")
-                    instance_variable_set("@is_estimate", v) unless v.nil?
-				elsif(k == "columns")
-                    columns = []
-                    next if v.nil?
-                    v.keys.each do |col_key|
-                        columns << NexosisApi::DatasetColumn.new(col_key, v[col_key])
-                    end
-                    @column_metadata = columns
-				elsif(k == "resultInterval")
-					@result_interval = v
-				else
-					instance_variable_set("@#{k}", v) unless v.nil?
-				end
-			end
-        end
-
-        # identifier for this sesssion
-        # @return [String]
-        attr_accessor :sessionId
-
-        # What type of analysis was run during this session
-        # @return [String]
-        attr_accessor :type
-
-        # Is this session requested, estimated, started, or completed
-        # @return [String]
-        attr_accessor :status
-
-        # Date and status of each status this session has entered
-        # @return [Hash]
-        attr_accessor :statusHistory
-
-        # reserved for future extensions
-        # @return [Hash]
-        attr_accessor :extraParameters
-        
-        # the dataset used in this session
-        # @return [String]
-        attr_accessor :dataSetName
-
-        # The column in the dataset for which this session ran predictions
-        # @return [String]
-        attr_accessor :targetColumn
-
-        # The start date of analysis in this session
-        # @return [DateTime]
-        attr_accessor :startDate
-
-        # The end date of analysis in this session
-        # @return [DateTime]
-        attr_accessor :endDate
-
-        # associated hypermedia
-        # @return [Array of NexosisApi::Link]
-        attr_accessor :links
-
-        # Is this session an estimate only session
-        # @return [Boolean]
-        attr_accessor :is_estimate
-
-        # 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::DatasetColumn]
-        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
-    end
-end
+module NexosisApi
+  # Class for parsing the results of a session based request
+  class Session
+    def initialize(sessionHash)
+      sessionHash.each do |k,v|
+        if(k == 'links')
+          links = Array.new
+          v.each do |l| links << NexosisApi::Link.new(l) end
+          instance_variable_set("@#{k}", links) unless v.nil?
+        elsif(k == 'isEstimate')
+          instance_variable_set('@is_estimate', v) unless v.nil?
+        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 == 'resultInterval')
+          @result_interval = v
+        elsif (k == 'dataSourceName')
+          @datasource_name = v
+        else
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+
+    # identifier for this sesssion
+    # @return [String]
+    attr_accessor :sessionId
+
+    # What type of analysis was run during this session
+    # @return [String]
+    attr_accessor :type
+
+    # Is this session requested, estimated, started, or completed
+    # @return [String]
+    attr_accessor :status
+
+    # Date and status of each status this session has entered
+    # @return [Hash]
+    attr_accessor :statusHistory
+
+    # reserved for future extensions
+    # @return [Hash]
+    attr_accessor :extraParameters
+    
+    # the dataset used in this session
+    # @return [String]
+    # @deprecated - Use the @data_source_name property instead
+    attr_accessor :dataSetName
+
+    # The column in the dataset for which this session ran predictions
+    # @return [String]
+    attr_accessor :targetColumn
+
+    # The start date of analysis in this session
+    # @return [DateTime]
+    attr_accessor :startDate
+
+    # The end date of analysis in this session
+    # @return [DateTime]
+    attr_accessor :endDate
+
+    # associated hypermedia
+    # @return [Array of NexosisApi::Link]
+    attr_accessor :links
+
+    # Is this session an estimate only session
+    # @return [Boolean]
+    attr_accessor :is_estimate
+
+    # 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 v1.2
+    attr_accessor :datasource_name
+  end
+end