microsoft_computer_vision 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 067e72acf9cf7d4c5fb3f98c92bbf2ae79033509
+  data.tar.gz: e5e9f064142d80e9990c665b52317986e2e194a6
+SHA512:
+  metadata.gz: 7c9f9811427d7d5137b243636dd15286bf0ff8eeeb6b4f847acb9e6dc9718a6e083173b8276f1ca380919188b758034a25281eb105af287a0e957a305f368036
+  data.tar.gz: 11de3dd934a44ea1286b444b5a35d1e29ae5d36954bdfdb665bafa8c817ce1c9d2c06f03d6994a4d56c2675ed1165e3004a81af0b99e264f807e9cca4934b787

data/.gitignore

@@ -0,0 +1,16 @@
+.idea/
+microsoft_computer_vision.iml
+.DS_Store
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+*.gem
+
+example/thumbnail_from_image_file.jpg
+example/thumbnail_from_image_url.jpg

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# Microsoft Computer Vision API
+
+This is a very basic wrapper for the [Microsoft Computer Vision API](https://www.microsoft.com/cognitive-services/en-us/computer-vision-api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'microsoft_computer_vision'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install microsoft_computer_vision 
+```
+    
+## Usage
+
+```ruby
+require 'microsoft_computer_vision'
+
+client = MicrosoftComputerVision::Client.new('your_subscription_key')
+options = {
+  visual_features: 'Faces',
+  details: 'Celebrities'
+}
+
+res = client.analyze_image_url('http://example.com/images/test.jpg', options)
+puts res.body
+```
+
+Please see [example](https://github.com/henteko/microsoft_computer_vision/tree/master/example).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/henteko/microsoft_computer_vision.
+
+
+## License
+
+[MIT License](http://www.opensource.org/licenses/MIT)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'microsoft_computer_vision'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/all.rb

@@ -0,0 +1,152 @@
+require 'microsoft_computer_vision'
+require 'json'
+
+subscription_key = ENV['SUBSCRIPTION_KEY']
+@client = MicrosoftComputerVision::Client.new(subscription_key)
+IMAGE_URL = 'https://www.pakutaso.com/shared/img/thumb/PAK105215431_TP_V.jpg'
+
+def file_open
+  File.open(File.expand_path('../test.jpg', __FILE__)) do |image_file|
+    yield(image_file)
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fa
+def analyze
+  puts 'Analyze'
+
+  options = {
+      visual_features: 'Faces', # [Categories, Tags, Description, Faces, ImageType, Color, Adult]
+      details: 'Celebrities' # [Celebrities]
+  }
+
+  # image url
+  res = @client.analyze_image_url(IMAGE_URL, options)
+  puts res.body
+
+  # image file
+  file_open do |image_file|
+    res = @client.analyze_image_file(image_file.read, options)
+    puts res.body
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fe
+def describe
+  puts 'Describe'
+
+  options = {
+      max_candidates: '1'
+  }
+
+  # image url
+  res = @client.describe_image_url(IMAGE_URL, options)
+  puts res.body
+
+  # image file
+  file_open do |image_file|
+    res = @client.describe_image_file(image_file.read, options)
+    puts res.body
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fb
+def thumbnail
+  puts 'Thumbnail'
+
+  options = {
+      width: 400,
+      height: 400,
+      smart_cropping: true
+  }
+
+  # image url
+  res = @client.thumbnail_image_url(IMAGE_URL, options)
+  out = File.expand_path('../thumbnail_from_image_url.jpg', __FILE__)
+  File.write out, res.body
+  puts "Created #{out}"
+
+  # image file
+  file_open do |image_file|
+    out = File.expand_path('../thumbnail_from_image_file.jpg', __FILE__)
+
+    res = @client.thumbnail_image_file(image_file.read, options)
+    File.write out, res.body
+    puts "Created #{out}"
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fd
+def domain_models
+  puts 'Domain Models'
+
+  res = @client.domain_models
+  puts res.body
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fc
+def ocr
+  puts 'OCR'
+
+  options = {
+      language: 'ja',
+      detect_orientation: true
+  }
+
+  # image url
+  res = @client.ocr_image_url(IMAGE_URL, options)
+  puts res.body
+
+  # image file
+  file_open do |image_file|
+    res = @client.ocr_image_file(image_file.read, options)
+    puts res.body
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e200
+def domain_model
+  puts 'DomainModel'
+
+  res = @client.domain_models
+  models = JSON.parse(res.body)['models']
+
+  model = models[0]['name']
+  puts "model: #{model}"
+  options = {
+      model: model
+  }
+
+  # image url
+  res = @client.domain_model_image_url(IMAGE_URL, options)
+  puts res.body
+
+  # image file
+  file_open do |image_file|
+    res = @client.domain_model_image_file(image_file.read, options)
+    puts res.body
+  end
+end
+
+# See: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1ff
+def tag
+  puts 'Tag'
+
+  # image url
+  res = @client.tag_image_url(IMAGE_URL)
+  puts res.body
+
+  # image file
+  file_open do |image_file|
+    res = @client.tag_image_file(image_file.read)
+    puts res.body
+  end
+end
+
+analyze
+describe
+thumbnail
+domain_models
+ocr
+domain_model
+tag

data/lib/microsoft_computer_vision.rb

@@ -0,0 +1,16 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module MicrosoftComputerVision
+end
+
+require 'microsoft_computer_vision/version'
+require 'microsoft_computer_vision/client'
+require 'microsoft_computer_vision/api/analyze'
+require 'microsoft_computer_vision/api/describe'
+require 'microsoft_computer_vision/api/thumbnail'
+require 'microsoft_computer_vision/api/domain_model'
+require 'microsoft_computer_vision/api/domain_models'
+require 'microsoft_computer_vision/api/ocr'
+require 'microsoft_computer_vision/api/tag'

data/lib/microsoft_computer_vision/api/analyze.rb

@@ -0,0 +1,26 @@
+module MicrosoftComputerVision::Api
+  class Analyze
+
+    ENDPOINT = '/analyze'
+
+    def initialize(visual_features, details)
+      @visual_features = visual_features
+      @details = details
+    end
+
+    def uri
+      uri = URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+      uri.query = URI.encode_www_form(params)
+
+      uri
+    end
+
+    def params
+      data = {}
+      data[:visualFeatures] = @visual_features if @visual_features
+      data[:details] = @details if @details
+
+      data
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/describe.rb

@@ -0,0 +1,24 @@
+module MicrosoftComputerVision::Api
+  class Describe
+
+    ENDPOINT = '/describe'
+
+    def initialize(max_candidates)
+      @max_candidates = max_candidates
+    end
+
+    def uri
+      uri = URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+      uri.query = URI.encode_www_form(params)
+
+      uri
+    end
+
+    def params
+      data = {}
+      data[:maxCandidates] = @max_candidates if @max_candidates
+
+      data
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/domain_model.rb

@@ -0,0 +1,14 @@
+module MicrosoftComputerVision::Api
+  class DomainModel
+
+    ENDPOINT = '/models'
+
+    def initialize(model)
+      @model = model
+    end
+
+    def uri
+      URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}/#{@model}/analyze")
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/domain_models.rb

@@ -0,0 +1,10 @@
+module MicrosoftComputerVision::Api
+  class DomainModels
+
+    ENDPOINT = '/models'
+
+    def uri
+      URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/ocr.rb

@@ -0,0 +1,26 @@
+module MicrosoftComputerVision::Api
+  class OCR
+
+    ENDPOINT = '/ocr'
+
+    def initialize(language, detect_orientation)
+      @language = language
+      @detect_orientation = detect_orientation
+    end
+
+    def uri
+      uri = URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+      uri.query = URI.encode_www_form(params)
+
+      uri
+    end
+
+    def params
+      data = {}
+      data[:language] = @language if @language
+      data[:detectOrientation] = @detect_orientation if @detect_orientation
+
+      data
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/tag.rb

@@ -0,0 +1,10 @@
+module MicrosoftComputerVision::Api
+  class Tag
+
+    ENDPOINT = '/tag'
+
+    def uri
+      URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+    end
+  end
+end

data/lib/microsoft_computer_vision/api/thumbnail.rb

@@ -0,0 +1,28 @@
+module MicrosoftComputerVision::Api
+  class Thumbnail
+
+    ENDPOINT = '/generateThumbnail'
+
+    def initialize(width, height, smart_cropping)
+      @width = width
+      @height = height
+      @smart_cropping = smart_cropping
+    end
+
+    def uri
+      uri = URI("#{MicrosoftComputerVision::Client::API_BASE}#{ENDPOINT}")
+      uri.query = URI.encode_www_form(params)
+
+      uri
+    end
+
+    def params
+      data = {}
+      data[:width] = @width if @width
+      data[:height] = @height if @height
+      data[:smartCropping] = @smart_cropping if @smart_cropping
+
+      data
+    end
+  end
+end

data/lib/microsoft_computer_vision/client.rb

@@ -0,0 +1,142 @@
+module MicrosoftComputerVision
+  class Client
+
+    API_BASE = 'https://api.projectoxford.ai/vision/v1.0'
+
+    def initialize(subscription_key)
+      @subscription_key = subscription_key
+    end
+
+    ###############################################################################################################
+    # Analyze
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fa
+    ###############################################################################################################
+
+    def analyze_image_url(image_url, options)
+      analyze = Api::Analyze.new(options[:visual_features], options[:details])
+      post_image_url(analyze.uri, image_url)
+    end
+
+    def analyze_image_file(image_file, options)
+      analyze = Api::Analyze.new(options[:visual_features], options[:details])
+      post_image_file(analyze.uri, image_file)
+    end
+
+    ###############################################################################################################
+    # Describe
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fe
+    ###############################################################################################################
+
+    def describe_image_url(image_url, options)
+      describe = Api::Describe.new(options[:max_candidates])
+      post_image_url(describe.uri, image_url)
+    end
+
+    def describe_image_file(image_file, options)
+      describe = Api::Describe.new(options[:max_candidates])
+      post_image_file(describe.uri, image_file)
+    end
+
+    ###############################################################################################################
+    # Thumbnail
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fb
+    ###############################################################################################################
+
+    def thumbnail_image_url(image_url, options)
+      thumbnail = Api::Thumbnail.new(options[:width], options[:height], options[:smart_cropping])
+      post_image_url(thumbnail.uri, image_url)
+    end
+
+    def thumbnail_image_file(image_file, options)
+      thumbnail = Api::Thumbnail.new(options[:width], options[:height], options[:smart_cropping])
+      post_image_file(thumbnail.uri, image_file)
+    end
+
+    ###############################################################################################################
+    # Domain Models
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fd
+    ###############################################################################################################
+
+    def domain_models
+      domain_models = Api::DomainModels.new()
+      get(domain_models.uri, {}.to_json)
+    end
+
+    ###############################################################################################################
+    # Domain Model
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e200
+    ###############################################################################################################
+
+    def domain_model_image_url(image_url, options)
+      domain_model = Api::DomainModel.new(options[:model])
+      post_image_url(domain_model.uri, image_url)
+    end
+
+    def domain_model_image_file(image_file, options)
+      domain_model = Api::DomainModel.new(options[:model])
+      post_image_file(domain_model.uri, image_file)
+    end
+
+    ###############################################################################################################
+    # OCR
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fc
+    ###############################################################################################################
+
+    def ocr_image_url(image_url, options)
+      ocr = Api::OCR.new(options[:language], options[:detect_orientation])
+      post_image_url(ocr.uri, image_url)
+    end
+
+    def ocr_image_file(image_file, options)
+      ocr = Api::OCR.new(options[:language], options[:detect_orientation])
+      post_image_file(ocr.uri, image_file)
+    end
+
+    ###############################################################################################################
+    # Tag
+    # Docs: https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1ff
+    ###############################################################################################################
+
+    def tag_image_url(image_url)
+      tag = Api::Tag.new()
+      post_image_url(tag.uri, image_url)
+    end
+
+    def tag_image_file(image_file)
+      tag = Api::Tag.new()
+      post_image_file(tag.uri, image_file)
+    end
+
+    private
+
+    def get(uri, body)
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      start(uri, body, request)
+    end
+
+    def post_image_file(uri, image_file)
+      post(uri, 'application/octet-stream', image_file)
+    end
+
+    def post_image_url(uri, image_url)
+      post(uri, 'application/json', {url: image_url}.to_json)
+    end
+
+    def post(uri, content_type, body)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Content-Type'] = content_type
+
+      start(uri, body, request)
+    end
+
+    def start(uri, body, request)
+      request['Ocp-Apim-Subscription-Key'] = @subscription_key
+      request.body = body
+
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/microsoft_computer_vision/version.rb

@@ -0,0 +1,3 @@
+module MicrosoftComputerVision
+  VERSION = '0.1.0'
+end

data/microsoft_computer_vision.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microsoft_computer_vision/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'microsoft_computer_vision'
+  spec.version       = MicrosoftComputerVision::VERSION
+  spec.authors       = ['henteko']
+  spec.email         = ['henteko07@gmail.com']
+
+  spec.summary       = 'This is a very basic wrapper for the Microsoft Computer Vision API.'
+  spec.description   = 'This is a very basic wrapper for the Microsoft Computer Vision API.'
+  spec.homepage      = 'https://github.com/henteko/microsoft_computer_vision'
+
+  spec.files         = `git ls-files`.split($/).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.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: microsoft_computer_vision
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- henteko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: This is a very basic wrapper for the Microsoft Computer Vision API.
+email:
+- henteko07@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/all.rb
+- example/test.jpg
+- lib/microsoft_computer_vision.rb
+- lib/microsoft_computer_vision/api/analyze.rb
+- lib/microsoft_computer_vision/api/describe.rb
+- lib/microsoft_computer_vision/api/domain_model.rb
+- lib/microsoft_computer_vision/api/domain_models.rb
+- lib/microsoft_computer_vision/api/ocr.rb
+- lib/microsoft_computer_vision/api/tag.rb
+- lib/microsoft_computer_vision/api/thumbnail.rb
+- lib/microsoft_computer_vision/client.rb
+- lib/microsoft_computer_vision/version.rb
+- microsoft_computer_vision.gemspec
+homepage: https://github.com/henteko/microsoft_computer_vision
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: This is a very basic wrapper for the Microsoft Computer Vision API.
+test_files: []