metal_archives 2.2.0 → 2.2.3

data/Rakefile

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require 'rake'
-require 'rake/testtask'
+require "rake"
+require "rake/testtask"
+require "zeitwerk"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/*/*_test.rb']
+  t.libs << "test"
+  t.test_files = FileList["test/*/*_test.rb"]
   t.verbose = true
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 end

data/bin/console

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "logger"
+
+require "bundler/setup"
+require "metal_archives"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+MetalArchives.configure do |c|
+  ## Application identity (required)
+  c.app_name = "My App"
+  c.app_version = "1.0"
+  c.app_contact = "support@mymusicapp.com"
+
+  ## Request throttling (optional, overrides defaults)
+  # c.request_rate = 1
+  # c.request_timeout = 3
+
+  ## Connect additional Faraday middleware
+  # c.middleware = [MyMiddleware, MyOtherMiddleware]
+
+  ## Custom cache size per object class (optional, overrides defaults)
+  # c.cache_size = 100
+
+  ## Metal Archives endpoint (optional, overrides default)
+  # c.endpoint = "http://www.metal-archives.com/"
+
+  ## Custom logger (optional)
+  c.logger = Logger.new STDOUT
+  c.logger.level = Logger::WARN
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.7"
+
+services:
+  nginx:
+    image: nginx:alpine
+    ports:
+      - "80:80"
+    volumes:
+      - ./nginx/:/etc/nginx/conf.d/
+      - nginx:/cache/
+    restart: always
+
+volumes:
+  nginx:

data/lib/metal_archives.rb

@@ -1,37 +1,56 @@
 # frozen_string_literal: true
 
-require 'openssl'
-
-require 'metal_archives/middleware/headers'
-require 'metal_archives/middleware/cache_check'
-require 'metal_archives/middleware/rewrite_endpoint'
-require 'metal_archives/middleware/encoding'
-
-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/utils/lru_cache'
-require 'metal_archives/utils/nil_date'
-
-require 'metal_archives/models/base_model'
-require 'metal_archives/models/label'
-require 'metal_archives/models/artist'
-require 'metal_archives/models/band'
-require 'metal_archives/models/release'
-
-require 'metal_archives/parsers/parser'
-require 'metal_archives/parsers/label'
-require 'metal_archives/parsers/artist'
-require 'metal_archives/parsers/band'
-require 'metal_archives/parsers/release'
-
-require 'metal_archives/http_client'
+require "openssl"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+load.enable_reloading if ENV["METAL_ARCHIVES_ENV"] == "development"
+loader.inflector.inflect(
+  "id" => "ID",
+  "api" => "API",
+  "http_client" => "HTTPClient",
+  "lru_cache" => "LRUCache"
+)
+loader.collapse("lib/metal_archives/models")
+loader.setup
 
 ##
 # Metal Archives Ruby API
 #
 module MetalArchives
+  class << self
+    ##
+    # API configuration
+    #
+    # Instance of rdoc-ref:MetalArchives::Configuration
+    #
+    def config
+      raise MetalArchives::Errors::InvalidConfigurationError, "Gem has not been configured" unless @config
+
+      @config
+    end
+
+    ##
+    # Configure API options.
+    #
+    # A block must be specified, to which a
+    # rdoc-ref:MetalArchives::Configuration parameter will be passed.
+    #
+    # [Raises]
+    # - rdoc-ref:InvalidConfigurationException
+    #
+    def configure
+      raise MetalArchives::Errors::InvalidConfigurationError, "No configuration block given" unless block_given?
+
+      @config = MetalArchives::Configuration.new
+      yield @config
+
+      raise MetalArchives::Errors::InvalidConfigurationError, "app_name has not been configured" unless MetalArchives.config.app_name && !MetalArchives.config.app_name.empty?
+      raise MetalArchives::Errors::InvalidConfigurationError, "app_version has not been configured" unless MetalArchives.config.app_version && !MetalArchives.config.app_version.empty?
+
+      return if MetalArchives.config.app_contact && !MetalArchives.config.app_contact.empty?
+
+      raise MetalArchives::Errors::InvalidConfigurationError, "app_contact has not been configured"
+    end
+  end
 end

data/lib/metal_archives/configuration.rb

@@ -1,38 +1,8 @@
 # frozen_string_literal: true
 
-module MetalArchives
-  class << self
-    ##
-    # API configuration
-    #
-    # Instance of rdoc-ref:MetalArchives::Configuration
-    #
-    def config
-      raise MetalArchives::Errors::InvalidConfigurationError, 'Gem has not been configured' unless @config
-
-      @config
-    end
-
-    ##
-    # Configure API options.
-    #
-    # A block must be specified, to which a
-    # rdoc-ref:MetalArchives::Configuration parameter will be passed.
-    #
-    # [Raises]
-    # - rdoc-ref:InvalidConfigurationException
-    #
-    def configure
-      raise MetalArchives::Errors::InvalidConfigurationError, 'No configuration block given' unless block_given?
-      @config = MetalArchives::Configuration.new
-      yield @config
-
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_name has not been configured' unless MetalArchives.config.app_name && !MetalArchives.config.app_name.empty?
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_version has not been configured' unless MetalArchives.config.app_version && !MetalArchives.config.app_version.empty?
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_contact has not been configured' unless MetalArchives.config.app_contact && !MetalArchives.config.app_contact.empty?
-    end
-  end
+require "logger"
 
+module MetalArchives
   ##
   # Contains configuration options
   #
@@ -58,6 +28,12 @@ module MetalArchives
     attr_accessor :endpoint
     attr_reader :default_endpoint
 
+    ##
+    # Endpoint HTTP Basic authentication
+    #
+    attr_accessor :endpoint_user
+    attr_accessor :endpoint_password
+
     ##
     # Additional Faraday middleware
     #
@@ -87,7 +63,7 @@ module MetalArchives
     # Default configuration values
     #
     def initialize
-      @default_endpoint = 'https://www.metal-archives.com/'
+      @default_endpoint = "https://www.metal-archives.com/"
       @throttle_rate = 1
       @throttle_wait = 3
       @logger = Logger.new STDOUT

data/lib/metal_archives/http_client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'faraday_throttler'
+require "faraday"
+require "faraday_throttler"
 
 module MetalArchives
   ##
@@ -23,7 +23,7 @@ module MetalArchives
         raise Errors::APIError, response.status if response.status >= 400
 
         response
-      rescue Faraday::Error::ClientError => e
+      rescue Faraday::ClientError => e
         MetalArchives.config.logger.error e.response
         raise Errors::APIError, e
       end
@@ -35,7 +35,7 @@ module MetalArchives
       #
       #
       def client
-        raise Errors::InvalidConfigurationError, 'Not configured yet' unless MetalArchives.config
+        raise Errors::InvalidConfigurationError, "Not configured yet" unless MetalArchives.config
 
         @faraday ||= Faraday.new do |f|
           f.request   :url_encoded # form-encode POST params
@@ -46,14 +46,19 @@ module MetalArchives
           f.use       MetalArchives::Middleware::RewriteEndpoint
           f.use       MetalArchives::Middleware::Encoding
 
-          MetalArchives.config.middleware.each { |m| f.use m } if MetalArchives.config.middleware
+          MetalArchives.config.middleware&.each { |m| f.use m }
 
           f.use       :throttler,
-                      :rate => MetalArchives.config.request_rate,
-                      :wait => MetalArchives.config.request_timeout,
-                      :logger => MetalArchives.config.logger
+                      rate: MetalArchives.config.request_rate,
+                      wait: MetalArchives.config.request_timeout,
+                      logger: MetalArchives.config.logger
 
           f.adapter   Faraday.default_adapter
+
+          next unless MetalArchives.config.endpoint_user
+
+          f.basic_auth MetalArchives.config.endpoint_user,
+                       MetalArchives.config.endpoint_password
         end
       end
     end

data/lib/metal_archives/middleware/cache_check.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
 module MetalArchives
   module Middleware
@@ -11,9 +11,7 @@ module MetalArchives
       def on_complete(env)
         return unless MetalArchives.config.endpoint
 
-        if env[:response_headers].has_key? 'x-cache-status'
-          MetalArchives.config.logger.info "Cache #{env[:response_headers]['x-cache-status'].downcase} for #{env.url.to_s}"
-        end
+        MetalArchives.config.logger.info "Cache #{env[:response_headers]['x-cache-status'].downcase} for #{env.url}" if env[:response_headers].key? "x-cache-status"
       end
     end
   end

data/lib/metal_archives/middleware/encoding.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
 module MetalArchives
   module Middleware
@@ -9,7 +9,7 @@ module MetalArchives
     #
     class Encoding < Faraday::Response::Middleware # :nodoc:
       def on_complete(env)
-        env.response.body.force_encoding('utf-8')
+        env.response.body.force_encoding("utf-8")
       end
     end
   end

data/lib/metal_archives/middleware/headers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
 module MetalArchives
   module Middleware
@@ -10,9 +10,9 @@ module MetalArchives
     class Headers < Faraday::Middleware # :nodoc:
       def call(env)
         headers = {
-          'User-Agent' => user_agent_string,
-          'Via' => via_string,
-          'Accept' => accept_string
+          "User-Agent" => user_agent_string,
+          "Via" => via_string,
+          "Accept" => accept_string,
         }
 
         env[:request_headers].merge! headers
@@ -27,7 +27,7 @@ module MetalArchives
       end
 
       def accept_string
-        'application/json'
+        "application/json"
       end
 
       def via_string

data/lib/metal_archives/middleware/rewrite_endpoint.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
 module MetalArchives
   module Middleware
@@ -27,7 +27,7 @@ module MetalArchives
             new_uri.host = rewritten_uri.host
             new_uri.scheme = rewritten_uri.scheme
 
-            MetalArchives.config.logger.debug "Rewrite #{uri.to_s} to #{new_uri}"
+            MetalArchives.config.logger.debug "Rewrite #{uri} to #{new_uri}"
           end
 
           new_uri

data/lib/metal_archives/models/artist.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'countries'
+require "date"
+require "countries"
+require "nokogiri"
 
 module MetalArchives
   ##
@@ -13,7 +14,7 @@ module MetalArchives
     #
     # Returns +Integer+
     #
-    property :id, :type => Integer
+    property :id, type: Integer
 
     ##
     # :attr_reader: name
@@ -35,7 +36,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)
     #
-    property :aliases, :multiple => true
+    property :aliases, multiple: true
 
     ##
     # :attr_reader: country
@@ -46,7 +47,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)
     #
-    property :country, :type => ISO3166::Country
+    property :country, type: ISO3166::Country
 
     ##
     # :attr_reader: location
@@ -68,7 +69,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)
     #
-    property :date_of_birth, :type => NilDate
+    property :date_of_birth, type: NilDate
 
     ##
     # :attr_reader: date_of_death
@@ -79,7 +80,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)
     #
-    property :date_of_death, :type => NilDate
+    property :date_of_death, type: NilDate
 
     ##
     # :attr_reader: cause_of_death
@@ -101,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: %i(male female)
 
     ##
     # :attr_reader: biography
@@ -145,17 +146,32 @@ 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)
     #
-    # [+similar+]
+    # [+links+]
     #     - +:url+: +String+
     #     - +:type+: +Symbol+, either +:official+, +:unofficial+ or +:unlisted_bands+
     #     - +:title+: +String+
     #
-    property :links, :multiple => true
+    property :links, multiple: true
 
-    # TODO: active bands/albums
-    # TODO: past bands/albums
-    # TODO: guest bands/albums
-    # TODO: misc bands/albums
+    ##
+    # :attr_reader: bands
+    #
+    # Returns +Array+ of +Hash+ containing the following keys
+    #
+    # [Raises]
+    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
+    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    #
+    # [+bands+]
+    #     - +:band+: rdoc-ref:Band
+    #     - +:active+: Boolean
+    #     - +:date_active+: +Array+ of rdoc-ref:Range containing rdoc-ref:NilDate
+    #     - +:role+: +String+
+    #
+    property :bands, type: Hash, multiple: true
+
+    # TODO: guest/session bands
+    # TODO: misc bands
 
     protected
 
@@ -206,7 +222,7 @@ module MetalArchives
       def find(id)
         return cache[id] if cache.include? id
 
-        Artist.new :id => id
+        Artist.new id: id
       end
 
       ##
@@ -252,10 +268,10 @@ module MetalArchives
         response = HTTPClient.get url, params
         json = JSON.parse response.body
 
-        return nil if json['aaData'].empty?
+        return nil if json["aaData"].empty?
 
-        data = json['aaData'].first
-        id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.delete('\\').split('/').last.gsub(/\D/, '').to_i
+        data = json["aaData"].first
+        id = Nokogiri::HTML(data.first).xpath("//a/@href").first.value.delete('\\').split("/").last.gsub(/\D/, "").to_i
 
         find id
       end
@@ -299,7 +315,7 @@ module MetalArchives
         raise MetalArchives::Errors::ArgumentError unless name.is_a? String
 
         url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
-        query = { :name => name }
+        query = { name: name }
 
         params = Parsers::Artist.map_params query
 
@@ -309,16 +325,16 @@ module MetalArchives
           if @max_items && @start >= @max_items
             []
           else
-            response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
+            response = HTTPClient.get url, params.merge(iDisplayStart: @start)
             json = JSON.parse response.body
 
-            @max_items = json['iTotalRecords']
+            @max_items = json["iTotalRecords"]
 
             objects = []
 
-            json['aaData'].each do |data|
+            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.delete('\\').split('/').last.gsub(/\D/, '').to_i
+              id = Nokogiri::HTML(data.first).xpath("//a/@href").first.value.delete('\\').split("/").last.gsub(/\D/, "").to_i
               objects << Artist.find(id)
             end
 
@@ -341,7 +357,7 @@ module MetalArchives
       # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
       #
       def all
-        search ''
+        search ""
       end
     end
   end