tinplate 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ab343df2b39b5fab64740c6801bd8be576f5822
+  data.tar.gz: e0c73ac143009fb9f614cdb7820f0d8aeee09e30
+SHA512:
+  metadata.gz: e3046ddc36bc333a2b5b9caf1ed924c80a368a13d6b8bf78017cb7a55992f3fc71debdfa4d713e836acaea14fb18aa9b6a5fd79b785fcd1917e17bd89dffbd2d
+  data.tar.gz: 868ac2863f91150367d8760083f35df787b47b6f04404a8a98778b37386089b7878bdd2c664228e4352b138828fba15b670f2015873cb1e72c90dc32b6805d9f

data/.gitignore

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

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.1.6'
+
+# Specify your gem's dependencies in tinplate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Crew
+
+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,90 @@
+# Tinplate
+
+Wrapper 'round the [TinEye API](https://services.tineye.com/developers/tineyeapi/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tinplate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tinplate
+
+## Usage
+
+There are only three API actions available: `search`, `remaining_searches` (to check the status of your account), and `image_count` (if you're curious how many total images TinEye has indexed).
+
+`remaining_searches` returns an `OpenStruct` object with three attributes: `remaining_searches`, `start_date`, and `expire_date`.
+
+`image_count` returns a plain old integer.
+
+### Search example
+
+*Note: this gem does not (yet) support searching by image upload, only by image URL.*
+
+```ruby
+tineye = Tinplate::TinEye.new
+results = tineye.search(image_url: "http://example.com/photo.jpg")
+
+results.total_results    # => 2
+results.total_backlinks  # => 3
+results.matches          # => an Array of matched images (see below)
+
+results.matches.each do |match|
+  # Do what you like with this matched image. The world is your oyster.
+end
+```
+
+#### Optional search parameters
+
+`offset`: Default 0    
+`limit`:  Default 100    
+`sort`:   "score", "size", or "crawl_date". Default "score".    
+`order`:  "asc" or "desc". Default "desc".
+
+#### Example matched image
+
+An `OpenStruct` object with the following attributes (/w example values):
+
+```ruby
+width: 400
+height: 300
+size: 50734
+image_url: "http://images.tineye.com/result/0f1e84b7b7538e8e7de048f4d45eb8f579e3e999941b3341ed9a754eb447ebb1",
+format: "JPEG",
+contributor: true,
+overlay: "overlay/507bb6bf9a397284e2330be7c0671aadc7319b4b/0f1e84b7b7538e8e7de048f4d45eb8f579e3e999941b3341ed9a754eb447ebb1?m21=-9.06952e-05&m22=0.999975&m23=0.0295591&m11=0.999975&m13=-0.0171177&m12=9.06952e-05",
+backlinks:
+  # These are also an OpenStruct objects, not Hashes.
+  [
+    {
+      url: "http://example-copier.com/photo.jpg",
+      crawl_date: "2012-06-30",
+      backlink: "http://example-copier.com/photo.jpg"
+    }
+  ]
+```
+  
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/CrewLabs/tinplate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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 "tinplate"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tinplate.rb

@@ -0,0 +1,23 @@
+require "faraday"
+require "json"
+
+require "tinplate/version"
+require "tinplate/configuration"
+require "tinplate/tineye"
+require "tinplate/request_authenticator"
+require "tinplate/search_results"
+require "tinplate/errors"
+
+module Tinplate
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/tinplate/configuration.rb

@@ -0,0 +1,29 @@
+module Tinplate # :nodoc:
+  class Configuration # :nodoc:
+
+    # https://services.tineye.com/developers/tineyeapi/sandbox.html
+    SANDBOX_PUBLIC_KEY  = "LCkn,2K7osVwkX95K4Oy"
+    SANDBOX_PRIVATE_KEY = "6mm60lsCNIB,FwOWjJqA80QZHh9BMwc-ber4u=t^"
+
+    attr_writer :public_key
+    attr_writer :private_key
+    attr_writer :test
+
+    def initialize
+      @test = true
+    end
+
+    def test?
+      !!@test
+    end
+
+    def public_key
+      test? ? SANDBOX_PUBLIC_KEY : @public_key
+    end
+
+    def private_key
+      test? ? SANDBOX_PRIVATE_KEY : @private_key
+    end
+
+  end
+end

data/lib/tinplate/errors.rb

@@ -0,0 +1,13 @@
+module Tinplate
+  class Error < StandardError
+    attr_reader :code
+    attr_reader :type
+    attr_reader :message
+
+    def initialize(code, type, message)
+      @code = code
+      @type = @type
+      @message = message
+    end
+  end
+end

data/lib/tinplate/request_authenticator.rb

@@ -0,0 +1,48 @@
+# https://services.tineye.com/developers/tineyeapi/authentication.html
+
+module Tinplate
+  class RequestAuthenticator
+
+    def initialize(action, params = {}, image_name = "")
+      @action = action
+      @params = params
+      @image_name = image_name
+      @nonce = SecureRandom.hex
+      @date  = Time.now.to_i
+    end
+
+    def params
+      {
+        api_key: Tinplate.configuration.public_key,
+        api_sig: signature,
+        nonce:   @nonce,
+        date:    @date
+      }
+    end
+
+    def signature_components
+      [
+        Tinplate.configuration.private_key,
+        "GET",
+        "", # Content-Type for GET requests is blank
+        URI.encode(@image_name).downcase,
+        @date.to_i,
+        @nonce,
+        "http://api.tineye.com/rest/#{@action}/",
+        hash_to_sorted_query_string(@params),
+      ]
+    end
+
+    def signature
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"),
+                              Tinplate.configuration.private_key,
+                              signature_components.join)
+    end
+
+    def hash_to_sorted_query_string(params)
+      Hash[params.sort].map do |key, value|
+        "#{key}=#{URI.encode_www_form_component(value)}"
+      end.join("&")
+    end
+  end
+end

