metal_archives 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28427a784c317b61bcf01f503f193773f7ab8854
-  data.tar.gz: 1fdafac6af5df82d1cd1de9c02a9e3357297a160
+  metadata.gz: 506a9d5605961addaadfe8c55a609c3d363bb087
+  data.tar.gz: 2f4e9daec3ad414a96ee970093e6e775420eaedf
 SHA512:
-  metadata.gz: 41f50843c789d298d6b123c2571bae112d2f656d420d1db36bff4c9d4d64437800ff58d0332e207a605c9c07954881eec4faaa06a58454a0ef7325ecbc00fc13
-  data.tar.gz: 581f8c2e7ebc7bacc8d687b9a7a69db25ac2e579518aa3c66c5fa4ff3c22a739f8b89d17b31ce70b4f949f13aae9b5b51a64257955b14346a067f6769a8c8d56
+  metadata.gz: c4e1ddea186668837f3dd74a1ef5190276fd319c4e710b51d859a92fa1b2f24590da01843d21890c298084adb33672974bb57e9996603d0952f04324e1e9e989
+  data.tar.gz: e80b21a2b3915bceda1258c6be7329b474d6c77974c29deea11422ca4b5769ba4941e19220c9718326c936bf73a1e49e59bb1406fff2ff11319a537978e2be04

data/README.md

@@ -27,14 +27,13 @@ MetalArchives.configure do |c|
   c.app_version = "1.0"
   c.app_contact = "support@mymusicapp.com"
 
-  # Cache config (optional)
-  c.enable_cache = true
-  c.cache_store = ActiveSupport::Cache.lookup_store(:file_store, '/tmp/metal_archives-cache')
-
   # Request throttling (optional, overrides defaults)
   c.request_rate = 1
   c.request_timeout = 3
 
+  # Custom cache size per object class (optional, overrides defaults)
+  c.cache_size = 100
+
   # Custom logger (optional)
   c.logger = Logger.new File.new('metal_archives.log')
 end

data/lib/metal_archives.rb

@@ -4,6 +4,7 @@ require 'metal_archives/error'
 
 require 'metal_archives/utils/range'
 require 'metal_archives/utils/collection'
+require 'metal_archives/utils/lru_cache'
 
 require 'metal_archives/models/base_model'
 require 'metal_archives/models/label'

data/lib/metal_archives/configuration.rb

@@ -23,7 +23,6 @@ module MetalArchives
       raise MetalArchives::Errors::InvalidConfigurationError, 'app_name has not been configured' unless MetalArchives.config.app_name and not MetalArchives.config.app_name.empty?
       raise MetalArchives::Errors::InvalidConfigurationError, 'app_version has not been configured' unless MetalArchives.config.app_version and not MetalArchives.config.app_version.empty?
       raise MetalArchives::Errors::InvalidConfigurationError, 'app_contact has not been configured' unless MetalArchives.config.app_contact and not MetalArchives.config.app_contact.empty?
-
     end
   end
 
@@ -46,16 +45,6 @@ module MetalArchives
     #
     attr_accessor :app_contact
 
-    ##
-    # Whether to enable the cache
-    #
-    attr_accessor :enable_cache
-
-    ##
-    # ActiveSupport::Cache compatible store
-    #
-    attr_accessor :cache_store
-
     ##
     # Request throttling rate (in seconds per request per path)
     #
@@ -71,6 +60,11 @@ module MetalArchives
     #
     attr_accessor :logger
 
+    ##
+    # Cache size (per object class)
+    #
+    attr_accessor :cache_size
+
     ##
     # Default configuration values
     #
@@ -78,6 +72,7 @@ module MetalArchives
       @throttle_rate = 1
       @throttle_wait = 3
       @logger = Logger.new STDOUT
+      @cache_size = 100
     end
   end
 end

data/lib/metal_archives/error.rb

@@ -31,5 +31,10 @@ module Errors
   # Error in backend response
   #
   class APIError < Error; end
+
+  ##
+  # Error in method argument
+  #
+  class ArgumentError < Error; end
 end
 end

data/lib/metal_archives/http_client.rb

@@ -1,5 +1,4 @@
 require 'faraday'
-require 'faraday-http-cache'
 require 'faraday_throttler'
 
 module MetalArchives
@@ -40,8 +39,6 @@ module MetalArchives
             f.response  :logger, MetalArchives.config.logger
 
             f.use       MetalArchives::Middleware
-            f.use       Faraday::HttpCache,
-                                        :store => MetalArchives.config.cache_store if !!MetalArchives.config.enable_cache
             f.use       :throttler,
                                 :rate => MetalArchives.config.request_rate,
                                 :wait => MetalArchives.config.request_timeout,

data/lib/metal_archives/models/artist.rb

@@ -191,13 +191,15 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        Artist.new :id => id
+        cache[id] = Artist.new :id => id unless cache.include? id
+
+        cache[id]
       end
 
       ##
       # Find by ID (no lazy loading)
       #
-      # Returns rdoc-ref:Band
+      # Returns rdoc-ref:Artist
       #
       # [Raises]
       # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
@@ -209,7 +211,7 @@ module MetalArchives
       #
       def find!(id)
         obj = find id
-        obj.load!
+        obj.load! if obj
 
         obj
       end
@@ -222,12 +224,15 @@ module MetalArchives
       # [Raises]
       # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400
       # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+      # - rdoc-ref:MetalArchives::Errors::ArgumentError when query contains no :name key
       #
       # [+query+]
       #     Hash containing one or more of the following keys:
       #     - +:name+: +String+
       #
       def find_by(query)
+        raise MetalArchives::Errors::ArgumentError unless query.include? :name
+
         url = 'http://www.metal-archives.com/search/ajax-artist-search/'
         params = Parsers::Artist.map_params query
 
@@ -239,7 +244,29 @@ module MetalArchives
         data = json['aaData'].first
         id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
 
-        Artist.new :id => id
+        find id
+      end
+
+      ##
+      # Find by attributes (no lazy loading)
+      #
+      # Returns rdoc-ref:Artist or nil when no results
+      #
+      # [Raises]
+      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
+      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400
+      # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+      # - rdoc-ref:MetalArchives::Errors::ArgumentError when query contains no :name key
+      #
+      # [+query+]
+      #     Hash containing one or more of the following keys:
+      #     - +:name+: +String+
+      #
+      def find_by!(query)
+        obj = find_by query
+        obj.load! if obj
+
+        obj
       end
 
       ##
@@ -250,11 +277,14 @@ module MetalArchives
       # [Raises]
       # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400
       # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+      # - rdoc-ref:MetalArchives::Errors::ArgumentError when +name+ isn't a +String+
       #
       # [+name+]
       #     +String+
       #
       def search(name)
+        raise MetalArchives::Errors::ArgumentError unless name.is_a? String
+
         url = 'http://www.metal-archives.com/search/ajax-artist-search/'
         query = { :name => name }
 
@@ -263,24 +293,26 @@ module MetalArchives
         l = lambda do
           @start ||= 0
 
-          return [] if instance_variable_defined?('@max_items') and @start >= @max_items
+          if @max_items and @start >= @max_items
+            []
+          else
+            response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
+            json = JSON.parse response.body
 
-          response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
-          json = JSON.parse response.body
+            @max_items = json['iTotalRecords']
 
-          @max_items = json['iTotalRecords']
+            objects = []
 
-          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.find(id)
+            end
 
-          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
+            @start += 200
 
-          @start += 200
-
-          objects
+            objects
+          end
         end
 
         MetalArchives::Collection.new l

data/lib/metal_archives/models/band.rb

@@ -248,7 +248,9 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        Band.new :id => id
+        cache[id] = Band.new(:id => id) unless cache.include? id
+
+        cache[id]
       end
 
       ##
@@ -308,9 +310,39 @@ module MetalArchives
         data = json['aaData'].first
         id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
 
