isrc 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in isrc.gemspec
+gemspec
+
+group :test do
+  gem 'guard-rspec'
+  
+  if RUBY_PLATFORM.downcase.include? "darwin"
+   gem 'rb-fsevent'
+   gem 'growl'
+ end
+end

data/Guardfile

@@ -0,0 +1,36 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 Michael Bianco
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# ISRC
+
+Gem to pull isrc code data from [PPL UK's database](http://repsearch.ppluk.com/ARSWeb/appmanager/ARS/main).
+
+Although this gem uses ppluk's DB, the goal is support more DBs as the need arises.
+
+## Installation
+
+Add this line to your application's Gemfile or install manually.
+
+## Usage
+
+	class Song
+	  def update_isrc
+	    retriever = ISRC::PPLUK.new
+	    retriever.retrieve artist: self.artist, title: self.title
+	    isrc_match = retriever.match(time: self.song_length)
+	
+	    self.isrc = isrc_match[:isrc]
+	    self.match_quality = isrc_match[:delta]
+	  end
+	end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Copyright (c) 2012 Michael Bianco, released under the New BSD License

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/isrc.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/isrc/version', __FILE__)
+
+Gem::Specification.new do |g|
+  g.authors       = ["Michael Bianco"]
+  g.email         = ["info@cliffsidedev.com"]
+  g.description   = "Pull ISRC codes from PPLK UK's database"
+  g.summary       = "Gem to pull ISRC codes from PPL UK's database. " + 
+                    "Match by artist and title."
+  g.homepage      = "http://github.com/iloveitaly/isrc"
+
+  g.files         = `git ls-files`.split($\)
+  g.executables   = g.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  g.test_files    = g.files.grep(%r{^(test|spec|features)/})
+  g.name          = "isrc"
+  g.require_paths = ["lib"]
+  g.version       = ISRC::VERSION
+
+  g.add_dependency 'httparty'
+  g.add_dependency 'nokogiri'
+  g.add_dependency 'mechanize'
+
+  g.add_development_dependency 'rspec'
+  g.add_development_dependency 'guard'
+end

data/lib/isrc.rb

@@ -0,0 +1,146 @@
+require "isrc/version"
+
+require 'nokogiri'
+require 'mechanize'
+require 'logger'
+
+module ISRC
+  # NOTE the cont=A is crucial to getting the trick to work
+  PPLUK_SESSION_GRAB_URL = 'http://repsearch.ppluk.com/ARSWeb/appmanager/ARS/main'
+  PPLUK_AJAX_SEARCH_URL = 'http://repsearch.ppluk.com/ARSWeb/block/send-receive-updates'
+
+  class PPLUK
+    def retrieve(opts)
+      puts "INFO #{opts[:artist]}:#{opts[:title]}"
+      agent = Mechanize.new
+      agent.log = Logger.new "mech.log"
+      agent.user_agent_alias = 'Mac Safari'
+
+      isrc_session_init = agent.get PPLUK_SESSION_GRAB_URL
+      view_state = self.extract_view_state(isrc_session_init.body)
+      ice_session, ice_session_count = self.extract_ice_session(isrc_session_init.body)
+
+      # add the ice_sessions cookie
+      ice_cookie = Mechanize::Cookie.new('ice.sessions', "#{ice_session}##{ice_session_count}")
+      ice_cookie.path = "/"
+      ice_cookie.domain = "repsearch.ppluk.com"
+      agent.cookie_jar.add!(ice_cookie)
+
+      # NOTE the online search is a bit funky: adding more to the search make the results worse
+      # trying out a three word limit
+
+      shortened_title = opts[:title]
+
+      # TODO remove '(Club Mix)' from titles
+      # TODO remove anything in brackets
+
+      if shortened_title.count(' ') > 2
+        shortened_title = shortened_title.split(' ').slice(0, 3).join(' ')
+      end
+
+      begin
+        isrc_search = agent.post PPLUK_AJAX_SEARCH_URL, {
+          'ice.submit.partial' => 'false',
+          # 'ice.event.target' => 'T400335881332330323192:ars_form:search_button',
+          # 'ice.event.captured' => 'T400335881332330323192:ars_form:search_button',
+          # 'ice.event.type' => 'onclick',
+          # 'ice.event.alt' => 'false',
+          # 'ice.event.ctrl' => 'false',
+          # 'ice.event.shift' => 'false',
+          # 'ice.event.meta' => 'false',
+          # 'ice.event.x' => '47',
+          # 'ice.event.y' => '65',
+          # 'ice.event.left' => 'false',
+          # 'ice.event.right' => 'false',
+          'T400335881332330323192:ars_form:search_button' => 'Search',
+          'T400335881332330323192:ars_form:isrc_code' => '',
+          'T400335881332330323192:ars_form:rec_title_idx' => '',
+          'T400335881332330323192:ars_form:rec_title' => shortened_title,
+          'T400335881332330323192:ars_form:rec_band_artist_idx' => '',
+          'T400335881332330323192:ars_form:rec_band_artist' => opts[:artist],
+          'javax.faces.RenderKitId' => 'ICEfacesRenderKit',
+          'javax.faces.ViewState' => view_state,
+          'icefacesCssUpdates' => '',
+          'T400335881332330323192:ars_form' => '',
+          'ice.session' => ice_session,
+          'ice.view' => view_state,
+          'ice.focus' => '',
+
+          # the rand is 19 characters long in the browser's HTTP requests
+          'rand' => sprintf('%1.17f', rand)
+        }
+      rescue Mechanize::ResponseCodeError => e
+        agent.log.error "The Stuff #{e.page.body}"
+      end
+
+      # creates an array representation of the table:
+      #   artist, title, isrc, released, time
+      isrc_html = Nokogiri::HTML(isrc_search.body)
+      @matches = isrc_html.css("table[id='T400335881332330323192:ars_form:searchResultsTable'] tbody tr").map do |m|
+        columns = m.css('td')
+
+        # if there is no ISRC don't bother looking
+        next if columns[2] == 'Not Supplied'
+
+        # zero length music wont be used
+        next if columns[-1] == '0:00sec'
+
+        columns.map &:text
+      end
+    end
+
+    def match(opts = {})
+      return {
+        :isrc => 'No Match',
+        :delta => -1
+      } if @matches.count == 0
+
+      return {
+        :artist => @matches.first[0],
+        :title => @matches.first[1],
+        :isrc => @matches.first[2],
+        :delta => 0
+      } if @matches.count == 1
+
+      seconds = opts[:time]
+
+      if seconds
+        # if string, convert to integer. Format '5:08'
+        seconds = timestring_to_integer(seconds) if seconds.class == String
+        match_quality = []
+
+        @matches.each do |song_match|
+          song_seconds = timestring_to_integer(song_match[4].match(/([0-9]:[0-9]{2})/)[1])
+          match_quality << { :delta => (song_seconds - seconds).abs, :match => song_match }
+        end
+
+        best_match = match_quality.min_by { |m| m[:delta] }
+
+        return {
+          :artist => best_match[:match][0],
+          :title => best_match[:match][1],
+          :isrc => best_match[:match][2],
+          :delta => best_match[:delta]
+        }
+      end
+
+      nil
+    end
+
+    protected
+    def extract_view_state(body)
+      body.match(/javax\.faces\.ViewState" value="([0-9])"/)[1]
+    end
+
+    def extract_ice_session(body)
+      session_info = body.match(/history-frame:([^:]+):([0-9]+)/)
+      [session_info[1], session_info[2].to_i]
+    end
+
+    def timestring_to_integer(time_string)
+      minutes, seconds = time_string.split(':')
+      minutes.to_i * 60 + seconds.to_i
+    end
+
+  end
+end

data/lib/isrc/version.rb

@@ -0,0 +1,3 @@
+module ISRC
+  VERSION = "1.0.0"
+end

data/spec/isrc_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'isrc'
+
+describe ISRC do
+  before { @isrc = ISRC::PPLUK.new }
+  let(:isrc) { @isrc }
+
+  it "should correctly handle multiple search results" do
+    isrc.retrieve artist: 'Coldplay', title: 'Clocks'
+    isrc.match(time:'5:08')[:isrc].should == 'GBAYE0200771'
+  end
+
+  it "should correctly handle a single search result" do
+    isrc.retrieve artist: 'Coldplay', title: 'Glass'
+    isrc.match(time:'5:08')[:isrc].should == 'GBAYE0800410'    
+  end
+
+  it "should handle songs with multiple results" do
+    isrc.retrieve artist:'Soul II Soul', title: 'Back To Life (However Do You Want Me) (Club Mix)'
+    isrc.match(time:'7:39')[:isrc].should == 'GBAAA8900153'
+
+    # the better match seems to be: GB1209500610
+    # however, the length delta is huge
+
+  end
+
+  it "should handle songs with no results" do
+    isrc.retrieve artist:'The Rurals', title: 'Take Your Time'
+    isrc.match(time:'7:27')[:isrc].should == 'No Match'
+
+    isrc = ISRC::PPLUK.new
+    isrc.retrieve artist:'Slut Puppies', title:'Funky Together' 
+    isrc.match(time:'6:36')[:isrc].should == 'No Match'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: isrc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Bianco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pull ISRC codes from PPLK UK's database
+email:
+- info@cliffsidedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- isrc.gemspec
+- lib/isrc.rb
+- lib/isrc/version.rb
+- spec/isrc_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/iloveitaly/isrc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem to pull ISRC codes from PPL UK's database. Match by artist and title.
+test_files:
+- spec/isrc_spec.rb
+- spec/spec_helper.rb