spyke 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 568f2c2a6a67bcd64fd33bc1b4e06f4135e6da50
-  data.tar.gz: d676467ed8eef8d1b24401c0e52ddff9f9886570
+  metadata.gz: 351feb9aa7e6aa5486ac90bfee67db3088e1bba3
+  data.tar.gz: dce508b409ac67d45c30746a5608d3e0911d8475
 SHA512:
-  metadata.gz: edc4cffb4685b3811db353441e6a6889ea6acd3221da4b6adc9a8618c4069acd8a18c342a40bbc907b68f27d3e33add09acc0ef981bce6896af82606f6365319
-  data.tar.gz: 14349fc853de9b6e9c411d13ab373d2f6ceadaf201eb6a5317aeb6cf3901a5019a0e04021ab71e216d89a5d826d76d045d9dcbe6a13651141e625e27b3a66415
+  metadata.gz: cec924b0be7293242a30fd358de54aaa9c4d8357fccdc3dd5e1ba3b408f993d4b0d20fa9f81b57ff49fb8cbac7c43620a14d7ba0b5a35a7af505ecde76ac209b
+  data.tar.gz: 5507ca04b4f70ca3a2c5d6b624029c23409414ae14adcfbfd15e55576c6c6c670a0c59ea3817f2e2d77d693adc54ba337c17926840e9008d48e6c38c17459958

data/README.md

@@ -1,8 +1,14 @@
 # Spyke
 
-Spyke allows you to interact with remote REST services in an ActiveRecord-like manner.
+<p align="center">
+  <img src="http://upload.wikimedia.org/wikipedia/en/thumb/2/21/Spyke.jpg/392px-Spyke.jpg" width="20%" />
+  <br/>
+  Interact with remote <strong>REST services</strong> in an <strong>ActiveRecord-like</strong> manner.
+</p>
 
-It basically ~~rips off~~ takes inspiration :innocent: from [Her](https://github.com/remiprev/her), a gem which we sadly had to abandon as it showed significant performance problems and maintenance seemed to had gone stale. 
+---
+
+Spyke basically ~~rips off~~ takes inspiration :innocent: from [Her](https://github.com/remiprev/her), a gem which we sadly had to abandon as it showed significant performance problems and maintenance seemed to had gone stale.
 
 We therefore made Spyke which adds a few fixes/features that we needed for our projects:
 
@@ -37,12 +43,15 @@ class JSONParser < Faraday::Response::Middleware
       data: json[:result],
       metadata: json[:metadata]
     }
+  rescue MultiJson::ParseError => exception
+    { error: exception.cause }
   end
 end
 
 Spyke::Config.connection = Faraday.new(url: 'http://api.com') do |c|
-  c.use JSONParser
-  c.use Faraday::Adapter::NetHttp
+  c.request   :json
+  c.use       JSONParser
+  c.use       Faraday.default_adapter
 end
 ```
 
@@ -66,7 +75,7 @@ You can specify custom URIs on both the class and association level:
 ```ruby
 class User < Spyke::Base
   uri '/v1/users/:id'
-  
+
   has_one :image, uri: nil
   has_many :posts, uri: '/posts/for_user/:user_id'
 end
@@ -82,5 +91,5 @@ Post.find(4) # => GET http://api.com/posts/4
 
 ## Contributing
 
-If possible please take a look at the tests marked "wishlisted"! 
+If possible please take a look at the tests marked "wishlisted"!
 These are features/fixes we want to implement but haven't gotten around to doing yet :)

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spyke.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 3.0.0', '< 5.0'
   spec.add_dependency 'activemodel', '>= 3.0.0', '< 5.0'
   spec.add_dependency 'faraday', '>= 0.8.0', '< 2.0'
+  spec.add_dependency "faraday_middleware", '>= 0.9.1', '< 2.0'
   spec.add_dependency 'uri_template', '>= 0.7.0', '< 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "faraday_middleware"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-line"
   spec.add_development_dependency "minitest-reporters"

data/test/associations_test.rb

@@ -26,7 +26,7 @@ module Spyke
     end
 
     def test_embedded_associations
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { groups: [{ id: 1, name: 'Fish' }] })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { groups: [{ id: 1, name: 'Fish' }] })
 
       recipe = Recipe.find(1)
 
@@ -34,7 +34,7 @@ module Spyke
     end
 
     def test_nested_embedded_associtations
