nexosis_api 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c463f70058910101a5ec3b3ed201cc91ed27791c
-  data.tar.gz: '09331c0b0cd6c388851e1782942487038e69f50a'
+  metadata.gz: 68de69240c73f21137b109d7b15c8e7cf1da75b2
+  data.tar.gz: 4a293eef3fb48705ab8de41588429eebcf94448c
 SHA512:
-  metadata.gz: aa44a973d907bf7b9a55b4accb1b20669bcd0c8085ee9b92585240926d6d12517f6f14ff25d483097ac7215cc10153bafc319003301bfe23a211910d77f55f23
-  data.tar.gz: 0fe95f24b21264037f0e384af3fd9d8f1757b0e2235443c7041066cd167f1f49a2206a979d086ca4852d51e7a68c5dc2c203cf451239114e5a3b45fc2ef709ae
+  metadata.gz: 0df0c54a56b46490157727a763a76142863f93c53cb46e2ab7c873c76a2b5a2933d8a1e04f7532a9cfb25c2958c02d7c8c25ce6a7e621102ec9685a11d2ab798
+  data.tar.gz: 68eecf2f181e40fb7cb6683ac1e2af3d736e270a5da4bc1c59c90f590700368da17d691d6a67cd382d7e0c0295aa91cbb3da85c0b5d3b20e853dcf30b58a5def

data/lib/nexosis_api/client/datasets.rb

@@ -114,6 +114,20 @@ module NexosisApi
         return if response.success?
         raise HttpException.new("There was a problem removing the dataset: #{response.code}.", "removing dataset #{dataset_name}", response)
       end
+      
+      # Get per column statistics for data in the given dataset
+      # @param dataset_name [String] the name of the dataset for which to retrieve stats
+      # @since 2.3.0
+      # @note The stats will be a hash per column with a structure like: {'columns': 'column_name': { 'max': 1, 'min': 0 }}
+      # @note Common stats returned include 'max', 'min', 'stddev', 'variance', 'median'
+      def get_column_stats(dataset_name)
+        raise ArgumentError, 'dataset_name was not provided and is not optional ' if dataset_name.to_s.empty?
+        dataset_stats_url = "/data/#{dataset_name}/stats"
+        response = self.class.get(dataset_stats_url,
+                                     headers: @headers)
+        return response.parsed_response if response.success?
+        raise HttpException.new("There was a problem getting stats for the dataset: #{response.code}.", "getting stats for dataset #{dataset_name}", response)
+      end
 
       private
 
@@ -124,7 +138,8 @@ module NexosisApi
         headers = { 'api-key' => @api_key, 'Content-Type' => content_type }
         response = self.class.put(dataset_url, headers: headers, body: content)
         if response.success?
-          NexosisApi::DatasetSummary.new(response)
+          summary = NexosisApi::DatasetSummary.new(response)
+          summary
         else
           raise HttpException.new("There was a problem uploading the dataset: #{response.code}.", "uploading dataset #{dataset_name}", response)
         end

data/lib/nexosis_api/dataset_summary.rb

@@ -10,6 +10,10 @@ module NexosisApi
                               .map do |col_key, col_val|
                                 NexosisApi::Column.new(col_key, col_val)
                               end
+        elsif (k == 'dataSetSize')
+          @dataset_size = v.to_i
+        elsif (k == 'links')
+          @links = v.reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
         end
       end
     end
@@ -22,6 +26,16 @@ module NexosisApi
     # @return [Array of NexosisApi::Column]
     attr_accessor :column_metadata
 
+    # number of estimated bytes required to store the dataset
+    # @return [Integer]
+    # @since 2.3.0
+    attr_reader :dataset_size
+
+    # Helpful links to more information about this dataset
+    # @return [Array of NexosisApi::Link]
+    # @since 2.3.0
+    attr_accessor :links
+
     # Helper method which tells you whether or not this dataset has a column with timestamp role.
     # @note Often helpful for implmenters as non-timeseries datasets
     # cannot be sent to forecast or impact sessions

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 = '2.2.0'
+  spec.version = '2.3.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: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler