starwars 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad657666a52a78f6326d5781ee9f1c12f19e5b54
+  data.tar.gz: 07fefe6fd93d76fb5bf6184093608379a7252147
+SHA512:
+  metadata.gz: 6b9c5802184691e8e1337a9048488e5b2d0fd8d258c799e9526fc065c7456d1f3bfff9a3ccc83a3a05d8978007ea55d661fae4f38f75dc91b8d36589034ce952
+  data.tar.gz: bda6c580a84b436c3eb057ee174de48f3253556eb13f227c140d5d92c23c60f09ced5d58088b97640ee233bbd3d1367714dbe7bfd04718a104c2557ec9a9d279

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 140

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+bundler_args: --without guard
+script: "bundle exec rake"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: rbx-2
+  fast_finish: true
+branches:
+  only: master
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'coveralls'
+  gem 'rspec', '>= 2.14'
+  gem 'simplecov', '>= 0.9'
+  gem 'rubocop', '>= 0.27'
+  gem 'yardstick'
+  if RUBY_VERSION >= '1.9.3'
+    gem 'guard', '~> 2.6'
+    gem 'guard-rspec', '~> 4.2'
+  end
+  gem 'webmock'
+end
+
+# Specify your gem's dependencies in flood.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Moski Doski
+
+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,59 @@
+# Starwars
+
+A Ruby interface for http://swapi.co/ - the Star Wars API
+![Starwars](https://s3.amazonaws.com/f.cl.ly/items/1r2F2K460v1R2o011n1M/star-wars-evolution-evolution-funny.jpg)
+
+## API Support
+- [x] Films API
+- [x] People API
+- [x] Planet API
+- [x] Species API
+- [x] Vehicles API
+- [x] Starship API
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'starwars'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install starwars
+
+## Usage
+    require "starwars"
+    luke = Starwars::Person.fetch(1)
+    puts luke.name
+    puts luke.height
+
+    falcon = Starwars::Spaceship.new(id: 10)
+    falcon.fetch
+    puts falcon.name
+    puts falcon.pilots
+
+  you can also nest the quries, such as:
+    
+    falcon.pilots.each do |piolt|
+      puts piolt.fetch.name
+    end
+
+  You can load a resouce by url:
+
+    aldeeran = Starwars::Planet.new(url: 'http://swapi.co/api/planets/3/').fetch
+    puts aldeeran.name
+    puts aldeeran.residents
+    puts aldeeran.population
+
+## Contributing
+
+1. Fork it ( https://github.com/moski/starwars/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,27 @@
+require 'bundler/gem_tasks'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 55
+  verify.require_exact_threshold = false
+end
+
+task default: [:spec, :rubocop, :verify_measurements]

data/lib/starwars.rb

@@ -0,0 +1,19 @@
+require 'starwars/version'
+require 'starwars/base'
+require 'starwars/fetcher'
+
+# Avoid circuler require issues :(
+module Starwars
+  class Planet < Starwars::Base; end
+  class Person < Starwars::Base; end
+  class Film < Starwars::Base; end
+  class Specie < Starwars::Base; end
+  class Vehicle < Starwars::Base; end
+  class Starship < Starwars::Base; end
+end
+require 'starwars/planet'
+require 'starwars/person'
+require 'starwars/specie'
+require 'starwars/vehicle'
+require 'starwars/starship'
+require 'starwars/film'

data/lib/starwars/base.rb

@@ -0,0 +1,54 @@
+require 'roar/json'
+require 'roar/client'
+require 'roar/coercion'
+require 'ostruct'
+require 'equalizer'
+require 'virtus'
+
+module Starwars
+  #
+  # Base Class for fetching all the data from the remote api.
+  # All Classes should inhert from this class.
+  #
+  class Base < OpenStruct
+    include Roar::JSON
+    include Roar::Client
+    include Roar::Coercion
+
+    BASE_URL = 'http://swapi.co/api'
+    FORMAT = 'application/json'
+
+    def ==(other)
+      id == other.id && url == other.url
+    end
+
+    def fetch(resource_name)
+      #
+      # If the url is set, then fetch using the resource url
+      #
+      if url
+        get(uri: url, as: FORMAT)
+      #
+      # Try to fetch using the resource name and ID
+      #
+      elsif id
+        get(uri: "#{BASE_URL}/#{resource_name}/#{id}/", as: FORMAT)
+      else
+        fail 'error'
+      end
+    end
+    class << self
+      def fetch(resources, id)
+        #
+        # Special case for person and people, instead of removing the s
+        #
+        if (resources == 'people')
+          resources = 'person'
+        else
+          resources.slice!(-1, 1)
+        end
+        Starwars.const_get(resources.capitalize).new(id: id).fetch
+      end
+    end
+  end
+end

data/lib/starwars/fetcher.rb

@@ -0,0 +1,40 @@
+module Starwars
+  #
+  # Common Module for the fetcher behaviour across all api references
+  #
+  module Fetcher
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    # Fetcher Methods to be included in every resource
+    module InstanceMethods
+      #
+      # Fetch a resouce give the resource name
+      #
+      def fetch
+        super(resouces_name)
+      end
+
+      private
+
+      def resouces_name
+        resource = self.class.name.split('::').last.downcase
+        (resource == 'person') ? 'people' : "#{resource}s"
+      end
+    end
+
+    # Fetcher Class Method to be included in every resource
+    module ClassMethods
+      def fetch(id)
+        super(resouces_name, id)
+      end
+
+      def resouces_name
+        resource = name.split('::').last.downcase
+        (resource == 'person') ? 'people' : "#{resource}s"
+      end
+    end
+  end
+end

data/lib/starwars/film.rb

@@ -0,0 +1,35 @@
+module Starwars
+  #
+  # A Film resource is an single film.
+  #
+  class Film < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    RESOURCE_NAME = 'films'
+
+    include Starwars::Fetcher
+
+    # @return [String]
+    property :title
+    property :opening_crawl
+    property :director
+    property :producer
+    property :url
+
+    # @return [Integer]
+    property :id, type: Integer
+    property :episode_id, type: Integer
+
+    # @return [Time]
+    property :created, type: Time
+    property :edited, type: Time
+
+    # @return [Array]
+    collection :characters, class: Starwars::Person,  deserialize: ->(_, fragment, _) { Person.new(url: fragment) }
+    collection :planets, class: Starwars::Planet,  deserialize: ->(_, fragment, _) { Planet.new(url: fragment) }
+    collection :starships, class: Starwars::Starship,  deserialize: ->(_, fragment, _) { Starship.new(url: fragment) }
+    collection :vehicles, class: Starwars::Vehicle,  deserialize: ->(_, fragment, _) { Vehicle.new(url: fragment) }
+    collection :species, class: Starwars::Specie,  deserialize: ->(_, fragment, _) { Specie.new(url: fragment) }
+  end
+end

data/lib/starwars/person.rb

@@ -0,0 +1,39 @@
+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'
+
+    include Starwars::Fetcher
+
+    # @return [String]
+    property :name
+    property :skin_color
+    property :eye_color
+    property :hair_color
+    property :birth_year
+    property :gender
+    property :url
+
+    # @return [Integer]
+    property :height, type: Integer
+    property :mass, type: Integer
+
+    # @return [Starwars::Planet]
+    property :homeworld, class: Starwars::Planet, deserialize: ->(_, fragment, _) { Planet.new(url: fragment) }
+
+    # @return [Time]
+    property :created, type: Time
+    property :edited, type: Time
+
+    # @return [Array]
+    collection :films, class: Starwars::Film,  deserialize: ->(_, fragment, _) { Film.new(url: fragment) }
+    collection :species, class: Starwars::Specie,  deserialize: ->(_, fragment, _) { Specie.new(url: fragment) }
+    collection :vehicles, class: Starwars::Vehicle,  deserialize: ->(_, fragment, _) { Vehicle.new(url: fragment) }
+    collection :starships, class: Starwars::Starship,  deserialize: ->(_, fragment, _) { Starship.new(url: fragment) }
+  end
+end

data/lib/starwars/planet.rb

@@ -0,0 +1,37 @@
+module Starwars
+  #
+  # A Planet resource is a large mass, planet or planetoid in
+  # the Star Wars Universe, at the time of 0 ABY.
+  #
+  class Planet < Starwars::Base
+    #
+    # Define the source name in the starwars api
+    #
+    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
+end