nexosis_api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2b997a9434d25b751e65efde4b3a9a6b58ad78b
-  data.tar.gz: 463ec0c9d01720274900f03a2df85d103d282c4a
+  metadata.gz: 52b0b16b9e0a7690ade72a0498b125aa2672f89d
+  data.tar.gz: da93e102814f4b830e5b5411e873c2cd2c6017c0
 SHA512:
-  metadata.gz: dc2c1e2a42e5eef101cf49207d9ecc32103c27bb587ccd8d6e4bf095f6c669dd6aa811acd288e609736b36171e1b9719b797a62586dd75a1db882d31c2b589a5
-  data.tar.gz: 7946b2578d223abd00e694ef5f533854c9015493c2a9e745ca75ddb36d0387ea27de3d9e245207f0e40025bb7bc8f527d3060db194552c42c543dcda085bfd87
+  metadata.gz: 8742572d3e9860871553bf5056d71e3ff30a5fae276e39479b73591ee443e5327b305bd4f35dafb16d451b9273facead20148b4524b7d57bc5b5924d9a9f8b94
+  data.tar.gz: 9298f52be1a0a8d6fe131d3c63bcd28a6236a85d372fabf3380d86f121041af14f5164fe15eee3e025cb1271a5f6aef386575be727107bf62bbd94b0141ef319

data/lib/nexosis_api/client/datasets.rb

@@ -113,11 +113,8 @@ module NexosisApi
                 }
                 
                 if(filter_options.empty? == false)
-                    query["startDate"] = filter_options[:start_date].to_s unless filter_options[:start_date].nil?
-                    query["endDate"] = filter_options[:end_date].to_s unless filter_options[:end_date].nil?
-                end
-                if(query.values.all?{|v|v.to_s.empty?})
-                    query = nil
+                    query["startDate"] = filter_options[:start_date].to_s #unless filter_options[:start_date].nil?
+                    query["endDate"] = filter_options[:end_date].to_s #unless filter_options[:end_date].nil?
                 end
                 response  = self.class.delete(dataset_remove_url, :headers => @headers, :query => query)
                 if(response.success?)
@@ -155,9 +152,9 @@ module NexosisApi
                     "startDate" => options[:start_date].to_s,
                     "endDate" => options[:end_date].to_s,
                     "page" => options[:page_number],
-                    "pageSize" => options[:page_size]
+                    "pageSize" => options[:page_size],
+                    "include" => options[:include]
                 }
-                query["include"] = options[:include].to_s unless options[:include].nil?
                 query
             end
         end

data/lib/nexosis_api/client/sessions.rb

@@ -1,4 +1,5 @@
 require 'csv'
+require 'json'
 
 module NexosisApi
 	class Client
@@ -70,87 +71,89 @@ module NexosisApi
 			# Forecast from data already saved to the API.
 			#
 			# @param dataset_name [String] The name of the saved data set that has the data to forecast on.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the forecast period. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the forecast period. Can be ISO 8601 string.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in dataset.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion
-			def create_forecast_session(dataset_name, target_column, start_date, end_date)
-				create_session dataset_name, target_column, start_date, end_date
+			def create_forecast_session(dataset_name, start_date, end_date, target_column = nil)
+				create_session(dataset_name, start_date, end_date, target_column)
 			end
 
 			# Forecast from CSV formatted data.
 			#
 			# @param csv [CSV] initialized CSV object ready for reading.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the forecast period. Can be ISO 8601 parseable string. 
 			# @param end_date [DateTime] The ending date of the forecast period. Can be ISO 8601 parseable string.
+			# @param target_column [String] The name of the column for which you want predictions.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion
 			# @example load and send local file
 			#    mycsv = CSV.read('.\mylocal.csv')
 			#    NexosisApi.client(:api_key=>mykey).create_forecast_session_csv(mycsv,'sales','01-01-2017','02-01-2017')
-            def create_forecast_session_csv(csv, target_column, start_date, end_date)
+            def create_forecast_session_csv(csv, start_date, end_date, target_column)
 				content = process_csv_to_s csv
-                create_session(nil, target_column, start_date, end_date, false, nil, "forecast", content)
+                create_session(nil, start_date, end_date, target_column, false, nil, "forecast", content)
             end
 
 			# Forecast from data posted in the request.
 			#
 			# @param json_data [String] Json dataset matching the dataset input schema.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the forecast period. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the forecast period. Can be ISO 8601 string.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in dataset
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion
 			# @see https://developers.nexosis.com/docs/services/98847a3fbbe64f73aa959d3cededb3af/operations/5919ef80a730020dd851f233
-			def create_forecast_session_data(json_data, target_column, start_date, end_date)
-				create_session nil, target_column, start_date, end_date, false, nil, "forecast", json_data, "application/json"
+			def create_forecast_session_data(json_data, start_date, end_date, target_column = nil)
+				json_data = json_data.to_json unless json_data.is_a? String
+				create_session nil, start_date, end_date, target_column, false, nil, "forecast", json_data, "application/json"
 			end
 
 			# Estimate the cost of a forecast from data already saved to the API.
 			#
 			# @param dataset_name [String] The name of the saved data set that has the data to forecast on.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the forecast period. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the forecast period. Can be ISO 8601 string.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in dataset.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion, including the cost
