brickset_api 0.1.0

data/spec/brickset/client_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Client do
+  it 'knows its ancestors' do
+    aggregate_failures do
+      expect(described_class.ancestors).to include HTTParty
+      expect(described_class.ancestors).to include ActiveModel::Validations
+
+      expect(described_class.ancestors).to include Brickset::Api::Auth
+      expect(described_class.ancestors).to include Brickset::Api::Set
+      expect(described_class.ancestors).to include Brickset::Api::Collection::Set
+      expect(described_class.ancestors).to include Brickset::Api::Collection::Minifig
+      expect(described_class.ancestors).to include Brickset::Api::Collection::Advanced
+    end
+  end
+
+  it 'knows its base_uri' do
+    expect(described_class.base_uri).to eq 'https://brickset.com/api/v2.asmx'
+  end
+
+  describe '#initialize' do
+    context 'when a token is specified' do
+      subject { described_class.new(token: 'access-token') }
+
+      it 'sets the token attribute' do
+        expect(subject.token).to eq 'access-token'
+      end
+    end
+
+    context 'when no token is specified' do
+      subject { described_class.new }
+
+      it 'does not set the token attribute' do
+        expect(subject.token).to be_nil
+      end
+    end
+  end
+
+  describe '#call' do
+    let(:options) do
+      {}
+    end
+    let(:body) { 'apiKey=super-secret' }
+    let(:call) { subject.send(:call, '/method', options) }
+
+    before { stub_post('/method').with(body: body).to_return body: fixture('api_key_valid.xml') }
+
+    context 'when additional options have been set' do
+      let(:options) do
+        { attribute: 'value' }
+      end
+
+      let(:body) { 'attribute=value&apiKey=super-secret' }
+
+      it 'makes a POST request with the additional options and default options as the body' do
+        expect(described_class).to receive(:post).with('/method', { body: { attribute: 'value', apiKey: 'super-secret' } }).and_call_original
+        call
+      end
+    end
+
+    context 'when no additional options have been set' do
+      it 'makes a POST request with the default options as the body' do
+        expect(described_class).to receive(:post).with('/method', { body: { apiKey: 'super-secret' } }).and_call_original
+        call
+      end
+    end
+
+    context 'when the response is OK' do
+      it 'returns the response body' do
+        expect(call).to eq "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<string xmlns=\"https://brickset.com/api/\">OK</string>\n"
+      end
+    end
+
+    context 'when the response is not OK' do
+      before { stub_post('/method').with(body: body).to_return body: 'Error 500: Internal Server Error', status: 500 }
+
+      it 'raises the response body' do
+        expect { call }.to raise_error 'Error 500: Internal Server Error'
+      end
+    end
+  end
+
+  describe '#handle_update' do
+    let(:handle_update) { subject.send(:handle_update, response) }
+
+    let(:response) { fixture('api_key_valid.xml') }
+
+    it 'parses the specified response' do
+      expect(HappyMapper).to receive(:parse).with(response).and_call_original
+      handle_update
+    end
+
+    context 'when the content is OK' do
+      it 'returns true' do
+        expect(handle_update).to eq true
+      end
+    end
+
+    context 'when the content is not OK' do
+      let(:response) { fixture('api_key_invalid.xml') }
+
+      it 'saves a reference to the error' do
+        handle_update
+        expect(subject.errors[:base]).to match_array [ 'INVALIDKEY' ]
+      end
+
+      it 'returns false' do
+        expect(handle_update).to eq false
+      end
+    end
+  end
+
+  describe '#extract_attributes_from_options' do
+    let(:extract_attributes_from_options) { subject.send(:extract_attributes_from_options, options) }
+
+    context 'when there is a known attribute in the options hash' do
+      let(:options) do
+        { owned: 0 }
+      end
+
+      it 'sets its value to the known attribute' do
+        extract_attributes_from_options
+        expect(subject.owned).to eq 0
+      end
+    end
+
+    context 'when there is an unknown attribute in the options hash' do
+      let(:options) do
+        { unknown: 'value' }
+      end
+
+      it 'raises a KeyError' do
+        expect { extract_attributes_from_options }.to raise_error KeyError, "Attribute key 'unknown' is not supported"
+      end
+    end
+  end
+
+  describe '#default_options' do
+    let(:default_options) { subject.send(:default_options) }
+
+    context 'when the token has not been set' do
+      it 'knows its default options' do
+        expect(default_options).to eq apiKey: 'super-secret'
+      end
+    end
+
+    context 'when the token has been set' do
+      subject { described_class.new(token: 'access-token') }
+
+      it 'knows its default options' do
+        expect(default_options).to eq apiKey: 'super-secret', userHash: 'access-token'
+      end
+    end
+  end
+end

data/spec/brickset/configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Configuration do
+  describe '#api_key' do
+    it 'knows its default value' do
+      expect(subject.api_key).to be_nil
+    end
+  end
+end

data/spec/brickset/elements/additional_image_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::AdditionalImage do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'additionalImages'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_additional_images.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.thumbnail_url).to eq 'https://images.brickset.com/sets/AdditionalImages/10179-1/tn_10179-0000-xx-13-1_jpg.jpg'
+        expect(parsed.thumbnail_url).to eq 'https://images.brickset.com/sets/AdditionalImages/10179-1/tn_10179-0000-xx-13-1_jpg.jpg'
+        expect(parsed.image_url).to eq 'https://images.brickset.com/sets/AdditionalImages/10179-1/10179-0000-xx-13-1.jpg'
+      end
+    end
+  end
+
+end

data/spec/brickset/elements/collection_detail_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::CollectionDetail do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'collectionDetails'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_collection_detail.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.collection_id).to eq 12712521
+        expect(parsed.date_acquired).to eq '21-08-18'
+        expect(parsed.currency).to eq 'EUR'
+        expect(parsed.price_paid).to eq 3.0
+        expect(parsed.additional_price_paid).to eq 0.49
+        expect(parsed.current_estimated_value).to eq 3.49
+        expect(parsed.condition_when_acquired).to eq 'As new'
+        expect(parsed.acquired_from).to eq 'Mos Eisley'
+        expect(parsed.condition_now).to eq 'Assembled'
+        expect(parsed.location).to eq 'In a galaxy far, far away...'
+        expect(parsed.notes).to eq 'A long time ago...'
+        expect(parsed.parts).to eq true
+        expect(parsed.minifigs).to eq false
+        expect(parsed.instructions).to eq true
+        expect(parsed.box).to eq true
+        expect(parsed.modified).to eq true
+        expect(parsed.will_trade).to eq false
+        expect(parsed.deleted).to eq false
+      end
+    end
+  end
+end

data/spec/brickset/elements/collection_total_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::CollectionTotal do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'collectionTotals'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_collection_totals.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.total_sets_owned).to eq 126
+        expect(parsed.total_sets_wanted).to eq 85
+        expect(parsed.total_distinct_sets_owned).to eq 121
+        expect(parsed.total_minifigs_owned).to eq 156
+        expect(parsed.total_minifigs_wanted).to eq 40
+      end
+    end
+  end
+end

data/spec/brickset/elements/condition_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::Condition do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'conditions'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_collection_detail_conditions.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.condition).to eq 'Assembled'
+      end
+    end
+  end
+end

data/spec/brickset/elements/instruction_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::Instruction do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'instructions'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_instructions.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.url).to eq 'https://www.lego.com/biassets/bi/4525430.pdf'
+        expect(parsed.description).to eq 'Building instruction 10179'
+      end
+    end
+  end
+end

data/spec/brickset/elements/minifig_collection_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::MinifigCollection do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'minifigCollection'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_minifig_collection.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.minifig_number).to eq '85863pb076'
+        expect(parsed.owned_in_sets).to eq 1
+        expect(parsed.owned_loose).to eq 0
+        expect(parsed.owned_total).to eq 1
+        expect(parsed.wanted).to eq true
+      end
+    end
+  end
+end

data/spec/brickset/elements/review_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::Review do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'reviews'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_reviews.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.author).to eq 'darth-vader'
+        expect(parsed.title).to eq 'Ultimate Collector Series Millennium Falcon'
+        expect(parsed.review).to match(/^A long time ago, in a Lego factory far, far away.../)
+        expect(parsed.date_posted).to eq Date.parse('2010-10-01')
+        expect(parsed.overall_rating).to eq 5
+        expect(parsed.parts).to eq 5
+        expect(parsed.building_experience).to eq 5
+        expect(parsed.playability).to eq 3
+        expect(parsed.value_for_money).to eq 4
+        expect(parsed.html).to eq false
+      end
+    end
+  end
+end

data/spec/brickset/elements/set_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+RSpec.describe Brickset::Elements::Set do
+
+  it 'knows its ancestors' do
+    expect(described_class.ancestors).to include HappyMapper
+  end
+
+  it 'knows its tag' do
+    expect(described_class.tag_name).to eq 'sets'
+  end
+
+  describe '#parse' do
+    let(:xml) { fixture('get_sets.xml') }
+    let(:parsed) { described_class.parse(xml, single: true) }
+
+    it 'knows its attributes' do
+      aggregate_failures do
+        expect(parsed.id).to eq 5860
+        expect(parsed.number).to eq '10179'
+        expect(parsed.number_variant).to eq 1
+        expect(parsed.name).to eq "Ultimate Collector's Millennium Falcon"
+        expect(parsed.year).to eq '2007'
+        expect(parsed.description).to be_nil
+        expect(parsed.category).to eq 'Normal'
+        expect(parsed.theme).to eq 'Star Wars'
+        expect(parsed.theme_group).to eq 'Licensed'
+        expect(parsed.subtheme).to eq 'Ultimate Collector Series'
+        expect(parsed.pieces).to eq '5197'
+        expect(parsed.minifigs).to eq '5'
+        expect(parsed.image).to eq true
+        expect(parsed.image_url).to eq 'https://images.brickset.com/sets/images/10179-1.jpg'
+        expect(parsed.image_filename).to eq '10179-1'
+        expect(parsed.thumbnail_url).to eq 'https://images.brickset.com/sets/thumbs/tn_10179-1_jpg.jpg'
+        expect(parsed.thumbnail_url_large).to eq 'https://images.brickset.com/sets/small/10179-1.jpg'
+        expect(parsed.brickset_url).to eq 'https://brickset.com/sets/10179-1'
+        expect(parsed.owned_by_total).to eq 3807
+        expect(parsed.wanted_by_total).to eq 9349
+        expect(parsed.released).to eq true
+        expect(parsed.rating).to eq 4.76190476190476
+        expect(parsed.user_rating).to eq 0
+        expect(parsed.review_count).to eq 21
+        expect(parsed.instructions_count).to eq 1
+        expect(parsed.additional_image_count).to eq 5
+        expect(parsed.last_updated).to eq Date.parse('2017-08-23')
+        expect(parsed.age_minimum).to eq 16
+        expect(parsed.age_maximum).to be_nil
+        expect(parsed.notes).to be_nil
+        expect(parsed.tags).to be_nil
+        expect(parsed.retail_price_uk).to eq '342.49'
+        expect(parsed.retail_price_us).to eq '499.99'
+        expect(parsed.retail_price_ca).to eq ''
+        expect(parsed.retail_price_eu).to eq ''
+        expect(parsed.date_added_to_shop).to eq '2007-10-24'
+        expect(parsed.date_removed_from_shop).to eq '2010-05-04'
+        expect(parsed.packaging_type).to eq 'Box'
+        expect(parsed.height).to eq 0.0
+        expect(parsed.width).to eq 0.0
+        expect(parsed.depth).to eq 0.0
+        expect(parsed.weight).to eq 0.0
+        expect(parsed.availability).to eq 'LEGO exclusive'
+        expect(parsed.ean).to eq ''
+        expect(parsed.upc).to eq ''
+        expect(parsed.acm_data_count).to eq 0
+        expect(parsed.owned).to eq false
+        expect(parsed.wanted).to eq true
+        expect(parsed.number_owned).to eq 0
+        expect(parsed.user_notes).to eq 'A long time ago in a galaxy far, far away...'
+      end
+    end
+  end
+end