content_gateway 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65fe5be0eff06af34c50732980238a937d3f8249
-  data.tar.gz: edd6943756c0136824ba2fefa40768e6c83fa0bd
+  metadata.gz: 07723d5fea288ca91c4f1da7436168e83daa8fea
+  data.tar.gz: d66d49a1846de645acce9b3a2363056c16992842
 SHA512:
-  metadata.gz: 4183a37c2624be76daa48c6f8238e10db77a260903583e2e4bb92123e238e3ed357d5b0393c2de56d3b723f1dc733419c0747b73aef25615a5ed14dcb03cf64c
-  data.tar.gz: 0405a719b4a119bcc110d6eb077b3f962a1a5d7fd0673110c348c1a713bc2cf575ef4865c4011c7e97fa330e4eb4598d1b649a502ef111d922cb909922d868c1
+  metadata.gz: 45f744929408bf9b41b94a212c9320a152dd9b0a8baa7ed733eb12bb1eb9d9e21de47179d6eedf522a9c30c886740f8ae6ccfe8bba979c720e86f783afab6839
+  data.tar.gz: 39795c45b0a7fcc25619aea6df33cad3d360604b2984a44ac40bd842ff8aaf28e3c35e0350b405a720a802af8f06e30efdab41d8f861a0e0ac78e91fdcf8a957

data/Changelog

@@ -1,3 +1,8 @@
+2014-10-31 [0.2.0]
+
+	* Adding ssl support in requests
+	* Solving cache problem when using ssl in requests. The solution was convert the result of the request to string before save the cache value.
+
 2014-10-21 [0.1.0]
 
 	* Adding delete_json method.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    content_gateway (0.1.0)
+    content_gateway (0.2.0)
       activesupport
       json
       rest-client

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014, Globo.com - Webmedia
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -85,6 +85,7 @@ Optional parameters are supported:
 - `stale_expires_in`: overwrites the default stale cache expiration time
 - `skip_cache`: if set to `true`, ignores cache and stale cache
 - `headers`: a hash with request headers
+- `ssl_certificate`: a hash with ssl cert and key (see ssl support section below)
 
 Every other parameter is passed to URLGenerator `generate` method (like query string parameters).
 
@@ -100,7 +101,7 @@ gateway.get_json("/path.json", skip_cache: true)
 
 POST, PUT and DELETE verbs are also supported, but ignore cache and stale cache.
 The gateway object offers the equivalent methods for these verbs (`post`, `post_json`, `put`, `put_json`, `delete` and `delete_json`).
-The only optional parameter supported by these methods is `payload`.
+The only optional parameters supported by these methods are `payload` and `ssl_certificate`.
 Every other parameter is passed to URLGenerator `generate` method (like query string parameters).
 
 Examples:
