multitagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86e88fd337cbe596e5ca06bb9647668379fa2a09
+  data.tar.gz: bd4da909ba31732c3ea47eb975cae94376740495
+SHA512:
+  metadata.gz: 21ebe5d9bc3cd80a83e7fcd22fc0a1daee6ee773b20a0108f3496e4454f1539abdeeb24226891fd83d05cb72a18fa8e1149244e1aa669a34d05f02fefaf57715
+  data.tar.gz: 35d25c29bffb4b6c85a86297961733e610044a809ffebd34b6f80b457596fb1e1275f253d8cbb30347e1aa9fb630aa31d00165e830dedf7e25df44a28fce2e89

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/config/multitagger.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dj@danieljanus.pl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rebased
+
+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,87 @@
+# Multitagger
+
+Multitagger offers a unified API for automatic image tagging services. With Multitagger, you can start developing your image-recognizing app and have
+the comfort of changing your provider without rewriting the code, or even
+use multiple providers at once. See the [blog post] for background.
+
+Multitagger currently supports five providers:
+
+ - [Algorithmia Illustration Tagger]
+ - [Clarifai]
+ - [Google Cloud Vision]
+ - [Imagga]
+ - [Microsoft Cognitive Services]
+
+ [Algorithmia Illustration Tagger]: https://algorithmia.com/algorithms/deeplearning/IllustrationTagger
+ [Clarifai]: https://www.clarifai.com/
+ [Google Cloud Vision]: https://cloud.google.com/vision/
+ [Microsoft Cognitive Services]: https://www.microsoft.com/cognitive-services
+ [Imagga]: https://imagga.com
+ [blog post]: https://blog.rebased.pl/2016/10/04/computer-vision-1.html
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'multitagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multitagger
+
+## Usage
+
+The simplest way to use Multitagger is to just do:
+
+```ruby
+tags = Multitagger.tag(:google, "/path/to/your/image.jpg")
+```
+
+Where the first argument tells Multitagger to use Google Cloud Vision as the tagging service, and the second designates a local path to your image.
+
+This will return an array of `Multitagger::Tag` structures, each of which has `name` (a string) and `prob` (a number from 0.0 to 1.0 representing the probability that this tag fits the image). See the file `multitagger/tag.rb`.
+
+To use another provider, just replace the first argument. `Multitagger.providers` will tell you what providers are available.
+
+You can also instantiate the tagging service and then call the `tag` method on that:
+
+```ruby
+tagger = Multitagger.tagger(:google)
+tags = tagger.tag("/path/to/your/image.jpg")
+```
+
+## Configuration
+
+Before you can use Multitagger, you must configure it. This is commonly done by putting your service’s credentials in `config/multitagger.yml`.
+
+You need obtain the credentials (typically an API key, an app ID, a secret, or a combination of these, depending on the service) separately for each service you plan on using, by registering with the service.
+
+You’ll find a sample `multitagger.yml` in the `config/` directory in this repo; substitute the keys as needed.
+
+If you need to put this file elsewhere, call this before invoking tagging:
+
+```ruby
+Multitagger::Config.read("/path/to/your/multitagger.yml")
+```
+
+Alternatively, you can pass the configuration hash as a second argument to `Multitagger.tagger`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rebased/multitagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multitagger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/multitagger.yml.example

@@ -0,0 +1,13 @@
+google:
+  project: my_google_project
+  keyfile: my_google_project.json
+microsoft:
+  key: my_microsoft_api_key
+clarifai:
+  id: my_clarifai_app_id
+  secret: my_clarifai_app_secret
+algorithmia:
+  key: my_algorithmia_api_key
+imagga:
+  key: my_imagga_api_key
+  secret: my_imagga_api_secret

data/lib/multitagger.rb

@@ -0,0 +1,21 @@
+require "multitagger/version"
+require "multitagger/tag"
+require "multitagger/config"
+
+Dir[File.dirname(__FILE__) + '/multitagger/provider/*.rb'].each {|file| require file }
+
+module Multitagger
+  def self.tagger(provider, config = nil)
+    clazz = Provider.const_get(provider.to_s.capitalize)
+    config ||= Config.read[provider.to_s]
+    clazz.new(config)
+  end
+
+  def self.providers
+    Provider.constants.select { |c| Provider.const_get(c).is_a? Class }.map(&:downcase)
+  end
+
+  def self.tag(provider, image)
+    self.tagger(provider).tag(image)
+  end
+end

data/lib/multitagger/config.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module Multitagger
+  class Config
+    def self.read(path = "config/multitagger.yml")
+      @@config ||= YAML.load_file(path)
+    end
+  end
+end

data/lib/multitagger/provider/algorithmia.rb

@@ -0,0 +1,19 @@
+require 'algorithmia'
+
+module Multitagger
+  module Provider
+    class Algorithmia
+      def initialize(config)
+        @client = ::Algorithmia.client(config["key"])
+      end
+
+      def tag(image)
+        algo = @client.algo("deeplearning/IllustrationTagger/0.2.3")
+        image_data = Base64.encode64(File.open(image, "rb").read)
+        input = { "image" => "data:image/jpeg;base64,#{image_data}" }
+        result = algo.pipe(input).result
+        result["general"].map { |x| Tag.new(x.keys.first, x.values.first) }
+      end
+    end
+  end
+end

