metal_archives 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c1527cbe8ea9df768ea3112b958fbba43f29dd0
-  data.tar.gz: 82971bd30252efb8e77badb9dfe10c71fb86a585
+  metadata.gz: '00870c0edc861f8ff624c887f5a83346e1d2cba6'
+  data.tar.gz: 19f0e38a29a17f35604ae692c5773c8bcee0cede
 SHA512:
-  metadata.gz: 64fb61f7acd105d6aa93f005cccdc1d246de4ac7b9a2fc4f944c7a3ff729698eaedd42faee4228f25549f33beedef1f5d34d3834953abe59054f16161b4dcea0
-  data.tar.gz: e57bc2994341940aa33f283ae028ca3cb7a51f1e634eee3041c66d3d75ff0d765ee93e87cf30d394a6cc9ade61d8458bdab08fb5e4bc5dd5d45ec146fe43d38b
+  metadata.gz: 2499d481e8719a3913504a826214824b7871004ffabed9661e1bb623510bdc3d4cbd9a80499d8b7a2888d24b0314334d6fb29dad12f033057a23fe2e7bcb7949
+  data.tar.gz: d6825c4a2172caa7b37d3080154e653961c3e456e3018f20b283b286a493064a5401a00348752d3f207fb5af7a1b272df9d9145b136e922e3662b515fe499012

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
-## 0.0.1
+## 1.0.0
+
+- Add `Artist#photo`
+- Return URI instead of String for `Artist#photo`, `Band#logo` and `Band#photo`
+- Allow specifying endpoint
+- Allow specifying additional Faraday middleware
+- Implement `NilDate` class allowing year, month or date to be `nil`
+- Add `#cached?` and `#loaded?`
+- Add verbose output option
+- Return `MetalArchives::Errors::TypeError` in certain cases
+- Migrate tests to RSpec
+
+## 0.8.0
+
+- Add configurable endpoint
+
+## 0.7.0
+
+- Add `Band#all` and `Artist#all`
+
+## 0.6.0
+
+- Add LRU object cache
+- Remove HTTP cache due to uncacheable response headers
+- Add `Band#find_by!` and `Artist#find_by!`
+
+## 0.5.0
+
+- Fix dependency versions
+
+## 0.4.0
+
+- Bubble errors up
+- Add `find!`
+
+## 0.3.0
+
+- Add `Collection` iterator
+
+## 0.2.1
+
+- Add correct license
+- Lock dependency versions
+
+## 0.2.0
+
+## 0.1.0
 
 Initial release

data/README.md

@@ -40,9 +40,7 @@ MetalArchives.configure do |c|
   
   ## Custom logger (optional)
   c.logger = Logger.new File.new('metal_archives.log')
