endow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 034bba2791918b03fcc0184b4db0e76a0131b1eb
+  data.tar.gz: 40b310f28ce7f8acba88bfb209959d8ac46cbd72
+SHA512:
+  metadata.gz: 8ffd32c6d7977a8bf86312a1b85bb0336376bebc9238c3f5914dcc32407cfb4ce0efa3fd27415d5820c122f4eb15e6532c415e6a4650fb46365721ee6a677eb3
+  data.tar.gz: cb53e92145b41b15a5be074fe441cdb52c63f669fb0a5eafe22db5b53442531d98ba580424849d5ff29368e773c1de27224e8b6a4296e6674bc34913ed1dee10

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+gemdev

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in endow.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Harrelson
+
+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

@@ -0,0 +1,22 @@
+# Endow
+
+A library to assist in consuming API endpoints.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'endow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install endow
+
+
+## Usage
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/endow.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'endow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "endow"
+  spec.version       = Endow::VERSION
+  spec.authors       = ["Jason Harrelson"]
+  spec.email         = ["jason@lookforwardenterprises.com"]
+  spec.description   = %q{A library to assist in consuming API endpoints.}
+  spec.summary       = %q{A library to assist in consuming API endpoints.}
+  spec.homepage      = "https://github.com/midas/endow"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 3"
+  spec.add_dependency "httpi"#, "~> 1"
+  spec.add_dependency "multi_json"#, "~> 1"
+  spec.add_dependency "retryable-rb", "~> 1"
+  spec.add_dependency "wisper"#, "~> 1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/ansi.rb

@@ -0,0 +1,36 @@
+class ANSI
+
+  def self.resolve_text( color, &block )
+    text = nil
+    if block_given?
+      text = block.call + reset
+    end
+    "\e[#{chart[color.to_sym]}m#{text}"
+  end
+
+  def self.reset
+    "\e[0m"
+  end
+
+  def self.chart
+    {
+      black: 30,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      magenta: 35,
+      cyan: 36,
+      white: 37
+    }
+  end
+
+  chart.keys.each do |color|
+
+    define_singleton_method color do |&block|
+      resolve_text color, &block
+    end
+
+  end
+
+end

data/lib/endow/configuration.rb

@@ -0,0 +1,13 @@
+module Endow
+  class Configuration
+
+    def logger
+      @logger
+    end
+
+    def logger=( logger )
+      @logger = logger
+    end
+
+  end
+end

data/lib/endow/endpoint.rb

@@ -0,0 +1,238 @@
+module Endow
+  module Endpoint
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Retryable
+      include ErrorHandling
+      include Logging
+      include Wisper::Publisher
+    end
+
+    def initialize
+      set_content nil
+    end
+
+    def call
+      with_graceful_error_handling do
+        attempt = 0
+        retryable on: retryable_errors,
+                  times: retryable_times,
+                  sleep: retryable_sleep do
+          attempt += 1
+          log_connection( self, attempt )
+
+          if success_error_codes.include?( response.code )
+            handle_successful_response
+          else
+            _handle_unsuccessful_response
+          end
+        end
+      end
+    end
+
+    def request_url
+      request.url
+    end
+
+    def request_query
+      request.query
+    end
+
+    def request_body
+      request.body
+    end
+
+    def request_headers
+      request.headers
+    end
+
+    def to_s
+      "#<#{self.class.name}:#{object_id} " +
+        "@verb=#{http_verb.inspect} " +
+        "@url=#{request_url.to_s.inspect} " +
+        "@query=#{request_query.inspect} " +
+        "@body=#{request_body.inspect } " +
+        "@headers=#{request_headers.inspect}>"
+    end
+
+  protected
+
+    def response
+      @response ||= HTTPI.request( http_verb, request )
+    end
+
+    def request
+      @request ||= HTTPI::Request.new( request_params ).tap do |req|
+        req.headers = default_headers
+        req.auth.ssl.verify_mode = ssl_verify_mode
+      end
+    end
+
+    def request_params
+      {
+        url: url,
+        open_timeout: open_timeout_in_seconds,
+        read_timeout: read_timeout_in_seconds
+      }.reject { |k,v| v.blank? }
+    end
+
+    def handle_successful_response
+      check_response_on_success( response )
+
+      response_wrapper_class.new( decode_body( response.body )).tap do |response_body|
+        publish :success,
+                response_body,
+                response
+      end
+    end
+
+    def check_response_on_success( response )
+      # purposefully empty
+    end
+
+    def response_wrapper_class
+      raise NotImplementedError
+    end
+
+    def handle_unsuccessful_response
+      publish :error, response
+    end
+
+    def _handle_unsuccessful_response
+      custom_handler_method = "handle_unsuccessful_response_#{response.code}"
+
+      unless respond_to?( custom_handler_method )
+        handle_unsuccessful_response
+        return
+      end
+
+      send( custom_handler_method )
+    end
+
+    def set_content( content )
+      send "set_content_as_#{content_type_name}", content
+    end
+
+    def set_content_as_no_content_type_specified( content )
+      if http_verb.to_sym == :get
+        request.query = make_query_string( content )
+      elsif http_verb.to_sym == :post
+        request.body = make_query_string( content )
+      end
+    end
+
+    def set_content_as_application_json( content )
+      request.body = MultiJson.dump( content || {} )
+    end
+
+    def decode_body( content )
+      send "decode_body_as_#{accept_name}", content
+    end
+
+    def decode_body_as_no_accept_specified( content )
+      content
+    end
+
+    def decode_body_as_application_json( content )
+      MultiJson.load( content )
+    end
+
+    def decode_body_as_application_xml( content )
+      raise NotImplementedError
+    end
+
+    def content_type_name
+      content_type.blank? ?
+        :no_content_type_specified :
+        content_type.split( '/' ).join( '_' )
+    end
+
+    def accept_name
+      accept.blank? ?
+        :no_accept_specified :
+        accept.split( '/' ).join( '_' )
+    end
+
+    def default_headers
+      {
+        'Accept'       => accept,
+        'Content-Type' => content_type,
+      }.reject { |k,v| v.blank? }
+    end
+
+    def make_query_string( content )
+      content.merge( base_content ).to_query
+    end
+
+    def base_content
+      {}
+    end
+
+    def url
+      File.join( base_url, endpoint )
+    end
+
+    def http_verb
+      :get
+    end
+
+    def success_error_codes
+      [200]
+    end
+
+    def open_timeout_in_seconds
+      15
+    end
+
+    def read_timeout_in_seconds
+      15
+    end
+
+    def retryable_times
+      1
+    end
+
+    def retryable_sleep
+      false
+    end
+
+    def accept
+      nil
+    end
+
+    def accept_version
+      raise NotImplementedError
+    end
+
+    def content_type
+      nil
+    end
+
+    def endpoint
+      raise NotImplementedError
+    end
+
+    def authentication_token_key
+      raise NotImplementedError
+    end
+
+    def ssl_verify_mode
+      raise NotImplementedError
+    end
+
+    def ensure_date( time_or_string )
+      return nil if time_or_string.blank?
+      if time_or_string.is_a?( String )
+        begin
+          return Date.strptime( time_or_string, Date::DATE_FORMATS[:api_internal] )
+        rescue ArgumentError
+          return Date.strptime( time_or_string, Date::DATE_FORMATS[:isdn] )
+        end
+      end
+      time_or_string.to_date
+    end
+
+  end
+end

data/lib/endow/error_handling.rb

@@ -0,0 +1,29 @@
+module Endow
+  module ErrorHandling
+
+  protected
+
+    def retryable_errors
+      graceful_errors
+    end
+
+    def graceful_errors
+      graceful_errors_map.keys
+    end
+
+    def graceful_errors_map
+      raise NotImplementedError
+    end
+
+    def with_graceful_error_handling( &block )
+      block.call
+    rescue *graceful_errors => e
+      msg = "#{self.class.name}: #{graceful_errors_map[e.class][:msg]}"
+      log_graceful_error( msg )
+      raise graceful_errors_map[e.class][:klass],
+            msg,
+            e.backtrace
+    end
+
+  end
+end

data/lib/endow/logger.rb

@@ -0,0 +1,48 @@
+module Endow
+  class Logger
+
+    #class_attribute :logger
+    #self.logger = nil
+
+    def self.log_connection( service, attempt )
+      log "#{green_prefix} #{service.class.name} (Attempt #{attempt})"
+    end
+
+    def self.log_graceful_error( msg )
+      log "#{red_prefix} #{msg}"
+    end
+
+    def self.log( msg )
+      return unless logger
+      #TODO make this more adaptable
+      logger.info( msg )
+    end
+
+    def self.logger
+      Endow.configuration.logger
+    end
+
+    def self.green_prefix
+      #TODO change to another ANSI library
+      "#{indention}[#{ANSI.green { label }}]"
+    end
+
+    def self.red_prefix
+      #TODO change to another ANSI library
+      "#{indention}[#{ANSI.red { error_label }}]"
+    end
+
+    def self.label
+      "Service Connection"
+    end
+
+    def self.error_label
+      "Service ERROR"
+    end
+
+    def self.indention
+      "  "
+    end
+
+  end
+end

data/lib/endow/logging.rb

@@ -0,0 +1,13 @@
+module Endow
+  module Logging
+
+    def log_connection( service, attempt )
+      Endow::Logger.log_connection( service, attempt )
+    end
+
+    def log_graceful_error( msg )
+      Endow::Logger.log_graceful_error( msg )
+    end
+
+  end
+end

data/lib/endow/version.rb

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

data/lib/endow.rb

@@ -0,0 +1,26 @@
+require 'active_support'
+require 'active_support/core_ext/string'
+require "httpi"
+require "multi_json"
+require "retryable"
+require "wisper"
+require "endow/version"
+require "ansi"
+
+module Endow
+
+  autoload :Configuration, 'endow/configuration'
+  autoload :Endpoint,      'endow/endpoint'
+  autoload :ErrorHandling, 'endow/error_handling'
+  autoload :Logger,        'endow/logger'
+  autoload :Logging,       'endow/logging'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield( configuration ) if block_given?
+  end
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: endow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 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: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: retryable-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: A library to assist in consuming API endpoints.
+email:
+- jason@lookforwardenterprises.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- endow.gemspec
+- lib/ansi.rb
+- lib/endow.rb
+- lib/endow/configuration.rb
+- lib/endow/endpoint.rb
+- lib/endow/error_handling.rb
+- lib/endow/logger.rb
+- lib/endow/logging.rb
+- lib/endow/version.rb
+homepage: https://github.com/midas/endow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.5
+signing_key: 
+specification_version: 4
+summary: A library to assist in consuming API endpoints.
+test_files: []