content_gateway 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65fe5be0eff06af34c50732980238a937d3f8249
+  data.tar.gz: edd6943756c0136824ba2fefa40768e6c83fa0bd
+SHA512:
+  metadata.gz: 4183a37c2624be76daa48c6f8238e10db77a260903583e2e4bb92123e238e3ed357d5b0393c2de56d3b723f1dc733419c0747b73aef25615a5ed14dcb03cf64c
+  data.tar.gz: 0405a719b4a119bcc110d6eb077b3f962a1a5d7fd0673110c348c1a713bc2cf575ef4865c4011c7e97fa330e4eb4598d1b649a502ef111d922cb909922d868c1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+docs/*
+*.gem
+.bundle
+.rvmrc
+coverage/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+content-gateway

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p481

data/COPYING

@@ -0,0 +1,24 @@
+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.

data/Changelog

@@ -0,0 +1,42 @@
+2014-10-21 [0.1.0]
+
+	* Adding delete_json method.
+	* A lot of refactoring.
+
+2014-10-07 [0.0.14]
+
+	* Ignoring cache after an internal server error when skip_cache = true.
+	* Mapping 5xx errors to ContentGateway::ServerError.
+
+2014-04-01 [0.0.13]
+
+	* Added support for HTTP 409 Conflict error.
+
+2014-04-01 [0.0.12]
+
+	* Require debugger on spec_helper.
+
+2014-01-17 [0.0.11]
+
+	* Adding delete method support
+
+2014-01-17 [0.0.10]
+
+	* Do not depend on a specific version of activesupport.
+
+2013-08-15 [0.0.9]
+
+	* Using try to get proxy from config to avoid error when not exists.
+
+2013-08-15 [0.0.8]
+
+	* Return empty when result is not a RestClient object and do not have "code" method.
+
+2013-08-15 [0.0.7]
+
+	* Default params now are optional
+
+2013-08-14 [0.0.6]
+
+	* First release
+	* Replaces Esportes API gateway.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '2.0.0'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    content_gateway (0.1.0)
+      activesupport
+      json
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    mime-types (2.0)
+    minitest (4.7.5)
+    multi_json (1.7.9)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.6.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  content_gateway!
+  rspec (>= 2.3.0)
+  simplecov (>= 0.7.1)

data/README.md

@@ -0,0 +1,134 @@
+# Content Gateway
+
+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.
+If the configured timeout is reached without response, it searches for cached data.
+If cache is unavailable or expired, it returns the stale cache data.
+Only then, if stale cache is also unavailable or expired, it raises an exception
+
+## Dependencies
+
+- Ruby >= 1.9
+- ActiveSupport (for cache store)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'content_gateway'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install content_gateway
+
+## Configuration
+
+`ContentGateway::Gateway` class accepts a configuration object with the following parameters:
+
+- `timeout`: request timeout in seconds
+- `cache_expires_in`: cache data expiration time, in seconds
+- `cache_stale_expires_in`: stale cache data expiration time, in seconds
+- `cache`: cache store instance. This may be an instance of `ActiveSupport::Cache`
+- `proxy`: proxy address, if needed
+
+Configuration object example:
+
+```ruby
+config = OpenStruct.new(
+  timeout: 2,
+  cache_expires_in: 1800,
+  cache_stale_expires_in: 86400,
+  cache: ActiveSupport::Cache.lookup_store(:memory_store),
+  proxy: "http://proxy.example.com/"
+)
+```
+
+## Usage
+
+`ContentGateway::Gateway` expects four parameters:
+
+- 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
+
+```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
+end
+
+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.
+
+This Gateway object supports the following methods:
+
+### GET
+
+To do a GET request, you may use the `get` or `get_json` methods. The second one parses the response as JSON.
+Optional parameters are supported:
+
+- `timeout`: overwrites the default timeout
+- `expires_in`: overwrites the default cache expiration time
+- `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
+
+Every other parameter is passed to URLGenerator `generate` method (like query string parameters).
+
+Examples:
+
+```ruby
+gateway.get("/path", timeout: 3)
+
+gateway.get_json("/path.json", skip_cache: true)
+```
+
+### POST, PUT and DELETE
+
+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`.
+Every other parameter is passed to URLGenerator `generate` method (like query string parameters).
+
+Examples:
+
+```ruby
+gateway.post("/api/post_example", payload: { param1: "value" })
+
+gateway.put_json("/api/put_example.json", query_string_param: "value")
+
+gateway.delete("/api/delete_example", id: "100")
+```
+
+## Authors
+
+- [Emerson Macedo](https://github.com/emerleite)
+- [Guilherme Garnier](https://github.com/ggarnier)
+- [Daniel Martins](https://github.com/danielfm)
+- [Rafael Biriba](https://github.com/rafaelbiriba)
+- [Célio Latorraca](https://github.com/celiofonseca)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2014 Globo.com - Webmedia. See [COPYING](https://github.com/globocom/content_gateway/blob/master/COPYING) for more details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+# Rake tasks
+Dir.glob('lib/tasks/**/*.rake').each {|r| import r}
+
+require "rspec/core/rake_task"
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/content-gateway.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+  gem.add_dependency "rest-client"
+  gem.add_dependency "json"
+
+  gem.add_development_dependency "rspec",                       ">= 2.3.0"
+  gem.add_development_dependency "simplecov",                   ">= 0.7.1"
+  gem.add_development_dependency "byebug"
+end

