indico 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4e4ebe9a3cf53dba1c8ca028f77791ecd6afc50
-  data.tar.gz: a72dd4eca05693da019919d24d52c74aa173ff40
+  metadata.gz: 24341b66e960ef4cdd9e36ecf862b2b710948797
+  data.tar.gz: 0425f72fb76f39185f36e15d9b41c975d31dc8a5
 SHA512:
-  metadata.gz: 3888771271c807c9439ca1093408c02426067bef7518510772faad21d61c3014ccd1c1ec7d117e11b972dd05a8c37ae41f2312dd26046d8dbfd0b148156b1ce1
-  data.tar.gz: b5ea3d04258c46d7553337531f7abbbc2acafc9081e045e5025882c95fc81726cf7f1c365e427321951163797ae463b2245f52ca91848f5ad326ba27be82e812
+  metadata.gz: db04ca7b5c47e177d5fe4deea09c08e6be93dab650e78eb056926928e8f09d940dbf7870243299eaa5fdc00d42ae83ec5fab6261c7f0c2c28def0769bc763b94
+  data.tar.gz: 04e0f72440cb63422a8f4c847593a99fa666d11b3156893b7977063483e554419a49e288881ec59b88a48efdd3795fda4c36b8b91eb9250441520c68d798c34f

data/lib/indico/helper.rb

@@ -14,6 +14,7 @@ module Indico
   def self.api_handler(data, api, config)
     server = nil
     api_key = nil
+    version = nil
 
     d = {}
     d['data'] = data
@@ -28,15 +29,24 @@ module Indico
       server = config.delete('cloud')
       api_key = config.delete('api_key')
       apis = config.delete(:apis)
+      version = config.delete(:version)
       d = d.merge(config)
     end
 
+    api_key = (api_key or Indico.config['auth'])
+    server = (server or Indico.config['cloud'])
 
-    server = server or Indico.config['cloud']
+    if api_key.nil?
+      raise ArgumentError, 'api key is required'
+    end
+    
+    url = url_join(server, api) + \
+         ("?key=" + api_key) + \
+         (apis ? "&apis=" + apis.join(",") : "") + \
+         (version ? "&version=" + version : "")
 
-    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'])))
+                            add_api_key_to_header(api_key))
 
 
     results = JSON.parse(response.body)
@@ -67,9 +77,6 @@ module Indico
   end
 
   def self.add_api_key_to_header(api_key)
-    if api_key.nil?
-      raise ArgumentError, 'api key is required'
-    end
     headers = HEADERS
     headers['X-ApiKey'] = api_key
     headers

data/lib/indico/image.rb

@@ -2,92 +2,97 @@ require 'oily_png'
 require 'base64'
 
 module Indico
-  def self.preprocess(image, size, min_axis)
-    
-    if image.class == String
-      decoded_image = handle_string_input(image)
-    elsif image.class == Array
-      # Batch Request
-      im_array = Array.new
+    def self.preprocess(image, size, min_axis)
+        if image.class == Array
+            # Batch Request
+            im_array = Array.new
 
-      # process each image
-      image.each do |_image|
-        im_array.push(preprocess(_image, size, min_axis))
-      end
+            # process each image
+            image.each do |_image|
+                im_array.push(preprocess(_image, size, min_axis))
+            end
 
-      return im_array
-    else
-      raise Exception.new("Image input must be filename or base64 string")
-    end
+            return im_array
+        elsif image.class != String
+            raise Exception.new("Image input must be filename or base64 string")
+        end
 
-    if size
-      if min_axis
-        image = self.min_resize(decoded_image, size)
-      else
-        image = decoded_image.resize(size, size) 
-      end
-    else
-      image = decoded_image
+        # Resize and export base64 encoded string
+        return handle_image_input(image, size, min_axis)
     end
 
-    # Resize and export base64 encoded string
-    return image.to_data_url.gsub("data:image/png;base64," ,"")
-  end
-
-  def self.min_resize(decoded_image, size)
-    img_size = [decoded_image.width, decoded_image.height]
-    min_idx, max_idx = img_size[0] < img_size[1] ? [0, 1] : [1, 0]
-    aspect = img_size[max_idx] / Float(img_size[min_idx])
-    if aspect > 10
-      warn("An aspect ratio greater than 10:1 is not recommended")
+    def self.min_resize(decoded_image, size)
+        img_size = [decoded_image.width, decoded_image.height]
+        min_idx, max_idx = img_size[0] < img_size[1] ? [0, 1] : [1, 0]
+        aspect = img_size[max_idx] / Float(img_size[min_idx])
+        if aspect > 10
+            warn("An aspect ratio greater than 10:1 is not recommended")
+        end
+        size_arr = [0, 0]
+        size_arr[min_idx] = size
+        size_arr[max_idx] = Integer(size * aspect)
+        image = decoded_image.resize(size_arr[0], size_arr[1])
+        return image
     end
-    size_arr = [0, 0]
-    size_arr[min_idx] = size
-    size_arr[max_idx] = Integer(size * aspect)
-    image = decoded_image.resize(size_arr[0], size_arr[1])
-    return image
-  end
 
-  def self.handle_string_input(str)
-    # Handles string input
-    if File.file?(str)
-      # Handling File Inputs
-      return ChunkyPNG::Image.from_file(str)
+    def self.handle_image_input(str, size, min_axis)
+        # Handles string input
+        if File.file?(str)
+            # Handling File Inputs
+            begin
+                image = ChunkyPNG::Image.from_file(str)
+                if min_axis
+                    image = self.min_resize(image, size)
+                else
+                    image = image.resize(size, size)
+                end
+                image = image.to_data_url.gsub("data:image/png;base64," ,"")
+            rescue
+                File.open(str, 'r') do |file|
+                    image = Base64.encode64(file.read)
+                end
+            end
+        else
+            begin
+                image = ChunkyPNG::Image.from_data_url("data:image/png;base64," + str.gsub("data:image/png;base64," ,""))
+                if min_axis
+                    image = self.min_resize(image, size)
+                else
+                    image = image.resize(size, size)
+                end
+                image = image.to_data_url.gsub("data:image/png;base64," ,"")
+            rescue
+                image = str
+            end
+        end
+
+        return image
     end
 
-    regex = %r{^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)$}.match(str)
-    # Base 64 handling
-    if regex == nil
-      raise Exception.new("String is not a valid absolute filepath or base64 string")
-    else
-      return ChunkyPNG::Image.from_data_url("data:image/png;base64," + str.gsub("data:image/png;base64," ,""))
+    def self.get_dimension(array)
+        return [] unless array.is_a?(Array)
+        return [array.size] + get_dimension(array[0])
     end
-  end
 
-  def self.get_dimension(array)
-    return [] unless array.is_a?(Array)
-    return [array.size] + get_dimension(array[0])
-  end
+    def self.array_contains_float(array, dimens)
+        # Determines whether or not the array contains floats
+        if not array.is_a?(Array)
+            return array.class == Float
+        end
+        elem = array[0]
+        (0..dimens.size - 2).each do |i|
+            elem = elem[0]
+        end
 
-  def self.array_contains_float(array, dimens)
-    # Determines whether or not the array contains floats
-    if not array.is_a?(Array)
-      return array.class == Float
+        return elem.class == Float
     end
-    elem = array[0]
-    (0..dimens.size - 2).each do |i|
-      elem = elem[0]
-    end
-
-    return elem.class == Float
-  end
 
-  def self.get_rgb(value)
-    # Returns Integer encoding of RGB value used by ChunkyPNG
-    return [
-      ChunkyPNG::Color.r(value),
-      ChunkyPNG::Color.g(value),
-      ChunkyPNG::Color.b(value)
-    ]
-  end
+    def self.get_rgb(value)
+        # Returns Integer encoding of RGB value used by ChunkyPNG
+        return [
+            ChunkyPNG::Color.r(value),
+            ChunkyPNG::Color.g(value),
+            ChunkyPNG::Color.b(value)
+        ]
+    end
 end

data/lib/indico/settings.rb

