imagga_auto_tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4641b1a4efb8144d051899306c267d815af2b56
+  data.tar.gz: 68caa48fab91beecd93d3fe9deea06f65c02de6a
+SHA512:
+  metadata.gz: dfff46a628f1958c5adfe6d658a84adb18a532bfdb894a7fc11c4f2c7af2bdf4a79a4468e452bb94d07aeb378a4e9b44173297a17edb55a99ff0ab533258d93e
+  data.tar.gz: ae4ae9f7f9434ff21b989bfa4bd2408e2f062c048e6c869cba83cf1af9e538956894189b9c04254e84c284cd284066755f5d19a1d76fef4345b83ccb36950bf9

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imagga_auto_tag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Luke Chesser
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# ImaggaAutoTag
+
+Ruby client for fetching tags for an image using the [Imagga Auto Tagging API](http://imagga.com/solutions/auto-tagging.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'imagga_auto_tag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imagga_auto_tag
+
+## Usage
+
+```ruby
+client = ImaggaAutoTag::Client.new(your_imagga_api_key)
+results = client.fetch("http://static.ddmcdn.com/gif/landscape-photography-1.jpg")
+
+results.tags
+# => array of tags
+
+results.scrub(30)
+# => removes tags with a confidence of less than 30
+
+results.tags[0].tap do |tag|
+  tag.name # => tag name
+  tag.confidence # => tag confidence as a float
+end
+
+results.to_csv
+# => comma delimitted string of tag names
+# => 'tag1,tag2,etc..'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/lukechesser/imagga_auto_tag/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/imagga_auto_tag.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imagga_auto_tag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imagga_auto_tag"
+  spec.version       = ImaggaAutoTag::VERSION
+  spec.authors       = ["Luke Chesser"]
+  spec.email         = ["luke@unsplash.com"]
+  spec.summary       = %q{Imagga Auto Tagging API client}
+  spec.description   = %q{Ruby wrapper around the Imagga Auto Tagging API}
+  spec.homepage      = "https://github.com/lukechesser/imagga-auto-tag"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

data/lib/imagga_auto_tag/client.rb

@@ -0,0 +1,27 @@
+module ImaggaAutoTag
+  
+  class Client
+
+    IMAGGA_API_BASE_URL = "https://api.imagga.com" || ENV['IMAGGA_API_BASE_URL']
+    IMAGGA_API_TAG_PATH = "/draft/tags" || ENV['IMAGGA_API_TAG_PATH']
+
+    attr_reader :response
+
+    def initialize(api_key)
+      @api_key = api_key
+      @conn = Faraday.new(:url => IMAGGA_API_BASE_URL)
+    end
+
+    def fetch(url)
+      @response = @conn.get do |req|
+        req.url IMAGGA_API_TAG_PATH
+        req.params['api_key'] = @api_key
+        req.params['url'] = url
+      end
+
+      TaggedImage.new(@response)
+    end
+
+  end
+
+end

data/lib/imagga_auto_tag/tag.rb

@@ -0,0 +1,14 @@
+module ImaggaAutoTag
+
+  class Tag
+
+    attr_reader :confidence, :name
+
+    def initialize(raw_data)
+      @confidence = raw_data['confidence']
+      @name = raw_data['tag']
+    end
+
+  end
+
+end

data/lib/imagga_auto_tag/tagged_image.rb

@@ -0,0 +1,31 @@
+module ImaggaAutoTag
+  
+  class TaggedImage
+
+    attr_reader :status, :tags
+
+    def initialize(api_response)
+      body = JSON.parse(api_response.body)
+
+      @tags = []
+
+      body['tags'].each do |tag|
+        @tags.push Tag.new(tag)
+      end
+
+      @status = api_response.status
+    end
+
+    def scrub(threshold = 30)
+      @tags.select! do |tag|
+        tag.confidence > threshold
+      end
+    end
+
+    def to_csv
+      @tags.collect { |t| t.name }.join(',')
+    end
+
+  end
+
+end

data/lib/imagga_auto_tag/version.rb

@@ -0,0 +1,3 @@
+module ImaggaAutoTag
+  VERSION = "0.1.0"
+end

data/lib/imagga_auto_tag.rb

@@ -0,0 +1,6 @@
+require "faraday"
+require "json"
+require "imagga_auto_tag/version"
+require "imagga_auto_tag/client"
+require "imagga_auto_tag/tagged_image"
+require "imagga_auto_tag/tag"

data/spec/cassettes/image.yml

@@ -0,0 +1,125 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.imagga.com/draft/tags?api_key=acc_86d36eb78c04c30&url=http://static.ddmcdn.com/gif/landscape-photography-1.jpg
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.6.0
+      Date:
+      - Wed, 10 Dec 2014 02:42:04 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '5920'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - OPTIONS, PUT, GET, POST, DELETE
+      Access-Control-Allow-Headers:
+      - content-type, accept, cache-control, x-requested-with
+      Access-Control-Max-Age:
+      - '60'
+    body:
+      encoding: UTF-8
+      string: "{\n    \"tags\": [\n        {\n            \"confidence\": 45.87292714129046,
+        \n            \"tag\": \"field\"\n        }, \n        {\n            \"confidence\":
+        45.019462630471075, \n            \"tag\": \"grass\"\n        }, \n        {\n
+        \           \"confidence\": 41.539616750533774, \n            \"tag\": \"meadow\"\n
+        \       }, \n        {\n            \"confidence\": 37.68175405091519, \n
+        \           \"tag\": \"landscape\"\n        }, \n        {\n            \"confidence\":
+        34.47865257334126, \n            \"tag\": \"summer\"\n        }, \n        {\n
+        \           \"confidence\": 33.133958517035, \n            \"tag\": \"sky\"\n
+        \       }, \n        {\n            \"confidence\": 29.98744024808808, \n
+        \           \"tag\": \"rural\"\n        }, \n        {\n            \"confidence\":
+        28.823619628995857, \n            \"tag\": \"countryside\"\n        }, \n
+        \       {\n            \"confidence\": 27.131082541347382, \n            \"tag\":
+        \"country\"\n        }, \n        {\n            \"confidence\": 27.093789187148097,
+        \n            \"tag\": \"spring\"\n        }, \n        {\n            \"confidence\":
+        25.714842645518626, \n            \"tag\": \"farm\"\n        }, \n        {\n
+        \           \"confidence\": 24.336827549986037, \n            \"tag\": \"horizon\"\n
+        \       }, \n        {\n            \"confidence\": 24.115280119433198, \n
+        \           \"tag\": \"clouds\"\n        }, \n        {\n            \"confidence\":
+        23.561707674279226, \n            \"tag\": \"sun\"\n        }, \n        {\n
+        \           \"confidence\": 23.556618136482914, \n            \"tag\": \"agriculture\"\n
+        \       }, \n        {\n            \"confidence\": 22.642037498437524, \n
+        \           \"tag\": \"cloud\"\n        }, \n        {\n            \"confidence\":
+        22.567807528953672, \n            \"tag\": \"sunny\"\n        }, \n        {\n
+        \           \"confidence\": 21.692051236071865, \n            \"tag\": \"plant\"\n
+        \       }, \n        {\n            \"confidence\": 21.469710723996684, \n
+        \           \"tag\": \"environment\"\n        }, \n        {\n            \"confidence\":
+        20.808006937712843, \n            \"tag\": \"outdoor\"\n        }, \n        {\n
+        \           \"confidence\": 20.273804774870438, \n            \"tag\": \"pasture\"\n
+        \       }, \n        {\n            \"confidence\": 19.97223888645286, \n
+        \           \"tag\": \"weather\"\n        }, \n        {\n            \"confidence\":
+        19.672755570551505, \n            \"tag\": \"season\"\n        }, \n        {\n
+        \           \"confidence\": 19.129671346370415, \n            \"tag\": \"lawn\"\n
+        \       }, \n        {\n            \"confidence\": 18.09129540318274, \n
+        \           \"tag\": \"outdoors\"\n        }, \n        {\n            \"confidence\":
+        17.82011861957261, \n            \"tag\": \"land\"\n        }, \n        {\n
+        \           \"confidence\": 17.53373669750844, \n            \"tag\": \"cloudscape\"\n
+        \       }, \n        {\n            \"confidence\": 17.227521342721275, \n
+        \           \"tag\": \"scenery\"\n        }, \n        {\n            \"confidence\":
+        17.0521923231383, \n            \"tag\": \"sunlight\"\n        }, \n        {\n
+        \           \"confidence\": 16.598898786080063, \n            \"tag\": \"outside\"\n
+        \       }, \n        {\n            \"confidence\": 16.490149573311943, \n
+        \           \"tag\": \"cloudy\"\n        }, \n        {\n            \"confidence\":
+        15.857062477693319, \n            \"tag\": \"clear\"\n        }, \n        {\n
+        \           \"confidence\": 15.829675488345195, \n            \"tag\": \"tree\"\n
+        \       }, \n        {\n            \"confidence\": 15.24591685171035, \n
+        \           \"tag\": \"plain\"\n        }, \n        {\n            \"confidence\":
+        15.071062582287361, \n            \"tag\": \"scene\"\n        }, \n        {\n
+        \           \"confidence\": 14.274802746575993, \n            \"tag\": \"day\"\n
+        \       }, \n        {\n            \"confidence\": 13.820782181417332, \n
+        \           \"tag\": \"hill\"\n        }, \n        {\n            \"confidence\":
+        13.37486025558128, \n            \"tag\": \"natural\"\n        }, \n        {\n
+        \           \"confidence\": 13.367081765784242, \n            \"tag\": \"farming\"\n
+        \       }, \n        {\n            \"confidence\": 12.898074060896516, \n
+        \           \"tag\": \"scenic\"\n        }, \n        {\n            \"confidence\":
+        10.999456006061584, \n            \"tag\": \"fields\"\n        }, \n        {\n
+        \           \"confidence\": 10.287484889012664, \n            \"tag\": \"grassland\"\n
+        \       }, \n        {\n            \"confidence\": 10.19599186203595, \n
+        \           \"tag\": \"farmland\"\n        }, \n        {\n            \"confidence\":
+        10.151697168209193, \n            \"tag\": \"fresh\"\n        }, \n        {\n
+        \           \"confidence\": 10.061411487391338, \n            \"tag\": \"park\"\n
+        \       }, \n        {\n            \"confidence\": 10.055026818532369, \n
+        \           \"tag\": \"flora\"\n        }, \n        {\n            \"confidence\":
+        9.471499129485952, \n            \"tag\": \"sunset\"\n        }, \n        {\n
+        \           \"confidence\": 9.435488194403247, \n            \"tag\": \"tranquil\"\n
+        \       }, \n        {\n            \"confidence\": 8.944498856145206, \n
+        \           \"tag\": \"travel\"\n        }, \n        {\n            \"confidence\":
+        8.836695582313878, \n            \"tag\": \"freedom\"\n        }, \n        {\n
+        \           \"confidence\": 8.68426390350368, \n            \"tag\": \"colorful\"\n
+        \       }, \n        {\n            \"confidence\": 8.358216968823195, \n
+        \           \"tag\": \"vibrant\"\n        }, \n        {\n            \"confidence\":
+        8.260337283211635, \n            \"tag\": \"idyllic\"\n        }, \n        {\n
+        \           \"confidence\": 8.182653073843216, \n            \"tag\": \"sunrise\"\n
+        \       }, \n        {\n            \"confidence\": 8.01481616674438, \n            \"tag\":
+        \"peaceful\"\n        }, \n        {\n            \"confidence\": 8.011175205099152,
+        \n            \"tag\": \"bright\"\n        }, \n        {\n            \"confidence\":
+        7.933190186126691, \n            \"tag\": \"color\"\n        }, \n        {\n
+        \           \"confidence\": 7.860003741597381, \n            \"tag\": \"yellow\"\n
+        \       }, \n        {\n            \"confidence\": 7.8105899950891775, \n
+        \           \"tag\": \"lea\"\n        }, \n        {\n            \"confidence\":
+        7.76446030144356, \n            \"tag\": \"heavens\"\n        }, \n        {\n
+        \           \"confidence\": 7.650482427445872, \n            \"tag\": \"vista\"\n
+        \       }\n    ]\n}\n"
+    http_version: 
+  recorded_at: Wed, 10 Dec 2014 02:42:04 GMT
+recorded_with: VCR 2.9.3

data/spec/imagga_auto_tag_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe "An Imagga Auto Tag API" do
+  
+  context "client" do
+
+    before(:each) do
+      @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'])
+    end
+
+    it "connects" do
+      VCR.use_cassette('image') do
+        expect {
+          results = @client.fetch("http://static.ddmcdn.com/gif/landscape-photography-1.jpg")
+        }.not_to raise_error
+      end
+    end
+
+  end
+
+  context "result" do
+    
+    before do
+      VCR.use_cassette('image') do
+        @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'])
+        @results = @client.fetch("http://static.ddmcdn.com/gif/landscape-photography-1.jpg")
+      end
+    end
+
+    it "returns a tagged image object" do
+      expect(@results).to be_an_instance_of(ImaggaAutoTag::TaggedImage)
+    end
+
+    it "has a status code" do
+      expect(@results.status).to be 200
+    end
+
+    it "has tags" do
+      expect(@results.tags[0]).to be_an_instance_of(ImaggaAutoTag::Tag)
+    end
+
+    it "has tags with a confidence and name" do
+      expect(@results.tags[0].name).to be_an_instance_of(String)
+      expect(@results.tags[0].confidence).to be_an_instance_of(Float)
+    end
+
+    it "drops tags under a certain threshold if scrubbed" do
+      number_of_tags = @results.tags.size
+
+      @results.scrub
+
+      expect(@results.tags.size).to be < number_of_tags
+    end
+
+    it "converts tags into a comma delimitted string" do
+      expect(@results.to_csv).to be_an_instance_of(String)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rspec'
+require 'imagga_auto_tag'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+end
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: imagga_auto_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Chesser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper around the Imagga Auto Tagging API
+email:
+- luke@unsplash.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- imagga_auto_tag.gemspec
+- lib/imagga_auto_tag.rb
+- lib/imagga_auto_tag/client.rb
+- lib/imagga_auto_tag/tag.rb
+- lib/imagga_auto_tag/tagged_image.rb
+- lib/imagga_auto_tag/version.rb
+- spec/cassettes/image.yml
+- spec/imagga_auto_tag_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lukechesser/imagga-auto-tag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Imagga Auto Tagging API client
+test_files:
+- spec/cassettes/image.yml
+- spec/imagga_auto_tag_spec.rb
+- spec/spec_helper.rb