content_gateway 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f61a78669daef3d6d8e315286dfc30b809fff617
-  data.tar.gz: dafc8418766cd8db41f12341d2133dfe3e315cb4
+  metadata.gz: '09f4668cfce0325aa25a4deedd9230872b50866f'
+  data.tar.gz: 99ae88d63d41897fe28e17784d04858007e78edb
 SHA512:
-  metadata.gz: d4a10af76e1d83e84826eabd94a95ade5169f8786c200f39b0a00c884a4e98f0140e6d59c1d54220a9efd3985a1d438ce53887f6c73e25ee22bbaaef05679e0b
-  data.tar.gz: 5039d46047e9549f72a413e607e0db3cb0cf02e8cd2cbf553e40963aa169702f6a7194379cbf2bf1915d51a80cc7af018635599302fe92ae3e7622796dfbc433
+  metadata.gz: e4d825a0913af3a1bb450faa6dddf267d333b06dd237b8e4ee8e15e086d94fdfb1b17f38b8b9d49a0604da73a7dfcd86081312976016cd70cd06696b45f5a855
+  data.tar.gz: 1abb95ab7ef05ae2160f42732a6214665327c513e3ed266b47d285cc9248534e954b8f99b2506ea1b2e1f1d7f8c40d89b83719443164f154d37cf8936b112969

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p598
+ruby-2.3.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+sudo: false
+script: bundle exec rake spec

data/Changelog

@@ -1,3 +1,8 @@
+2016-12-19 [0.5.2]
+
+  * Bugfix: Now stale_on_error returns true if theres no config
+  * Add default url generator
+
 2015-11-19 [0.5.1]
 
   * Bugfix proxy implementation wrapper on rest-client

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
-ruby '2.0.0'
+ruby '2.3.3'
+
+gem 'coveralls', require: false
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    content_gateway (0.5.0)
+    content_gateway (0.5.2)
       activesupport (>= 3)
       json (~> 1.0)
       rest-client (~> 1.0)
@@ -9,29 +9,36 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     byebug (3.5.1)
       columnize (~> 0.8)
       debugger-linecache (~> 1.2)
       slop (~> 3.6)
     columnize (0.8.9)
+    concurrent-ruby (1.0.2)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
-    domain_name (0.5.25)
+    domain_name (0.5.20161021)
       unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
     i18n (0.7.0)
     json (1.8.3)
-    mime-types (2.6.2)
-    minitest (5.8.3)
+    mime-types (2.99.3)
+    minitest (5.10.1)
     multi_json (1.7.9)
     netrc (0.11.0)
+    rake (0.9.6)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
@@ -53,12 +60,16 @@ GEM
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     slop (3.6.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.4)
     thread_safe (0.3.5)
+    tins (1.13.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.2)
 
 PLATFORMS
   ruby
@@ -66,8 +77,13 @@ PLATFORMS
 DEPENDENCIES
   byebug
   content_gateway!
+  coveralls
+  rake
   rspec (>= 2.3.0)
   simplecov (>= 0.7.1)
 
+RUBY VERSION
+   ruby 2.3.3p222
+
 BUNDLED WITH
-   1.10.6
+   1.13.6

data/README.md

@@ -1,5 +1,8 @@
 # Content Gateway
 
