indico 0.1.6 → 0.2.0

data/README.md

@@ -16,6 +16,10 @@ Or install it yourself as:
 
     $ gem install indico
 
+Documentation
+------------
+Found [here](http://indico.readme.io/v1.0/docs)
+
 ## Usage
 
 ```ruby
@@ -41,19 +45,44 @@ Or install it yourself as:
 
 ```
 
-###Local
+###Batch API Access
 
-When using a local version of the api you must remember to require 'indico_local' instead of 'indico'. Along the same vein, the package is then referenced as "IndicoLocal" rather than "Indico".
+If you'd like to use our batch api interface, please check out the [pricing page](https://indico.io/pricing) on our website to find the right plan for you.
 
 ```ruby
-> require 'indico_local'
+> require 'indico'
 
 => true
 
-> IndicoLocal.sentiment("I love using this tool!")
+> data = ["I believe in capital punishment", "The president is wrong"]
+
+=> ["I believe in capital punishment", "The president is wrong"]
+
+> Indico.batch_political(data, "username", "password")
+
+=> [ {"Libertarian"=>0.3511057701654774, "Liberal"=>0.06709112089656208, "Green"=>0.03830472376983833, "Conservative"=>0.5434983851681222}, {"Libertarian"=>0.08762905907467175, "Liberal"=>0.18965142341591298, "Green"=>0.02612359787701222, "Conservative"=>0.696595919632403}]
+````
+
+###Private cloud API Access
+
+If you're looking to use indico's API for high throughput applications, please check out the [pricing page](https://indico.io/pricing) on our website to find the right plan for you.
+
+```ruby
+> require 'indico'
+
+=> true
+
+> data = ["I believe in capital punishment", "The president is wrong"]
+
+=> ["I believe in capital punishment", "The president is wrong"]
+
+> Indico.batch_political(data, "username", "password", cloud)
+
+=> [ {"Libertarian"=>0.3511057701654774, "Liberal"=>0.06709112089656208, "Green"=>0.03830472376983833, "Conservative"=>0.5434983851681222}, {"Libertarian"=>0.08762905907467175, "Liberal"=>0.18965142341591298, "Green"=>0.02612359787701222, "Conservative"=>0.696595919632403}]
+````
+
+The `cloud` parameter redirects API calls to your private cloud hosted at `[cloud].indico.domains`
 
-=> {"Sentiment"=>0.7483253499779664}
-```
 
 ## Contributing
 

data/lib/indico.rb

@@ -8,37 +8,68 @@ module Indico
 
   HEADERS = { "Content-Type" => "application/json", "Accept" => "text/plain" }
 
-  def self.political(test_text, api="remote")
-    api_handler(test_text, api, "political")
+  def self.political(test_text, username=nil, password=nil, private_cloud=nil)
+    api_handler(test_text, private_cloud, "political", username, password)
   end
 
-  def self.posneg(test_text, api="remote")
-    api_handler(test_text, api, "sentiment")
+  def self.batch_political(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "political/batch", username, password)
+  end
+
+  def self.posneg(test_text, username=nil, password=nil, private_cloud=nil)
+    api_handler(test_text, private_cloud, "sentiment", username, password)
+  end
+
+  def self.batch_posneg(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "sentiment/batch", username, password)
   end
 
   def self.sentiment(*args)
     self.posneg(*args)
   end
 
-  def self.language(test_text, api="remote")
-    api_handler(test_text, api, "language")
+  def self.batch_sentiment(*args)
+    self.batch_posneg(*args)
+  end
+
+  def self.language(test_text, username=nil, password=nil, private_cloud=nil)
+    api_handler(test_text, private_cloud, "language", username, password)
+  end
+
+  def self.batch_language(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "language/batch", username, password)
   end
 
-  def self.text_tags(test_text, api="remote")
-    api_handler(test_text, api, "texttags")
+  def self.text_tags(test_text, username=nil, password=nil, private_cloud=nil)
+    api_handler(test_text, private_cloud, "texttags", username, password)
   end
-  
-  def self.fer(face, api="remote")
-    api_handler(face, api, "fer")
+
+  def self.batch_text_tags(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "texttags/batch", username, password)
+  end
+
+  def self.fer(face, username=nil, password=nil, private_cloud=nil)
+    api_handler(face, private_cloud, "fer", username, password)
+  end
+
+  def self.batch_fer(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "fer/batch", username, password)
+  end
+
+  def self.facial_features(face, username=nil, password=nil, private_cloud=nil)
+    api_handler(face, private_cloud, "facialfeatures", username, password)
   end
 
-  def self.facial_features(face, api="remote")
-    api_handler(face, api, "facialfeatures")
+  def self.batch_facial_features(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "facialfeatures/batch", username, password)
   end
 
-  def self.image_features(face, api="remote")
-    api_handler(face, api, "imagefeatures")
+  def self.image_features(face, username=nil, password=nil, private_cloud=nil)
+    api_handler(face, private_cloud, "imagefeatures", username, password)
   end
 
+  def self.batch_image_features(test_text, username, password, private_cloud=nil)
+    api_handler(test_text, private_cloud, "imagefeatures/batch", username, password)
+  end
 
 end

data/lib/indico/helper.rb

@@ -1,22 +1,28 @@
+require "base64"
+
 module Indico
   private
 
   def self.url_join(root, api)
-    if root == 'local'
-      "http://localhost:9438/%s" % api
-    else
+    if root.nil?
       "http://apiv1.indico.io/%s" % api
+    else
+      "http://" + root + ".indico.domains/" + api
     end
   end
 
-  def self.api_handler(data, server, api)
+  def self.api_handler(data, server, api, username=nil, password=nil)
     d = {}
     d['data'] = data
     data_dict = JSON.dump(d)
-    response = make_request(url_join(server, api), data_dict, HEADERS)
+    if username.nil?
+      response = make_request(url_join(server, api), data_dict, HEADERS)
+    else
+      response = make_request(url_join(server, api), data_dict, encode_credentials(username, password))
+    end
     results = JSON.parse(response.body)
     if results.key?("error")
-      results = results["error"]
+      raise results["error"]
     else
       results = results["results"]
     end
@@ -36,4 +42,12 @@ module Indico
 
     http.request(request)
   end
-end
+
+  def self.encode_credentials(username, password)
+    headers = { "Content-Type" => "application/json", "Accept" => "text/plain" }
+    credentials = username + ":" + password
+    headers["Authorization"] = "Basic " + Base64.strict_encode64(credentials)
+    headers
+  end
+
+end

data/lib/indico/version.rb

@@ -1,3 +1,3 @@
 module Indico
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/spec/indico_batch_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+require 'set'
+
+$username = ENV['INDICO_USERNAME']
+$password = ENV['INDICO_PASSWORD']
+$private_cloud = 'indico-test'
+
+describe Indico do
+
+  it "should tag text with correct political tags" do
+    expected_keys = Set.new(["Conservative", "Green", "Liberal", "Libertarian"])
+    data = ["Guns don't kill people."," People kill people."]
+    response = Indico.batch_political(data, $username, $password) # Guns don't kill people. People kill people.
+
+    expect(Set.new(response[0].keys)).to eql(expected_keys)
+    expect(Set.new(response[1].keys)).to eql(expected_keys)
+  end
+
+  it "should access a private cloud" do
+    expected_keys = Set.new(["Conservative", "Green", "Liberal", "Libertarian"])
+    data = ["Guns don't kill people."," People kill people."]
+    response = Indico.batch_political(data, $username, $password, $private_cloud) # Guns don't kill people. People kill people.
+
+    expect(Set.new(response[0].keys)).to eql(expected_keys)
+    expect(Set.new(response[1].keys)).to eql(expected_keys)
+  end
+
+  it "should tag text with correct sentiment tags" do
+    response = Indico.batch_sentiment(["Worst movie ever."], $username, $password)
+
+    expect(response[0] < 0.5).to eql(true)
+  end
+
+  it "should tag text with correct language tags" do
+    expected_keys = Set.new([
+      'English',
+      'Spanish',
+      'Tagalog',
+      'Esperanto',
+      'French',
+      'Chinese',
+      'French',
+      'Bulgarian',
+      'Latin',
+      'Slovak',
+      'Hebrew',
+      'Russian',
+      'German',
+      'Japanese',
+      'Korean',
+      'Portuguese',
+      'Italian',
+      'Polish',
+      'Turkish',
+      'Dutch',
+      'Arabic',
+      'Persian (Farsi)',
+      'Czech',
+      'Swedish',
+      'Indonesian',
+      'Vietnamese',
+      'Romanian',
+      'Greek',
+      'Danish',
+      'Hungarian',
+      'Thai',
+      'Finnish',
+      'Norwegian',
+      'Lithuanian'
+    ])
+
+    data = ['Quis custodiet ipsos custodes', 'Clearly english, foo!']
+    response = Indico.batch_language(data, $username, $password)
+
+    expect(Set.new(response[0].keys)).to eql(expected_keys)
+    expect(Set.new(response[1].keys)).to eql(expected_keys)
+  end
+
+  it "should tag text with correct text tags" do
+    expected_keys = Set.new(['fashion', 'art', 'energy', 'economics', 'entrepreneur',
+                             'books', 'politics', 'gardening', 'nba', 'conservative',
+                             'technology', 'startups', 'relationships', 'education',
+                             'humor', 'psychology', 'bicycling', 'investing', 'travel',
+                             'cooking', 'christianity', 'environment', 'religion', 'health',
+                             'hockey', 'pets', 'music', 'soccer', 'guns', 'gaming', 'jobs',
+                             'business', 'nature', 'food', 'cars', 'photography', 'philosophy',
+                             'geek', 'sports', 'baseball', 'news', 'television', 'entertainment',
+                             'parenting', 'comics', 'science', 'nfl','programming',
+                             'personalfinance', 'atheism', 'movies', 'anime', 'fitness',
+                             'military', 'realestate', 'history'])
+
+    data = ["Guns don't kill people.", "People kill people."]
+    response = Indico.batch_text_tags(data, $username, $password) # Guns don't kill people. People kill people.
+
+    expect Set.new(response[0].keys).subset?(Set.new(expected_keys))
+    expect Set.new(response[1].keys).subset?(Set.new(expected_keys))
+  end
+
+  it "should tag face with correct facial expression" do
+    expected_keys = Set.new(["Angry", "Sad", "Neutral", "Surprise", "Fear", "Happy"])
+    test_face = Array.new(48){Array.new(48){rand(100)/100.0} }
+    response = Indico.batch_fer([test_face, test_face], $username, $password)
+
+    expect(Set.new(response[0].keys)).to eql(expected_keys)
+    expect(Set.new(response[1].keys)).to eql(expected_keys)
+  end
+
+  it "should tag face with correct facial features" do
+    test_face = Array.new(48){Array.new(48){rand(100)/100.0} }
+    response = Indico.batch_facial_features([test_face, test_face], $username, $password)
+
+    expect(response[0].length).to eql(48)
+    expect(response[1].length).to eql(48)
+  end
+
+  it "should tag image with correct image features" do
+    test_image = Array.new(48){Array.new(48){rand(100)/100.0} }
+    response = Indico.batch_image_features([test_image, test_image], $username, $password)
+
+    expect(response[0].length).to eql(2048)
+    expect(response[1].length).to eql(2048)
+  end
+
+  # Uncomment when frontend updated to accept image urls
+  # it "should accept image urls" do
+  #   test_image = "http://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/48/Emotes-face-smile-icon.png"
+  #   response = Indico.batch_image_features([test_image, test_image], $username, $password)
+
+  #   expect(response[0].length).to eql(2048)
+  #   expect(response[1].length).to eql(2048)
+  # end
+
+end

data/spec/indico_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 require 'set'
 
+$username = ENV['INDICO_USERNAME']
+$password = ENV['INDICO_PASSWORD']
+$private_cloud = 'indico-test'
+
 describe Indico do
 
   it "should tag text with correct political tags" do
@@ -10,6 +14,14 @@ describe Indico do
     expect(Set.new(response.keys)).to eql(expected_keys)
   end
 
+  it "should tag text with correct political tags" do
+    expected_keys = Set.new(["Conservative", "Green", "Liberal", "Libertarian"])
+    data = "Guns don't kill people. People kill people."
+    response = Indico.political(data, $username, $password, $private_cloud) # Guns don't kill people. People kill people.
+
+    expect(Set.new(response.keys)).to eql(expected_keys)
+  end
+
   it "should tag text with correct sentiment tags" do
     response = Indico.sentiment("Worst movie ever.")
 
@@ -59,11 +71,11 @@ describe Indico do
   end
 
   it "should tag text with correct text tags" do
-    expected_keys = Set.new(['fashion', 'art', 'energy', 'economics', 'entrepreneur', 
-                             'books', 'politics', 'gardening', 'nba', 'conservative', 
+    expected_keys = Set.new(['fashion', 'art', 'energy', 'economics', 'entrepreneur',
+                             'books', 'politics', 'gardening', 'nba', 'conservative',
                              'technology', 'startups', 'relationships', 'education',
                              'humor', 'psychology', 'bicycling', 'investing', 'travel',
-                             'cooking', 'christianity', 'environment', 'religion', 'health', 
+                             'cooking', 'christianity', 'environment', 'religion', 'health',
                              'hockey', 'pets', 'music', 'soccer', 'guns', 'gaming', 'jobs',
                              'business', 'nature', 'food', 'cars', 'photography', 'philosophy',
                              'geek', 'sports', 'baseball', 'news', 'television', 'entertainment',
@@ -72,22 +84,37 @@ describe Indico do
                              'military', 'realestate', 'history'])
     response = Indico.text_tags("Guns don't kill people. People kill people.") # Guns don't kill people. People kill people.
 
-    expect(Set.new(response.keys)).to eql(expected_keys)
+    expect Set.new(response.keys).subset?(Set.new(expected_keys))
   end
 
   it "should tag face with correct facial expression" do
     expected_keys = Set.new(["Angry", "Sad", "Neutral", "Surprise", "Fear", "Happy"])
-    test_face = 0.step(50, 50.0/(48.0*48.0)).to_a[0..-2].each_slice(48).to_a
+    test_face = Array.new(48){Array.new(48){rand(100)/100.0} }
+
     response = Indico.fer(test_face)
 
     expect(Set.new(response.keys)).to eql(expected_keys)
   end
 
   it "should tag face with correct facial features" do
-    test_face = 0.step(50, 50.0/(48.0*48.0)).to_a[0..-2].each_slice(48).to_a
+    test_face = Array.new(48){Array.new(48){rand(100)/100.0} }
     response = Indico.facial_features(test_face)
 
     expect(response.length).to eql(48)
   end
 
-end
+  it "should tag image with correct image features" do
+    test_image = Array.new(48){Array.new(48){rand(100)/100.0} }
+    response = Indico.image_features(test_image)
+
+    expect(response.length).to eql(2048)
+  end
+
+  # Uncomment when frontend updated to accept image urls
+  # it "should accept image urls" do
+  #   response = Indico.image_features("http://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/48/Emotes-face-smile-icon.png")
+
+  #   expect(response.length).to eql(2048)
+  # end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indico
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,8 +78,7 @@ files:
 - lib/indico.rb
 - lib/indico/helper.rb
 - lib/indico/version.rb
-- lib/indico_local.rb
-- spec/indico_local_spec.rb
+- spec/indico_batch_spec.rb
 - spec/indico_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/IndicoDataSolutions/IndicoIo-ruby
@@ -108,6 +107,6 @@ signing_key:
 specification_version: 3
 summary: A simple Ruby Wrapper for the indico set of APIs.
 test_files:
-- spec/indico_local_spec.rb
+- spec/indico_batch_spec.rb
 - spec/indico_spec.rb
 - spec/spec_helper.rb

data/lib/indico_local.rb

@@ -1,37 +0,0 @@
-require "indico"
-
-module IndicoLocal
-
-  def self.political(test_text)
-    Indico.political(test_text, "local")
-  end
-
-  def self.posneg(test_text)
-    Indico.posneg(test_text, "local")
-  end
-
-  def self.sentiment(*args)
-    self.posneg(*args)
-  end
-
-  def self.language(test_text)
-    Indico.language(test_text, "local")
-  end
-
-  def self.text_tags(test_text)
-    Indico.text_tags(test_text, "local")
-  end
-
-  def self.fer(face)
-    Indico.fer(face, "local")
-  end
-
-  def self.facial_features(face)
-    Indico.facial_features(face, "local")
-  end
-
-  def self.image_features(image)
-    Indico.image_features(image, "local")
-  end
-
-end

data/spec/indico_local_spec.rb

@@ -1,107 +0,0 @@
-require 'indico_local'
-require 'set'
-
-describe Indico do
-
-  it "should tag text with correct political tags" do
-    expected_keys = Set.new(["Conservative", "Green", "Liberal", "Libertarian"])
-    response = Indico.political("Guns don't kill people. People kill people.") # Guns don't kill people. People kill people.
-
-    expect(Set.new(response.keys)).to eql(expected_keys)
-  end
-
-  it "should tag text with correct text tags" do
-    expected_keys = Set.new(["political", "arts", "products", "news"])
-    response = Indico.text_tags("Guns don't kill people. People kill people.") # Guns don't kill people. People kill people.
-
-    expect(Set.new(response.keys)).to eql(expected_keys)
-  end
-
-  it "should tag text with correct sentiment tags" do
-    response = Indico.sentiment("Worst movie ever.")
-
-    expect(response).to be < 0.5
-  end
-
-  it "should tag text with correct language tags" do
-    expected_keys = Set.new([
-      'English',
-      'Spanish',
-      'Tagalog',
-      'Esperanto',
-      'French',
-      'Chinese',
-      'French',
-      'Bulgarian',
-      'Latin',
-      'Slovak',
-      'Hebrew',
-      'Russian',
-      'German',
-      'Japanese',
-      'Korean',
-      'Portuguese',
-      'Italian',
-      'Polish',
-      'Turkish',
-      'Dutch',
-      'Arabic',
-      'Persian (Farsi)',
-      'Czech',
-      'Swedish',
-      'Indonesian',
-      'Vietnamese',
-      'Romanian',
-      'Greek',
-      'Danish',
-      'Hungarian',
-      'Thai',
-      'Finnish',
-      'Norwegian',
-      'Lithuanian'
-    ])
-    response = Indico.language('Quis custodiet ipsos custodes')
-
-    expect(Set.new(response.keys)).to eql(expected_keys)
-  end
-
-  it "should tag text with correct text tags" do
-    expected_keys = Set.new(['fashion', 'art', 'energy', 'economics', 'entrepreneur', 
-                             'books', 'politics', 'gardening', 'nba', 'conservative', 
-                             'technology', 'startups', 'relationships', 'education',
-                             'humor', 'psychology', 'bicycling', 'investing', 'travel',
-                             'cooking', 'christianity', 'environment', 'religion', 'health', 
-                             'hockey', 'pets', 'music', 'soccer', 'guns', 'gaming', 'jobs',
-                             'business', 'nature', 'food', 'cars', 'photography', 'philosophy',
-                             'geek', 'sports', 'baseball', 'news', 'television', 'entertainment',
-                             'parenting', 'comics', 'science', 'nfl','programming',
-                             'personalfinance', 'atheism', 'movies', 'anime', 'fitness',
-                             'military', 'realestate', 'history'])
-    response = Indico.text_tags("Guns don't kill people. People kill people.") # Guns don't kill people. People kill people.
-
-    expect(Set.new(response.keys)).to eql(expected_keys)
-  end
-
-  it "should tag face with correct facial expression" do
-    expected_keys = Set.new(["Angry", "Sad", "Neutral", "Surprise", "Fear", "Happy"])
-    test_face = 0.step(1, 1.0/(48.0*48.0)).to_a[0..-2].each_slice(48).to_a
-    response = Indico.fer(test_face)
-
-    expect(Set.new(response.keys)).to eql(expected_keys)
-  end
-
-  it "should return a facial feature vector" do
-    test_face = 0.step(1, 1.0/(48.0*48.0)).to_a[0..-2].each_slice(48).to_a
-    response = Indico.facial_features(test_face)
-
-    expect(response.length).to eql(48)
-  end
-
-  it "should return an image features vector" do
-    test_image = 0.step(1, 1.0/(48.0*48.0)).to_a[0..-2].each_slice(48).to_a
-    response = Indico.image_features(test_image)
-
-    expect(response.length).to eql(2048)
-  end
-
-end