under_fire 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb1de4137e3e56a58f163f7410cd950f0c9353be
-  data.tar.gz: 86cc6bc36b6ae0b03d190627e7efdbbdfa37cd27
+  metadata.gz: 5e1d93ad915cfe697878585aedf307b541a00865
+  data.tar.gz: d1cda0cfee2c6b7ef2e661de7a2c2405b543d438
 SHA512:
-  metadata.gz: cf75d52b9dc93330343d74dd287bf48d39a86a2af86045ecd7bfc6417d1bc68f7819b754735ba9b177114583c4cc121c80b39d96dfff5880e2e7307e1c6bf13a
-  data.tar.gz: e1ec64051f8a67670dbf316495e8db128338d098943e73edb5cc7bef784812e58142450e799c27d613e0887496cf147f14a1be1d78932e42a72f91d8be13f39e
+  metadata.gz: f56978420c9b2efca82e1525d927f5247deb5781ab3751454e0148386314fd709290686a1f6c0cd90c13f59c4291d9c27b62d5303f30642ae21410a52ab47e8c
+  data.tar.gz: 2f4f939608621eb84705b0acdad307c0dc1c89280f1fbb2bd22db730e262148684447609b5d268940b9d8e44795f60b40f129a3086a5b20de3aa0865c99d685f

data/.ackrc

@@ -0,0 +1 @@
+--type=ruby

data/Changelog

@@ -0,0 +1,2 @@
+* Extracted toc_reader to its own gem (cdtoc).
+

data/README.md

@@ -1,3 +1,144 @@
 # UnderFire
 
-Wraps Gracenote's API in Ruby goodness. Still under development. 
+Wraps Gracenote's Web API in Ruby goodness. UnderFire provides two interfaces: a client to use from your projects and a command line interface.
+
+## Installation
+
+```ruby
+gem install under_fire
+```
+or in your gemfile:
+
+```ruby
+gem 'under_fire'
+
+```
+## Registration
+
+Before using UnderFire, you need to obtain a `client_id` and `user_id` from Gracenote as described below.
+
+### Obtain client_id
+
+-To obtain a client_id, visit http://developer.gracenote.com and register yourself for a developer account. Once your account is created, go to "My Apps" and create a new app. Finaly, open your new app from your My Apps page to obtain your "Client ID for Mobile Client, Web API, and eyeQ".
+
+-Now on your computer you need to add your `client_id` to your environment. On OSX or Linux you can do this by adding the following line to your `.bashrc`, `.zshrc` or wherever you prefer to set your environment variables:
+
+```shell
+export GRACENOTE_CLIENT_ID=your-client_id-here
+
+```
+After doing this, open a new terminal or type the following at the command prompt:
+
+```
+source ~/.bashrc
+
+```
+or
+
+```
+source ~/.zshrc
+
+```
+
+To test this out type the following in your terinal:
+
+```
+echo $GRACENOTE_CLIENT_ID
+
+``` 
+
+### Obtain user_id
+
+-Now you're ready to use UnderFire's register task to obtain your `user_id`. At the command prompt, type:
+
+```
+under-fire register -c `echo $GRACENOTE_CLIENT_ID`
+
+```
+Copy your `user_id` from the output and add to your environment by entering the folloing in your `.bashrc` or `.zshrc` as you did with your `client_id` above:
+
+```shell
+export GRACENOTE_USER_ID=your-user_id-here
+
+```
+Once again, ensure that your current environment is up to date by opening a new terminal or sourcing the appropriate config file.
+
+Now you're ready to get started.
+
+## Usage
+
+### Command line
+
+UnderFire provides a command line interface (CLI) that makes it easy to explore the Gracenote Web API or combine with other UNIX tools in shell scripts. If you followed the registration instructions above, you've already used the CLI's registration task.
+
+Here are some other things you can do:
+
+Look up the album called "Armed Forces":
+
+```
+under-fire album -t "Armed Forces"
+
+```
+
+
+Look up "Armed Forces", fetch its cover art, and save it as "armed-forces.jpg in the current folder:
+
+```
+under-fire album -t "Armed Forces" | grep url | awk '{ print $2 }' | xargs under-fire cover -f "armed-forces.jpg" -u
+
+```
+For more information:
+
+```
+under-fire -h
+
+```
+If you want to search by a cd's table of contents, you need to provide the offset for each track on a given CD. To make things easy, I wrote a little gem called `cdtoc`. Just install this in the usual way:
+
+```
+gem install cdtoc
+
+```
+
+Then:
+
+```
+  $ cdtoc | xargs under-fire -o
+
+```
+
+### Programming API
+
+If you're familiar with the Gracenote API, you'll note that I have renamed the commands to make it easier to differentiate between them and to stay with idiomatic Ruby. So, for example, Gracenote's "ALBUM_SEARCH" is called `find_album`.
+
+All requests, with the exception of `fetch_cover`, return an APIResponse class, which provides `to_h` and `to_s` methods. You will probably find the `to_h` method most convenient.
+
+```ruby
+
+require 'under_fire/client'
+
+# First, get a client instance
+client = UnderFire::Client.new
+
+# Search by track title
+client.find_album(:track_title => 'Paranoid Android')
+
+# or use either SINGLE_BEST or SINGLE_BEST_COVER
+# SINGLE_BEST: returns the single best result as decided by Gracenote.
+# SINGLE_BEST_COVER: same as above, but also returns cover URL. Currently this is the default.
+
+album = client.find_album(:track_title => 'Paranoid Android', :mode => 'SINGLE_BEST')
+
+# use query response to fetch the album cover.
+client.fetch_cover(album, "OK_Computer_cover.jpg")
+
+# The following searches by Gracenote album id or track id:
+album = client.fetch_album(:gn_id => '86372321-2C7F28ADC369EB90E53A7F6CA3A70D56')
+
+# If you want to limit your response to one album, use one of the two modes described above.
+
+```
+
+## Roadmap
+
+More convenient APIResponse class that wraps artists and albums in their own classes.

