indico 0.5.0 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4e4ebe9a3cf53dba1c8ca028f77791ecd6afc50
+  data.tar.gz: a72dd4eca05693da019919d24d52c74aa173ff40
+SHA512:
+  metadata.gz: 3888771271c807c9439ca1093408c02426067bef7518510772faad21d61c3014ccd1c1ec7d117e11b972dd05a8c37ae41f2312dd26046d8dbfd0b148156b1ce1
+  data.tar.gz: b5ea3d04258c46d7553337531f7abbbc2acafc9081e045e5025882c95fc81726cf7f1c365e427321951163797ae463b2245f52ca91848f5ad326ba27be82e812

data/lib/indico/helper.rb

@@ -19,20 +19,22 @@ module Indico
     d['data'] = data
 
     if data.class == Array
+      if api != "apis/intersections"
         api += "/batch"
+      end
     end
 
     unless config.nil?
-      server = config[:cloud]
-      api_key = config[:api_key]
-      apis = config[:apis]
+      server = config.delete('cloud')
+      api_key = config.delete('api_key')
+      apis = config.delete(:apis)
       d = d.merge(config)
     end
 
+
     server = server or Indico.config['cloud']
 
     url = url_join(server, api) + (apis ? "?apis=" + apis.join(",") : "")
-
     response = make_request(url, JSON.dump(d),
                             add_api_key_to_header((api_key or Indico.config['auth'])))
 

data/lib/indico/multi.rb

@@ -1,4 +1,5 @@
 require_relative './errors'
+require_relative './settings'
 
 module Indico
   CLIENT_TO_SERVER = {
@@ -8,41 +9,69 @@ module Indico
     "language" => "language",
     "text_tags" => "texttags",
     "fer" => "fer",
-    "named_entities" => "named_entities",
+    "named_entities" => "namedentities",
     "keywords" => "keywords",
     "facial_features" => "facialfeatures",
+    "facial_localization" => "facial_localization",
     "image_features" => "imagefeatures",
     "content_filtering" => "contentfiltering",
     "twitter_engagement" => "twitterengagement"
   }
 
   SERVER_TO_CLIENT = CLIENT_TO_SERVER.invert
-  def self.multi(data, type, apis, allowed, batch = false, config)
-    converted_apis = Array.new
+
+  def self.validate_apis(apis, type="api", allowed=CLIENT_TO_SERVER.keys)
     apis.each { |api|
       if not allowed.include? api
         fail  api + " is not a valid api for " + type + " requests. Please use: " + allowed.join(", ")
-      else
-        converted_apis.push(CLIENT_TO_SERVER[api])
       end
     }
+  end
+
+  def self.multi(data, type, apis, allowed, batch = false, config)
 
     if config.nil?
       config = {}
     end
 
-    config[:apis] = converted_apis
+    self.validate_apis(apis, type, allowed)
+    config[:apis] = apis
     response = api_handler(data, batch ? "apis/batch" : "apis", config)
-    results = handle_multi(response)
+    return handle_multi(response)
+  end
+
+  def self.intersections(data, apis = nil, config = nil)
+
+    if apis == nil
+      fail "Argument 'apis' must be provided"
+    end
+
+    api_types = apis.map { |api| API_TYPES[api] }
+
+    if !apis.is_a? Array or apis.length != 2
+      fail "Argument 'apis' must be of length 2"
+    elsif data.is_a? Array and data.length < 3
+      fail "At least 3 examples are required to use the intersections api"
+    elsif api_types[0] != api_types[1]
+      fail "Both 'apis' must accept the same kind of input to use the intersections api."
+    end
+
+    if config.nil?
+      config = {}
+    end
+
+    self.validate_apis(apis)
+    config[:apis] = apis
+    response = api_handler(data, "apis/intersections", config)
+    return response
 
-    results
   end
 
   def self.handle_multi(results)
     converted_results = Hash.new
     results.each do |key, value|
       if value.is_a?(Hash) && value.has_key?("results")
