Merge pull request #50 from GoogleCloudPlatform/vision

remi Taylor · web-flow · commit cd9eae4b0956 · 2016-09-06T13:28:07.000-07:00
Ruby Sample for Google Cloud Vision API
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -76,6 +76,15 @@ Performance/RedundantBlockCall:
 Style/EmptyLinesAroundBlockBody:
   Enabled: false
 
+# Allow any level of comment indentation for documentation region tag comments
+Style/CommentIndentation:
+  Enabled: false
+
+# Methods in this repository are often used to wrap code snippets
+# These snippets may be long, so the method length cop is disabled
+Style/MethodLength:
+  Enabled: false
+
 Style/NumericLiterals:
   Enabled: false
 Style/SpaceAroundOperators:
@@ -109,4 +118,4 @@ Style/DotPosition:
 Style/WordArray:
   MinSize: 4
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
diff --git a/.travis.yml b/.travis.yml
@@ -39,6 +39,7 @@ env:
   - TEST_DIR=translate
   - TEST_DIR=language
   - TEST_DIR=appengine/endpoints
+  - TEST_DIR=vision
 
 before_install:
 - openssl aes-256-cbc -K $encrypted_aeb4e2af7332_key -iv $encrypted_aeb4e2af7332_iv
diff --git a/vision/.rspec b/vision/.rspec
@@ -0,0 +1 @@
+--tty --color --format documentation --order random
diff --git a/vision/Gemfile b/vision/Gemfile
@@ -0,0 +1,25 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+source "https://rubygems.org"
+
+gem "google-cloud-vision"
+gem "rmagick"
+
+group :test do
+  gem "rake"
+  gem "rubocop"
+  gem "rspec"
+  gem "rack-test"
+end
diff --git a/vision/Gemfile.lock b/vision/Gemfile.lock
@@ -0,0 +1,96 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.9.13)
+      addressable (~> 2.3)
+      googleauth (~> 0.5)
+      httpclient (~> 2.7)
+      hurley (~> 0.1)
+      memoist (~> 0.11)
+      mime-types (>= 1.6)
+      representable (~> 2.3.0)
+      retriable (~> 2.0)
+    google-cloud-core (0.20.1)
+    google-cloud-vision (0.20.0)
+      google-api-client (~> 0.9.11)
+      google-cloud-core (~> 0.20.0)
+    googleauth (0.5.1)
+      faraday (~> 0.9)
+      jwt (~> 1.4)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    httpclient (2.8.2.3)
+    hurley (0.2)
+    jwt (1.5.4)
+    little-plugger (1.1.4)
+    logging (2.1.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    memoist (0.15.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    os (0.9.6)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    representable (2.3.0)
+      uber (~> 0.0.7)
+    retriable (2.1.0)
+    rmagick (2.16.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    signet (0.7.3)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (~> 1.5)
+      multi_json (~> 1.10)
+    uber (0.0.15)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  google-cloud-vision
+  rack-test
+  rake
+  rmagick
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.12.5
diff --git a/vision/README.md b/vision/README.md
@@ -0,0 +1,35 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Vision API Ruby Samples
+
+The [Cloud Vision API][vision_docs] allows developers to easily integrate vision
+detection features within applications, including image labeling, face and
+landmark detection, optical character recognition (OCR), and tagging of explicit
+content.
+
+[vision_docs]: https://cloud.google.com/vision/docs/
+
+## Run sample
+
+To run the sample, first install dependencies:
+
+    bundle install
+
+Run the sample:
+
+    bundle exec ruby vision_samples.rb
+
+Usage:
+
+    Usage: ruby vision_samples.rb <command> [arguments]
+
+    Commands:
+      labels   <image-path>
+      landmark <image-path>
+      faces    <image-path> <output-image-path>
+
+Example:
+
+    ruby vision_samples.rb labels   /path/to/cat.jpg
+    ruby vision_samples.rb landmark /path/to/grand-canyon.jpg
+    ruby vision_samples.rb faces    /path/to/faces.jpg output-image.jpg
diff --git a/vision/Rakefile b/vision/Rakefile
@@ -0,0 +1,21 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: :spec
diff --git a/vision/detect.rb b/vision/detect.rb
@@ -0,0 +1,36 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in write, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "label_detection"
+require_relative "landmark_detection"
+require_relative "face_detection"
+
+detection_type      = ARGV.shift
+path_to_image_file  = ARGV.shift
+path_to_output_file = ARGV.shift
+
+case detection_type
+when "label"
+  detect_labels path_to_image_file
+when "landmark"
+  detect_landmark path_to_image_file
+when "faces"
+  detect_faces path_to_image_file, path_to_output_file
+else
+  puts "Usage: detect.rb [type] [image path] [output path]"
+  puts
+  puts "       detect.rb label     /path/to/image.jpg"
+  puts "       detect.rb landmark  /path/to/image.jpg"
+  puts "       detect.rb faces     /path/to/image.jpg  /path/to/output.jpg"
+end
diff --git a/vision/images/cat.jpg b/vision/images/cat.jpg
diff --git a/vision/images/eiffel_tower.jpg b/vision/images/eiffel_tower.jpg
diff --git a/vision/images/face.png b/vision/images/face.png
diff --git a/vision/spec/vision_samples_spec.rb b/vision/spec/vision_samples_spec.rb
@@ -0,0 +1,78 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "../vision_samples"
+require "rspec"
+require "tempfile"
+
+describe "Vision sample" do
+
+  # Returns full path to sample image included in repository for testing
+  def image_path filename
+    File.expand_path "../images/#{filename}", __dir__
+  end
+
+  # Capture and return STDOUT output by block
+  def capture &block
+    real_stdout = $stdout
+    $stdout = StringIO.new
+    block.call
+    @captured_output = $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
+  attr_reader :captured_output
+
+# cat.jpg
+# eiffel_tower.jpg
+# face.png
+
+  example "detect labels" do
+    capture { detect_labels path_to_image_file: image_path("cat.jpg") }
+
+    expect(captured_output).to start_with "Image labels:"
+    expect(captured_output).to include "cat"
+    expect(captured_output).to include "mammal"
+  end
+
+  example "detect landmark" do
+    expect {
+      detect_landmark path_to_image_file: image_path("eiffel_tower.jpg")
+    }.to output(
+      "Found landmark: Eiffel Tower\n"
+    ).to_stdout
+  end
+
+  example "detect faces" do
+    output_image_file = Tempfile.new "cloud-vision-testing"
+    expect(File.size output_image_file.path).to eq 0
+
+    begin
+      capture do
+        detect_faces path_to_image_file: image_path("face.png"),
+                     path_to_output_file: output_image_file.path
+      end
+
+      expect(captured_output).to include "Face bounds:"
+      expect(captured_output).to include "(154, 33)"
+      expect(captured_output).to include "(301, 33)"
+      expect(captured_output).to include "(301, 180)"
+      expect(captured_output).to include "(154, 180)"
+      expect(File.size output_image_file.path).to be > 0
+    ensure
+      output_image_file.close
+      output_image_file.unlink
+    end
+  end
+end
diff --git a/vision/vision_samples.rb b/vision/vision_samples.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+--tty --color --format documentation --order random`