content_gateway 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa85efc4f1c83ec7bdd1a6759fb1fda12afcbea4
-  data.tar.gz: aab412e14cccaac8e3110a82b9067e95dc5c034a
+  metadata.gz: ee3e2f6da92f839d6d66363fb6860fe51ca61ff1
+  data.tar.gz: 25fcaa57e51bf4f365133c4d5672ce93cb1076e9
 SHA512:
-  metadata.gz: 89ce05e82342e19a45d4cdf54bcbd065d6ee2f897230d5af0aaecad301b636c455fa4f531fc2dc5abe08fffa0bdb522d7d8c26383b5acfd32942459fd1e58241
-  data.tar.gz: bd179384af08df8c163fd8e2e32509bff4dcdbcf8aed44192dd27b5c039114edceec71f3018d9b759860b728086e61b0adcb547d7f20aab0ebf2e9e5d63f5641
+  metadata.gz: 4e95aa8acf647aaa56102fcc5e28ca6fab2f46d0885d3353d9f785003f6a4848d6ee367cbbc2d79a7ef78679e20f0f296d51f2e889ef29dc4515a6d8e21a2db5
+  data.tar.gz: 79995262957697314650059639726c15d474a199c59c9f96ee377ceadaa9b2c38a0ebbc930c5eededd0ded68f8908112419a9b0ef985919581b2c48389270881

data/Changelog

@@ -1,10 +1,17 @@
+2015-07-24 [0.5.0]
+
+  * Mapping JSON parse errors to ContentGateway::ParserError
+
 2015-06-16 [0.4.0]
+
   * Adding ssl_version support to ssl_certificate hash
 
 2015-01-05 [0.3.0]
+
   * Optional url generator. (Without the url generator on boot the content gateway will use the get/post/delete/put resource argument as full url for request). Closes #4
 
 2014-11-06 [0.2.1]
+
 	* Fix: Do not send connection parameters to url generator. Closes #2
 	* Fix: Send http headers to request object. Closes #3
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    content_gateway (0.3.0)
+    content_gateway (0.5.0)
       activesupport
       json
       rest-client
@@ -9,13 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.14)
+      tzinfo (~> 1.1)
     byebug (3.5.1)
       columnize (~> 0.8)
       debugger-linecache (~> 1.2)
@@ -23,13 +22,15 @@ GEM
     columnize (0.8.9)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
-    i18n (0.6.9)
+    i18n (0.6.11)
     json (1.8.1)
-    mime-types (2.0)
-    minitest (4.7.5)
+    mime-types (2.4.3)
+    minitest (5.5.0)
     multi_json (1.7.9)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
+    netrc (0.10.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
@@ -47,9 +48,9 @@ GEM
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     slop (3.6.0)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/lib/content_gateway/exceptions.rb

@@ -81,5 +81,7 @@ module ContentGateway
     end
   end
 
+  class ParserError < BaseError; end
+
   class StaleCacheNotAvailableError < StandardError; end
 end

data/lib/content_gateway/gateway.rb

@@ -88,19 +88,19 @@ module ContentGateway
     end
 
     def get_json(resource_path, params = {})
-      JSON.parse get(resource_path, params)
+      json_request(:get, resource_path, params)
     end
 
     def post_json(resource_path, params = {})
-      JSON.parse post(resource_path, params)
+      json_request(:post, resource_path, params)
     end
 
     def put_json(resource_path, params = {})
-      JSON.parse put(resource_path, params)
+      json_request(:put, resource_path, params)
     end
 
     def delete_json(resource_path, params = {})
-      JSON.parse delete(resource_path, params)
+      json_request(:delete, resource_path, params)
     end
 
     def generate_url(resource_path, params = {})
@@ -158,6 +158,13 @@ module ContentGateway
       end
     end
 
+    def json_request(verb, resource_path, params = {})
+      JSON.parse(self.send(verb, resource_path, params))
+    rescue JSON::ParserError => e
+      url = generate_url(resource_path, params) rescue resource_path
+      raise ContentGateway::ParserError.new(url, e)
+    end
+
     def measure(message)
       result = nil
       time_elapsed = Benchmark.measure { result = yield }

data/lib/content_gateway/version.rb

@@ -1,3 +1,3 @@
 module ContentGateway
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/unit/content_gateway/gateway_spec.rb

@@ -18,6 +18,7 @@ describe ContentGateway::Gateway do
   let(:cache) { double("cache", use?: false, status: "HIT") }
   let(:request) { double("request", execute: data) }
   let(:data) { '{"param": "value"}' }
+  let(:invalid_data) { "" }
   let(:cache_params) { { timeout: 2, expires_in: 30, stale_expires_in: 180, skip_cache: false, ssl_certificate: {ssl_client_cert: "test", ssl_client_key: "test"} } }
   let(:connection_params) {{ timeout: 2, ssl_certificate: {ssl_client_cert: "test", ssl_client_key: "test"} }}
 
@@ -27,17 +28,41 @@ describe ContentGateway::Gateway do
     allow(OpenSSL::PKey::RSA).to receive(:new).with("cert_content").and_return("key")
   end
 
+  shared_examples "request" do
+    describe "doing a request" do
+      it "should do a # {verb} request passing the correct parameters" do
+        expect(subject.send(verb, path, params)).to eql data
+      end
+    end
+
+    describe "doing a json request" do
+      it "should parse the response as JSON" do
+        expect(subject.send("#{verb}_json", path, params)).to eql JSON.parse(data)
+      end
+
+      context "when the answer is not a valid JSON" do
+        let(:data) { invalid_data }
+
+        it "should raise ContentGateway::ParserError" do
+          expect { subject.send("#{verb}_json", path, params) }.
+            to raise_error(ContentGateway::ParserError)
+        end
+      end
+    end
+  end
+
   describe "Without url generator" do
     describe "GET method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:get, fullpath, headers, nil, config.proxy, cache_params).
-        and_return(request)
+          to receive(:new).
+          with(:get, fullpath, headers, nil, config.proxy, cache_params).
+          and_return(request)
+
         expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, fullpath, :get, cache_params).
-        and_return(cache)
+          to receive(:new).
+          with(config, fullpath, :get, cache_params).
+          and_return(cache)
       end
 
       describe "#get" do
@@ -50,13 +75,14 @@ describe ContentGateway::Gateway do
     describe "POST method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:post, fullpath, nil, payload, config.proxy, connection_params).
-        and_return(request)
+          to receive(:new).
+          with(:post, fullpath, nil, payload, config.proxy, connection_params).
+          and_return(request)
+
         expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, fullpath, :post, connection_params).
-        and_return(cache)
+          to receive(:new).
+          with(config, fullpath, :post, connection_params).
+          and_return(cache)
       end
 
       describe "#post" do
@@ -69,13 +95,14 @@ describe ContentGateway::Gateway do
     describe "PUT method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:put, fullpath, nil, payload, config.proxy, connection_params).
-        and_return(request)
+          to receive(:new).
+          with(:put, fullpath, nil, payload, config.proxy, connection_params).
+          and_return(request)
+
         expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, fullpath, :put, connection_params).
-        and_return(cache)
+          to receive(:new).
+          with(config, fullpath, :put, connection_params).
+          and_return(cache)
       end
 
       describe "#put" do
@@ -88,13 +115,14 @@ describe ContentGateway::Gateway do
     describe "DELETE method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:delete, fullpath, nil, nil, config.proxy, connection_params).
-        and_return(request)
+          to receive(:new).
+          with(:delete, fullpath, nil, nil, config.proxy, connection_params).
+          and_return(request)
+
         expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, fullpath, :delete, connection_params).
-        and_return(cache)
+          to receive(:new).
+          with(config, fullpath, :delete, connection_params).
+          and_return(cache)
       end
 
       describe "#delete" do
@@ -107,106 +135,82 @@ describe ContentGateway::Gateway do
 
   describe "With url generator" do
     before do
-      expect(url_generator).to receive(:generate).with(path, {}).and_return("url")
+      expect(url_generator).to receive(:generate).at_least(:once).with(path, {}).and_return("url")
     end
 
     describe "GET method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:get, "url", headers, nil, config.proxy, cache_params).
-        and_return(request)
-        expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, "url", :get, cache_params).
-        and_return(cache)
-      end
+          to receive(:new).
+          with(:get, "url", headers, nil, config.proxy, cache_params).
+          and_return(request)
 
-      describe "#get" do
-        it "should do a get request passing the correct parameters" do
-          expect(subject.get(path, cache_params.merge(headers: headers))).to eql data
-        end
+        expect(ContentGateway::Cache).
+          to receive(:new).
+          with(config, "url", :get, cache_params).
+          and_return(cache)
       end
 
-      describe "#get_json" do
-        it "should parse the response as JSON" do
-          expect(subject.get_json(path, cache_params.merge(headers: headers))).to eql JSON.parse(data)
-        end
+      it_should_behave_like "request" do
+        let(:verb) { "get" }
+        let(:params) { cache_params.merge(headers: headers) }
       end
     end
 
     describe "POST method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:post, "url", nil, payload, config.proxy, connection_params).
-        and_return(request)
+          to receive(:new).
+          with(:post, "url", nil, payload, config.proxy, connection_params).
+          and_return(request)
+
         expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, "url", :post, connection_params).
-        and_return(cache)
+          to receive(:new).
+          with(config, "url", :post, connection_params).
+          and_return(cache)
       end
 
-      describe "#post" do
-        it "should do a post request passing the correct parameters" do
-          expect(subject.post(path, cache_params.merge(payload: payload))).to eql data
-        end
-      end
-
-      describe "#post_json" do
-        it "should parse the response as JSON" do
-          expect(subject.post_json(path, cache_params.merge(payload: payload))).to eql JSON.parse(data)
-        end
+      it_should_behave_like "request" do
+        let(:verb) { "post" }
+        let(:params) { cache_params.merge(payload: payload) }
       end
     end
 
     describe "PUT method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:put, "url", nil, payload, config.proxy, connection_params).
-        and_return(request)
-        expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, "url", :put, connection_params).
-        and_return(cache)
-      end
+          to receive(:new).
+          with(:put, "url", nil, payload, config.proxy, connection_params).
+          and_return(request)
 
-      describe "#put" do
-        it "should do a put request passing the correct parameters" do
-          expect(subject.put(path, cache_params.merge(payload: payload))).to eql data
-        end
+        expect(ContentGateway::Cache).
+          to receive(:new).
+          with(config, "url", :put, connection_params).
+          and_return(cache)
       end
 
-      describe "#put_json" do
-        it "should parse the response as JSON" do
-          expect(subject.put_json(path, cache_params.merge(payload: payload))).to eql JSON.parse(data)
-        end
+      it_should_behave_like "request" do
+        let(:verb) { "put" }
+        let(:params) { cache_params.merge(payload: payload) }
       end
     end
 
     describe "DELETE method" do
       before do
         expect(ContentGateway::Request).
-        to receive(:new).
-        with(:delete, "url", nil, nil, config.proxy, connection_params).
-        and_return(request)
-        expect(ContentGateway::Cache).
-        to receive(:new).
-        with(config, "url", :delete, connection_params).
-        and_return(cache)
-      end
+          to receive(:new).
+          with(:delete, "url", nil, nil, config.proxy, connection_params).
+          and_return(request)
 
-      describe "#delete" do
-        it "should do a delete request passing the correct parameters" do
-          expect(subject.delete(path, cache_params.merge(payload: payload))).to eql data
-        end
+        expect(ContentGateway::Cache).
+          to receive(:new).
+          with(config, "url", :delete, connection_params).
+          and_return(cache)
       end
 
-      describe "#delete_json" do
-        it "should parse the response as JSON" do
-          expect(subject.delete_json(path, cache_params.merge(payload: payload))).to eql JSON.parse(data)
-        end
+      it_should_behave_like "request" do
+        let(:verb) { "delete" }
+        let(:params) { cache_params.merge(payload: payload) }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_gateway
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport