badger_vision 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c636bf2929c903d6c1336255a84fe382393bf519
+  data.tar.gz: eaf5e30be11105e195cfd51a50035d662258e61c
+SHA512:
+  metadata.gz: a6af1789243660676a828354b901baf6f587e49058e49c8317dc106934cde4be70d9ec034388111f752f82197d81d726912f623ca0ba1e32c07d392449cde182
+  data.tar.gz: e31fe002a245324a7a176b932f5cd2a7a7320f7156dfb2012eb7a19debe306af0542da9f9840c108c52a45a22597871c8bf1978a0f622f918da131639241fd72

data/.gitignore

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

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in badger_vision.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    badger_vision (0.1.0)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      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.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  badger_vision!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,60 @@
+# Badger Vision 🐼
+
+Extract concepts and tags from images using badger vision. It's a wrapper
+around the Places365 project allowing you to understand what landscape
+information is available a given images
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'badger_vision'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install badger_vision
+
+## Usage
+
+You always need to pass a URL of the image to the service.
+
+```
+url = 'https://www.telegraph.co.uk/content/dam/Travel/Destinations/Asia/Maldives/Maldives%20lead-xlarge.jpg'
+response = BadgerVision::Client.image_information(url: url)
+
+```
+
+Your response has the following methods:
+
+```
+response.attributes
+#=> ['natural light', 'open area', 'man-made', 'sunny', 'clouds', 'far-away horizon', 'swimming', 'boating', 'diving']
+
+response.type
+#=> 'outdoor'
+
+scenes = info.scenes
+
+scenes.first.name
+#=> 'lagoon'
+
+scenes.first.probability
+#=> 0.299
+
+```
+
+## 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/Hendricius/badger_vision.

data/Rakefile

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

data/badger_vision.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "badger_vision/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "badger_vision"
+  spec.version       = BadgerVision::VERSION
+  spec.authors       = ["Hendrik Kleinwaechter"]
+  spec.email         = ["hendrik.kleinwaechter@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for the Places365 image detection algorithm.}
+  spec.description   = %q{Allows you to understand for a given image what is going on there.}
+  spec.homepage      = "https://github.com/hendricius/badger_vision"
+  spec.licenses      = ["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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0"
+
+  spec.add_dependency "faraday", "~> 0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "badger_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(__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/lib/badger_vision/client.rb

@@ -0,0 +1,73 @@
+require "faraday"
+require "json"
+require "pry"
+require "badger_vision/config"
+require "badger_vision/request"
+
+module BadgerVision
+  class Client
+    def initialize(request_options: {})
+      @request_options = request_options
+    end
+
+    # Extract tags from a given image URL
+    def self.image_information(url)
+      new(request_options: {url: url}).image_information
+    end
+
+    def image_information
+      body = Request.post("cgi-bin/image.py", @request_options)
+      ImageInformationResponse.new(parse_response(body))
+    end
+
+    private
+
+    def parse_response(body)
+      JSON.parse(body, symbolize_names: true)
+    end
+
+    class ImageInformationResponse
+      def initialize(response)
+        @response = response || {}
+      end
+
+      def attributes
+        @response.fetch(:attributes, []).split(",").map(&:strip)
+      end
+
+      def type
+        @response.fetch(:type, nil)
+      end
+
+      def scenes
+        @response.fetch(:scenes, []).split(",").map(&:strip).map do |scene|
+          Scene.new(parse_scene(scene))
+        end
+      end
+
+      private
+
+      def parse_scene(scene)
+        name, probability = extract_scene_data(scene)
+        {
+          name: name,
+          probability: probability.to_f
+        }
+      end
+
+      def extract_scene_data(scene)
+        # format: lagoon (0.299)
+        scene.match(/^(\w*)\s\((.*)\)/)&.captures
+      end
+    end
+
+    class Scene
+      attr_reader :name, :probability
+
+      def initialize(name:, probability:)
+        @name = name
+        @probability = probability
+      end
+    end
+  end
+end

data/lib/badger_vision/config.rb

@@ -0,0 +1,20 @@
+require "badger_vision/configuration"
+
+module BadgerVision
+  module Config
+    def configure
+      if block_given?
+        yield configuration
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # This exposes the configuration methods in global scope, so
+  # we can directly use those like: `BadgerVision.configuration`.
+  #
+  extend Config
+end

data/lib/badger_vision/configuration.rb

@@ -0,0 +1,13 @@
+module BadgerVision
+  class Configuration
+    attr_accessor :api_key, :api_host, :version
+
+    def initialize
+      @api_host ||= "http://places2.csail.mit.edu"
+    end
+
+    def base_path
+      ""
+    end
+  end
+end

data/lib/badger_vision/request.rb

@@ -0,0 +1,76 @@
+require "faraday"
+require "badger_vision/config"
+
+module BadgerVision
+  class Request
+    # Initialize a Request
+    #
+    # @param http_method [Symbol] HTTP verb as sysmbol
+    # @param endpoint [String] The relative API endpoint
+    # @param data [Hash] Attributes / Options as a Hash
+    #
+    def initialize(http_method, endpoint)
+      @data        = data
+      @endpoint    = endpoint
+      @http_method = http_method
+    end
+
+    # Make a HTTP Request
+    #
+    # @param options [Hash] Additonal options hash
+    # @return Hash
+    #
+    def request(options = {})
+      connection.send(http_method, api_endpoint, default_options.merge(options)).body
+    end
+
+    # Make a HTTP POST Request
+    #
+    # @param endpoint [String] The relative API endpoint
+    # @param options [Hash] The additional query params
+    # @return Hash
+    #
+    def self.post(endpoint, options = {})
+      new(:post, endpoint).request(options)
+    end
+
+    private
+
+    attr_reader :client, :data, :http_method
+
+    def config
+      BadgerVision.configuration
+    end
+
+    def default_options
+      {
+        random: Time.now.to_i * 1000,
+        data: nil,
+        date: Time.now.to_i * 1000,
+        demoimg: 0,
+      }
+    end
+
+    def places_host
+      config.api_host
+    end
+
+    def api_endpoint
+      ["", config.base_path, @endpoint].join("/").squeeze("/")
+    end
+
+    def faraday_options
+      {
+        url: places_host
+      }
+    end
+
+    def connection
+      @connection ||= Faraday.new(faraday_options) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+  end
+end

data/lib/badger_vision/version.rb

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

data/lib/badger_vision.rb

@@ -0,0 +1,9 @@
+require "badger_vision/version"
+require "badger_vision/request"
+require "badger_vision/client"
+
+module BadgerVision
+  def self.root
+    File.dirname(__dir__)
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: badger_vision
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hendrik Kleinwaechter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-01 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: Allows you to understand for a given image what is going on there.
+email:
+- hendrik.kleinwaechter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- badger_vision.gemspec
+- bin/console
+- bin/setup
+- lib/badger_vision.rb
+- lib/badger_vision/client.rb
+- lib/badger_vision/config.rb
+- lib/badger_vision/configuration.rb
+- lib/badger_vision/request.rb
+- lib/badger_vision/version.rb
+homepage: https://github.com/hendricius/badger_vision
+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: Ruby wrapper for the Places365 image detection algorithm.
+test_files: []