data/lib/under_fire/album_fetch.rb

@@ -7,7 +7,7 @@ module UnderFire
   # @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 = UnderFire::Album_Fetch.new(:gn_id => '86372321-2C7F28ADC369EB90E53A7F6CA3A70D56')
   #   search.query => Response = The Beatles, Help!
   class AlbumFetch < BaseQuery
     # @return [String] XML string for query.
@@ -18,30 +18,30 @@ module UnderFire
 
     # @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' 
+    # @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 
+      @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"
+        builder.QUERY(cmd: "ALBUM_FETCH"){
+          builder.MODE "SINGLE_BEST_COVER"
           parameters.each do |k,v|
-            builder.gn_id gn_id
+            builder.GN_ID gn_id
           end
         }
       end

data/lib/under_fire/album_search.rb

@@ -2,20 +2,20 @@ require 'under_fire/base_query'
 require 'builder'
 
 module UnderFire
-  # Builds XML for Gracenote's ALBUM_SEARCH query. 
+  # 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 
-  # 
-  # 
+  #   search.query #=> XML for ALBUM_SEARCH
+  #
+  #
   class AlbumSearch < BaseQuery
     # @return [String] XML string for query.
     attr_reader :query
@@ -28,12 +28,12 @@ module UnderFire
 
     # @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.
@@ -52,10 +52,10 @@ module UnderFire
     # @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"
+        builder.QUERY(CMD: "ALBUM_SEARCH"){
+          builder.MODE "SINGLE_BEST_COVER"
           parameters.each do |k,v|
-            builder.text(v, type: k.to_s.upcase)
+            builder.TEXT(v, TYPE: k.to_s.upcase)
           end
         }
       end

data/lib/under_fire/album_toc_search.rb

@@ -12,12 +12,12 @@ module UnderFire
   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'
@@ -33,10 +33,10 @@ module UnderFire
     # @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
+        builder.QUERY(CMD: "ALBUM_TOC"){
+          builder.MODE mode
+          builder.TOC {
+            builder.OFFSETS toc.to_s
           }
         }
       end

data/lib/under_fire/api_request.rb

@@ -26,9 +26,9 @@ module UnderFire
       req.body = query
       req['Content-Type'] = 'application/xml'
       res = http.request(req)
-      res 
+      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)
@@ -36,7 +36,7 @@ module UnderFire
 
       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|

data/lib/under_fire/api_response.rb

@@ -5,12 +5,12 @@ module UnderFire
   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]
@@ -26,8 +26,8 @@ module UnderFire
       response[:responses][:response][:@status] == 'OK'
     end
 
-    private 
-    
+    private
+
     # Recursively walks nested hash structure to return string representation.
     # @return [String] Flat string representation of nest Hash.
     def recursive_to_s(hash)

data/lib/under_fire/base_query.rb

@@ -6,23 +6,27 @@ module UnderFire
   class BaseQuery
     # @return [String]
     attr_reader :mode
-    
+
+    # @return [UnderFire::Configuration]
+    attr_reader :config
+
     # @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"
+      @config = Configuration.instance
     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.QUERIES {
+        builder.AUTH {
+          builder.CLIENT config.client_id
+          builder.USER config.user_id
         }
-        builder.lang "eng"
-        builder.country "canada"
-        builder.app_info %Q{app="under-fire #{VERSION}", os="#{RUBY_PLATFORM}"}
+        builder.LANG "eng"
+        builder.COUNTRY "canada"
+        builder.APP_INFO %Q{APP="under-fire #{VERSION}", OS="#{RUBY_PLATFORM}"}
         yield builder
       }
     end

data/lib/under_fire/cli.rb

@@ -1,25 +1,28 @@
 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'
+require 'under_fire/client'
 
 module UnderFire
   # Command Line interface
   class CLI < Thor
     include UnderFire
 
+    attr_reader :config, :client
+
     def initialize(*)
       super
+      @config = Configuration.instance
+      @client = Client.new()
     end
 
-    desc  "toc", "Uses `discid` to get a CD's table of contents and then " +
-      "uses the TOC to query Gracenote for album information."
+    desc  "toc", "Use provided offsets to query Gracenote for album information."
+    method_option :offsets,
+      :aliases => '-o',
+      :desc => "Specify cd table of contents offsets",
+      :required => true,
+      :type => :array
     def toc
-      search = AlbumTOCSearch.new(:toc => TOCReader.read)
-      response = APIRequest.post(search.query, Configuration.api_url)
-      say APIResponse.new(response.body).to_s
+      say client.find_by_toc(options[:offsets])
     end
 
     desc "album", "Queries Gracenote with album <title>, <song> title, or <artist> name"
@@ -36,31 +39,47 @@ module UnderFire
       :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
+      say client.find_album(options)
     end
-    
-    desc "id", "Fetches album info using given Gracenote ID."
-    method_option :gn_id, :aliases => ['-i', '--id'], :required => true,
+
+    desc "id", "Not yet implemented"
+    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 
+      puts "Not implemented"
+    end
 
     desc "cover", "Gets cover from Gracenote."
-    method_option :url, :aliases => '-u', :required => true,
+    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."
+    method_option :file_name,
+      :aliases => '-f',
+      :required => false,
+      :desc => "File name for saving image.",
+      :default => ""
+    method_option :verbose,
+      :aliases => '-v',
+      :type => :boolean,
+      :required => false,
+      :default => false
     def cover
-      say "Fetching cover"
+      say "Fetching cover" if options[:verbose]
       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__}"
+      say "saved #{file_name} in #{File.dirname __FILE__}" if options[:verbose]
+    end
+
+    desc "register", "Registers user with client_id."
+    method_option :client_id,
+      :aliases => '-c',
+      :required => true
+    def register
+      say client.register(options[:client_id])
     end
   end
 end

data/lib/under_fire/client.rb

@@ -4,7 +4,6 @@ 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'
 
@@ -14,9 +13,9 @@ module UnderFire
   # @example
   #   client = UnderFire::Client.new
   #   client.album_search(:artist => 'Miles Davis') #=> lots of results
-  #   
+  #
   #   client = UnderFire::Client.new
-  #   client.find_by_toc
+  #   client.find_by_toc space_delimited_toc_offsets
   class Client
     include UnderFire
 
@@ -24,18 +23,19 @@ module UnderFire
     attr_reader :api_url
 
     def initialize
-      @api_url = Configuration.api_url
+      @api_url = Configuration.instance.api_url
     end
 
-    # Searches for album using TOC of CD in drive.
-    # @return [APIResponse] 
+    # Searches for album using provided toc offsets.
+    # @return [APIResponse]
     # @see UnderFire::AlbumTOCSearch
-    def find_by_toc
-      search = AlbumTOCSearch.new(get_toc)
+    def find_by_toc(*offsets)
+      offsets = offsets.join(" ")
+      search = AlbumTOCSearch.new(:toc => offsets)
       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.
@@ -44,7 +44,7 @@ module UnderFire
       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.
@@ -54,19 +54,24 @@ module UnderFire
       APIResponse.new(response.body)
     end
 
+    # Registers user with given client_id
+    # @return [APIResponse]
+    # @see UnderFire::Registration Description of arguments
+    def register(client_id)
+      search = Registration.new(client_id)
+      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)
+    def fetch_cover(response, file_name)
       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
+      file_name = file_name || "#{title}-cover.jpg"
 
-    def get_toc
-      TOCReader.read
+      APIRequest.get_file(response_url, filename)
     end
   end
 end

data/lib/under_fire/configuration.rb

@@ -1,30 +1,38 @@
+require 'singleton'
+
 module UnderFire
-  # Configuration information. Currently stored as environment variables.
-  module Configuration
+  # Configuration information.
+  class Configuration
+    include Singleton
+
+    attr_reader :config_info
+
+    def initialize
+      @config_info = load_config
+    end
+
     # Gracenote client id stored in environment variable.
     # @return [String]
     def client_id
-      ENV['GRACENOTE_CLIENT_ID']
+      config_info.fetch(:client_id, nil).to_s
     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
+      client_id.split('-')[0]
     end
 
     # Part of client id after hyphen
     # @return [String]
     def client_tag
-      _, ct = ENV['GRACENOTE_CLIENT_ID'].split('-')
-      ct
+      client_id.split('-')[1]
     end
 
-    # Gracenote user id stored as environment variable.
+    # Gracenote user id
     # @return [String]
     def user_id
-      ENV['GRACENOTE_USER_ID']
+      config_info.fetch(:user_id, nil).to_s
     end
 
     # Gracenote API url for use in queries.
@@ -33,7 +41,27 @@ module UnderFire
       "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
+    # Returns true if user has a user_id
+    # @return [Boolean]
+    def authorized?
+      user_id != nil
+    end
+
+    # Returns true if user has a client_id and user_id
+    # @return [Boolean]
+    def configured?
+      client_id != nil && !authorized?
+    end
+
+    def reset
+      initialize
+    end
+
+    private
+
+    def load_config
+      {:client_id => ENV['GRACENOTE_CLIENT_ID'],
+       :user_id => ENV['GRACENOTE_USER_ID']}
+    end
   end
 end

data/lib/under_fire/registration.rb

@@ -6,21 +6,26 @@ module UnderFire
   #
   # @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 
+    # @return [String] XML string for query
     attr_reader :query
-    
-    def initialize
+
+    # @return [String] Gracenote Client ID
+    attr_reader :client_id
+
+    # @param [String] client_id Gracenote Client ID.
+    def initialize(client_id)
+      @client_id = client_id
       @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 = builder.QUERIES {
+        builder.QUERY(CMD: 'REGISTER'){
+        builder.CLIENT client_id
         }
       }
       xml

