nexosis_api 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98e972055cf506f2a4e54483c50f57605ade5992
-  data.tar.gz: f9da5b974d540d66e589c8f09a5df16a10ff9d81
+  metadata.gz: 05b7aebc636b47c645dc8ca1d8440dde6c26f523
+  data.tar.gz: 29acd4e727fe0e346fa7fcf4d55ad51a45c3de41
 SHA512:
-  metadata.gz: 9f763f8f98fd480d8d84e2b77ace7d8097f426ff003fc1e5bb01ad114306792ab589ef147e297e7a1684ef1ebec5e602f45c5daf5c3f9a1204ab6f78b07452bc
-  data.tar.gz: ea5d25a7bc0502c59ac958c26af5d170e80a0ee6fa5389e395a61fed7e1e2b1cbccd6c209c44fb0b70420233156167c0b37f7497f4e272450d0f25f869d5dbd2
+  metadata.gz: 3dfd4f118c8a030fb867d370b3262f995d3e2ef516d8e887dc3d9e4d6a964780e40dba3e08bd399dc04613e82ca923b12f078f57dd2775bb89246f6b8f26732c
+  data.tar.gz: e81a1e499369c1a61e603ed0ce35da9f846718d91646cecd4bd95e0eaf3d6c346f5f558703128c92f9a8f805130db1987893302cd776e132b07595b978011290

data/lib/nexosis_api/algorithm.rb

@@ -1,22 +1,22 @@
-module NexosisApi
-  # Class to parse an individual algorithm
-  class Algorithm
-    def initialize(algo_hash)
-      algo_hash.each do |k, v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-
-    # A unique identififer for the algorithm
-    # @return [String]
-    attr_accessor :key
-
-    # A friendly name for the algorithm
-    # @return [String]
-    attr_accessor :name
-
-    # Descriptive explanation of the algorithm implementation
-    # @return [String]
-    attr_accessor :description
-  end
-end
+module NexosisApi
+  # Class to parse an individual algorithm
+  class Algorithm
+    def initialize(algo_hash)
+      algo_hash.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # A unique identififer for the algorithm
+    # @return [String]
+    attr_accessor :key
+
+    # A friendly name for the algorithm
+    # @return [String]
+    attr_accessor :name
+
+    # Descriptive explanation of the algorithm implementation
+    # @return [String]
+    attr_accessor :description
+  end
+end

data/lib/nexosis_api/algorithm_contestant.rb

@@ -1,43 +1,43 @@
-module NexosisApi
-  # Class to parse results of an algorithm run
-  # @since 2.0.0
-  class AlgorithmContestant
-    def initialize(contestant_hash)
-      contestant_hash.each do |k, v|
-        if k.to_s == 'links'
-          instance_variable_set("@#{k}", v.map { |l| NexosisApi::Link.new(l) unless l.nil? })
-        elsif k.to_s == 'dataSourceProperties'
-          @datasource_properties = v
-        elsif k.to_s == 'algorithm'
-          instance_variable_set("@#{k}", NexosisApi::Algorithm.new(v)) unless v.nil?
-        else
-          instance_variable_set("@#{k}", v)
-        end
-      end
-    end
-
-    # Unique identifier for this contestant
-    attr_reader :id
-
-    # Identifier of algorithm run
-    # @return [NexosisApi::Algorithm]
-    attr_accessor :algorithm
-
-    # Name and value for metrics calculated for this algorithm
-    # @return [Hash]
-    attr_accessor :metrics
-
-    # Relevant hypermedia as {NexosisApi::Link}
-    # @return [Array]
-    attr_accessor :links
-
-    # Operations performed on datasource prior to run
-    # @return [Array]
-    attr_reader :datasource_properties
-
-    # The test dataset used to score the algo
-    # @return [Array of Hash] columnname: value hash of each observation row in test set
-    # @note - may be nil when reviewing contestant lists
-    attr_reader :data
-  end
-end
+module NexosisApi
+  # Class to parse results of an algorithm run
+  # @since 2.0.0
+  class AlgorithmContestant
+    def initialize(contestant_hash)
+      contestant_hash.each do |k, v|
+        if k.to_s == 'links'
+          instance_variable_set("@#{k}", v.map { |l| NexosisApi::Link.new(l) unless l.nil? })
+        elsif k.to_s == 'dataSourceProperties'
+          @datasource_properties = v
+        elsif k.to_s == 'algorithm'
+          instance_variable_set("@#{k}", NexosisApi::Algorithm.new(v)) unless v.nil?
+        else
+          instance_variable_set("@#{k}", v)
+        end
+      end
+    end
+
+    # Unique identifier for this contestant
+    attr_reader :id
+
+    # Identifier of algorithm run
+    # @return [NexosisApi::Algorithm]
+    attr_accessor :algorithm
+
+    # Name and value for metrics calculated for this algorithm
+    # @return [Hash]
+    attr_accessor :metrics
+
+    # Relevant hypermedia as {NexosisApi::Link}
+    # @return [Array]
+    attr_accessor :links
+
+    # Operations performed on datasource prior to run
+    # @return [Array]
+    attr_reader :datasource_properties
+
+    # The test dataset used to score the algo
+    # @return [Array of Hash] columnname: value hash of each observation row in test set
+    # @note - may be nil when reviewing contestant lists
+    attr_reader :data
+  end
+end

data/lib/nexosis_api/calendar_jointarget.rb

@@ -1,35 +1,35 @@
-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
-
-    # custom hash to match with api requests
-    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
+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
+
+    # custom hash to match with api requests
+    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/classifier_result.rb

@@ -1,25 +1,25 @@
-require 'nexosis_api/session'
-module NexosisApi
-  # class to hold parsed results of confusion matrix request
-  # @since 1.4.1
-  class ClassifierResult < Session
-    def initialize(classify_result)
-      classify_result.each do |k, v|
-        if (k.to_s == 'confusionMatrix')
-          @confusion_matrix = v
-        elsif (k.to_s == 'classes')
-          @classes = v
-        end
-      end
-      super(classify_result)
-    end
-
-    # array of arrays to form confusion matrix results
-    # @return [Array of Array of Int] - the class counts for expected to predicted
-    attr_accessor :confusion_matrix
-
-    # Class labels in index order of matrix arrays
-    # @return [Array]
-    attr_accessor :classes
-  end
-end
+require 'nexosis_api/session'
+module NexosisApi
+  # class to hold parsed results of confusion matrix request
+  # @since 1.4.1
+  class ClassifierResult < Session
+    def initialize(classify_result)
+      classify_result.each do |k, v|
+        if (k.to_s == 'confusionMatrix')
+          @confusion_matrix = v
+        elsif (k.to_s == 'classes')
+          @classes = v
+        end
+      end
+      super(classify_result)
+    end
+
+    # array of arrays to form confusion matrix results
+    # @return [Array of Array of Int] - the class counts for expected to predicted
+    attr_accessor :confusion_matrix
+
+    # Class labels in index order of matrix arrays
+    # @return [Array]
+    attr_accessor :classes
+  end
+end

data/lib/nexosis_api/client/contest.rb

@@ -1,66 +1,66 @@
-module NexosisApi
-  class Client
-    # Session Contest-based API operations
-    #
-    # @see http://docs.nexosis.com/
-    # @since 2.0.0
-    module Contest
-
-      # @return [NexosisApi::SessionContest]
-      def get_session_contest(session_id)
-        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
-        contest_url = "/sessions/#{session_id}/contest"
-        response = self.class.get(contest_url, headers: @headers)
-        raise HttpException.new("There was a problem getting session contest #{response.code}.",
-                                "getting contest for #{session_id}",
-                                response) unless response.success?
-        NexosisApi::SessionContest.new(response.parsed_response)
-      end
-
-      # @return [NexosisApi::AlgorithmContestant]
-      def get_contest_champion(session_id)
-        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
-        champion_url = "/sessions/#{session_id}/contest/champion"
-        response = self.class.get(champion_url, headers: @headers)
-        raise HttpException.new("There was a problem getting session champion #{response.code}.",
-                                "getting champion for #{session_id}",
-                                response) unless response.success?
-        NexosisApi::AlgorithmContestant.new(response.parsed_response)
-      end
-
-      # @return [Array of NexosisApi::AlgorithmContestant]
-      def get_contestants(session_id)
-        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
-        contestants_url = "/sessions/#{session_id}/contest/contestants"
-        response = self.class.get(contestants_url, headers: @headers)
-        raise HttpException.new("There was a problem getting session contestants #{response.code}.",
-                                "getting contestants for #{session_id}",
-                                response) unless response.success?
-        response.parsed_response['items'].map { |c| NexosisApi::AlgorithmContestant.new(c) }
-      end
-
-      # @return [NexosisApi::AlgorithmContestant]
-      def get_contestant_results(session_id, contestant_id)
-        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
-        raise ArgumentError, 'contestant_id was not provided and is not optional ' if contestant_id.to_s.empty?
-        contestant_url = "/sessions/#{session_id}/contest/contestants/#{contestant_id}"
-        response = self.class.get(contestant_url, headers: @headers)
-        raise HttpException.new("There was a problem getting session contestant result #{response.code}.",
-                                "getting contestant result for #{session_id}:#{contestant_id}",
-                                response) unless response.success?
-        NexosisApi::AlgorithmContestant.new(response.parsed_response)
-      end
-
-      # @return [NexosisApi::SessionSelectionMetrics]
-      def get_selection_metrics(session_id)
-        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
-        selection_url = "/sessions/#{session_id}/contest/selection"
-        response = self.class.get(selection_url, headers: @headers)
-        raise HttpException.new("There was a problem getting session selection metrics #{response.code}.",
-                                "getting selection metrics for #{session_id}",
-                                response) unless response.success?
-        NexosisApi::SessionSelectionMetrics.new(response.parsed_response)
-      end
-    end
-  end
-end
+module NexosisApi
+  class Client
+    # Session Contest-based API operations
+    #
+    # @see http://docs.nexosis.com/
+    # @since 2.0.0
+    module Contest
+
+      # @return [NexosisApi::SessionContest]
+      def get_session_contest(session_id)
+        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
+        contest_url = "/sessions/#{session_id}/contest"
+        response = self.class.get(contest_url, headers: @headers)
+        raise HttpException.new("There was a problem getting session contest #{response.code}.",
+                                "getting contest for #{session_id}",
+                                response) unless response.success?
+        NexosisApi::SessionContest.new(response.parsed_response)
+      end
+
+      # @return [NexosisApi::AlgorithmContestant]
+      def get_contest_champion(session_id)
+        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
+        champion_url = "/sessions/#{session_id}/contest/champion"
+        response = self.class.get(champion_url, headers: @headers)
+        raise HttpException.new("There was a problem getting session champion #{response.code}.",
+                                "getting champion for #{session_id}",
+                                response) unless response.success?
+        NexosisApi::AlgorithmContestant.new(response.parsed_response)
+      end
+
+      # @return [Array of NexosisApi::AlgorithmContestant]
+      def get_contestants(session_id)
+        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
+        contestants_url = "/sessions/#{session_id}/contest/contestants"
+        response = self.class.get(contestants_url, headers: @headers)
+        raise HttpException.new("There was a problem getting session contestants #{response.code}.",
+                                "getting contestants for #{session_id}",
+                                response) unless response.success?
+        response.parsed_response['items'].map { |c| NexosisApi::AlgorithmContestant.new(c) }
+      end
+
+      # @return [NexosisApi::AlgorithmContestant]
+      def get_contestant_results(session_id, contestant_id)
+        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
+        raise ArgumentError, 'contestant_id was not provided and is not optional ' if contestant_id.to_s.empty?
+        contestant_url = "/sessions/#{session_id}/contest/contestants/#{contestant_id}"
+        response = self.class.get(contestant_url, headers: @headers)
+        raise HttpException.new("There was a problem getting session contestant result #{response.code}.",
+                                "getting contestant result for #{session_id}:#{contestant_id}",
+                                response) unless response.success?
+        NexosisApi::AlgorithmContestant.new(response.parsed_response)
+      end
+
+      # @return [NexosisApi::SessionSelectionMetrics]
+      def get_selection_metrics(session_id)
+        raise ArgumentError, 'session_id was not provided and is not optional ' if session_id.to_s.empty?
+        selection_url = "/sessions/#{session_id}/contest/selection"
+        response = self.class.get(selection_url, headers: @headers)
+        raise HttpException.new("There was a problem getting session selection metrics #{response.code}.",
+                                "getting selection metrics for #{session_id}",
+                                response) unless response.success?
+        NexosisApi::SessionSelectionMetrics.new(response.parsed_response)
+      end
+    end
+  end
+end