marvell 0.1.0

data/spec/lib/character_spec.rb

@@ -0,0 +1,55 @@
+require_relative "../spec_helper"
+
+describe "a character entity" do
+  before { VCR.insert_cassette 'character', record: :new_episodes }
+  after { VCR.eject_cassette }
+
+  describe "parsing the json argument" do
+    let(:client) { Marvell::Client.new(public_key: "07e4dc912806b1c5d1e51687095bca09", private_key: 'a97d276fe66678f07ec9150e3012d41160937b85')}
+    let(:character){ client.character(id: 1009521) }
+
+    it "returns a hash result set" do
+      character.result.must_be_instance_of Hash
+    end
+
+    it "returns a name" do
+      character.name.must_equal " Hank Pym"
+    end
+
+    it "returns a description" do
+      character.description.must_equal ""
+    end
+
+    it "returns a modified date" do
+      character.modified.must_equal "1969-12-31T19:00:00-0500"
+    end
+
+    it "returns a thumbnail object" do
+      character.thumbnail.must_be_instance_of Hash
+    end
+
+    it "returns a resource URI" do
+      character.resourceURI.must_equal "http://gateway.marvel.com/v1/public/characters/1009521"
+    end
+
+    it "returns a comics object" do
+      character.comics.must_be_instance_of Hash
+    end
+
+    it "returns a series object" do
+      character.series.must_be_instance_of Hash
+    end
+
+    it "returns a stories object" do
+      character.stories.must_be_instance_of Hash
+    end
+
+    it "returns an events object" do
+      character.events.must_be_instance_of Hash
+    end
+
+    it "returns a set of public urls for the resource" do
+      character.urls.must_be_instance_of Array
+    end
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,178 @@
+require_relative "../spec_helper"
+
+describe Marvell::Client do
+  let(:client) { Marvell::Client.new(public_key: "07e4dc912806b1c5d1e51687095bca09", private_key: 'a97d276fe66678f07ec9150e3012d41160937b85')}
+
+  before { VCR.insert_cassette 'requests', record: :new_episodes }
+  after { VCR.eject_cassette }
+
+  describe "api functionality" do
+    it "uses the HTTParty library" do
+      Marvell::Client.must_include HTTParty
+    end
+
+    it "uses the correct base uri" do
+      Marvell::Client.base_uri.must_equal "http://gateway.marvel.com"
+    end
+  end
+
+  describe "#character" do
+
+    it "given an id, returns a Marvel::Character object" do
+      character = client.character(id: 1009521)
+      character.must_be_instance_of Marvell::Entity
+      character.name.must_equal " Hank Pym"
+    end
+  end
+
+  describe "#characters" do
+
+    it "returns an array of characters" do
+      characters = client.characters
+      characters.must_be_instance_of Array
+      characters.first.must_be_instance_of Marvell::Entity
+    end
+
+    describe "filtering the resultset" do
+
+      it "filters by limit" do
+        characters = client.characters(limit: 4)
+        characters.size.must_equal 4
+      end
+
+      it "filters by name" do
+        characters = client.characters(name: 'Spider-Man')
+        characters.first.name.must_equal "Spider-Man"
+      end
+    end
+
+    describe "second class resources" do
+      it "returns a set of characters which belong to a comic" do
+        characters = client.characters(comic_id: 36489)
+        characters.first.name.must_equal " Hank Pym"
+      end
+
+      it "returns a set of characters which belong to a story" do
+        characters = client.characters(story_id: 5621)
+        characters.first.name.must_equal " Hank Pym"
+      end
+
+      it "returns a set of characters which belong to a series" do
+        characters = client.characters(series_id: 20)
+        characters.first.name.must_equal "Ben Urich"
+      end
+
+      it "returns a set of characters which belong to an event" do
+        characters = client.characters(event_id: 318)
+        characters.first.name.must_equal " Hank Pym"
+      end
+    end
+  end
+
+  describe "#comic" do
+    it "given an id, returns a Marvel::Entity object" do
+      comic = client.comic(id: 41530)
+      comic.must_be_instance_of Marvell::Entity
+    end
+  end
+
+  describe "#comics" do
+    it "returns an array of comics" do
+      comics = client.comics
+      comics.must_be_instance_of Array
+      comics.first.must_be_instance_of Marvell::Entity
+    end
+
+    describe "filtering the resultset" do
+
+      it "filters by limit" do
+        comics = client.comics(limit: 4)
+        comics.size.must_equal 4
+      end
+
+      it "filters by format" do
+        comics = client.comics(format: 'digital comic')
+        comics.first.format.must_equal 'Digital Comic'
+      end
+    end
+  end
+
+  describe '#creator' do
+    it "given an id, returns a Marvel::Entity object" do
+      creator = client.creator(id: 546)
+      creator.must_be_instance_of Marvell::Entity
+    end
+  end
+
+  describe '#creators' do
+    it 'returns an array of creators' do
+      creators = client.creators
+      creators.must_be_instance_of Array
+      creators.first.must_be_instance_of Marvell::Entity
+    end
+
+    describe "filtering the resultset" do
+
+      it "filters by limit" do
+        creators = client.creators(limit: 4)
+        creators.size.must_equal 4
+      end
+
+      it "filters by first name" do
+        creators = client.creators(firstName: 'Brian')
+        creators.first.first_name.must_equal 'Brian'
+      end
+    end
+  end
+
+  describe "#story" do
+
+    it "given an id, returns a Marvel::Entity object" do
+      story = client.story(id: 3)
+      story.must_be_instance_of Marvell::Entity
+    end
+  end
+
+  describe "#stories" do
+
+    it "returns an array of stories" do
+      stories = client.stories
+      stories.must_be_instance_of Array
+      stories.first.must_be_instance_of Marvell::Entity
+    end
+
+    describe "filtering the resultset" do
+
+      it "filters by limit" do
+        stories = client.stories(limit: 4)
+        stories.size.must_equal 4
+      end
+    end
+  end
+
+  describe "#serie" do
+
+    it "given an id, returns a Marvel::Entity object" do
+      serie = client.serie(id: 3)
+      serie.must_be_instance_of Marvell::Entity
+    end
+  end
+
+  describe "#series" do
+
+    it "returns an array of series" do
+      series = client.series
+      series.must_be_instance_of Array
+      series.first.must_be_instance_of Marvell::Entity
+    end
+
+    describe "filtering the resultset" do
+
+      it "filters by limit" do
+        series = client.stories(limit: 4)
+        series.size.must_equal 4
+      end
+    end
+  end
+
+end

data/spec/lib/comic_spec.rb

@@ -0,0 +1,29 @@
+require_relative "../spec_helper"
+
+describe 'marvel comic entity' do
+  before { VCR.insert_cassette 'requests', record: :new_episodes }
+  after { VCR.eject_cassette }
+
+  let(:client) { Marvell::Client.new(public_key: "07e4dc912806b1c5d1e51687095bca09", private_key: 'a97d276fe66678f07ec9150e3012d41160937b85')}
+  let(:comic){ client.comic(id: 41530) }
+
+  it "returns a hash result set" do
+    comic.result.must_be_instance_of Hash
+  end
+
+  it "returns a title" do
+    comic.title.must_equal "Ant-Man: So (Trade Paperback)"
+  end
+
+  it "returns a description" do
+    comic.description.must_include "It's the origin of the original Avenger"
+  end
+
+  it "returns the date of last modification" do
+    comic.modified.must_equal "2012-09-25T18:05:58-0400"
+  end
+
+  it "returns the isbn number" do
+    comic.isbn.must_equal "978-0-7851-6390-9"
+  end
+end

data/spec/lib/entity_spec.rb

@@ -0,0 +1,18 @@
+require_relative "../spec_helper"
+
+describe Marvell::Entity do
+  let(:client) { Marvell::Client.new(public_key: "07e4dc912806b1c5d1e51687095bca09", private_key: 'a97d276fe66678f07ec9150e3012d41160937b85')}
+
+  before { VCR.insert_cassette 'character', record: :new_episodes }
+  after { VCR.eject_cassette }
+  
+  it "finds an entity attribute if one exists" do
+    character = client.character(id: 1009521)
+    proc {character.name}.must_be_silent
+  end
+
+  it "throws an error if the given attribute doesn't exist" do
+    character = client.character(id: 1009521)
+    proc{character.some_random_attribute}.must_raise NoMethodError
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require_relative "../lib/marvell"
+
+require 'minitest/autorun'
+require "webmock/minitest"
+require "vcr"
+
+#WebMock.allow_net_connect!
+
+#VCR config
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/dish_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: marvell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oz Huner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Marvel Comics API Wrapper
+email:
+- oguzcanhuner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/marvell.rb
+- lib/marvell/entity.rb
+- lib/marvell/json_parser.rb
+- lib/marvell/client.rb
+- spec/fixtures/dish_cassettes/character.yml
+- spec/fixtures/dish_cassettes/requests.yml
+- spec/lib/comic_spec.rb
+- spec/lib/entity_spec.rb
+- spec/lib/character_spec.rb
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+- Rakefile
+- Gemfile
+homepage: http://www.github.com/oguzcanhuner/marvell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby Marvel Comics API Wrapper
+test_files:
+- spec/fixtures/dish_cassettes/character.yml
+- spec/fixtures/dish_cassettes/requests.yml
+- spec/lib/comic_spec.rb
+- spec/lib/entity_spec.rb
+- spec/lib/character_spec.rb
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb