marver 0.0.0 → 0.0.2

data/spec/fixtures/serie.json

@@ -0,0 +1,102 @@
+{
+  "code": 200,
+  "status": "Ok",
+  "copyright": "© 2014 MARVEL",
+  "attributionText": "Data provided by Marvel. © 2014 MARVEL",
+  "attributionHTML": "<a href=\"http://marvel.com\">Data provided by Marvel. © 2014 MARVEL</a>",
+  "etag": "35cdca2e00cecb0c9f613382c0d92155d6c971d3",
+  "data": {
+    "offset": 0,
+    "limit": 20,
+    "total": 1,
+    "count": 1,
+    "results": [
+      {
+        "id": 2002,
+        "title": "Daredevil (1963 - 1998)",
+        "description": "Join the Man Without Fear as he stands up for justice! Blind lawyer Matt Murdock protects the streets of Hell's Kitchen by night against dangerous foes like Bullseye and the Kingpin! Includes the classic stories by icon Frank Miller that changed comics forever.",
+        "resourceURI": "http://gateway.marvel.com/v1/public/series/2002",
+        "urls": [
+          {
+            "type": "detail",
+            "url": "http://marvel.com/comics/series/2002/daredevil_1963_-_1998?utm_campaign=apiRef&utm_source=f302f582215c3deedff86e8015f853c7"
+          }
+        ],
+        "startYear": 1963,
+        "endYear": 1998,
+        "rating": "",
+        "type": "ongoing",
+        "modified": "2014-03-19T14:31:12-0400",
+        "thumbnail": {
+          "path": "http://i.annihil.us/u/prod/marvel/i/mg/1/00/5130f628766d9",
+          "extension": "jpg"
+        },
+        "creators": {
+          "available": 279,
+          "collectionURI": "http://gateway.marvel.com/v1/public/series/2002/creators",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/87",
+              "name": "Mark Bagley",
+              "role": "penciller (cover)"
+            }
+          ],
+          "returned": 20
+        },
+        "characters": {
+          "available": 57,
+          "collectionURI": "http://gateway.marvel.com/v1/public/series/2002/characters",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009175",
+              "name": "Beast"
+            }
+          ],
+          "returned": 20
+        },
+        "stories": {
+          "available": 819,
+          "collectionURI": "http://gateway.marvel.com/v1/public/series/2002/stories",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/stories/15722",
+              "name": "Life Be Not Proud!",
+              "type": "interiorStory"
+            }
+          ],
+          "returned": 20
+        },
+        "comics": {
+          "available": 381,
+          "collectionURI": "http://gateway.marvel.com/v1/public/series/2002/comics",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/comics/8072",
+              "name": "Daredevil (1963)"
+            }
+          ],
+          "returned": 20
+        },
+        "events": {
+          "available": 6,
+          "collectionURI": "http://gateway.marvel.com/v1/public/series/2002/events",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/events/116",
+              "name": "Acts of Vengeance!"
+            }
+          ],
+          "returned": 6
+        },
+        "next": {
+          "resourceURI": "http://gateway.marvel.com/v1/public/series/449",
+          "name": "Daredevil (1998 - 2011)"
+        },
+        "previous": {
+          "resourceURI": "http://gateway.marvel.com/v1/public/series/449",
+          "name": "Daredevil (1998 - 2011)"
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/story.json

@@ -0,0 +1,94 @@
+{
+  "code": 200,
+  "status": "Ok",
+  "etag": "889444dc620e1a126b7da5ed58120347d0eb32b0",
+  "data": {
+    "offset": 0,
+    "limit": 20,
+    "total": 1,
+    "count": 1,
+    "results": [
+      {
+        "id": 892,
+        "title": "Cover #892",
+        "description": "",
+        "resourceURI": "http://gateway.marvel.com/v1/public/stories/892",
+        "type": "cover",
+        "modified": "1969-12-31T19:00:00-0500",
+        "thumbnail": null,
+        "creators": {
+          "available": 1,
+          "collectionURI": "http://gateway.marvel.com/v1/public/stories/892/creators",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/374",
+              "name": "Steve Epting",
+              "role": "penciller (cover)"
+            }
+          ],
+          "returned": 1
+        },
+        "characters": {
+          "available": 4,
+          "collectionURI": "http://gateway.marvel.com/v1/public/stories/892/characters",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009165",
+              "name": "Avengers"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009220",
+              "name": "Captain America"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009368",
+              "name": "Iron Man"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009664",
+              "name": "Thor"
+            }
+          ],
+          "returned": 4
+        },
+        "series": {
+          "available": 1,
+          "collectionURI": "http://gateway.marvel.com/v1/public/stories/892/series",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/series/581",
+              "name": "Thor (1998 - 2004)"
+            }
+          ],
+          "returned": 1
+        },
+        "comics": {
+          "available": 1,
+          "collectionURI": "http://gateway.marvel.com/v1/public/stories/892/comics",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/comics/715",
+              "name": "Thor (1998) #81"
+            }
+          ],
+          "returned": 1
+        },
+        "events": {
+          "available": 1,
+          "collectionURI": "http://gateway.marvel.com/v1/public/stories/892/events",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/events/234",
+              "name": "Avengers Disassembled"
+            }
+          ],
+          "returned": 1
+        },
+        "originalIssue": {
+          "resourceURI": "http://gateway.marvel.com/v1/public/comics/715",
+          "name": "Thor (1998) #81"
+        }
+      }
+    ]
+  }
+}

