ultron 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d47f1ba2fff84cc647f4ea1111338e1ce5f20cf8
-  data.tar.gz: 8e1eeb250086219dd878d2186b36663d9ef9ccbd
+  metadata.gz: 69b914d9f16335035655a79ba254c6dddb28fdea
+  data.tar.gz: 99eaf8d276b7036e57376c2b9539032417c73600
 SHA512:
-  metadata.gz: d025340593662595b0838030cefc9cd3deb49887b8b4602a826e470b0cf65417d2f9b6e14021234b75d27946009b7ace33dd0f45bbd3f3e73c9d670a57ff8cae
-  data.tar.gz: be743c8d85ad0ffcea274f806618ace605fa9bf6e25d40154406ee7f8df1a38b09bff84dc4d626438b4cc88e8e871148bd3f81f21de5ab3c9445312229f9cd09
+  metadata.gz: 237d10bf3c136b2dd6433eb0b0703b328ae09f9b6c9811232f5e848b6f1e9dd8b31a00f8a20ea11d1c17da6ade53503e12be7fb1dd70ef63e60d2960ffcd1986
+  data.tar.gz: d6b43d18a54ae12ab359055153445f1b828a0ab760963e3cf1f52b575a6383631130dd6c7c7177ff4b7cdc1c43e26a3e7053283238b4172df7ba847c37821a5e

data/README.md

@@ -65,7 +65,7 @@ I've tried to follow the [Marvel API](http://developer.marvel.com/docs#!/public/
       comics.first.resourceURI.should == 'http://gateway.marvel.com/v1/public/comics/8268'
     end
     
-### Get a random item from a search
+### Get a random thing from a search
 
       it 'should give us a random comic', :vcr do
         set = Comics.by_character 1009610
@@ -79,14 +79,14 @@ I've tried to follow the [Marvel API](http://developer.marvel.com/docs#!/public/
         set.sample.title.should == 'Dazzler (1981) #19'
       end
     
-There's also some Noddy exception handling:
+## Exceptions
 
 ### Catch and re-raise a 404
 
-    it 'should throw a Not Found exception', :vcr do
+    it 'should throw a 404 (wrapped in a Marvel exception) on a 404', :vcr do
       begin
         comic = Comics.find 1000000 # there are not a million comics
-      rescue NotFoundException => e
+      rescue MarvelException => e
         e.code.should == 404
         e.status.should == "We couldn't find that comic_issue"
       end
@@ -94,10 +94,10 @@ There's also some Noddy exception handling:
     
 ### Raise a custom exception when no results are found
 
-    it 'should throw a No Results exception', :vcr do
+    it 'should throw an Ultron exception for something internal to Ultron', :vcr do
       begin
         comics = Comics.where offset: 1000000
-      rescue NoResultsException => e
-        e.status.should == 'That search returned no results'
+      rescue UltronException => e
+        e.status.should == 'The search returned no results'
       end
     end

data/config/ultron.yaml

@@ -1,2 +1,3 @@
 host: http://gateway.marvel.com
-path: /v1/public/
+path: /v1/public/
+api_docs: http://developer.marvel.com/docs

data/lib/ultron.rb

@@ -12,16 +12,15 @@ require 'ultron/auth'
 require 'ultron/config'
 require 'ultron/connection'
 
-require 'ultron/entities'
+require 'ultron/models/entities'
+require 'ultron/models/characters'
+require 'ultron/models/comics'
+require 'ultron/models/creators'
+require 'ultron/models/events'
+require 'ultron/models/series'
+require 'ultron/models/stories'
 
-require 'ultron/characters'
-require 'ultron/comics'
-require 'ultron/creators'
-require 'ultron/events'
-require 'ultron/series'
-require 'ultron/stories'
-
-require 'ultron/exceptions/not_found_exception'
-require 'ultron/exceptions/no_results_exception'
+require 'ultron/exceptions/marvel_exception'
+require 'ultron/exceptions/ultron_exception'
 
 require 'pry'

data/lib/ultron/connection.rb

