eyevision 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a0c3a612ada521338711f3df8f5b6cd0ee63fb
+  data.tar.gz: 568a1d8f0193b1ac0e06fff3dbce69df6942edef
+SHA512:
+  metadata.gz: 816deebbe5e57923d5c33aa3b752d9f15589948311fe3d564409d6b873992fea6eb727d2857fa8cffadb2229c1256509c41b8a3515173cfca2b9ea1f4e1c9802
+  data.tar.gz: 4e4011a294035430a6198f38271c4e574fbcc12f24c0ff7b0cb457c4706953bdb76298f193a7d7bea7576c8016fd748182eaa32468dcecad98d254012dbb9011

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# Eyevision
+
+This gem is a client to EyeEm's Vision API. It provides functionality to analyze an imageand retrieve tags, captions and an aesthetic score.
+
+The client handles request authentication and token refreshes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eyevision'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eyevision
+
+## Usage
+
+Usage is fairly simple. You initialize the client with your API keys and then pass images by file, url or binary input:
+
+```ruby
+require 'eyevision'
+
+c = Eyevision::Client.new('CLIENT ID', 'CLIENT SECRET')
+
+c.analyze(url: "https://cdn.eyeem.com/thumb/fa153872f1fb87d2c49f03da2e605cbdc343230d-1479466499934/1200/1200")
+c.analyze(file: "image.jpg")
+c.analyze(image: "binary")
+```
+
+By default it will retrieve tags, captions and aesthetic score but you can also request other combinations:
+
+```ruby
+c.analyze(image: "binary", features: ["TAGS", "AESTHETIC_SCORE"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/tmacedo/eyevision.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eyevision"
+
+# 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,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/eyevision.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eyevision/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eyevision"
+  spec.version       = Eyevision::VERSION
+  spec.authors       = ["Tiago Macedo"]
+  spec.email         = ["tftfmacedo@gmail.com"]
+
+  spec.summary       = "Ruby Client for the EyeEm Vision API"
+  spec.description   = "Ruby Client for the EyeEm Vision API"
+  spec.homepage      = "https://github.com/tmacedo/eyevision"
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+
+  spec.add_runtime_dependency "httparty", "~> 0.14.0"
+end

data/lib/eyevision.rb

@@ -0,0 +1,11 @@
+require "json"
+require "httparty"
+require "base64"
+
+require "eyevision/version"
+require "eyevision/client"
+
+module Eyevision
+  class AuthenticationError < StandardError; end
+  class ApiError < StandardError; end
+end

data/lib/eyevision/client.rb

@@ -0,0 +1,82 @@
+module Eyevision
+  class Client
+    include HTTParty
+
+    BASE_URI = "https://vision-api.eyeem.com/v1"
+    base_uri BASE_URI
+
+    SUPPORTED_FEATURES = %w(TAGS CAPTIONS AESTHETIC_SCORE)
+
+    def initialize(client_id, client_secret)
+      @client_id     = client_id
+      @client_secret = client_secret
+    end
+
+    def analyze(opts)
+      case
+      when opts[:file]
+        image = from_file(opts[:file])
+      when opts[:url]
+        image = from_url(opts[:url])
+      when opts[:image]
+        image = opts[:image]
+      else
+        raise "You need to supply an image, file or URL"
+      end
+
+      features = SUPPORTED_FEATURES & (opts[:features] || SUPPORTED_FEATURES)
+
+      resp = request('/analyze', body: body(image, features), headers: auth_headers, format: :json)
+
+      JSON.parse(resp.body)["responses"].first
+    end
+
+    private
+
+    def request(url, options, retry_count=1)
+      resp = self.class.post(url, options)
+
+      puts url
+      puts resp.code
+      case resp.code
+      when 200
+        resp
+      when 401 # token refresh
+        if retry_count > 0
+          @token = nil
+
+          request(url, options.merge(headers: auth_headers), (retry_count - 1))
+        else
+          raise AuthenticationError, resp.body
+        end
+      else
+          raise ApiError, resp.body 
+      end
+    end
+
+    def encode(image)
+      Base64.strict_encode64(image)
+    end
+
+    def from_url(url)
+      encode(HTTParty.get(url).body)
+    end
+
+    def from_file(path)
+      encode(File.binread(path))
+    end
+
+    def body(image, features)
+      tasks = features.map{|f| {type: f}}
+      {requests: [{ tasks: tasks, image: { content: image }}]}.to_json
+    end
+
+    def auth_headers
+      {'Content-Type' => 'application/json', 'Authorization' => "Bearer #{token}"}
+    end
+
+    def token
+      @token ||= request('/token', {body: {clientId: @client_id, clientSecret: @client_secret}, headers: {'Content-Type' => 'application/x-www-form-urlencoded'}}, retry_count=0)['access_token']
+    end
+  end
+end

data/lib/eyevision/version.rb

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: eyevision
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiago Macedo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Ruby Client for the EyeEm Vision API
+email:
+- tftfmacedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eyevision.gemspec
+- lib/eyevision.rb
+- lib/eyevision/client.rb
+- lib/eyevision/version.rb
+homepage: https://github.com/tmacedo/eyevision
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Client for the EyeEm Vision API
+test_files: []