@@ -7,20 +7,20 @@ HEADERS = { 'Content-Type' => 'application/json',
             'version-number' => Indico::VERSION }
 # APIS
 TEXT_APIS = [
-  "political", 
-  "sentiment", 
-  "sentiment_hq", 
+  "political",
+  "sentiment",
+  "sentiment_hq",
   "language", 
-  "text_tags", 
-  "twitter_engagement", 
-  "keywords", 
+  "text_tags",
+  "twitter_engagement",
+  "keywords",
   "named_entities"
 ]
 IMAGE_APIS = [
-  "fer", 
-  "facial_features", 
+  "fer",
+  "facial_features",
   "facial_localization",
-  "image_features", 
+  "image_features",
   "content_filtering"
 ]
 

data/lib/indico/version.rb

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

data/lib/indico.rb

@@ -30,7 +30,7 @@ module Indico
 
   def self.batch_political(text, config = nil)
     warn(
-      "The `batch_political` function will be deprecated in the next major upgrade. " + 
+      "The `batch_political` function will be deprecated in the next major upgrade. " +
       "Please call `political` instead with the same arguments"
     )
     self.political(text, config)
@@ -42,7 +42,7 @@ module Indico
 
   def self.batch_posneg(text, config = nil)
     warn(
-      "The `batch_posneg` function will be deprecated in the next major upgrade. " + 
+      "The `batch_posneg` function will be deprecated in the next major upgrade. " +
       "Please call `posneg` instead with the same arguments"
     )
     self.posneg(text, config)
@@ -54,7 +54,7 @@ module Indico
 
   def self.batch_sentiment(text, config = nil)
     warn(
-      "The `batch_sentiment` function will be deprecated in the next major upgrade. " + 
+      "The `batch_sentiment` function will be deprecated in the next major upgrade. " +
       "Please call `sentiment` instead with the same arguments"
     )
     self.sentiment(text, config)
@@ -67,7 +67,7 @@ module Indico
 
   def self.batch_twitter_engagement(text, config = nil)
     warn(
-      "The `batch_twitter_engagement` function will be deprecated in the next major upgrade. " + 
+      "The `batch_twitter_engagement` function will be deprecated in the next major upgrade. " +
       "Please call `twitter_engagement` instead with the same arguments"
     )
     self.twitter_engagement(text, config)
@@ -79,7 +79,7 @@ module Indico
 
   def self.batch_sentiment_hq(text, config = nil)
     warn(
-      "The `batch_sentiment_hq` function will be deprecated in the next major upgrade. " + 
+      "The `batch_sentiment_hq` function will be deprecated in the next major upgrade. " +
       "Please call `sentiment_hq` instead with the same arguments"
     )
     self.sentiment_hq(text, config)
@@ -92,7 +92,7 @@ module Indico
 
   def self.batch_language(text, config = nil)
     warn(
-      "The `batch_language` function will be deprecated in the next major upgrade. " + 
+      "The `batch_language` function will be deprecated in the next major upgrade. " +
       "Please call `language` instead with the same arguments"
     )
     self.language(text, config)
@@ -105,7 +105,7 @@ module Indico
 
   def self.batch_text_tags(text, config = nil)
     warn(
-      "The `batch_text_tags` function will be deprecated in the next major upgrade. " + 
+      "The `batch_text_tags` function will be deprecated in the next major upgrade. " +
       "Please call `text_tags` instead with the same arguments"
     )
     self.text_tags(text, config)
@@ -118,7 +118,7 @@ module Indico
 
   def self.batch_keywords(text, config = nil)
     warn(
-      "The `batch_keywords` function will be deprecated in the next major upgrade. " + 
+      "The `batch_keywords` function will be deprecated in the next major upgrade. " +
       "Please call `keywords` instead with the same arguments"
     )
     self.keywords(text, config)
@@ -131,7 +131,7 @@ module Indico
 
   def self.batch_named_entities(text, config = nil)
     warn(
-      "The `batch_named_entities` function will be deprecated in the next major upgrade. " + 
+      "The `batch_named_entities` function will be deprecated in the next major upgrade. " +
       "Please call `named_entities` instead with the same arguments"
     )
     self.named_entities(text, config)
@@ -144,7 +144,7 @@ module Indico
 
   def self.batch_fer(image, config = nil)
     warn(
-      "The `batch_fer` function will be deprecated in the next major upgrade. " + 
+      "The `batch_fer` function will be deprecated in the next major upgrade. " +
       "Please call `fer` instead with the same arguments"
     )
     self.fer(image, config)
@@ -157,31 +157,35 @@ module Indico
 
   def self.batch_facial_features(image, config = nil)
     warn(
-      "The `batch_facial_features` function will be deprecated in the next major upgrade. " + 
+      "The `batch_facial_features` function will be deprecated in the next major upgrade. " +
       "Please call `facial_features` instead with the same arguments"
     )
     self.facial_features(image, config)
   end
 
   def self.facial_localization(image, config = nil)
-    api_handler(preprocess(image, 128, false), 'faciallocalization', config)
+    api_handler(preprocess(image, false, false), 'faciallocalization', config)
   end
 
   def self.batch_facial_localization(image, config = nil)
     warn(
-      "The `batch_facial_localization` function will be deprecated in the next major upgrade. " + 
+      "The `batch_facial_localization` function will be deprecated in the next major upgrade. " +
       "Please call `facial_localization` instead with the same arguments"
     )
     self.facial_localization(image, config)
   end
 
   def self.image_features(image, config = nil)
-    api_handler(preprocess(image, 64, false), 'imagefeatures', config)
+    api_handler(preprocess(image, 144, true), 'imagefeatures', config)
+  end
+
+  def self.image_recognition(image, config = nil)
+    api_handler(preprocess(image, 144, true), 'imagerecognition', config)
   end
 
   def self.batch_image_features(image, config = nil)
     warn(
-      "The `batch_image_features` function will be deprecated in the next major upgrade. " + 
+      "The `batch_image_features` function will be deprecated in the next major upgrade. " +
       "Please call `image_features` instead with the same arguments"
     )
     self.image_features(image, config)
@@ -193,7 +197,7 @@ module Indico
 
   def self.batch_content_filtering(image, config = nil)
     warn(
-      "The `batch_content_filtering` function will be deprecated in the next major upgrade. " + 
+      "The `batch_content_filtering` function will be deprecated in the next major upgrade. " +
       "Please call `content_filtering` instead with the same arguments"
     )
     self.content_filtering(image, config)
@@ -206,7 +210,7 @@ module Indico
 
   def self.batch_analyze_image(image, apis = IMAGE_APIS, config = nil)
     warn(
-      "The `batch_analyze_image` function will be deprecated in the next major upgrade. " + 
+      "The `batch_analyze_image` function will be deprecated in the next major upgrade. " +
       "Please call `analyze_image` instead with the same arguments"
     )
     self.analyze_image(image, apis, config)
@@ -219,7 +223,7 @@ module Indico
 
   def self.batch_analyze_text(text, apis = TEXT_APIS, config = nil)
     warn(
-      "The `batch_analyze_text` function will be deprecated in the next major upgrade. " + 
+      "The `batch_analyze_text` function will be deprecated in the next major upgrade. " +
       "Please call `analyze_text` instead with the same arguments"
     )
     self.analyze_text(text, apis, config)

data/spec/imagerecognition_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Indico do
+    before do
+        api_key = ENV['INDICO_API_KEY']
+        private_cloud = 'indico-test'
+        @config = { api_key: api_key, cloud: private_cloud}
+    end
+
+    it 'single image recognition should return the right response' do
+        data = File.dirname(__FILE__) + "/data/happy.png"
+
+        config = @config.clone
+        config["top_n"] = 3
+        response = Indico.image_recognition(data, config)
+        expect(response.keys.length).to eql(3)
+    end
+
+    it 'batch image recognition should return the right response' do
+        data = File.dirname(__FILE__) + "/data/happy.png"
+
+        config = @config.clone
+        config["top_n"] = 3
+        response = Indico.image_recognition([data, data], config)
+        expect(response.length).to eql(2)
+        expect(response[0].keys.length).to eql(3)
+    end
+end

data/spec/indico_spec.rb

@@ -6,8 +6,6 @@ describe Indico do
   before do
     api_key = ENV['INDICO_API_KEY']
     private_cloud = 'indico-test'
-    # FIXME - REMOVE WHEN SENTIMENTHQ RELEASE
-    TEXT_APIS.delete("sentiment_hq")
     @config = { api_key: api_key, cloud: private_cloud}
   end
 
@@ -117,14 +115,14 @@ describe Indico do
   it 'should tag text with correct keywords for auto detect language' do
     text = "La semaine suivante, il remporte sa premiere victoire, dans la descente de Val Gardena en Italie, près de cinq ans après la dernière victoire en Coupe du monde d'un Français dans cette discipline, avec le succès de Nicolas Burtin à Kvitfjell."
     config = { "language" => "detect" }
-    response = Indico.keywords(text)
+    response = Indico.keywords(text, config)
 
     expect Set.new(response.keys).subset?(Set.new(text.gsub(/\s+/m, ' ').strip.split(" ")))
   end
   it 'should tag text with correct keywords for specified language' do
     text = "La semaine suivante, il remporte sa premiere victoire, dans la descente de Val Gardena en Italie, près de cinq ans après la dernière victoire en Coupe du monde d'un Français dans cette discipline, avec le succès de Nicolas Burtin à Kvitfjell."
     config = { "language" => "French" }
-    response = Indico.keywords(text)
+    response = Indico.keywords(text, config)
 
     expect Set.new(response.keys).subset?(Set.new(text.gsub(/\s+/m, ' ').strip.split(" ")))
   end
@@ -186,6 +184,14 @@ describe Indico do
     end
   end
 
+  it 'should tag image with correct image features with jpg files' do
+    test_image= File.dirname(__FILE__) + "/data/dog.jpg"
+    silent_warnings do
+      response = Indico.image_features(test_image)
+      expect(response.length).to eql(2048)
+    end
+  end
+
   it "should tag rgb image with correct image features" do
     test_image = File.open(File.dirname(__FILE__) + "/data/happy64.txt", 'rb') { |f| f.read }
     silent_warnings do
@@ -277,7 +283,7 @@ describe Indico 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

data/spec/settings_spec.rb

@@ -75,6 +75,7 @@ describe Indico do
     end
 
     it 'should set api key with a call to set_api_key' do
+        saved_key = Indico.api_key
         Indico.api_key = nil
         begin
             Indico.political('Guns don\'t kill people. People kill people.')
@@ -91,5 +92,6 @@ describe Indico do
         else
             fail('api_key was not null')
         end
+        Indico.api_key = saved_key
     end
 end

data/spec/versioning_spec.rb

@@ -0,0 +1,18 @@
+describe Indico do
+    before do
+        api_key = ENV['INDICO_API_KEY']
+        private_cloud = 'indico-test'
+        @config = { api_key: api_key, cloud: private_cloud}
+    end
+
+    it 'should tag text with correct political tags' do
+        expected_keys = Set.new(%w(Conservative Green Liberal Libertarian))
+        data = 'Guns don\'t kill people. People kill people.'
+
+        # for mocking: use http to redirect requests to our public cloud endpoint
+        config = @config.clone
+        config["version"] = 1
+        response = Indico.political(data, config)
+        expect(Set.new(response.keys)).to eql(expected_keys)
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indico
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Slater Victoroff
@@ -11,76 +11,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: oily_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby Wrapper for the indico set of APIs.
@@ -93,8 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,12 +109,15 @@ files:
 - lib/indico/version.rb
 - spec/config/.indicorc.test
 - spec/config/.indicorc.test.2
+- spec/data/dog.jpg
 - spec/data/happy.png
 - spec/data/happy64.txt
+- spec/imagerecognition_spec.rb
 - spec/indico_batch_spec.rb
 - spec/indico_spec.rb
 - spec/settings_spec.rb
 - spec/spec_helper.rb
+- spec/versioning_spec.rb
 homepage: https://github.com/IndicoDataSolutions/IndicoIo-ruby
 licenses:
 - MIT
@@ -125,17 +128,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A simple Ruby Wrapper for the indico set of APIs.