picguard 1.0.0 → 1.0.1

data/spec/picguard_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Picguard do
+  before(:all) do
+    Picguard.configure do |config|
+      config.google_api_key = ENV['GCLOUD_KEY']
+      config.threshold_adult = "POSSIBLE"
+      config.threshold_violence = "UNLIKELY"
+      config.threshold_face = 0.8
+    end
+  end
+  it 'has a version number' do
+    expect(Picguard::VERSION).not_to be nil
+  end
+
+  describe '#analyze' do
+    subject { described_class.analyze(image_path: "spec/support/img/face-example.jpg") }
+    it 'returns a result as hash' do
+      expect(subject).to be_an_instance_of(Hash)
+    end
+  end
+end

data/spec/services/analyzer_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Services::Analyzer do
+  subject { described_class.new(
+    result = ResultHashStub.new.api_hash_result,
+    threshold_adult = 'POSSIBLE',
+    threshold_violence = 'POSSIBLE',
+    threshold_face = 0.8
+    ) }
+  describe '#call' do
+    let(:analyzed_result) { subject.call }
+
+    it 'returns a valid hash' do
+      expect(analyzed_result).to be_an_instance_of(Hash)
+      expect(analyzed_result).to have_key(:safe_search)
+      expect(analyzed_result[:safe_search]).to have_key(:adult)
+      expect(analyzed_result[:safe_search]).to have_key(:violence)
+      expect(analyzed_result).to have_key(:face_recognised)
+    end
+
+    it 'returns adult content violation' do
+      expect(analyzed_result[:safe_search][:adult]).to be(true)
+    end
+
+    it 'does not return violent content violation' do
+      expect(analyzed_result[:safe_search][:violence]).to be(false)
+    end
+
+    it 'recognises face' do
+      expect(analyzed_result[:face_recognised]).to be(true)
+    end
+  end
+end

data/spec/services/builders/annotate_image_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Services::Builders::AnnotateImage do
+  subject { described_class.new(image, [feature]) }
+  let(:image) do
+    Google::Apis::VisionV1::Image.new(content: open('spec/support/img/face-example.jpg').to_a.join)
+  end
+  let(:feature) { Google::Apis::VisionV1::Feature.new(type: 'FACE_DETECTION') }
+
+  describe '#call' do
+    it 'creates valid Google::Apis::VisionV1::AnnotateImageRequest object' do
+      expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::AnnotateImageRequest
+    end
+  end
+end

data/spec/services/builders/batch_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Services::Builders::BatchAnnotateImages do
+  subject { described_class.new([image_request]) }
+  let(:image) do
+    Google::Apis::VisionV1::Image.new(content: open('spec/support/img/face-example.jpg').to_a.join)
+  end
+  let(:feature) { Google::Apis::VisionV1::Feature.new(type: 'FACE_DETECTION') }
+  let(:image_request) do
+    Google::Apis::VisionV1::AnnotateImageRequest.new(image: [image], features: [feature])
+  end
+
+  describe '#call' do
+    it 'creates valid Google::Apis::VisionV1::BatchAnnotateImagesRequest object' do
+      expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::BatchAnnotateImagesRequest
+    end
+  end
+end

data/spec/services/builders/feature_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Services::Builders::Feature do
+  let(:type) { 'SAFE_SEARCH_DETECTION' }
+  let(:max_results) { '3' }
+
+  context 'max_results is defined' do
+    subject { described_class.new(type, max_results) }
+
+    describe '#call' do
+      it 'creates valid Google::Apis::VisionV1::Feature object' do
+        expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::Feature
+      end
+    end
+  end
+
+  context 'max_results is not defined' do
+    subject { described_class.new(type) }
+
+    describe '#call' do
+      it 'creates valid Google::Apis::VisionV1::Feature object' do
+        expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::Feature
+      end
+    end
+  end
+end

data/spec/services/builders/image_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Services::Builders::Image do
+  subject { described_class.new(image_path) }
+  let(:image_path) { 'spec/support/img/face-example.jpg' }
+
+  describe '#call' do
+    it 'creates valid Google::Apis::VisionV1::Image object' do
+      expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::Image
+    end
+  end
+end

data/spec/services/builders/vision_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Services::Builders::Vision do
+  subject { described_class.new }
+
+  before { Picguard.configure { |config| config.google_api_key = "google_api_key" } }
+
+  describe '#call' do
+    it 'creates valid Google::Apis::VisionV1::VisionService object with given key' do
+      expect(subject.call).to be_an_instance_of Google::Apis::VisionV1::VisionService
+      expect(subject.call.key).to eq "google_api_key"
+    end
+  end
+end

data/spec/services/image_preparator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'mini_magick'
+
+describe Services::ImagePreparator do
+  describe '#call' do
+    context 'image is too big' do
+      let(:image_path) { 'spec/support/img/face-example.jpg' }
+
+      context 'with face detection' do
+        subject { described_class.new(image_path, true, true).call }
+        it 'resizes picture to 1600x' do
+          expect(MiniMagick::Image.open(subject).dimensions.first).to equal 1600
+        end
+      end
+
+      context 'without face detection' do
+        subject { described_class.new(image_path, false, true).call }
+        it 'resizes picture to 640x' do
+          expect(MiniMagick::Image.open(subject).dimensions.first).to equal 640
+        end
+      end
+    end
+
+    context 'image is below the threshold' do
+      let(:image_path) do
+        img = MiniMagick::Image.open('spec/support/img/face-example.jpg')
+        img.resize(800).path
+      end
+      subject { described_class.new(image_path, true, true).call }
+      it 'does not resize the picture' do
+        original_dimensions = MiniMagick::Image.open(image_path).dimensions
+        expect(MiniMagick::Image.open(subject).dimensions).to match_array(original_dimensions)
+      end
+    end
+  end
+end

data/spec/services/validators/likelihood_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Services::Validators::Likelihood do
+  subject { described_class.new(response, threshold) }
+  let(:threshold) { 'possible' }
+
+  context 'response is below the threshold' do
+    let(:response) { 'unlikely' }
+
+    describe '#call' do
+      it 'checks whether response is acceptable' do
+        expect(subject.call).to eq false
+      end
+    end
+  end
+
+  context 'response is above the threshold' do
+    let(:response) { 'likely' }
+
+    describe '#call' do
+      it 'checks whether response is acceptable' do
+        expect(subject.call).to eq true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+SimpleCov.start do
+  add_filter '/lib/google/apis'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'picguard'
+require 'pry'
+require 'support/result_hash_stub'

data/spec/support/result_hash_stub.rb

@@ -0,0 +1,212 @@
+class ResultHashStub
+
+  attr_reader :api_hash_result
+
+  def initialize
+    @api_hash_result =
+      {:safe_search_annotation =>
+        {:medical => "POSSIBLE", :violence =>
+            "VERY_UNLIKELY", :spoof => "VERY_UNLIKELY", :adult => "VERY_LIKELY"
+        }, :face_annotations => [
+        {:tilt_angle => -5.6747785,
+          :under_exposed_likelihood => "VERY_UNLIKELY", :fd_bounding_poly =>
+            {
+              :vertices => [
+              {:y => 66, :x => 212
+              },
+              {:y => 66, :x => 309
+              },
+              {:y => 162, :x => 309
+              },
+              {:y => 162, :x => 212
+              }]
+            }, :landmarking_confidence => 0.54256278, :joy_likelihood =>
+            "UNLIKELY", :detection_confidence => 0.81811, :surprise_likelihood =>
+            "VERY_UNLIKELY", :anger_likelihood => "VERY_UNLIKELY",
+            :headwear_likelihood => "VERY_UNLIKELY", :bounding_poly =>
+            {
+              :vertices => [
+              {:y => 15, :x => 181
+              },
+              {:y => 15, :x => 319
+              },
+              {:y => 176, :x => 319
+              },
+              {:y => 176, :x => 181
+              }]
+            }, :pan_angle => 21.601442, :landmarks => [
+            {:position =>
+              {:y =>
+                  92.158325, :z => 0.00041507356, :x => 247.91048
+              }, :type => "LEFT_EYE"
+            },
+            {:position =>
+              {:y => 95.865105, :z => 14.610845, :x =>
+                  284.24
+              }, :type => "RIGHT_EYE"
+            },
+            {:position =>
+              {:y => 80.607, :z => -2.5638669, :x =>
+                  234.99283
+              }, :type => "LEFT_OF_LEFT_EYEBROW"
+            },
+            {:position =>
+              {:y => 84.722275, :z => -4.653347, :x =>
+                  262.35208
+              }, :type => "RIGHT_OF_LEFT_EYEBROW"
+            },
+            {:position =>
+              {:y => 86.8425, :z => 2.8803124, :x =>
+                  281.2482
+              }, :type => "LEFT_OF_RIGHT_EYEBROW"
+            },
+            {:position =>
+              {:y => 87.784157, :z => 23.202911, :x =>
+                  300.01212
+              }, :type => "RIGHT_OF_RIGHT_EYEBROW"
+            },
+            {:position =>
+              {:y => 93.327347, :z => -0.74257189, :x =>
+                  271.58786
+              }, :type => "MIDPOINT_BETWEEN_EYES"
+            },
+            {:position =>
+              {:y => 121.89613, :z => -9.7575331, :x =>
+                  272.08487
+              }, :type => "NOSE_TIP"
+            },
+            {:position =>
+              {:y => 134.86389, :z => 1.2005523, :x =>
+                  265.13113
+              }, :type => "UPPER_LIP"
+            },
+            {:position =>
+              {:y => 145.711, :z => 5.1032391, :x =>
+                  262.22424
+              }, :type => "LOWER_LIP"
+            },
+            {:position =>
+              {:y => 132.93515, :z => 6.4996686, :x =>
+                  241.32828
+              }, :type => "MOUTH_LEFT"
+            },
+            {:position =>
+              {:y => 139.00401, :z => 18.114491, :x =>
+                  275.54007
+              }, :type => "MOUTH_RIGHT"
+            },
+            {:position =>
+              {:y => 139.32642, :z => 4.637207, :x =>
+                  263.2186
+              }, :type => "MOUTH_CENTER"
+            },
+            {:position =>
+              {:y => 123.55997, :z => 10.26918, :x =>
+                  276.53827
+              }, :type => "NOSE_BOTTOM_RIGHT"
+            },
+            {:position =>
+              {:y => 121.06685, :z => 1.5411681, :x =>
+                  256.73715
+              }, :type => "NOSE_BOTTOM_LEFT"
+            },
+            {:position =>
+              {:y => 127.45449, :z => 0.13932635, :x =>
+                  267.49707
+              }, :type => "NOSE_BOTTOM_CENTER"
+            },
+            {:position =>
+              {:y => 89.913605, :z => -2.8806689, :x =>
+                  249.3102
+              }, :type => "LEFT_EYE_TOP_BOUNDARY"
+            },
+            {:position =>
+              {:y => 93.544769, :z => 3.4420719, :x =>
+                  257.01355
+              }, :type => "LEFT_EYE_RIGHT_CORNER"
+            },
+            {:position =>
+              {:y => 94.753471, :z => -0.046903312, :x =>
+                  247.54877
+              }, :type => "LEFT_EYE_BOTTOM_BOUNDARY"
+            },
+            {:position =>
+              {:y => 91.094345, :z => 0.55011082, :x =>
+                  238.81487
+              }, :type => "LEFT_EYE_LEFT_CORNER"
+            },
+            {:position =>
+              {:y => 92.459457, :z => -1.2200928, :x =>
+                  247.72058
+              }, :type => "LEFT_EYE_PUPIL"
+            },
+            {:position =>
+              {:y => 94.214386, :z => 12.550914, :x =>
+                  288.2327
+              }, :type => "RIGHT_EYE_TOP_BOUNDARY"
+            },
+            {:position =>
+              {:y => 97.126755, :z => 22.092098, :x =>
+                  293.21048
+              }, :type => "RIGHT_EYE_RIGHT_CORNER"
+            },
+            {:position =>
+              {:y => 99.567993, :z => 15.348606, :x =>
+                  285.91495
+              }, :type => "RIGHT_EYE_BOTTOM_BOUNDARY"
+            },
+            {:position =>
+              {:y => 96.592667, :z => 12.590128, :x =>
+                  278.9971
+              }, :type => "RIGHT_EYE_LEFT_CORNER"
+            },
+            {:position =>
+              {:y => 96.920578, :z => 14.648366, :x =>
+                  287.66995
+              }, :type => "RIGHT_EYE_PUPIL"
+            },
+            {:position =>
+              {:y => 78.016655, :z => -6.7624264, :x =>
+                  250.26114
+              }, :type => "LEFT_EYEBROW_UPPER_MIDPOINT"
+            },
+            {:position =>
+              {:y => 82.696075, :z => 9.9695559, :x =>
+                  292.5242
+              }, :type => "RIGHT_EYEBROW_UPPER_MIDPOINT"
+            },
+            {:position =>
+              {:y => 102.3996, :z => 40.218388, :x =>
+                  202.1022
+              }, :type => "LEFT_EAR_TRAGION"
+            },
+            {:position =>
+              {:y => 112.2905, :z => 75.182877, :x =>
+                  290.25772
+              }, :type => "RIGHT_EAR_TRAGION"
+            },
+            {:position =>
+              {:y => 85.515747, :z => -2.4461775, :x =>
+                  272.49033
+              }, :type => "FOREHEAD_GLABELLA"
+            },
+            {:position =>
+              {:y => 165.34473, :z => 12.695765, :x =>
+                  257.7327
+              }, :type => "CHIN_GNATHION"
+            },
+            {:position =>
+              {:y => 133.05925, :z => 28.48736, :x =>
+                  210.18437
+              }, :type => "CHIN_LEFT_GONION"
+            },
+            {:position =>
+              {:y => 140.82602, :z => 59.486729, :x =>
+                  288.02194
+              }, :type => "CHIN_RIGHT_GONION"
+            }], :blurred_likelihood => "VERY_UNLIKELY", :roll_angle =>
+            8.5247707, :sorrow_likelihood => "VERY_UNLIKELY"
+        }]
+      }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picguard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Szymon Baranowski
@@ -128,10 +128,55 @@ description: Picguard guards your application by filtering out the pictures cont
 email:
 - szymon.baranowski@netguru.pl
 - tomasz.jaskiewicz@netguru.pl
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/configuration.rb
+- lib/google/apis/vision_v1.rb
+- lib/google/apis/vision_v1/classes.rb
+- lib/google/apis/vision_v1/representations.rb
+- lib/google/apis/vision_v1/service.rb
+- lib/guard_validator.rb
+- lib/picguard.rb
+- lib/picguard/version.rb
+- lib/services/analyzer.rb
+- lib/services/builders/annotate_image.rb
+- lib/services/builders/batch.rb
+- lib/services/builders/feature.rb
+- lib/services/builders/image.rb
+- lib/services/builders/request.rb
+- lib/services/builders/vision.rb
+- lib/services/image_preparator.rb
+- lib/services/validators/likelihood.rb
+- picguard.gemspec
+- spec/guard_validator_spec.rb
+- spec/picguard_spec.rb
+- spec/services/analyzer_spec.rb
+- spec/services/builders/annotate_image_spec.rb
+- spec/services/builders/batch_spec.rb
+- spec/services/builders/feature_spec.rb
+- spec/services/builders/image_spec.rb
+- spec/services/builders/vision_spec.rb
+- spec/services/image_preparator_spec.rb
+- spec/services/validators/likelihood_spec.rb
+- spec/spec_helper.rb
+- spec/support/img/cat.jpg
+- spec/support/img/face-example.jpg
+- spec/support/img/gun-violence.jpg
+- spec/support/result_hash_stub.rb
 homepage: https://github.com/netguru/picguard
 licenses:
 - MIT
@@ -156,4 +201,19 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A gem for filtering a pictures that are being uploaded to your server.
-test_files: []
+test_files:
+- spec/guard_validator_spec.rb
+- spec/picguard_spec.rb
+- spec/services/analyzer_spec.rb
+- spec/services/builders/annotate_image_spec.rb
+- spec/services/builders/batch_spec.rb
+- spec/services/builders/feature_spec.rb
+- spec/services/builders/image_spec.rb
+- spec/services/builders/vision_spec.rb
+- spec/services/image_preparator_spec.rb
+- spec/services/validators/likelihood_spec.rb
+- spec/spec_helper.rb
+- spec/support/img/cat.jpg
+- spec/support/img/face-example.jpg
+- spec/support/img/gun-violence.jpg
+- spec/support/result_hash_stub.rb