data/lib/under_fire/version.rb

@@ -6,5 +6,5 @@ module UnderFire
   #   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"
+  VERSION = "0.7.0"
 end

data/spec/fixtures/.ufrc

@@ -0,0 +1,3 @@
+---
+user_id: 12354534
+client_id: 1252545-34543523452345

data/spec/fixtures/album_response.xml

@@ -0,0 +1,78 @@
+
+      <RESPONSES>
+       <RESPONSE STATUS="OK">
+       <ALBUM><GN_ID>86372321-2C7F28ADC369EB90E53A7F6CA3A70D56</GN_ID>
+       <ARTIST>The Beatles</ARTIST>
+       <TITLE>Help!</TITLE>
+       <PKG_LANG>ENG</PKG_LANG>
+       <GENRE NUM="61364" ID="25332">60&apos;s Rock</GENRE>
+       <TRACK_COUNT>13</TRACK_COUNT>
+       <TRACK>
+          <TRACK_NUM>1</TRACK_NUM>
+          <GN_ID>86372322-05CF584F3265FA67F3E0C18987973C21</GN_ID>
+          <TITLE>Help!</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>2</TRACK_NUM>
+          <GN_ID>86372323-CA2905A4F82908C761E28472D3991EDF</GN_ID>
+          <TITLE>The Night Before</TITLE>
+         </TRACK>
+          <TRACK>
+          <TRACK_NUM>3</TRACK_NUM>
+          <GN_ID>86372324-10C31E8C4C6F7B841A045FF6434AB1B0</GN_ID>
+          <TITLE>You&apos;ve Got To Hide Your Love Away</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>4</TRACK_NUM>
+          <GN_ID>86372325-60EE527589C23B2F648156AD400FF857</GN_ID>
+          <TITLE>I Need You</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>5</TRACK_NUM>
+          <GN_ID>86372326-8DAA1AC1B819C66A28E2CD0EAD9D8222</GN_ID>
+          <TITLE>Another Girl</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>6</TRACK_NUM>
+          <GN_ID>86372327-E0DC3EC15ACDFE8E6880329970F82B78</GN_ID>
+          <TITLE>You&apos;re Going To Lose That Girl</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>7</TRACK_NUM>
+          <GN_ID>86372328-CD35818A7400061D8BC4C08D32E0BB38</GN_ID>
+          <TITLE>Ticket To Ride</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>8</TRACK_NUM>
+          <GN_ID>86372329-50EB4C1E500F3F6C895D0F8C48B9663D</GN_ID>
+          <TITLE>Act Naturally</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>9</TRACK_NUM>
+          <GN_ID>86372330-E6FA805C5DBA2E571935B0B8A7978862</GN_ID>
+          <TITLE>It&apos;s Only Love</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>10</TRACK_NUM>
+          <GN_ID>86372331-3F0E4CF181963FB330FF2001775F0FE1</GN_ID>
+          <TITLE>You Like Me Too Much</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>11</TRACK_NUM>
+          <GN_ID>86372332-5744350BE1E7DF380118F4BD93A98AA4</GN_ID>
+          <TITLE>Tell Me What You See</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>12</TRACK_NUM>
+          <GN_ID>86372333-79F674F3FBB538148DEF9ECF56AD4180</GN_ID>
+          <TITLE>I&apos;ve Just Seen A Face</TITLE>
+          </TRACK>
+          <TRACK>
+          <TRACK_NUM>13</TRACK_NUM>
+          <GN_ID>86372334-6EF61C66E4FE46B76C79D697159F0B97</GN_ID>
+          <TITLE>Yesterday</TITLE>
+          </TRACK>
+          <URL TYPE="COVERART" SIZE="MEDIUM">http://web.content.cddbp.net/cds/2.0?id=28088C817AD817CB&amp;client=866304&amp;class=cover&amp;origin=front&amp;size=medium&amp;type=image/jpeg&amp;tag=02-KSYB0rRmIy4UaXsdI4xheDiM0wIntXI9vxq0J9-tYN8uImMSkQ8hg</URL>
+          </ALBUM>
+          </RESPONSE>
+          </RESPONSES>

