her 0.5.2 → 0.5.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDM1MWIwOWZmYThlZjA5YTJlMzdlZDM3MDQzMjg5ZGNlOTVhOGYxMQ==
+    MmIxMjIyZWU2NTIyOTdmZDdlNzU2MjBiM2NlNDU2MmFhMjJlNzVhNQ==
   data.tar.gz: !binary |-
-    ODgwMDMwMDM3M2MyZTdjN2YwZDBhMDlhMDJlZTY5MzcwZTVhMjVjNQ==
+    MDJmNTM0YzI1ZmY1OTM3NDM4NTczNDYxNWZjOWI0NjU1NzNlYzY2Mg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OGIyY2JkM2Y5OTI4NzdmZDk5OTE2ZGM4OWU4ZTM3MTYzOWNhMGRlOWZlNTc4
-    ZTcxODBmYzMxYjdmNDJkNGFhZDc0NGQzZGE3ODU0NTE4ODliYjQ4MTIyMGJi
-    NjBjMTE3ZGE1ZDM5Y2QwYWVjNTgwZDQxOGRkNDc0OTRhYzA2YjQ=
+    M2Q3MDc2NWJmNDI1NDM3Y2M1YjNkNjgwN2JlMWY3M2M5ZjhmYWZmMTY4Njdk
+    MzViMjE0NDY1ZDlmOTNkNzBkNWI1MzgwNWFmYWYyM2YzOWE3YTE5YjcyZTg4
+    YzM5ZWZkMDFjODBjMjBlN2Q0MDBiNDI5MzYyYWNhODZlZDQzNDU=
   data.tar.gz: !binary |-
-    M2ZlYmU3ZGE5ZjBkNDkxYjgyZWFlZmM4OWEyYjMxYzYzMmI1ODAyOTFhMmM1
-    ZDk0ZDA1YWUxODY2NGIzZDEwMTdiODQ5MWJkN2NlYjFlMTc5YjAxZmVkYzY1
-    NjY3YWY4NGIyNGFkNzMxNmZmY2E2YmJkOTIyNWZjMjU3MjZhNTE=
+    YWJmZDEwMzlhMzkxZWJlMDZjOTZlZDRkNzM4MTMyZDBlZTlkZmM1NWUzOTMz
+    YWFkMjBlNjgzY2U2ZWQxYTg3ZThlODZkMGVkOWU3MzVjNTU2ODc5ZjYyMGQ2
+    YzJkNWFhYjRiY2EzZGI1YzE1OGQ5YzJkYzVjYTY0MWJiYjBmNmQ=

data/README.md

@@ -296,16 +296,14 @@ If there’s association data in the resource, no extra HTTP request is made whe
 ```ruby
 @user = User.find(1)
 # {
-#   :data => {
-#     :id => 1,
-#     :name => "George Michael Bluth",
-#     :comments => [
-#       { :id => 1, :text => "Foo" },
-#       { :id => 2, :text => "Bar" }
-#     ],
-#     :role => { :id => 1, :name => "Admin" },
-#     :organization => { :id => 2, :name => "Bluth Company" }
-#   }
+#   :id => 1,
+#   :name => "George Michael Bluth",
+#   :comments => [
+#     { :id => 1, :text => "Foo" },
+#     { :id => 2, :text => "Bar" }
+#   ],
+#   :role => { :id => 1, :name => "Admin" },
+#   :organization => { :id => 2, :name => "Bluth Company" }
 # }
 @user.comments
 # [#<Comment id=1 text="Foo">, #<Comment id=2 text="Bar">]
@@ -319,7 +317,7 @@ If there’s no association data in the resource, Her makes a HTTP request to re
 
 ```ruby
 @user = User.find(1)
-# { :data => { :id => 1, :name => "George Michael Bluth", :organization_id => 2 }}
+# { :id => 1, :name => "George Michael Bluth", :organization_id => 2 }
 
 # has_many association:
 @user.comments
@@ -340,6 +338,28 @@ If there’s no association data in the resource, Her makes a HTTP request to re
 
 Subsequent calls to `#comments`, `#role` and `#organization` will not trigger extra HTTP requests and will return the cached objects.
 
+#### Notes about paths
+
+Resources must always have all the required attributes to build their complete path. For example, if you have these models:
+
+```ruby
+class User
+  include Her::Model
+  collection_path "organizations/:organization_id/users"
+end
+
+class Organization
+  include Her::Model
+  has_many :users
+end
+```
+
+Her expects all `User` resources to have an `:organization_id` (or `:_organization_id`) attribute. Otherwise, calling mostly all methods, like `User.all`, will thrown an exception like this one:
+
+```ruby
+Her::Errors::PathError: Missing :_organization_id parameter to build the request path. Path is `organizations/:organization_id/users`. Parameters are `{ … }`.
+```
+
 ### Validations
 
 Her includes `ActiveModel::Validations` so you can declare validations the same way you do in Rails.

data/lib/her/errors.rb

@@ -2,5 +2,6 @@ module Her
   module Errors
     class PathError < StandardError; end;
     class AssociationUnknownError < StandardError; end;
+    class ParseError < StandardError; end;
   end
 end

data/lib/her/middleware.rb

@@ -1,3 +1,4 @@
+require "her/middleware/parse_json"
 require "her/middleware/first_level_parse_json"
 require "her/middleware/second_level_parse_json"
 require "her/middleware/accept_json"

data/lib/her/middleware/first_level_parse_json.rb

@@ -1,15 +1,15 @@
 module Her
   module Middleware
     # This middleware treat the received first-level JSON structure as the resource data.
-    class FirstLevelParseJSON < Faraday::Response::Middleware
+    class FirstLevelParseJSON < ParseJSON
       # Parse the response body
       #
       # @param [String] body The response body
       # @return [Mixed] the parsed response
       def parse(body)
-        json = MultiJson.load(body, :symbolize_keys => true)
+        json = parse_json(body)
         errors = json.delete(:errors) || {}
-        metadata = json.delete(:metadata) || []
+        metadata = json.delete(:metadata) || {}
         {
           :data => json,
           :errors => errors,
@@ -22,11 +22,11 @@ module Her
       #
       # @param [Hash] env The response environment
       def on_complete(env)
-        case env[:status]
+        env[:body] = case env[:status]
         when 204
-          env[:body] = parse('{}')
+          parse('{}')
         else
-          env[:body] = parse(env[:body])
+          parse(env[:body])
         end
       end
     end

data/lib/her/middleware/parse_json.rb

@@ -0,0 +1,20 @@
+module Her
+  module Middleware
+    class ParseJSON < Faraday::Response::Middleware
+      def parse_json(body = nil)
+        body ||= '{}'
+        message = "Response from the API must behave like a Hash or an Array (last JSON response was #{body.inspect})"
+
+        json = begin
+          MultiJson.load(body, :symbolize_keys => true)
+        rescue MultiJson::LoadError
+          raise Her::Errors::ParseError, message
+        end
+
+        raise Her::Errors::ParseError, message unless json.is_a?(Hash) or json.is_a?(Array)
+
+        json
+      end
+    end
+  end
+end

data/lib/her/middleware/second_level_parse_json.rb

@@ -2,13 +2,14 @@ module Her
   module Middleware
     # This middleware expects the resource/collection data to be contained in the `data`
     # key of the JSON object
-    class SecondLevelParseJSON < Faraday::Response::Middleware
+    class SecondLevelParseJSON < ParseJSON
       # Parse the response body
       #
       # @param [String] body The response body
       # @return [Mixed] the parsed response
       def parse(body)
-        json = MultiJson.load(body, :symbolize_keys => true)
+        json = parse_json(body)
+
         {
           :data => json[:data],
           :errors => json[:errors],
@@ -21,7 +22,12 @@ module Her
       #
       # @param [Hash] env The response environment
       def on_complete(env)
-        env[:body] = parse(env[:body])
+        env[:body] = case env[:status]
+        when 204
+          parse('{}')
+        else
+          parse(env[:body])
+        end
       end
     end
   end

data/lib/her/model/orm.rb

@@ -265,7 +265,7 @@ module Her
             resource = nil
             request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data, response|
               if response.success?
-                resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
+                resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
                 resource.run_callbacks :find
               else
                 return nil

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/spec/middleware/first_level_parse_json_spec.rb

@@ -5,6 +5,9 @@ describe Her::Middleware::FirstLevelParseJSON do
   subject { described_class.new }
   let(:body_without_errors) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"metadata\": 3}" }
   let(:body_with_errors) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"errors\": { \"name\": [ \"not_valid\", \"should_be_present\" ] }, \"metadata\": 3}" }
+  let(:body_with_malformed_json) { "wut." }
+  let(:body_with_invalid_json) { "true" }
+  let(:nil_body) { nil }
 
   it "parses body as json" do
     subject.parse(body_without_errors).tap do |json|
@@ -30,6 +33,18 @@ describe Her::Middleware::FirstLevelParseJSON do
     subject.parse(body_with_errors)[:errors].should eq({:name => [ 'not_valid', 'should_be_present']})
   end
 
+  it 'ensures that malformed JSON throws an exception' do
+    expect { subject.parse(body_with_malformed_json) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "wut.")')
+  end
+
+  it 'ensures that invalid JSON throws an exception' do
+    expect { subject.parse(body_with_invalid_json) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "true")')
+  end
+
+  it 'ensures that a nil response returns an empty hash' do
+    subject.parse(nil_body)[:data].should eq({})
+  end
+
   context 'with status code 204' do
     it 'returns an empty body' do
       env = { :status => 204 }

data/spec/middleware/second_level_parse_json_spec.rb

@@ -3,23 +3,33 @@ require "spec_helper"
 
 describe Her::Middleware::SecondLevelParseJSON do
   subject { described_class.new }
-  let(:body) { "{\"data\": 1, \"errors\": 2, \"metadata\": 3}" }
 
-  it "parses body as json" do
-    subject.parse(body).tap do |json|
-      json[:data].should == 1
-      json[:errors].should == 2
-      json[:metadata].should == 3
+  context "with valid JSON body" do
+    let(:body) { "{\"data\": 1, \"errors\": 2, \"metadata\": 3}" }
+    it "parses body as json" do
+      subject.parse(body).tap do |json|
+        json[:data].should == 1
+        json[:errors].should == 2
+        json[:metadata].should == 3
+      end
+    end
+
+    it "parses :body key as json in the env hash" do
+      env = { :body => body }
+      subject.on_complete(env)
+      env[:body].tap do |json|
+        json[:data].should == 1
+        json[:errors].should == 2
+        json[:metadata].should == 3
+      end
     end
   end
 
-  it "parses :body key as json in the env hash" do
-    env = { :body => body }
-    subject.on_complete(env)
-    env[:body].tap do |json|
-      json[:data].should == 1
-      json[:errors].should == 2
-      json[:metadata].should == 3
+  context "with invalid JSON body" do
+    let(:body) { '"foo"' }
+    it 'ensures that invalid JSON throws an exception' do
+      expect { subject.parse(body) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "\"foo\"")')
     end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -140,6 +140,7 @@ files:
 - lib/her/middleware.rb
 - lib/her/middleware/accept_json.rb
 - lib/her/middleware/first_level_parse_json.rb
+- lib/her/middleware/parse_json.rb
 - lib/her/middleware/second_level_parse_json.rb
 - lib/her/model.rb
 - lib/her/model/associations.rb