tinplate 1.0.2 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a614c00dcffdd96297cd2fbfa6982efb67ce878
-  data.tar.gz: af55c37e079bd5131f540b7790c065897c11c9fa
+SHA256:
+  metadata.gz: 4e646b162936b034d5e402b3c47957942019644a844c40ce643ce8606355b366
+  data.tar.gz: fb30461669218584c80330b21b1de6f0abb88686d687c2fef151a3bcbe573e66
 SHA512:
-  metadata.gz: 879760416e70f064d0affe912a0f36584fbaa4c1f75ff42aa9c068e5a980510af94cfb8ed8fa43ce6d1083a1d7a108e081a593fd3aac7038ed1fc12ccec63983
-  data.tar.gz: 0984d1d8b8eb99fce820388ea34513c826c15f6babcea769c501643c1a29cea17803e0e4137d92501fcc060bc524d78e87f515e028bfd349e2054fda94b2cb75
+  metadata.gz: 20a758012a6f63ad26b536f5f8fe3b9efd96bf43febc8f9ee11dec11c2f66245ec6280e6989549fca37521a8ac69087cebb4b10dad6198018d27e6f9143a93ac
+  data.tar.gz: da05c621d15de702343f62173df7f96e874b0ca3dfc0fa951403ec30648cf0d8d3f976335aa8b4f39a90ba63c95fa561f799f4a764b0e8c11d2af4a0bfdc67b4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Crew
+Copyright (c) 2016 Unsplash
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -41,23 +41,30 @@ There are only three API actions available: `search`, `remaining_searches` (to c
 
 `image_count` returns a plain old integer.
 
-### Search example
+### Search examples
 
-*Note: this gem does not (yet) support searching by image upload, only by image URL.*
+#### Search by 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.stats.total_results    # => 2
+results.stats.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
 ```
 
+#### Search by upload
+
+```ruby
+tineye = Tinplate::TinEye.new
+results = tineye.search(image_path: "/home/alice/example.jpg")
+```
+
 #### Optional search parameters
 
 `offset`: Default 0    
@@ -70,15 +77,20 @@ end
 An `OpenStruct` object with the following attributes (/w example values):
 
 ```ruby
+domain: "ucsb.edu",
+top_level_domain: "ucsb.edu",
 width: 400
 height: 300
-size: 50734
+size: 50734,
+filesize: 195840,
+score: 88.9,
+tags: ["collection"],
 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.
+  # These are also OpenStruct objects, not Hashes.
   [
     {
       url: "http://example-copier.com/photo.jpg",

data/lib/tinplate/request_authenticator.rb

@@ -1,12 +1,16 @@
 # https://services.tineye.com/developers/tineyeapi/authentication.html
 
+require "securerandom"
+require "uri"
+require "openssl"
+
 module Tinplate
   class RequestAuthenticator
 
     def initialize(action, params = {}, image_name = "")
       @action = action
       @params = params
-      @image_name = image_name
+      @image_name = image_name || ""
       @nonce = SecureRandom.hex
       @date  = Time.now.to_i
     end
@@ -20,21 +24,29 @@ module Tinplate
       }
     end
 
+    def verb
+      @image_name.empty? ? "GET" : "POST"
+    end
+
+    def content_type
+      verb == "GET" ? "" : "multipart/form-data; boundary=-----------RubyMultipartPost"
+    end
+
     def signature_components
       [
         Tinplate.configuration.private_key,
-        "GET",
-        "", # Content-Type for GET requests is blank
-        URI.encode(@image_name).downcase,
+        verb,
+        content_type,
+        URI.encode_www_form_component(@image_name).downcase,
         @date.to_i,
         @nonce,
-        "http://api.tineye.com/rest/#{@action}/",
+        "https://api.tineye.com/rest/#{@action}/",
         hash_to_sorted_query_string(@params),
       ]
     end
 
     def signature
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"),
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"),
                               Tinplate.configuration.private_key,
                               signature_components.join)
     end

data/lib/tinplate/search_results.rb

@@ -1,9 +1,8 @@
 module Tinplate
   class SearchResults < OpenStruct
     def initialize(data)
-      super total_backlinks: data["total_backlinks"],
-            total_results:   data["total_results"],
-            matches:         parsed_matches(data["matches"])
+      super stats:   OpenStruct.new(data["stats"]),
+            matches: parsed_matches(data["results"]["matches"])
     end
 
     private

data/lib/tinplate/tineye.rb

@@ -3,34 +3,56 @@ module Tinplate
     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
+    def search(image_path: nil, image_url: nil, offset: 0, limit: 100, sort: "score", order: "desc")
+      raise ArgumentError.new("You must supply an image or image_url") if !image_url && !image_path
       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"])
+      options = {
+        offset: offset.to_s,
+        limit: limit.to_s,
+        sort: sort,
+        order: order
+      }
+      img = image_url ? { image_url: image_url } : { image_path: image_path }
+
+      response = request("search", options.merge(img))
+
+      Tinplate::SearchResults.new(response)
     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"]))
+
+      bundles = results["bundles"].map do |bundle|
+        OpenStruct.new(remaining_searches: bundle["remaining_searches"],
+                       start_date:  Time.parse(bundle["start_date"]),
+                       expire_date: Time.parse(bundle["expire_date"]))
+      end
+
+      OpenStruct.new(total_remaining_searches: results["total_remaining_searches"], bundles: bundles)
     end
 
     def image_count
       request("image_count")["results"]
     end
 
-
     private
 
     def request(action, params = {})
-      auth = Tinplate::RequestAuthenticator.new(action, params)
+      http_verb = :get
+
+      upload = if params[:image_path]
+        http_verb = :post
+        Faraday::UploadIO.new(params.delete(:image_path), "image/jpeg")
+      end
+
+      auth = Tinplate::RequestAuthenticator.new(action, params, upload && upload.original_filename)
       params.merge!(auth.params)
 
-      response = ::JSON.parse(connection.get("#{action}/", params).body)
+      params.merge!(image_upload: upload) if upload
+
+      response = ::JSON.parse(connection.send(http_verb, "#{action}/", params).body)
 
       if response["code"] != 200
         raise Tinplate::Error.from_response(response["code"], response["messages"][0], response["messages"][1])
@@ -40,13 +62,13 @@ module Tinplate
     end
 
     def connection
-      @conn ||= Faraday.new(url: "http://api.tineye.com/rest/") do |faraday|
+      @conn ||= Faraday.new(url: "https://api.tineye.com/rest/") do |faraday|
+        faraday.request  :multipart
         faraday.request  :url_encoded
-        faraday.response :logger
         faraday.adapter  Faraday.default_adapter
       end
     end
 
   end
 
-end
+end

data/lib/tinplate/version.rb

@@ -1,3 +1,3 @@
 module Tinplate
-  VERSION = "1.0.2"
+  VERSION = "2.0.2"
 end

data/tinplate.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "tinplate"
   spec.version       = Tinplate::VERSION
   spec.authors       = ["Aaron Klaassen"]
-  spec.email         = ["aaron@crew.co"]
+  spec.email         = ["aaron@unsplash.com"]
 
   spec.summary       = %q{A wrapper around the TinEye API.}
   spec.homepage      = "https://github.com/unsplash/tinplate"
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday", [">= 0.9.2", "< 2.0.0"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake",    "~> 10.0"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: tinplate
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.2
 platform: ruby
 authors:
 - Aaron Klaassen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2020-10-08 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,9 +86,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
-- aaron@crew.co
+- aaron@unsplash.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -108,7 +114,7 @@ homepage: https://github.com/unsplash/tinplate
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +129,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
 specification_version: 4
 summary: A wrapper around the TinEye API.
 test_files: []