starwars 0.0.1 → 0.0.2

data/lib/starwars/{specie.rb → resources/specie.rb}

@@ -1,6 +1,6 @@
 module Starwars
   #
-  # A Film resource is an single film.
+  # A Species resource is a type of person or character within the Star Wars Universe.
   #
   class Specie < Starwars::Base
     #
@@ -8,9 +8,6 @@ module Starwars
     #
     RESOURCE_NAME = 'species'
 
-    include Starwars::Fetcher
-
-    # @return [String]
     property :name
     property :classification
     property :designation
@@ -18,20 +15,9 @@ module Starwars
     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

data/lib/starwars/resources/starship.rb

@@ -0,0 +1,115 @@
+module Starwars
+  #
+  # A Starship resource is a single transport craft that has hyperdrive capability.
+  #
+  class Starship < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'starships'
+
+    # The name of this starship
+    #
+    # @return [String]
+    #
+    # @note The common name, such as "Death Star".
+    #
+    # @example
+    #   starship.name #=> 'Death Star'
+    # @api public
+    property :name
+
+    # The model or official name of this starship
+    # @return [String]
+    #
+    # @example
+    #   starship.model #=> 'DS-1 Orbital Battle Station'
+    # @api public
+    property :model
+
+    # The manufacturer of the starship
+    # @return [String]
+    # @example
+    #   starship.manufacturer #=> 'Imperial Department of Military Research'
+    # @api public
+    property :manufacturer
+
+    # The class of this starship
+    # @return [String]
+    # @example
+    #   starship.starship_class #=> 'Starfighter'
+    # @api public
+    property :starship_class
+
+    # consumables
+    # @return [String]
+    # @example
+    #   starship.consumables
+    # @api public
+    property :consumables
+
+    # The cost of this new starship, in Galactic Credits
+    # @return [String]
+    # @example
+    #   starship.cost_in_credits
+    # @api public
+    property :cost_in_credits, type: Integer
+
+    # The length of this starship in meters
+    # @return [String]
+    # @example
+    #   starship.length
+    # @api public
+    property :length, type: Integer
+
+    # The maximum speed of this starship in atmosphere
+    # @return [Integer]
+    # @example
+    #   starship.max_atmosphering_speed
+    # @api public
+    property :max_atmosphering_speed, type: Integer
+
+    # The number of personnel needed to run or pilot this starship
+    # @return [Integer]
+    # @example
+    #   starship.crew
+    # @api public
+    property :crew, type: Integer
+
+    # The number of non-essential people this starship can transport
+    # @return [Integer]
+    # @example
+    #   starship.passengers
+    # @api public
+    property :passengers, type: Integer
+
+    # The maximum number of kilograms that this starship can transport
+    # @return [Integer]
+    # @example
+    #   starship.cargo_capacity
+    # @api public
+    property :cargo_capacity, type: Integer
+    # property :MGLT, as: :mglt
+
+    # The class of this starships hyperdrive
+    # @return [Float]
+    # @example
+    #   starship.hyperdrive_rating
+    # @api public
+    property :hyperdrive_rating, type: Float
+
+    # List of pilots
+    # @return [Array<Pilot>]
+    # @example
+    #   starship.pilots
+    # @api public
+    collection :pilots, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+
+    # List of films
+    # @return [Array<Film>]
+    # @example
+    #   starship.films
+    # @api public
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+  end
+end

data/lib/starwars/resources/vehicle.rb

@@ -0,0 +1,106 @@
+module Starwars
+  #
+  # A Vehicle resource is a single transport craft that does not have hyperdrive capability.
+  #
+  class Vehicle < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'vehicles'
+
+    # The name of this vehicle
+    #
+    # @return [String]
+    #
+    # @note The common name, such as "Sand Crawler" or "Speeder bike"
+    #
+    # @example
+    #   vehicle.name #=> 'Snowspeeder'
+    # @api public
+    property :name
+
+    # The model or official name of this vehicle
+    # @return [String]
+    # @example
+    #   vehicle.model #=> 't-47 airspeeder'
+    # @api public
+    property :model
+
+    # The manufacturer of this vehicle. Comma-seperated if more than one
+    # @return [String]
+    # @example
+    #   vehicle.manufacturer #=> 'Incom corporation'
+    # @api public
+    property :manufacturer
+
+    # consumables
+    # @return [String]
+    # @example
+    #   vehicle.consumables
+    # @api public
+    property :consumables
+
+    # The class of this vehicle, such as "Wheeled" or "Repulsorcraft"
+    # @return [String]
+    # @example
+    #   vehicle.vehicle_class #=> 'airspeeder'
+    # @api public
+    property :vehicle_class
+
+    # The cost of this vehicle new, in Galactic Credits
+    # @return [String]
+    # @example
+    #   vehicle.cost_in_credits
+    # @api public
+    property :cost_in_credits
+
+    # The maximum speed of this vehicle in atmosphere
+    # @return [Integer]
+    # @example
+    #   vehicle.max_atmosphering_speed
+    # @api public
+    property :max_atmosphering_speed, type: Integer
+
+    # The number of personnel needed to run or pilot this vehicle
+    # @return [Integer]
+    # @example
+    #   vehicle.crew
+    # @api public
+    property :crew, type: Integer
+
+    # The number of non-essential people this vehicle can transport
+    # @return [Integer]
+    # @example
+    #   vehicle.passengers
+    # @api public
+    property :passengers, type: Integer
+
+    # The maximum number of kilograms that this vehicle can transport
+    # @return [Integer]
+    # @example
+    #   vehicle.cargo_capacity
+    # @api public
+    property :cargo_capacity, type: Integer
+
+    # The length of this vehicle in meters
+    # @return [Float]
+    # @example
+    #   vehicle.length
+    # @api public
+    property :length, type: Float
+
+    # List of pilots
+    # @return [Array<Pilot>]
+    # @example
+    #   vehicle.pilots
+    # @api public
+    collection :pilots, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+
+    # List of films
+    # @return [Array<Film>]
+    # @example
+    #   vehicle.films
+    # @api public
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+  end
+end

data/lib/starwars/version.rb

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

data/spec/fixtures/404.json

@@ -0,0 +1 @@
+{"detail":"Not found"}

data/spec/fixtures/planets_page1.json

@@ -0,0 +1 @@
+{"count":60,"next":"http://swapi.co/api/planets/?page=2","previous":null,"results":[{"name":"Alderaan","rotation_period":"24","orbital_period":"364","diameter":"12500","climate":"temperate","gravity":"1 standard","terrain":"grasslands, mountains","surface_water":"40","population":"2000000000","residents":["http://swapi.co/api/people/5/","http://swapi.co/api/people/68/","http://swapi.co/api/people/81/"],"films":["http://swapi.co/api/films/1/","http://swapi.co/api/films/6/"],"created":"2014-12-10T11:35:48.479000Z","edited":"2014-12-20T20:58:18.420000Z","url":"http://swapi.co/api/planets/2/"},{"name":"Yavin IV","rotation_period":"24","orbital_period":"4818","diameter":"10200","climate":"temperate, tropical","gravity":"1 standard","terrain":"jungle, rainforests","surface_water":"8","population":"1000","residents":[],"films":["http://swapi.co/api/films/1/"],"created":"2014-12-10T11:37:19.144000Z","edited":"2014-12-20T20:58:18.421000Z","url":"http://swapi.co/api/planets/3/"},{"name":"Hoth","rotation_period":"23","orbital_period":"549","diameter":"7200","climate":"frozen","gravity":"1.1 standard","terrain":"tundra, ice caves, mountain ranges","surface_water":"100","population":"unknown","residents":[],"films":["http://swapi.co/api/films/2/"],"created":"2014-12-10T11:39:13.934000Z","edited":"2014-12-20T20:58:18.423000Z","url":"http://swapi.co/api/planets/4/"},{"name":"Dagobah","rotation_period":"23","orbital_period":"341","diameter":"8900","climate":"murky","gravity":"N/A","terrain":"swamp, jungles","surface_water":"8","population":"unknown","residents":[],"films":["http://swapi.co/api/films/2/","http://swapi.co/api/films/3/","http://swapi.co/api/films/6/"],"created":"2014-12-10T11:42:22.590000Z","edited":"2014-12-20T20:58:18.425000Z","url":"http://swapi.co/api/planets/5/"},{"name":"Bespin","rotation_period":"12","orbital_period":"5110","diameter":"118000","climate":"temperate","gravity":"1.5 (surface), 1 standard (Cloud City)","terrain":"gas giant","surface_water":"0","population":"6000000","residents":["http://swapi.co/api/people/26/"],"films":["http://swapi.co/api/films/2/"],"created":"2014-12-10T11:43:55.240000Z","edited":"2014-12-20T20:58:18.427000Z","url":"http://swapi.co/api/planets/6/"},{"name":"Endor","rotation_period":"18","orbital_period":"402","diameter":"4900","climate":"temperate","gravity":"0.85 standard","terrain":"forests, mountains, lakes","surface_water":"8","population":"30000000","residents":["http://swapi.co/api/people/30/"],"films":["http://swapi.co/api/films/3/"],"created":"2014-12-10T11:50:29.349000Z","edited":"2014-12-20T20:58:18.429000Z","url":"http://swapi.co/api/planets/7/"},{"name":"Naboo","rotation_period":"26","orbital_period":"312","diameter":"12120","climate":"temperate","gravity":"1 standard","terrain":"grassy hills, swamps, forests, mountains","surface_water":"12","population":"4500000000","residents":["http://swapi.co/api/people/3/","http://swapi.co/api/people/21/","http://swapi.co/api/people/35/","http://swapi.co/api/people/36/","http://swapi.co/api/people/37/","http://swapi.co/api/people/38/","http://swapi.co/api/people/39/","http://swapi.co/api/people/42/","http://swapi.co/api/people/60/","http://swapi.co/api/people/61/","http://swapi.co/api/people/66/"],"films":["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-10T11:52:31.066000Z","edited":"2014-12-20T20:58:18.430000Z","url":"http://swapi.co/api/planets/8/"},{"name":"Coruscant","rotation_period":"24","orbital_period":"368","diameter":"12240","climate":"temperate","gravity":"1 standard","terrain":"cityscape, mountains","surface_water":"unknown","population":"1000000000000","residents":["http://swapi.co/api/people/34/","http://swapi.co/api/people/55/","http://swapi.co/api/people/74/"],"films":["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-10T11:54:13.921000Z","edited":"2014-12-20T20:58:18.432000Z","url":"http://swapi.co/api/planets/9/"},{"name":"Kamino","rotation_period":"27","orbital_period":"463","diameter":"19720","climate":"temperate","gravity":"1 standard","terrain":"ocean","surface_water":"100","population":"1000000000","residents":["http://swapi.co/api/people/22/","http://swapi.co/api/people/72/","http://swapi.co/api/people/73/"],"films":["http://swapi.co/api/films/5/"],"created":"2014-12-10T12:45:06.577000Z","edited":"2014-12-20T20:58:18.434000Z","url":"http://swapi.co/api/planets/10/"},{"name":"Geonosis","rotation_period":"30","orbital_period":"256","diameter":"11370","climate":"temperate, arid","gravity":"0.9 standard","terrain":"rock, desert, mountain, barren","surface_water":"5","population":"100000000000","residents":["http://swapi.co/api/people/63/"],"films":["http://swapi.co/api/films/5/"],"created":"2014-12-10T12:47:22.350000Z","edited":"2014-12-20T20:58:18.437000Z","url":"http://swapi.co/api/planets/11/"}]}

data/spec/fixtures/planets_page2.json

@@ -0,0 +1 @@
+{"count":60,"next":"http://swapi.co/api/planets/?page=3","previous":"http://swapi.co/api/planets/?page=1","results":[{"name":"Utapau","rotation_period":"27","orbital_period":"351","diameter":"12900","climate":"temperate, arid, windy","gravity":"1 standard","terrain":"scrublands, savanna, canyons, sinkholes","surface_water":"0.9","population":"95000000","residents":["http://swapi.co/api/people/83/"],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T12:49:01.491000Z","edited":"2014-12-20T20:58:18.439000Z","url":"http://swapi.co/api/planets/12/"},{"name":"Mustafar","rotation_period":"36","orbital_period":"412","diameter":"4200","climate":"hot","gravity":"1 standard","terrain":"volcanoes, lava rivers, mountains, caves","surface_water":"0","population":"20000","residents":[],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T12:50:16.526000Z","edited":"2014-12-20T20:58:18.440000Z","url":"http://swapi.co/api/planets/13/"},{"name":"Kashyyyk","rotation_period":"26","orbital_period":"381","diameter":"12765","climate":"tropical","gravity":"1 standard","terrain":"jungle, forests, lakes, rivers","surface_water":"60","population":"45000000","residents":["http://swapi.co/api/people/13/","http://swapi.co/api/people/80/"],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:32:00.124000Z","edited":"2014-12-20T20:58:18.442000Z","url":"http://swapi.co/api/planets/14/"},{"name":"Polis Massa","rotation_period":"24","orbital_period":"590","diameter":"0","climate":"artificial temperate ","gravity":"0.56 standard","terrain":"airless asteroid","surface_water":"0","population":"1000000","residents":[],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:33:46.405000Z","edited":"2014-12-20T20:58:18.444000Z","url":"http://swapi.co/api/planets/15/"},{"name":"Mygeeto","rotation_period":"12","orbital_period":"167","diameter":"10088","climate":"frigid","gravity":"1 standard","terrain":"glaciers, mountains, ice canyons","surface_water":"unknown","population":"19000000","residents":[],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:43:39.139000Z","edited":"2014-12-20T20:58:18.446000Z","url":"http://swapi.co/api/planets/16/"},{"name":"Felucia","rotation_period":"34","orbital_period":"231","diameter":"9100","climate":"hot, humid","gravity":"0.75 standard","terrain":"fungus forests","surface_water":"unknown","population":"8500000","residents":[],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:44:50.397000Z","edited":"2014-12-20T20:58:18.447000Z","url":"http://swapi.co/api/planets/17/"},{"name":"Cato Neimoidia","rotation_period":"25","orbital_period":"278","diameter":"0","climate":"temperate, moist","gravity":"1 standard","terrain":"mountains, fields, forests, rock arches","surface_water":"unknown","population":"10000000","residents":["http://swapi.co/api/people/33/"],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:46:28.704000Z","edited":"2014-12-20T20:58:18.449000Z","url":"http://swapi.co/api/planets/18/"},{"name":"Saleucami","rotation_period":"26","orbital_period":"392","diameter":"14920","climate":"hot","gravity":"unknown","terrain":"caves, desert, mountains, volcanoes","surface_water":"unknown","population":"1400000000","residents":[],"films":["http://swapi.co/api/films/6/"],"created":"2014-12-10T13:47:46.874000Z","edited":"2014-12-20T20:58:18.450000Z","url":"http://swapi.co/api/planets/19/"},{"name":"Stewjon","rotation_period":"unknown","orbital_period":"unknown","diameter":"0","climate":"temperate","gravity":"1 standard","terrain":"grass","surface_water":"unknown","population":"unknown","residents":["http://swapi.co/api/people/10/"],"films":[],"created":"2014-12-10T16:16:26.566000Z","edited":"2014-12-20T20:58:18.452000Z","url":"http://swapi.co/api/planets/20/"},{"name":"Eriadu","rotation_period":"24","orbital_period":"360","diameter":"13490","climate":"polluted","gravity":"1 standard","terrain":"cityscape","surface_water":"unknown","population":"22000000000","residents":["http://swapi.co/api/people/12/"],"films":[],"created":"2014-12-10T16:26:54.384000Z","edited":"2014-12-20T20:58:18.454000Z","url":"http://swapi.co/api/planets/21/"}]}

data/spec/starwars/base_spec.rb

@@ -0,0 +1,17 @@
+describe Starwars::Base do
+  before do
+    stub_get('/planets/100/').to_return(status: [404, 'NOT FOUND'], body: fixture('404.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    stub_get('/planets/1/').to_return(body: fixture('planets_1.json'), headers: { content_type: 'application/json; charset=utf-8' })
+  end
+  describe '#fetch' do
+    it 'should raise an exception when argument error' do
+      base = Starwars::Base.new
+      expect { base.fetch }.to raise_error(Starwars::Error::ArgumentError)
+    end
+  end
+  describe '#link' do
+    it 'should return the same string if passed a string' do
+      expect(Starwars::Base.send('link', '/something')).to eq '/something'
+    end
+  end
+end

data/spec/starwars/cursor_spec.rb

@@ -0,0 +1,76 @@
+describe Starwars::Cursor do
+  let(:resource) { Starwars::Planet }
+  let(:uri) { 'http://swapi.co/api/planets/' }
+  let(:as) { Starwars::Request::FORMAT }
+  let(:params) { { two: 2 } }
+  let(:method) { :get }
+  let(:cursor) do
+    Starwars::Cursor.new
+  end
+
+  describe '#last_page?' do
+    it 'returns true if so' do
+      cursor.next = nil
+      expect(cursor.last_page?).to eq(true)
+    end
+
+    it 'returns false if not' do
+      cursor.next = '/something'
+      expect(cursor.last_page?).to eq(false)
+    end
+  end
+
+  describe '#next_page?' do
+    it 'returns true if so' do
+      cursor.next = '/something'
+      expect(cursor.next_page?).to eq(true)
+    end
+
+    it 'returns false if not' do
+      cursor.next = nil
+      expect(cursor.next_page?).to eq(false)
+    end
+  end
+
+  describe '#next_page' do
+    let(:request_response) do
+      double(body: { results: [], next: '/something', pervious: nil })
+    end
+    before :each do
+      allow(cursor).to receive(:perform_request).and_return(request_response)
+    end
+
+    it 'returns nil if there are no more pages' do
+      cursor.next = nil
+      expect(cursor.next_page).to eq(nil)
+    end
+
+    it 'performs a request' do
+      cursor.next = 'http://swapi.co/api/planets/?page=2'
+      expect(cursor).to receive(:perform_request)
+      cursor.next_page
+    end
+  end
+
+  describe '#each_page' do
+    it 'should return an enumerator if no block is provided' do
+      expect(cursor.each_page).to be_an(Enumerator)
+    end
+
+    it 'yields till no more pages' do
+      request_responses = [
+        double(body: { previous: nil, results: [1, 2, 3, 4] }),
+        double(body: { next: '/next/next', previous: '/previous', results: [1, 2, 3, 4] }),
+        double(body: { next: nil, previous: '/previous', results: [1, 2, 3, 4] })
+      ]
+      cursor.next = '/something'
+      allow(cursor).to receive(:perform_request).and_return(request_responses[0])
+      expect(cursor).to receive(:perform_request).exactly(4).times
+
+      cursor.each_with_index do |_, index|
+        allow(cursor).to receive(:perform_request).and_return(request_responses[index])
+        cursor.next = request_responses[index]
+      end
+    end
+  end
+end

data/spec/starwars/person_spec.rb

@@ -19,7 +19,7 @@ describe Starwars::Person do
   end
 
   describe 'getters' do
-    subject(:person_2) { Starwars::Person.fetch(2) }
+    subject(:person_2) { Starwars::Person.new(id: 2).fetch }
     subject(:person_1) { Starwars::Person.fetch(1) }
     describe '#created' do
       it 'returns a Time when updated is set' do

data/spec/starwars/request_spec.rb

@@ -0,0 +1,29 @@
+describe Starwars::Request do
+  let(:resource) { Starwars::Planet }
+  let(:uri) { 'http://swapi.co/api/planets/100/' }
+  let(:as) { Starwars::Request::FORMAT }
+  let(:params) { { two: 2 } }
+  let(:method) { :get }
+
+  let(:request) do
+    Starwars::Request.new(resource: resource.new, uri: uri, method: method, as: as, params: { moski: true })
+  end
+
+  before do
+    stub_get('/planets/100/').to_return(status: [404, 'NOT FOUND'], body: fixture('404.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    stub_get('/planets/1/').to_return(body: fixture('planets_1.json'), headers: { content_type: 'application/json; charset=utf-8' })
+  end
+
+  describe '#perform_request' do
+    let(:perform_request) { -> { request.send(:perform_request) } }
+    it 'runs the request and verifies it' do
+      allow(request).to receive(:perform_request)
+      expect(request).to receive(:perform_request)
+      perform_request.call
+    end
+
+    it 'raises an exception when data not found' do
+      expect { request.perform_request }.to raise_error(Starwars::Error::NotFound)
+    end
+  end
+end

data/spec/starwars/resources/paginated/planets_spec.rb

@@ -0,0 +1,38 @@
+describe Starwars::Planets do
+  before do
+    stub_get('/planets/').to_return(body: fixture('planets_page1.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    stub_get('/planets/?page=2').to_return(body: fixture('planets_page2.json'), headers: { content_type: 'application/json; charset=utf-8' })
+  end
+  describe 'getters' do
+    subject(:planets) { Starwars::Planet.fetch_all }
+    describe '#number_of_pages' do
+      it 'should have the correct value' do
+        expect(planets.number_of_pages).to eq 60
+      end
+    end
+    describe '#next' do
+      it 'should have the correct value' do
+        expect(planets.next).to eq 'http://swapi.co/api/planets/?page=2'
+      end
+    end
+    describe '#previous' do
+      it 'should have the correct value' do
+        expect(planets.previous).to eq nil
+      end
+    end
+    describe '#results' do
+      it 'should have the correct size' do
+        expect(planets.results.size).to eq 10
+      end
+      it 'should have the correct type' do
+        expect(planets.results.first).to be_a Starwars::Planet
+      end
+    end
+    describe '#next_page' do
+      it 'should fetch the next page' do
+        planets.next_page
+        expect(planets.next).to eq 'http://swapi.co/api/planets/?page=3'
+      end
+    end
+  end
+end