data/lib/content_gateway/cache.rb

@@ -0,0 +1,59 @@
+module ContentGateway
+  class Cache
+    attr_reader :status
+
+    def initialize(config, url, method, params = {})
+      @config = config
+      @url = url
+      @method = method.to_sym
+      @skip_cache = params[:skip_cache] || false
+    end
+
+    def use?
+      !@skip_cache && [:get, :head].include?(@method)
+    end
+
+    def fetch(request, params = {})
+      timeout = params[:timeout] || @config.timeout
+      expires_in = params[:expires_in] || @config.cache_expires_in
+      stale_expires_in = params[:stale_expires_in] || @config.cache_stale_expires_in
+
+      begin
+        Timeout.timeout(timeout) do
+          @config.cache.fetch(@url, expires_in: expires_in) do
+            @status = "MISS"
+            response = request.execute
+
+            @config.cache.write(stale_key, response, expires_in: stale_expires_in)
+            response
+          end
+        end
+
+      rescue Timeout::Error => e
+        begin
+          serve_stale
+        rescue ContentGateway::StaleCacheNotAvailableError
+          raise ContentGateway::TimeoutError.new(@url, e, timeout)
+        end
+
+      rescue ContentGateway::ServerError => e
+        begin
+          serve_stale
+        rescue ContentGateway::StaleCacheNotAvailableError
+          raise e
+        end
+      end
+    end
+
+    def serve_stale
+      @config.cache.read(stale_key).tap do |cached|
+        raise ContentGateway::StaleCacheNotAvailableError.new unless cached
+        @status = "STALE"
+      end
+    end
+
+    def stale_key
+      @stale_key ||= "stale:#{@url}"
+    end
+  end
+end

data/lib/content_gateway/exceptions.rb

@@ -0,0 +1,79 @@
+module ContentGateway
+  class BaseError < StandardError
+    attr_reader :resource_url, :wrapped_exception, :status_code, :info
+
+    def initialize(resource_url, wrapped_exception = nil, status_code = nil, info = nil)
+      @resource_url = resource_url
+      @wrapped_exception = wrapped_exception
+      @status_code = status_code
+      @info = info
+
+      message = @resource_url.dup
+      if @wrapped_exception
+        message << " - #{@wrapped_exception.message}"
+        message << " - #{@info}" if @info
+      end
+
+      super(message)
+    end
+  end
+
+  class UnauthorizedError < BaseError
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 401)
+    end
+  end
+
+  class Forbidden < BaseError
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 403)
+    end
+  end
+
+  class ResourceNotFound < BaseError
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 404)
+    end
+  end
+
+  class TimeoutError < BaseError
+    def initialize(resource_url, wrapped_exception = nil, timeout = nil)
+      info = "TIMEOUT (max #{timeout} s)" if timeout
+
+      super(resource_url, wrapped_exception, 408, info)
+    end
+  end
+
+  class ConflictError < BaseError
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 409)
+    end
+  end
+
+  class ValidationError < BaseError
+    attr_reader :errors
+
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 422)
+
+      if wrapped_exception
+        response = wrapped_exception.response
+        @errors = JSON.parse(response) if response.present?
+      end
+    end
+  end
+
+  class ServerError < BaseError
+    def initialize(resource_url, wrapped_exception = nil, status_code = nil)
+      super(resource_url, wrapped_exception, status_code, "SERVER ERROR")
+    end
+  end
+
+  class ConnectionFailure < BaseError
+    def initialize(resource_url, wrapped_exception = nil)
+      super(resource_url, wrapped_exception, 500)
+    end
+  end
+
+  class StaleCacheNotAvailableError < StandardError; end
+end

data/lib/content_gateway/gateway.rb

@@ -0,0 +1,153 @@
+module ContentGateway
+  class Gateway
+    def initialize(label, config, url_generator, default_params = {})
+      @label = label
+      @config = config
+      @url_generator = url_generator
+      @default_params = default_params
+    end
+
+    def get(resource_path, params = {})
+      timeout = params.delete :timeout
+      expires_in = params.delete :expires_in
+      stale_expires_in = params.delete :stale_expires_in
+      skip_cache = params.delete :skip_cache
+      headers = (params.delete :headers) || @default_params[:headers]
+
+      url = self.generate_url(resource_path, params)
+
+      measure("GET - #{url}") do
+        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)
+      end
+    end
+
+    def post(resource_path, params = {})
+      payload = params.delete :payload
+      url = self.generate_url(resource_path, params)
+
+      measure("POST - #{url}") do
+        send_request({ method: :post, url: url, payload: payload }, params)
+      end
+    end
+
+    def put(resource_path, params = {})
+      payload = params.delete :payload
+      url = self.generate_url(resource_path, params)
+
+      measure("PUT - #{url}") do
+        send_request({ method: :put, url: url, payload: payload }, params)
+      end
+    end
+
+    def delete(resource_path, params = {})
+      payload = params.delete :payload
+      url = self.generate_url(resource_path, params)
+
+      measure("DELETE - #{url}") do
+        send_request({ method: :delete, url: url, payload: payload }, params)
+      end
+    end
+
+    def get_json(resource_path, params = {})
+      JSON.parse get(resource_path, params)
+    end
+
+    def post_json(resource_path, params = {})
+      JSON.parse post(resource_path, params)
+    end
+
+    def put_json(resource_path, params = {})
+      JSON.parse put(resource_path, params)
+    end
+
+    def delete_json(resource_path, params = {})
+      JSON.parse delete(resource_path, params)
+    end
+
+    def generate_url(resource_path, params = {})
+      @url_generator.generate(resource_path, params)
+    end
+
+    private
+
+    def send_request(request_data, params = {})
+      method  = request_data[:method] || :get
+      url     = request_data[:url]
+      headers = request_data[:headers]
+      payload = request_data[:payload]
+
+      @cache = ContentGateway::Cache.new(@config, url, method, params)
+      @request = ContentGateway::Request.new(method, url, headers, payload, @config.try(:proxy))
+
+      begin
+        do_request(params)
+
+      rescue ContentGateway::BaseError => e
+        message = "#{prefix(e.status_code)} :: #{color_message(e.resource_url)}"
+        message << " - #{e.info}" if e.info
+        logger.info message
+
+        raise e
+      end
+    end
+
+    def do_request(params = {})
+      if @cache.use?
+        @cache.fetch(@request, timeout: params[:timeout], expires_in: params[:expires_in], stale_expires_in: params[:stale_expires_in])
+      else
+        @request.execute
+      end
+    end
+
+    def measure(message)
+      result = nil
+      time_elapsed = Benchmark.measure { result = yield }
+      sufix = "finished in #{humanize_elapsed_time(time_elapsed.real)}. "
+      cache_log = (@cache.status || "HIT").to_s.ljust(4, " ")
+      log_message = "#{prefix(code(result))} :: #{cache_log} #{color_message(message)} #{sufix}"
+
+      logger.info log_message
+      result
+    end
+
+    def code(result)
+      result.respond_to?(:code) ? result.code : ""
+    end
+
+    def humanize_elapsed_time(time_elapsed)
+      time_elapsed >= 1 ? "%.3f secs" % time_elapsed : "#{(time_elapsed * 1000).to_i} ms"
+    end
+
+    def prefix(code = nil)
+      "[#{@label}] #{color_code(code)}"
+    end
+
+    def color_message(message)
+      "\033[1;33m#{message}\033[0m"
+    end
+
+    def color_code(code)
+      color = code == 200 ? "32" : "31"
+      code_message = code.to_s.ljust(3, " ")
+      "\033[#{color}m#{code_message}\033[0m"
+    end
+
+    def logger
+      @logger || lambda do
+        if defined?(Rails)
+          Rails.logger
+        else
+          log = ::Logger.new STDOUT
+          log.formatter = lambda {|severity, datetime, progname, msg|
+            "#{datetime.strftime("%Y-%m-%d %H:%M:%S")} #{severity.upcase} #{msg}\n"
+          }
+
+          log
+        end
+      end.yield
+    end
+  end
+end

data/lib/content_gateway/request.rb

@@ -0,0 +1,48 @@
+module ContentGateway
+  class Request
+    def initialize(method, url, headers = {}, payload = {}, proxy = nil)
+      data = { method: method, url: url, proxy: proxy || :none }.tap do |h|
+        h[:payload] = payload if payload.present?
+        h[:headers] = headers if headers.present?
+      end
+
+      @client = RestClient::Request.new(data)
+    end
+
+    def execute
+      @client.execute
+
+    rescue RestClient::ResourceNotFound => e1
+      raise ContentGateway::ResourceNotFound.new url, e1
+
+    rescue RestClient::Unauthorized => e2
+      raise ContentGateway::UnauthorizedError.new url, e2
+
+    rescue RestClient::UnprocessableEntity => e3
+      raise ContentGateway::ValidationError.new url, e3
+
+    rescue RestClient::Forbidden => e4
+      raise ContentGateway::Forbidden.new url, e4
+
+    rescue RestClient::Conflict => e5
+      raise ContentGateway::ConflictError.new url, e5
+
+    rescue RestClient::Exception => e6
+      status_code = e6.http_code
+      if status_code < 500
+        raise e6
+      else
+        raise ContentGateway::ServerError.new url, e6, status_code
+      end
+
+    rescue StandardError => e7
+      raise ContentGateway::ConnectionFailure.new url, e7
+    end
+
+    private
+
+    def url
+      @client.url
+    end
+  end
+end

data/lib/content_gateway/version.rb

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