-      json = { data: { groups: [{ ingredients: [{ id: 1, name: 'Fish' }] }, { ingredients: [] }] } }
+      json = { result: { groups: [{ ingredients: [{ id: 1, name: 'Fish' }] }, { ingredients: [] }] } }
       stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(json)
 
       recipe = Recipe.find(1)
@@ -43,7 +43,7 @@ module Spyke
     end
 
     def test_singular_associtations
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { image: { url: 'bob.jpg' } })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { image: { url: 'bob.jpg' } })
 
       recipe = Recipe.find(1)
 
@@ -51,7 +51,7 @@ module Spyke
     end
 
     def test_unloaded_has_many_association
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/1/groups?public=true').to_return_json(data: [{ id: 1 }])
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/1/groups?public=true').to_return_json(result: [{ id: 1 }])
 
       groups = Recipe.new(id: 1).groups.where(public: true).to_a
 
@@ -60,7 +60,7 @@ module Spyke
     end
 
     def test_unloaded_has_one_association
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/1/image').to_return_json(data: { url: 'bob.jpg' })
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/1/image').to_return_json(result: { url: 'bob.jpg' })
 
       image = Recipe.new(id: 1).image
 
@@ -69,7 +69,7 @@ module Spyke
     end
 
     def test_array_like_behavior
-      stub_request(:get, 'http://sushi.com/recipes/1/groups').to_return_json(data: [{ name: 'Fish' }, { name: 'Fruit' }, { name: 'Bread' }])
+      stub_request(:get, 'http://sushi.com/recipes/1/groups').to_return_json(result: [{ name: 'Fish' }, { name: 'Fruit' }, { name: 'Bread' }])
 
       recipe = Recipe.new(id: 1)
 
@@ -138,7 +138,7 @@ module Spyke
     end
 
     def test_converting_association_to_ids
-      stub_request(:get, 'http://sushi.com/users/1/recipes').to_return_json(data: [{ id: 2 }])
+      stub_request(:get, 'http://sushi.com/users/1/recipes').to_return_json(result: [{ id: 2 }])
       user = User.new(id: 1)
       assert_equal [2], user.recipe_ids
     end
@@ -151,7 +151,7 @@ module Spyke
     end
 
     def test_custom_class_name
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { background_image: { url: 'bob.jpg' } })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { background_image: { url: 'bob.jpg' } })
 
       recipe = Recipe.find(1)
 
@@ -180,7 +180,7 @@ module Spyke
     end
 
     def test_create_association
-      endpoint = stub_request(:post, 'http://sushi.com/recipes/1/groups').with(body: { group: { title: 'Topping' } }).to_return_json(data: { title: 'Topping', id: 1, recipe_id: 1 })
+      endpoint = stub_request(:post, 'http://sushi.com/recipes/1/groups').with(body: { group: { title: 'Topping' } }).to_return_json(result: { title: 'Topping', id: 1, recipe_id: 1 })
 
       recipe = Recipe.new(id: 1)
       group = recipe.groups.create(title: 'Topping')
@@ -209,7 +209,7 @@ module Spyke
     end
 
     def test_save_association
-      endpoint = stub_request(:post, 'http://sushi.com/recipes/1/groups').with(body: { group: { title: 'Topping' } }).to_return_json(data: { title: 'Topping', recipe_id: 1 })
+      endpoint = stub_request(:post, 'http://sushi.com/recipes/1/groups').with(body: { group: { title: 'Topping' } }).to_return_json(result: { title: 'Topping', recipe_id: 1 })
 
       group = Recipe.new(id: 1).groups.build(title: 'Topping')
       group.save

data/test/attributes_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 module Spyke
   class AttributesTest < MiniTest::Test
     def test_predicate_methods
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1, title: 'Sushi' })
 
       recipe = Recipe.find(1)
 
@@ -12,7 +12,7 @@ module Spyke
     end
 
     def test_respond_to
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, serves: 3 })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1, serves: 3 })
 
       recipe = Recipe.find(1)
 

data/test/custom_request_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 module Spyke
   class CustomRequestTest < MiniTest::Test
     def test_custom_get_request_from_class
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(data: [{ id: 1, title: 'Bread' }])
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(result: [{ id: 1, title: 'Bread' }])
       assert_equal %w{ Bread }, Recipe.get('/recipes/recent').map(&:title)
       assert_requested endpoint
     end
@@ -23,7 +23,7 @@ module Spyke
     end
 
     def test_custom_get_request_from_class
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(data: [{ id: 1, title: 'Bread' }])
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(result: [{ id: 1, title: 'Bread' }])
       assert_equal %w{ Bread }, Recipe.get('/recipes/recent').map(&:title)
       assert_requested endpoint
     end
@@ -35,7 +35,7 @@ module Spyke
     end
 
     def test_custom_put_request_from_instance
-      endpoint = stub_request(:put, 'http://sushi.com/recipes/1/publish').to_return_json(data: { id: 1, status: 'published' })
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1/publish').to_return_json(result: { id: 1, status: 'published' })
       recipe = Recipe.new(id: 1, status: 'unpublished')
       recipe.put('/recipes/:id/publish')
 

data/test/orm_test.rb

@@ -3,8 +3,8 @@ require 'test_helper'
 module Spyke
   class OrmTest < MiniTest::Test
     def test_find
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
-      stub_request(:get, 'http://sushi.com/users/1').to_return_json(data: { id: 1, name: 'Bob' })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1, title: 'Sushi' })
+      stub_request(:get, 'http://sushi.com/users/1').to_return_json(result: { id: 1, name: 'Bob' })
 
       recipe = Recipe.find(1)
       user = User.find(1)
@@ -15,18 +15,18 @@ module Spyke
     end
 
     def test_reload
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1, title: 'Sushi' })
 
       recipe = Recipe.find(1)
       assert_equal 'Sushi', recipe.title
 
-      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sashimi' })
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1, title: 'Sashimi' })
       recipe.reload
       assert_equal 'Sashimi', recipe.title
     end
 
     def test_find_with_slug
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1 })
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(result: { id: 1 })
       Recipe.find('1-delicious-soup')
       assert_requested endpoint
     end
@@ -40,7 +40,7 @@ module Spyke
     end
 
     def test_save_new_record
-      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi (created)' })
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(result: { id: 1, title: 'Sushi (created)' })
 
       recipe = Recipe.new(title: 'Sushi')
       recipe.save
@@ -51,7 +51,7 @@ module Spyke
 
     def test_save_persisted_record
       stub_request(:put, /.*/)
-      endpoint = stub_request(:put, 'http://sushi.com/recipes/1').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi (saved)' })
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1').with(body: { recipe: { title: 'Sushi' } }).to_return_json(result: { id: 1, title: 'Sushi (saved)' })
 
       recipe = Recipe.new(id: 1, title: 'Sashimi')
       recipe.title = 'Sushi'
@@ -62,7 +62,7 @@ module Spyke
     end
 
     def test_create
-      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi' })
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(result: { id: 1, title: 'Sushi' })
 
       recipe = Recipe.create(title: 'Sushi')
 
@@ -71,7 +71,7 @@ module Spyke
     end
 
     def test_find_using_custom_uri_template
-      endpoint = stub_request(:get, 'http://sushi.com/images/photos/1').to_return_json(data: { id: 1 })
+      endpoint = stub_request(:get, 'http://sushi.com/images/photos/1').to_return_json(result: { id: 1 })
       Photo.find(1)
       assert_requested endpoint
     end

data/test/relation_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 module Spyke
   class RelationTest < MiniTest::Test
     def test_all
-      stub_request(:get, 'http://sushi.com/recipes').to_return_json(data: [{ id: 1, title: 'Sushi' }, { id: 2, title: 'Nigiri' }], metadata: 'meta')
+      stub_request(:get, 'http://sushi.com/recipes').to_return_json(result: [{ id: 1, title: 'Sushi' }, { id: 2, title: 'Nigiri' }], metadata: 'meta')
 
       recipes = Recipe.all
 

data/test/support/api.rb

@@ -1,6 +1,18 @@
 # Set up dummy api
+class JSONParser < Faraday::Response::Middleware
+  def parse(body)
+    json = MultiJson.load(body, symbolize_keys: true)
+    {
+      data: json[:result],
+      metadata: json[:metadata]
+    }
+  rescue MultiJson::ParseError => exception
+    { error: exception.cause }
+  end
+end
+
 Spyke::Config.connection = Faraday.new(url: 'http://sushi.com') do |faraday|
   faraday.request   :json
-  faraday.response  :json
+  faraday.use       JSONParser
   faraday.adapter   Faraday.default_adapter
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -71,12 +71,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: uri_template
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -86,38 +86,44 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: uri_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement