nexosis_api 2.0.0 → 2.0.1

data/lib/nexosis_api/join.rb

@@ -1,63 +1,63 @@
-# frozen_string_literal: true
-
-module NexosisApi
-  # class to hold a join defintion initialized by a hash of join values
-  # @since 1.2.0
-  class Join
-    def initialize(join_hash)
-      join_hash.each do |k, v|
-        if k == 'dataSet'
-          @join_target = NexosisApi::DatasetJoinTarget.new(v) unless v.nil?
-        elsif k == 'calendar'
-          @join_target = NexosisApi::CalendarJoinTarget.new(v) unless v.nil?
-        elsif k == 'columnOptions'
-          next if v.nil?
-          @column_options = v.map do |key, option|
-            NexosisApi::ColumnOptions.new(key, option)
-          end
-        elsif k == 'joins'
-          next if v.nil?
-          @joins = v.map do |join|
-            NexosisApi::Join.new(join)
-          end
-        end
-      end
-    end
-
-    # The details of the data source that will be participating in the join
-    # @return [Object] details of the join target
-    attr_accessor :join_target
-
-    # 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
-
-    # provides a custom hash which can be converted to json matching api request
-    def to_hash
-      hash = join_target.to_hash
-      if column_options.nil? == false
-        hash['columnOptions'] = {}
-        column_options.each do |column|
-          hash['columnOptions'].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
-
-    # gets a json represenation which can be used in api request
-    def to_json
-      to_hash.to_json
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NexosisApi
+  # class to hold a join defintion initialized by a hash of join values
+  # @since 1.2.0
+  class Join
+    def initialize(join_hash)
+      join_hash.each do |k, v|
+        if k == 'dataSet'
+          @join_target = NexosisApi::DatasetJoinTarget.new(v) unless v.nil?
+        elsif k == 'calendar'
+          @join_target = NexosisApi::CalendarJoinTarget.new(v) unless v.nil?
+        elsif k == 'columnOptions'
+          next if v.nil?
+          @column_options = v.map do |key, option|
+            NexosisApi::ColumnOptions.new(key, option)
+          end
+        elsif k == 'joins'
+          next if v.nil?
+          @joins = v.map do |join|
+            NexosisApi::Join.new(join)
+          end
+        end
+      end
+    end
+
+    # The details of the data source that will be participating in the join
+    # @return [Object] details of the join target
+    attr_accessor :join_target
+
+    # 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
+
+    # provides a custom hash which can be converted to json matching api request
+    def to_hash
+      hash = join_target.to_hash
+      if column_options.nil? == false
+        hash['columnOptions'] = {}
+        column_options.each do |column|
+          hash['columnOptions'].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
+
+    # gets a json represenation which can be used in api request
+    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(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
+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/message.rb

@@ -1,19 +1,19 @@
-module NexosisApi
-  # class to provide message responses
-  # @since 1.4.1
-  class Message
-    def initialize(message_hash)
-      message_hash.each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-
-    # The type of message: information, warning, or error
-    # @return [String]
-    attr_accessor :severity
-
-    # The content of the message
-    # @return [String]
-    attr_accessor :message
-  end
-end
+module NexosisApi
+  # class to provide message responses
+  # @since 1.4.1
+  class Message
+    def initialize(message_hash)
+      message_hash.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # The type of message: information, warning, or error
+    # @return [String]
+    attr_accessor :severity
+
+    # The content of the message
+    # @return [String]
+    attr_accessor :message
+  end
+end

data/lib/nexosis_api/metric.rb

@@ -1,17 +1,17 @@
-module NexosisApi
-  # Class to parse algorithm metrics from model results
-  class Metric
-    def initialize(name, value)
-      @name = name
-      @value = value
-    end
-
-    # Friendly name of the metric
-    # @return [String]
-    attr_accessor :name
-
-    # Calculated metric
-    # @return [Float]
-    attr_accessor :value
-  end
+module NexosisApi
+  # Class to parse algorithm metrics from model results
+  class Metric
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    # Friendly name of the metric
+    # @return [String]
+    attr_accessor :name
+
+    # Calculated metric
+    # @return [Float]
+    attr_accessor :value
+  end
 end

data/lib/nexosis_api/model_summary.rb

@@ -1,66 +1,66 @@
-module NexosisApi
-  # class to hold the parsed results of model summary json
-  # @since 1.3.0
-  class ModelSummary
-    def initialize(model_hash)
-      model_hash.each do |k, v|
-        k = k.to_s
-        if (k == 'modelId')
-          @model_id = v
-        elsif (k == 'predictionDomain')
-          @prediction_domain = v
-        elsif (k == 'dataSourceName')
-          @datasource_name = v
-        elsif (k == 'createdDate')
-          @created_date = DateTime.parse(v) unless v.nil?
-        elsif (k == 'algorithm')
-          @algorithm = NexosisApi::Algorithm.new(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
-        elsif (k == 'metrics')
-          @metrics = v.reject { |_key, value| value.nil? }
-                      .map do |col_key, col_val|
-                        NexosisApi::Metric.new(col_key, col_val)
-                      end
-        elsif (k == 'sessionId')
-          @session_id = v
-        end
-      end
-    end
-
-    # Unique model id for this model in uuid/guid format.
-    # @return [String]
-    attr_accessor :model_id
-
-    # Unique id of the session used to create this model instance
-    # @return [String]
-    attr_accessor :session_id
-
-    # The type of prediction performed
-    # @return [String]
-    attr_reader :prediction_domain
-
-    # The data source used to create this model
-    # @return [String]
-    attr_accessor :datasource_name
-
-    # The date on which this model was created.
-    # @return [DateTime]
-    attr_accessor :created_date
-
-    # Information about the algorithm used to create the model
-    # @return [NexosisApi::Algorithm]
-    attr_accessor :algorithm
-
-    # Descriptive information about the columns
-    # @return [Array of NexosisApi::Column]
-    attr_accessor :column_metadata
-
-    # Algorithm and model specific metrics which may be of interest
-    # @return [Array of NexosisApi::Metric]
-    attr_accessor :metrics
-  end
-end
+module NexosisApi
+  # class to hold the parsed results of model summary json
+  # @since 1.3.0
+  class ModelSummary
+    def initialize(model_hash)
+      model_hash.each do |k, v|
+        k = k.to_s
+        if (k == 'modelId')
+          @model_id = v
+        elsif (k == 'predictionDomain')
+          @prediction_domain = v
+        elsif (k == 'dataSourceName')
+          @datasource_name = v
+        elsif (k == 'createdDate')
+          @created_date = DateTime.parse(v) unless v.nil?
+        elsif (k == 'algorithm')
+          @algorithm = NexosisApi::Algorithm.new(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
+        elsif (k == 'metrics')
+          @metrics = v.reject { |_key, value| value.nil? }
+                      .map do |col_key, col_val|
+                        NexosisApi::Metric.new(col_key, col_val)
+                      end
+        elsif (k == 'sessionId')
+          @session_id = v
+        end
+      end
+    end
+
+    # Unique model id for this model in uuid/guid format.
+    # @return [String]
+    attr_accessor :model_id
+
+    # Unique id of the session used to create this model instance
+    # @return [String]
+    attr_accessor :session_id
+
+    # The type of prediction performed
+    # @return [String]
+    attr_reader :prediction_domain
+
+    # The data source used to create this model
+    # @return [String]
+    attr_accessor :datasource_name
+
+    # The date on which this model was created.
+    # @return [DateTime]
+    attr_accessor :created_date
+
+    # Information about the algorithm used to create the model
+    # @return [NexosisApi::Algorithm]
+    attr_accessor :algorithm
+
+    # Descriptive information about the columns
+    # @return [Array of NexosisApi::Column]
+    attr_accessor :column_metadata
+
+    # Algorithm and model specific metrics which may be of interest
+    # @return [Array of NexosisApi::Metric]
+    attr_accessor :metrics
+  end
+end

data/lib/nexosis_api/paged_array.rb

@@ -1,35 +1,35 @@
-module NexosisApi
-  # Generic list base class for list responses
-  # @since 1.4.0
-  class PagedArray < Array
-    def initialize(paged_response, item_array = [])
-      self[0..item_array.length] = item_array
-      var_map = { 'pageNumber' => :@page_number,
-                  'totalPages' => :@total_pages,
-                  'pageSize' => :@page_size,
-                  'totalCount' => :@item_total }
-      paged_response.each { |k, v| instance_variable_set(var_map[k.to_s], v) unless var_map[k.to_s].nil? }
-      @links = paged_response['links'].map { |l| NexosisApi::Link.new(l) } unless paged_response['links'].nil?
-    end
-
-    # The current page number represented by this collection
-    # @return [int]
-    attr_accessor :page_number
-
-    # The total number of pages given the current page size and item total
-    # @return [int]
-    attr_accessor :total_pages
-
-    # The total number of items per page
-    # @return [int]
-    attr_accessor :page_size
-
-    # The total number of items available on the server for this collection
-    # @return [int]
-    attr_accessor :item_total
-
-    # paging links to first, last pages
-    # @return [Array of NexosisApi::Link]
-    attr_accessor :links
-  end
-end
+module NexosisApi
+  # Generic list base class for list responses
+  # @since 1.4.0
+  class PagedArray < Array
+    def initialize(paged_response, item_array = [])
+      self[0..item_array.length] = item_array
+      var_map = { 'pageNumber' => :@page_number,
+                  'totalPages' => :@total_pages,
+                  'pageSize' => :@page_size,
+                  'totalCount' => :@item_total }
+      paged_response.each { |k, v| instance_variable_set(var_map[k.to_s], v) unless var_map[k.to_s].nil? }
+      @links = paged_response['links'].map { |l| NexosisApi::Link.new(l) } unless paged_response['links'].nil?
+    end
+
+    # The current page number represented by this collection
+    # @return [int]
+    attr_accessor :page_number
+
+    # The total number of pages given the current page size and item total
+    # @return [int]
+    attr_accessor :total_pages
+
+    # The total number of items per page
+    # @return [int]
+    attr_accessor :page_size
+
+    # The total number of items available on the server for this collection
+    # @return [int]
+    attr_accessor :item_total
+
+    # paging links to first, last pages
+    # @return [Array of NexosisApi::Link]
+    attr_accessor :links
+  end
+end

data/lib/nexosis_api/predict_response.rb

@@ -1,35 +1,35 @@
-module NexosisApi
-  # Class to hold the parsed response of a prediction request
-  # @since 1.3.0
-  class PredictResponse
-    def initialize(model_id, response_hash)
-      @model_id = model_id
-      @predictions = response_hash['data']
-      @message = response_hash['messages']
-    end
-
-    # The unique identifier for the model used to create these predictions
-    # @return [String]
-    attr_reader :model_id
-
-    # The feature data along with predicted target value
-    # @return [Array of Hash] each row of data as a hash in an array of values
-    # @note The result data includes an echo of the data sent to the predict request
-    # along with the target column containing the values predicted.
-    # [
-    #   {
-    #     "feature1": 23.33,
-    #     "target": 2.59
-    #   },
-    #   {
-    #     "feature1": 15.82,
-    #     "target": 1.75
-    #   }
-    # ]
-    attr_accessor :predictions
-
-    # A list of warning message optionally returned from prediction run
-    # @return [Array]
-    attr_accessor :messages
-  end
-end
+module NexosisApi
+  # Class to hold the parsed response of a prediction request
+  # @since 1.3.0
+  class PredictResponse
+    def initialize(model_id, response_hash)
+      @model_id = model_id
+      @predictions = response_hash['data']
+      @message = response_hash['messages']
+    end
+
+    # The unique identifier for the model used to create these predictions
+    # @return [String]
+    attr_reader :model_id
+
+    # The feature data along with predicted target value
+    # @return [Array of Hash] each row of data as a hash in an array of values
+    # @note The result data includes an echo of the data sent to the predict request
+    # along with the target column containing the values predicted.
+    # [
+    #   {
+    #     "feature1": 23.33,
+    #     "target": 2.59
+    #   },
+    #   {
+    #     "feature1": 15.82,
+    #     "target": 1.75
+    #   }
+    # ]
+    attr_accessor :predictions
+
+    # A list of warning message optionally returned from prediction run
+    # @return [Array]
+    attr_accessor :messages
+  end
+end