metal_archives 0.8.0 → 1.0.0

data/lib/metal_archives/middleware/headers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module MetalArchives
+  module Middleware
+    ##
+    # Add appropriate request headers
+    #
+    class Headers < Faraday::Middleware # :nodoc:
+      def call(env)
+        headers = {
+          'User-Agent' => user_agent_string,
+          'Via' => via_string,
+          'Accept' => accept_string
+        }
+
+        env[:request_headers].merge! headers
+
+        @app.call env
+      end
+
+      private
+
+      def user_agent_string
+        "#{MetalArchives.config.app_name}/#{MetalArchives.config.app_version} ( #{MetalArchives.config.app_contact} )"
+      end
+
+      def accept_string
+        'application/json'
+      end
+
+      def via_string
+        "gem metal_archives/#{VERSION}"
+      end
+    end
+  end
+end

data/lib/metal_archives/middleware/rewrite_endpoint.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module MetalArchives
+  module Middleware
+    ##
+    # Dynamically rewrite endpoints
+    #
+    class RewriteEndpoint < Faraday::Middleware
+      def call(env)
+        RewriteEndpoint.rewrite(env[:url])
+
+        @app.call env
+      end
+
+      class << self
+        def rewrite(uri)
+          return uri unless MetalArchives.config.endpoint
+
+          new_uri = uri.clone
+
+          default_uri = URI MetalArchives.config.default_endpoint
+          rewritten_uri = URI MetalArchives.config.endpoint
+
+          if uri.host == default_uri.host && uri.scheme == default_uri.scheme
+            new_uri.host = rewritten_uri.host
+            new_uri.scheme = rewritten_uri.scheme
+
+            MetalArchives.config.logger.debug "Rewrite #{uri.to_s} to #{new_uri}"
+          end
+
+          new_uri
+        end
+      end
+    end
+  end
+end

data/lib/metal_archives/models/artist.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'countries'
 
 module MetalArchives
-
   ##
   # Represents a single performer (but not a solo artist)
   #
@@ -100,7 +101,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 => [:male, :female]
+    enum :gender, :values => %i[male female]
 
     ##
     # :attr_reader: biography
@@ -124,6 +125,17 @@ module MetalArchives
     #
     property :trivia
 
+    ##
+    # :attr_reader: photo
+    #
+    # Returns +URI+ (rewritten if config option was enabled)
+    #
+    # [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 :photo
+
     ##
     # :attr_reader: links
     #
@@ -146,40 +158,41 @@ module MetalArchives
     # TODO: misc bands/albums
 
     protected
-      ##
-      # Fetch the data and assemble the model
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
-      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-      #
-      def assemble # :nodoc:
-        ## Base attributes
-        url = "#{MetalArchives.config.endpoint}artist/view/id/#{id}"
-        response = HTTPClient.get url
 
-        properties = Parsers::Artist.parse_html response.body
+    ##
+    # Fetch the data and assemble the model
+    #
+    # [Raises]
+    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
+    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    #
+    def assemble # :nodoc:
+      ## Base attributes
+      url = "#{MetalArchives.config.default_endpoint}artist/view/id/#{id}"
+      response = HTTPClient.get url
+
+      properties = Parsers::Artist.parse_html response.body
 
-        ## Biography
-        url = "#{MetalArchives.config.endpoint}artist/read-more/id/#{id}/field/biography"
-        response = HTTPClient.get url
+      ## Biography
+      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/biography"
+      response = HTTPClient.get url
 
-        properties[:biography] = response.body
+      properties[:biography] = response.body
 
-        ## Trivia
-        url = "#{MetalArchives.config.endpoint}artist/read-more/id/#{id}/field/trivia"
-        response = HTTPClient.get url
+      ## Trivia
+      url = "#{MetalArchives.config.default_endpoint}artist/read-more/id/#{id}/field/trivia"
+      response = HTTPClient.get url
 
-        properties[:trivia] = response.body
+      properties[:trivia] = response.body
 
-        ## Related links
-        url = "#{MetalArchives.config.endpoint}link/ajax-list/type/person/id/#{id}"
-        response = HTTPClient.get url
+      ## Related links
+      url = "#{MetalArchives.config.default_endpoint}link/ajax-list/type/person/id/#{id}"
+      response = HTTPClient.get url
 
