amazon-album-art 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'nokogiri', '>= 1.4.4'
+gem 'sucker', '>= 1.1.4'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    curb (0.7.9)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    sucker (1.1.4)
+      activesupport (>= 2.3.2)
+      curb (~> 0.7.0)
+      nokogiri (~> 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri (>= 1.4.4)
+  rcov
+  shoulda
+  sucker (>= 1.1.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John Allen
+
+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.rdoc

@@ -0,0 +1,48 @@
+= amazon-album-art
+
+A specialized Amazon AWS gem for finding Album Art running on top of the 'sucker' gem
+
+== INSTALLATION:
+
+  gem install amazon-album-art
+  
+== USAGE:
+
+Create a client
+
+  client = AmazonAlbumArt.new('YOUR_ACCESS_KEY', 'YOUR_SECRET_KEY')
+
+Search for all available image sizes
+
+  client.search("phish", "rift")
+  
+Or search for a medium and large image
+
+  client.search("phish", "rift", [:medium, :large])
+
+These methods will return a hash with the found artist and album names along with URL's to the requested image sizes. Example: 
+
+  { :artist => "Phish", :album => "Rift", :images => { :medium => "http://ecx.images-amazon.com/images/I/511RmbQV7dL._SL160_.jpg", :large => "http://ecx.images-amazon.com/images/I/511RmbQV7dL.jpg" } }
+
+* TODO: offer options to return different image sets (Primary, Vibrant etc...)
+
+== ACKNOWLEDGEMENTS 
+
+* The sucker gem by papercavalier does all the heavy lifting: https://github.com/papercavalier/sucker/
+* Grabbed some fuzzy match code from: http://code.coneybeare.net/amazon-album-covers-in-ruby-on-rails/
+
+== Contributing to amazon-album-art
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 John Allen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "amazon-album-art"
+  gem.homepage = "http://github.com/johnallen3d/amazon-album-art"
+  gem.license = "MIT"
+  gem.summary = %Q{A specialized Amazon AWS gem for finding Album Art}
+  gem.description = %Q{A specialized Amazon AWS gem for finding Album Art running on top of the 'sucker' gem}
+  gem.email = "john@threedogconsulting.com"
+  gem.authors = ["John Allen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'nokogiri', '>= 1.4.4'
+  gem.add_runtime_dependency 'sucker', '>= 1.1.4'
+  
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amazon-album-art #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/amazon-album-art.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amazon-album-art}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Allen"]
+  s.date = %q{2011-01-13}
+  s.description = %q{A specialized Amazon AWS gem for finding Album Art running on top of the 'sucker' gem}
+  s.email = %q{john@threedogconsulting.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "amazon-album-art.gemspec",
+    "lib/amazon-album-art.rb",
+    "lib/amazon-album-art/client.rb",
+    "test/helper.rb",
+    "test/test_amazon-album-art.rb"
+  ]
+  s.homepage = %q{http://github.com/johnallen3d/amazon-album-art}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A specialized Amazon AWS gem for finding Album Art}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_amazon-album-art.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_runtime_dependency(%q<sucker>, [">= 1.1.4"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_runtime_dependency(%q<sucker>, [">= 1.1.4"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<sucker>, [">= 1.1.4"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<sucker>, [">= 1.1.4"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<sucker>, [">= 1.1.4"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<sucker>, [">= 1.1.4"])
+  end
+end
+

data/lib/amazon-album-art.rb

@@ -0,0 +1 @@
+require 'amazon-album-art/client'

data/lib/amazon-album-art/client.rb

@@ -0,0 +1,114 @@
+require 'nokogiri'
+require 'sucker'
+
+module AmazonAlbumArt
+
+  def self.new(access_key, secret_key, locale = "us")
+    Client.new(access_key, secret_key, locale)
+  end
+
+  class Client
+
+    def initialize(access_key, secret_key, locale)
+      raise ArgumentError.new("An access and secret key are require") if access_key.blank? || secret_key.blank?
+      
+      @worker = Sucker.new(
+        :locale => "us",
+        :key    => access_key, 
+        :secret => secret_key
+      )
+    end
+
+    def search(artist, album, sizes = [:swatch, :small, :thumbnail, :tiny, :medium, :large])
+      raise ArgumentError.new("An artist and album are required to search") if artist.blank? || album.blank?
+
+      # Prepare a request.
+      @worker << {
+        "Operation"     => "ItemSearch",
+        "SearchIndex"   => "Music",
+        "Title"         => album,
+        "Artist"        => artist
+      }
+
+      # Get a response.
+      results = @worker.get
+
+      # Make sure nothing went awry.
+      raise AmazonAlbumArtError.new("Error finding album") unless results.valid?
+
+      # Now parse it.
+      results.map("Item") do |match|
+        attribs = match['ItemAttributes']
+
+        # grab values that were returned
+        found_artist, found_album = (attribs['Artist'] ||= attribs['Author'] ||= attribs["Creator"]["__content__"]), match['ItemAttributes']['Title']
+
+        # check to see if we have a reasonable match
+        next unless !found_album.blank? && !found_artist.blank? && matches?(album, found_album) && matches?(artist, found_artist)
+
+        # remove params not used for image search
+        @worker.parameters.delete_if { |k,v| %w{SearchIndex Title Artist}.include? k }
+
+        # fetch images
+        @worker << {
+          "Operation"     => "ItemLookup",
+          "IdType"        => "ASIN",
+          "ResponseGroup" => "Images",
+          "ItemId"        => match["ASIN"]
+        }
+
+        # Get a response.
+        images = @worker.get
+
+        # Make sure nothing went awry.
+        raise AmazonAlbumArtError.new("Error finding images") unless images.valid?
+
+        # parse response
+        doc = Nokogiri::XML.parse(images.body)
+
+        urls = {}
+
+        # build the hash with requested values
+        sizes.each do |size|
+          urls.merge!({ size => doc.css("Item > ImageSets > ImageSet[@Category=\"primary\"] > #{size.to_s.capitalize}Image > URL").text })
+        end
+
+        return { :artist => found_artist, :album => found_album, :images => urls }
+      end
+    end
+
+    def matches?(s1, s2, tolerance = 2)
+      s1 == s2 ||
+      s1 =~ /#{Regexp.escape s2}/i ||
+      s2 =~ /#{Regexp.escape s1}/i ||
+      (levenshtein(s1, s2) <= tolerance)
+    end
+
+    def levenshtein(str1, str2)
+      s, t = [str1.unpack('U*'), str2.unpack('U*')]
+      n, m = [s.length, t.length]
+      return m if (0 == n)
+      return n if (0 == m)
+      d = (0..m).to_a
+      x = nil
+      (0...n).each do |i|
+          e = i+1
+          (0...m).each do |j|
+              cost = (s[i] == t[j]) ? 0 : 1
+              x = [d[j+1] + 1, e + 1, d[j] + cost].min
+              d[j] = e
+              e = x
+          end
+          d[m] = x
+      end
+      return x
+    end
+  end
+  
+  class AmazonAlbumArtError < StandardError
+    alias :msg :message
+    def initialize(msg)
+      super(msg)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'amazon-album-art'
+
+class Test::Unit::TestCase
+  def api_key
+    'test_key'
+  end
+
+  def secret_key
+    'secret_key'
+  end
+end

data/test/test_amazon-album-art.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+class TestAmazonAlbumArt < Test::Unit::TestCase
+  context "amazon-album-art module" do
+      should "create a new client" do
+        c = AmazonAlbumArt.new(api_key, secret_key)
+        assert_equal AmazonAlbumArt::Client, c.class
+      end
+    end
+    context "using the amazon-amazon-art client" do
+      setup do
+        @client = AmazonAlbumArt.new(api_key, secret_key)
+      end
+      context "search for known items" do
+        context "and for all images sizes" do
+          setup do
+            @result = @client.search("phish", "rift")
+          end
+          should "return a hash" do
+            assert_kind_of Hash, @result
+          end
+          should "include the found artists name" do
+            assert_equal "Phish", @result[:artist]
+          end
+          should "include the found artists name" do
+            assert_equal "Rift", @result[:album]
+          end
+          should "include an images key" do
+            assert @result.has_key?(:images)
+          end
+          setup do
+            @images = @result[:images]
+          end
+          should "include include all image sizes" do
+            [:swatch, :small, :thumbnail, :tiny, :medium, :large].each do |key|
+              assert @images.has_key?(key)
+            end
+          end
+        end
+        context "and just a medium search" do
+          setup do
+            @result = @client.search("phish", "rift", [:medium])
+          end
+          context "just a medium image" do
+            should "include a medium image url" do
+              assert_equal "http://ecx.images-amazon.com/images/I/511RmbQV7dL._SL160_.jpg", @result[:images][:medium]
+            end
+          end
+        end
+        context "no search values" do
+          should "raise an ArgumentError" do
+            assert_raise ArgumentError do
+              @client.search
+            end
+          end
+        end
+      end
+    end
+    context "no keys" do
+      should "raise an ArgumentError" do
+        assert_raise ArgumentError do
+          AmazonAlbumArt.new
+        end
+      end
+    end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification 
+name: amazon-album-art
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sucker
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: sucker
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id008
+description: A specialized Amazon AWS gem for finding Album Art running on top of the 'sucker' gem
+email: john@threedogconsulting.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- amazon-album-art.gemspec
+- lib/amazon-album-art.rb
+- lib/amazon-album-art/client.rb
+- test/helper.rb
+- test/test_amazon-album-art.rb
+has_rdoc: true
+homepage: http://github.com/johnallen3d/amazon-album-art
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3269156557234574606
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A specialized Amazon AWS gem for finding Album Art
+test_files: 
+- test/helper.rb
+- test/test_amazon-album-art.rb