starwars 0.0.1 → 0.0.2

data/lib/starwars/error.rb

@@ -0,0 +1,63 @@
+module Starwars
+  # Custom error class for rescuing from all Starwars errors
+  class Error < StandardError
+    class << self
+      # Return a hash of error classes
+      # @return [Hash]
+      # @example get the total number of pages
+      #   Starwars::Error.errors
+      # @api public
+      def errors
+        @errors ||=  {
+          400 => Starwars::Error::BadRequest,
+          401 => Starwars::Error::Unauthorized,
+          403 => Starwars::Error::Forbidden,
+          404 => Starwars::Error::NotFound,
+          500 => Starwars::Error::InternalServerError,
+          503 => Starwars::Error::ServiceUnavailableError
+        }
+      end
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param _status [Exception, status]
+    # @return [Starwars::Error]
+    # @example
+    #   Starwars::Error.new('I am your father', nil)
+    # @api public
+    def initialize(message = '', _status = nil)
+      super(message)
+    end
+
+    class ArgumentError < self; end
+
+    # Raised when Starwars returns a 4xx HTTP status status_code
+    class ClientError < self; end
+
+    # Raised when Starwars returns the HTTP status status_code 400
+    class BadRequest < ClientError; end
+
+    # Raised when Starwars returns the HTTP status status_code 401
+    class Unauthorized < ClientError; end
+
+    # Raised when Starwars returns the HTTP status status_code 403
+    class Forbidden < ClientError; end
+
+    # Raised when Starwars returns the HTTP status status_code 404
+    class NotFound < ClientError; end
+
+    # Raised when Starwars returns a 5xx HTTP status code
+    class ServerError < self; end
+
+    # Raised when Starwars returns the HTTP status status_code 500
+    class InternalServerError < ServerError; end
+
+    # Raised when Starwars returns the HTTP status status_code 503
+    class ServiceUnavailableError < ServerError; end
+
+    # Raised when the request times out
+    class RequestTimeout < self; end
+  end
+end

data/lib/starwars/overrides/ostruct.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+#
+# ostruct for ruby 1.9 doesn't implement [] operater
+# This a monkey patch my copying the ruby 2.0 version
+class OpenStruct
+  #
+  # Fetch an object by id or URL
+  # @param [String] name
+  # @return [Object]
+  #
+  # @api private
+  def [](name)
+    @table[name.to_sym]
+  end
+end

data/lib/starwars/request.rb

@@ -0,0 +1,80 @@
+require 'starwars/error'
+
+module Starwars
+  # Wrap request attrs
+  class Request
+    BASE_URL = 'http://swapi.co/api'
+    FORMAT = 'application/json'
+
+    # The format of the HTTP request
+    # @return [String]
+    # @api private
+    attr_accessor :as
+
+    # The http method for the request
+    # @return [Symbol]
+    # @api private
+    attr_accessor :method
+
+    # The resouce object that we going to call to fetch the data
+    # @return [Person, Film, Planet, Specie, Starship, Vehicle]
+    # @api private
+    attr_accessor :resource
+
+    # The remote url for the resource that we want to fetch
+    # @return [String]
+    # @api private
+    attr_accessor :uri
+
+    # Extra params we want to send with the http request
+    # @return [Hash]
+    # @api private
+    attr_accessor :params
+
+    # Initializer
+    # @param [Hash] attrs request attributes
+    # @option attrs [Starwars::] :resource
+    # @option attrs [Symbol] :method
+    # @option attrs [String] :uri
+    # @option attrs [Hash] :params
+    # @option attrs [String] :as
+    # @return [Starwars::Request]
+    # @example
+    #   data = Request.new(resource: Person.new(id: 1), uri: "/something")
+    # @api public
+    def initialize(attrs)
+      self.resource = attrs.fetch(:resource)
+      self.method = attrs.fetch(:method) { :get }
+      self.uri = attrs.fetch(:uri)
+      self.as = attrs.fetch(:as) { FORMAT }
+      self.params = attrs.fetch(:params) { {} }
+    end
+
+    #
+    # Delegate to the Roar client to fetch data from api
+    # @return [Person, Film, Planet, Specie, Starship, Vehicle]
+    # @example
+    #   request.perform_request
+    # @raise [Starwars::Error]
+    # @api public
+    def perform_request
+      resource.send(method, uri: uri, as: as)
+
+      rescue Roar::Transport::Error => e
+        raise_http_errors(e.response.code.to_i, e.response.msg)
+    end
+
+    private
+
+    #
+    # Check the response code and raise exceptions if needed
+    # @param status [Integer]
+    # @param message [String]
+    # @return [void]
+    # @api private
+    def raise_http_errors(status, message)
+      error_class = Starwars::Error.errors[status]
+      fail(error_class.new(message, status)) if error_class
+    end
+  end
+end