@@ -9,10 +9,6 @@ module Ultron
           'User-agent' => 'Ultron v%s: https://rubygems.org/gems/ultron' % Ultron::VERSION
       }
 
-      if Config.instance.config['debug']
-        puts ">>> Hitting\n\t%s" % url
-      end
-
       c.perform
       JSON.parse c.body_str
     end

data/lib/ultron/exceptions/{not_found_exception.rb → marvel_exception.rb}

@@ -1,5 +1,5 @@
 module Ultron
-  class NotFoundException < Exception
+  class MarvelException < Exception
     attr_reader :code, :status
 
     def initialize params

data/lib/ultron/exceptions/{no_results_exception.rb → ultron_exception.rb}

@@ -1,5 +1,5 @@
 module Ultron
-  class NoResultsException < Exception
+  class UltronException < Exception
     attr_reader :status
 
     def initialize status

data/lib/ultron/{entities.rb → models/entities.rb}

@@ -1,49 +1,45 @@
 module Ultron
   class Entities
-    attr_reader :metadata
-
     include Enumerable
 
-    def self.name_for_path
-      self.name.split('::')[-1].downcase
-    end
-
-    def self.find id
-      path     = self.name_for_path
-      path     = '%s/%s' % [path, id]
-      url      = get_url path
-      response = Ultron::Connection.perform url
-      case response['code'].to_i
-        when 404
-          raise NotFoundException.new response
-
-        else
-          set = self.new response['data'], url
-          set.first
-      end
-    end
-
     def self.method_missing method_name, *args
       mname = method_name.to_s
       query = nil
       path  = self.name_for_path #if mname == 'get'
 
-      parts = mname.split /_and_/
-      parts.each do |part|
+      mname.split(/_and_/).each do |part|
         case part
+          when 'find'
+            path = '%s/%s' % [path, args.shift]
+
           when /by_(.*)/
             path = self.send(:by_something, $1, args.shift)
+
           when 'with', 'where'
-            query = self.send(:by_params, args[0])
+            query = self.send(:by_params, args.shift)
         end
       end
 
       url      = get_url path, query
+      response = self.response url
+
+      set = self.new response['data'], url
+      return set.first if mname == 'find'
+      set
+    end
+
+    def self.response url
       response = Ultron::Connection.perform url
-      unless response['data']['results'].any?
-        raise NoResultsException.new 'That search returned no results'
+      case response['code'].to_s
+        when /^4/
+          raise MarvelException.new response
+        when 'ResourceNotFound'
+          raise UltronException.new 'Resource does not exist. Check %s' % Config.instance.config.api_docs
       end
-      self.new response['data'], url
+
+      raise UltronException.new 'The search returned no results' unless response['data']['results'].any?
+
+      response
     end
 
     def self.by_something something, id
@@ -58,8 +54,14 @@ module Ultron
       "%s%s?%s%s" % [Ultron::Config.instance.root_url, path, query, Ultron.auth(ENV['PRIVATE_KEY'], ENV['PUBLIC_KEY'])]
     end
 
+    def self.name_for_path
+      self.name.split('::')[-1].downcase
+    end
+
     ###
 
+    attr_reader :metadata
+
     def initialize data, url
       @results_set = data['results']
       @metadata    = OpenStruct.new data

data/lib/ultron/version.rb

@@ -1,3 +1,3 @@
 module Ultron
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/cassettes/exceptions/should_throw_a_404_wrapped_in_a_Marvel_exception_on_a_404.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gateway.marvel.com/v1/public/comics/1000000?apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c&ts=1392317244
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - 'Ultron v0.1.3: https://rubygems.org/gems/ultron'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '57'
+      Date:
+      - Sat, 15 Feb 2014 20:59:00 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: "{\"code\":404,\"status\":\"We couldn't find that comic_issue\"}"
+    http_version: 
+  recorded_at: Thu, 13 Feb 2014 18:47:24 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/exceptions/should_throw_a_Marvel_exception_on_an_API_error.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gateway.marvel.com/v1/public/comics/1000000?apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c&ts=1392317244
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - 'Ultron v0.1.3: https://rubygems.org/gems/ultron'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '57'
+      Date:
+      - Sat, 15 Feb 2014 20:34:41 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: "{\"code\":404,\"status\":\"We couldn't find that comic_issue\"}"
+    http_version: 
+  recorded_at: Thu, 13 Feb 2014 18:47:24 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/exceptions/should_throw_a_No_Idea_What_This_Param_Is_exception.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gateway.marvel.com/v1/public/characters?Thor=Mighty&apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c&ts=1392317244
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - 'Ultron v0.1.3: https://rubygems.org/gems/ultron'
+  response:
+    status:
+      code: 409
+      message: Conflict
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '61'
+      Date:
+      - Sat, 15 Feb 2014 20:57:47 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: "{\"code\":409,\"status\":\"We don't recognize the parameter Thor\"}"
+    http_version: 
+  recorded_at: Thu, 13 Feb 2014 18:47:24 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/exceptions/should_throw_a_Resource_Not_Found_exception_when_we_search_for_something_non-sensical.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gateway.marvel.com/v1/public/creators/186/characters?apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c&ts=1392317244
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - 'Ultron v0.1.3: https://rubygems.org/gems/ultron'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '181'
+      Date:
+      - Sat, 15 Feb 2014 21:03:27 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: "{\"code\":\"ResourceNotFound\",\"message\":\"/v1/public/creators/186/characters?ts=1392317244&apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c
+        does not exist\"}"
+    http_version: 
+  recorded_at: Thu, 13 Feb 2014 18:47:24 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/exceptions/should_throw_an_Ultron_exception_for_something_internal_to_Ultron.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gateway.marvel.com/v1/public/comics?apikey=<PUBLIC_KEY>&hash=a304d29c7e65217654f6ddd18daf2b3c&offset=1000000&ts=1392317244
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - 'Ultron v0.1.3: https://rubygems.org/gems/ultron'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Etag:
+      - c6221500e62a7317e759c6bd37130ee5c62c0cba
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '150'
+      Date:
+      - Sat, 15 Feb 2014 20:34:41 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: "{\"code\":200,\"status\":\"Ok\",\"etag\":\"c6221500e62a7317e759c6bd37130ee5c62c0cba\",\"data\":{\"offset\":1000000,\"limit\":20,\"total\":31917,\"count\":0,\"results\":[]}}"
+    http_version: 
+  recorded_at: Thu, 13 Feb 2014 18:47:24 GMT
+recorded_with: VCR 2.8.0

data/spec/ultron/exceptions_spec.rb

@@ -6,24 +6,39 @@ module Ultron
       Timecop.freeze '2014-02-13T18:47:24+00:00'
     end
 
-    it 'should throw a Not Found exception', :vcr do
+    it 'should throw a 404 (wrapped in a Marvel exception) on a 404', :vcr do
       begin
         comic = Comics.find 1000000 # there are not a million comics
-      rescue NotFoundException => e
+      rescue MarvelException => e
         e.code.should == 404
         e.status.should == "We couldn't find that comic_issue"
       end
     end
 
-    it 'should throw a No Results exception', :vcr do
+    it 'should throw a No Idea What This Param Is exception', :vcr do
+      begin
+        character = Characters.where Thor: 'Mighty'
+      rescue MarvelException => e
+        e.code.should == 409
+        e.status.should == "We don't recognize the parameter Thor"
+      end
+    end
+
+    it 'should throw an Ultron exception for something internal to Ultron', :vcr do
       begin
         comics = Comics.where offset: 1000000
-      rescue NoResultsException => e
-        e.status.should == 'That search returned no results'
+      rescue UltronException => e
+        e.status.should == 'The search returned no results'
       end
     end
 
-    it 'should throw a No Idea What This Param Is exception'
+    it 'should throw a Resource Not Found exception when we search for something nonsensical', :vcr do
+      begin
+        characters = Characters.by_creator 186 # characters by creator is a nonsense concept in the Marvel API
+      rescue UltronException => e
+        e.status.should == 'Resource does not exist. Check http://developer.marvel.com/docs'
+      end
+    end
 
     after :each do
       Timecop.return

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultron
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - pikesley
@@ -263,22 +263,21 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- config/params.yaml
 - config/ultron.yaml
 - examples/links.rb
 - lib/ultron.rb
 - lib/ultron/auth.rb
-- lib/ultron/characters.rb
-- lib/ultron/comics.rb
 - lib/ultron/config.rb
 - lib/ultron/connection.rb
-- lib/ultron/creators.rb
-- lib/ultron/entities.rb
-- lib/ultron/events.rb
-- lib/ultron/exceptions/no_results_exception.rb
-- lib/ultron/exceptions/not_found_exception.rb
-- lib/ultron/series.rb
-- lib/ultron/stories.rb
+- lib/ultron/exceptions/marvel_exception.rb
+- lib/ultron/exceptions/ultron_exception.rb
+- lib/ultron/models/characters.rb
+- lib/ultron/models/comics.rb
+- lib/ultron/models/creators.rb
+- lib/ultron/models/entities.rb
+- lib/ultron/models/events.rb
+- lib/ultron/models/series.rb
+- lib/ultron/models/stories.rb
 - lib/ultron/version.rb
 - spec/cassettes/Ultron_Characters/find_a_character.yml
 - spec/cassettes/Ultron_Characters/should_find_a_character.yml
@@ -293,8 +292,13 @@ files:
 - spec/cassettes/Ultron_Series/should_give_a_default_set_of_series.yml
 - spec/cassettes/Ultron_Series/should_let_us_reuse_the_connection_safely.yml
 - spec/cassettes/Ultron_Series/should_let_us_search_with_parameters.yml
+- spec/cassettes/exceptions/should_throw_a_404_wrapped_in_a_Marvel_exception_on_a_404.yml
+- spec/cassettes/exceptions/should_throw_a_Marvel_exception_on_an_API_error.yml
+- spec/cassettes/exceptions/should_throw_a_No_Idea_What_This_Param_Is_exception.yml
 - spec/cassettes/exceptions/should_throw_a_No_Results_exception.yml
 - spec/cassettes/exceptions/should_throw_a_Not_Found_exception.yml
+- spec/cassettes/exceptions/should_throw_a_Resource_Not_Found_exception_when_we_search_for_something_non-sensical.yml
+- spec/cassettes/exceptions/should_throw_an_Ultron_exception_for_something_internal_to_Ultron.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_get_a_count_of_items_for_a_lookup.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_give_us_a_random_comic.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_give_us_a_random_comic_for_a_more_complex_search.yml
@@ -368,8 +372,13 @@ test_files:
 - spec/cassettes/Ultron_Series/should_give_a_default_set_of_series.yml
 - spec/cassettes/Ultron_Series/should_let_us_reuse_the_connection_safely.yml
 - spec/cassettes/Ultron_Series/should_let_us_search_with_parameters.yml
+- spec/cassettes/exceptions/should_throw_a_404_wrapped_in_a_Marvel_exception_on_a_404.yml
+- spec/cassettes/exceptions/should_throw_a_Marvel_exception_on_an_API_error.yml
+- spec/cassettes/exceptions/should_throw_a_No_Idea_What_This_Param_Is_exception.yml
 - spec/cassettes/exceptions/should_throw_a_No_Results_exception.yml
 - spec/cassettes/exceptions/should_throw_a_Not_Found_exception.yml
+- spec/cassettes/exceptions/should_throw_a_Resource_Not_Found_exception_when_we_search_for_something_non-sensical.yml
+- spec/cassettes/exceptions/should_throw_an_Ultron_exception_for_something_internal_to_Ultron.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_get_a_count_of_items_for_a_lookup.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_give_us_a_random_comic.yml
 - spec/cassettes/sample/let_us_pick_a_random_item/should_give_us_a_random_comic_for_a_more_complex_search.yml