discogs 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.1.0 / 2008-09-03
+
+* Fixes by Andreas Roedl <andreas.roedl@googlemail.com>
+
+  * Images works as expected. Returns the main URI.
+  * Fixed Artist.releases.
+  * Fixed Artist.urls. Now we get an array of URLs. We're also chomping line feeds.
+  * Minor documentation fixes.
+
 === 1.0.0 / 2008-07-08
 
 * 1 major enhancement

data/README.txt

@@ -1,4 +1,4 @@
-= discog
+= discogs
 
 * http://discogs.rubyforge.org
 
@@ -26,46 +26,49 @@ And a bin util
 
 == SYNOPSIS:
 
-d = Discog::Artist.new(ARGV[0])
-puts "
-Artist:     #{d.name}
-Members:    #{d.members}
-Images:     #{d.images}
-URLs:       #{d.urls}
-Releases:   #{d.releases.map{|r| r.title }}
-"
-
-release = Discog::Release.new('188365')
-puts "
-Title:        #{release.title}
-Labels:       #{release.labels}
-Format:       #{release.formats}
-Status:       #{release.discog_status}
-Genres:       #{release.genres}
-Styles:       #{release.styles}
-Country:      #{release.country}
-ReleaseDate:  #{release.released}
-Tracks        #{release.tracks}
-Images:       #{release.images}
-Extras:       #{release.contributors.join(', ')}
-"
-
-label = Discog::Label.new(ARGV[0])
-puts "
-Name:         #{label.name}
-Images:       #{label.images}
-Contact:      #{label.contact_info}
-Profile:      #{label.profile}
-URLs:         #{label.urls}
-Parent:       #{label.parent}
-SubLabels:    #{label.sublabels}
-Releases:     #{label.releases}
-"
+The first time discogs tries to make an api call, it will look for a YAML file '~/.discogs' or 'RAILS_ROOT/config/discogs.yml'.
+If it doesn't exist, it will be created, and will need editing.  Paste your discogs api key in place of 'CHANGE ME'.
+
+	artist = Discog::Artist.new('Broken Social Scene')
+	puts "
+	Artist:     #{artist.name}
+	Members:    #{artist.members}
+	Images:     #{artist.images}
+	URLs:       #{artist.urls}
+	Releases:   #{artist.releases.map{|r| r.title }}
+	"
+
+	release = Discog::Release.new('188365')
+	puts "
+	Title:        #{release.title}
+	Labels:       #{release.labels}
+	Format:       #{release.formats}
+	Status:       #{release.discog_status}
+	Genres:       #{release.genres}
+	Styles:       #{release.styles}
+	Country:      #{release.country}
+	ReleaseDate:  #{release.released}
+	Tracks        #{release.tracks}
+	Images:       #{release.images}
+	Extras:       #{release.contributors.join(', ')}
+	"
+
+	label = Discog::Label.new(ARGV[0])
+	puts "
+	Name:         #{label.name}
+	Images:       #{label.images}
+	Contact:      #{label.contact_info}
+	Profile:      #{label.profile}
+	URLs:         #{label.urls}
+	Parent:       #{label.parent}
+	SubLabels:    #{label.sublabels}
+	Releases:     #{label.releases}
+	"
 
 == REQUIREMENTS:
 
-rubygems
-hpricot
+- rubygems
+- hpricot
 
 == INSTALL:
 

data/Rakefile

@@ -14,8 +14,8 @@ end
 
 desc "Run all specs in spec directory"
 Spec::Rake::SpecTask.new(:spec) do |t|
-#  t.rcov = true
-#  t.rcov_opts = ["--output=coverage"]
+  t.rcov = true
+  t.rcov_opts = ["--output=coverage"]
   t.spec_opts = ["--color"]
   t.spec_files = FileList['spec/*_spec.rb']
 end

data/lib/artist.rb

@@ -8,21 +8,28 @@ module Discogs
                   :images,
                   :realname
 
+    # Discogs Data
     def name
       @name ||= (parsed/'artist'/'name').first.inner_html
     end
 
+    # Discogs Data
     def realname
-      @realname ||= (parsed/'artist'/'realname').first.inner_html
+      @realname ||= begin
+        realname = (parsed/'artist'/'realname').first
+        realname.nil? ? '' : realname.inner_html
+      end
     end
 
+    # Discogs Data
     def members
       @members ||= (parsed/'artist'/'members'/'name').collect { |artist| artist.inner_html }
     end
 
+    # an array images
     def images
       @images ||= (parsed/'artist'/'images'/'image').collect do |image|
-        Image.new(image.attributes['url'], 
+        Image.new(image.attributes['uri'], 
                   image.attributes['type'],
                   image.attributes['uri150'],
                   image.attributes['width'],
@@ -30,17 +37,21 @@ module Discogs
       end
     end
 
+    # an array of urls
     def urls
-      @urls ||= (parsed/'artist'/'urls').collect { |url| (url/'url').inner_html }
+      @urls ||= (parsed/'artist'/'urls'/'url').collect { |url| url.inner_html.chomp }
     end
 
+    # for each release on the artist
+    # this will make a new API request
+    # for each release.  Be careful!!!
     def releases
       @release ||= (parsed/'artist'/'releases'/'release').collect do |release| 
-        Release.new(api_key, release.attributes['id']) 
+        Release.new(release.attributes['id']) 
       end
     end
 
-    def to_s
+    def to_s #:nodoc:
       name
     end
   end

data/lib/base.rb

@@ -17,49 +17,60 @@ module Discogs
       @request_type = request_type.to_s
     end
 
+    # Hpricot parsed XML
     def parsed
       @parsed ||= Hpricot.XML(fetched)
     end
 
-    def fetched
+    def fetched #:nodoc:
       @fetched ||= begin
+        begin
         gz = Zlib::GzipReader.new(open(request_url, 'Accept-encoding' => 'gzip, deflate'))
         fetched = gz.read
         gz.close
+        rescue
+          fetched = open(request_url).read
+        end
         fetched
       end
     end
 
     protected
-      def request_url
+      def request_url #:nodoc:
         "#{DISCOGS_BASE_URL}/#{request_type}/#{CGI::escape(request_string)}?f=xml&api_key=#{api_key}"
       end
 
-      def load_api_key
+      # try to load api key from yaml file
+      # If it doesn't exist, then create it
+      def load_api_key #:nodoc:
         begin
           YAML::load(open(config_file))[:api_key]
         rescue Errno::ENOENT
           File.open(config_file, 'w') do |file|
             file.write({:api_key => "CHANGE ME"}.to_yaml)
-            puts "Please edit #{config_file}"
           end
+          logger.warn "DISCOGS:: Please edit #{config_file}"
         end
       end
       
-      def home_dir
+      def home_dir #:nodoc:
         ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH']
       end
 
-      def config_filename(rails = false)
+      def config_filename(rails = false) #:nodoc:
         rails ? 'discogs.yml' : '.discogs'
       end
 
-      def config_file
+      def config_file #:nodoc:
         if defined?(RAILS_ROOT)
-          File.join(RAILS_ROOT, 'config', config_filename)
+          File.join(RAILS_ROOT, 'config', config_filename(true))
         else
           File.join(home_dir, config_filename)
         end
       end
+
+      def logger #:nodoc:
+        @logger ||= (ActiveRecord::Base.logger || Logger.new)
+      end
   end
 end

data/lib/contributor.rb

@@ -6,8 +6,8 @@ module Discogs
       @role = role
     end
 
-    def to_s
-      name
+    def to_s #:nodoc:
+      "#{name} as #{role}"
     end
   end
 end

data/lib/discogs.rb

@@ -5,6 +5,7 @@ require 'hpricot'
 require 'zlib'
 require 'cgi'
 
+# discgs gem libraries
 require 'base'
 require 'artist'
 require 'label'
@@ -17,6 +18,6 @@ require 'search'
 
 
 module Discogs
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   API_VERSION = '1.0'
 end

data/lib/format.rb

@@ -6,7 +6,7 @@ module Discogs
       @qty = qty
     end
 
-    def to_s
+    def to_s #:nodoc:
       name
     end
   end

data/lib/image.rb

@@ -15,7 +15,7 @@ module Discogs
       @height = height
     end
 
-    def to_s
+    def to_s #:nodoc:
       uri
     end
   end

data/lib/label.rb

@@ -4,17 +4,20 @@ module Discogs
 
     def initialize(request_string)
       @request_string = request_string
-      super(@request_string, 'label')
+      super(@request_string, :label)
     end
 
+    # Discogs Data
     def label
       @label ||= (parsed/'label')
     end
 
+    # Discogs Data
     def name
       @name ||= (label/'name').inner_html
     end
 
+    # An array of image objects
     def images
       @images ||= (label/'images'/'image').collect do |image| 
         Image.new(image.attributes['url'], 
@@ -25,18 +28,23 @@ module Discogs
       end
     end
 
+    # Discogs Data
     def contact_info
       @contact_info ||= (label/'contactinfo').inner_html
     end
 
+    # Discogs Data
     def profile
       @profile ||= (label/'profile').inner_html
     end
 
+    # Discogs Data
+    # An array of strings
     def urls
       @url ||= (label/'urls'/'url').collect { |url | url.inner_html }
     end
 
+    # parent label if applicable
     def parent
       @parent_label ||= begin
         Label.new((label/'parentLabel').inner_html) unless (label/'parentLabel').empty?
@@ -44,6 +52,7 @@ module Discogs
       end
     end
 
+    # sublabels if applicable
     def sublabels
       @sub_labels ||= begin
         (label/'sublabels'/'label').collect do |label| 
@@ -54,6 +63,9 @@ module Discogs
       end
     end
 
+    # Be careful, this creates a Release object for each release.
+    # Data is lazy loaded, so an API call will be created as soon
+    # as you access the attributes
     def releases
       @releases ||= begin
         (label/'releases'/'release').collect do |release| 
@@ -63,7 +75,7 @@ module Discogs
       end
     end
 
-    def to_s
+    def to_s #:nodoc:
       name
     end
   end

data/lib/release.rb

@@ -21,40 +21,50 @@ module Discogs
       super
     end
 
+    # status as determined by discogs
+    # 'Approved', etc..
     def discog_status
       @discog_status ||= (parsed/'release').first.attributes['status']
     end
 
+    # Discogs Data
     def title
       @title ||= (parsed/'title').first.inner_html
     end
 
+    # Discogs Data
     def labels
       @labels ||= (parsed/'labels'/'label').collect { |label| label.attributes['name'] }
     end
 
+    # Discogs Data
     def genres
       @genres ||= (parsed/'genres'/'genre').collect { |genre| genre.inner_html }
     end
 
+    # Discogs Data
     def styles
       @styles ||= (parsed/'styles'/'style').collect{ |label| label.inner_html }
     end
 
+    # Discogs Data
     def country
       @country ||= (parsed/'country').inner_html
     end
 
+    # Discogs Data
     def released
       @released ||= (parsed/'released').inner_html
     end
 
+    # An array of Format objects
     def formats
       @formats ||= (parsed/'formats'/'format').collect do |format| 
         Format.new(format.attributes['name'], format.attributes['qty'])
       end
     end
 
+    # An array of Track objects
     def tracks
       @tracks ||= (parsed/'tracklist'/'track').collect do |track|
         Track.new((track/'position').inner_html,
@@ -64,6 +74,7 @@ module Discogs
       end
     end
 
+    # An array of Image objects
     def images
       @images ||= (parsed/'images'/'image').collect do |image|
         Image.new(image.attributes['url'], 
@@ -74,18 +85,19 @@ module Discogs
       end
     end
 
+    # An array of Contributor objects
     def contributors
       @contributors ||= (parsed/'extraartists'/'artist').collect do |artist| 
         Contributor.new((artist/'name').inner_html, (artist/'role').inner_html)
       end
     end
 
-    def to_s
+    def to_s #:nodoc:
       "#{title} - #{label} - #{released} - #{format}"
     end
 
     protected
-      def request_url
+      def request_url #:nodoc:
         "#{DISCOGS_BASE_URL}/release/#{discog_id}?f=xml&api_key=#{api_key}"
       end
   end

data/lib/search.rb

@@ -13,14 +13,17 @@ module Discogs
       super
     end
 
+    # size of exact search phrase matches
     def exactresult_size
       @exactresult_size ||= exactresults.size
     end
 
+    # size of fuzzy matches
     def result_size
-      (parsed/'searchresults').first.attributes['end'].to_i
+      @result_size ||= (parsed/'searchresults').first.attributes['end'].to_i
     end
 
+    # results that match the search phrase exactly
     def exactresults
       (parsed/'exactresults'/'result').collect do |result|
         SearchResult.new(
@@ -30,9 +33,9 @@ module Discogs
           (result/'summary').inner_html
         )
       end
-
     end
 
+    # fuzzy results
     def results
       (parsed/'searchresults'/'result').collect do |result|
         SearchResult.new(
@@ -44,6 +47,8 @@ module Discogs
       end
     end
 
+    # use the exact results to get more data using another
+    # api call based on the result type
     def best_match
       first_result = exactresults.first
       if first_result.artist?
@@ -53,8 +58,8 @@ module Discogs
     end
 
     protected
-      def request_url
-        "#{base_url}/search?type=#{search_type}&q=#{request_string}&f=xml&api_key=#{api_key}"
+      def request_url #:nodoc:
+        "#{DISCOGS_BASE_URL}/search?type=#{search_type}&q=#{CGI::escape(request_string)}&f=xml&api_key=#{api_key}"
       end
   end
 
@@ -71,14 +76,14 @@ module Discogs
       @summary = summary
     end
 
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &block) #:nodoc:
       type = method.to_s.match(/([a-zA-Z0-9_-]+)\?/)
       # if type.size < 2 the method did not have a question mark at the end
       super if type.size < 2
       @type == type[1].to_s
     end
 
-    def to_s
+    def to_s #:nodoc:
       "#{title}"
     end
     

data/lib/track.rb

@@ -10,7 +10,7 @@ module Discogs
       @duration = duration
     end
     
-    def to_s
+    def to_s #:nodoc:
       title
     end
   end

data/spec/artist_spec.rb

@@ -32,3 +32,13 @@ describe Discogs::Artist do
     @artist.releases.should eql([mock_release]*59)
   end
 end
+describe Discogs::Artist do
+  describe "network connections" do
+    it "does not make more connections than it needs" do
+      @artist = Discogs::Artist.new('Broken Social Scene')
+      @artist.name
+      sleep 2
+      @artist.realname
+    end
+  end
+end

data/spec/search_spec.rb

@@ -27,4 +27,12 @@ describe Discogs::Search do
   it "returns fuzzy result size" do
     @search.result_size.should eql(20)
   end
+
+# this is not mocked.  use for real-deal testing
+#  describe "advanced searching" do
+#    it "returns some junk" do
+#      search = discogs::search.new('broken social scene')
+#      puts search.exactresults
+#    end
+#  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: discogs
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Josh Stephenson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-13 00:00:00 -06:00
+date: 2008-09-04 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency