character_recognition_by_vision_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d02b880bd9f86ac9e9c4c4a5b5640b90eebd968a
+  data.tar.gz: 2d25edd934172d75d35d1aca9ffd4c3b95df4afa
+SHA512:
+  metadata.gz: 9367ab1e607beb97142179f17e8e114e5ff87104d40990785f3f670ddcb6faaf04ae4ba4cf195ceaf273f98e3a41f836149e8eff8db337bf9de14eae12564bcd
+  data.tar.gz: ad7d4b08c1f7149e76258f406a3d8ac19c9569047357785666cb1498c3dd2aba3f867d0c8cf334575adea68b1554729035832239a9b8719cc2d2041c878344ef

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in character_recognition_by_vision_api.gemspec
+gemspec
+
+gem 'rest-client'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    character_recognition_by_vision_api (0.1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  character_recognition_by_vision_api!
+  rake (~> 10.0)
+  rest-client
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 corselia
+
+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,77 @@
+[![CircleCI](https://circleci.com/gh/corselia/character-recognition-by-vision-api/tree/master.svg?style=svg)](https://circleci.com/gh/corselia/character-recognition-by-vision-api/tree/master)
+
+# Overview
+- you get the characters as text format from the image file with characters
+    - first step
+        - you prepare the image file with characters (any language, of course Japanese too)
+        - you prepare the `API Key` of `Google Cloud Vision API`
+    - second step
+        - exec method in this gem
+    - third step
+        - you get the characters as text format :)
+
+# Installation
+```ruby
+$ gem install character_recognition_by_vision_api
+```
+
+# Usage
+
+#### 1. prepare the image file
+in this repository, I prepare [sample_image.png](spec/sample_image.png)
+
+![spec/sample_image.png](sample_image.png "sample_image.png")
+
+#### 2. prepare api_key of Google Cloud Vision API
+- the official site of Google Cloud Vision API is here
+    - [Vision API | Google Cloud Platform](https://cloud.google.com/vision/)
+- you acquire `API Key` at [Google Cloud Platform Service](https://console.cloud.google.com/)
+    - the detail of procedure is omitted on this document
+    - the blue part of below image contains `API Key`
+
+![api_key](api_key.png "api_key.png")
+
+#### 3. require gem
+```ruby
+require 'character_recognition_by_vision_api'
+```
+
+#### 4. exec method
+```ruby
+CharacterRecognitionByVisionApi.(image_file, api_key)
+```
+
+#### 5. return the characters as text format
+- 🎉you get the characters as text format🎉
+
+# Example
+
+#### when the image file is below
+
+![sample_image](sample_image.png "spec/sample_image.png")
+
+#### the result is here
+
+```
+あいうえおかきくけこさしすせそた
+ちってとなにぬねのはひふへぼまみ
+むめもやゆよらりる丸ろわをんーゑ
+H本語表示サンプJ 1 2 3 4 5 60
+ABCDE FGHIJKLMNOP
+```
+
+- looks alomst good :)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/character_recognition_by_vision_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "character_recognition_by_vision_api"
+
+# 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(__FILE__)

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/character_recognition_by_vision_api.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "character_recognition_by_vision_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "character_recognition_by_vision_api"
+  spec.version       = CharacterRecognitionByVisionApi::VERSION
+  spec.authors       = ["Osamu Takiya"]
+  spec.email         = ["takiya@toran.sakura.ne.jp"]
+
+  spec.summary       = %q{Recognize characters in image file by Vision API}
+  spec.description   = %q{With Google Vision API, you can extract the characters by text format from image file}
+  spec.homepage      = "https://github.com/corselia/character-recognition-by-vision-api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'rest-client'
+end

data/lib/character_recognition_by_vision_api.rb

@@ -0,0 +1,54 @@
+require "character_recognition_by_vision_api/version"
+require 'rest-client'
+require 'base64'
+require 'json'
+
+module CharacterRecognitionByVisionApi
+  extend self
+
+  def extract_to_text(image_file, api_key)
+    JSON.parse(response_json(image_file, api_key))['responses'][0]['fullTextAnnotation']['text']
+  end
+
+  def payload(image_file)
+    {
+      requests: [
+        {
+          image:
+            {
+              content: Base64.encode64(open(image_file).read)
+            },
+          features: [
+            {
+              type: "TEXT_DETECTION",
+              maxResults: 10,
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  def headers_for_post
+    {
+      'Content-Type': 'application/json',
+    }
+  end
+
+  def request_uri(api_key)
+    "https://vision.googleapis.com/v1/images:annotate?key=#{api_key}"
+  end
+
+  def response_json(image_file, api_key)
+    begin
+      RestClient.post(
+        request_uri(api_key),
+        payload(image_file).to_json,
+        headers_for_post,
+      )
+    rescue => e
+      puts e
+      exit(1)
+    end
+  end
+end

data/lib/character_recognition_by_vision_api/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: character_recognition_by_vision_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Osamu Takiya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: With Google Vision API, you can extract the characters by text format
+  from image file
+email:
+- takiya@toran.sakura.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- api_key.png
+- bin/console
+- bin/setup
+- character_recognition_by_vision_api.gemspec
+- lib/character_recognition_by_vision_api.rb
+- lib/character_recognition_by_vision_api/version.rb
+homepage: https://github.com/corselia/character-recognition-by-vision-api
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Recognize characters in image file by Vision API
+test_files: []