data/spec/lib/under_fire/album_fetch_spec.rb

@@ -5,40 +5,27 @@ require 'ox'
 module UnderFire
   describe AlbumFetch do
     subject {AlbumFetch.new(:gn_id => '7F28ADC369EB90E53A7F6CA3A70D56V')}
-      
-    let(:xml){
-      '<queries>'+  
-      '<auth>'+
-      '<client>1234454</client>'+
-      '<user>2353452345243545-454351435kj435j345434</user>'+
-      '</auth>'+
-      '<lang>eng</lang>'+
-      '<country>canada</country>'+
-      '<query cmd="album_fetch">'+
-      '<gn_id>7F28ADC369EB90E53A7F6CA3A70D56V</gn_id>'+
-      '</query>'+
-      '</queries>'}
 
     before do
-          ENV['GRACENOTE_CLIENT_ID'] = '1234454'
-          ENV['GRACENOTE_USER_ID'] = '2353452345243545-454351435kj435j345434'
+      ENV['UF_CONFIG_PATH'] = File.expand_path('spec/fixtures/.ufrc')
+      @config = UnderFire::Configuration.instance
     end
 
     describe "instantiation" do
       it "accepts an album GN_ID as input" do
-        AlbumFetch.new(:gn_id => '7F28ADC369EB90E53A7F6CA3A70D56V').must_be_kind_of UnderFire::AlbumFetch 
+        AlbumFetch.new(:gn_id => '7F28ADC369EB90E53A7F6CA3A70D56V').must_be_kind_of UnderFire::AlbumFetch
       end
     end
 
     describe "#query" do
-      
+
       it "returns properly formed xml" do
         #`Ox.load` returns Ox::ParseError if xml is malformed
         Ox.load(subject.query).must_be_kind_of Ox::Element
       end
-      
+
       it "returns the correct xml query" do
-        subject.query.must_include "gn_id"
+        subject.query.must_include "GN_ID"
         subject.query.must_include "ALBUM_FETCH"
         subject.query.must_include "7F28ADC369EB90E53A7F6CA3A70D56V"
       end

data/spec/lib/under_fire/album_search_spec.rb

@@ -8,21 +8,9 @@ module UnderFire
                              artist: "Radiohead",
                              track_title: "Paranoid Android",
                              album_title: "OK Computer")}
-    let(:xml){
-      '<queries><auth><client>1234454</client>'+
-      '<user>2353452345243545-454351435kj435j345434</user></auth>'+
-      '<lang>eng</lang><country>canada</country>'+
-      '<query cmd="ALBUM_SEARCH">'+
-      '<mode>SINGLE_BEST_COVER</mode>'+
-      '<text type="ALBUM_TITLE">OK Computer</text>'+
-      '<text type="TRACK_TITLE">Paranoid Android</text>'+
-      '<text type="ARTIST">Radiohead</text>'+
-      '</query></queries>'
-    }
 
     before do
-          ENV['GRACENOTE_CLIENT_ID'] = '1234454'
-          ENV['GRACENOTE_USER_ID'] = '2353452345243545-454351435kj435j345434'
+      ENV['UF_CONFIG_PATH'] = File.expand_path('spec/fixtures/.ufrc')
     end
 
     it "accepts a hash of arguments" do
@@ -35,6 +23,11 @@ module UnderFire
         Ox.load(subject.query).must_be_kind_of Ox::Element
       end
 
+      it "returns xml with an auth element" do
+        subject.query.must_include "<AUTH>"
+        subject.query.must_include "</AUTH>"
+      end
+
       describe "with all fields" do
         it "returns the correct xml query" do
           subject.query.must_include "Radiohead"

