metal_archives 0.8.0 → 1.0.0

data/spec/factories/artist_factory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :artist, :class => MetalArchives::Artist do
+    id { Faker::Number.number [1, 2, 3, 4].sample }
+    name { Faker::Name.name }
+    gender { %i[male female].sample }
+    biography { Faker::Lorem.words(200).join ' ' }
+    trivia { Faker::Lorem.words(200).join ' ' }
+
+    country { ISO3166::Country[Faker::Address.country_code] }
+    location { Faker::Address.city }
+
+    date_of_birth { Faker::Date.birthday 18, 65 }
+
+    links do
+      3.times.collect do
+        {
+          :url => Faker::Internet.url,
+          :type => %i[official unofficial unlisted_bands].sample,
+          :title => Faker::Lorem.words(4).join(' ')
+        }
+      end
+    end
+
+    trait :has_died do
+      date_of_death { Faker::Date.between date_of_birth, Date.today }
+      cause_of_death { %w(Suicide N/A Accident Cancer Illness Murder).sample }
+    end
+
+    trait :with_aliases do
+      aliases do
+        3.times.collect { Faker::Name.name }
+      end
+    end
+  end
+end

data/spec/factories/band_factory.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :band, :class => MetalArchives::Band do
+    id { Faker::Number.number [1, 2, 3, 4].sample }
+    name { Faker::Name.name }
+    status { %i[active split_up on_hold unknown changed_name disputed].sample }
+
+    comment { Faker::Lorem.words(200).join ' ' }
+
+    country { ISO3166::Country[Faker::Address.country_code] }
+    location { Faker::Address.city }
+
+    date_formed { Faker::Date.birthday 0, 50 }
+    date_active { build_list :range }
+
+    label { [build(:label), nil].sample }
+    independent { label.nil? }
+
+    logo { Faker::Internet.url }
+    photo { Faker::Internet.url }
+
+    genres do
+      3.times.collect do
+        "#{%w(Black Death Doom Power Progressive Speed Thrash).sample} Metal"
+      end
+    end
+
+    lyrical_themes do
+      3.times.collect do
+        ['Fantasy', 'Epic battles', 'Tales', 'Myths', 'Legends', 'Feelings', 'Life', 'Eden', 'Glory', 'the Four Elements', 'Metal'].sample
+      end
+    end
+
+    similar do
+      4.times.collect do
+        {
+          :band => build(:band),
+          :score => Faker::Number.between(1, 100)
+        }
+      end
+    end
+
+    links do
+      3.times.collect do
+        {
+          :url => Faker::Internet.url,
+          :type => %i[official unofficial unlisted_bands].sample,
+          :title => Faker::Lorem.words(4).join(' ')
+        }
+      end
+    end
+
+    trait :with_aliases do
+      aliases do
+        3.times.collect { Faker::Name.name }
+      end
+    end
+  end
+end

data/spec/factories/nil_date_factory.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :nil_date, :class => MetalArchives::NilDate do
+    year { Faker::Date.backward(99).year }
+    month { Faker::Date.backward(99).month }
+    day { Faker::Date.backward(99).day }
+  end
+end

data/spec/factories/range_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :range, :class => MetalArchives::Range do
+    send(:begin) { Faker::Date.birthday 0, 50 }
+    send(:end) { Faker::Date.birthday }
+  end
+end

data/spec/models/artist_spec.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Artist do
+  describe 'properties' do
+    it 'Alberto Rionda has properties' do
+      artist = MetalArchives::Artist.find 60908
+
+      expect(artist).to be_instance_of MetalArchives::Artist
+      expect(artist.id).to eq 60908
+      expect(artist.name).to eq 'Alberto Rionda'
+      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.gender).to eq :male
+      expect(artist.biography).to match 'Avalanch'
+      expect(artist.trivia).to match 'Sanctuarium Estudios'
+      expect(artist.photo).to be_instance_of URI::HTTPS
+      expect(artist.photo.path).to eq '/images/6/0/9/0/60908_artist.jpg'
+    end
+
+    it 'Lemmy Kilmister has properties' do
+      artist = MetalArchives::Artist.find 260
+
+      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.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
+      expect(artist.links.count { |l| l[:type] == :unlisted_bands }).to eq 2
+      expect(artist.links.select { |l| l[:type] == :official }.first[:url]).to eq 'https://www.facebook.com/OfficialLemmy'
+      expect(artist.links.select { |l| l[:type] == :official }.first[:title]).to eq 'Facebook'
+    end
+
+    it 'maps query parameters' 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/'
+
+      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
+    end
+  end
+
+  describe 'methods' do
+    describe 'find' do
+      it 'finds an artist' do
+        artist = MetalArchives::Artist.find 60908
+
+        expect(artist).to be_instance_of MetalArchives::Artist
+        expect(artist.name).to eq 'Alberto Rionda'
+      end
+
+      it 'lazily loads' do
+        artist = MetalArchives::Artist.find -1
+
+        expect(artist).to be_instance_of MetalArchives::Artist
+      end
+    end
+
+    describe 'find!' do
+      it 'finds an artist' do
+        artist = MetalArchives::Artist.find! 60908
+
+        expect(artist).to be_instance_of MetalArchives::Artist
+        expect(artist.name).to eq 'Alberto Rionda'
+      end
+
+      it 'raises on invalid id' do
+        expect(-> { MetalArchives::Artist.find! -1 }).to raise_error MetalArchives::Errors::APIError
+        expect(-> { MetalArchives::Artist.find! 0 }).to raise_error MetalArchives::Errors::InvalidIDError
+        expect(-> { MetalArchives::Artist.find! nil }).to raise_error MetalArchives::Errors::InvalidIDError
+      end
+    end
+
+    describe 'find_by' do
+      it 'finds an artist' do
+        artist = MetalArchives::Artist.find_by :name => 'Alberto Rionda'
+
+        expect(artist).to be_instance_of MetalArchives::Artist
+        expect(artist.id).to eq 60908
+      end
+
+      it 'returns nil on invalid id' do
+        artist = MetalArchives::Artist.find_by :name => 'SomeNonExistantName'
+
+        expect(artist).to be_nil
+      end
+    end
+
+    describe 'find_by!' do
+      it 'finds an artist' do
+        artist = MetalArchives::Artist.find_by! :name => 'Alberto Rionda'
+
+        expect(artist).to be_instance_of MetalArchives::Artist
+        expect(artist.id).to eq 60908
+      end
+
+      it 'returns nil on invalid id' do
+        artist = MetalArchives::Artist.find_by! :name => 'SomeNonExistantName'
+
+        expect(artist).to be_nil
+      end
+    end
+
+    describe 'search' do
+      it 'returns a collection' do
+        collection = MetalArchives::Artist.search 'Alberto Rionda'
+
+        expect(collection).to be_instance_of MetalArchives::Collection
+        expect(collection.first).to be_instance_of MetalArchives::Artist
+      end
+
+      it 'returns a collection' do
+        expect(MetalArchives::Artist.search('Alberto Rionda').count).to eq 1
+        expect(MetalArchives::Artist.search('Name').count).to eq 10
+        expect(MetalArchives::Artist.search('SomeNonExistantName').count).to eq 0
+        expect(MetalArchives::Artist.search 'SomeNonExistantName').to be_empty
+        expect(MetalArchives::Artist.search('Filip').count).to be > 200
+      end
+
+      it 'returns an empty collection' do
+        expect(MetalArchives::Artist.search 'SomeNoneExistantName').to be_empty
+      end
+    end
+
+    describe 'all' do
+      it 'returns a collection' do
+        expect(MetalArchives::Artist.all).to be_instance_of MetalArchives::Collection
+      end
+    end
+  end
+end

data/spec/models/band_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Band do
+  describe 'properties' do
+    it 'Pathfinder has properties' do
+      band = MetalArchives::Band.find 122302
+
+      expect(band).to be_instance_of MetalArchives::Band
+      expect(band.name).to eq 'Pathfinder'
+      expect(band.aliases).to be_empty
+      expect(band.country).to eq ISO3166::Country['PL']
+      expect(band.location).to eq 'Poznań'
+      expect(band.date_formed).to eq Date.new(2006)
+      expect(band.date_active).to eq [MetalArchives::Range.new(Date.new(2006), nil)]
+      expect(band.status).to eq :active
+      expect(band.genres).to eq ['Symphonic Power']
+      expect(band.lyrical_themes.sort).to eq ['Fantasy', 'Battles', 'Glory', 'The Four Elements', 'Metal'].sort
+      expect(band.comment).to match 'Pathfinder was founded by'
+      expect(band.logo).to be_instance_of URI::HTTPS
+      expect(band.logo.path).to eq '/images/1/2/2/3/122302_logo.jpg'
+      expect(band.photo).to be_instance_of URI::HTTPS
+      expect(band.photo.path).to eq '/images/1/2/2/3/122302_photo.jpg'
+      expect(band.independent).not_to be true
+      expect(band.similar.length).to eq 19
+      expect(band.links.length).to eq 15
+      expect(band.links.count { |l| l[:type] == :official }).to eq 12
+      expect(band.links.count { |l| l[:type] == :merchandise }).to eq 3
+      expect(band.links.select { |l| l[:type] == :merchandise }.first[:url]).to eq 'http://www.amazon.com/Fifth-Element-Pathfinder/dp/B007MNNCVW'
+      expect(band.links.select { |l| l[:type] == :merchandise }.first[:title]).to eq 'Amazon'
+    end
+
+    it 'Lemmy Kilmister has properties' do
+      band = MetalArchives::Band.find 32
+
+      expect(band).to be_instance_of MetalArchives::Band
+      expect(band.name).to eq 'Rhapsody of Fire'
+      expect(band.aliases).to match %w(Thundercross Rhapsody)
+    end
+
+    it 'maps status' do
+      expect(MetalArchives::Parsers::Band.send(:map_status, nil)).to eq ''
+      expect(MetalArchives::Parsers::Band.send(:map_status, :active)).to eq 'Active'
+      expect(MetalArchives::Parsers::Band.send(:map_status, :split_up)).to eq 'Split-up'
+      expect(MetalArchives::Parsers::Band.send(:map_status, :on_hold)).to eq 'On hold'
+      expect(MetalArchives::Parsers::Band.send(:map_status, :unknown)).to eq 'Unknown'
+      expect(MetalArchives::Parsers::Band.send(:map_status, :changed_name)).to eq 'Changed name'
+      expect(MetalArchives::Parsers::Band.send(:map_status, :disputed)).to eq 'Disputed'
+
+      expect(-> { MetalArchives::Parsers::Band.send(:map_status, :invalid_status) }).to raise_error MetalArchives::Errors::ParserError
+    end
+
+    it 'rewrites URIs' do
+      old_endpoint = MetalArchives.config.endpoint
+      MetalArchives.config.endpoint = 'https://foo.bar/'
+
+      band = MetalArchives::Band.find! 122302
+
+      expect(band.logo.scheme).to eq 'https'
+      expect(band.logo.host).to eq 'foo.bar'
+
+      expect(band.logo.scheme).to eq 'https'
+      expect(band.photo.host).to eq 'foo.bar'
+
+      MetalArchives.config.endpoint = old_endpoint
+    end
+  end
+
+  describe 'methods' do
+    describe 'find' do
+      it 'finds a band' do
+        band = MetalArchives::Band.find 3540361100
+
+        expect(band).not_to be_nil
+        expect(band).to be_instance_of MetalArchives::Band
+        expect(band.id).to eq 3540361100
+        expect(band.name).to eq 'Alquimia'
+        expect(band.country).to eq ISO3166::Country['ES']
+
+        expect(band.logo).to be_instance_of URI::HTTPS
+        expect(band.logo.path).to eq '/images/3/5/4/0/3540361100_logo.gif'
+
+        expect(band.photo).to be_instance_of URI::HTTPS
+        expect(band.photo.path).to eq '/images/3/5/4/0/3540361100_photo.jpg'
+      end
+
+      it 'lazily loads' do
+        band = MetalArchives::Band.find -1
+
+        expect(band).to be_instance_of MetalArchives::Band
+      end
+    end
+
+    describe 'find!' do
+      it 'finds a band' do
+        band = MetalArchives::Band.find! 3540361100
+
+        expect(band).to be_instance_of MetalArchives::Band
+        expect(band.name).to eq 'Alquimia'
+      end
+
+      it 'raises on invalid id' do
+        expect(-> { MetalArchives::Band.find! -1 }).to raise_error MetalArchives::Errors::APIError
+        expect(-> { MetalArchives::Band.find! 0 }).to raise_error MetalArchives::Errors::InvalidIDError
+        expect(-> { MetalArchives::Band.find! nil }).to raise_error MetalArchives::Errors::InvalidIDError
+      end
+    end
+
+    describe 'find_by' do
+      it 'finds a band' do
+        band = MetalArchives::Band.find_by :name => 'Falconer'
+
+        expect(band).to be_instance_of MetalArchives::Band
+        expect(band.id).to eq 74
+      end
+
+      it 'returns nil on invalid id' do
+        band = MetalArchives::Band.find_by :name => 'SomeNonExistantName'
+
+        expect(band).to be_nil
+      end
+    end
+
+    describe 'find_by!' do
+      it 'finds a band' do
+        band = MetalArchives::Band.find_by! :name => 'Falconer'
+
+        expect(band).to be_instance_of MetalArchives::Band
+        expect(band.id).to eq 74
+      end
+
+      it 'returns nil on invalid id' do
+        band = MetalArchives::Band.find_by! :name => 'SomeNonExistantName'
+
+        expect(band).to be_nil
+      end
+    end
+
+    describe 'search' do
+      it 'returns a collection' do
+        collection = MetalArchives::Band.search 'Alquimia'
+
+        expect(collection).to be_instance_of MetalArchives::Collection
+        expect(collection.first).to be_instance_of MetalArchives::Band
+      end
+
+      it 'returns an empty collection' do
+        expect(MetalArchives::Band.search 'SomeNoneExistantName').to be_empty
+      end
+
+      it 'searches by name' do
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia').count).to eq 5
+        expect(MetalArchives::Band.search_by(:name => 'Lost Horizon').count).to eq 3
+        expect(MetalArchives::Band.search_by(:name => 'Lost Horizon', :exact => true).count).to eq 2
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :genre => 'Melodic Power').count).to eq 2
+      end
+
+      it 'searches by year' do
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :year => MetalArchives::Range.new(nil, nil)).count).to eq 5
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2013), nil)).count).to eq 1
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2008))).count).to eq 1
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2013))).count).to eq 2
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :year => MetalArchives::Range.new(nil, Date.new(2013))).count).to eq 5
+      end
+
+      it 'searches by country' do
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['ES']).count).to eq 1
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).count).to eq 3
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).count).to eq 3
+        expect(MetalArchives::Band.search_by(:name => 'Alquimia', :label => 'Mutus Liber').count).to eq 1
+      end
+    end
+
+    describe 'all' do
+      it 'returns a collection' do
+        expect(MetalArchives::Band.all).to be_instance_of MetalArchives::Collection
+      end
+    end
+  end
+end

data/spec/models/base_model_spec.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+
+##
+# Sample model without :id property or :assemble method
+#
+class ModelOne < MetalArchives::BaseModel
+  property :property_one
+end
+
+##
+# Sample model without :assemble method
+#
+class ModelTwo < MetalArchives::BaseModel
+  property :id
+  property :property_one
+end
+
+##
+# Sample complete model
+#
+class ModelThree < MetalArchives::BaseModel
+  property :id
+  property :property_one
+
+  def assemble
+    { :property_one => 'Property One' }
+  end
+end
+
+##
+# Sample complete model
+#
+class ModelFour < MetalArchives::BaseModel
+  property :id
+  property :property_one
+
+  def assemble
+    { :property_one => 'Property One' }
+  end
+end
+
+##
+# Sample invalid model
+#
+class ModelFive < MetalArchives::BaseModel
+  property :id
+  property :property_one
+
+  def assemble
+    raise MetalArchives::Errors::APIError
+  end
+end
+
+RSpec.describe MetalArchives::BaseModel do
+  it 'requires an :id property' do
+    expect(-> { ModelOne.new(:property_one => 'foo') }).to raise_error MetalArchives::Errors::NotImplementedError
+  end
+
+  it 'requires an :assemble method' do
+    expect(-> { ModelTwo.new(:id => 'foo').property_one }).to raise_error MetalArchives::Errors::NotImplementedError
+  end
+
+  it 'defines methods' do
+    model = ModelTwo.new :id => 'foo'
+
+    expect(model).to respond_to :id
+    expect(model).to respond_to :id=
+    expect(model).to respond_to :id?
+    expect(model).to respond_to :property_one
+    expect(model).to respond_to :property_one=
+    expect(model).to respond_to :property_one?
+    expect(model).not_to respond_to :property_two
+    expect(model).not_to respond_to :property_two=
+    expect(model).not_to respond_to :property_two?
+  end
+
+  it 'returns properties' do
+    model = ModelThree.new :id => 'foo', :property_one => 'bar'
+
+    expect(model.id).to eq 'foo'
+    expect(model.property_one).to eq 'bar'
+  end
+
+  it 'sets properties' do
+    model = ModelThree.new :id => 'foo', :property_one => 'bar'
+
+    model.id = 'baz'
+    model.property_one = 'bat'
+
+    expect(model.id).to eq 'baz'
+    expect(model.property_one).to eq 'bat'
+  end
+
+  it 'checks properties' do
+    model = ModelThree.new :id => 'foo', :property_one => 'bar'
+    model2 = ModelThree.new :id => 'foo'
+    model2.load!
+    model2.property_one = nil
+
+    expect(model.id?).to be true
+    expect(model.property_one?).to be true
+
+    expect(model2.id?).to be true
+    expect(model2.property_one?).to be false
+  end
+
+  it 'calls assemble' do
+    model = ModelThree.new :id => 'foo'
+
+    expect(model.id).to eq 'foo'
+    expect(model.property_one).to eq 'Property One'
+  end
+
+  it 'lazily loads' do
+    model = ModelThree.new :id => 'foo'
+
+    expect(model).to be_instance_variable_defined '@id'
+    expect(model).not_to be_instance_variable_defined '@property_one'
+
+    model.property_one
+
+    expect(model).to be_instance_variable_defined '@id'
+    expect(model).to be_instance_variable_defined '@property_one'
+    expect(model.property_one).to eq 'Property One'
+  end
+
+
+  it 'implements the load! operation' do
+    model = ModelThree.new :id => 'foo'
+
+    expect(model).to be_instance_variable_defined '@id'
+    expect(model).not_to be_instance_variable_defined '@property_one'
+
+    model.load!
+
+    expect(model).to be_instance_variable_defined '@id'
+    expect(model).to be_instance_variable_defined '@property_one'
+    expect(model.property_one).to eq 'Property One'
+  end
+
+  it 'implements the equal operator' do
+    m1 = ModelThree.new :id => 'id_one'
+    m2 = ModelThree.new :id => 'id_one'
+    m3 = ModelThree.new :id => 'id_two'
+    m4 = ModelFour.new :id => 'id_one'
+
+    expect(m1).to eq m2
+    expect(m2).not_to eq m3
+    expect(m1).not_to eq m3
+    expect(m1).not_to eq m4
+    expect(m2).not_to eq m4
+  end
+
+  describe 'loaded?' do
+    it 'has a :loaded? method' do
+      expect(ModelThree.new).to respond_to :loaded?
+    end
+
+    it 'returns false on lazy load' do
+      m = ModelThree.new :id => 'id_one'
+
+      expect(m).not_to be_loaded
+    end
+
+    it 'returns true on load!' do
+      m = ModelThree.new :id => 'id_one'
+      m.load!
+
+      expect(m).to be_loaded
+    end
+  end
+
+  describe 'cached?' do
+    context 'valid model' do
+      it 'has a :cached? method' do
+        expect(ModelThree.new).to respond_to :cached?
+      end
+
+      it "doesn't cache lazily loaded objects" do
+        m = ModelThree.new :id => 'id_one'
+
+        expect(m).not_to be_loaded
+        expect(m).not_to be_cached
+      end
+
+      it 'caches loaded objects' do
+        m = ModelThree.new :id => 'id_one'
+        m.load!
+
+        expect(m).to be_loaded
+        expect(m).to be_cached
+      end
+    end
+
+    context 'invalid model' do
+      it 'has a :cached? method' do
+        expect(ModelFive.new).to respond_to :cached?
+      end
+
+      it "doesn't cache lazily loaded objects" do
+        m = ModelFive.new :id => 'id_one'
+
+        expect(m).not_to be_loaded
+        expect(m).not_to be_cached
+      end
+
+      it "doesn't cache loaded invalid objects" do
+        m = ModelFive.new :id => 'id_one'
+        expect(-> { m.load! }).to raise_error MetalArchives::Errors::APIError
+
+        expect(m).not_to be_loaded
+        expect(m).not_to be_cached
+      end
+    end
+  end
+end