spyke 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bb23a4da9d9143ff6f62b5887a54b0244746be8
-  data.tar.gz: 926010cb42bae7510da165fa4c94cc69dbe96faa
+  metadata.gz: aae9497db570bde9804ea90d14418f739aa9b739
+  data.tar.gz: 33ded16c0322550c0694cbc36f6a64ca6b46ce6f
 SHA512:
-  metadata.gz: 8a5ca662137935d28cd46ebe4fda3ca44a0158edde6c1d658f1a7195445a565626d393abb571d448564cee4910b75d9a477789b81b521591e56be0edac270267
-  data.tar.gz: 87ba21f060e68307b1aaf49386d180e2a511a5a5d8b4af9a68bd1f82ad9a585b4bb5760ea17e674d21a60e2e5260e4aaeaaa7702877cf14e0087b2d985fbee82
+  metadata.gz: bcaf128e92e898c6036b080afc1a8ae73b328bf17c5dfa2c4480dff9a9e38038a58792aa7fc6beacf3a3bba3f6a7f5d962602ba113e26675939851cfc25e14c6
+  data.tar.gz: 2ed6ec2a7c5cb0203d78fde3addde56192f72777a2387695b92944caca91ea70cb68eb0d8646cce4e0d00f1d1b57ad0486cd743b0be34e48a2250044f0999986

data/README.md

@@ -22,6 +22,7 @@ We therefore made Spyke which adds a few fixes/features needed for our projects:
 - Proper support for scopes
 - Ability to define custom URIs for associations
 - ActiveRecord-like log output
+- Handling of server side validations
 - Googlable name! :)
 
 ## Configuration
@@ -41,7 +42,7 @@ Spyke uses Faraday to handle requests and expects it to parse the response body
 So, for example for an API that returns JSON in the following format:
 
 ```json
-{ "result": { "id": 1, "name": "Bob" }, "metadata": {}, "message": "" }
+{ "result": { "id": 1, "name": "Bob" }, "extra": {}, "errors": {} }
 ```
 
 ...the simplest possible configuration that could work is something like this:
@@ -54,11 +55,11 @@ class JSONParser < Faraday::Response::Middleware
     json = MultiJson.load(body, symbolize_keys: true)
     {
       data: json[:result],
-      metadata: json[:metadata],
-      errors: [json[:message]]
+      metadata: json[:extra],
+      errors: json[:errors]
     }
   rescue MultiJson::ParseError => exception
-    { errors: [exception.cause] }
+    { errors: { base: [ error: exception.message ] } }
   end
 end
 
@@ -139,6 +140,20 @@ Processing by PostsController#index as HTML
 Completed 200 OK in 75ms (Views: 64.6ms | Spyke: 40.3ms | ActiveRecord: 0ms)
 ```
 
+### Server-side validations
+
+Spyke expects errors to be formatted in the same way as the
+ActiveModel::Errors hash, ie:
+
+```ruby
+{ title: [{ error: 'blank'}, { error: 'too_short', count: 10 }]}
+```
+
+If the API you're using returns errors in a different format you can
+remap it in Faraday to match the above. Doing this will allow you to
+show errors returned from the server in forms and f.ex using
+`@post.errors.full_messages` just like ActiveRecord.
+
 ## Contributing
 
 If possible please take a look at the [tests marked "wishlisted"](https://github.com/balvig/spyke/search?utf8=%E2%9C%93&q=wishlisted)!

data/lib/spyke/base.rb

@@ -9,12 +9,7 @@ require 'spyke/scoping'
 module Spyke
   class Base
     # ActiveModel
-    include ActiveModel::Conversion
     include ActiveModel::Model
-    include ActiveModel::Validations
-    include ActiveModel::Validations::Callbacks
-    extend ActiveModel::Translation
-    extend ActiveModel::Callbacks
 
     # Spyke
     include Associations

data/lib/spyke/http.rb

@@ -66,7 +66,7 @@ module Spyke
 
         result = self.class.send("#{method}_raw", path, params)
 
-        result.errors.each { |error| errors.add(:base, error) }
+        add_errors_to_model(result.errors)
         self.attributes = result.data
       end
     end
@@ -77,6 +77,15 @@ module Spyke
 
     private
 
+      def add_errors_to_model(errors_hash)
+        errors_hash.each do |field, field_errors|
+          field_errors.each do |attributes|
+            error_name = attributes.delete(:error).to_sym
+            errors.add(field.to_sym, error_name, attributes.symbolize_keys)
+          end
+        end
+      end
+
       def resolve_path_from_action(action)
         case action
         when Symbol then uri.join(action)

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.7.2'
+  VERSION = '1.8.0'
 end

data/test/orm_test.rb

@@ -79,13 +79,13 @@ module Spyke
       assert_requested endpoint
     end
 
-    def test_create_with_server_failure
-      endpoint = stub_request(:put, 'http://sushi.com/recipes/1').to_return_json(id: 'write_error:400', message: 'Unable to save recipe')
+    def test_create_with_server_returning_validation_errors
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1').to_return_json(id: 'write_error:400', errors: { title: [{ error: 'too_short', count: 4 }] })
 
-      recipe = Recipe.create(id: 1, title: 'Sushi')
+      recipe = Recipe.create(id: 1, title: 'sus')
 
-      assert_equal 'Sushi', recipe.title
-      assert_equal ['Unable to save recipe'], recipe.errors[:base]
+      assert_equal 'sus', recipe.title
+      assert_equal ['Title is too short (minimum is 4 characters)'], recipe.errors.full_messages
       assert_requested endpoint
     end
 
@@ -146,10 +146,5 @@ module Spyke
       RecipeImage.where(recipe_id: 1).destroy
       assert_requested endpoint
     end
-
-    def test_validations
-      assert_equal false, RecipeImage.new.valid?
-      assert_equal true, RecipeImage.new(url: 'bob.jpg').valid?
-    end
   end
 end

data/test/support/api.rb

@@ -5,10 +5,10 @@ class JSONParser < Faraday::Response::Middleware
     {
       data: json[:result],
       metadata: json[:metadata],
-      errors: [json[:message]]
+      errors: json[:errors]
     }
   rescue MultiJson::ParseError => exception
-    { errors: [exception.cause] }
+    { errors: { base: [ error: exception.message ] } }
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport