tinplate 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba23118a45b0d10c153fc40b6b3e65c600a4854e
-  data.tar.gz: 5be87df8bd610dc667f30d81bbe2248ec881aec9
+  metadata.gz: cd4d09eedc78227f59705e1178ce27d024270fe2
+  data.tar.gz: ac0c1b55d669aad4ca94b24cfec7802aae73ed33
 SHA512:
-  metadata.gz: e4e3cf73996b52331ff949cd81527dc6b337c4d0ab2a2efc5848201ad681adf34803680ef12b822fcb48e23a8bc5589ebfda4137e5406bae45fb9819b34fb31f
-  data.tar.gz: 0cec435914711cb5fba98aa01fd42682e794700faaa425970e0d104a0eb5ae531e7631199bf26563847e20e1f5d470519daed3f6f617dc6c3290d6cfa93db789
+  metadata.gz: 87de49e77f7b78d21a613390a47443e1b6b44602b64f0faf2fb6dd8dacb184e91b0dc5319f9e47eb4c2dd0f4ce1c76ddf13f08a3927a82652a2684830abf5184
+  data.tar.gz: e1496130dcde0c1484a2adba0f989fe6a6cf087be4c915aaa59ca81d474d7ca3c07bb67c938a9a3773f86b87ee32d5b55056735b5c6a17e927288359ebf82d37

data/Gemfile

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

data/README.md

@@ -12,11 +12,15 @@ gem 'tinplate'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install tinplate
+```bash
+$ gem install tinplate
+```
 
 ## Configuration
 
@@ -24,7 +28,6 @@ First you've got to let Tinplate know what your TinEye API keys are. In a Rails
 
 ```ruby
 Tinplate.configure do |config|
-  config.public_key  = "YOUR PUBLIC API KEY"
   config.private_key = "YOUR PRIVATE API KEY"
   config.test        = false
 end
@@ -49,9 +52,9 @@ There are only three API actions available: `search`, `remaining_searches` (to c
 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.
@@ -77,9 +80,14 @@ results = tineye.search(image_path: "/home/alice/example.jpg")
 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,

data/lib/tinplate/configuration.rb

@@ -2,10 +2,8 @@ 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
 
@@ -17,13 +15,9 @@ module Tinplate # :nodoc:
       !!@test
     end
 
-    def public_key
-      test? ? SANDBOX_PUBLIC_KEY : @public_key
-    end
-
     def private_key
       test? ? SANDBOX_PRIVATE_KEY : @private_key
     end
 
   end
-end
+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

@@ -18,14 +18,19 @@ module Tinplate
 
       response = request("search", options.merge(img))
 
-      Tinplate::SearchResults.new(response["results"])
+      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
@@ -42,12 +47,12 @@ module Tinplate
         Faraday::UploadIO.new(params.delete(:image_path), "image/jpeg")
       end
 
-      auth = Tinplate::RequestAuthenticator.new(action, params, upload && upload.original_filename)
-      params.merge!(auth.params)
-
       params.merge!(image_upload: upload) if upload
 
-      response = ::JSON.parse(connection.send(http_verb, "#{action}/", params).body)
+      headers = { "x-api-key" => Tinplate.configuration.private_key }
+
+      response = connection.send(http_verb, "#{action}/", params, headers)
+      response = ::JSON.parse(response.body)
 
       if response["code"] != 200
         raise Tinplate::Error.from_response(response["code"], response["messages"][0], response["messages"][1])
@@ -58,9 +63,9 @@ module Tinplate
 
     def connection
       @conn ||= Faraday.new(url: "https://api.tineye.com/rest/") do |faraday|
-        faraday.request  :multipart
-        faraday.request  :url_encoded
-        faraday.adapter  Faraday.default_adapter
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
       end
     end
 

data/lib/tinplate/version.rb

@@ -1,3 +1,3 @@
 module Tinplate
-  VERSION = "1.1.0"
+  VERSION = "2.1.0"
 end

data/tinplate.gemspec

@@ -19,10 +19,10 @@ 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"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake",    ">= 12.3.3"
   spec.add_development_dependency "rspec",   "~> 3.4.0"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,57 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: tinplate
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Klaassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2021-11-12 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +105,6 @@ files:
 - 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

data/lib/tinplate/request_authenticator.rb

@@ -1,59 +0,0 @@
-# https://services.tineye.com/developers/tineyeapi/authentication.html
-
-require "securerandom"
-require "uri"
-
-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 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,
-        verb,
-        content_type,
-        URI.encode_www_form_component(@image_name).downcase,
-        @date.to_i,
-        @nonce,
-        "https://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