gateway 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 3.0"
+gem "resource_pool", ">= 0.2.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Aaron Qian
+
+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.rdoc

@@ -0,0 +1,29 @@
+= gateway
+
+Gateway is an opinionated generic IO connection manager. It is created to be a manager / wrapper that can provide a uniform behavior across various IO connection types such as HTTP, Memcache, database, or even generic TCP / UDP protocols.
+
+This gem provides a `Gateway::Base` class for other connection types to be built upon. It provides the following features:
+
+* Connection Management. Choose from single, connection pooling, or thread local.
+* Error Transform / Handling.
+* Timeouts
+* Automatic retry
+* performance logging
+* Newrelic instrumentation. ( If newrelic is loaded. )
+
+
+== Contributing to gateway
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Aaron Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gateway"
+  gem.homepage = "http://github.com/aq1018/gateway"
+  gem.license = "MIT"
+  gem.summary = %Q{ Opinionated Generic IO Connection Manager }
+  gem.description = %Q{ Opinionated Generic IO Connection Manager }
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gateway/base.rb

@@ -0,0 +1,70 @@
+module Gateway
+  class Base
+    include Gateway::Feature::NewRelic
+    include Gateway::Feature::Performance
+    include Gateway::Feature::Timeout
+    include Gateway::Feature::Retry
+    include Gateway::Feature::ErrorHandle
+    include Gateway::Feature::CategorizeError
+    include Gateway::Connection
+
+    categorize_error SystemCallError, SocketError, IOError,
+                     :as => :bad_gateway
+
+    categorize_error Timeout::Error,
+                     :as => :timeout
+
+    categorize_error SystemCallError, SocketError, IOError,
+                     :as => :retry
+
+    attr_reader :options, :name
+
+    def initialize(name, opts)
+      @name = name
+      @options = opts
+    end
+
+    protected
+
+    def bad_gateway_errors(action)
+      errors_for(action, :bad_gateway)
+    end
+
+    def timeout_errors(action)
+      errors_for(action, :timeout)
+    end
+
+    def retry_errors(action)
+      errors_for(action, :retry)
+    end
+
+    def run_bad_gateway_callbacks(action)
+      run_callbacks_for(action, :bad_gateway)
+    end
+
+    def run_timeout_callbacks(action)
+      run_callbacks_for(action, :timeout)
+    end
+
+    def run_retry_callbacks(action)
+      run_callbacks_for(action, :retry)
+    end
+
+    def execute(action, req, opts={}, &block)
+      with_connection(opts) do |conn|
+        with_retry(action, opts) do
+          with_perf(action, req, opts) do
+            with_error_handle(action, conn, opts) do
+              with_new_relic(opts) do
+                with_timeout(opts) do
+                  block.call(conn)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/gateway/connection/pool.rb

@@ -0,0 +1,27 @@
+module Gateway
+  module Connection
+    module Pool
+      protected
+
+      def with_pool(&block)
+        pool.hold do |conn|
+          block.call(conn)
+        end
+      end
+
+      def purge_current_connection_from_pool!
+        pool.trash_current!
+      end
+
+      def pool
+        @pool ||= ResourcePool.new(pool_options) { connect }
+      end
+
+      def pool_options
+        @pool_options ||= {
+          :delete_proc => lambda{ |conn| disconnect conn }
+        }.merge(options[:pool])
+      end
+    end
+  end
+end

data/lib/gateway/connection/single.rb

@@ -0,0 +1,20 @@
+module Gateway
+  module Connection
+    module Single
+      protected
+      def with_single(&block)
+        conn = connect
+        begin
+          block.call conn
+        ensure
+          disconnect(conn)
+        end
+      end
+
+      def purge_current_connection_from_single!
+        # This is intentionally empty.
+        # Do not remove this method.
+      end
+    end
+  end
+end

data/lib/gateway/connection/thread_local.rb

@@ -0,0 +1,24 @@
+module Gateway
+  module Connection
+    module ThreadLocal
+      protected
+
+      def with_thread_local(&block)
+        conn = thread_local_connection
+        block.call conn
+      end
+
+      def purge_current_connection_from_thread_local!
+        Thread.current[thread_local_connection_name] = nil
+      end
+
+      def thread_local_connection_name
+        "#{self.class.name}:#{self.name}"
+      end
+
+      def thread_local_connection
+        Thread.current[thread_local_connection_name] ||= connect
+      end
+    end
+  end
+end

data/lib/gateway/connection.rb

@@ -0,0 +1,34 @@
+module Gateway
+  module Connection
+    include Single
+    include ThreadLocal
+    include Pool
+
+    protected
+
+    def connect
+      raise "Abstract Method"
+    end
+
+    def disconnect(conn)
+      raise "Abstract Method"
+    end
+
+    def reconnect(conn)
+      raise "Abstract Method"
+    end
+
+    def purge_current_connection!
+      send "purge_current_connection_from_#{connection_type}!"
+    end
+
+    def connection_type
+      @connection_type ||= (options[:connection_type] || :thread_local)
+    end
+
+    def with_connection(opts={}, &block)
+      return with_single(&block) if opts[:persistent] == false
+      send "with_#{connection_type}", &block
+    end
+  end
+end

data/lib/gateway/errors.rb

@@ -0,0 +1,39 @@
+module Gateway
+  class Error < RuntimeError
+    attr_accessor :status, :inner_error
+    def self.wrap(error)
+      e = self.new("#{self.name} - #{error.class.name}: #{error.message}")
+      e.inner_error = error
+      e
+    end
+  end
+
+  # When backend stops responding within given time.
+  class GatewayTimeout < Error
+    def initialize(msg)
+      super
+      self.status = "504"
+    end
+  end
+
+  # When backend did not send back an (processible) response.
+  # Usually when connection is dropped.
+  class BadGateway < Error
+    def initialize(msg)
+      super
+      self.status = "502"
+    end
+  end
+
+  # When a response is returned, but is considered unsuccessful.
+  # This is application specific.
+  # For HTTP responses: 4xx, 5xx can be considered bad response
+  class BadResponse < BadGateway
+    attr_accessor :info
+    def initialize(msg, info=nil)
+      msg = "#{msg}\nInfo:\n#{info.inspect}" if info
+      super msg
+      self.info = info
+    end
+  end
+end

data/lib/gateway/feature/categorize_error.rb

@@ -0,0 +1,82 @@
+module Gateway
+  module Feature
+    module CategorizeError
+      def self.included(klass)
+        klass.class_eval do
+          class_attribute :error_catalog, :error_categories
+          self.error_catalog = {}
+          self.error_categories = [:bad_gateway, :timeout, :retry]
+
+          extend ClassMethods
+        end
+      end
+
+      protected
+
+      def errors_for(action, error_category)
+        cat = self.error_catalog[error_category]
+        return [] if cat.blank?
+
+        errors  = cat[action] ? cat[action][:errors] : []
+        default_errors = cat[:all][:errors] || []
+        errors + default_errors
+      end
+
+      def error_callbacks_for(action, error_category)
+        cat = self.error_catalog[error_category]
+        return [] if cat.blank?
+
+        lambdas = cat[action]  ? cat[action][:lambdas] : []
+        default_lambdas = cat[:all][:lambdas] || []
+        lambdas + default_lambdas
+      end
+
+      def run_callbacks_for(action, error_category)
+        error_callbacks_for(action, error_category).each do |cb|
+          cb.call self
+        end
+      end
+
+      module ClassMethods
+        protected
+
+        def categorize_error(*params, &block)
+          errors, actions, categories = extract_params(params)
+
+          self.error_catalog ||= {}
+
+          categories.each do |error_category|
+            self.error_catalog[error_category] ||= {}
+            actions.each do |action|
+              self.error_catalog[error_category][action] ||= {}
+              self.error_catalog[error_category][action][:errors] ||= []
+              self.error_catalog[error_category][action][:errors] += errors
+              self.error_catalog[error_category][action][:lambdas] ||= []
+              self.error_catalog[error_category][action][:lambdas] << block if block
+            end
+          end
+        end
+
+        def extract_params(params)
+          opt = params.pop
+          opt ||= {}
+          errors = params.flatten
+
+          actions = [opt[:for]].flatten.compact
+          actions = [:all] if actions.blank?
+
+          categories = [opt[:as]].flatten.compact
+          categories = error_categories if categories.blank?
+
+          categories.each do |error_category|
+            unless error_categories.include?(error_category.to_sym)
+              raise "Error Category: #{error_category} must be one of #{error_categories}."
+            end
+          end
+
+          [errors, actions, categories]
+        end
+      end
+    end
+  end
+end

data/lib/gateway/feature/error_handle.rb

@@ -0,0 +1,39 @@
+module Gateway
+  module Feature
+    module ErrorHandle
+      protected
+
+      def with_error_handle(action, conn, opts={}, &block)
+        return block.call if opts[:handle_error] == false
+
+        begin
+          block.call
+        rescue *bad_gateway_errors(action) => e
+          run_bad_gateway_callbacks(action)
+          reconnect(conn)
+          raise Gateway::BadGateway.wrap(e)
+        rescue *timeout_errors(action) => e
+          run_timeout_callbacks(action)
+          reconnect(conn)
+          raise Gateway::GatewayTimeout.wrap(e)
+        end
+      end
+
+      def bad_gateway_errors(action)
+        raise "Abstract Method"
+      end
+
+      def timeout_errors(action)
+        raise "Abstract Method"
+      end
+
+      def run_bad_gateway_callbacks(action)
+        raise "Abstract Method"
+      end
+
+      def run_timeout_callbacks(action)
+        raise "Abstract Method"
+      end
+    end
+  end
+end

data/lib/gateway/feature/new_relic.rb

@@ -0,0 +1,21 @@
+module Gateway
+  module Feature
+    module NewRelic
+      protected
+
+      def with_new_relic(opts={}, &block)
+        return block.call unless opts.fetch(:record_newrelic, record_newrelic)
+
+        # per newrelic support: ['External/servicename/all', 'External/allWeb']
+        metric_names = ["External/#{name}/all", 'External/allWeb']
+        ::NewRelic::Agent::MethodTracer.trace_execution_scoped metric_names do
+          block.call
+        end
+      end
+
+      def record_newrelic
+        defined?(::NewRelic) && options.fetch(:record_newrelic, false)
+      end
+    end
+  end
+end

data/lib/gateway/feature/performance.rb

@@ -0,0 +1,53 @@
+module Gateway
+  module Feature
+    module Performance
+      def self.included(klass)
+        klass.class_eval do
+          class_attribute :profiler
+        end if klass.is_a?(Class)
+      end
+
+      def profiler
+        @profiler ||= (options[:profiler] || self.class.profiler)
+      end
+
+      protected
+
+      def with_perf(action, req, opts={}, &block)
+        return block.call if opts[:perf] == false
+
+        status     = success_status
+        desc       = success_message
+        start_time = Time.now
+
+        begin
+          block.call
+        rescue => e
+          status = error_status(e)
+          desc = error_message(e)
+          raise
+        ensure
+          duration = Time.now - start_time
+          req = "#{action.to_s.upcase} #{req}"
+          profiler.performance(name.to_s, duration, status, desc, req)
+        end
+      end
+
+      def success_status
+        200
+      end
+
+      def success_message
+        "OK"
+      end
+
+      def error_status(error)
+        error.respond_to?(:status) ? error.status : 500
+      end
+
+      def error_message(error)
+        "#{error.class.name} - #{error.message}"
+      end
+    end
+  end
+end

data/lib/gateway/feature/retry.rb

@@ -0,0 +1,41 @@
+module Gateway
+  module Feature
+    module Retry
+      protected
+
+      def with_retry(action, opts={}, &block)
+        return block.call unless opts.fetch(:retry, retry?)
+
+        retried = false
+        begin
+          block.call
+        rescue => e
+          if !retried && retry_error?(action, e)
+            run_retry_callbacks(action)
+            retried = true
+            retry
+          end
+          raise
+        end
+      end
+
+      def retry_error?(action, error)
+        error = error.inner_error if error.is_a?(Gateway::Error)
+        errors = retry_errors(action)
+        errors.any?{ |klass| error.is_a?(klass) }
+      end
+
+      def retry_errors(action)
+        raise "Abstract Method"
+      end
+
+      def run_retry_callbacks(action)
+        raise "Abstract Method"
+      end
+
+      def retry?
+        @retry ||= options.fetch(:retry, true)
+      end
+    end
+  end
+end

data/lib/gateway/feature/timeout.rb

@@ -0,0 +1,18 @@
+module Gateway
+  module Feature
+    module Timeout
+      DEFAULT_TIMEOUT = 2
+
+      def timeout
+        @timeout ||= (options[:timeout] || Gateway::Feature::Timeout::DEFAULT_TIMEOUT)
+      end
+
+      protected
+
+      def with_timeout(opts={}, &block)
+        return block.call if opts[:timeout] == false
+        ::Timeout.timeout(opts[:timeout] || timeout){ block.call }
+      end
+    end
+  end
+end

data/lib/gateway.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/class/attribute'
+require 'timeout'
+require 'net/http'
+
+require 'gateway/errors'
+
+require 'gateway/feature/retry'
+require 'gateway/feature/new_relic'
+require 'gateway/feature/timeout'
+require 'gateway/feature/error_handle'
+require 'gateway/feature/categorize_error'
+require 'gateway/feature/performance'
+
+require 'gateway/connection/pool'
+require 'gateway/connection/thread_local'
+require 'gateway/connection/single'
+require 'gateway/connection'
+
+require 'gateway/base'
+

data/spec/gateway_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Gateway" do
+  it "be worked on"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'gateway'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &20040260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20040260
+- !ruby/object:Gem::Dependency
+  name: resource_pool
+  requirement: &20039500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *20039500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20038340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *20038340
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &20037640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *20037640
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &20037020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *20037020
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &20036340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *20036340
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &20035680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *20035680
+description: ! ' Opinionated Generic IO Connection Manager '
+email: aq1018@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/gateway.rb
+- lib/gateway/base.rb
+- lib/gateway/connection.rb
+- lib/gateway/connection/pool.rb
+- lib/gateway/connection/single.rb
+- lib/gateway/connection/thread_local.rb
+- lib/gateway/errors.rb
+- lib/gateway/feature/categorize_error.rb
+- lib/gateway/feature/error_handle.rb
+- lib/gateway/feature/new_relic.rb
+- lib/gateway/feature/performance.rb
+- lib/gateway/feature/retry.rb
+- lib/gateway/feature/timeout.rb
+- spec/gateway_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aq1018/gateway
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1877491257505437583
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Opinionated Generic IO Connection Manager
+test_files: []