tatooine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75e1fa6852675a23a818217a4bc9bfc9070e6cff
+  data.tar.gz: 0b675f61ea00c7c2d94a5e411ec8c7b49527ada0
+SHA512:
+  metadata.gz: 37d6d51419db7ade8e3e35a6997606d7ea498ed027179e2664d9170a7ddd373d4b69821d752276925967bec877b4c85867eb861f98594a67d9e6e97d8bc9e97c
+  data.tar.gz: 587a2a3bb77d0b7aa67f83becda01f972e399d995f4c202d0ffede6563daa35ea711d5fcd3ed4af3fbb3752751f6bcc098fef0aef389af120f69a60c1b5c1ed7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tatooine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phil Nash
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Tatooine
+
+A Ruby interface to [SWAPI](http://swapi.co/) (the Star Wars API).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tatooine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tatooine
+
+## Usage
+
+There are 6 resources available: Planets, Starships, Vehicles, People, Films and Species. They all have a similar interface.
+
+```ruby
+planets = Tatooine::Planet.list
+Tatooine::Planet.count
+# => 60
+planets.length
+# => 10 # resources are paginated
+planets.concat Tatooine::Planet.next
+planets.length
+# => 20
+
+tatooine = Tatooine::Planet.get(1)
+tatooine.name
+# => "Tatooine"
+tatooine.residents
+# => [<Tatooine::Person>, ...]
+tatooine.residents.first.name
+# => "Luke Skywalker" # Will make the request to get the resource
+```
+
+## Schema
+
+In SWAPI the objects are described by their [schemas](http://swapi.co/documentation#schema). Check the [SWAPI documentation](http://swapi.co/documentation) to find out more about each of the objects.
+
+## Contributing
+
+1. Fork it ( https://github.com/philnash/tatooine/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/lib/tatooine.rb

@@ -0,0 +1,17 @@
+require "faraday"
+require "faraday_middleware"
+
+require "tatooine/version"
+require "tatooine/error"
+require "tatooine/middleware/raise_http_error"
+require "tatooine/resource"
+require "tatooine/film"
+require "tatooine/person"
+require "tatooine/planet"
+require "tatooine/species"
+require "tatooine/starship"
+require "tatooine/vehicle"
+
+module Tatooine
+  API_BASE = "http://swapi.co/api/"
+end

data/lib/tatooine/error.rb

@@ -0,0 +1,25 @@
+module Tatooine
+  # Custom error class for rescuing from all client errors
+  class Error < StandardError; end
+
+  # Raised when Swapi returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Swapi returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Swapi returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Swapi returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Swapi returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Swapi returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when Swapi returns the HTTP status code 521
+  class OriginDown < Error; end
+end

data/lib/tatooine/film.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Film
+    include Resource
+    resource_path "films"
+  end
+end

data/lib/tatooine/middleware/raise_http_error.rb

@@ -0,0 +1,34 @@
+module Tatooine
+  module Middleware
+    class RaiseHttpError < Faraday::Response::Middleware
+      def on_complete(env)
+        case env[:status].to_i
+        when 400
+          raise Tatooine::BadRequest, response_values(env)
+        when 404
+          raise Tatooine::NotFound, response_values(env)
+        when 500
+          raise Tatooine::InternalServerError, response_values(env)
+        when 502
+          raise Tatooine::BadGateway, response_values(env)
+        when 503
+          raise Tatooine::ServiceUnavailable, response_values(env)
+        when 504
+          raise Tatooine::GatewayTimeout, response_values(env)
+        when 521
+          raise Tatooine::OriginDown, response_values(env)
+        end
+      end
+
+      def response_values(env)
+        {:status => env.status, :headers => env.response_headers, :body => env.body}
+      end
+    end
+  end
+end
+
+module Faraday
+  class Response
+    register_middleware :raise_http_error => Tatooine::Middleware::RaiseHttpError
+  end
+end

data/lib/tatooine/person.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Person
+    include Resource
+    resource_path "people"
+  end
+end

data/lib/tatooine/planet.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Planet
+    include Resource
+    resource_path "planets"
+  end
+end

data/lib/tatooine/resource.rb

@@ -0,0 +1,125 @@
+module Tatooine
+  module Resource
+    MAPPING = {
+      "films" => :Film,
+      "people" => :Person,
+      "planets" => :Planet,
+      "species" => :Species,
+      "starships" => :Starship,
+      "vehicles" => :Vehicle,
+      "homeworld" => :Planet,
+      "characters" => :Person,
+      "pilots" => :Person,
+      "residents" => :Person
+    }
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize(opts={})
+      @properties = opts
+      set_properties
+    end
+
+    private
+
+    def set_properties
+      self.class.schema["properties"].each do |property, values|
+        properties = @properties.dup
+        if properties[property]
+          if values["type"] == "integer"
+            properties[property] = properties[property].to_i
+          elsif values["type"] == "array" && MAPPING.keys.include?(property)
+            klass = Tatooine.const_get(MAPPING[property])
+            properties[property] = properties[property].map do |url|
+              klass.new("url" => url)
+            end
+          elsif MAPPING.keys.include?(property)
+            klass = Tatooine.const_get(MAPPING[property])
+            properties[property] = klass.new("url" => properties[property])
+          end
+          instance_variable_set("@#{property}", properties[property])
+        end
+      end
+      @url = @properties["url"] if @properties["url"]
+    end
+
+
+    module ClassMethods
+      def list(opts={})
+        load_schema
+        url = opts.delete("url") || ""
+        body = connection.get(url, opts).body
+        @count = body["count"]
+        @next = body["next"]
+        @previous = body["previous"]
+        body["results"].map { |result| new(result) }
+      end
+
+      def count
+        @count || get_count
+      end
+
+      def next
+        list "url" => @next if @next
+      end
+
+      def previous
+        list "url" => @previous if @previous
+      end
+
+      def get(id)
+        load_schema
+        result = connection.get("#{id}/")
+        new(result.body)
+      end
+
+      def schema
+        load_schema
+      end
+
+      def connection
+        options = {
+          headers: {
+            "User-Agent" => "Tatooine Ruby Gem - #{Tatooine::VERSION}"
+          },
+          url: "#{Tatooine::API_BASE}#{@resource_path}/"
+        }
+        @connection ||= Faraday.new(options) do |faraday|
+          faraday.response :raise_http_error
+          faraday.response :dates
+          faraday.response :json
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
+
+      private
+
+      def load_schema
+        if !@schema
+          @schema = connection.get("schema").body
+          @schema["properties"].keys.each do |property|
+            define_method property.to_sym do
+              if @properties.nil? || @properties.keys.length <= 1
+                result = self.class.connection.get(@url)
+                @properties = result.body
+                set_properties
+              end
+              instance_variable_get("@#{property}")
+            end
+          end
+        end
+        @schema
+      end
+
+      def get_count
+        @count = connection.get("").body["count"]
+      end
+
+      def resource_path(path)
+        @resource_path = path
+      end
+    end
+  end
+end

data/lib/tatooine/species.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Species
+    include Resource
+    resource_path "species"
+  end
+end

data/lib/tatooine/starship.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Starship
+    include Resource
+    resource_path "starships"
+  end
+end

data/lib/tatooine/vehicle.rb

@@ -0,0 +1,6 @@
+module Tatooine
+  class Vehicle
+    include Resource
+    resource_path "vehicles"
+  end
+end

data/lib/tatooine/version.rb

@@ -0,0 +1,3 @@
+module Tatooine
+  VERSION = "1.0.0"
+end

data/spec/error_spec.rb

@@ -0,0 +1,21 @@
+require "./spec/spec_helper"
+
+describe "API errors" do
+  {
+    400 => Tatooine::BadRequest,
+    404 => Tatooine::NotFound,
+    500 => Tatooine::InternalServerError,
+    502 => Tatooine::BadGateway,
+    503 => Tatooine::ServiceUnavailable,
+    504 => Tatooine::GatewayTimeout,
+    521 => Tatooine::OriginDown
+  }.each do |status, error|
+    it "should raise custom error for #{status}" do
+      stub_request(:get, "#{Tatooine::API_BASE}films/schema").to_return(
+        :body => File.new("./spec/fixtures/film_schema.json")
+      )
+      stub_request(:get, "#{Tatooine::API_BASE}films/11/").to_return(:status => status)
+      expect { Tatooine::Film.get(11) }.to raise_error(error)
+    end
+  end
+end

data/spec/film_spec.rb

@@ -0,0 +1,107 @@
+require "./spec/spec_helper"
+
+describe Tatooine::Film do
+  describe "#schema" do
+    before(:all) do
+      VCR.use_cassette("film schema") do
+        @schema = Tatooine::Film.schema
+      end
+    end
+
+    it "should get the description of the class" do
+      expect(@schema).to be_instance_of(Hash)
+      expect(@schema["description"]).to eq("A Star Wars film")
+    end
+  end
+
+  describe "#count" do
+    before(:all) do
+      VCR.use_cassette("film count") do
+        @count = Tatooine::Film.count
+      end
+    end
+
+    it "should return the correct count" do
+      expect(@count).to be(6)
+    end
+  end
+
+  describe "#list" do
+    before(:all) do
+      VCR.use_cassette("film list") do
+        @films = Tatooine::Film.list
+      end
+    end
+
+    it "gets a list of films" do
+      expect(@films).to be_instance_of(Array)
+      expect(@films.length).to be(6)
+      expect(@films.first).to be_instance_of(Tatooine::Film)
+    end
+  end
+
+  describe "#get" do
+    before(:all) do
+      VCR.use_cassette("film 1") do
+        @film = Tatooine::Film.get(1)
+      end
+    end
+
+    it "gets the url of the film" do
+      expect(@film.url).to eq("http://swapi.co/api/films/1/")
+    end
+
+    it "gets the attributes of the film" do
+      expect(@film.title).to eq("A New Hope")
+      expect(@film.episode_id).to eq(4)
+    end
+
+    it "gets a list of characters" do
+      expect(@film.characters).to be_instance_of(Array)
+      expect(@film.characters.first).to be_instance_of(Tatooine::Person)
+    end
+
+    it "gets a list of planets" do
+      expect(@film.planets).to be_instance_of(Array)
+      expect(@film.planets.first).to be_instance_of(Tatooine::Planet)
+    end
+
+    it "gets a list of species" do
+      expect(@film.species).to be_instance_of(Array)
+      expect(@film.species.first).to be_instance_of(Tatooine::Species)
+    end
+
+    it "gets a list of starships" do
+      expect(@film.starships).to be_instance_of(Array)
+      expect(@film.starships.first).to be_instance_of(Tatooine::Starship)
+    end
+
+    it "gets a list of vehicles" do
+      expect(@film.vehicles).to be_instance_of(Array)
+      expect(@film.vehicles.first).to be_instance_of(Tatooine::Vehicle)
+    end
+  end
+
+  describe "#new" do
+    it "primes an object with a url" do
+      VCR.use_cassette("film schema") do
+        @film = Tatooine::Film.new("url" => "#{Tatooine::API_BASE}films/1/")
+        expect(@film).to respond_to(:title)
+      end
+    end
+
+    it "gets the object when methods are called" do
+      VCR.use_cassette("film 1 and schema") do
+        @film = Tatooine::Film.new("url" => "#{Tatooine::API_BASE}films/1/")
+        expect(@film.title).to eq("A New Hope")
+      end
+    end
+
+    it "sets properties from an object" do
+      VCR.use_cassette("film schema") do
+        @film = Tatooine::Film.new("title" => "Anything, because I said so")
+        expect(@film.title).to eq("Anything, because I said so")
+      end
+    end
+  end
+end