imagga_auto_tag 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4641b1a4efb8144d051899306c267d815af2b56
-  data.tar.gz: 68caa48fab91beecd93d3fe9deea06f65c02de6a
+  metadata.gz: ba0f79257f3870199b4fe58456689d1a662df130
+  data.tar.gz: e9bac6cf0ea659bd41bc3ebfbbd4a6d9ec3faa1e
 SHA512:
-  metadata.gz: dfff46a628f1958c5adfe6d658a84adb18a532bfdb894a7fc11c4f2c7af2bdf4a79a4468e452bb94d07aeb378a4e9b44173297a17edb55a99ff0ab533258d93e
-  data.tar.gz: ae4ae9f7f9434ff21b989bfa4bd2408e2f062c048e6c869cba83cf1af9e538956894189b9c04254e84c284cd284066755f5d19a1d76fef4345b83ccb36950bf9
+  metadata.gz: 9f1006744a9f922271ebb57105b1b90863e011d113a85be8bf6021080884b61e9c58a4b7584413057c6853cbb34d395280bf321f20c97d91bde508d98c95b573
+  data.tar.gz: 8e2654c3102ae01a2c9637b16754550f95d0d3922dc328a60b94e1eda9d0f704c0d43f09855040e96e2dda949c5f52546b290c4dc3707034e20c8c369c1439ae

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-client = ImaggaAutoTag::Client.new(your_imagga_api_key)
+client = ImaggaAutoTag::Client.new(your_imagga_api_key, your_imagga_api_secret)
 results = client.fetch("http://static.ddmcdn.com/gif/landscape-photography-1.jpg")
 
 results.tags
@@ -47,3 +47,7 @@ results.to_csv
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Version
+
+**0.2.0** : Change the API endpoint and the way authentication is done.

data/imagga_auto_tag.gemspec

@@ -8,9 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ImaggaAutoTag::VERSION
   spec.authors       = ["Luke Chesser"]
   spec.email         = ["luke@unsplash.com"]
-  spec.summary       = %q{Imagga Auto Tagging API client}
-  spec.description   = %q{Ruby wrapper around the Imagga Auto Tagging API}
-  spec.homepage      = "https://github.com/lukechesser/imagga-auto-tag"
+  spec.summary       = %q{Simple wrapper around the Imagga Auto Tagging API}
+  spec.homepage      = ""
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/imagga_auto_tag/client.rb

@@ -1,23 +1,38 @@
+require 'base64'
+
 module ImaggaAutoTag
   
   class Client
 
-    IMAGGA_API_BASE_URL = "https://api.imagga.com" || ENV['IMAGGA_API_BASE_URL']
-    IMAGGA_API_TAG_PATH = "/draft/tags" || ENV['IMAGGA_API_TAG_PATH']
+    IMAGGA_API_BASE_URL = "https://api.imagga.com"
+    IMAGGA_API_TAG_PATH = "/v1/tagging"
 
     attr_reader :response
 
-    def initialize(api_key)
-      @api_key = api_key
-      @conn = Faraday.new(:url => IMAGGA_API_BASE_URL)
+    # Initialize a new client to fetch information from IMAGGA
+    #
+    # ==== Attributes
+    # * +api_key+ `String` of your IMAGGA api key
+    # * +api_secret+ `String` of your IMAGGA api secret
+    #
+    # ===== Examples
+    # client = ImaggaAutoTag::Client.new(api_key, api_secret)
+    def initialize(api_key, api_secret)
+      @conn = Faraday.new(url: IMAGGA_API_BASE_URL)
+      @conn.basic_auth api_key, api_secret
     end
 
+    # Fetch the JSON information for a specific image
+    #
+    # ==== Attributes
+    # * +url+ `String` of the image URL to analyse
+    #
+    # ==== Examples
+    # # Create a new client
+    # client = ImaggaAutoTag::Client.new(api_key, api_secret)
+    # client.fetch(image_url_string)
     def fetch(url)
-      @response = @conn.get do |req|
-        req.url IMAGGA_API_TAG_PATH
-        req.params['api_key'] = @api_key
-        req.params['url'] = url
-      end
+      @response = @conn.get IMAGGA_API_TAG_PATH, {url: url}
 
       TaggedImage.new(@response)
     end

data/lib/imagga_auto_tag/tagged_image.rb

@@ -5,11 +5,15 @@ module ImaggaAutoTag
     attr_reader :status, :tags
 
     def initialize(api_response)
+      # The response from Imagga is now wrap in a results envelop
+      #
+      # ==== Result
+      # { "results" => [{ "image" => "", "tags" => [{}, {}, {}] }] }
       body = JSON.parse(api_response.body)
 
       @tags = []
 
-      body['tags'].each do |tag|
+      body['results'][0]['tags'].each do |tag|
         @tags.push Tag.new(tag)
       end
 

data/lib/imagga_auto_tag/version.rb

@@ -1,3 +1,3 @@
 module ImaggaAutoTag
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/imagga_auto_tag_spec.rb

@@ -5,7 +5,7 @@ describe "An Imagga Auto Tag API" do
   context "client" do
 
     before(:each) do
-      @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'])
+      @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'], ENV['IMAGGA_API_SECRET'])
     end
 
     it "connects" do
@@ -22,7 +22,7 @@ describe "An Imagga Auto Tag API" do
     
     before do
       VCR.use_cassette('image') do
-        @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'])
+        @client = ImaggaAutoTag::Client.new(ENV['IMAGGA_API_KEY'], ENV['IMAGGA_API_SECRET'])
         @results = @client.fetch("http://static.ddmcdn.com/gif/landscape-photography-1.jpg")
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imagga_auto_tag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Luke Chesser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby wrapper around the Imagga Auto Tagging API
+description: 
 email:
 - luke@unsplash.com
 executables: []
@@ -130,7 +130,7 @@ files:
 - spec/cassettes/image.yml
 - spec/imagga_auto_tag_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/lukechesser/imagga-auto-tag
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -153,7 +153,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Imagga Auto Tagging API client
+summary: Simple wrapper around the Imagga Auto Tagging API
 test_files:
 - spec/cassettes/image.yml
 - spec/imagga_auto_tag_spec.rb