-        properties[:links] = Parsers::Artist.parse_links_html response.body
+      properties[:links] = Parsers::Artist.parse_links_html response.body
 
-        properties
-      end
+      properties
+    end
 
     class << self
       ##
@@ -191,9 +204,9 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        cache[id] = Artist.new :id => id unless cache.include? id
+        return cache[id] if cache.include? id
 
-        cache[id]
+        Artist.new :id => id
       end
 
       ##
@@ -211,7 +224,7 @@ module MetalArchives
       #
       def find!(id)
         obj = find id
-        obj.load! if obj
+        obj&.load!
 
         obj
       end
@@ -233,7 +246,7 @@ module MetalArchives
       def find_by(query)
         raise MetalArchives::Errors::ArgumentError unless query.include? :name
 
-        url = "#{MetalArchives.config.endpoint}search/ajax-artist-search/"
+        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         params = Parsers::Artist.map_params query
 
         response = HTTPClient.get url, params
@@ -242,7 +255,7 @@ module MetalArchives
         return nil if json['aaData'].empty?
 
         data = json['aaData'].first
-        id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
+        id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.delete('\\').split('/').last.gsub(/\D/, '').to_i
 
         find id
       end
@@ -264,7 +277,7 @@ module MetalArchives
       #
       def find_by!(query)
         obj = find_by query
-        obj.load! if obj
+        obj&.load!
 
         obj
       end
@@ -285,7 +298,7 @@ module MetalArchives
       def search(name)
         raise MetalArchives::Errors::ArgumentError unless name.is_a? String
 
-        url = "#{MetalArchives.config.endpoint}search/ajax-artist-search/"
+        url = "#{MetalArchives.config.default_endpoint}search/ajax-artist-search/"
         query = { :name => name }
 
         params = Parsers::Artist.map_params query
@@ -293,7 +306,7 @@ module MetalArchives
         l = lambda do
           @start ||= 0
 
-          if @max_items and @start >= @max_items
+          if @max_items && @start >= @max_items
             []
           else
             response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
@@ -305,7 +318,7 @@ module MetalArchives
 
             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
+              id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.delete('\\').split('/').last.gsub(/\D/, '').to_i
               objects << Artist.find(id)
             end
 
@@ -328,34 +341,7 @@ module MetalArchives
       # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
       #
       def all
-        url = "#{MetalArchives.config.endpoint}search/ajax-artist-search/"
-
-        l = lambda do
-          @start ||= 0
-
-          if @max_items and @start >= @max_items
-            []
-          else
-            response = HTTPClient.get url, :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.find(id)
-            end
-
-            @start += 200
-
-            objects
-          end
-        end
-
-        MetalArchives::Collection.new l
+        search ''
       end
     end
   end

data/lib/metal_archives/models/band.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'countries'
 
 module MetalArchives
-
   ##
   # Represents an band (person or group)
   #
@@ -144,7 +145,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 :status, :values => [:active, :split_up, :on_hold, :unknown, :changed_name, :disputed]
+    enum :status, :values => %i[active split_up on_hold unknown changed_name disputed]
 
     # TODO: releases
     # TODO: members
@@ -167,7 +168,7 @@ module MetalArchives
     ##
     # :attr_reader: logo
     #
-    # Returns +String+
+    # Returns +URI+ (rewritten if config option was enabled)
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
@@ -178,7 +179,7 @@ module MetalArchives
     ##
     # :attr_reader: photo
     #
-    # Returns +String+
+    # Returns +URI+ (rewritten if config option was enabled)
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
@@ -203,40 +204,41 @@ module MetalArchives
     property :links, :multiple => true
 
     protected
-      ##
-      # Fetch the data and assemble the model
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when receiving a status code == 404
-      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-      #
-      def assemble # :nodoc:
-        ## Base attributes
-        url = "#{MetalArchives.config.endpoint}band/view/id/#{id}"
-        response = HTTPClient.get url
 
-        properties = Parsers::Band.parse_html response.body
+    ##
+    # Fetch the data and assemble the model
+    #
+    # [Raises]
+    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when receiving a status code == 404
+    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
+    #
+    def assemble # :nodoc:
+      ## Base attributes
+      url = "#{MetalArchives.config.default_endpoint}band/view/id/#{id}"
+      response = HTTPClient.get url
 
-        ## Comment
-        url = "#{MetalArchives.config.endpoint}band/read-more/id/#{id}"
-        response = HTTPClient.get url
+      properties = Parsers::Band.parse_html response.body
 
-        properties[:comment] = response.body
+      ## Comment
+      url = "#{MetalArchives.config.default_endpoint}band/read-more/id/#{id}"
+      response = HTTPClient.get url
 
-        ## Similar artists
-        url = "#{MetalArchives.config.endpoint}band/ajax-recommendations/id/#{id}"
-        response = HTTPClient.get url
+      properties[:comment] = response.body
 
-        properties[:similar] = Parsers::Band.parse_similar_bands_html response.body
+      ## Similar artists
+      url = "#{MetalArchives.config.default_endpoint}band/ajax-recommendations/id/#{id}"
+      response = HTTPClient.get url
 
-        ## Related links
-        url = "#{MetalArchives.config.endpoint}link/ajax-list/type/band/id/#{id}"
-        response = HTTPClient.get url
+      properties[:similar] = Parsers::Band.parse_similar_bands_html response.body
 
-        properties[:links] = Parsers::Band.parse_related_links_html response.body
+      ## Related links
+      url = "#{MetalArchives.config.default_endpoint}link/ajax-list/type/band/id/#{id}"
+      response = HTTPClient.get url
 
-        properties
-      end
+      properties[:links] = Parsers::Band.parse_related_links_html response.body
+
+      properties
+    end
 
     class << self
       ##
@@ -248,9 +250,9 @@ module MetalArchives
       #     +Integer+
       #
       def find(id)
-        cache[id] = Band.new(:id => id) unless cache.include? id
+        return cache[id] if cache.include? id
 
-        cache[id]
+        Band.new :id => id
       end
 
       ##
@@ -299,7 +301,7 @@ module MetalArchives
       #     - +:independent+: boolean
       #
       def find_by(query)
-        url = "#{MetalArchives.config.endpoint}search/ajax-advanced/searching/bands"
+        url = "#{MetalArchives.config.default_endpoint}search/ajax-advanced/searching/bands"
         params = Parsers::Band.map_params query
 
         response = HTTPClient.get url, params
@@ -308,7 +310,7 @@ module MetalArchives
         return nil if json['aaData'].empty?
 
         data = json['aaData'].first
-        id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.gsub('\\', '').split('/').last.gsub(/\D/, '').to_i
+        id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.delete('\\').split('/').last.gsub(/\D/, '').to_i
 
         find id
       end
@@ -340,7 +342,7 @@ module MetalArchives
       #
       def find_by!(query)
         obj = find_by query
-        obj.load! if obj
+        obj&.load!
 
         obj
       end
@@ -371,14 +373,14 @@ module MetalArchives
       #     - +:independent+: boolean
       #
       def search_by(query)
-        url = "#{MetalArchives.config.endpoint}search/ajax-advanced/searching/bands"
+        url = "#{MetalArchives.config.default_endpoint}search/ajax-advanced/searching/bands"
 
         params = Parsers::Band.map_params query
 
         l = lambda do
           @start ||= 0
 
-          if @max_items and @start >= @max_items
+          if @max_items && @start >= @max_items
             []
           else
             response = HTTPClient.get url, params.merge(:iDisplayStart => @start)
@@ -390,7 +392,7 @@ module MetalArchives
 
             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
+              id = Nokogiri::HTML(data.first).xpath('//a/@href').first.value.delete('\\').split('/').last.gsub(/\D/, '').to_i
               objects << Band.find(id)
             end
 
@@ -432,7 +434,7 @@ module MetalArchives
       # - rdoc-ref:MetalArchives::Errors::ParserError when parsing failed. Please report this error.
       #
       def all
-        search_by Hash.new
+        search_by({})
       end
     end
   end