data/lib/tinplate/search_results.rb

@@ -0,0 +1,18 @@
+module Tinplate
+  class SearchResults < OpenStruct
+    def initialize(data)
+      super total_backlinks: data["total_backlinks"],
+            total_results:   data["total_results"],
+            matches:         parsed_matches(data["matches"])
+    end
+
+    private
+
+    def parsed_matches(matches_data)
+      matches_data.map do |match|
+        backlinks = { backlinks: match["backlinks"].map { |links| OpenStruct.new(links) } }
+        OpenStruct.new(match.merge(backlinks))
+      end
+    end
+  end
+end

data/lib/tinplate/tineye.rb

@@ -0,0 +1,52 @@
+module Tinplate
+  class TinEye
+    SORTS  = ["score", "size", "crawl_date"]
+    ORDERS = ["asc", "desc"]
+
+    def search(image_url: nil, offset: 0, limit: 100, sort: "score", order: "desc")
+      raise ArgumentError.new("You must supply an image_url") if !image_url
+      raise ArgumentError.new("sort must be one of #{SORTS.join(', ')}") if !SORTS.include?(sort)
+      raise ArgumentError.new("order must be one of #{ORDERS.join(', ')}") if !ORDERS.include?(order)
+
+      response = request "search", image_url: image_url, offset: offset.to_s, limit: limit.to_s, sort: sort, order: order
+      Tinplate::SearchResults.new(response["results"])
+    end
+
+    def remaining_searches
+      results = request("remaining_searches")["results"]
+      OpenStruct.new(remaining_searches: results["remaining_searches"],
+                     start_date:  DateTime.parse(results["start_date"]),
+                     expire_date: DateTime.parse(results["expire_date"]))
+    end
+
+    def image_count
+      request("image_count")["results"]
+    end
+
+
+    private
+
+    def request(action, params = {})
+      auth = Tinplate::RequestAuthenticator.new(action, params)
+      params.merge!(auth.params)
+
+      response = ::JSON.parse(connection.get("#{action}/", params).body)
+
+      if response["code"] != 200
+        raise Tinplate::Error.new(response["code"], response["messages"][0], response["messages"][1])
+      end
+
+      response
+    end
+
+    def connection
+      @conn ||= Faraday.new(url: "http://api.tineye.com/rest/") do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger                
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+  end
+
+end

data/lib/tinplate/version.rb

@@ -0,0 +1,3 @@
+module Tinplate
+  VERSION = "1.0"
+end

data/tinplate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tinplate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tinplate"
+  spec.version       = Tinplate::VERSION
+  spec.authors       = ["Aaron Klaassen"]
+  spec.email         = ["aaron@crew.co"]
+
+  spec.summary       = %q{A wrapper around the TinEye API.}
+  spec.homepage      = "https://github.com/CrewLabs/tinplate"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.4.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: tinplate
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Aaron Klaassen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.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'
+description: 
+email:
+- aaron@crew.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tinplate.rb
+- lib/tinplate/configuration.rb
+- lib/tinplate/errors.rb
+- lib/tinplate/request_authenticator.rb
+- lib/tinplate/search_results.rb
+- lib/tinplate/tineye.rb
+- lib/tinplate/version.rb
+- tinplate.gemspec
+homepage: https://github.com/CrewLabs/tinplate
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A wrapper around the TinEye API.
+test_files: []