nexosis_api 1.1.2 → 1.2.0

data/lib/nexosis_api/session_response.rb

@@ -1,26 +1,26 @@
-require 'nexosis_api/session'
-
-module NexosisApi
-    #Class to parse the results from a new session
-    class SessionResponse < Session
-        def initialize(forecast_hash)
-            forecast_hash.each do |k,v|
-				if(k == "session")
-					super(v) unless v.nil?
-				elsif(k == "nexosis-request-cost")
-					instance_variable_set("@cost", v[0]) unless v.nil?
-                elsif(k == "nexosis-account-balance")
-                    instance_variable_set("@account_balance", v[0]) unless v.nil?
-                end
-			end
-        end
-
-        # The cost of this session with currency identifier
-        # @return [String]
-        attr_accessor :cost
-
-        # Remaining balance after charge for this session
-        # @return [String]
-        attr_accessor :account_balance
-    end
-end
+require 'nexosis_api/session'
+
+module NexosisApi
+  #Class to parse the results from a new session
+  class SessionResponse < Session
+    def initialize(forecast_hash)
+      forecast_hash.each do |k, v|
+        if(k == 'session')
+          super(v) unless v.nil?
+        elsif(k == 'nexosis-request-cost')
+          instance_variable_set('@cost', v[0]) unless v.nil?
+        elsif(k == 'nexosis-account-balance')
+          instance_variable_set('@account_balance', v[0]) unless v.nil?
+        end
+      end
+    end
+
+    # The cost of this session with currency identifier
+    # @return [String]
+    attr_accessor :cost
+
+    # Remaining balance after charge for this session
+    # @return [String]
+    attr_accessor :account_balance
+  end
+end

data/lib/nexosis_api/session_result.rb

@@ -1,23 +1,23 @@
-module NexosisApi
-    # Class for parsing the results of a completed session
-    class SessionResult < Session
-        def initialize(sessionHash)
-           sessionHash.each do |k,v|
-               if k == "metrics"
-                   instance_variable_set("@#{k}", NexosisApi::ImpactMetric.new(v)) unless v.nil?
-               else
-                   instance_variable_set("@#{k}", v) unless v.nil?
-               end
-            end
-            super(sessionHash.reject {|k,v| k == "data" || k == "metrics"})
-        end
-
-        # The impact analysis if this session type is impact
-        # @return [NexosisApi::ImpactMetric]
-        attr_accessor :metrics
-
-        # The result data in a hash with the name of the target column
-        # @return [Hash]
-        attr_accessor :data
-    end
-end
+module NexosisApi
+  # Class for parsing the results of a completed session
+  class SessionResult < Session
+    def initialize(session_hash)
+      session_hash.each do |k, v|
+        if k == 'metrics'
+            instance_variable_set("@#{k}", NexosisApi::ImpactMetric.new(v)) unless v.nil?
+        else
+            instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+      super(session_hash.reject { |k,v| k == 'data' || k == 'metrics' })
+    end
+
+    # The impact analysis if this session type is impact
+    # @return [NexosisApi::ImpactMetric]
+    attr_accessor :metrics
+
+    # The result data in a hash with the name of the target column
+    # @return [Hash]
+    attr_accessor :data
+  end
+end

data/lib/nexosis_api/time_interval.rb

@@ -1,15 +1,15 @@
-module NexosisApi
-    #constants for the date/time interval (e.g. Day, Hour) at which predictions should be generated. 
-    module TimeInterval
-        # results summarized by hour
-        HOUR = :hour
-        # results summarized by day. Default option.
-        DAY = :day
-        # results summarized by week
-        WEEK = :week
-        # results summarized by month
-        MONTH = :month
-        # results summarized by year
-        YEAR = :year
-    end
-end
+module NexosisApi
+  # constants for the date/time interval (e.g. Day, Hour) at which predictions should be generated. 
+  module TimeInterval
+    # results summarized by hour
+    HOUR = :hour
+    # results summarized by day. Default option.
+    DAY = :day
+    # results summarized by week
+    WEEK = :week
+    # results summarized by month
+    MONTH = :month
+    # results summarized by year
+    YEAR = :year
+  end
+end

data/lib/nexosis_api/view_data.rb

@@ -0,0 +1,13 @@
+module NexosisApi
+  # Class to hold the parsed results of a view data retrieval
+  class ViewData < ViewDefinition
+    def initialize(viewdata_hash)
+      @data = viewdata_hash['data']
+      super(viewdata_hash.reject { |k| k == 'data' })
+    end
+
+    # An array of hashes representing the processed data of the view
+    # @return [Array of Hash] - one hash per row of data where key = column name
+    attr_accessor :data
+  end
+end

data/lib/nexosis_api/view_definition.rb

@@ -0,0 +1,51 @@
+module NexosisApi
+  # class to hold the parsed results of a view
+  class ViewDefinition
+    def initialize(view_hash)
+      view_hash.each do |k, v|
+        if k == 'viewName'
+          @view_name = v unless v.nil?
+        elsif k == 'dataSetName'
+          @dataset_name = v unless v.nil?
+        elsif k == 'columns'
+          next if v.nil?
+          @column_metadata = v.reject { |value| value.nil? } .map { |col_name, col_hash| NexosisApi::Column.new(col_name, col_hash)}
+        elsif k == 'joins'
+          @joins = v.reject(&:nil?).map { |join| NexosisApi::Join.new(join) }
+        end
+      end
+    end
+
+    # The name of the view uploaded and saved
+    # @return [String]
+    attr_accessor :view_name
+
+    # The name of the dataset on the left of the join
+    # @return [String]
+    attr_accessor :dataset_name
+
+    # Descriptive information about the columns
+    # @return [Array of NexosisApi::Column]
+    attr_accessor :column_metadata
+
+    # The join configuration for this view
+    # @return [Array of NexosisApi::Join]
+    attr_accessor :joins
+
+    def to_json
+      hash = {}
+      hash['dataSetName'] = dataset_name
+      if column_metadata.nil? == false
+        hash['columns'] = {}
+        column_metadata.each do |column|
+          hash['columns'].merge!(column.to_hash)
+        end
+      end
+      hash['joins'] = []
+      joins.each do |join|
+        hash['joins'] << join.to_hash
+      end
+      hash.to_json
+    end
+  end
+end

data/nexosisapi.gemspec

@@ -1,21 +1,21 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_dependency 'httparty', '>= 0.15'
-  spec.authors = ["Nexosis,Inc"]
-  spec.description = %q{Nexosis API client}
-  spec.email = ['support@nexosis.com']
-  spec.files = %w(nexosisapi.gemspec)
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.homepage = 'https://github.com/nexosis/nexosisclient-rb'
-  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.1.2'
-  spec.metadata["yard.run"] = "yri"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_dependency 'httparty', '>= 0.15'
+  spec.authors = ["Nexosis,Inc"]
+  spec.description = %q{Nexosis API client}
+  spec.email = ['support@nexosis.com']
+  spec.files = %w(nexosisapi.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.homepage = 'https://github.com/nexosis/nexosisclient-rb'
+  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.2.0'
+  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.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,25 +53,30 @@ files:
 - lib/nexosis_api/client/datasets.rb
 - lib/nexosis_api/client/imports.rb
 - lib/nexosis_api/client/sessions.rb
+- lib/nexosis_api/client/views.rb
+- lib/nexosis_api/column.rb
+- lib/nexosis_api/column_options.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
 - lib/nexosis_api/http_exception.rb
 - lib/nexosis_api/impact_metric.rb
 - lib/nexosis_api/imports_response.rb
+- lib/nexosis_api/join.rb
 - lib/nexosis_api/link.rb
 - lib/nexosis_api/metric.rb
 - lib/nexosis_api/session.rb
 - lib/nexosis_api/session_response.rb
 - lib/nexosis_api/session_result.rb
 - lib/nexosis_api/time_interval.rb
+- lib/nexosis_api/view_data.rb
+- lib/nexosis_api/view_definition.rb
 - nexosisapi.gemspec
 homepage: https://github.com/nexosis/nexosisclient-rb
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata:
   yard.run: yri
 post_install_message: 
@@ -90,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby client for working with the Nexosis API

data/lib/nexosis_api/dataset_column.rb

@@ -1,47 +0,0 @@
-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) unless value_hash['dataType'].nil?
-            @role = NexosisApi::ColumnRole.const_get(value_hash['role'].upcase) unless value_hash['role'].nil?
-            @imputation = value_hash['imputation'] unless value_hash['imputation'].nil?
-            @aggregation = value_hash['aggregation'] unless value_hash['aggregation'].nil?
-        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
-
-        # The strategy used to imput missing values
-        # @note Either Zeroes, Mean, Median, or Mode
-        # @return [String]
-        attr_accessor :imputation
-
-        # The strategy used to aggregate data if requested prediction period is greater than observation period
-        # @note Either Sum, Mean, Median, or Mode
-        # @return [String]
-        attr_accessor :aggregation
-
-        # utility method to format a column description in the way it is expected on input
-        def to_hash
-            { self.name => { 'dataType' => self.type.to_s, 'role' => self.role.to_s }} 
-        end
-
-        def self.to_json(column_array)
-            result = {}
-            column_array.each {|col| result[col.to_hash.keys[0]] = col.to_hash.values[0] } 
-            result
-        end
-    end
-end