data/spec/marver/client_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require './lib/marver/rest/client.rb'
+require './lib/marver.rb'
+
+describe Marver::Client do
+  let(:client) { Marver::Client.new("private_key", "public_key") }
+
+  it 'has a character finder' do
+    expect(client.characters.class).to eq Marver::CharacterFinder
+  end
+
+end

data/spec/marver/credentials_spec.rb

@@ -0,0 +1,19 @@
+require './lib/marver.rb'
+
+describe Marver::Credentials do
+  let(:credentials) { Marver::Credentials.new("priv_key", "pub_key") }
+
+  it "has a API private key" do
+    expect(credentials.public_key).to eq "pub_key"
+  end
+
+  it "has a API public key" do
+    expect(credentials.private_key).to eq "priv_key"
+  end
+
+  it 'has a timestamp' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(credentials.timestamp).to eq "1"
+  end
+
+end

data/spec/marver/data_container_spec.rb

@@ -0,0 +1,23 @@
+require './lib/marver.rb'
+
+describe Marver::DataContainer do
+  let(:response) { Marver::REST::Response.new("{ \"code\": 200, \"status\": \"Ok\", \"etag\": \"ec5ab621cf3760eb6f2df2e6270ccb56c6debfb7\", \"data\": { \"offset\": 0, \"limit\": 20, \"total\": 1, \"count\": 1, \"results\": [1]}}") }
+
+  let(:data_container) { Marver::DataContainer.new(response) }
+
+  it '#offset' do
+    expect(data_container.offset).to eq 0
+  end
+
+  it '#limit' do
+    expect(data_container.limit).to eq 20
+  end
+
+  it '#total' do
+    expect(data_container.total).to eq 1
+  end
+
+  it '#results' do
+    expect(data_container.results.class).to eq Fixnum
+  end
+end

data/spec/marver/entities/core/character_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Marver::Character do
+
+  describe 'Attributes' do
+    let(:json) { fixture('character.json').read }
+    let(:response) { Marver::REST::Response.new(json) }
+    let(:credentials) { Marver::Credentials.new('pub_key', 'priv_key') }
+    let(:data_container) { Marver::DataContainer.new(response) }
+    let(:character) { Marver::Character.new(data_container.results, credentials) }
+
+    it '#id - The unique ID of the character resource' do
+      expect(character.id).to eq 1009220
+    end
+
+    it '#name - The name of the character.' do
+      expect(character.name).to eq "Captain America"
+    end
+
+    it '#description - A short bio or description of the character.' do
+      expect(character.description).to eq "Vowing to serve his country any way he could, young Steve Rogers took the super soldier serum to become America's one-man army. Fighting for the red, white and blue for over 60 years, Captain America is the living, breathing symbol of freedom and liberty."
+    end
+
+    it '#resourceURI - The canonical URL identifier for this resource.' do
+      Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+      expect(character.resource_uri).to eq "http://gateway.marvel.com/v1/public/characters/1009220?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+    end
+
+    it '#urls - A set of public web site URLs for the resource.' do
+      expect(character.urls.class).to eq Array
+      expect(character.urls.first.type).to eq "detail"
+      expect(character.urls.first.url).to eq "http://marvel.com/comics/characters/1009220/captain_america?utm_campaign=apiRef&utm_source=f302f582215c3deedff86e8015f853c7"
+    end
+
+    it '#thumbnail - The representative image for this character.' do
+      expect(character.thumbnail.full_path).to eq "http://i.annihil.us/u/prod/marvel/i/mg/2/c0/5261a81d0154e.jpg"
+      expect(character.thumbnail.class).to eq Marver::Image
+    end
+
+    context 'summary objects' do
+      before :each do
+        Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+      end
+
+      it '#comics - A resource list containing comics which feature this character.' do
+        expect(character.comics.class).to eq Array
+        expect(character.comics.first.class).to eq Marver::ComicSummary
+        expect(character.comics.first.name).to eq "Age of Apocalypse (2011) #2 (Avengers Art Appreciation Variant)"
+        expect(character.comics.first.resource_uri).to eq          "http://gateway.marvel.com/v1/public/comics/42539?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+      end
+
+      it '#stories - A resource list of stories in which this character appears.' do
+        expect(character.stories.class).to eq Array
+        expect(character.stories.first.class).to eq Marver::StorySummary
+        expect(character.stories.first.name).to eq "Cover #892"
+        expect(character.stories.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/stories/892?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+        expect(character.stories.first.type).to eq "cover"
+      end
+
+      it '#events - A resource list of events in which this character appears.' do
+        expect(character.events.class).to eq Array
+        expect(character.events.first.class).to eq Marver::EventSummary
+        expect(character.events.first.name).to eq "Acts of Vengeance!"
+        expect(character.events.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/events/116?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+      end
+
+      it '#series - A resource list of series in which this character appears.' do
+        expect(character.series.class).to eq Array
+        expect(character.series.first.class).to eq Marver::SerieSummary
+        expect(character.series.first.name).to eq "Age of Apocalypse (2011 - Present)"
+        expect(character.series.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/series/15331?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+      end
+    end
+
+  end
+end

data/spec/marver/entities/core/comic_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe Marver::Comic do
+  let(:json) { JSON.parse(fixture('comic.json').read)['data']['results'].first }
+  let(:credentials) { Marver::Credentials.new("pub_key", "priv_key") }
+  let(:comic) { Marver::Comic.new(json, credentials) }
+
+  it '#id - The unique ID of the comic resource' do
+    expect(comic.id).to eq 38524
+  end
+
+  it '#title - The title of the comic.' do
+    expect(comic.title).to eq "Age of X: Universe (2011) #1"
+  end
+
+  it '#resource_uri - The canonical URL identifier for this resource.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.resource_uri).to eq "http://gateway.marvel.com/v1/public/comics/38524?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+  end
+
+  it '#digital_id - The ID of the digital comic representation of this comic. Will be 0 if the comic is not available digitally.' do
+    expect(comic.digital_id).to eq 20260
+  end
+
+  it '#issue_number - The number of the issue in the series (will generally be 0 for collection formats).' do
+    expect(comic.issue_number).to eq 1
+  end
+
+  it '#variant_description - If the issue is a variant (e.g. an alternate cover, second printing, or director\'s cut), a text description of the variant.' do
+    expect(comic.variant_description).to eq ""
+  end
+
+  it '#description - The preferred description of the comic.' do
+    expect(comic.description).to eq "In an age without the X-Men, mutants are hated and hunted. The surviving mutants create a last bastion for their dying race: Fortress X. With this AGE OF X, humanity vows to see mutants destroyed and a team of champions find themselves united. \n"
+  end
+
+  it '#isbn - The ISBN for the comic (generally only populated for collection formats).' do
+    expect(comic.isbn).to eq ""
+  end
+
+  it '#upc - The UPC barcode number for the comic (generally only populated for periodical formats).' do
+    expect(comic.upc).to eq "5960607573-00111"
+  end
+
+  it '#diamond_code - The Diamond code for the comic.' do
+    expect(comic.diamond_code).to eq "JAN110795"
+  end
+
+  it '#ean - The EAN barcode for the comic.' do
+    expect(comic.ean).to eq ""
+  end
+  it '#issn - The ISSN barcode for the comic.' do
+    expect(comic.issn).to eq ""
+  end
+
+  it '#format - The publication format of the comic e.g. comic, hardcover, trade paperback.' do
+    expect(comic.format).to eq "Comic"
+  end
+
+  it '#page_count - The number of story pages in the comic.' do
+    expect(comic.page_count).to eq 40
+  end
+
+  it '#thumbnails - The representative image for this comic.' do
+    expect(comic.thumbnail.class).to eq Marver::Image
+    expect(comic.thumbnail.full_path).to eq "http://i.annihil.us/u/prod/marvel/i/mg/7/70/4f57719ff38c5.jpg"
+  end
+
+  describe '#dates - A list of key dates for this comic.' do
+    it 'is an array of KeyDate objects' do
+      expect(comic.dates.class).to eq Array
+      expect(comic.dates.first.class).to eq Marver::KeyDate
+    end
+  end
+
+  it '#text_objects - A set of descriptive text blurbs for the comic.' do
+    expect(comic.text_objects.class).to eq Array
+    expect(comic.text_objects.first.class).to eq Marver::TextObject
+    expect(comic.text_objects.first.type).to eq "issue_solicit_text"
+    expect(comic.text_objects.first.language).to eq "en-us"
+    expect(comic.text_objects.first.text).to eq "And there came an Age Of X, an age unlike any other, where there were no X-Men…mutants were hated and feared. In that age, the remaining mutants created a stronghold, a last bastion for their dying race: Fortress X. And in that Age Of X, when humanity vowed to see Fortress X destroyed, a team of heroes and heroines found themselves united against this terrible mutant threat.  This is their epoch!"
+  end
+
+  it '#urls - A set of public web site URLs for the resource.' do
+    expect(comic.urls.class).to eq Array
+    expect(comic.urls.first.class).to eq Marver::Url
+    expect(comic.urls.first.type).to eq "detail"
+    expect(comic.urls.first.url).to eq "http://marvel.com/comics/issue/38524/age_of_x_universe_2011_1?utm_campaign=apiRef&utm_source=f302f582215c3deedff86e8015f853c7"
+  end
+
+  it '#series - A summary representation of the series to which this comic belongs.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.series.class).to eq Array
+    expect(comic.series.first.class).to eq Marver::SerieSummary
+    expect(comic.series.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/series/13896?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+    expect(comic.series.first.name).to eq "Age of X: Universe (2011)"
+  end
+
+  it '#images - A list of promotional images associated with this comic.' do
+    expect(comic.images.class).to eq Array
+    expect(comic.images.first.full_path).to eq "http://i.annihil.us/u/prod/marvel/i/mg/7/70/4f57719ff38c5.jpg"
+    expect(comic.images.last.full_path).to eq "http://i.annihil.us/u/prod/marvel/i/mg/b/b0/4d6d3430cd3bb.jpg"
+  end
+
+  it '#prices - A list of prices for this comic.' do
+    expect(comic.prices.class).to eq Array
+    expect(comic.prices.first.class).to eq Marver::Price
+    expect(comic.prices.first.type).to eq "printPrice"
+    expect(comic.prices.first.price).to eq 3.99
+  end
+
+  it '#characters - A resource list containing the characters which appear in this comic.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.characters.class).to eq Array
+    expect(comic.characters.first.class).to eq Marver::CharacterSummary
+    expect(comic.characters.first.name).to eq "Captain America"
+    expect(comic.characters.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/characters/1009220?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+  end
+
+  it '#variants - A list of variant issues for this comic (includes the "original" issue if the current issue is a variant).'
+  it '#collections - A list of collections which include this comic (will generally be empty if the comic\'s format is a collection).'
+  it '#collected_issues - A list of issues collected in this comic (will generally be empty for periodical formats such as "comic" or "magazine").'
+
+  it '#creators - A resource list containing the creators associated with this comic.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.creators.class).to eq Array
+    expect(comic.creators.first.class).to eq Marver::CreatorSummary
+    expect(comic.creators.first.name).to eq "Simone Bianchi"
+    expect(comic.creators.first.role).to eq "penciller (cover)"
+    expect(comic.creators.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/creators/648?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+  end
+
+  it '#stories - A resource list containing the stories which appear in this comic.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.stories.class).to eq Array
+    expect(comic.stories.first.class).to eq Marver::StorySummary
+    expect(comic.stories.first.name).to eq "Age of X: Avengers (2011) #1"
+    expect(comic.stories.first.type).to eq "cover"
+    expect(comic.stories.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/stories/90010?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+  end
+
+  it '#events - A resource list containing the events in which this comic appears.' do
+    Time.stub_chain(:now, :to_i, :to_s).and_return "1"
+    expect(comic.events.class).to eq Array
+    expect(comic.events.first.class).to eq Marver::EventSummary
+    expect(comic.events.first.name).to eq "Age of X"
+    expect(comic.events.first.type).to eq nil
+    expect(comic.events.first.resource_uri).to eq "http://gateway.marvel.com/v1/public/events/303?ts=1&apikey=priv_key&hash=668dea517c974c12d8d0193cf2d8f7f7"
+  end
+end