-        converted_results[SERVER_TO_CLIENT[key]] = value["results"]
+        converted_results[key] = value["results"]
       else
         raise IndicoError, 'unexpected result from ' + key + '. ' + value.fetch("error", "")
       end

data/lib/indico/settings.rb

@@ -6,8 +6,31 @@ HEADERS = { 'Content-Type' => 'application/json',
             'client-lib' => 'ruby',
             'version-number' => Indico::VERSION }
 # APIS
-TEXT_APIS = ["political", "sentiment", "sentiment_hq", "language", "text_tags"]
-IMAGE_APIS = ["fer", "facial_features", "image_features", "content_filtering"]
+TEXT_APIS = [
+  "political", 
+  "sentiment", 
+  "sentiment_hq", 
+  "language", 
+  "text_tags", 
+  "twitter_engagement", 
+  "keywords", 
+  "named_entities"
+]
+IMAGE_APIS = [
+  "fer", 
+  "facial_features", 
+  "facial_localization",
+  "image_features", 
+  "content_filtering"
+]
+
+API_TYPES = {}
+TEXT_APIS.each do |api|
+  API_TYPES[:api] = 'text'
+end
+IMAGE_APIS.each do |api|
+  API_TYPES[:api] = 'image'
+end
 
 module Indico
   private

data/lib/indico/version.rb

@@ -1,3 +1,3 @@
 module Indico
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/lib/indico.rb

@@ -199,30 +199,30 @@ module Indico
     self.content_filtering(image, config)
   end
 
-  def self.predict_image(face, apis = IMAGE_APIS, config = nil)
+  def self.analyze_image(face, apis = IMAGE_APIS, config = nil)
     api_hash = {apis:apis}
     multi(preprocess(face, 48, false), "image", apis, IMAGE_APIS, config ? config.update(api_hash) : api_hash)
   end
 
-  def self.batch_predict_image(image, config = nil)
+  def self.batch_analyze_image(image, apis = IMAGE_APIS, config = nil)
     warn(
-      "The `batch_predict_image` function will be deprecated in the next major upgrade. " + 
-      "Please call `predict_image` instead with the same arguments"
+      "The `batch_analyze_image` function will be deprecated in the next major upgrade. " + 
+      "Please call `analyze_image` instead with the same arguments"
     )
-    self.predict_image(image, config)
+    self.analyze_image(image, apis, config)
   end
 
-  def self.predict_text(text, apis = TEXT_APIS, config = nil)
+  def self.analyze_text(text, apis = TEXT_APIS, config = nil)
     api_hash = {apis:apis}
     multi(text, "text", apis, TEXT_APIS, config ? config.update(api_hash) : api_hash)
   end
 
-  def self.batch_predict_text(text, config = nil)
+  def self.batch_analyze_text(text, apis = TEXT_APIS, config = nil)
     warn(
-      "The `batch_predict_text` function will be deprecated in the next major upgrade. " + 
-      "Please call `predict_text` instead with the same arguments"
+      "The `batch_analyze_text` function will be deprecated in the next major upgrade. " + 
+      "Please call `analyze_text` instead with the same arguments"
     )
-    self.predict_text(text, config)
+    self.analyze_text(text, apis, config)
   end
 
 end

data/spec/indico_batch_spec.rb

@@ -189,7 +189,7 @@ describe Indico do
 
   it "should respond with all text apis called in batch" do
     expected_keys = Set.new(TEXT_APIS)
-    response = Indico.predict_text(["Worst movie ever."], TEXT_APIS)
+    response = Indico.analyze_text(["Worst movie ever."], TEXT_APIS)
 
     expect(response.class).to eql(Hash)
     expect(Set.new(response.keys)).to eql(expected_keys)
@@ -199,7 +199,7 @@ describe Indico do
     test_image = File.dirname(__FILE__) + "/data/happy.png"
     expected_keys = Set.new(IMAGE_APIS)
     silent_warnings do
-      response = Indico.predict_image([test_image], IMAGE_APIS)
+      response = Indico.analyze_image([test_image], IMAGE_APIS)
 
       expect(response.class).to eql(Hash)
       expect(Set.new(response.keys)).to eql(expected_keys)
@@ -210,7 +210,7 @@ describe Indico do
     test_image = File.dirname(__FILE__) + "/data/happy.png"
     expected_keys = Set.new(IMAGE_APIS)
     silent_warnings do
-      response = Indico.predict_image([test_image], IMAGE_APIS)
+      response = Indico.analyze_image([test_image], IMAGE_APIS)
 
       expect(response.class).to eql(Hash)
       expect(Set.new(response.keys)).to eql(expected_keys)

data/spec/indico_spec.rb

@@ -212,7 +212,7 @@ describe Indico do
 
   it "should respond with all text apis called" do
     expected_keys = Set.new(TEXT_APIS)
-    response = Indico.predict_text("Worst movie ever.", TEXT_APIS)
+    response = Indico.analyze_text("Worst movie ever.", TEXT_APIS)
 
     expect(response.class).to eql(Hash)
     expect(Set.new(response.keys)).to eql(expected_keys)
@@ -220,7 +220,7 @@ describe Indico do
 
   it "should respond with all text apis called by default" do
     expected_keys = Set.new(TEXT_APIS)
-    response = Indico.predict_text("Worst movie ever.", TEXT_APIS)
+    response = Indico.analyze_text("Worst movie ever.", TEXT_APIS)
 
     expect(response.class).to eql(Hash)
     expect(Set.new(response.keys)).to eql(expected_keys)
@@ -230,7 +230,7 @@ describe Indico do
     test_image = File.open(File.dirname(__FILE__) + "/data/happy64.txt", 'rb') { |f| f.read }
     expected_keys = Set.new(IMAGE_APIS)
     silent_warnings do
-      response = Indico.predict_image(test_image, IMAGE_APIS)
+      response = Indico.analyze_image(test_image, IMAGE_APIS)
 
       expect(response.class).to eql(Hash)
       expect(Set.new(response.keys)).to eql(expected_keys)
@@ -241,7 +241,7 @@ describe Indico do
     test_image = File.open(File.dirname(__FILE__) + "/data/happy64.txt", 'rb') { |f| f.read }
     expected_keys = Set.new(IMAGE_APIS)
     silent_warnings do
-      response = Indico.predict_image(test_image, IMAGE_APIS)
+      response = Indico.analyze_image(test_image, IMAGE_APIS)
 
       expect(response.class).to eql(Hash)
       expect(Set.new(response.keys)).to eql(expected_keys)
@@ -257,6 +257,21 @@ describe Indico do
     end
   end
 
+  it 'should respond with proper results from intersections api' do
+    text = ['data', 'baseball', 'weather']
+    apis = ['twitter_engagement', 'sentiment']
+    response = Indico.intersections(text, apis)
+    expect(Set.new(response.keys)).to eql(Set.new(['twitter_engagement']))
+  end
+
+  it 'should respond with proper results from raw intersections api' do
+    data = {}
+    data['sentiment'] = [0.1, 0.2, 0.3];
+    data['twitter_engagement'] = [0.1, 0.2, 0.3]
+    response = Indico.intersections(data, ['sentiment', 'twitter_engagement'])
+    expect(Set.new(response.keys)).to eql(Set.new(['sentiment']))
+  end
+
   # Uncomment when frontend updated to accept image urls
   # it 'should accept image urls' do
   #   response = Indico.image_features('http://icons.iconarchive.com/icons/' +

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indico
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - Slater Victoroff
@@ -12,86 +11,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: oily_png
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby Wrapper for the indico set of APIs.
@@ -104,8 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -129,26 +118,25 @@ files:
 homepage: https://github.com/IndicoDataSolutions/IndicoIo-ruby
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple Ruby Wrapper for the indico set of APIs.
 test_files: []