@@ -113,8 +114,29 @@ gateway.put_json("/api/put_example.json", query_string_param: "value")
 gateway.delete("/api/delete_example", id: "100")
 ```
 
+### SSL Support
+
+You can use ssl certificates to run all supported requests (get, post, put, delete).
+
+Just pass the path of cert file (x509 certificate) and key file (rsa key) to the request method. See exemple below:
+
+```ruby
+ssl = {
+  ssl_client_cert: "path/client.cert",
+  ssl_client_key: "path/client.key"
+}
+
+gateway.get("/path", timeout: 3, ssl_certificate: ssl)
+
+gateway.get_json("/path.json", skip_cache: true, ssl_certificate: ssl)
+
+gateway.post("/api/post_example", payload: { param1: "value" }, ssl_certificate: ssl)
+```
+
 ## Authors
 
+- [Túlio Ornelas](https://github.com/tulios)
+- [Roberto Soares](https://github.com/roberto)
 - [Emerson Macedo](https://github.com/emerleite)
 - [Guilherme Garnier](https://github.com/ggarnier)
 - [Daniel Martins](https://github.com/danielfm)
@@ -131,4 +153,4 @@ gateway.delete("/api/delete_example", id: "100")
 
 ## License
 
-Copyright (c) 2014 Globo.com - Webmedia. See [COPYING](https://github.com/globocom/content_gateway/blob/master/COPYING) for more details.
+Copyright (c) 2014 Globo.com - Webmedia. See [LICENSE.txt](https://github.com/globocom/content-gateway-ruby/blob/master/LICENSE.txt) for more details.

data/content-gateway.gemspec

@@ -5,11 +5,11 @@ require 'content_gateway/version'
 Gem::Specification.new do |gem|
   gem.name          = "content_gateway"
   gem.version       = ContentGateway::VERSION
-  gem.authors       = ["Emerson Macedo", "Guilherme Garnier", "Daniel Martins", "Rafael Biriba", "Célio Latorraca"]
-  gem.email         = ["emerleite@gmail.com", "guilherme.garnier@gmail.com", "daniel.tritone@gmail.com", "biribarj@gmail.com", "celio.la@gmail.com"]
+  gem.authors       = ["Túlio Ornelas", "Roberto Soares", "Emerson Macedo", "Guilherme Garnier", "Daniel Martins", "Rafael Biriba", "Célio Latorraca"]
+  gem.email         = ["ornelas.tulio@gmail.com", "roberto.tech@gmail.com", "emerleite@gmail.com", "guilherme.garnier@gmail.com", "daniel.tritone@gmail.com", "biribarj@gmail.com", "celio.la@gmail.com"]
   gem.description   = %q{An easy way to get external content with two cache levels. The first is a performance cache and second is the stale}
   gem.summary       = %q{Content Gateway}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/globocom/content-gateway-ruby"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/content_gateway/cache.rb

@@ -23,6 +23,7 @@ module ContentGateway
           @config.cache.fetch(@url, expires_in: expires_in) do
             @status = "MISS"
             response = request.execute
+            response = String.new(response) if response
 
             @config.cache.write(stale_key, response, expires_in: stale_expires_in)
             response

data/lib/content_gateway/exceptions.rb

@@ -75,5 +75,11 @@ module ContentGateway
     end
   end
 
+  class OpenSSLFailure < BaseError
+    def initialize(resource_url, wrapped_exception = nil, info=nil)
+      super(resource_url, wrapped_exception, 406, info)
+    end
+  end
+
   class StaleCacheNotAvailableError < StandardError; end
 end

data/lib/content_gateway/gateway.rb

@@ -20,7 +20,8 @@ module ContentGateway
         data = { method: :get, url: url }.tap do |h|
           h[:headers] = headers if headers.present?
         end
-        send_request(data, skip_cache: skip_cache, expires_in: expires_in, stale_expires_in: stale_expires_in, timeout: timeout)
+        request_params = { skip_cache: skip_cache, expires_in: expires_in, stale_expires_in: stale_expires_in, timeout: timeout }.merge(params)
+        send_request(data, request_params)
       end
     end
 
@@ -80,7 +81,7 @@ module ContentGateway
       payload = request_data[:payload]
 
       @cache = ContentGateway::Cache.new(@config, url, method, params)
-      @request = ContentGateway::Request.new(method, url, headers, payload, @config.try(:proxy))
+      @request = ContentGateway::Request.new(method, url, headers, payload, @config.try(:proxy), params)
 
       begin
         do_request(params)

data/lib/content_gateway/request.rb

@@ -1,11 +1,11 @@
 module ContentGateway
   class Request
-    def initialize(method, url, headers = {}, payload = {}, proxy = nil)
+    def initialize(method, url, headers = {}, payload = {}, proxy = nil, params = {})
       data = { method: method, url: url, proxy: proxy || :none }.tap do |h|
         h[:payload] = payload if payload.present?
         h[:headers] = headers if headers.present?
+        h = load_ssl_params(h, params) if params.has_key?(:ssl_certificate)
       end
-
       @client = RestClient::Request.new(data)
     end
 
@@ -29,7 +29,7 @@ module ContentGateway
 
     rescue RestClient::Exception => e6
       status_code = e6.http_code
-      if status_code < 500
+      if status_code && status_code < 500
         raise e6
       else
         raise ContentGateway::ServerError.new url, e6, status_code
@@ -41,6 +41,25 @@ module ContentGateway
 
     private
 
+    def load_ssl_params h, params
+      client_cert_file = File.read params[:ssl_certificate][:ssl_client_cert]
+      client_cert_key = File.read params[:ssl_certificate][:ssl_client_key]
+
+      h[:ssl_client_cert] = OpenSSL::X509::Certificate.new(client_cert_file)
+      h[:ssl_client_key] = OpenSSL::PKey::RSA.new(client_cert_key)
+      h[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
+      h
+
+    rescue Errno::ENOENT => e0
+      raise ContentGateway::OpenSSLFailure.new h[:url], e0
+
+    rescue OpenSSL::X509::CertificateError => e1
+      raise ContentGateway::OpenSSLFailure.new h[:url], e1, "invalid ssl client cert"
+
+    rescue OpenSSL::PKey::RSAError => e2
+      raise ContentGateway::OpenSSLFailure.new h[:url], e2, "invalid ssl client key"
+    end
+
     def url
       @client.url
     end

data/lib/content_gateway/version.rb

@@ -1,3 +1,3 @@
 module ContentGateway
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/unit/content_gateway/cache_spec.rb

@@ -84,6 +84,11 @@ describe ContentGateway::Cache do
           expect(subject.status).to eql "MISS"
         end
 
+        it "should convert request response into string" do
+          expect(String).to receive(:new).with("data")
+          subject.fetch(request)
+        end
+
         it "should return the request data" do
           expect(subject.fetch(request)).to eql "data"
         end

data/spec/unit/content_gateway/gateway_spec.rb

@@ -23,7 +23,7 @@ describe ContentGateway::Gateway do
     before do
       expect(ContentGateway::Request).
         to receive(:new).
-        with(:get, "url", headers, nil, config.proxy).
+        with(:get, "url", headers, nil, config.proxy, cache_params).
         and_return(request)
       expect(ContentGateway::Cache).
         to receive(:new).
@@ -48,7 +48,7 @@ describe ContentGateway::Gateway do
     before do
       expect(ContentGateway::Request).
         to receive(:new).
-        with(:post, "url", nil, payload, config.proxy).
+        with(:post, "url", nil, payload, config.proxy, cache_params).
         and_return(request)
       expect(ContentGateway::Cache).
         to receive(:new).
@@ -73,7 +73,7 @@ describe ContentGateway::Gateway do
     before do
       expect(ContentGateway::Request).
         to receive(:new).
-        with(:put, "url", nil, payload, config.proxy).
+        with(:put, "url", nil, payload, config.proxy, cache_params).
         and_return(request)
       expect(ContentGateway::Cache).
         to receive(:new).
@@ -98,7 +98,7 @@ describe ContentGateway::Gateway do
     before do
       expect(ContentGateway::Request).
         to receive(:new).
-        with(:delete, "url", nil, payload, config.proxy).
+        with(:delete, "url", nil, payload, config.proxy, cache_params).
         and_return(request)
       expect(ContentGateway::Cache).
         to receive(:new).

data/spec/unit/content_gateway/request_spec.rb

@@ -101,5 +101,57 @@ describe ContentGateway::Request do
         end
       end
     end
+
+    context "requests with SSL" do
+
+      let(:ssl_certificate_params) { { ssl_client_cert: "test", ssl_client_key: "test"} }
+      let(:restclient_ssl_params) { { :ssl_client_cert=>"cert", :ssl_client_key=>"key", :verify_ssl=>0 } }
+      let(:request_params_ssl) { request_params.merge! restclient_ssl_params }
+
+      let :subject_ssl do
+        ContentGateway::Request.new(:get, "/url", {}, {}, nil, ssl_certificate: ssl_certificate_params)
+      end
+
+      context "when request is successful" do
+        before do
+          allow(File).to receive(:read).with("test").and_return("cert_content")
+          allow(OpenSSL::X509::Certificate).to receive(:new).with("cert_content").and_return("cert")
+          allow(OpenSSL::PKey::RSA).to receive(:new).with("cert_content").and_return("key")
+          allow(RestClient::Request).to receive(:new).with(request_params_ssl).and_return(client)
+        end
+
+        it "should setup ssl certificates" do
+          expect(OpenSSL::X509::Certificate).to receive(:new).with("cert_content")
+          expect(OpenSSL::PKey::RSA).to receive(:new).with("cert_content")
+          subject_ssl.execute
+        end
+
+        it "should setup request with ssl params" do
+          expect(RestClient::Request).to receive(:new).with(request_params_ssl)
+          subject_ssl.execute
+        end
+
+        it "should return request data with ssl params" do
+          expect(subject_ssl.execute).to eql "data"
+        end
+      end
+
+      context "when request fails" do
+        it "should return ssl failure error if certificate was not found" do
+          expect { subject_ssl.execute }.to raise_error(ContentGateway::OpenSSLFailure).with_message("/url - No such file or directory - test")
+        end
+
+        it "should return ssl failure error if certificate cert was not valid" do
+          allow(File).to receive(:read).with("test").and_return("cert_content")
+          expect { subject_ssl.execute }.to raise_error(ContentGateway::OpenSSLFailure).with_message("/url - not enough data - invalid ssl client cert")
+        end
+
+        it "should return ssl failure error if certificate key was not valid" do
+          allow(File).to receive(:read).with("test").and_return("cert_content")
+          allow(OpenSSL::X509::Certificate).to receive(:new).with("cert_content").and_return("cert")
+          expect { subject_ssl.execute }.to raise_error(ContentGateway::OpenSSLFailure).with_message("/url - Neither PUB key nor PRIV key: not enough data - invalid ssl client key")
+        end
+      end
+    end
   end
 end

metadata

@@ -1,9 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: content_gateway
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
+- Túlio Ornelas
+- Roberto Soares
 - Emerson Macedo
 - Guilherme Garnier
 - Daniel Martins
@@ -12,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,6 +103,8 @@ dependencies:
 description: An easy way to get external content with two cache levels. The first
   is a performance cache and second is the stale
 email:
+- ornelas.tulio@gmail.com
+- roberto.tech@gmail.com
 - emerleite@gmail.com
 - guilherme.garnier@gmail.com
 - daniel.tritone@gmail.com
@@ -114,10 +118,10 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
-- COPYING
 - Changelog
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - content-gateway.gemspec
@@ -132,7 +136,7 @@ files:
 - spec/unit/content_gateway/cache_spec.rb
 - spec/unit/content_gateway/gateway_spec.rb
 - spec/unit/content_gateway/request_spec.rb
-homepage: ''
+homepage: https://github.com/globocom/content-gateway-ruby
 licenses: []
 metadata: {}
 post_install_message: 
@@ -151,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Content Gateway

data/COPYING

@@ -1,24 +0,0 @@
-Copyright (c) 2014, Globo.com - Webmedia
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the Globo.com - Webmedia nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL GLOBO.COM - WEBMEDIA BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.