data/lib/multitagger/provider/clarifai.rb

@@ -0,0 +1,39 @@
+require 'clarifai_ruby'
+require 'base64'
+
+module ClarifaiRuby
+  class MyTagRequest < TagRequest
+    def get(image_url_or_path, opts = {})
+      if image_url_or_path =~ URI::regexp
+        super
+      else
+        body = {
+          encoded_data: File.new(image_url_or_path),
+          model: opts[:model]
+        }
+        build_request!(body, opts)
+        @raw_response = @client.post(TAG_PATH, body).parsed_response
+        raise RequestError.new @raw_response["status_msg"] if @raw_response["status_code"] != "OK"
+        TagResponse.new(raw_response)
+      end
+    end
+  end
+end
+
+module Multitagger
+  module Provider
+    class Clarifai
+      def initialize(our_config)
+        ClarifaiRuby.configure do |config|
+          config.client_id = our_config["id"]
+          config.client_secret = our_config["secret"]
+        end
+      end
+
+      def tag(image)
+        response = ClarifaiRuby::MyTagRequest.new.get(image)
+        response.tag_images.first.tags.map { |x| Tag.new(x.word, x.prob) }
+      end
+    end
+  end
+end

data/lib/multitagger/provider/google.rb

@@ -0,0 +1,16 @@
+require 'google/cloud'
+
+module Multitagger
+  module Provider
+    class Google
+      def initialize(config)
+        @vision = ::Google::Cloud.vision(config["project"], config["keyfile"])
+      end
+
+      def tag(image)
+        img = @vision.image(image)
+        img.labels.map { |x| Tag.new(x.description, x.score) }
+      end
+    end
+  end
+end

data/lib/multitagger/provider/imagga.rb

@@ -0,0 +1,26 @@
+require 'rest_client'
+
+module Multitagger
+  module Provider
+    class Imagga
+      def initialize(config)
+        @key = config["key"]
+        @secret = config["secret"]
+      end
+
+      def tag(image)
+        auth = 'Basic ' + Base64.strict_encode64("#{@key}:#{@secret}").chomp
+        image_response_raw = RestClient.post "https://api.imagga.com/v1/content",
+                                             { image: File.new(image, 'rb') },
+                                             { Authorization: auth }
+        image_response = JSON.parse image_response_raw
+        image_id = image_response["uploaded"].first["id"]
+        tag_response_raw = RestClient.get "https://api.imagga.com/v1/tagging?content=#{image_id}",
+                                          { Authorization: auth }
+        tag_response = JSON.parse tag_response_raw
+        tags = tag_response["results"].first["tags"].map { |x| [ x["tag"], x["confidence"] ] }
+        tags.map { |x| Tag.new(x.first, x.last / tags.first.last) }
+      end
+    end
+  end
+end

data/lib/multitagger/provider/microsoft.rb

@@ -0,0 +1,18 @@
+require 'microsoft_computer_vision'
+require 'json'
+
+module Multitagger
+  module Provider
+    class Microsoft
+      def initialize(config)
+        @client = MicrosoftComputerVision::Client.new(config["key"])
+      end
+
+      def tag(image)
+        result = @client.analyze image, {visual_features: "Tags"}
+        data = JSON.parse result.body
+        data["tags"].map { |x| Tag.new(x["name"], x["confidence"]) }
+      end
+    end
+  end
+end

data/lib/multitagger/tag.rb

@@ -0,0 +1,3 @@
+module Multitagger
+  Tag = Struct.new(:name, :prob)
+end

data/lib/multitagger/version.rb

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

data/lib/test.rb

@@ -0,0 +1,3 @@
+require 'multitagger'
+
+puts Multitagger.tagger(:clarifai).tag("/tmp/cat.jpg")

data/multitagger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multitagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multitagger"
+  spec.version       = Multitagger::VERSION
+  spec.authors       = ["Daniel Janus"]
+  spec.email         = ["daniel.janus@rebased.com"]
+
+  spec.summary       = %q{Tag images using multiple computer vision API providers}
+  spec.homepage      = "https://github.com/rebased/multitagger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "clarifai_ruby", "~> 0.1.2"
+  spec.add_runtime_dependency "algorithmia", "~> 0.9.4"
+  spec.add_runtime_dependency "rest-client", "~> 2.0.0"
+  spec.add_runtime_dependency "google-cloud", "~> 0.20.0"
+  spec.add_runtime_dependency "microsoft_computer_vision", "~> 0.2.0"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: multitagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Janus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: clarifai_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: algorithmia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: google-cloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: microsoft_computer_vision
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- daniel.janus@rebased.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/multitagger.yml.example
+- lib/multitagger.rb
+- lib/multitagger/config.rb
+- lib/multitagger/provider/algorithmia.rb
+- lib/multitagger/provider/clarifai.rb
+- lib/multitagger/provider/google.rb
+- lib/multitagger/provider/imagga.rb
+- lib/multitagger/provider/microsoft.rb
+- lib/multitagger/tag.rb
+- lib/multitagger/version.rb
+- lib/test.rb
+- multitagger.gemspec
+homepage: https://github.com/rebased/multitagger
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Tag images using multiple computer vision API providers
+test_files: []