docomo_image_recognition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef826684f40faddb76c2a6bce951e932e471fd9b
+  data.tar.gz: 118d6694e146b0dff2717d4b7128c3c278fe399e
+SHA512:
+  metadata.gz: b76d2a6f82173bcdd303e50a1e5453241d2c13b3f967825d1436defdd32cd2df429f2cc5fac821bf7a1ec2d50f74c3ef13f9ab45e89de3161b5a26c61247a557
+  data.tar.gz: 8d07e368d0af6127c6cf1c0f3de72d2d8db2f5d8f556f1a78fc568a8b52944c12eee385fd0f27e28024202ba08d1113c04593f02cf4f5fe231384c81886c9317

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Claude Tech
+
+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,35 @@
+# Docomo Image Recognition
+
+Ruby SDK for Docomo recognition API.
+https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=105
+
+## Installation
+
+Add 
+
+```
+gem 'docomo_image_recognition'
+```
+
+to your Gemfile or install it manually with
+
+```sh
+$ gem install docomo_image_recognition
+```
+
+## Usage
+
+To use this API, you first need to get an API key from [Docomo developer page](https://dev.smt.docomo.ne.jp/?p=login).
+
+Then, you can use it the following way:
+
+```ruby
+API_KEY = 'api you just got'
+client = DocomoImageRecognition::Client.new(API_KEY)
+client.recognize_from_url('http://the_url_you_want_to_anlayze.com/image.jpg')
+client.recognize_from_file('/path/to/file/to/analyze.jpg')
+```
+
+Both method return the response in JSON format.
+
+If an error occurs, a `DocomoImageRecognition::ApiError` is thrown.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CdnTags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/docomo_image_recognition/client.rb

@@ -0,0 +1,55 @@
+module DocomoImageRecognition
+  class Client
+    def initialize(api_key)
+      base_url = DocomoImageRecognition.configuration.base_url
+      @base_url = base_url + "?APIKEY=#{api_key}"
+    end
+
+    def recognize(data, options = default_options)
+      url = "#{@base_url}&#{to_query(options)}"
+      curl = Curl::Easy.new(url)
+      curl.headers['Content-Type'] = 'application/octet-stream'
+      curl.post_body = data
+      curl.http_post
+      body = JSON.parse(curl.body_str)
+      raise_on_error!(body, curl.status)
+      body
+    end
+
+    def recognize_from_file(path, options = default_options)
+      data = File.read(path)
+      recognize(data, options)
+    end
+
+    def recognize_from_url(url, options = default_options)
+      data = download_file(url)
+      recognize(data, options)
+    end
+
+    private
+
+    def download_file(url)
+      uri = URI(url)
+      Net::HTTP.get(uri)
+    end
+
+    def default_options
+      { recog: 'product-all', numOfCandidates: 10 }
+    end
+
+    def to_query(options)
+      options
+        .reject { |_k, v| v.nil? }
+        .map { |k, v| k.to_s + '=' + v.to_s }
+        .join('&')
+    end
+
+    def raise_on_error!(body, status)
+      case status.split(' ')[0].to_i
+      when 200 then return
+      when 401 then fail 'not authorized', ApiError.new(body)
+      when 400 then fail 'bad request', ApiError.new(body)
+      end
+    end
+  end
+end

data/lib/docomo_image_recognition/configuration.rb

@@ -0,0 +1,9 @@
+module DocomoImageRecognition
+  class Configuration
+    attr_accessor :base_url
+
+    def initialize
+      self.base_url = 'https://api.apigw.smt.docomo.ne.jp/imageRecognition/v1/recognize'
+    end
+  end
+end

data/lib/docomo_image_recognition/error.rb

@@ -0,0 +1,14 @@
+module DocomoImageRecognition
+  class Error < StandardError
+  end
+
+  class DownloadError < Error
+  end
+
+  class ApiError < Error
+    attr_reader :body
+    def initialize(body)
+      @body = body
+    end
+  end
+end

data/lib/docomo_image_recognition/version.rb

@@ -0,0 +1,6 @@
+module DocomoImageRecognition
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+end

data/lib/docomo_image_recognition.rb

@@ -0,0 +1,17 @@
+require 'curb'
+require 'net/http'
+require 'json'
+
+%w(error configuration client).each do |m|
+  require File.join(File.dirname(__FILE__), 'docomo_image_recognition', m)
+end
+
+module DocomoImageRecognition
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: docomo_image_recognition
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Perez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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'
+description: 
+email:
+- daniel@claudetech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/docomo_image_recognition.rb
+- lib/docomo_image_recognition/client.rb
+- lib/docomo_image_recognition/configuration.rb
+- lib/docomo_image_recognition/error.rb
+- lib/docomo_image_recognition/version.rb
+homepage: https://github.com/HackathonMonster/docomo-image-recognition
+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: SDK for Docomo image recognition API
+test_files: []