metal_archives 2.2.0 → 2.2.3

data/lib/metal_archives/models/band.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,18 +69,18 @@ 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_formed, :type => Date
+    property :date_formed, type: NilDate
 
     ##
     # :attr_reader: date_active
     #
-    # Returns +Array+ of rdoc-ref:Range
+    # Returns +Array+ of rdoc-ref:Range containing rdoc-ref:NilDate
     #
     # [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_active, :type => MetalArchives::Range, :multiple => true
+    property :date_active, type: MetalArchives::Range, multiple: true
 
     ##
     # :attr_reader: genres
@@ -90,7 +91,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 :genres, :multiple => true
+    property :genres, multiple: true
 
     ##
     # :attr_reader: lyrical_themes
@@ -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)
     #
-    property :lyrical_themes, :multiple => true
+    property :lyrical_themes, multiple: true
 
     ##
     # :attr_reader: label
@@ -112,7 +113,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 :label, :type => MetalArchives::Label
+    property :label, type: MetalArchives::Label
 
     ##
     # :attr_reader: independent
@@ -123,7 +124,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 :independent, :values => [true, false]
+    enum :independent, values: [true, false]
 
     ##
     # :attr_reader: comment
@@ -145,9 +146,19 @@ 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 => %i[active split_up on_hold unknown changed_name disputed]
+    enum :status, values: %i(active split_up on_hold unknown changed_name disputed)
+
+    ##
+    # :attr_reader: releases
+    #
+    # Returns +Array+ of rdoc-ref:Release
+    #
+    # [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 :releases, type: MetalArchives::Release, multiple: true
 
-    # TODO: releases
     # TODO: members
 
     ##
@@ -163,7 +174,7 @@ module MetalArchives
     #     - +:band+: rdoc-ref:Band
     #     - +:score+: +Integer+
     #
-    property :similar, :type => Hash, :multiple => true
+    property :similar, type: Hash, multiple: true
 
     ##
     # :attr_reader: logo
@@ -196,12 +207,12 @@ 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+ or +:merchandise+
     #     - +:title+: +String+
     #
-    property :links, :multiple => true
+    property :links, multiple: true
 
     protected
 
@@ -237,6 +248,12 @@ module MetalArchives
 
       properties[:links] = Parsers::Band.parse_related_links_html response.body
 
+      ## Releases
+      url = "#{MetalArchives.config.default_endpoint}band/discography/id/#{id}/tab/all"
+      response = HTTPClient.get url
+
+      properties[:releases] = Parsers::Band.parse_releases_html response.body
+
       properties
     end
 
@@ -252,7 +269,7 @@ module MetalArchives
       def find(id)
         return cache[id] if cache.include? id
 
-        Band.new :id => id
+        Band.new id: id
       end
 
       ##
@@ -292,7 +309,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range of rdoc-ref:NilDate
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -307,10 +324,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
@@ -332,7 +349,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range of +Date+
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -364,7 +381,7 @@ module MetalArchives
       #     - +:exact+: +Boolean+
       #     - +:genre+: +String+
       #     - +:country+: +ISO3166::Country+
-      #     - +:year_formation+: rdoc-ref:Range of +Date+
+      #     - +:year_formation+: rdoc-ref:Range containing rdoc-ref:NilDate
       #     - +:comment+: +String+
       #     - +:status+: see rdoc-ref:Band.status
       #     - +:lyrical_themes+: +String+
@@ -383,16 +400,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 Band 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 << Band.find(id)
             end
 
@@ -421,7 +438,8 @@ module MetalArchives
       #
       def search(name)
         raise MetalArchives::Errors::ArgumentError unless name.is_a? String
-        search_by :name => name
+
+        search_by name: name
       end
 
       ##

data/lib/metal_archives/models/base_model.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module MetalArchives
   ##
   # Abstract model class
@@ -8,7 +9,7 @@ module MetalArchives
     # Generic shallow copy constructor
     #
     def initialize(hash = {})
-      raise Errors::NotImplementedError, 'no :id property in model' unless respond_to? :id?, true
+      raise Errors::NotImplementedError, "no :id property in model" unless respond_to? :id?, true
 
       hash.each do |property, value|
         instance_variable_set("@#{property}", value) if self.class.properties.include? property
@@ -19,7 +20,7 @@ module MetalArchives
     # Returns true if two objects have the same type and id
     #
     def ==(obj)
-      obj.instance_of?(self.class) && id ==(obj.id)
+      obj.instance_of?(self.class) && id == obj.id
     end
 
     ##
@@ -30,7 +31,7 @@ module MetalArchives
     # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
     #
     def load!
-      raise Errors::InvalidIDError, 'no id present' unless !!id
+      raise Errors::InvalidIDError, "no id present" unless id
 
       # Use constructor to set attributes
       initialize assemble
@@ -42,7 +43,7 @@ module MetalArchives
 
       @loaded = true
       self.class.cache[id] = self
-    rescue => e
+    rescue StandardError => e
       # Don't cache invalid requests
       self.class.cache.delete id
       raise e
@@ -64,17 +65,17 @@ module MetalArchives
 
     protected
 
-      ##
-      # Fetch the data and assemble the model
-      #
-      # Override this method
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
-      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-      #
+    ##
+    # Fetch the data and assemble the model
+    #
+    # Override this method
+    #
+    # [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
-      raise Errors::NotImplementedError, 'method :assemble not implemented'
+      raise Errors::NotImplementedError, "method :assemble not implemented"
     end
 
     class << self
@@ -92,37 +93,37 @@ module MetalArchives
 
       protected
 
-        ##
-        # Defines a model property.
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+type+]
-        #       Data type of property (a constant)
-        #
-        #       Default: +String+
-        #
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
+      ##
+      # Defines a model property.
+      #
+      # [+name+]
+      #     Name of the property
+      #
+      # [+opts+]
+      #   [+type+]
+      #       Data type of property (a constant)
+      #
+      #       Default: +String+
+      #
+      #   [+multiple+]
+      #       Whether or not the property has multiple values (which
+      #       turns it into an +Array+ of +type+)
+      #
       def property(name, opts = {})
         (@properties ||= []) << name
 
         # property
         define_method(name) do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name ==(:id)
+          load! unless loaded? && instance_variable_defined?("@#{name}") || name == :id
           instance_variable_get("@#{name}")
         end
 
         # property?
         define_method("#{name}?") do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name ==(:id)
+          load! unless loaded? && instance_variable_defined?("@#{name}") || name == :id
 
           property = instance_variable_get("@#{name}")
-          property.respond_to?(:empty?) ? !property.empty? : !!property
+          property.respond_to?(:empty?) ? !property.empty? : !property.nil?
         end
 
         # property=
@@ -136,6 +137,7 @@ module MetalArchives
           type = opts[:type] || String
           if opts[:multiple]
             raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be Array for #{name}" unless value.is_a? Array
+
             value.each do |val|
               raise MetalArchives::Errors::TypeError, "invalid type #{val.class}, must be #{type} for #{name}" unless val.is_a? type
             end
@@ -147,22 +149,22 @@ module MetalArchives
         end
       end
 
-        ##
-        # Defines a model enum property.
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+values+]
-        #       Required. An array of possible values
-        #
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
+      ##
+      # Defines a model enum property.
+      #
+      # [+name+]
+      #     Name of the property
+      #
+      # [+opts+]
+      #   [+values+]
+      #       Required. An array of possible values
+      #
+      #   [+multiple+]
+      #       Whether or not the property has multiple values (which
+      #       turns it into an +Array+ of +type+)
+      #
       def enum(name, opts)
-        raise ArgumentError, 'opts[:values] is required' unless opts and opts[:values]
+        raise ArgumentError, "opts[:values] is required" unless opts && opts[:values]
 
         (@properties ||= []) << name
 
@@ -177,7 +179,7 @@ module MetalArchives
           load! unless loaded? && instance_variable_defined?("@#{name}")
 
           property = instance_variable_get("@#{name}")
-          property.respond_to?(:empty?) ? !property.empty? : !!property
+          property.respond_to?(:empty?) ? !property.empty? : !property.nil?
         end
 
         # property=
@@ -185,6 +187,7 @@ module MetalArchives
           # Check enum type
           if opts[:multiple]
             raise MetalArchives::Errors::TypeError, "invalid enum value #{value}, must be Array for #{name}" unless value.is_a? Array
+
             value.each do |val|
               raise MetalArchives::Errors::TypeError, "invalid enum value #{val} for #{name}" unless opts[:values].include? val
             end
@@ -196,19 +199,19 @@ module MetalArchives
         end
       end
 
-        ##
-        # Defines a model boolean property. This method is an alias for <tt>enum name, :values => [true, false]</tt>
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
+      ##
+      # Defines a model boolean property. This method is an alias for <tt>enum name, :values => [true, false]</tt>
+      #
+      # [+name+]
+      #     Name of the property
+      #
+      # [+opts+]
+      #   [+multiple+]
+      #       Whether or not the property has multiple values (which
+      #       turns it into an +Array+ of +type+)
+      #
       def boolean(name, opts = {})
-        enum name, opts.merge(:values => [true, false])
+        enum name, opts.merge(values: [true, false])
       end
     end
   end

data/lib/metal_archives/models/label.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'countries'
+require "date"
+require "countries"
 
 module MetalArchives
   ##
@@ -13,7 +13,7 @@ module MetalArchives
     #
     # Returns +Integer+
     #
-    property :id, :type => Integer
+    property :id, type: Integer
 
     ##
     # :attr_reader: name
@@ -46,7 +46,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: phone
@@ -68,7 +68,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 :specializations, :multiple => true
+    property :specializations, multiple: true
 
     ##
     # :attr_reader: date_founded
@@ -79,14 +79,14 @@ 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_founded, :type => NilDate
+    property :date_founded, type: NilDate
 
     ##
     # :attr_reader: sub_labels
     #
     # Returns +Array+ of rdoc-ref:Label
     #
-    property :sub_labels, :type => MetalArchives::Label, :multiple => true
+    property :sub_labels, type: MetalArchives::Label, multiple: true
 
     ##
     # :attr_reader: online_shopping
@@ -100,14 +100,14 @@ module MetalArchives
     #
     # Returns +Hash+ with the following keys: +title+, +content+
     #
-    property :contact, :type => Hash, :multiple => true
+    property :contact, type: Hash, multiple: true
 
     ##
     # :attr_reader: status
     #
     # Returns +:active+, +:closed+ or +:unknown+
     #
-    enum :status, :values => %i[active closed unknown]
+    enum :status, values: %i(active closed unknown)
 
     class << self
       ##
@@ -128,8 +128,8 @@ module MetalArchives
       def find_by_name(name, id)
         client.find_resource(
           :band,
-          :name => name,
-          :id => id
+          name: name,
+          id: id
         )
       end
     end