metal_archives 3.0.1 → 3.1.0

data/lib/metal_archives/cache/base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module MetalArchives
+  module Cache
+    ##
+    # Generic cache interface
+    #
+    class Base
+      attr_accessor :options
+
+      def initialize(options = {})
+        @options = options
+
+        validate!
+      end
+
+      def validate!; end
+
+      def []
+        raise NotImplementedError
+      end
+
+      def []=(_key, _value)
+        raise NotImplementedError
+      end
+
+      def clear
+        raise NotImplementedError
+      end
+
+      def include?(_key)
+        raise NotImplementedError
+      end
+
+      def delete(_key)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/metal_archives/cache/memory.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module MetalArchives
+  module Cache
+    ##
+    # Generic LRU memory cache
+    #
+    class Memory < Base
+      def validate!
+        raise Errors::InvalidConfigurationError, "size has not been configured" if options[:size].blank?
+        raise Errors::InvalidConfigurationError, "size must be a number" unless options[:size].is_a? Integer
+      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 []=(key, value)
+        cache[key] = value
+
+        keys.delete key if keys.include? key
+
+        keys << key
+
+        pop if keys.size > options[:size]
+      end
+
+      def clear
+        cache.clear
+        keys.clear
+      end
+
+      def include?(key)
+        cache.include? key
+      end
+
+      def delete(key)
+        cache.delete key
+      end
+
+      private
+
+      def cache
+        # Underlying data store
+        @cache ||= {}
+      end
+
+      def keys
+        # Array of keys in order of insertion
+        @keys ||= []
+      end
+
+      def pop
+        to_remove = keys.shift(keys.size - options[:size])
+
+        to_remove.each { |key| cache.delete key }
+      end
+    end
+  end
+end

data/lib/metal_archives/cache/null.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MetalArchives
+  module Cache
+    ##
+    # Null cache
+    #
+    class Null < Base
+      def [](_key); end
+
+      def []=(_key, _value); end
+
+      def clear; end
+
+      def include?(_key)
+        false
+      end
+
+      def delete(_key); end
+    end
+  end
+end

data/lib/metal_archives/cache/redis.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module MetalArchives
+  module Cache
+    ##
+    # Redis-backed cache
+    #
+    class Redis < Base
+      def initialize(options = {})
+        super
+
+        # Default TTL is 1 month
+        options[:ttl] ||= (30 * 24 * 60 * 60)
+      end
+
+      def [](key)
+        redis.get cache_key_for(key)
+      end
+
+      def []=(key, value)
+        redis.set cache_key_for(key), value, ex: options[:ttl]
+      end
+
+      def clear
+        redis.keys(cache_key_for("*")).each { |key| redis.del key }
+      end
+
+      def include?(key)
+        redis.exists? cache_key_for(key)
+      end
+
+      def delete(key)
+        redis.del cache_key_for(key)
+      end
+
+      private
+
+      def cache_key_for(key)
+        "metal_archives.cache.#{key}"
+      end
+
+      def redis
+        @redis ||= ::Redis.new(**options.except(:ttl))
+      end
+    end
+  end
+end

data/lib/metal_archives/collection.rb

@@ -22,15 +22,13 @@ module MetalArchives
     # 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
-      return to_enum :each unless block_given?
+    def each(&block)
+      return to_enum :each unless block
 
       loop do
         items = instance_exec(&@proc)
 
-        items.each do |item|
-          yield item
-        end
+        items.each(&block)
 
         break if items.empty?
       end

data/lib/metal_archives/configuration.rb

@@ -3,6 +3,8 @@
 require "logger"
 
 module MetalArchives
+  CACHE_STRATEGIES = %w(memory redis).freeze
+
   ##
   # Contains configuration options
   #
@@ -23,10 +25,9 @@ module MetalArchives
     attr_accessor :app_contact
 
     ##
-    # Override Metal Archives endpoint (defaults to http://www.metal-archives.com/)
+    # Override Metal Archives endpoint (defaults to https://www.metal-archives.com/)
     #
     attr_accessor :endpoint
-    attr_reader :default_endpoint
 
     ##
     # Endpoint HTTP Basic authentication
@@ -35,39 +36,45 @@ module MetalArchives
     attr_accessor :endpoint_password
 
     ##
-    # Additional Faraday middleware
+    # Logger instance
     #
-    attr_accessor :middleware
+    attr_accessor :logger
 
     ##
-    # Request throttling rate (in seconds per request per path)
+    # Cache strategy
     #
-    attr_accessor :request_rate
+    attr_accessor :cache_strategy
 
     ##
-    # Request timeout (in seconds per request per path)
+    # Cache strategy options
     #
-    attr_accessor :request_timeout
+    attr_accessor :cache_options
 
     ##
-    # Logger instance
+    # Default configuration values
     #
-    attr_accessor :logger
+    def initialize(**attributes)
+      attributes.each { |key, value| send(:"#{key}=", value) }
 
-    ##
-    # Cache size (per object class)
-    #
-    attr_accessor :cache_size
+      @endpoint ||= "https://www.metal-archives.com/"
+      @logger ||= Logger.new $stdout
+
+      @cache_strategy ||= "memory"
+      @cache_options ||= { size: 100 }
+    end
 
     ##
-    # Default configuration values
+    # Validate configuration
+    #
+    # [Raises]
+    # - rdoc-ref:MetalArchives::Errors::ConfigurationError when configuration is invalid
     #
-    def initialize
-      @default_endpoint = "https://www.metal-archives.com/"
-      @throttle_rate = 1
-      @throttle_wait = 3
-      @logger = Logger.new STDOUT
-      @cache_size = 100
+    def validate!
+      raise Errors::InvalidConfigurationError, "app_name has not been configured" if app_name.blank?
+      raise Errors::InvalidConfigurationError, "app_version has not been configured" if app_version.blank?
+      raise Errors::InvalidConfigurationError, "app_contact has not been configured" if app_contact.blank?
+      raise Errors::InvalidConfigurationError, "cache_strategy has not been configured" if cache_strategy.blank?
+      raise Errors::InvalidConfigurationError, "cache_strategy must be one of: #{CACHE_STRATEGIES.join(', ')}" if CACHE_STRATEGIES.exclude?(cache_strategy.to_s)
     end
   end
 end

data/lib/metal_archives/errors.rb

@@ -32,7 +32,15 @@ module MetalArchives
     ##
     # Error in backend response
     #
-    class APIError < Error; end
+    class APIError < Error
+      attr_reader :code
+
+      def initialize(response)
+        super("#{response.reason}: #{response.body}")
+
+        @code = response.code
+      end
+    end
 
     ##
     # Error in method argument

data/lib/metal_archives/http_client.rb

@@ -1,66 +1,62 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "faraday_throttler"
+require "http"
 
 module MetalArchives
   ##
-  # HTTP request client
+  # Generic HTTP client
   #
-  class HTTPClient # :nodoc:
-    class << self
-      ##
-      # Retrieve a HTTP resource
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when receiving a status code == 404n
-      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-      #
-      def get(*params)
-        response = client.get(*params)
+  class HTTPClient
+    attr_reader :endpoint, :metrics
 
-        raise Errors::InvalidIDError, response.status if response.status == 404
-        raise Errors::APIError, response.status if response.status >= 400
+    def initialize(endpoint = MetalArchives.config.endpoint)
+      @endpoint = endpoint
+      @metrics = { hit: 0, miss: 0 }
+    end
 
-        response
-      rescue Faraday::ClientError => e
-        MetalArchives.config.logger.error e.response
-        raise Errors::APIError, e
-      end
+    def get(path, params = {})
+      response = http
+        .get(url_for(path), params: params)
 
-      private
+      # Log cache status
+      status = response.headers["x-cache-status"]&.downcase&.to_sym
+      MetalArchives.config.logger.info "Cache #{status} for #{path}" if status
 
-      ##
-      # Retrieve a HTTP client
-      #
-      #
-      def client
-        raise Errors::InvalidConfigurationError, "Not configured yet" unless MetalArchives.config
+      case status
+      when :hit
+        metrics[:hit] += 1
+      when :miss, :bypass, :expired, :stale, :updating, :revalidated
+        metrics[:miss] += 1
+      end
+      raise Errors::InvalidIDError, response if response.code == 404
+      raise Errors::APIError, response unless response.status.success?
 
-        @faraday ||= Faraday.new do |f|
-          f.request   :url_encoded # form-encode POST params
-          f.response  :logger, MetalArchives.config.logger
+      response
+    end
 
-          f.use       MetalArchives::Middleware::Headers
-          f.use       MetalArchives::Middleware::CacheCheck
-          f.use       MetalArchives::Middleware::RewriteEndpoint
-          f.use       MetalArchives::Middleware::Encoding
+    private
 
-          MetalArchives.config.middleware&.each { |m| f.use m }
+    def http
+      @http ||= HTTP
+        .headers(headers)
+        .use(logging: { logger: MetalArchives.config.logger })
+        .encoding("utf-8")
 
-          f.use       :throttler,
-                      rate: MetalArchives.config.request_rate,
-                      wait: MetalArchives.config.request_timeout,
-                      logger: MetalArchives.config.logger
+      return @http unless MetalArchives.config.endpoint_user && MetalArchives.config.endpoint_password
 
-          f.adapter   Faraday.default_adapter
+      @http
+        .basic_auth(user: MetalArchives.config.endpoint_user, pass: MetalArchives.config.endpoint_password)
+    end
 
-          next unless MetalArchives.config.endpoint_user
+    def headers
+      {
+        user_agent: "#{MetalArchives.config.app_name}/#{MetalArchives.config.app_version} (#{MetalArchives.config.app_contact})",
+        accept: "application/json",
+      }
+    end
 
-          f.basic_auth MetalArchives.config.endpoint_user,
-                       MetalArchives.config.endpoint_password
-        end
-      end
+    def url_for(path)
+      "#{endpoint}#{path}"
     end
   end
 end

data/lib/metal_archives/models/artist.rb

@@ -8,7 +8,7 @@ module MetalArchives
   ##
   # Represents a single performer (but not a solo artist)
   #
-  class Artist < MetalArchives::BaseModel
+  class Artist < Base
     ##
     # :attr_reader: id
     #
@@ -63,24 +63,24 @@ module MetalArchives
     ##
     # :attr_reader: date_of_birth
     #
-    # Returns rdoc-ref:NilDate
+    # Returns rdoc-ref:Date
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_of_birth, type: NilDate
+    property :date_of_birth, type: Date
 
     ##
     # :attr_reader: date_of_death
     #
-    # Returns rdoc-ref:NilDate
+    # Returns rdoc-ref:Date
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    property :date_of_death, type: NilDate
+    property :date_of_death, type: Date
 
     ##
     # :attr_reader: cause_of_death
@@ -102,7 +102,7 @@ module MetalArchives
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
-    enum :gender, values: %i(male female)
+    enum :gender, values: [:male, :female]
 
     ##
     # :attr_reader: biography
@@ -165,7 +165,7 @@ module MetalArchives
     # [+bands+]
     #     - +:band+: rdoc-ref:Band
     #     - +:active+: Boolean
-    #     - +:date_active+: +Array+ of rdoc-ref:Range containing rdoc-ref:NilDate
+    #     - +:years_active+: +Array+ of rdoc-ref:Range containing +Integer+
     #     - +:role+: +String+
     #
     property :bands, type: Hash, multiple: true
@@ -173,6 +173,41 @@ module MetalArchives
     # TODO: guest/session bands
     # TODO: misc bands
 
+    ##
+    # Serialize to hash
+    #
+    def to_h
+      {
+        type: "artist",
+        id: id,
+        name: name,
+        aliases: aliases || [],
+        country: country&.alpha3,
+        location: location,
+        date_of_birth: date_of_birth&.iso8601,
+        date_of_death: date_of_death&.iso8601,
+        cause_of_death: cause_of_death,
+        gender: gender,
+        biography: biography,
+        trivia: trivia,
+        photo: photo,
+        links: links || [],
+        bands: bands || [],
+      }
+    end
+
+    ##
+    # Deserialize from hash
+    #
+    def self.from_h(hash)
+      return unless hash.fetch(:type) == "artist"
+
+      new(hash.slice(:id, :name, :aliases, :location, :cause_of_death, :gender, :biography, :trivial, :photo, :links, :bands))
+        .tap { |m| m.country = ISO3166::Country[hash[:country]] }
+        .tap { |m| m.date_of_birth = Date.parse(hash[:date_of_birth]) if hash[:date_of_birth] }
+        .tap { |m| m.date_of_death = Date.parse(hash[:date_of_death]) if hash[:date_of_death] }
+    end
+
     protected
 
     ##
@@ -184,28 +219,24 @@ module MetalArchives
     #
     def assemble # :nodoc:
       ## Base attributes
-      url = "#{MetalArchives.config.default_endpoint}artist/view/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/view/id/#{id}"
 
-      properties = Parsers::Artist.parse_html response.body
+      properties = Parsers::Artist.parse_html response.to_s
 
       ## Biography
-      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/biography"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/read-more/id/#{id}/field/biography"
 
-      properties[:biography] = response.body
+      properties[:biography] = response.to_s
 
       ## Trivia
-      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/trivia"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/artist/read-more/id/#{id}/field/trivia"
 
-      properties[:trivia] = response.body
+      properties[:trivia] = response.to_s
 
       ## Related links
-      url = "#{MetalArchives.config.default_endpoint}link/ajax-list/type/person/id/#{id}"
-      response = HTTPClient.get url
+      response = MetalArchives.http.get "/link/ajax-list/type/person/id/#{id}"
 
-      properties[:links] = Parsers::Artist.parse_links_html response.body
+      properties[:links] = Parsers::Artist.parse_links_html response.to_s
 
       properties
     end
@@ -220,7 +251,7 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        return cache[id] if cache.include? id
+        return MetalArchives.cache[id] if MetalArchives.cache.include? id
 
         Artist.new id: id
       end
@@ -262,11 +293,10 @@ module MetalArchives
       def find_by(query)
         raise MetalArchives::Errors::ArgumentError unless query.include? :name
 
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         params = Parsers::Artist.map_params query
 
-        response = HTTPClient.get url, params
-        json = JSON.parse response.body
+        response = MetalArchives.http.get "/search/ajax-artist-search/", params
+        json = JSON.parse response.to_s
 
         return nil if json["aaData"].empty?
 
@@ -314,7 +344,6 @@ module MetalArchives
       def search(name)
         raise MetalArchives::Errors::ArgumentError unless name.is_a? String
 
-        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         query = { name: name }
 
         params = Parsers::Artist.map_params query
@@ -325,8 +354,8 @@ module MetalArchives
           if @max_items && @start >= @max_items
             []
           else
-            response = HTTPClient.get url, params.merge(iDisplayStart: @start)
-            json = JSON.parse response.body
+            response = MetalArchives.http.get "/search/ajax-artist-search/", params.merge(iDisplayStart: @start)
+            json = JSON.parse response.to_s
 
             @max_items = json["iTotalRecords"]