under_fire 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb1de4137e3e56a58f163f7410cd950f0c9353be
+  data.tar.gz: 86cc6bc36b6ae0b03d190627e7efdbbdfa37cd27
+SHA512:
+  metadata.gz: cf75d52b9dc93330343d74dd287bf48d39a86a2af86045ecd7bfc6417d1bc68f7819b754735ba9b177114583c4cc121c80b39d96dfff5880e2e7307e1c6bf13a
+  data.tar.gz: e1ec64051f8a67670dbf316495e8db128338d098943e73edb5cc7bef784812e58142450e799c27d613e0887496cf147f14a1be1d78932e42a72f91d8be13f39e

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in under_fire.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/lib/under_fire/(.*)_spec\.rb})
+  watch(%r{^lib/under_fire/(.+)\.rb})         { |m| "spec/lib/under_fire/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb})
+  # watch(%r{^test/test_helper\.rb}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Thompson
+
+MIT License
+
+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.md

@@ -0,0 +1,3 @@
+# UnderFire
+
+Wraps Gracenote's API in Ruby goodness. Still under development. 

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/under_fire'
+  t.test_files = FileList['spec/lib/under_fire/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/under-fire

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'under_fire'
+
+UnderFire::CLI.start(ARGV)

data/lib/under_fire/album_fetch.rb

@@ -0,0 +1,50 @@
+require 'under_fire/base_query'
+require 'builder'
+
+module UnderFire
+  # Builds XML for Gracenote's ALBUM_FETCH query.
+  #
+  # @see https://developer.gracenote.com/sites/default/files/web/html/index.html#Music%20Web%20API/ALBUM_FETCH.html#_Toc344907262
+  #
+  # @example
+  #   search = UnderFire::Album_Fetch.new(:gn_id => '86372321-2C7F28ADC369EB90E53A7F6CA3A70D56') 
+  #   search.query => Response = The Beatles, Help!
+  class AlbumFetch < BaseQuery
+    # @return [String] XML string for query.
+    attr_reader :query
+
+    # @return [Hash] Search parameters with :mode removed.
+    attr_reader :parameters
+
+    # @return [String] Gracenote ID for album
+    attr_accessor :gn_id
+    
+    # Requires album :gn_id or track :gn_id
+    #
+    # @param [Hash] args the arguments for Album_Fetch
+    # @option args [String] :gn_id Gracenote ID of album or track
+    # @option args [String] :mode Either 'SINGLE_BEST' or 'SINGLE_BEST_COVER' 
+    #   (Only needed if track :gn_id used)
+    def initialize(args)
+      super args
+      @parameters = args.reject {|k,v| k == :mode}
+      parameters.each do |k,v| send("#{k}=", v) end
+      @query = build_query 
+    end
+   
+    # Builds ALBUM_FETCH-specific part of ALBUM_FETCH query and adds it to the base query
+    # common to all query types. Called by constructor.
+    #
+    # @return [String] XML string for ALBUM_FETCH query.
+    def build_query
+      build_base_query do |builder|
+        builder.query(cmd: "ALBUM_FETCH"){
+          builder.mode "SINGLE_BEST_COVER"
+          parameters.each do |k,v|
+            builder.gn_id gn_id
+          end
+        }
+      end
+    end
+  end
+end

data/lib/under_fire/album_search.rb

@@ -0,0 +1,64 @@
+require 'under_fire/base_query'
+require 'builder'
+
+module UnderFire
+  # Builds XML for Gracenote's ALBUM_SEARCH query. 
+  #
+  # @see https://developer.gracenote.com/sites/default/files/web/html/index.html#Music%20Web%20API/ALBUM_SEARCH.html#_Toc344907249
+  #  
+  # @example
+  #   search = UnderFire::AlbumSearch.new(:artist => 'Radiohead')
+  #   search.query #=> XML for Gracenote ALBUM_SEARCH query for albums by Radiohead.
+  #   
+  #   search = UnderFire::AlbumSearch.new(:track_title = > 'Paranoid Android',
+  #                                       :artist => 'Radiohead',
+  #                                       :mode => 'SINGLE_BEST_COVER')
+  #   search.query #=> XML for ALBUM_SEARCH 
+  # 
+  # 
+  class AlbumSearch < BaseQuery
+    # @return [String] XML string for query.
+    attr_reader :query
+
+    # @return [Hash] search parameters without :mode
+    attr_reader :parameters
+
+    # @return [String]
+    attr_accessor :artist
+
+    # @return [String]
+    attr_accessor :track_title
+    
+    # @return [String]
+    attr_accessor :album_title
+    
+    # At least one of :artist, :track_title, :album_title is required (:mode is optional).
+    # 
+    # @param [Hash] args the arguments for an Album_Search.
+    # @option args [String] :artist Name of the artist.
+    # @option args [String] :track_title Name of the song/track.
+    # @option args [String] :album_title Name of the album.
+    # @option args [String] :mode Either 'SINGLE_BEST' or 'SINGLE_BEST_COVER'
+    def initialize(args={})
+      super args[:mode]
+      @parameters = args.reject {|k,v| k == :mode}
+      parameters.each do |k,v| send("#{k}=", v) end
+      @query = build_query
+    end
+
+    # Builds ALBUM_SEARCH-specific part of ALBUM_SEARCH query and adds it to the base query
+    # common to all query types. Called by constructor.
+    #
+    # @return [String] XML string for ALBUM_SEARCH query.
+    def build_query
+      build_base_query do |builder|
+        builder.query(cmd: "ALBUM_SEARCH"){
+          builder.mode "SINGLE_BEST_COVER"
+          parameters.each do |k,v|
+            builder.text(v, type: k.to_s.upcase)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/under_fire/album_toc_search.rb

@@ -0,0 +1,45 @@
+require 'under_fire/base_query'
+require 'builder'
+
+module UnderFire
+  # Builds XML for Gracenote's ALBUM_TOC query
+  #
+  # @see 'https://developer.gracenote.com/sites/default/files/web/html/index.html#Music%20Web%20API/ALBUM_TOC.html#_Toc344907258'
+  #
+  # @example
+  #   search = UnderFire::AlbumTOCSearch.new(:toc => '182 10762 22515 32372 43735 53335 63867 78305 89792 98702 110612 122590 132127 141685')
+  #   search.query #=> XML query string for ALBUM_TOC query.
+  class AlbumTOCSearch < BaseQuery
+    # @return [String] CD Table of contents.
+    attr_reader :toc
+    
+    # @return [String] XML string for ALBUM_TOC query.
+    attr_reader :query
+
+    # :toc is required (:mode is optional).
+    # 
+    # @param [Hash] args arguments to create an ALBUM_TOC query.
+    # @option [String] :toc CD table of contents (space-separated list of track start frames)
+    # @option [String] :mode Either 'SINGLE_BEST' or 'SINGLE_BEST_COVER'
+    def initialize(args)
+      super args[:mode]
+      @toc = args[:toc]
+      @query = build_query
+    end
+
+    # Builds TOC-specific part of ALBUM_TOC query and adds it to the base query
+    # common to all query types. Called by constructor.
+    #
+    # @return [String] XML string for ALBUM_TOC query.
+    def build_query
+      build_base_query do |builder|
+        builder.query(cmd: "ALBUM_TOC"){
+          builder.mode mode
+          builder.toc {
+            builder.offsets toc
+          }
+        }
+      end
+    end
+  end
+end

data/lib/under_fire/api_request.rb

@@ -0,0 +1,50 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'open-uri'
+
+module UnderFire
+  # HTTP requests required for Gracenote API.
+  #
+  # @todo Error handling
+  #
+  # @example
+  #   response = UnderFire::ApiRequest.post(query_xml, api_url)
+  #
+  #   response = UnderFire::ApiRequest.get_file(image_url, filename)
+  class APIRequest
+    # @param [String] query XML query string
+    # @param [String] api_url url for your application
+    # @return [Net::HTTPResponse]
+    def self.post(query, api_url)
+      uri = URI(api_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.ssl_version = 'SSLv3'
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.body = query
+      req['Content-Type'] = 'application/xml'
+      res = http.request(req)
+      res 
+    end
+    
+    # @param [String] url URL that points to file.
+    # @param [String] filename Filename and path for saving downloaded file.
+    def self.get_file(url, filename)
+      uri = URI url
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Get.new uri
+        
+        http.request request do |response|
+          open filename, 'w' do |io|
+            response.read_body do |chunk|
+              io.write chunk
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/under_fire/api_response.rb

@@ -0,0 +1,57 @@
+require 'nori'
+
+module UnderFire
+  # Wraps query response, providing to_h and to_s methods for easy processing.
+  class APIResponse
+    # @return [Hash] Response as Hash.
+    attr_reader :response
+    
+    # @param [String] response XML string.
+    def initialize(response)
+      @response = parse_response(response)
+    end
+    
+    # @return [Hash] Hash representation of response.
+    def to_h
+      response[:responses]
+    end
+
+    # @return [String] String represenation suitable for command line.
+    def to_s
+      recursive_to_s(to_h)
+    end
+
+    # @return [Boolean] Did the query return something?
+    def success?
+      response[:responses][:response][:@status] == 'OK'
+    end
+
+    private 
+    
+    # Recursively walks nested hash structure to return string representation.
+    # @return [String] Flat string representation of nest Hash.
+    def recursive_to_s(hash)
+      output = ""
+      hash.each do |k,v|
+        if v.is_a? Hash
+          output << "\n"
+          output << "#{k}:\n#{recursive_to_s(v)}\n"
+        elsif v.is_a? Array
+          output << "\n"
+          v.each {|i| output << "#{recursive_to_s(i)}\n" }
+        else
+          output << "#{k}: #{v}\n"
+        end
+      end
+      output
+    end
+
+    # Builds hash from XML response.
+    # @param [String] response XML response string.
+    # @return [Hash] Hash representation of response.
+    def parse_response(response)
+      parser = Nori.new(:convert_tags_to => lambda {|tag| tag.snakecase.to_sym })
+      parser.parse(response)
+    end
+  end
+end

data/lib/under_fire/base_query.rb

@@ -0,0 +1,30 @@
+require 'under_fire/configuration'
+require 'builder'
+
+module UnderFire
+  # Builds an XML query with information common to all queries (to be subclassed by individual queries).
+  class BaseQuery
+    # @return [String]
+    attr_reader :mode
+    
+    # @param [String] mode Either 'SINGLE_BEST' or 'SINGLE_BEST_COVER' (defaults to 'SINGLE_BEST_COVER').
+    def initialize(mode="SINGLE_BEST_COVER")
+      @mode = mode || "SINGLE_BEST_COVER"
+    end
+
+    # @yield [Builder] builder object used by subclass's build_query method.
+    def build_base_query(&block)
+      builder = Builder::XmlMarkup.new
+      builder.queries {
+        builder.auth {
+          builder.client Configuration.client_id
+          builder.user Configuration.user_id
+        }
+        builder.lang "eng"
+        builder.country "canada"
+        builder.app_info %Q{app="under-fire #{VERSION}", os="#{RUBY_PLATFORM}"}
+        yield builder
+      }
+    end
+  end
+end

data/lib/under_fire/cli.rb

@@ -0,0 +1,66 @@
+require 'thor'
+require 'under_fire/api_request'
+require 'under_fire/api_response'
+require 'under_fire/album_toc_search'
+require 'under_fire/album_search'
+require 'under_fire/toc_reader'
+
+module UnderFire
+  # Command Line interface
+  class CLI < Thor
+    include UnderFire
+
+    def initialize(*)
+      super
+    end
+
+    desc  "toc", "Uses `discid` to get a CD's table of contents and then " +
+      "uses the TOC to query Gracenote for album information."
+    def toc
+      search = AlbumTOCSearch.new(:toc => TOCReader.read)
+      response = APIRequest.post(search.query, Configuration.api_url)
+      say APIResponse.new(response.body).to_s
+    end
+
+    desc "album", "Queries Gracenote with album <title>, <song> title, or <artist> name"
+    method_option :album_title,
+      :aliases => '-t',
+      :desc => "Specify album title",
+      :required => false
+    method_option :track_title,
+      :aliases => ['-s', :song_title],
+      :desc => "Specify song title",
+      :required => false
+    method_option :artist,
+      :aliases => '-a',
+      :desc => "Specify artist name",
+      :required => false
+    def album
+      search = AlbumSearch.new(options)
+      request = APIRequest.post(search.query, Configuration.api_url)
+      say APIResponse.new(request.body).to_s
+    end
+    
+    desc "id", "Fetches album info using given Gracenote ID."
+    method_option :gn_id, :aliases => ['-i', '--id'], :required => true,
+      :desc => "Gracenote album or song GN_ID"
+    def id
+      search = AlbumFetch.new(options)
+      request = APIRequest.post(search.query, Configuration.api_url)
+      say APIResponse.new(request.body).to_s
+    end 
+
+    desc "cover", "Gets cover from Gracenote."
+    method_option :url, :aliases => '-u', :required => true,
+      :desc => "URL provided by Gracenote for downloading cover image."
+    method_option :file_name, :aliases => '-f', :required => false,
+      :desc => "File name for saving image."
+    def cover
+      say "Fetching cover"
+      url = options[:url]
+      file_name = options[:file_name].empty? ? "cover.jpg" : options[:file_name]
+      APIRequest.get_file(url, file_name)
+      say "saved #{file_name} in #{File.dirname __FILE__}"
+    end
+  end
+end

data/lib/under_fire/client.rb

@@ -0,0 +1,72 @@
+require 'under_fire/album_search'
+require 'under_fire/album_toc_search'
+require 'under_fire/album_fetch'
+require 'under_fire/api_request'
+require 'under_fire/api_response'
+require 'under_fire/configuration'
+require 'under_fire/toc_reader'
+
+require 'pry'
+
+module UnderFire
+  # Public interface to UnderFire's functionality.
+  #
+  # @example
+  #   client = UnderFire::Client.new
+  #   client.album_search(:artist => 'Miles Davis') #=> lots of results
+  #   
+  #   client = UnderFire::Client.new
+  #   client.find_by_toc
+  class Client
+    include UnderFire
+
+    # @return [String] API URL for application.
+    attr_reader :api_url
+
+    def initialize
+      @api_url = Configuration.api_url
+    end
+
+    # Searches for album using TOC of CD in drive.
+    # @return [APIResponse] 
+    # @see UnderFire::AlbumTOCSearch
+    def find_by_toc
+      search = AlbumTOCSearch.new(get_toc)
+      response = APIRequest.post(search.query, api_url)
+      APIResponse.new(response.body)
+    end
+    
+    # Finds album using one or more of :artist, :track_title and :album_title
+    # @return [APIResponse]
+    # @see UnderFire::AlbumSearch Description of arguments.
+    def find_album(args)
+      search = AlbumSearch.new(args)
+      response = APIRequest.post(search.query, api_url)
+      APIResponse.new(response.body)
+    end
+    
+    # Fetches album with given album :gn_id or track :gn_id
+    # @return [APIResponse]
+    # @see UnderFire::AlbumFetch Description of arguments.
+    def fetch_album(args)
+      search = AlbumFetch.new(args)
+      response = APIRequest.post(search.query, api_url)
+      APIResponse.new(response.body)
+    end
+
+    # Fetches cover art using results of query.
+    # @param [APIResponse] response
+    def fetch_cover(response)
+      res = response.to_h
+      response_url = res['RESPONSE']['ALBUM']['URL']
+      title = res['RESPONSE']['ALBUM']['TITLE']
+      APIRequest.get_file(response_url, "#{title}-cover.jpeg")
+    end
+
+    private
+
+    def get_toc
+      TOCReader.read
+    end
+  end
+end

data/lib/under_fire/configuration.rb

@@ -0,0 +1,39 @@
+module UnderFire
+  # Configuration information. Currently stored as environment variables.
+  module Configuration
+    # Gracenote client id stored in environment variable.
+    # @return [String]
+    def client_id
+      ENV['GRACENOTE_CLIENT_ID']
+    end
+
+    # Part of client id before the hyphen (used by api_url).
+    # @return [String]
+    def client_id_string
+      ci_string, _ = ENV['GRACENOTE_CLIENT_ID'].split('-')
+      ci_string
+    end
+
+    # Part of client id after hyphen
+    # @return [String]
+    def client_tag
+      _, ct = ENV['GRACENOTE_CLIENT_ID'].split('-')
+      ct
+    end
+
+    # Gracenote user id stored as environment variable.
+    # @return [String]
+    def user_id
+      ENV['GRACENOTE_USER_ID']
+    end
+
+    # Gracenote API url for use in queries.
+    # @return [String]
+    def api_url
+      "https://c#{client_id_string}.web.cddbp.net/webapi/xml/1.0/"
+    end
+
+    module_function :client_id, :client_tag, :api_url, :user_id,
+                    :client_id_string
+  end
+end

data/lib/under_fire/registration.rb

@@ -0,0 +1,29 @@
+require 'under_fire/configuration'
+require 'builder'
+
+module UnderFire
+  # Register an application using client_id (only needs to be done once per application).
+  #
+  # @see https://developer.gracenote.com/sites/default/files/web/html/index.html#Music%20Web%20API/Registration%20and%20Authentication.html#_Toc344907213
+  class Registration
+    # @return [String] XML string for query 
+    attr_reader :query
+    
+    def initialize
+      @query = build_query
+    end
+    
+    # Builds XML for REGISTRATION query.
+    #
+    # @return [String] XML string for REGISTRATION
+    def build_query
+      builder = Builder::XmlMarkup.new
+      xml = builder.queries {
+        builder.query(cmd: 'REGISTER'){
+        builder.client UnderFire::Configuration.client_id
+        }
+      }
+      xml
+    end
+  end
+end

data/lib/under_fire/toc_reader.rb

@@ -0,0 +1,19 @@
+require 'discid'
+
+module UnderFire
+  # Reads CD and returns table of contents (start frame of each track).
+  # 
+  # @example
+  #   UnderFire.TOCReader.read
+  class TOCReader
+    # @return [Array<String>] array of start frame strings
+    def self.read
+      device = "/dev/cdrom"
+      disc = DiscId.read(device)
+      toc = []
+      disc.tracks {|t| toc << t.offset.to_s}
+      toc.join(" ")
+    end
+  end
+end
+

data/lib/under_fire/version.rb

@@ -0,0 +1,10 @@
+module UnderFire
+  # Because I always forget:
+  #
+  # Given a version number MAJOR.MINOR.PATCH, increment the:
+  #   MAJOR version when you make incompatible API changes,
+  #   MINOR version when you add functionality in a backwards-compatible manner, and
+  #   PATCH version when you make backwards-compatible bug fixes.
+  #   Refer to: http://semver.org/
+  VERSION = "0.6.1"
+end

data/lib/under_fire.rb

@@ -0,0 +1,13 @@
+require 'under_fire/version'
+require 'under_fire/configuration'
+require 'under_fire/album_search'
+require 'under_fire/album_fetch'
+require 'under_fire/registration'
+require 'under_fire/api_request'
+require 'under_fire/api_response'
+require 'under_fire/album_toc_search'
+require 'under_fire/cli'
+
+# A wrapper library for the Gracenote web API that also provides a command line executable (under-fire).
+module UnderFire
+end