metal_archives 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 755641bbb04169f0ab112404ec57e72d201931d3
-  data.tar.gz: 54c41255e4483da53612a77ba93a9930838fa3f2
+  metadata.gz: 29c629e0d26e84fff55b4c57c2423e8f46c95547
+  data.tar.gz: 200e49292fd001e2b035f105c5f518323f7659e3
 SHA512:
-  metadata.gz: f793965504ad2eda1a99862aaec0a357eaf6b11b9a6284efaee02deebb4ebe75b81e1bd5b0969ec374aa0046234fdc4e93e91f7564b9fc9e587e938f872eab49
-  data.tar.gz: 23ce29a7f912b72e7701d2bf04dff9ebd717e4f60c8fc75e41cc85c29693a84a767975f0edb889ccfc930e8a86d68ccd0df6f5e190d8bf6309cdab1254c389c9
+  metadata.gz: 6a2443f5b2f8bcdc4dd5d7f8cc96648b1182225d9ba2e27289fb4782fb5b8cbd283ee8995e3b50cb1dbc1c76e7a67edddffb92d8fda8f5d703d03a4dd4a16426
+  data.tar.gz: b824e554a0deac921487b096c93227989d9d1a440969114b6b2cf5fc35acbe7f831d4b7fbed2a8316d18b8e50d4ab298bd54931df1b21b847eaaec12e0052ef7

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Florian Dejonckheere
+
+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

@@ -85,4 +85,4 @@ $ bundle exec rake rdoc
 
 ## Copyright
 
-Copyright 2016 Florian Dejonckheere. See `LICENSE` for further details.
+Copyright 2016 Florian Dejonckheere. All content acquired through the usage of this API is copyrighted by the respective owner.

data/lib/metal_archives.rb

@@ -2,8 +2,10 @@ require 'metal_archives/version'
 require 'metal_archives/configuration'
 require 'metal_archives/error'
 
+require 'metal_archives/utils/range'
+require 'metal_archives/utils/collection'
+
 require 'metal_archives/models/base_model'
-require 'metal_archives/models/range'
 require 'metal_archives/models/label'
 require 'metal_archives/models/artist'
 require 'metal_archives/models/band'

data/lib/metal_archives/models/artist.rb

@@ -178,38 +178,41 @@ module MetalArchives
       ##
       # Search by name
       #
-      # Returns (possibly empty) +Array+ of rdoc-ref:Artist
+      # Returns rdoc-ref:Collection of rdoc-ref:Artist
       #
       # [+name+]
       #     +String+
       #
       def search(name)
-        objects = []
-
         url = 'http://www.metal-archives.com/search/ajax-artist-search/'
-        query = {
-          :name => name,
-          :iDisplayStart => 0
-        }
+        query = { :name => name }
+
+        params = Parsers::Artist.map_params query
 
-        loop do
-          params = Parsers::Artist.map_params query
+        l = lambda do
+          @start ||= 0
 
-          response = HTTPClient.get url, params
+          return [] if instance_variable_defined?('@max_items') and @start >= @max_items
+
+          response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
           json = JSON.parse response.body
 
+          @max_items = json['iTotalRecords']
+
+          objects = []
+
           json['aaData'].each do |data|
             # Create Artist object for every ID in the results list
             id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
             objects << Artist.new(:id => id)
           end
 
-          break if objects.length == json['iTotalRecords']
+          @start += 200
 
-          query[:iDisplayStart] += 200
+          objects
         end
 
-        objects
+        MetalArchives::Collection.new l
       end
     end
   end

data/lib/metal_archives/models/band.rb

@@ -231,7 +231,7 @@ module MetalArchives
       #
       # Refer to {MA's FAQ}[http://www.metal-archives.com/content/help?index=3#tab_db] for search tips.
       #
-      # Returns (possibly empty) +Array+ of rdoc-ref:Band
+      # Returns rdoc-ref:Collection of rdoc-ref:Band
       #
       # [+query+]
       #     Hash containing one or more of the following keys:
@@ -248,29 +248,34 @@ module MetalArchives
       #     - +:independent+: boolean
       #
       def search_by(query)
-        objects = []
-
         url = 'http://www.metal-archives.com/search/ajax-advanced/searching/bands/'
-        query[:iDisplayStart] = 0
 
-        loop do
-          params = Parsers::Band.map_params query
+        params = Parsers::Band.map_params query
+
+        l = lambda do
+          @start ||= 0
 
-          response = HTTPClient.get url, params
+          return [] if instance_variable_defined?('@max_items') and @start >= @max_items
+
+          response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
           json = JSON.parse response.body
 
+          @max_items = json['iTotalRecords']
+
+          objects = []
+
           json['aaData'].each do |data|
             # Create Band object for every ID in the results list
             id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
             objects << Band.new(:id => id)
           end
 
-          break if objects.length == json['iTotalRecords']
+          @start += 200
 
-          query[:iDisplayStart] += 200
+          objects
         end
 
-        objects
+        MetalArchives::Collection.new l
       end
 
       ##

data/lib/metal_archives/utils/collection.rb

@@ -0,0 +1,37 @@
+module MetalArchives
+  ##
+  # Enumerable collection over a paginated resource
+  #
+  class Collection
+    include Enumerable
+
+    ##
+    # Construct a new Collection
+    #
+    # [+proc+]
+    #   +Proc+ or +lambda+, called repeatedly when iterating. Should return an array of results (stateful),
+    #   should return an empty array when there are no results left.
+    #
+    def initialize(proc)
+      @proc = proc
+    end
+
+    ##
+    # Calls the given block once for each element, passing that element as a parameter.
+    # If no block is given, an Enumerator is returned.
+    #
+    def each(&block)
+      return to_enum :each unless block_given?
+
+      loop do
+        items = instance_exec(&@proc)
+
+        items.each do |item|
+          yield item
+        end
+
+        break if items.empty?
+      end
+    end
+  end
+end

data/lib/metal_archives/version.rb

@@ -2,5 +2,5 @@ module MetalArchives
   ##
   # MetalArchives API version
   #
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/test/property/artist_property_test.rb

@@ -12,7 +12,7 @@ class ArtistPropertyTest < Test::Unit::TestCase
   def test_basic_attributes
     artist = MetalArchives::Artist.find 60908
 
-    assert artist.is_a? MetalArchives::Artist
+    assert_instance_of MetalArchives::Artist, artist
     assert_equal 60908, artist.id
     assert_equal 'Alberto Rionda', artist.name
     assert_empty artist.aliases
@@ -25,7 +25,7 @@ class ArtistPropertyTest < Test::Unit::TestCase
 
     artist = MetalArchives::Artist.find 260
 
-    assert artist.is_a? MetalArchives::Artist
+    assert_instance_of MetalArchives::Artist, artist
     assert_equal 'Ian Fraser Kilmister', artist.name
     assert_equal ['Lemmy Kilmister'], artist.aliases
     assert_equal Date.new(2015, 12, 28), artist.date_of_death

data/test/query/artist_query_test.rb

@@ -11,20 +11,20 @@ class ArtistQueryTest < Test::Unit::TestCase
     artist = MetalArchives::Artist.find 60908
 
     assert_not_nil artist
-    assert artist.is_a? MetalArchives::Artist
+    assert_instance_of MetalArchives::Artist, artist
     assert_equal 'Alberto Rionda', artist.name
     assert_equal ISO3166::Country['ES'], artist.country
 
     artist = MetalArchives::Artist.find(999999)
 
-    assert artist.is_a? MetalArchives::Artist
+    assert_instance_of MetalArchives::Artist, artist
   end
 
   def test_find_by
     artist = MetalArchives::Artist.find_by :name => 'Alberto Rionda'
 
     assert_not_nil artist
-    assert artist.is_a? MetalArchives::Artist
+    assert_instance_of MetalArchives::Artist, artist
     assert_equal 'Alberto Rionda', artist.name
     assert_equal 60908, artist.id
     assert_equal ISO3166::Country['ES'], artist.country
@@ -36,9 +36,12 @@ class ArtistQueryTest < Test::Unit::TestCase
   end
 
   def test_search
-    assert_equal 1, MetalArchives::Artist.search('Alberto Rionda').length
-    assert_equal 9, MetalArchives::Artist.search('Name').length
-    assert_equal 0, MetalArchives::Artist.search('SomeNonExistantName').length
-    assert_equal 293, MetalArchives::Artist.search('Filip').length
+    assert_instance_of MetalArchives::Collection, MetalArchives::Artist.search('Alberto Rionda')
+    assert_equal 1, MetalArchives::Artist.search('Alberto Rionda').count
+    assert_equal 9, MetalArchives::Artist.search('Name').count
+    assert_equal 0, MetalArchives::Artist.search('SomeNonExistantName').count
+    assert_equal 293, MetalArchives::Artist.search('Filip').count
+
+    assert !MetalArchives::Artist.search('SomeNonExistantName').any?
   end
 end

data/test/query/band_query_test.rb

@@ -11,7 +11,7 @@ class BandQueryTest < Test::Unit::TestCase
     band = MetalArchives::Band.find 3540361100
 
     assert_not_nil band
-    assert band.is_a? MetalArchives::Band
+    assert_instance_of MetalArchives::Band, band
     assert_equal 'Alquimia', band.name
     assert_equal ISO3166::Country['ES'], band.country
 
@@ -20,14 +20,14 @@ class BandQueryTest < Test::Unit::TestCase
 
     band = MetalArchives::Band.find(2)
 
-    assert band.is_a? MetalArchives::Band
+    assert_instance_of MetalArchives::Band, band
   end
 
   def test_find_by
     band = MetalArchives::Band.find_by :name => 'Falconer'
 
     assert_not_nil band
-    assert band.is_a? MetalArchives::Band
+    assert_instance_of MetalArchives::Band, band
     assert_equal 'Falconer', band.name
     assert_equal 74, band.id
     assert_equal ISO3166::Country['SE'], band.country
@@ -41,44 +41,45 @@ class BandQueryTest < Test::Unit::TestCase
     band = MetalArchives::Band.find_by(:name => 'Alquimia', :country => ISO3166::Country['ES'])
 
     assert_not_nil band
-    assert band.is_a? MetalArchives::Band
+    assert_instance_of MetalArchives::Band, band
     assert_equal 3540361100, band.id
   end
 
   def test_search_by
-    assert_equal 5, MetalArchives::Band.search_by(:name => 'Alquimia').length
+    assert_instance_of MetalArchives::Collection, MetalArchives::Band.search_by(:name => 'Alquimia')
 
-    assert_equal 3, MetalArchives::Band.search_by(:name => 'Lost Horizon').length
-    assert_equal 2, MetalArchives::Band.search_by(:name => 'Lost Horizon', :exact => true).length
+    assert_equal 5, MetalArchives::Band.search_by(:name => 'Alquimia').count
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Lost Horizon').count
+    assert_equal 2, MetalArchives::Band.search_by(:name => 'Lost Horizon', :exact => true).count
+    assert_equal 2, MetalArchives::Band.search_by(:name => 'Alquimia', :genre => 'Melodic Power').count
 
-    assert_equal 2, MetalArchives::Band.search_by(:name => 'Alquimia', :genre => 'Melodic Power').length
 
+    countries = MetalArchives::Band.search('Alquimia').map { |a| a.country }.sort
 