+[![Build Status](https://travis-ci.org/globocom/content-gateway-ruby.svg)](https://travis-ci.org/globocom/content-gateway-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/globocom/content-gateway-ruby/badge.svg?branch=master)](https://coveralls.io/github/globocom/content-gateway-ruby?branch=master)
+
 An easy way to get external content with two cache levels. The first is a performance cache and second is the stale.
 
 Content Gateway lets you set a timeout for any request.
@@ -56,13 +59,12 @@ config = OpenStruct.new(
 
 - a label, which is used in the log messages
 - a config object, just as described above
-- an URL Generator object. This may be any object that responds to a `generate` method, like this:
-- an optional hash with default params. Currently, it only supports default headers
+- (optional) an URL Generator object. This may be any object that responds to a `generate` method, like this:
+- (optional) a hash with default params. Currently, it only supports default headers
 
 ```ruby
 class UrlGenerator
   def generate(resource_path, params = {})
-    args = ""
     args = "?#{params.map {|k, v| "#{k}=#{v}"}.join("&")}" if params.any?
     "http://example.com/#{resource_path}#{args}"
   end
@@ -73,7 +75,7 @@ default_params = { headers: { Accept: "application/json" } }
 gateway = ContentGateway::Gateway.new("My API", config, UrlGenerator.new, default_params)
 ```
 
-Every param may be overrided on each request.
+If ommited, the default URL Generator adds the method call params as query string parameters. Every param may be overrided on each request.
 
 This Gateway object supports the following methods:
 
@@ -169,4 +171,4 @@ gateway.post("/api/post_example", payload: { param1: "value" }, ssl_certificate:
 
 ## License
 
-Copyright (c) 2015 Globo.com - Webmedia. See [LICENSE.txt](https://github.com/globocom/content-gateway-ruby/blob/master/LICENSE.txt) for more details.
+Copyright (c) 2016 Globo.com - Webmedia. See [LICENSE.txt](https://github.com/globocom/content-gateway-ruby/blob/master/LICENSE.txt) for more details.

data/content-gateway.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec",                       ">= 2.3.0"
   gem.add_development_dependency "simplecov",                   ">= 0.7.1"
   gem.add_development_dependency "byebug"
+  gem.add_development_dependency "rake"
 end

data/lib/content_gateway.rb

@@ -5,6 +5,7 @@ require "benchmark"
 require "json"
 require "rest-client"
 require "active_support/cache"
+require "active_support/notifications"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/date_time/calculations"
 require "active_support/core_ext/hash/indifferent_access"

data/lib/content_gateway/cache.rb

@@ -62,7 +62,7 @@ module ContentGateway
     private
     def config_stale_on_error params, config
       return params[:stale_on_error] unless params[:stale_on_error].nil?
-      return @config.stale_on_error unless @config.stale_on_error.nil?
+      return config.stale_on_error unless config.try(:stale_on_error).nil?
       true
     end
   end

data/lib/content_gateway/gateway.rb

@@ -3,7 +3,7 @@ module ContentGateway
     def initialize(label, config, url_generator = nil, default_params = {})
       @label = label
       @config = config
-      @url_generator = url_generator
+      @url_generator = url_generator || DefaultUrlGenerator
       @default_params = default_params
     end
 
@@ -212,5 +212,12 @@ module ContentGateway
         end
       end.yield
     end
+
+    class DefaultUrlGenerator
+      def generate(resource_path, params = {})
+        args = "?#{params.map {|k, v| "#{k}=#{v}"}.join("&")}" if params.any?
+        "#{resource_path}#{args}"
+      end
+    end
   end
 end

data/lib/content_gateway/version.rb

@@ -1,3 +1,3 @@
 module ContentGateway
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/integration/content_gateway/gateway_spec.rb

@@ -8,11 +8,24 @@ describe ContentGateway::Gateway do
   end
 
   let! :config do
-    OpenStruct.new(
+    class FakeConfig
+      attr_accessor :cache, :cache_expires_in, :cache_stale_expires_in, :proxy, :timeout
+
+      def initialize(params)
+        @cache = params[:cache]
+        @cache_expires_in = params[:cache_expires_in]
+        @cache_stale_expires_in = params[:cache_stale_expires_in]
+        @proxy = params[:proxy]
+        @timeout = params[:timeout]
+      end
+    end
+
+    FakeConfig.new(
       cache: ActiveSupport::Cache::NullStore.new,
       cache_expires_in: 15.minutes,
       cache_stale_expires_in: 1.hour,
-      proxy: "proxy"
+      proxy: "proxy",
+      timeout: 2
     )
   end
 
@@ -123,9 +136,10 @@ describe ContentGateway::Gateway do
         end
 
         context "with stale cache" do
+          let(:cache_store) {double("cache_store")}
+
           context "on timeout" do
             before do
-              cache_store = double("cache_store")
               allow(cache_store).to receive(:fetch).with(resource_url, expires_in: default_expires_in).and_raise(Timeout::Error)
               allow(cache_store).to receive(:read).with(stale_cache_key).and_return(cached_response)
               config.cache = cache_store
@@ -140,36 +154,27 @@ describe ContentGateway::Gateway do
             before do
               stub_request_with_error({method: :get, url: resource_url, proxy: config.proxy, headers: headers}, RestClient::InternalServerError.new(nil, 500))
 
-              cache_store = double("cache_store")
               allow(cache_store).to receive(:fetch).with(resource_url, expires_in: default_expires_in).and_yield
               allow(cache_store).to receive(:read).with(stale_cache_key).and_return(cached_response)
               config.cache = cache_store
             end
 
-            it "should serve stale" do
-              expect(gateway.get(resource_path)).to eql "cached response"
-            end
-
-            context "when stale_on_error configuration is true" do
-              let :gateway do
-                config_with_stale_on_error = config.dup
-                config_with_stale_on_error.stale_on_error = true
-                ContentGateway::Gateway.new "API XPTO", config_with_stale_on_error, url_generator, headers: headers
-              end
-
-              it "should serve stale" do
-                expect(gateway.get(resource_path)).to eql "cached response"
+            context "give a config without stale_on_error" do
+              context "uses the default value" do
+                it "returns cached stale" do
+                  expect(gateway.get(resource_path)).to eql "cached response"
+                end
               end
             end
 
             context "when stale_on_error configuration is false" do
               let :gateway do
                 config_with_stale_on_error = config.dup
-                config_with_stale_on_error.stale_on_error = false
+                allow(config_with_stale_on_error).to receive(:stale_on_error).and_return(false)
                 ContentGateway::Gateway.new "API XPTO", config_with_stale_on_error, url_generator, headers: headers
               end
 
-              it "should raise error" do
+              it "raises error" do
                 expect { gateway.get resource_path }.to raise_error ContentGateway::ServerError
               end
             end

data/spec/spec_helper.rb

@@ -2,6 +2,9 @@ ENV['RACK_ENV'] = 'test'
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'byebug'
 require 'rspec'
 require 'content_gateway'

data/spec/unit/content_gateway/gateway_spec.rb

@@ -53,21 +53,23 @@ describe ContentGateway::Gateway do
 
   describe "Without url generator" do
     describe "GET method" do
+      let(:query_string) { { a: 1, b: 2 } }
+
       before do
         expect(ContentGateway::Request).
           to receive(:new).
-          with(:get, fullpath, headers, nil, config.proxy, cache_params).
+          with(:get, fullpath, headers, nil, config.proxy, cache_params.merge(query_string)).
           and_return(request)
 
         expect(ContentGateway::Cache).
           to receive(:new).
-          with(config, fullpath, :get, cache_params).
+          with(config, fullpath, :get, cache_params.merge(query_string)).
           and_return(cache)
       end
 
       describe "#get" do
         it "should do a get request passing the correct parameters" do
-          expect(gateway_without_url_generator.get(fullpath, cache_params.merge(headers: headers))).to eql data
+          expect(gateway_without_url_generator.get(fullpath, cache_params.merge(query_string).merge(headers: headers))).to eql data
         end
       end
     end

data/spec/unit/content_gateway/request_spec.rb

@@ -156,7 +156,7 @@ describe ContentGateway::Request do
 
       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")
+          expect { subject_ssl.execute }.to raise_error(ContentGateway::OpenSSLFailure).with_message(/^\/url - No such file or directory/)
         end
 
         it "should return ssl failure error if certificate cert was not valid" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_gateway
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -14,90 +14,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: An easy way to get external content with two cache levels. The first
@@ -114,10 +128,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Changelog
 - Gemfile
 - Gemfile.lock
@@ -145,17 +160,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Content Gateway