sixarm_ruby_action_dispatch_response_json 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3778f1bb04235e11c9354bde441af79d8834307
-  data.tar.gz: a94d817ee2ecb30354679d7e0450fdd625e20f41
+  metadata.gz: bf380b36e269eb228cd8b6afddc517ec607f3302
+  data.tar.gz: ec2f7d822c315270756d6025ebeaf128f4f98c73
 SHA512:
-  metadata.gz: 60dee97688053bf1d42b286d32bea2f213f6bc92f20b3c6f06f5c0fc5c576fac6e53a40c27d0b283df7e7a7d8030db4833067d9c15cb76eaa1558f296374bd9d
-  data.tar.gz: 7993720cf93d1f2d1e8e1a81b5765416561cc57910d56d59e4df603dd55a422dce2c5b1b9b899f7da07c6aa9f023a26d568ac022b6905ff4cd1cb3450a0aa939
+  metadata.gz: ce83680bd0c5ffcb27d30ff013a3d09e871aaad3058b417bc7d11ff63763ba3b37e6da962b3404f77a0db75c5f1a1c9217ca51950269037dd764fad2ce962afc
+  data.tar.gz: 31d494fc2a4d9ac5434c5aa88adcbd6bd9f66a8ab0e777a03133b9e0652d37a8b6858a41ef443a9ce9ae559d602412eb1aa9cdebdc1870a2d491bc8635be3f70

data/README.md

@@ -11,16 +11,31 @@
 
 ## Introduction
 
-Add ActionPack Response#json method.
+This gem extends ActionPack Response with JSON API methods.
 
-So instead of this:
+You can replace this:
 
-     JSON.parse(response.body)
+    JSON.parse(response.body)
 
-You can write this:
+With this:
 
-     JSON.parse(response.json)
+    response.json
 
+You can replace these:
+
+    response.json["data"]
+    response.json["errors"]
+    response.json["linked"]
+    response.json["links"]
+    response.json["meta"]
+
+With these:
+
+    response.data
+    response.errors
+    response.linked
+    response.links
+    response.meta
 
 For docs go to <http://sixarm.com/sixarm_ruby_action_dispatch_response_json/doc>
 
@@ -35,7 +50,7 @@ Install:
 
 Bundler:
 
-    gem "sixarm_ruby_action_dispatch_response_json", ">=1.0.0", "<2"
+    gem "sixarm_ruby_action_dispatch_response_json", ">=1.1.0", "<2"
 
 Require:
 
@@ -57,6 +72,7 @@ To install with high security:
 
 ## Changes
 
+* 2015-02-19 1.1.0 Add response methods for top level JSON API
 * 2015-02-12 1.0.0 Create
 
 

data/lib/sixarm_ruby_action_dispatch_response_json.rb

@@ -11,12 +11,38 @@ module ActionDispatch
 
     # Returns the response body as JSON.
     def json
-      JSON.parse(body)
+      @json ||= JSON.parse(body)
     end
 
     # Allows you to manually set or override the response body as JSON.
     def json=(json)
       self.body=json
+      @json = nil
+    end
+
+    # Returns the response json "data" field.
+    def data
+      json["data"]
+    end
+
+    # Returns the response json "errors" field.
+    def errors
+      json["errors"]
+    end
+
+    # Returns the response json "linked" field.
+    def linked
+      json["linked"]
+    end
+
+    # Returns the response json "links" field.
+    def links
+      json["links"]
+    end
+
+    # Returns the response json "meta" field.
+    def meta
+      json["meta"]
     end
 
   end

data/test/sixarm_ruby_action_dispatch_response_json_test.rb

@@ -23,4 +23,43 @@ describe "ActionDispatchResponseJSONTest" do
     end
   end
 
+  describe "with typical JSON API structure" do
+
+    before do
+      @resp = ActionDispatch::Response.new
+      @resp.body = '{"data":{"a":"b"},"errors":{"c":"d"},"linked":{"e":"f"},"links":{"g":"h"},"meta":{"i":"j"}}'
+    end
+
+    describe "#data" do
+      it "gets the data field" do
+        @resp.data.must_equal({"a"=>"b"})
+      end
+    end
+
+    describe "#errors" do
+      it "gets the errors field" do
+        @resp.errors.must_equal({"c"=>"d"})
+      end
+    end
+
+    describe "#linked" do
+      it "gets the linked field" do
+        @resp.linked.must_equal({"e"=>"f"})
+      end
+    end
+
+    describe "#links" do
+      it "gets the links field" do
+        @resp.links.must_equal({"g"=>"h"})
+      end
+    end
+
+    describe "#meta" do
+      it "gets the meta field" do
+        @resp.meta.must_equal({"i"=>"j"})
+      end
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_action_dispatch_response_json
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - SixArm
@@ -30,7 +30,7 @@ cert_chain:
   sWRVEyjnjnNuAeLP9zv43IDXjS22L2efhap7IOinYjcecpfXJgQaU+6BFAY4sdkQ
   S1STYSfs3qySBxxAeEyZTw==
   -----END CERTIFICATE-----
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Convert response.body to response.json
 email: sixarm@sixarm.com