-        Band.new :id => id
-      rescue Errors::APIError
-        nil
+        find id
+      end
+
+      ##
+      # Find by attributes (no lazy loading)
+      #
+      # Refer to {MA's FAQ}[http://www.metal-archives.com/content/help?index=3#tab_db] for search tips.
+      #
+      # Returns rdoc-ref:Band or nil when no results
+      #
+      # [Raises]
+      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400
+      # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
+      #
+      # [+query+]
+      #     Hash containing one or more of the following keys:
+      #     - +:name+: +String+
+      #     - +:exact+: +Boolean+
+      #     - +:genre+: +String+
+      #     - +:country+: +ISO366::Country+
+      #     - +:year_formation+: rdoc-ref:Range of +Date+
+      #     - +:comment+: +String+
+      #     - +:status+: see rdoc-ref:Band.status
+      #     - +:lyrical_themes+: +String+
+      #     - +:location+: +String+
+      #     - +:label+: rdoc-ref:Label
+      #     - +:independent+: boolean
+      #
+      def find_by!(query)
+        obj = find_by query
+        obj.load! if obj
+
+        obj
       end
 
       ##
@@ -346,24 +378,26 @@ module MetalArchives
         l = lambda do
           @start ||= 0
 
-          return [] if instance_variable_defined?('@max_items') and @start >= @max_items
-
-          response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
-          json = JSON.parse response.body
+          if @max_items and @start >= @max_items
+            []
+          else
+            response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
+            json = JSON.parse response.body
 
-          @max_items = json['iTotalRecords']
+            @max_items = json['iTotalRecords']
 
-          objects = []
+            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
+            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.find(id)
+            end
 
-          @start += 200
+            @start += 200
 
-          objects
+            objects
+          end
         end
 
         MetalArchives::Collection.new l
@@ -378,11 +412,13 @@ module MetalArchives
       #
       # [Raises]
       # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400
+      # - rdoc-ref:MetalArchives::Errors::ArgumentError when +name+ isn't a +String+
       #
       # [+name+]
       #     +String+
       #
       def search(name)
+        raise MetalArchives::Errors::ArgumentError unless name.is_a? String
         search_by :name => name
       end
     end

data/lib/metal_archives/models/base_model.rb

@@ -55,6 +55,13 @@ module MetalArchives
       #
       attr_accessor :properties
 
+      ##
+      # Get class-level object cache
+      #
+      def cache
+        @cache ||= MetalArchives::LRUCache.new MetalArchives.config.cache_size
+      end
+
       protected
         ##
         # Defines a model property.

data/lib/metal_archives/utils/lru_cache.rb

@@ -0,0 +1,54 @@
+module MetalArchives
+  ##
+  # Generic LRU memory cache
+  #
+  class LRUCache
+    def initialize(size = 100)
+      @size = size
+
+      # Underlying data store
+      @cache = {}
+
+      # Array of keys in order of insertion
+      @keys = []
+    end
+
+    def []=(key, value)
+      @cache[key] = value
+
+      @keys.delete key if @keys.include? key
+
+      @keys << key
+
+      pop if @keys.size > @size
+    end
+
+    def [](key)
+      if @keys.include? key
+        MetalArchives.config.logger.debug "Cache hit for #{key}"
+        @keys.delete key
+        @keys << key
+      else
+        MetalArchives.config.logger.debug "Cache miss for #{key}"
+      end
+
+      @cache[key]
+    end
+
+    def clear
+      @cache.clear
+      @keys.clear
+    end
+
+    def include?(key)
+      @cache.include? key
+    end
+
+    private
+      def pop
+        to_remove = @keys.shift @keys.size - @size
+
+        to_remove.each { |key| @cache.delete key }
+      end
+  end
+end

data/lib/metal_archives/version.rb

@@ -2,5 +2,5 @@ module MetalArchives
   ##
   # MetalArchives API version
   #
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/metal_archives.gemspec

@@ -18,10 +18,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake', '~> 11.0'
   gem.add_development_dependency 'rdoc', '~> 5.0'
   gem.add_development_dependency 'test-unit', '~> 3.0'
-  gem.add_development_dependency 'activesupport', '~> 5.0'
 
   gem.add_dependency 'faraday', '~> 0.9'
-  gem.add_dependency 'faraday-http-cache', '~> 2.0'
   gem.add_dependency 'faraday_throttler', '~> 0.0.3'
   gem.add_dependency 'nokogiri', '~> 1.6.8'
   gem.add_dependency 'countries', '~> 1.2.5'

data/test/property/artist_property_test.rb

@@ -29,7 +29,7 @@ class ArtistPropertyTest < Test::Unit::TestCase
     assert_equal 'Ian Fraser Kilmister', artist.name
     assert_equal ['Lemmy Kilmister'], artist.aliases
     assert_equal Date.new(2015, 12, 28), artist.date_of_death
-    assert_equal 4, artist.links.length
+    assert_equal 5, artist.links.length
     assert_equal 1, artist.links.count { |l| l[:type] == :official }
     assert_equal 2, artist.links.count { |l| l[:type] == :unofficial }
     assert_equal 1, artist.links.count { |l| l[:type] == :unlisted_bands }

data/test/query/artist_query_test.rb

@@ -58,12 +58,22 @@ class ArtistQueryTest < Test::Unit::TestCase
     assert_nil artist
   end
 
+  def test_find_by!
+    artist = MetalArchives::Artist.find_by! :name => 'Alberto Rionda'
+
+    assert_instance_of MetalArchives::Artist, artist
+
+    artist = MetalArchives::Artist.find_by! :name => 'SomeNonExistantName'
+
+    assert_nil artist
+  end
+
   def test_search
     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_equal 296, MetalArchives::Artist.search('Filip').count
 
     assert !MetalArchives::Artist.search('SomeNonExistantName').any?
   end

data/test/query/band_query_test.rb

@@ -71,6 +71,16 @@ class BandQueryTest < Test::Unit::TestCase
     assert_equal 3540361100, band.id
   end
 
+  def test_find_by!
+    band = MetalArchives::Band.find_by! :name => 'Falconer'
+
+    assert_instance_of MetalArchives::Band, band
+
+    band = MetalArchives::Band.find_by! :name => 'SomeNonExistantName'
+
+    assert_nil band
+  end
+
   def test_search_by
     assert_instance_of MetalArchives::Collection, MetalArchives::Band.search_by(:name => 'Alquimia')
 
@@ -106,7 +116,7 @@ class BandQueryTest < Test::Unit::TestCase
     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']).count
+    assert_equal 279, MetalArchives::Band.search_by(:country => ISO3166::Country['CN']).count
   end
 
   def test_errors

data/test/test_helper.rb

@@ -13,9 +13,8 @@ MetalArchives.configure do |c|
   c.app_version = MetalArchives::VERSION
   c.app_contact = `git config user.email`.chomp || 'user@example.com'
 
-  # Cache config (optional)
-  c.enable_cache = false
-  # c.cache_store = ActiveSupport::Cache.lookup_store(:file_store, '/tmp/metal_archives-cache')
+  # Custom cache size per object class (optional, overrides defaults)
+  c.cache_size = 1
 
   # Request throttling (optional, overrides defaults)
   c.request_rate = 1

data/test/utils/lru_cache_test.rb

@@ -0,0 +1,22 @@
+require_relative '../test_helper'
+
+class LruCacheTest < Test::Unit::TestCase
+  def test_lru
+    cache = MetalArchives::LRUCache.new 3
+
+    cache[:a] = 'one'
+    cache[:b] = 'two'
+    cache[:c] = 'three'
+
+    assert_equal 3, cache.instance_variable_get('@size')
+
+    cache[:d] = 'four'
+
+    assert_equal 3, cache.instance_variable_get('@size')
+
+    assert_equal 'two', cache[:b]
+    assert_equal 'three', cache[:c]
+    assert_equal 'four', cache[:d]
+    assert_equal nil, cache[:a]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metal_archives
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: faraday-http-cache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday_throttler
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +148,7 @@ files:
 - lib/metal_archives/parsers/label.rb
 - lib/metal_archives/parsers/parser.rb
 - lib/metal_archives/utils/collection.rb
+- lib/metal_archives/utils/lru_cache.rb
 - lib/metal_archives/utils/range.rb
 - lib/metal_archives/version.rb
 - metal_archives.gemspec
@@ -188,6 +161,7 @@ files:
 - test/query/band_query_test.rb
 - test/test_helper.rb
 - test/utils/collection_test.rb
+- test/utils/lru_cache_test.rb
 - test/utils/range_test.rb
 homepage: http://github.com/floriandejonckheere/metal_archives
 licenses:
@@ -209,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Metal Archives Ruby API