-  
-  ## Verbose output
-  # c.debug = false
+  c.logger.level = Logger::INFO
 end
 ```
 

data/lib/metal_archives/configuration.rb

@@ -27,8 +27,6 @@ module MetalArchives
       @config = MetalArchives::Configuration.new
       yield @config
 
-      @config.logger.level = @config.debug ? Logger::DEBUG : Logger::WARN
-
       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?
@@ -80,11 +78,6 @@ module MetalArchives
     #
     attr_accessor :logger
 
-    ##
-    # Verbose output
-    #
-    attr_accessor :debug
-
     ##
     # Cache size (per object class)
     #
@@ -98,7 +91,6 @@ module MetalArchives
       @throttle_rate = 1
       @throttle_wait = 3
       @logger = Logger.new STDOUT
-      @debug = false
       @cache_size = 100
     end
   end

data/lib/metal_archives/http_client.rb

@@ -41,6 +41,7 @@ module MetalArchives
           f.response  :logger, MetalArchives.config.logger
 
           f.use       MetalArchives::Middleware::Headers
+          f.use       MetalArchives::Middleware::CacheCheck
           f.use       MetalArchives::Middleware::RewriteEndpoint
 
           MetalArchives.config.middleware.each { |m| f.use m } if MetalArchives.config.middleware

data/lib/metal_archives/middleware/cache_check.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module MetalArchives
+  module Middleware
+    ##
+    # Log cache status
+    #
+    class CacheCheck < Faraday::Response::Middleware # :nodoc:
+      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
+      end
+    end
+  end
+end

data/lib/metal_archives/middleware/rewrite_endpoint.rb

@@ -9,7 +9,7 @@ module MetalArchives
     #
     class RewriteEndpoint < Faraday::Middleware
       def call(env)
-        RewriteEndpoint.rewrite(env[:url])
+        env[:url] = RewriteEndpoint.rewrite(env[:url])
 
         @app.call env
       end

data/lib/metal_archives/models/artist.rb

@@ -68,18 +68,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_of_birth, :type => Date
+    property :date_of_birth, :type => NilDate
 
     ##
     # :attr_reader: date_of_death
     #
-    # Returns +Date+
+    # Returns 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_of_death, :type => Date
+    property :date_of_death, :type => NilDate
 
     ##
     # :attr_reader: cause_of_death

data/lib/metal_archives/models/band.rb

@@ -62,7 +62,7 @@ module MetalArchives
     ##
     # :attr_reader: date_formed
     #
-    # Returns +Date+
+    # Returns rdoc-ref:NilDate
     #
     # [Raises]
     # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id

data/lib/metal_archives/models/label.rb

@@ -7,19 +7,23 @@ module MetalArchives
   ##
   # Represents a record label
   #
-  class Label < BaseModel
+  class Label < MetalArchives::BaseModel
     ##
     # :attr_reader: id
     #
     # Returns +Integer+
     #
-    property :id
+    property :id, :type => Integer
 
     ##
     # :attr_reader: name
     #
     # Returns +String+
     #
+    # [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 :name
 
     ##
@@ -27,6 +31,10 @@ module MetalArchives
     #
     # Returns multiline +String+
     #
+    # [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 :address
 
     ##
@@ -34,6 +42,10 @@ module MetalArchives
     #
     # Returns +ISO316::Country+
     #
+    # [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 :country, :type => ISO3166::Country
 
     ##
@@ -41,6 +53,10 @@ module MetalArchives
     #
     # Returns +String+
     #
+    # [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 :phone
 
     ##
@@ -48,14 +64,22 @@ module MetalArchives
     #
     # Returns +Array+ of +String+
     #
+    # [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 :specializations, :multiple => true
 
     ##
     # :attr_reader: date_founded
     #
-    # Returns +Date+
+    # Returns +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_founded, :type => Date
+    property :date_founded, :type => NilDate
 
     ##
     # :attr_reader: sub_labels

data/lib/metal_archives/parsers/artist.rb

@@ -58,9 +58,19 @@ module MetalArchives
                 props[:name] = content
               when 'Age:'
                 date = content.strip.gsub(/[0-9]* *\(born ([^\)]*)\)/, '\1')
-                props[:date_of_birth] = Date.parse date
+                begin
+                  props[:date_of_birth] = NilDate.parse date
+                rescue MetalArchives::Errors::ArgumentError => e
+                  dob = Date.parse date
+                  props[:date_of_birth] = NilDate.new dob.year, dob.month, dob.day
+                end
               when 'R.I.P.:'
-                props[:date_of_death] = Date.parse content
+                begin
+                  dod = Date.parse content
+                  props[:date_of_death] = NilDate.new dod.year, dod.month, dod.day
+                rescue ArgumentError => e
+                  props[:date_of_death] = NilDate.parse content
+                end
               when 'Died of:'
                 props[:cause_of_death] = content
               when 'Place of origin:'

data/lib/metal_archives/utils/nil_date.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'date'
+
 module MetalArchives
   ##
   # Date with nullable year, month and day
@@ -7,6 +9,8 @@ module MetalArchives
   # WARNING: No validation on actual date is performed
   #
   class NilDate
+    include Comparable
+
     attr_accessor :year, :month, :day
 
     def initialize(year = nil, month = nil, day = nil)
@@ -50,5 +54,41 @@ module MetalArchives
     rescue
       raise MetalArchives::Errors::ArgumentError, 'invalid date'
     end
+
+    def to_s
+      year = (@year || 0).to_s.rjust 2, '0'
+      month = (@month || 0).to_s.rjust 2, '0'
+      day = (@day || 0).to_s.rjust 2, '0'
+
+      "#{year}-#{month}-#{day}"
+    end
+
+    ##
+    # Comparison operator
+    #
+    def <=>(other)
+      return nil if other.nil?
+
+      # Return nil if one of the two years is nil
+      return nil if (@year.nil? && !other.year.nil?) || !@year.nil? && other.year.nil?
+
+      # Return nil if one of the two months is nil
+      return nil if (@month.nil? && !other.month.nil?) || !@month.nil? && other.month.nil?
+
+      # Return nil if one of the two months is nil
+      return nil if (@day.nil? && !other.day.nil?) || !@day.nil? && other.day.nil?
+
+      comp_year = @year <=> other.year
+      if comp_year == 0
+        comp_month = @month <=> other.month
+        if comp_month == 0
+          return @day <=> other.day
+        else
+          return comp_month
+        end
+      else
+        comp_year
+      end
+    end
   end
 end

data/lib/metal_archives/version.rb

@@ -4,5 +4,5 @@ module MetalArchives
   ##
   # MetalArchives API version
   #
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/metal_archives.rb

@@ -3,6 +3,7 @@
 require 'openssl'
 
 require 'metal_archives/middleware/headers'
+require 'metal_archives/middleware/cache_check'
 require 'metal_archives/middleware/rewrite_endpoint'
 
 require 'metal_archives/version'

data/spec/configuration_spec.rb

@@ -20,8 +20,6 @@ RSpec.describe MetalArchives::Configuration do
       expect(subject).to respond_to :request_timeout=
       expect(subject).to respond_to :logger
       expect(subject).to respond_to :logger=
-      expect(subject).to respond_to :debug
-      expect(subject).to respond_to :debug=
       expect(subject).to respond_to :cache_size
       expect(subject).to respond_to :cache_size=
     end
@@ -29,7 +27,6 @@ RSpec.describe MetalArchives::Configuration do
     it 'has default properties' do
       expect(subject.default_endpoint).to eq 'https://www.metal-archives.com/'
       expect(subject.logger).not_to be_nil
-      expect(subject.debug).to be false
       expect(subject.cache_size).to be_an Integer
     end
 
@@ -37,12 +34,10 @@ RSpec.describe MetalArchives::Configuration do
       subject.endpoint = 'http://my-proxy.com/'
       logger = Logger.new STDERR
       subject.logger = logger
-      subject.debug = true
       subject.cache_size = 0
 
       expect(subject.endpoint).to eq 'http://my-proxy.com/'
       expect(subject.logger).to be logger
-      expect(subject.debug).to be true
       expect(subject.cache_size).to eq 0
     end
   end

data/spec/models/artist_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe MetalArchives::Artist do
       expect(artist.aliases).to be_empty
       expect(artist.country).to eq ISO3166::Country['ES']
       expect(artist.location).to eq 'Oviedo, Asturias'
-      expect(artist.date_of_birth).to eq Date.new(1972, 9, 2)
+      expect(artist.date_of_birth).to eq MetalArchives::NilDate.new(1972, 9, 2)
       expect(artist.gender).to eq :male
       expect(artist.biography).to match 'Avalanch'
       expect(artist.trivia).to match 'Sanctuarium Estudios'
@@ -25,7 +25,7 @@ RSpec.describe MetalArchives::Artist do
       expect(artist).to be_instance_of MetalArchives::Artist
       expect(artist.name).to eq 'Ian Fraser Kilmister'
       expect(artist.aliases).to include 'Lemmy Kilmister'
-      expect(artist.date_of_death).to eq Date.new(2015, 12, 28)
+      expect(artist.date_of_death).to eq MetalArchives::NilDate.new(2015, 12, 28)
       expect(artist.links.length).to eq 5
       expect(artist.links.count { |l| l[:type] == :official }).to eq 1
       expect(artist.links.count { |l| l[:type] == :unofficial }).to eq 2
@@ -38,16 +38,12 @@ RSpec.describe MetalArchives::Artist do
       expect(MetalArchives::Parsers::Artist.map_params(:name => 'name')[:query]).to eq 'name'
     end
 
-    it 'rewrites URIs' do
-      old_endpoint = MetalArchives.config.endpoint
-      MetalArchives.config.endpoint = 'https://foo.bar/'
+    it 'uses NilDate' do
+      artist = MetalArchives::Artist.find 35049
 
-      artist = MetalArchives::Artist.find! 60908
-
-      expect(artist.photo.scheme).to eq 'https'
-      expect(artist.photo.host).to eq 'foo.bar'
-
-      MetalArchives.config.endpoint = old_endpoint
+      expect(artist.name).to eq 'Johan Johansson'
+      expect(artist.date_of_birth).to be_instance_of MetalArchives::NilDate
+      expect(artist.date_of_birth).to eq MetalArchives::NilDate.new(1975, nil, nil)
     end
   end
 

data/spec/support/metal_archives.rb

@@ -19,8 +19,6 @@ MetalArchives.configure do |c|
   end
 
   ## Custom logger (optional)
-  # c.logger = Logger.new 'metal_archives.log'
-
-  ## Verbose output
-  # c.debug = false
+  c.logger = Logger.new STDOUT
+  c.logger.level = Logger::INFO
 end

data/spec/utils/nil_date_spec.rb

@@ -95,4 +95,54 @@ RSpec.describe MetalArchives::NilDate do
       expect(-> { described_class.parse "This isn't a date" }).to raise_error MetalArchives::Errors::ArgumentError
     end
   end
+
+  it 'includes comparable' do
+    date1 = described_class.new 2015, 01, 01
+    date2 = described_class.new 2015, 01, 02
+    date3 = described_class.new 2015, 02, 01
+    date4 = described_class.new 2016, 01, 02
+    date5 = described_class.new 2015, 01, 01
+    date6 = described_class.new 2014, 12, 31
+    date7 = described_class.new 2015, 01, nil
+    date8 = described_class.new 2015, 01, nil
+    date9 = described_class.new 2015, 02, nil
+    date10 = described_class.new 2015, nil, nil
+    date11 = described_class.new 2016, nil, nil
+
+    expect(date1 <=> date2).to eq -1
+    expect(date2 <=> date1).to eq 1
+    expect(date1 <=> date3).to eq -1
+    expect(date3 <=> date1).to eq 1
+    expect(date1 <=> date4).to eq -1
+    expect(date4 <=> date1).to eq 1
+    expect(date1 <=> date5).to eq 0
+    expect(date5 <=> date1).to eq 0
+    expect(date6 <=> date1).to eq -1
+    expect(date1 <=> date6).to eq 1
+
+    expect(date1 <=> date7).to eq nil
+    expect(date7 <=> date1).to eq nil
+    expect(date1 <=> date9).to eq nil
+    expect(date9 <=> date1).to eq nil
+    expect(date7 <=> date8).to eq 0
+    expect(date8 <=> date7).to eq 0
+    expect(date7 <=> date9).to eq -1
+    expect(date9 <=> date7).to eq 1
+    expect(date7 <=> date10).to eq nil
+    expect(date10 <=> date7).to eq nil
+    expect(date10 <=> date11).to eq -1
+    expect(date11 <=> date10).to eq 1
+  end
+
+  it 'prints to string' do
+    date1 = described_class.new 2015, nil, nil
+    date2 = described_class.new 2015, 01, nil
+    date3 = described_class.new 2015, 01, 01
+    date4 = described_class.new 2015, nil, 01
+
+    expect(date1.to_s).to eq '2015-00-00'
+    expect(date2.to_s).to eq '2015-01-00'
+    expect(date3.to_s).to eq '2015-01-01'
+    expect(date4.to_s).to eq '2015-00-01'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metal_archives
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -212,6 +212,7 @@ files:
 - lib/metal_archives/configuration.rb
 - lib/metal_archives/error.rb
 - lib/metal_archives/http_client.rb
+- lib/metal_archives/middleware/cache_check.rb
 - lib/metal_archives/middleware/headers.rb
 - lib/metal_archives/middleware/rewrite_endpoint.rb
 - lib/metal_archives/models/artist.rb