marvel_api 0.2.0 → 0.2.1

data/spec/marvel_api/client/client_series_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Marvel::Client do
+  let(:client) { marvel_test_client }
+
+  context 'Series endpoints' do
+    let(:id) { 354 }
+
+    describe '#series' do
+      before do
+        stub_get('series', returns: 'series/series.json')
+      end
+
+      it 'fetches a list of series' do
+        expect(client.series.size).to eq 20
+        expect(client.series.map(&:title).take(3))
+          .to eq ['100th Anniversary Special (2014 - Present)',
+                  '15-Love (2011)',
+                  '15-Love GN-TPB (2013 - Present)']
+      end
+
+      it 'requests public/v1/series successfully' do
+        expect(client.series.status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series).to be_an Array
+        expect(client.series.sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#serie' do
+      before do
+        stub_get("series/#{id}", returns: 'series/serie.json')
+      end
+
+      it 'fetches a single series by id' do
+        expect(client.serie(id).size).to eq 1
+        expect(client.serie(id).pop.title)
+          .to eq 'Avengers (1998 - 2004)'
+      end
+
+      it 'requests public/v1/series/#{id} successfully' do
+        expect(client.serie(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.serie(id)).to be_an Array
+        expect(client.serie(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#series_characters' do
+      before do
+        stub_get("series/#{id}/characters",
+                 returns: 'series/series_characters.json')
+      end
+
+      it 'fetches a list of characters filtered by series id' do
+        expect(client.series_characters(id).size).to eq 20
+        expect(client.series_characters(id).map(&:name).take(3))
+          .to eq ['A.I.M.',
+                  'Abomination (Emil Blonsky)',
+                  'Archangel']
+      end
+
+      it 'requests public/v1/series/#{id}/characters successfully' do
+        expect(client.series_characters(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series_characters(id)).to be_an Array
+        expect(client.series_characters(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#series_comics' do
+      before do
+        stub_get("series/#{id}/comics",
+                 returns: 'series/series_comics.json')
+      end
+
+      it 'fetches a list of comics filtered by series id' do
+        expect(client.series_comics(id).size).to eq 20
+        expect(client.series_comics(id).map(&:id).take(3))
+          .to eq [923, 845, 767]
+      end
+
+      it 'requests public/v1/series/#{id}/comics successfully' do
+        expect(client.series_comics(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series_comics(id)).to be_an Array
+        expect(client.series_comics(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#series_creators' do
+      before do
+        stub_get("series/#{id}/creators",
+                 returns: 'series/series_creators.json')
+      end
+
+      it 'fetches a list of creators filtered by series id' do
+        expect(client.series_creators(id).size).to eq 20
+        expect(client.series_creators(id).map(&:id).take(3))
+          .to eq [807, 5744, 6694]
+      end
+
+      it 'requests public/v1/series/#{id}/creators successfully' do
+        expect(client.series_creators(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series_creators(id)).to be_an Array
+        expect(client.series_creators(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#series_events' do
+      before do
+        stub_get("series/#{id}/events",
+                 returns: 'series/series_events.json')
+      end
+
+      it 'fetches a list of events filtered by series id' do
+        expect(client.series_events(id).size).to eq 2
+        expect(client.series_events(id).map(&:title))
+          .to eq ['Avengers Disassembled', 'Maximum Security']
+      end
+
+      it 'requests public/v1/series/#{id}/events successfully' do
+        expect(client.series_events(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series_events(id)).to be_an Array
+        expect(client.series_events(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#series_stories' do
+      before do
+        stub_get("series/#{id}/stories",
+                 returns: 'series/series_stories.json')
+      end
+
+      it 'fetches a list of stories filtered by series id' do
+        expect(client.series_stories(id).size).to eq 20
+        expect(client.series_stories(id).map(&:id).take(3))
+          .to eq [490, 542, 572]
+      end
+
+      it 'requests public/v1/series/#{id}/stories successfully' do
+        expect(client.series_stories(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.series_stories(id)).to be_an Array
+        expect(client.series_stories(id).sample).to be_a Hashie::Mash
+      end
+    end
+  end
+end

data/spec/marvel_api/client/client_story_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+
+describe Marvel::Client do
+  let(:client) { marvel_test_client }
+
+  context 'Story endpoints' do
+    let(:id) { 2209 }
+
+    describe '#stories' do
+      before do
+        stub_get('stories', returns: 'stories/stories.json')
+      end
+
+      it 'fetches a list of stories' do
+        expect(client.stories.size).to eq 20
+        expect(client.stories.map(&:id).take(3))
+          .to eq [3, 7, 8]
+      end
+
+      it 'requests public/v1/stories successfully' do
+        expect(client.stories.status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.stories).to be_an Array
+        expect(client.stories.sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story' do
+      before do
+        stub_get("stories/#{id}", returns: 'stories/story.json')
+      end
+
+      it 'fetches a single story by id' do
+        expect(client.story(id).size).to eq 1
+        expect(client.story(id).pop.title)
+          .to eq '1 of 3 - House of M'
+      end
+
+      it 'requests public/v1/stories/#{id} successfully' do
+        expect(client.story(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story(id)).to be_an Array
+        expect(client.story(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story_characters' do
+      before do
+        stub_get("stories/#{id}/characters",
+                 returns: 'stories/story_characters.json')
+      end
+
+      it 'fetches a list of characters filtered by story id' do
+        expect(client.story_characters(id).size).to eq 2
+        expect(client.story_characters(id).map(&:name))
+          .to eq ['Iron Man', 'Wolverine']
+      end
+
+      it 'requests public/v1/stories/#{id}/characters successfully' do
+        expect(client.story_characters(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story_characters(id)).to be_an Array
+        expect(client.story_characters(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story_comics' do
+      before do
+        stub_get("stories/#{id}/comics",
+                 returns: 'stories/story_comics.json')
+      end
+
+      it 'fetches a list of comics filtered by story id' do
+        expect(client.story_comics(id).size).to eq 2
+        expect(client.story_comics(id).map(&:title))
+          .to eq ['House of M: World of M (Trade Paperback)',
+                  'Wolverine (2003) #33']
+      end
+
+      it 'requests public/v1/stories/#{id}/comics successfully' do
+        expect(client.story_comics(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story_comics(id)).to be_an Array
+        expect(client.story_comics(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story_creators' do
+      before do
+        stub_get("stories/#{id}/creators",
+                 returns: 'stories/story_creators.json')
+      end
+
+      it 'fetches a list of creators filtered by story id' do
+        expect(client.story_creators(id).size).to eq 5
+        expect(client.story_creators(id).map(&:fullName).take(3))
+          .to eq ['Randy Gentile', 'Paul Mounts', 'Javier Saltares']
+      end
+
+      it 'requests public/v1/stories/#{id}/creators successfully' do
+        expect(client.story_creators(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story_creators(id)).to be_an Array
+        expect(client.story_creators(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story_events' do
+      before do
+        stub_get("stories/#{id}/events",
+                 returns: 'stories/story_events.json')
+      end
+
+      it 'fetches a list of events filtered by story id' do
+        expect(client.story_events(id).size).to eq 1
+        expect(client.story_events(id).map(&:title))
+          .to eq ['House of M']
+      end
+
+      it 'requests public/v1/stories/#{id}/events successfully' do
+        expect(client.story_events(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story_events(id)).to be_an Array
+        expect(client.story_events(id).sample).to be_a Hashie::Mash
+      end
+    end
+
+    describe '#story_series' do
+      before do
+        stub_get("stories/#{id}/series",
+                 returns: 'stories/story_series.json')
+      end
+
+      it 'fetches a list of series filtered by story id' do
+        expect(client.story_series(id).size).to eq 2
+        expect(client.story_series(id).map(&:id))
+          .to eq [1614, 632]
+      end
+
+      it 'requests public/v1/stories/#{id}/series successfully' do
+        expect(client.story_series(id).status).to eq 'Ok'
+      end
+
+      it 'returns an [ Hashie::Mash ]' do
+        expect(client.story_series(id)).to be_an Array
+        expect(client.story_series(id).sample).to be_a Hashie::Mash
+      end
+    end
+  end
+end

data/spec/marvel_api/error_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe Marvel::Response::Error do
+  let(:client) { marvel_test_client }
+
+  context 'A request' do
+    describe 'for a non-existent resource' do
+      before do
+        stub_get('characters/1',
+                 response_code: 404,
+                 returns: 'errors/resource_not_found.json')
+      end
+
+      it 'returns a 404 not found' do
+        expect(client.character(1).to_s)
+          .to eq '404 We couldn\'t find that character'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.character(1))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with a limit parameter greater than 100' do
+      before do
+        stub_get('characters', limit: 101,
+                 response_code: 409,
+                 returns: 'errors/limit_over_100.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(limit: 101).to_s)
+          .to eq '409 You may not request more than 100 items.'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(limit: 101))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with an invalid limit or less than 1' do
+      before do
+        stub_get('characters', limit: 0,
+                 response_code: 409,
+                 returns: 'errors/limit_invalid.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(limit: 0).to_s)
+          .to eq '409 You must pass an integer limit greater than 0.'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(limit: 0))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with an invalid paramter' do
+      before do
+        stub_get('characters', invalid_param: 1,
+                 response_code: 409,
+                 returns: 'errors/invalid_parameter.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(invalid_param: 1).to_s)
+          .to eq '409 We don\'t recognize the parameter invalid_param'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(invalid_param: 1))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with an empty parameter' do
+      before do
+        stub_get('characters', name: '',
+                 response_code: 409,
+                 returns: 'errors/empty_parameter.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(name: '').to_s)
+          .to eq '409 name cannot be blank if it is set'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(name: ''))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with an invalid ordering parameter' do
+      before do
+        stub_get('characters', orderBy: 'goofiness',
+                 response_code: 409,
+                 returns: 'errors/invalid_ordering.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(orderBy: 'goofiness').to_s)
+          .to eq '409 goofiness is not a valid ordering parameter.'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(orderBy: 'goofiness'))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with too many values sent to a multi-value list filter' do
+      before do
+        stub_get('characters', comics: [*1..11] * ',',
+                 response_code: 409,
+                 returns: 'errors/excessive_filter_values.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(comics: [*1..11] * ',').to_s)
+          .to eq '409 You may not submit more than 10 issue ids.'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(comics: [*1..11] * ','))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    describe 'with an invalid filter value' do
+      before do
+        stub_get('characters', comics: 'one',
+                 response_code: 409,
+                 returns: 'errors/invalid_filter_value.json')
+      end
+
+      it 'returns a 409 error' do
+        expect(client.characters(comics: 'one').to_s)
+          .to eq '409 You must pass at least one valid '\
+                 'issue id if you set the issue filter.'
+      end
+
+      it 'returns a Marvel::Response::Error' do
+        expect(client.characters(comics: 'one'))
+          .to be_a Marvel::Response::Error
+      end
+    end
+
+    context 'with an Etag' do
+      let(:id) { 1009652 }
+
+      describe 'that is valid and up-to-date' do
+        let(:etag) { 'd3f102f7c8d0ef375f395733ae2ce06d1899a94f' }
+
+        before do
+          stub_get("characters/#{id}",
+                   etag: etag,
+                   response_code: 304,
+                   returns: nil)
+        end
+
+        it 'returns a 304 error' do
+          expect(client.character(id, etag: etag).to_s)
+            .to eq '304 Not Modified'
+        end
+
+        it 'returns a Marvel::Response::Error' do
+          expect(client.character(1009652, etag: etag))
+            .to be_a Marvel::Response::Error
+        end
+      end
+
+      describe 'that is invalid or expired' do
+        let(:etag) { 'invalid_or_expired_etag' }
+
+        before do
+          stub_get("characters/#{id}",
+                   etag: etag,
+                   returns: 'characters/character.json')
+        end
+
+        it 'fetches the requested resource' do
+          expect(client.character(id).status).to eq 'Ok'
+          expect(client.character(id).pop.name).to eq 'Thanos'
+        end
+      end
+    end
+  end
+end