iiif_google_cv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56583a675818e08d06e3cf369e3e29e83ec5c6a6
+  data.tar.gz: 47aa2262753fb7acf577f0bc7b0cbf919c5cd3f0
+SHA512:
+  metadata.gz: 1f238e860c00105020019885b17802dd1d9aac36f35daa40a201d305ebb619f62487c8d4d41cf10f16a0edd075a1bf682647c24c23a5d63381df43abdd2c37b2
+  data.tar.gz: 671fd6463563fbb00f89fed6902e0b305aea8c61c1d565a728ed88742c6d2119c9a48e716bbabf6494da42088278a8fc90348d4c406ce50b54a834ecf29f3794

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jack Reed
+
+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,62 @@
+# IiifGoogleCv
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iiif_google_cv`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iiif_google_cv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iiif_google_cv
+
+## Usage
+
+Activate and authorize an interactive session using [Google Cloud Vision Authentication](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-vision/v0.27.0/guides/authentication#withgooglecloudruby) and project id
+
+```sh
+$ VISION_PROJECT="my-project-id" VISION_KEYFILE=Project\ Key\ File.json bin/console
+```
+
+Create a new `IiifGoogleCv::Client`
+
+```ruby
+> c = IiifGoogleCv::Client.new(manifest_url: 'https://purl.stanford.edu/hg676jb4964/iiif/manifest')
+```
+
+Create a manifest with annotations from the client
+
+```ruby
+> c.iiif_manifest_with_annotations
+Annotating ["https://stacks.stanford.edu/image/iiif/hg676jb4964%2F0380_796-44/full/pct:50/0/default.jpg"]
+=> "https://api.myjson.com/bins/12uue9"
+```
+
+The returned url is now an annotated manifest of the images and can be viewed in a IIIF viewer like [Mirador](http://projectmirador.org/demo/).
+
+The API calls will fail if the images are too big or do not respond in time. You can modify the responding images from the IIIF Image API by changing the `SCALE_FACTOR` environment variable. This defaults to `0.5` (50% of original size).
+
+
+## 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/mejackreed/iiif_google_cv.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "iiif_google_cv"
+
+# 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/iiif_google_cv.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iiif_google_cv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'iiif_google_cv'
+  spec.version       = IiifGoogleCv::VERSION
+  spec.authors       = ['Jack Reed']
+  spec.email         = ['phillipjreed@gmail.com']
+
+  spec.summary       = 'IIIF + Google Cloud Vision API'
+  spec.description   = 'IIIF + Google Cloud Vision API'
+  spec.homepage      = 'https://github.com/mejackreed/iiif_google_cv'
+  spec.license       = 'MIT'
+
+  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_dependency 'google-cloud-vision'
+  spec.add_dependency 'iiif-presentation'
+  spec.add_dependency 'putson'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/iiif_google_cv.rb

@@ -0,0 +1,6 @@
+require 'iiif_google_cv/version'
+require 'iiif_google_cv/client'
+
+module IiifGoogleCv
+  # Your code goes here...
+end

data/lib/iiif_google_cv/annotations.rb

@@ -0,0 +1,67 @@
+require 'iiif_google_cv/bounding_box'
+
+module IiifGoogleCv
+  class Annotations
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def url
+      putson.url || putson.post({})
+    end
+
+    def putson
+      @putson ||= Putson::Client.new
+    end
+
+    def iiif_annotations(idx)
+      anno_list = IIIF::Presentation::AnnotationList.new(
+        '@context' => 'http://iiif.io/api/presentation/2/context.json',
+        '@id' => url
+      )
+      anno_list.resources = (faces_to_resources(idx) << text_to_resources(idx)).flatten.compact
+      putson.put(anno_list.to_json)
+      url
+    end
+
+    def text_to_resources(idx)
+      client.annotations[idx].text.words.map do |word|
+        xywh = IiifGoogleCv::BoundingBox.from_gcv_a(word.bounds, client.class::SCALE_FACTOR).to_xywh
+        IIIF::Presentation::Resource.new(
+          '@id' => SecureRandom.hex,
+          '@type' => 'oa:Annotation',
+          'motivation' => 'sc:painting',
+          'resource' => {
+            '@id' => SecureRandom.hex,
+            '@type' => 'cnt:ContentAsText',
+            'format' => 'text/plain',
+            'chars' => word.text,
+            'language' => 'eng'
+          },
+          'on' => "#{client.canvas_id(idx)}#xywh=#{xywh}"
+        )
+      end if client.annotations[idx].text?
+    end
+
+    def faces_to_resources(idx)
+      client.annotations[idx].faces.map do |face|
+        xywh = IiifGoogleCv::BoundingBox.from_gcv_a(face.bounds.head, client.class::SCALE_FACTOR).to_xywh
+        IIIF::Presentation::Resource.new(
+          '@id' => SecureRandom.hex,
+          '@type' => 'oa:Annotation',
+          'motivation' => 'sc:painting',
+          'resource' => {
+            '@id' => SecureRandom.hex,
+            '@type' => 'cnt:ContentAsText',
+            'format' => 'text/plain',
+            'chars' => 'Face detection',
+            'language' => 'eng'
+          },
+          'on' => "#{client.canvas_id(idx)}#xywh=#{xywh}"
+        )
+      end
+    end
+  end
+end

data/lib/iiif_google_cv/bounding_box.rb

@@ -0,0 +1,42 @@
+module IiifGoogleCv
+  ##
+  # Basic BoundingBox operations/parsing
+  class BoundingBox
+    attr_reader :minx, :miny, :maxx, :maxy, :scale_factor
+
+    def initialize(minx, miny, maxx, maxy, scale_factor: 1.0)
+      @minx = minx
+      @miny = miny
+      @maxx = maxx
+      @maxy = maxy
+      @scale_factor = scale_factor
+    end
+
+    def self.from_gcv_a(bounds_array, scale_factor = 1.0)
+      i = new(999_999_999, 999_999_999, -999_999_999, -999_999_999, scale_factor: scale_factor)
+      bounds_array.each do |vertex|
+        i.check_and_set_bounds(vertex)
+      end
+      i
+    end
+
+    def check_and_set_bounds(vertex)
+      @maxx = vertex.x / scale_factor if vertex.x / scale_factor > maxx
+      @maxy = vertex.y / scale_factor if vertex.y / scale_factor > maxy
+      @minx = vertex.x / scale_factor if vertex.x / scale_factor < minx
+      @miny = vertex.y / scale_factor if vertex.y / scale_factor < miny
+    end
+
+    def width
+      maxx - minx
+    end
+
+    def height
+      maxy - miny
+    end
+
+    def to_xywh
+      "#{minx.to_i},#{miny.to_i},#{width.to_i},#{height.to_i}"
+    end
+  end
+end

data/lib/iiif_google_cv/client.rb

@@ -0,0 +1,99 @@
+require 'faraday'
+require 'iiif/presentation'
+require 'google/cloud/vision'
+require 'putson'
+
+require 'iiif_google_cv/annotations'
+
+module IiifGoogleCv
+  class Client
+    SCALE_FACTOR = (ENV['SCALE_FACTOR'] || 0.5).to_f
+    attr_reader :manifest, :manifest_url
+
+    def initialize(manifest_url: nil, manifest: nil)
+      unless manifest_url || manifest
+        raise(
+          ArgumentError,
+          'manifest_url or manifest must be provided'
+        )
+      end
+      @manifest_url = manifest_url
+      @manifest = manifest
+    end
+
+    def putson
+      @putson ||= Putson::Client.new
+    end
+
+    def url
+      putson.url || putson.post({})
+    end
+
+    def vision
+      @vision ||= Google::Cloud::Vision.new
+    end
+
+    def annotations
+      puts "Annotating #{image_resources}"
+      @annotations ||= [*vision.annotate(
+        *image_resources,
+        faces: true,
+        labels: true,
+        landmarks: true,
+        logos: true,
+        text: true
+      )]
+    end
+
+    def process
+      annotations
+    end
+
+    def image_resources
+      iiif_manifest.sequences.collect do |s|
+        s.canvases.collect do |c|
+          c.images.collect do |i|
+            i.resource['@id'].gsub('full/0', "pct:#{(SCALE_FACTOR * 100).to_i}/0")
+          end
+        end
+      end.flatten.compact
+    end
+
+    def canvas_id(idx)
+      iiif_manifest.sequences.map do |s|
+        s.canvases[idx]['@id']
+      end.flatten.compact.first
+    end
+
+    def iiif_manifest
+      @iiif_manifest ||= IIIF::Service.parse(manifest_body)
+    end
+
+    ##
+    def iiif_manifest_with_annotations
+      @iiif_manifest_with_annotations ||= iiif_manifest.clone
+      @iiif_manifest_with_annotations['@id'] = url
+      @iiif_manifest_with_annotations.sequences.map do |s|
+        s.canvases.map.with_index do |c, i|
+          c.other_content = [
+            {
+              '@id' => iiif_annotations(i),
+              '@type' => 'sc:AnnotationList'
+            }
+          ]
+        end
+      end
+      putson.put(@iiif_manifest_with_annotations)
+    end
+
+    def iiif_annotations(i)
+      IiifGoogleCv::Annotations.new(self).iiif_annotations(i)
+    end
+
+    def manifest_body
+      return manifest if manifest
+      @manifest = Faraday.get(manifest_url).body
+      @manifest
+    end
+  end
+end

data/lib/iiif_google_cv/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: iiif_google_cv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-vision
+  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'
+- !ruby/object:Gem::Dependency
+  name: iiif-presentation
+  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'
+- !ruby/object:Gem::Dependency
+  name: putson
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: IIIF + Google Cloud Vision API
+email:
+- phillipjreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iiif_google_cv.gemspec
+- lib/iiif_google_cv.rb
+- lib/iiif_google_cv/annotations.rb
+- lib/iiif_google_cv/bounding_box.rb
+- lib/iiif_google_cv/client.rb
+- lib/iiif_google_cv/version.rb
+homepage: https://github.com/mejackreed/iiif_google_cv
+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.11
+signing_key: 
+specification_version: 4
+summary: IIIF + Google Cloud Vision API
+test_files: []