starwars 0.0.1

data/lib/starwars/specie.rb

@@ -0,0 +1,38 @@
+module Starwars
+  #
+  # A Film resource is an single film.
+  #
+  class Specie < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'species'
+
+    include Starwars::Fetcher
+
+    # @return [String]
+    property :name
+    property :classification
+    property :designation
+    property :skin_colors
+    property :hair_colors
+    property :eye_colors
+    property :language
+    property :url
+
+    # @return [Starwars::Planet]
+    property :homeworld, class: Starwars::Planet, deserialize: ->(_, fragment, _) { Planet.new(url: fragment) }
+
+    # @return [Integer]
+    property :average_height, type: Integer
+    property :average_lifespan, type: Integer
+
+    # @return [Time]
+    property :created, type: Time
+    property :edited, type: Time
+
+    # @return [Array]
+    collection :people, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+  end
+end

data/lib/starwars/starship.rb

@@ -0,0 +1,40 @@
+module Starwars
+  #
+  # A Film resource is an single film.
+  #
+  class Starship < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'starships'
+
+    include Starwars::Fetcher
+
+    # @return [String]
+    property :name
+    property :model
+    property :manufacturer
+    property :starship_class
+    property :consumables
+
+    # @return [Integer]
+    property :cost_in_credits, type: Integer
+    property :length, type: Integer
+    property :max_atmosphering_speed, type: Integer
+    property :crew, type: Integer
+    property :passengers, type: Integer
+    property :cargo_capacity, type: Integer
+    # property :MGLT, as: :mglt
+
+    # @return [Float]
+    property :hyperdrive_rating, type: Float
+
+    # @return [Time]
+    property :created, type: Time
+    property :edited, type: Time
+
+    # @return [Array]
+    collection :pilots, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+  end
+end

data/lib/starwars/vehicle.rb

@@ -0,0 +1,38 @@
+module Starwars
+  #
+  # A Film resource is an single film.
+  #
+  class Vehicle < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'vehicles'
+
+    include Starwars::Fetcher
+
+    # @return [String]
+    property :name
+    property :model
+    property :manufacturer
+    property :consumables
+    property :vehicle_class
+    property :cost_in_credits
+
+    # @return [Integer]
+    property :max_atmosphering_speed, type: Integer
+    property :crew, type: Integer
+    property :passengers, type: Integer
+    property :cargo_capacity, type: Integer
+
+    # @return [Float]
+    property :length, type: Float
+
+    # @return [Time]
+    property :created, type: Time
+    property :edited, type: Time
+
+    # @return [Array]
+    collection :pilots, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+  end
+end

data/lib/starwars/version.rb

@@ -0,0 +1,4 @@
+# Define the gem version
+module Starwars
+  VERSION = '0.0.1'
+end

data/spec/fixtures/films_1.json

@@ -0,0 +1 @@
+{"title":"A New Hope","episode_id":4,"opening_crawl":"It is a period of civil war.\r\nRebel spaceships, striking\r\nfrom a hidden base, have won\r\ntheir first victory against\r\nthe evil Galactic Empire.\r\n\r\nDuring the battle, Rebel\r\nspies managed to steal secret\r\nplans to the Empire's\r\nultimate weapon, the DEATH\r\nSTAR, an armored space\r\nstation with enough power\r\nto destroy an entire planet.\r\n\r\nPursued by the Empire's\r\nsinister agents, Princess\r\nLeia races home aboard her\r\nstarship, custodian of the\r\nstolen plans that can save her\r\npeople and restore\r\nfreedom to the galaxy....","director":"George Lucas","producer":"Gary Kurtz, Rick McCallum","characters":["http://swapi.co/api/people/1/","http://swapi.co/api/people/2/","http://swapi.co/api/people/3/","http://swapi.co/api/people/4/","http://swapi.co/api/people/5/","http://swapi.co/api/people/6/","http://swapi.co/api/people/7/","http://swapi.co/api/people/8/","http://swapi.co/api/people/9/","http://swapi.co/api/people/10/","http://swapi.co/api/people/12/","http://swapi.co/api/people/13/","http://swapi.co/api/people/14/","http://swapi.co/api/people/15/","http://swapi.co/api/people/16/","http://swapi.co/api/people/18/","http://swapi.co/api/people/19/","http://swapi.co/api/people/81/"],"planets":["http://swapi.co/api/planets/2/","http://swapi.co/api/planets/3/","http://swapi.co/api/planets/1/"],"starships":["http://swapi.co/api/starships/2/","http://swapi.co/api/starships/3/","http://swapi.co/api/starships/5/","http://swapi.co/api/starships/9/","http://swapi.co/api/starships/10/","http://swapi.co/api/starships/11/","http://swapi.co/api/starships/12/","http://swapi.co/api/starships/13/"],"vehicles":["http://swapi.co/api/vehicles/4/","http://swapi.co/api/vehicles/6/","http://swapi.co/api/vehicles/7/","http://swapi.co/api/vehicles/8/"],"species":["http://swapi.co/api/species/1/","http://swapi.co/api/species/2/","http://swapi.co/api/species/3/","http://swapi.co/api/species/4/","http://swapi.co/api/species/5/"],"created":"2014-12-10T14:23:31.880000Z","edited":"2014-12-20T19:49:45.256000Z","url":"http://swapi.co/api/films/1/"}

data/spec/fixtures/people_1.json

@@ -0,0 +1 @@
+{"name":"Luke Skywalker","height":"172","mass":"77","hair_color":"blond","skin_color":"fair","eye_color":"blue","birth_year":"19BBY","gender":"male","homeworld":"http://swapi.co/api/planets/1/","films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/2/","http://swapi.co/api/films/3/","http://swapi.co/api/films/6/"],"species":[],"vehicles":["http://swapi.co/api/vehicles/14/","http://swapi.co/api/vehicles/30/"],"starships":["http://swapi.co/api/starships/12/","http://swapi.co/api/starships/22/"],"created":"2014-12-09T13:50:51.644000Z","edited":"2014-12-20T21:17:56.891000Z","url":"http://swapi.co/api/people/1/"}

data/spec/fixtures/people_2.json

@@ -0,0 +1 @@
+{"name":"C-3PO","height":"167","mass":"75","hair_color":"n/a","skin_color":"gold","eye_color":"yellow","birth_year":"112BBY","gender":"n/a","homeworld":"http://swapi.co/api/planets/1/","films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/2/","http://swapi.co/api/films/3/","http://swapi.co/api/films/4/","http://swapi.co/api/films/5/","http://swapi.co/api/films/6/"],"species":["http://swapi.co/api/species/2/"],"vehicles":[],"starships":[],"created":"2014-12-10T15:10:51.357000Z","edited":"2014-12-20T21:17:50.309000Z","url":"http://swapi.co/api/people/2/"}

data/spec/fixtures/planets_1.json

@@ -0,0 +1 @@
+{"name":"Tatooine","rotation_period":"23","orbital_period":"304","diameter":"10465","climate":"arid","gravity":"1 standard","terrain":"desert","surface_water":"1","population":"200000","residents":["http://swapi.co/api/people/1/","http://swapi.co/api/people/2/","http://swapi.co/api/people/4/","http://swapi.co/api/people/6/","http://swapi.co/api/people/7/","http://swapi.co/api/people/8/","http://swapi.co/api/people/9/","http://swapi.co/api/people/11/","http://swapi.co/api/people/43/","http://swapi.co/api/people/62/"],"films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/3/","http://swapi.co/api/films/4/","http://swapi.co/api/films/5/","http://swapi.co/api/films/6/"],"created":"2014-12-09T13:50:49.641000Z","edited":"2014-12-21T20:48:04.175778Z","url":"http://swapi.co/api/planets/1/"}

data/spec/fixtures/species_1.json

@@ -0,0 +1 @@
+{"name":"Human","classification":"mammal","designation":"sentient","average_height":"180","skin_colors":"caucasian, black, asian, hispanic","hair_colors":"blonde, brown, black, red","eye_colors":"brown, blue, green, hazel, grey, amber","average_lifespan":"120","homeworld":"http://swapi.co/api/planets/9/","language":"Galactic Basic","people":["http://swapi.co/api/people/66/","http://swapi.co/api/people/67/","http://swapi.co/api/people/68/","http://swapi.co/api/people/74/"],"films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/2/","http://swapi.co/api/films/3/","http://swapi.co/api/films/4/","http://swapi.co/api/films/5/","http://swapi.co/api/films/6/"],"created":"2014-12-10T13:52:11.567000Z","edited":"2014-12-20T21:36:42.136000Z","url":"http://swapi.co/api/species/1/"}

data/spec/fixtures/starships_10.json

@@ -0,0 +1 @@
+{"name":"Millennium Falcon","model":"YT-1300 light freighter","manufacturer":"Corellian Engineering Corporation","cost_in_credits":"100000","length":"34.37","max_atmosphering_speed":"1050","crew":"4","passengers":"6","cargo_capacity":"100000","consumables":"2 months","hyperdrive_rating":"0.5","MGLT":"75","starship_class":"Light freighter","pilots":["http://swapi.co/api/people/13/","http://swapi.co/api/people/14/","http://swapi.co/api/people/25/","http://swapi.co/api/people/31/"],"films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/2/","http://swapi.co/api/films/3/"],"created":"2014-12-10T16:59:45.094000Z","edited":"2014-12-22T17:35:44.464156Z","url":"http://swapi.co/api/starships/10/"}

data/spec/fixtures/starships_5.json

@@ -0,0 +1 @@
+{"name":"Sentinel-class landing craft","model":"Sentinel-class landing craft","manufacturer":"Sienar Fleet Systems, Cyngus Spaceworks","cost_in_credits":"240000","length":"38","max_atmosphering_speed":"1000","crew":"5","passengers":"75","cargo_capacity":"180000","consumables":"1 month","hyperdrive_rating":"1.0","MGLT":"70","starship_class":"landing craft","pilots":[],"films":["http://swapi.co/api/films/1/"],"created":"2014-12-10T15:48:00.586000Z","edited":"2014-12-22T17:35:44.431407Z","url":"http://swapi.co/api/starships/5/"}

data/spec/fixtures/vehicles_14.json

@@ -0,0 +1 @@
+{"name":"Snowspeeder","model":"t-47 airspeeder","manufacturer":"Incom corporation","cost_in_credits":"unknown","length":"4.5","max_atmosphering_speed":"650","crew":"2","passengers":"0","cargo_capacity":"10","consumables":"none","vehicle_class":"airspeeder","pilots":["http://swapi.co/api/people/1/","http://swapi.co/api/people/18/"],"films":["http://swapi.co/api/films/2/"],"created":"2014-12-15T12:22:12Z","edited":"2014-12-22T18:21:15.623033Z","url":"http://swapi.co/api/vehicles/14/"}

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.start do
+  add_filter '/spec/'
+  minimum_coverage(90)
+end
+
+require 'starwars'
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow: 'coveralls.io')
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+end
+
+def a_get(path)
+  a_request(:get, Starwars::Base::BASE_URL + path)
+end
+
+def stub_get(path)
+  stub_request(:get, Starwars::Base::BASE_URL + path)
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/starwars/film_spec.rb

@@ -0,0 +1,132 @@
+describe Starwars::Film do
+  before do
+    stub_get('/films/1/').to_return(body: fixture('films_1.json'), headers: { content_type: 'application/json; charset=utf-8' })
+  end
+  describe '#==' do
+    it 'returns true when objects IDs and URLS are the same' do
+      planet = Starwars::Film.new(id: 1, title: 'foo')
+      other = Starwars::Film.new(id: 1, title: 'bar')
+      expect(planet == other).to be true
+    end
+
+    it 'returns false when objects IDs are different' do
+      planet = Starwars::Film.new(id: 1)
+      other = Starwars::Film.new(id: 2)
+      expect(planet == other).to be false
+    end
+  end
+
+  describe 'getters' do
+    subject(:film) { Starwars::Film.fetch(1) }
+    describe '#created' do
+      it 'returns a Time when updated is set' do
+        expect(film.created).to be_a Time
+      end
+    end
+    describe '#edited' do
+      it 'returns a Time when edited is set' do
+        expect(film.edited).to be_a Time
+      end
+    end
+    describe '#title' do
+      it 'should have the correct value' do
+        expect(film.title).to eq 'A New Hope'
+      end
+    end
+    describe '#opening_crawl' do
+      it 'should have the correct value' do
+        expect(film.opening_crawl.include?('It is a period of civil war')).to eq true
+      end
+    end
+    describe '#director' do
+      it 'should have the correct value' do
+        expect(film.director).to eq 'George Lucas'
+      end
+    end
+    describe '#producer' do
+      it 'should have the correct value' do
+        expect(film.producer).to eq 'Gary Kurtz, Rick McCallum'
+      end
+    end
+    describe '#url' do
+      it 'should have the correct value' do
+        expect(film.url).to eq 'http://swapi.co/api/films/1/'
+      end
+    end
+
+    describe '#episode_id' do
+      it 'should be an integer' do
+        expect(film.episode_id).to be_an Integer
+      end
+      it 'should should have the correct value' do
+        expect(film.episode_id).to eq 4
+      end
+    end
+
+    describe '#starships' do
+      it 'should return an Array' do
+        expect(film.starships).to be_an Array
+      end
+      it 'should should the correct number of starships' do
+        expect(film.starships.size).to eq 8
+      end
+      it 'should contain an array of starships correctly parsed' do
+        starship = film.starships.first
+        expect(starship).to be_a Starwars::Starship
+        expect(starship.url).to eq 'http://swapi.co/api/starships/2/'
+      end
+    end
+    describe '#vehicles' do
+      it 'should return an Array' do
+        expect(film.vehicles).to be_an Array
+      end
+      it 'should should the correct number of vehicles' do
+        expect(film.vehicles.size).to eq 4
+      end
+      it 'should contain an array of films correctly parsed' do
+        vehicle = film.vehicles.first
+        expect(vehicle).to be_a Starwars::Vehicle
+        expect(vehicle.url).to eq 'http://swapi.co/api/vehicles/4/'
+      end
+    end
+    describe '#species' do
+      it 'should return an Array' do
+        expect(film.species).to be_an Array
+      end
+      it 'should should the correct number of species' do
+        expect(film.species.size).to eq 5
+      end
+      it 'should contain an array of films correctly parsed' do
+        specie = film.species.first
+        expect(specie).to be_a Starwars::Specie
+        expect(specie.url).to eq 'http://swapi.co/api/species/1/'
+      end
+    end
+    describe '#characters' do
+      it 'should return an Array' do
+        expect(film.characters).to be_an Array
+      end
+      it 'should should the correct number of characters' do
+        expect(film.characters.size).to eq 18
+      end
+      it 'should contain an array of characters correctly parsed' do
+        person = film.characters.first
+        expect(person).to be_a Starwars::Person
+        expect(person.url).to eq 'http://swapi.co/api/people/1/'
+      end
+    end
+    describe '#planets' do
+      it 'should return an Array' do
+        expect(film.planets).to be_an Array
+      end
+      it 'should should the correct number of planets' do
+        expect(film.planets.size).to eq 3
+      end
+      it 'should contain an array of planets correctly parsed' do
+        planet = film.planets.first
+        expect(planet).to be_a Starwars::Planet
+        expect(planet.url).to eq 'http://swapi.co/api/planets/2/'
+      end
+    end
+  end
+end

data/spec/starwars/person_spec.rb

@@ -0,0 +1,150 @@
+describe Starwars::Person do
+  before do
+    stub_get('/people/2/').to_return(body: fixture('people_2.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    stub_get('/people/1/').to_return(body: fixture('people_1.json'), headers: { content_type: 'application/json; charset=utf-8' })
+  end
+
+  describe '#==' do
+    it 'returns true when objects IDs and URLS are the same' do
+      planet = Starwars::Person.new(id: 1, name: 'foo')
+      other = Starwars::Person.new(id: 1, name: 'bar')
+      expect(planet == other).to be true
+    end
+
+    it 'returns false when objects IDs are different' do
+      planet = Starwars::Person.new(id: 1)
+      other = Starwars::Person.new(id: 2)
+      expect(planet == other).to be false
+    end
+  end
+
+  describe 'getters' do
+    subject(:person_2) { Starwars::Person.fetch(2) }
+    subject(:person_1) { Starwars::Person.fetch(1) }
+    describe '#created' do
+      it 'returns a Time when updated is set' do
+        expect(person_2.created).to be_a Time
+      end
+    end
+    describe '#edited' do
+      it 'returns a Time when edited is set' do
+        expect(person_2.edited).to be_a Time
+      end
+    end
+    describe '#name' do
+      it 'should have the correct value' do
+        expect(person_2.name).to eq 'C-3PO'
+      end
+    end
+    describe '#skin_color' do
+      it 'should have the correct value' do
+        expect(person_2.skin_color).to eq 'gold'
+      end
+    end
+    describe '#eye_color' do
+      it 'should have the correct value' do
+        expect(person_2.eye_color).to eq 'yellow'
+      end
+    end
+    describe '#hair_color' do
+      it 'should have the correct value' do
+        expect(person_2.hair_color).to eq 'n/a'
+      end
+    end
+    describe '#birth_year' do
+      it 'should have the correct value' do
+        expect(person_2.birth_year).to eq '112BBY'
+      end
+    end
+    describe '#gender' do
+      it 'should have the correct value' do
+        expect(person_2.gender).to eq 'n/a'
+      end
+    end
+    describe '#url' do
+      it 'should have the correct value' do
+        expect(person_2.url).to eq 'http://swapi.co/api/people/2/'
+      end
+    end
+
+    describe '#height' do
+      it 'should be an integer' do
+        expect(person_2.height).to be_an Integer
+      end
+
+      it 'should should have the correct value' do
+        expect(person_2.height).to eq 167
+      end
+    end
+    describe '#mass' do
+      it 'should be an integer' do
+        expect(person_2.mass).to be_an Integer
+      end
+
+      it 'should should have the correct value' do
+        expect(person_2.mass).to eq 75
+      end
+    end
+    describe '#homeworld' do
+      it 'should return a Starwars::Planet object' do
+        expect(person_2.homeworld).to be_an Starwars::Planet
+      end
+      it 'should contains the correct resouce url' do
+        expect(person_2.homeworld.url).to eq 'http://swapi.co/api/planets/1/'
+      end
+    end
+
+    describe '#films' do
+      it 'should return an Array' do
+        expect(person_2.films).to be_an Array
+      end
+      it 'should should the correct number of residents' do
+        expect(person_2.films.size).to eq 6
+      end
+      it 'should contain an array of films correctly parsed' do
+        film = person_2.films.first
+        expect(film).to be_a Starwars::Film
+        expect(film.url).to eq 'http://swapi.co/api/films/1/'
+      end
+    end
+    describe '#species' do
+      it 'should return an Array' do
+        expect(person_2.species).to be_an Array
+      end
+      it 'should should the correct number of residents' do
+        expect(person_2.species.size).to eq 1
+      end
+      it 'should contain an array of films correctly parsed' do
+        specie = person_2.species.first
+        expect(specie).to be_a Starwars::Specie
+        expect(specie.url).to eq 'http://swapi.co/api/species/2/'
+      end
+    end
+    describe '#vehicles' do
+      it 'should return an Array' do
+        expect(person_1.vehicles).to be_an Array
+      end
+      it 'should should the correct number of residents' do
+        expect(person_1.vehicles.size).to eq 2
+      end
+      it 'should contain an array of films correctly parsed' do
+        vehicle = person_1.vehicles.first
+        expect(vehicle).to be_a Starwars::Vehicle
+        expect(vehicle.url).to eq 'http://swapi.co/api/vehicles/14/'
+      end
+    end
+    describe '#starships' do
+      it 'should return an Array' do
+        expect(person_1.starships).to be_an Array
+      end
+      it 'should should the correct number of residents' do
+        expect(person_1.starships.size).to eq 2
+      end
+      it 'should contain an array of films correctly parsed' do
+        starship = person_1.starships.first
+        expect(starship).to be_a Starwars::Starship
+        expect(starship.url).to eq 'http://swapi.co/api/starships/12/'
+      end
+    end
+  end
+end