data/spec/lib/under_fire/album_toc_search_spec.rb

@@ -8,18 +8,9 @@ module UnderFire
         "110612 122590 132127 141685"}
     subject {AlbumTOCSearch.new(toc: toc)}
 
-    let(:xml){
-      '<queries><auth><client>1234454</client>'+
-      '<user>2353452345243545-454351435kj435j345434</user></auth>'+
-      '<lang>eng</lang><country>canada</country>'+
-      '<query cmd="ALBUM_TOC">'+
-      '<mode>SINGLE_BEST_COVER</mode>'+
-      '<toc><offsets>' + toc + '</offsets></toc>'+
-      '</query></queries>'}
-
     before do
-          ENV['GRACENOTE_CLIENT_ID'] = '1234454'
-          ENV['GRACENOTE_USER_ID'] = '2353452345243545-454351435kj435j345434'
+      ENV['UF_CONFIG_PATH'] = File.expand_path('spec/fixtures/.ufrc')
+      @config = UnderFire::Configuration.instance
     end
 
 

data/spec/lib/under_fire/cli_spec.rb

@@ -0,0 +1,49 @@
+require_relative '../../spec_helper'
+require 'rr'
+
+module UnderFire
+  describe CLI do
+    before do
+      @cli = CLI.new
+      @stdout_old = $stdout
+      @stdin_old = $stdin
+      $stdout = StringIO.new
+      $stdin = StringIO.new
+  end
+
+  after do
+    $stdout = @stdout_old
+    $stdin = @stdin_old
+  end
+
+    # describe "#register" do
+    #   before do
+    #     response_body = '<RESPONSES><RESPONSE STATUS="OK"><USER>user_id_string</USER></RESPONSE><RESPONSES>'
+    #     stub_request(:post, "https://c.web.cddbp.net/webapi/xml/1.0/").
+    #       with(:body => "<QUERIES><QUERY cmd=\"REGISTER\"><CLIENT></CLIENT></QUERY></QUERIES>",
+    #            :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/xml', 'User-Agent'=>'Ruby'}).
+    #       to_return(:status => 200, :body => response_body, :headers => {})
+    #     stub.proxy(APIResponse).new(response_body) do |res|
+    #       stub(res).success? { true }
+    #       stub(res).to_h { { :response => { :user => "adfadsfasa-aq34rqfafafsfdasf"}}}
+    #     end
+    #   end
+
+    #   it "works" do
+    #     mock($stdout).puts "\nIn order to proceed, please obtain a Gracenote Client ID."
+    #     mock($stdout).puts "\nTo obtain a Client ID:"
+    #     mock($stdout).puts " 1) Register at http://developer.gracenote.com."
+    #     mock($stdout).puts " 2) Click on Add a New App."
+    #     mock($stdout).puts " 3) Obtain your 'Client ID for Mobile Client, Web API, and eyeQ'"
+    #     mock($stdout).puts " from the App Details."
+    #     mock($stdout).print "\nPlease press [Enter] once you have a Client ID. "
+    #     mock($stdout).print "Enter your client id: "
+    #     mock($stdin).gets {"2352352452454"}
+    #     mock($stdin).gets
+    #     mock($stdout).puts "Saved client_id to /home/jason/.ufrc"
+    #     mock($stdout).puts "Saved user_id to /home/jason/.ufrc"
+    #     @cli.register
+    #   end
+    # end
+  end
+end

data/spec/lib/under_fire/configuration_spec.rb

@@ -1,18 +1,45 @@
 require_relative '../../spec_helper'
+require 'pry'
 
 module UnderFire
   describe Configuration do
+    let(:base_dir){File.expand_path(__FILE__ + "/../../..")}
+    let(:config_file){File.join(base_dir, 'fixtures/.ufrc')}
+
     before do
-      ENV['GRACENOTE_CLIENT_ID'] = "12345668"
-      ENV['GRACENOTE_USER_ID'] = "1432145345-13413554646D35134"
+      ENV["GRACENOTE_USER_ID"] = "12354534"
+      ENV["GRACENOTE_CLIENT_ID"] = "1252545-34543523452345"
+     end
+
+    after do
+      Configuration.instance.reset
     end
 
-    it "has a client_id" do
-      UnderFire::Configuration.client_id.must_equal "12345668"
+    describe "a completed configuration" do
+
+      it "has a client_id" do
+        config = Configuration.instance
+        config.client_id.must_equal "1252545-34543523452345"
+      end
+
+      it "has a user_id" do
+        config = Configuration.instance
+        config.user_id.must_equal "12354534"
+      end
     end
 
-    it "has a user_id" do
-      UnderFire::Configuration.user_id.must_equal "1432145345-13413554646D35134"
+    describe "unconfigured" do
+      before do
+        ENV["GRACENOTE_CLIENT_ID"] = ""
+        ENV["GRACENOTE_USER_ID"] = ""
+      end
+
+      describe "#configured?" do
+        it "returns false if there are no credentials" do
+          config = Configuration.instance
+          config.configured?.must_equal false
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 require 'minitest/doc_reporter'
+require 'webmock/minitest'
 require File.expand_path('../../lib/under_fire.rb', __FILE__)
 

data/todo.txt

@@ -2,5 +2,3 @@
 -To implement:
     * ALBUM_FINGERPRINT
     * ALBUM_FETCH
-    * REGISTRATION
--Use symbols for 'SINGLE_BEST' and 'SINGLE_BEST_COVER'

data/under_fire.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-plus"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "guard-minitest"
   spec.add_development_dependency "rr"
   spec.add_development_dependency "minitest-doc_reporter", "~> 0.6.0"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "ox"
   if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwi/
     spec.add_development_dependency "wdm", ">= 0.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: under_fire
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jason Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,33 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: minitest-doc_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: minitest-doc_reporter
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement
@@ -214,8 +214,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .ackrc
 - .gitignore
 - .ruby-version
+- Changelog
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -233,8 +235,9 @@ files:
 - lib/under_fire/client.rb
 - lib/under_fire/configuration.rb
 - lib/under_fire/registration.rb
-- lib/under_fire/toc_reader.rb
 - lib/under_fire/version.rb
+- spec/fixtures/.ufrc
+- spec/fixtures/album_response.xml
 - spec/lib/under_fire/album_fetch_spec.rb
 - spec/lib/under_fire/album_search_spec.rb
 - spec/lib/under_fire/album_toc_search_spec.rb
@@ -242,6 +245,7 @@ files:
 - spec/lib/under_fire/api_response.rb
 - spec/lib/under_fire/api_response_spec.rb
 - spec/lib/under_fire/base_query_spec.rb
+- spec/lib/under_fire/cli_spec.rb
 - spec/lib/under_fire/configuration_spec.rb
 - spec/sample/response.xml
 - spec/sample/toc.txt
@@ -274,6 +278,8 @@ signing_key:
 specification_version: 4
 summary: An unofficial wrapper for the Gracenote web API
 test_files:
+- spec/fixtures/.ufrc
+- spec/fixtures/album_response.xml
 - spec/lib/under_fire/album_fetch_spec.rb
 - spec/lib/under_fire/album_search_spec.rb
 - spec/lib/under_fire/album_toc_search_spec.rb
@@ -281,6 +287,7 @@ test_files:
 - spec/lib/under_fire/api_response.rb
 - spec/lib/under_fire/api_response_spec.rb
 - spec/lib/under_fire/base_query_spec.rb
+- spec/lib/under_fire/cli_spec.rb
 - spec/lib/under_fire/configuration_spec.rb
 - spec/sample/response.xml
 - spec/sample/toc.txt

data/lib/under_fire/toc_reader.rb

@@ -1,19 +0,0 @@
-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
-