data/lib/starwars/resources/film.rb

@@ -0,0 +1,79 @@
+module Starwars
+  #
+  # A Film resource is an single film.
+  #
+  class Film < Starwars::Base
+    # Define the source name in the starwars api
+    RESOURCE_NAME = 'films'
+
+    # The title of this film
+    # @return [String]
+    # @example
+    #   film.title #=> 'A New Hope'
+    # @api public
+    property :title
+
+    # The opening paragraphs at the beginning of this film
+    # @return [String]
+    # @example
+    #   film.opening_crawl #=> 'It is a period of civil war ...'
+    # @api public
+    property :opening_crawl
+
+    # The name of the director of this film
+    # @return [String]
+    # @example
+    #   film.director #=> 'George Lucas'
+    # @api public
+    property :director
+
+    # The name(s) of the producer(s) of this film. Comma seperated
+    # @return [String]
+    # @example
+    #   film.producer #=> 'Gary Kurtz, Rick McCallum'
+    # @api public
+    property :producer
+
+    # The episode number of this film
+    # @return [Integer]
+    # @example
+    #   film.episode_id #=> 1
+    # @api public
+    property :episode_id, type: Integer
+
+    # List of people
+    # @return [Array<Person>]
+    # @example
+    #   film.characters
+    # @api public
+    collection :characters, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+
+    # List of planets
+    # @return [Array<Person>]
+    # @example
+    #   film.characters
+    # @api public
+    collection :planets, class: Starwars::Planet,  deserialize: ->(_, fragment, _) { Planet.new(url: fragment) }
+
+    # List of starships
+    # @return [Array<Starship>]
+    # @example
+    #   film.starships
+    # @api public
+    collection :starships, class: Starwars::Starship,  deserialize: ->(_, fragment, _) { Starship.new(url: fragment) }
+
+    # List of vehicles
+    # @return [Array<Vehicle>]
+    # @example
+    #   film.vehicles
+    # @api public
+    collection :vehicles, class: Starwars::Vehicle,  deserialize: ->(_, fragment, _) { Vehicle.new(url: fragment) }
+
+    # List of species
+    # @return [Array<Specie>]
+    # @example
+    #   film.species
+    # @api public
+    collection :species, class: Starwars::Specie,  deserialize: ->(_, fragment, _) { Specie.new(url: fragment) }
+  end
+end

data/lib/starwars/resources/paginated/films.rb

@@ -0,0 +1,8 @@
+module Starwars
+  #
+  # Films container
+  #
+  class Films < Starwars::Cursor
+    collection :results, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(fragment) }
+  end
+end

data/lib/starwars/resources/paginated/people.rb

@@ -0,0 +1,8 @@
+module Starwars
+  #
+  # People container
+  #
+  class People < Starwars::Cursor
+    collection :results, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(fragment) }
+  end
+end

data/lib/starwars/resources/paginated/planets.rb

@@ -0,0 +1,9 @@
+module Starwars
+  #
+  # A Planet resource is a large mass, planet or planetoid in
+  # the Star Wars Universe, at the time of 0 ABY.
+  #
+  class Planets < Starwars::Cursor
+    collection :results, class: Starwars::Planet,  deserialize: ->(_, fragment, _) { Planet.new(fragment) }
+  end
+end

data/lib/starwars/resources/paginated/species.rb

@@ -0,0 +1,8 @@
+module Starwars
+  #
+  # Species container
+  #
+  class Species < Starwars::Cursor
+    collection :results, class: Starwars::Specie,  deserialize: ->(_, fragment, _) { Specie.new(fragment) }
+  end
+end

data/lib/starwars/resources/paginated/starships.rb

@@ -0,0 +1,8 @@
+module Starwars
+  #
+  # Starships Container
+  #
+  class Starships < Starwars::Cursor
+    collection :results, class: Starwars::Starship,  deserialize: ->(_, fragment, _) { Starship.new(fragment) }
+  end
+end

data/lib/starwars/resources/paginated/vehicles.rb

@@ -0,0 +1,8 @@
+module Starwars
+  #
+  # Starships Container
+  #
+  class Vehicles < Starwars::Cursor
+    collection :results, class: Starwars::Vehicle,  deserialize: ->(_, fragment, _) { Vehicle.new(fragment) }
+  end
+end

data/lib/starwars/resources/person.rb

@@ -0,0 +1,124 @@
+module Starwars
+  #
+  # A People resource is an individual person or character within the Star Wars universe.
+  #
+  class Person < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'people'
+
+    # The name of this person
+    # @return [String]
+    # @example
+    #   person.name
+    # @api public
+    property :name
+
+    # The skin color of this person
+    # @return [String]
+    # @example
+    #   person.skin_color
+    # @api public
+    property :skin_color
+
+    # The eye color of this person
+    #
+    # @return [String]
+    #
+    # @note Will be "unknown" if not known or "n/a"
+    #       if the person does not have an eye
+    #
+    # @example
+    #   person.eye_color
+    # @api public
+    property :eye_color
+
+    # The hair color of this person
+    #
+    # @return [String]
+    #
+    # @note: Will be "unknown" if not known or "n/a"
+    #        if the person does not have hair
+    #
+    # @example
+    #   person.hair_color
+    # @api public
+    property :hair_color
+
+    # The birth year of the person
+    #
+    # @return [String]
+    #
+    # @note using the in-universe standard of
+    # BBY or ABY - Before the Battle of Yavin or After the Battle of Yavin.
+    # The Battle of Yavin is a battle that occurs at the end of Star Wars
+    # episode IV: A New Hope
+    #
+    # @example
+    #   person.birth_year
+    # @api public
+    property :birth_year
+
+    # The gender of this person
+    #
+    # @return [String]
+    #
+    # @note Either "Male", "Female" or "unknown", "n/a"
+    #       if the person does not have a gender
+    #
+    # @example
+    #   person.gender
+    # @api public
+    property :gender
+
+    # The height of the person in centimeters
+    # @return [Integer]
+    # @example
+    #   person.height
+    # @api public
+    property :height, type: Integer
+
+    # The mass of the person in kilograms
+    # @return [Integer]
+    # @example
+    #   person.mass
+    # @api public
+    property :mass, type: Integer
+
+    # List of homeworlds
+    # @return [Array<Planet>]
+    # @example
+    #   person.homeworlds
+    # @api public
+    property :homeworld, class: Starwars::Planet, deserialize: ->(_, fragment, _) { Planet.new(url: fragment) }
+
+    # List of films
+    # @return [Array<Film>]
+    # @example
+    #   person.films
+    # @api public
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+
+    # List of species
+    # @return [Array<Specie>]
+    # @example
+    #   person.species
+    # @api public
+    collection :species, class: Starwars::Specie,  deserialize: ->(_, fragment, _) { Specie.new(url: fragment) }
+
+    # List of vehicles
+    # @return [Array<Vehicle>]
+    # @example
+    #   person.vehicles
+    # @api public
+    collection :vehicles, class: Starwars::Vehicle,  deserialize: ->(_, fragment, _) { Vehicle.new(url: fragment) }
+
+    # List of tarships
+    # @return [Array<Starship>]
+    # @example
+    #   person.starships
+    # @api public
+    collection :starships, class: Starwars::Starship,  deserialize: ->(_, fragment, _) { Starship.new(url: fragment) }
+  end
+end

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

@@ -9,28 +9,15 @@ module Starwars
     #
     RESOURCE_NAME = 'planets'
 
-    include Starwars::Fetcher
-
-    # @return [String]
     property :name
     property :climate
     property :gravity
     property :terrain
-    property :url
-
-    # @return [Integer]
-    property :id, type: Integer
     property :population, type: Integer
     property :rotation_period, type: Integer
     property :orbital_period, type: Integer
     property :surface_water, type: Integer
     property :diameter, type: Integer
-
-    # @return [Time]
-    property :created, type: Time
-    property :edited, type: Time
-
-    # @return [Array]
     collection :residents, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
     collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
   end