-            def estimate_forecast_session(dataset_name, target_column, start_date, end_date)
-                create_session dataset_name, target_column, start_date, end_date, true
+            def estimate_forecast_session(dataset_name, start_date, end_date, target_column = nil)
+                create_session dataset_name, start_date, end_date, target_column, true
             end
 			
 			# Analyze impact for an event with data already saved to the API.
 			#
 			# @param dataset_name [String] The name of the saved data set that has the data to forecast on.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the impactful event. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the impactful event. Can be ISO 8601 string.
 			# @param event_name [String] The name of the event.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in datatset.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion
-            def create_impact_session(dataset_name, target_column, start_date, end_date, event_name)
-                create_session dataset_name, target_column, start_date, end_date, false, event_name, "impact"
+            def create_impact_session(dataset_name, start_date, end_date, event_name, target_column = nil)
+                create_session dataset_name, start_date, end_date, target_column, false, event_name, "impact"
             end
 
 			# Analyze impact for an event with data in json format.
 			#
 			# @param json_data [String] Json dataset matching the dataset input schema.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the impactful event. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the impactful event. Can be ISO 8601 string.
 			# @param event_name [String] The name of the event.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in dataset.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion
 			# @see https://developers.nexosis.com/docs/services/98847a3fbbe64f73aa959d3cededb3af/operations/5919ef80a730020dd851f233
-			def create_impact_session_data(json_data, target_column, start_date, end_date, event_name)
-				create_session nil, target_column, start_date, end_date, false, event_name, "impact", json_data, "application/json"
+			def create_impact_session_data(json_data, start_date, end_date, event_name, target_column = nil)
+				json_data = json_data.to_json unless json_data.is_a? String
+				create_session nil, start_date, end_date, target_column, false, event_name, "impact", json_data, "application/json"
 			end
             
 			# Estimate the cost of impact analysis for an event with data already saved to the API.
 			#
 			# @param dataset_name [String] The name of the saved data set that has the data to forecast on.
-			# @param target_column [String] The name of the column for which you want predictions.
 			# @param start_date [DateTime] The starting date of the impactful event. Can be ISO 8601 string. 
 			# @param end_date [DateTime] The ending date of the impactful event. Can be ISO 8601 string.
 			# @param event_name [String] The name of the event.
+			# @param target_column [String] The name of the column for which you want predictions. Nil if defined in dataset.
 			# @return [NexosisApi::SessionResponse] providing information about the sesssion, including the cost
-            def estimate_impact_session(dataset_name, target_column, start_date, end_date, event_name)
-                create_session dataset_name, target_column, start_date, end_date, true, event_name, "impact"
+            def estimate_impact_session(dataset_name, start_date, end_date, event_name, target_column = nil)
+                create_session dataset_name, start_date, end_date, target_column, true, event_name, "impact"
             end
             
 			# Get the results of the session.
@@ -192,10 +195,10 @@ module NexosisApi
 			    end
             end
         private
-			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")
+			def create_session(dataset_name, start_date, end_date, target_column = nil, is_estimate=false, event_name = nil, type = "forecast", content = nil, content_type = "text/csv")
 				session_url = "/sessions/#{type}"
 				query = { 
-					"targetColumn" => target_column,
+					"targetColumn" => target_column.to_s,
 					"startDate" => start_date.to_s,
 					"endDate" => end_date.to_s,
 					"isestimate" => is_estimate.to_s

data/lib/nexosis_api/dataset_column.rb

@@ -3,8 +3,8 @@ module NexosisApi
     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)
+            @type = NexosisApi::ColumnType.const_get(value_hash["dataType"].upcase) unless value_hash["dataType"].nil?
+            @role = NexosisApi::ColumnRole.const_get(value_hash["role"].upcase) unless value_hash["role"].nil?
         end
         # The column header, label, or name
         # @return [String]

data/lib/nexosis_api/dataset_summary.rb

@@ -17,6 +17,7 @@ module NexosisApi
         end
     
         # The name of the dataset uploaded and saved
+        # @return [String]
         attr_accessor :dataset_name
 
         # Descriptive information about the columns

data/nexosisapi.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |spec|
   spec.files = %w(nexosisapi.gemspec)
   spec.files += Dir.glob("lib/**/*.rb")
   spec.homepage = 'https://github.com/nexosis/nexosisclient-rb'
-  spec.licenses = ['MIT']
+  spec.licenses = ['Apache 2.0']
   spec.name = 'nexosis_api'
   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.2'
+  spec.version = '1.0.3'
   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.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,7 +68,7 @@ files:
 - nexosisapi.gemspec
 homepage: https://github.com/nexosis/nexosisclient-rb
 licenses:
-- MIT
+- Apache 2.0
 metadata:
   yard.run: yri
 post_install_message: