red5 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cc0bb9c1ac63bfe093999941d97cc3c23669dde
-  data.tar.gz: e637e3d181140613b101c1f3cad14380fc5c0e04
+  metadata.gz: d84a79a3bcb4b6cca90a470703d6dca96f67c080
+  data.tar.gz: 203496fc2fd5b6590d8cb20fd75bd2aeb28f2319
 SHA512:
-  metadata.gz: ec3efe49f6f54dfe101d859670c9fce2d55d0a73b2f7378a5e3461fc34ffe8092070746edaaf17955d2d83b4cdfe6ef56d9531c413ba71b305379e42aa68e305
-  data.tar.gz: faee78ecede73f6f88cfaf3fbda81c92eb322da9cb0b665dfd13b254333ff519d13497f2867ccdcaffa0a077961c9ce11b915d78718d46aa1506abb38392d17d
+  metadata.gz: df3ef0cb1d6a0a11dd16dfff9267fbb9d684009e22f26617eca62272ef3a4d90501bc1d29d8c83fe3735954544da149ddbde5ff045ea1331afb8ca36a84f93a7
+  data.tar.gz: 7931602b478f9b31dbccfeaf02bdcdc3da19345c8a998913f3ab556bc46e21ffe3d4c060b68ccd5f01976cf8874ca003ad574380ef337dcdeb742e525d1873f5

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/README.md

@@ -1,10 +1,64 @@
 [![Build Status](https://travis-ci.org/pikesley/red5.svg)](https://travis-ci.org/pikesley/red5)
 [![Dependency Status](http://img.shields.io/gemnasium/pikesley/red5.svg)](https://gemnasium.com/pikesley/red5)
+[![Coverage Status](http://img.shields.io/coveralls/pikesley/red5.svg)](https://coveralls.io/r/pikesley/red5)
 [![Code Climate](http://img.shields.io/codeclimate/github/pikesley/red5.svg)](https://codeclimate.com/github/pikesley/red5)
 [![Gem Version](http://img.shields.io/gem/v/red5.svg)](https://rubygems.org/gems/red5)
 [![License](http://img.shields.io/:license-mit-blue.svg)](http://pikesley.mit-license.org)
-[![Badges](http://img.shields.io/:badges-6/6-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)
+[![Badges](http://img.shields.io/:badges-7/7-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)
 
 # Red5
 
 Ruby bindings for the [Star Wars API](http://swapi.co)
+
+    git clone https://github.com/pikesley/red5
+    cd red5
+    bundle
+    rake
+
+or just
+
+    gem install red5
+
+##API
+
+I've followed the [Star Wars API](http://swapi.co/documentation#intro) as closely as I can. It's probably best illustrated with some examples from the [specs](https://github.com/pikesley/red5/tree/master/spec):
+
+###Get a thing
+
+    it 'finds a particular film', :vcr do
+      film = Films.find 1
+      expect(film['title']).to eq 'A New Hope'
+      expect(film['episode_id']).to eq 4
+    end
+
+###Fetch the thing linked to by an attribute
+
+    it 'fetches the species for a person', :vcr do
+      person = People.find 15 # Greedo
+      expect(person.fetch_species[0]['name']).to eq 'Rodian'
+    end
+
+##Exceptions
+
+###Raise an exception on a 404
+
+    it 'raises an exception on a non-existent thing', :vcr do
+      expect{ Starships.find 999 }.to raise_exception do |exception|
+        expect(exception).to be_a Red5Exception
+        expect(exception.status).to eq 'Starship #999 does not exist'
+      end
+    end
+
+###Raise an exception on a bogus lookup
+
+    it 'raises an exception on a bogus lookup', :vcr do
+      person = People.find 19
+      expect{ person['favourite_food'] }. to raise_exception do |exception|
+        expect(exception).to be_a Red5Exception
+        expect(exception.status).to eq 'No such attribute favourite_food'
+      end
+    end
+
+##Further work
+
+This seems to cover the basics, what else should it do?

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
 
 RSpec::Core::RakeTask.new
+Coveralls::RakeTask.new
 
-task :default => [:spec]
+task :default => [:spec, 'coveralls:push']

data/lib/red_5.rb

@@ -0,0 +1,19 @@
+require 'rest_client'
+require 'json'
+require 'active_support/core_ext/string'
+
+require 'red_5/version'
+
+require 'red_5/helpers'
+
+require 'red_5/root'
+require 'red_5/models/entities'
+
+require 'red_5/models/films'
+require 'red_5/models/people'
+require 'red_5/models/planets'
+require 'red_5/models/species'
+require 'red_5/models/starships'
+require 'red_5/models/vehicles'
+
+require 'red_5/exceptions/red_5_exception'

data/lib/red_5/exceptions/red_5_exception.rb

@@ -0,0 +1,9 @@
+module Red5
+  class Red5Exception < Exception
+    attr_reader :status
+
+    def initialize status
+      @status = status
+    end
+  end
+end

data/lib/red_5/helpers.rb

@@ -0,0 +1,8 @@
+module Red5
+  def self.fetch_results url
+    r = RestClient::Resource.new url
+    b = r.get.body
+    j = JSON.parse b
+    j
+  end
+end

data/lib/red_5/models/entities.rb

@@ -0,0 +1,54 @@
+module Red5
+  class Entities
+    def self.find id
+      basename = self.name.split('::').last
+      slug = basename.downcase
+      resource = RestClient::Resource.new "http://swapi.co/api/#{slug}/#{id}"
+
+      begin
+        self.new JSON.parse resource.get.body
+      rescue RestClient::ResourceNotFound
+        id = "##{id}" if id.is_a? Numeric
+        raise Red5Exception.new "#{basename.singularize} #{id} does not exist"
+      end
+    end
+
+    def self.first
+      self.find 1
+    end
+
+    def initialize data
+      @data = data
+      @data['id'] = @data['url'].split('/').last.to_i
+    end
+
+    def [] key
+      @data[key] || raise(Red5Exception.new "No such attribute #{key}")
+    end
+
+    def method_missing method_name, *args
+      mname = method_name.to_s
+      parts = mname.split('_')
+
+      case parts[0]
+        when 'fetch'
+          key = parts[1]
+          url = self[key]
+
+          unless url.is_a? Array
+            expects_single_result = true
+            url = [url]
+          end
+
+          results = []
+          url.each do |u|
+            results.push Red5.fetch_results u
+          end
+
+          return results.first if expects_single_result
+          results
+
+      end
+    end
+  end
+end

data/lib/{red5 → red_5/models}/films.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Films < Entities
   end
 end

data/lib/{red5 → red_5/models}/people.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class People < Entities
   end
 end

data/lib/{red5 → red_5/models}/planets.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Planets < Entities
   end
 end

data/lib/{red5 → red_5/models}/species.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Species < Entities
   end
 end

data/lib/{red5 → red_5/models}/starships.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Starships < Entities
   end
 end

data/lib/{red5 → red_5/models}/vehicles.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Vehicles < Entities
   end
 end

data/lib/{red5 → red_5}/root.rb

@@ -1,4 +1,4 @@
-module Red_5
+module Red5
   class Root
     def self.all
       resource = RestClient::Resource.new "http://swapi.co/api/"

data/lib/red_5/version.rb

@@ -0,0 +1,3 @@
+module Red5
+  VERSION = "0.0.3"
+end

data/red5.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'red5/version'
+require 'red_5/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'red5'
@@ -19,12 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rest_client', '~> 1.8'
+  spec.add_dependency 'activesupport', '~> 4.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'guard', '~> 2.10'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6'
   spec.add_development_dependency 'vcr',  '~> 2.9'
   spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
 end

data/spec/cassettes/Failure/404s/raises_an_exception_on_a_ludicrous_request.yml

@@ -0,0 +1,96 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://swapi.co/api/starships/lolwut
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 301
+      message: MOVED PERMANENTLY
+    headers:
+      Date:
+      - Tue, 23 Dec 2014 14:22:11 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=df0a1ed34ef460f4111eea44ea9cff8401419344531; expires=Wed, 23-Dec-15
+        14:22:11 GMT; path=/; domain=.swapi.co; HttpOnly
+      Location:
+      - http://swapi.co/api/starships/lolwut/
+      X-Frame-Options:
+      - SAMEORIGIN
+      Via:
+      - 1.1 vegur
+      Server:
+      - cloudflare-nginx
+      Cf-Ray:
+      - 19d535b8a00a0a78-LHR
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Tue, 23 Dec 2014 14:22:11 GMT
+- request:
+    method: get
+    uri: http://swapi.co/api/starships/lolwut/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Cookie:
+      - __cfduid=df0a1ed34ef460f4111eea44ea9cff8401419344531; domain=.swapi.co
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: NOT FOUND
+    headers:
+      Date:
+      - Tue, 23 Dec 2014 14:22:11 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, HEAD, OPTIONS
+      Vary:
+      - Accept, Cookie
+      Via:
+      - 1.1 vegur
+      Server:
+      - cloudflare-nginx
+      Cf-Ray:
+      - 19d535b95fb30a78-LHR
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6pWSkktSczMUbJS8ssvUUjLL81LUaoFAAAA//8DAN21v3kW
+        AAAA
+    http_version: 
+  recorded_at: Tue, 23 Dec 2014 14:22:11 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/Failure/404s/raises_an_exception_on_a_non-existent_thing.yml

@@ -0,0 +1,96 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://swapi.co/api/starships/999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 301
+      message: MOVED PERMANENTLY
+    headers:
+      Date:
+      - Tue, 23 Dec 2014 14:22:10 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d746f256c535edd7334a2751938b9a4a71419344530; expires=Wed, 23-Dec-15
+        14:22:10 GMT; path=/; domain=.swapi.co; HttpOnly
+      Location:
+      - http://swapi.co/api/starships/999/
+      X-Frame-Options:
+      - SAMEORIGIN
+      Via:
+      - 1.1 vegur
+      Server:
+      - cloudflare-nginx
+      Cf-Ray:
+      - 19d535b39fe90a78-LHR
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Tue, 23 Dec 2014 14:22:10 GMT
+- request:
+    method: get
+    uri: http://swapi.co/api/starships/999/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Cookie:
+      - __cfduid=d746f256c535edd7334a2751938b9a4a71419344530; domain=.swapi.co
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: NOT FOUND
+    headers:
+      Date:
+      - Tue, 23 Dec 2014 14:22:11 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, HEAD, OPTIONS
+      Vary:
+      - Accept, Cookie
+      Via:
+      - 1.1 vegur
+      Server:
+      - cloudflare-nginx
+      Cf-Ray:
+      - 19d535b58f9b0a78-LHR
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6pWSkktSczMUbJS8ssvUUjLL81LUaoFAAAA//8DAN21v3kW
+        AAAA
+    http_version: 
+  recorded_at: Tue, 23 Dec 2014 14:22:11 GMT
+recorded_with: VCR 2.9.3