-      countries = MetalArchives::Band.search('Alquimia').map { |a| a.country }.sort
-
-      assert_equal 5, countries.size
-      assert countries.include? ISO3166::Country['AR']
-      assert countries.include? ISO3166::Country['ES']
-      assert countries.include? ISO3166::Country['CL']
+    assert_equal 5, countries.size
+    assert countries.include? ISO3166::Country['AR']
+    assert countries.include? ISO3166::Country['ES']
+    assert countries.include? ISO3166::Country['CL']
 
     assert_equal 5, MetalArchives::Band.search_by(
-              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, nil)).length
+              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, nil)).count
     assert_equal 1, MetalArchives::Band.search_by(
-              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2013), nil)).length
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2013), nil)).count
     assert_equal 1, MetalArchives::Band.search_by(
-              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2008))).length
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2008))).count
     assert_equal 2, MetalArchives::Band.search_by(
-              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2013))).length
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2013))).count
     assert_equal 5, MetalArchives::Band.search_by(
-              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, Date.new(2013))).length
+              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, Date.new(2013))).count
 
-    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['ES']).length
-    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).length
-    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).length
-    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :label => 'Mutus Liber').length
+    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['ES']).count
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).count
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).count
+    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :label => 'Mutus Liber').count
 
-    assert_empty MetalArchives::Band.search_by(:name => 'SomeNonExistantName')
+    assert_equal 0, MetalArchives::Band.search_by(:name => 'SomeNonExistantName').count
+    assert !MetalArchives::Band.search_by(:name => 'SomeNonExistantName').any?
 
-    assert_equal 274, MetalArchives::Band.search_by(:country => ISO3166::Country['CN']).length
+    assert_equal 274, MetalArchives::Band.search_by(:country => ISO3166::Country['CN']).count
   end
 end

data/test/utils/collection_test.rb

@@ -0,0 +1,51 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test/unit'
+
+require 'metal_archives/utils/collection'
+
+class CollectionTest < Test::Unit::TestCase
+  def test_each
+    l = lambda do
+      @i ||= 0
+
+      return [] if @i >= 100
+      items = (@i .. (@i + 9)).to_a
+      @i += 10
+
+      items
+    end
+
+    c = MetalArchives::Collection.new l
+
+    i = 0
+    c.each do |item|
+      assert_equal i, item
+      i += 1
+    end
+
+    assert_equal 100, i
+  end
+
+  def test_return
+    l = lambda do
+      @i ||= 0
+
+      raise StandardError if @i >= 100
+      items = (@i .. (@i + 9)).to_a
+      @i += 10
+
+      items
+    end
+
+    c = MetalArchives::Collection.new l
+
+    i = 0
+    c.each do |item|
+      break if i == 99
+      assert_equal i, item
+      i += 1
+    end
+
+    assert_equal 99, i
+  end
+end

data/test/{range_test.rb → utils/range_test.rb}

@@ -1,6 +1,7 @@
-require 'test_helper'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test/unit'
 
-require 'metal_archives/models/range'
+require 'metal_archives/utils/range'
 
 class RangeTest < Test::Unit::TestCase
   def test_basic_attributes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metal_archives
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2016-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -231,11 +231,12 @@ files:
 - lib/metal_archives/models/band.rb
 - lib/metal_archives/models/base_model.rb
 - lib/metal_archives/models/label.rb
-- lib/metal_archives/models/range.rb
 - lib/metal_archives/parsers/artist.rb
 - lib/metal_archives/parsers/band.rb
 - lib/metal_archives/parsers/label.rb
 - lib/metal_archives/parsers/parser_helper.rb
+- lib/metal_archives/utils/collection.rb
+- lib/metal_archives/utils/range.rb
 - lib/metal_archives/version.rb
 - metal_archives.gemspec
 - test/base_model_test.rb
@@ -245,8 +246,9 @@ files:
 - test/property/band_property_test.rb
 - test/query/artist_query_test.rb
 - test/query/band_query_test.rb
-- test/range_test.rb
 - test/test_helper.rb
+- test/utils/collection_test.rb
+- test/utils/range_test.rb
 homepage: http://github.com/floriandejonckheere/metal_archives
 licenses:
 - MIT