nexosis_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea8420a0cc83927171b7767fb1d94bd3a5079afa
-  data.tar.gz: 440f6ff9e8af3ca49723fbb44b8284f632df58b8
+  metadata.gz: 8033e80ad77a8aaef047705b4226f4cf35004d53
+  data.tar.gz: b6d345887506671863f2f663add52ef4d5204363
 SHA512:
-  metadata.gz: fbe33013ff7623c70db259af4f46f070a913987197a8f5740cba1e5ab541cdec4d3f33a43397d3ffe7ee2816e7f2920deec4b4f856475a2ec5db35148f5e739e
-  data.tar.gz: cb0c8cf3defc7381ce444ebe0f46a64518c3a2a1377e396361b500afb45805e5887d1cdc9e52440843bfa40857870b2745b3c7ae7840393479c7772e4d726300
+  metadata.gz: ea20e9e26d1454e9a32ff6a00bb6fd0a735c98e53571cebaa4db1a8fe285b205cebdc710f887e07ecb8303effbf5bc0f3084892eda224799eedd1c671742bcc3
+  data.tar.gz: e84c69d46be15bef19aeed3728b9b559c45877739cd152136124a1754b91eb22e66202b70c44aa6dce93cf63fa25cdcdb2f759da5cb25f91cdbc9a975be869be

data/lib/nexosis_api/algorithm_run.rb

@@ -18,15 +18,15 @@ module NexosisApi
         end
 
         # Identifier of algorithm run
-        #    @return [NexosisApi::Algorithm] 
+        # @return [NexosisApi::Algorithm] 
         attr_accessor :algorithm        
         
         # Set of {NexosisApi::Metric} on algorithm
-        #    @return [Array]
+        # @return [Array]
         attr_accessor :metrics
         
         # Relevant hypermedia as {NexosisApi::Link}
-        #    @return [Array]
+        # @return [Array]
         attr_accessor :links
     end
 end

data/lib/nexosis_api/client.rb

@@ -1,6 +1,9 @@
 require 'nexosis_api/algorithm_run'
 require 'nexosis_api/algorithm_selection'
 require 'nexosis_api/algorithm'
+require 'nexosis_api/column_role'
+require 'nexosis_api/column_type'
+require 'nexosis_api/dataset_column'
 require 'nexosis_api/dataset_data'
 require 'nexosis_api/dataset_model'
 require 'nexosis_api/dataset_summary'

data/lib/nexosis_api/client/datasets.rb

@@ -84,14 +84,14 @@ module NexosisApi
             
             # Remove data from a data set or the entire set.
             #
-            # @param dataset [String] the name of the dataset from which to remove data
+            # @param dataset_name [String] the name of the dataset from which to remove data
             # @param filter_options [Hash] filtering which data to remove
-            # @Options - start_date, end_date, cascade_forecast, cascade_sessions, cascade
-            #    start_date - the first date on which to start removing data
-            #    end_date - the last date on which to finish removing data
-            #    cascade_forecast - will cascade deletes to all related forecasts
-            #    cascade_sessions - will cascade deletes to all related sessions
-            #    cascade - will cascade deletes to all related forecasts and sessions
+            # @note Options: start_date, end_date, cascade_forecast, cascade_sessions, cascade
+            #    - start_date - the first date on which to start removing data
+            #    - end_date - the last date on which to finish removing data
+            #    - cascade_forecast - will cascade deletes to all related forecasts
+            #    - cascade_sessions - will cascade deletes to all related sessions
+            #    - cascade - will cascade deletes to all related forecasts and sessions
             # @example - request delete with cascade forecast
             #    NexosisApi.client.remove_dataset('mydataset', {:cascade_forecast => true})
             def remove_dataset(dataset_name, filter_options = {})
@@ -155,11 +155,11 @@ module NexosisApi
                     "startDate" => options[:start_date].to_s,
                     "endDate" => options[:end_date].to_s,
                     "page" => options[:page_number],
-                    "pageSize" => options[:page_size],
-                    "include" => options[:include].to_s
+                    "pageSize" => options[:page_size]
                 }
+                query["include"] = options[:include].to_s unless options[:include].nil?
+                query
             end
-            
         end
     end
 end

data/lib/nexosis_api/client/sessions.rb

@@ -11,13 +11,20 @@ module NexosisApi
 			#
 			# @param query_options [Hash] optionally provide query parameters to limit the search of sessions. 
 			# @return[Array of NexosisApi::SessionResponse] with all sessions matching the query or all if no query
-			# @note query parameters hash members are dataset_name, event_name, start_date, and end_date. 
-			#    Start and end dates refer to the session requested date.
+			# @note query parameters hash members are dataset_name, event_name, requested_before_date, and requested_after_date. 
+			#    After and before dates refer to the session requested date.
 			# @example query for just one dataset
 			#   sessions = NexosisApi.client.list_sessions :dataset_name => 'MyDataset'
 			def list_sessions(query_options = {})
 				sessions_url = '/sessions'
-				response = self.class.get(sessions_url, :headers => @headers, :query => get_query_from_options(query_options))
+				query = { 
+					"dataSetName" => query_options[:dataset_name],
+					"eventName" => query_options[:event_name],
+					"requestedAfterDate" => query_options[:requested_after_date],
+					"requestedBeforeDate" => query_options[:requested_before_date],
+					"type" => query_options[:type]
+				}
+				response = self.class.get(sessions_url, :headers => @headers, :query => query)
 				if(response.success?)
 					all_responses = []
 					response.parsed_response["items"].each do |session_hash|
@@ -188,12 +195,12 @@ module NexosisApi
 			def create_session(dataset_name, target_column, start_date, end_date, is_estimate=false, event_name = nil, type = "forecast", content = nil, content_type = "text/csv")
 				session_url = "/sessions/#{type}"
 				query = { 
-					"dataSetName" => dataset_name,
 					"targetColumn" => target_column,
 					"startDate" => start_date.to_s,
 					"endDate" => end_date.to_s,
 					"isestimate" => is_estimate.to_s
 				}
+				query["dataSetName"] = dataset_name.to_s unless dataset_name.to_s.empty?
 				if(event_name.nil? == false)
 					query["eventName"] = event_name
 				end

data/lib/nexosis_api/column_role.rb

@@ -0,0 +1,13 @@
+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
+    end
+end

data/lib/nexosis_api/column_type.rb

@@ -0,0 +1,13 @@
+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
+    end
+end

data/lib/nexosis_api/dataset_column.rb

@@ -0,0 +1,24 @@
+module NexosisApi
+    # class to hold the parsed results of a dataset column
+    class DatasetColumn
+        def initialize(column_name, value_hash)
+            @name = column_name
+            @type = NexosisApi::ColumnType.const_get(value_hash["dataType"].upcase)
+            @role = NexosisApi::ColumnRole.const_get(value_hash["role"].upcase)
+        end
+        # The column header, label, or name
+        # @return [String]
+        attr_accessor :name
+
+
+        # The data type of this column
+        # @note Either string, numeric, logical, or date
+        # @return [NexosisApi::ColumnType]
+        attr_accessor :type
+
+        # The role of this column
+        # @note Either none, timestamp, target, or feature
+        # @return [NexosisApi::ColumnRole]
+        attr_accessor :role
+    end
+end

data/lib/nexosis_api/dataset_summary.rb

@@ -5,11 +5,22 @@ module NexosisApi
             data_hash.each do |k,v|
                 if(k == "dataSetName")
                     @dataset_name = 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
                 end
             end
         end
     
         # The name of the dataset uploaded and saved
         attr_accessor :dataset_name
+
+        # Descriptive information about the columns
+        # @return [Array of NexosisApi::DatasetColumn]
+        attr_accessor :column_metadata
     end
 end

data/nexosisapi.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
   spec.summary = "Ruby client for working with the Nexosis API"
-  spec.version = '1.0.0'
+  spec.version = '1.0.1'
   spec.metadata["yard.run"] = "yri"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexosis_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,9 @@ files:
 - lib/nexosis_api/client.rb
 - lib/nexosis_api/client/datasets.rb
 - lib/nexosis_api/client/sessions.rb
+- lib/nexosis_api/column_role.rb
+- lib/nexosis_api/column_type.rb
+- lib/nexosis_api/dataset_column.rb
 - lib/nexosis_api/dataset_data.rb
 - lib/nexosis_api/dataset_model.rb
 - lib/nexosis_api/dataset_summary.rb