nexosis_api 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1603f0780c88198805797b6929b1d81d9a86e6e3
-  data.tar.gz: 6fe9d4f166b9ababcdce3240540f1501597297ca
+  metadata.gz: 1e6d17a2358818ca916178aa8de48d8ebeb711da
+  data.tar.gz: 5d87a2791462658a349c81a155701ff147c2a6fc
 SHA512:
-  metadata.gz: b444cc72ecf7871697dd5dd55543b9d0702c2546b9dfa9faed0308a4457953c382c8a2e9dae717c6917f63ed1ede0bd1c96a4e843104d5f234910370ef1d3b53
-  data.tar.gz: c1c789c24817a72fe2897bbc6e23b47ea9af9e1d1e039e8c60f22f09110a7e096a7724386df610bcca3f0dce189201c33185cb754188562d28dc8988039afd4e
+  metadata.gz: d732e55a70a52ca2fd0e89d3485ffd0cf338f025b61187f20db0d08671bcbe3419c111054357a4ada9c2954aa818772b1dfa630f60f40792149b583636024054
+  data.tar.gz: 7edec30d1bedcc884748f0e568db6a916c5d9f2b47ac3cbef10077294cfb17bb1bb12e5dbea8f98db8a97fa56b4738a73ce758dc3c9bbaf9e6cc20b8779b8840

data/lib/nexosis_api/calendar_jointarget.rb

@@ -0,0 +1,34 @@
+module NexosisApi
+  # Specifies the details of a calendar data source to join to
+  # @see http://docs.nexosis.com/guides/calendars
+  # @since 1.2.3
+  class CalendarJoinTarget
+    def initialize(cal_join_hash)
+      @url = cal_join_hash['url'] unless cal_join_hash.nil?
+      @name = cal_join_hash['name'] unless cal_join_hash.nil?
+      @timezone = cal_join_hash['timeZone'] unless cal_join_hash.nil?
+    end
+
+    # The location of a public iCal to download as the datasource
+    # @return [String]
+    attr_accessor :url
+
+    # The name of a well-known Nexosis calendar.
+    # @return [String]
+    # @see http://docs.nexosis.com/guides/datasources
+    attr_accessor :name
+
+    # tz-db string name of the timezone of the calendar
+    # @return [String]
+    # @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+    attr_accessor :timezone
+
+    def to_hash
+      hash = { 'calendar' => {} }
+      hash['calendar'].store 'url', url unless url.nil?
+      hash['calendar'].store 'name', name unless name.nil?
+      hash['calendar'].store 'timeZone', name unless timezone.nil?
+      hash
+    end
+  end
+end

data/lib/nexosis_api/client.rb

@@ -1,11 +1,13 @@
 require 'nexosis_api/algorithm_run'
 require 'nexosis_api/algorithm_selection'
 require 'nexosis_api/algorithm'
+require 'nexosis_api/calendar_jointarget'
 require 'nexosis_api/column'
 require 'nexosis_api/column_options'
 require 'nexosis_api/column_role'
 require 'nexosis_api/column_type'
 require 'nexosis_api/dataset_data'
+require 'nexosis_api/dataset_jointarget'
 require 'nexosis_api/dataset_model'
 require 'nexosis_api/dataset_summary'
 require 'nexosis_api/http_exception'

data/lib/nexosis_api/client/views.rb

@@ -3,7 +3,7 @@ module NexosisApi
   class Client
     # Views-based API operations
     # @see http://docs.nexosis.com/
-    # @since v1.2
+    # @since 1.2.0
     module Views
       ## List all existing view defintions, optionally limited by
       # partial name or participating data sources

data/lib/nexosis_api/column_options.rb

@@ -1,17 +1,19 @@
 module NexosisApi
   # Class for holding the join options on a column in a view-based join
-  # @since v1.2
+  # @since 1.2.0
   class ColumnOptions
     # Create a new option for a join column.
     # @param column_name [String] the name of the original column from the source dataset
     # @param options_hash [Hash] additional information about how to process the column in a join
     def initialize(column_name, options_hash)
-      @name = column_name
+      @column_name = column_name
       @join_interval = NexosisApi::TimeInterval.const_get(options_hash['joinInterval'].upcase) unless options_hash['joinInterval'].nil?
       @alias = options_hash['alias']
     end
 
-    attr_accessor :name
+    # The name of the column on which these options are applied
+    # @return [String]
+    attr_accessor :column_name
 
     # Optional interval of a time series column being joined to another time series
     # @note not valid outside of join defintion
@@ -26,8 +28,10 @@ module NexosisApi
     attr_accessor :alias
 
     def to_hash
-      { name => { 'join_interval' => @join_internal.to_s,
-                  'alias' => @alias.to_s } }
+      hash = { column_name => {} }
+      hash[column_name]['join_interval'] = join_interval.to_s unless join_interval.nil?
+      hash[column_name]['alias'] = @alias.to_s unless @alias.nil?
+      hash
     end
   end
-end
+end

data/lib/nexosis_api/dataset_jointarget.rb

@@ -0,0 +1,18 @@
+module NexosisApi
+  # Specifies the name of a dataset to use as the join datasource
+  # @see http://docs.nexosis.com/guides/views
+  # @since 1.2.3
+  class DatasetJoinTarget
+    def initialize(ds_join_hash)
+      @dataset_name = ds_join_hash['name'] unless ds_join_hash.nil?
+    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
+    
+    def to_hash
+      { 'dataSet' => { 'name' => dataset_name } }
+    end
+  end
+end

data/lib/nexosis_api/join.rb

@@ -2,27 +2,31 @@
 
 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'
-          @dataset_name = v['name'] unless v.nil?
+          @join_target = NexosisApi::DatasetJoinTarget.new(v) unless v.nil?
+        elsif k == 'calendar'
+          @join_target = NexosisApi::CalendarJoinTarget.new(v) unless v.nil?
         elsif k == 'columnOptions'
-          @column_options = v unless v.nil?
+          next if v.nil?
+          @column_options = v.map do |key, option|
+            NexosisApi::ColumnOptions.new(key, option)
+          end
         elsif k == 'joins'
-          joins = []
           next if v.nil?
-          v.each do |join|
-            joins << NexosisApi::Join.new(join)
-            @joins = joins
+          @joins = v.map do |join|
+            NexosisApi::Join.new(join)
           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 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
@@ -34,12 +38,11 @@ module NexosisApi
     attr_accessor :joins
 
     def to_hash
-      hash = {}
-      hash['dataSet'] = { name: dataset_name }
+      hash = join_target.to_hash
       if column_options.nil? == false
-        hash['columns'] = {}
+        hash['columnOptions'] = {}
         column_options.each do |column|
-          hash['columns'].merge!(column.to_hash)
+          hash['columnOptions'].merge!(column.to_hash)
         end
       end
       if joins.nil? == false

data/lib/nexosis_api/session.rb

@@ -82,7 +82,7 @@ module NexosisApi
 
     # The name of the datasource used to run this session
     # @return [String] - the dataset or view name
-    # @since v1.2
+    # @since 1.2.0
     attr_accessor :datasource_name
   end
 end

data/lib/nexosis_api/view_data.rb

@@ -1,5 +1,6 @@
 module NexosisApi
   # Class to hold the parsed results of a view data retrieval
+  # @since 1.2.0
   class ViewData < ViewDefinition
     def initialize(viewdata_hash)
       @data = viewdata_hash['data']

data/lib/nexosis_api/view_definition.rb

@@ -1,5 +1,6 @@
 module NexosisApi
   # class to hold the parsed results of a view
+  # @since 1.2.0
   class ViewDefinition
     def initialize(view_hash)
       view_hash.each do |k, v|

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.2.2'
+  spec.version = '1.2.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.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ files:
 - lib/nexosis_api/algorithm.rb
 - lib/nexosis_api/algorithm_run.rb
 - lib/nexosis_api/algorithm_selection.rb
+- lib/nexosis_api/calendar_jointarget.rb
 - lib/nexosis_api/client.rb
 - lib/nexosis_api/client/datasets.rb
 - lib/nexosis_api/client/imports.rb
@@ -59,6 +60,7 @@ files:
 - lib/nexosis_api/column_role.rb
 - lib/nexosis_api/column_type.rb
 - lib/nexosis_api/dataset_data.rb
+- lib/nexosis_api/dataset_jointarget.rb
 - lib/nexosis_api/dataset_model.rb
 - lib/nexosis_api/dataset_summary.rb
 - lib/nexosis_api/http_exception.rb