multiconnect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 991ba66412af2a541aed7a547312cd01b4a59b73
+  data.tar.gz: eff776e9c9f55a27e1ba87ca13430d2bf077c51a
+SHA512:
+  metadata.gz: e1db9b9c47e7551fd3a713641bd08303768e667a80057846ac68a523bb93b5dbbe86f0a3875a0d8e8172a31a0197120e67a34ca03f2f8cd458763af7491fb5c5
+  data.tar.gz: 2778d5152b747fa0378e45decb9bc5855ddf85ff930f272f42e8bfb6101b45bd907302922c71938394e887fecd94895a26158b64dac596eb9d4c3885fcbe3875

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Greg Orlov
+
+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,73 @@
+# Multiconnect
+
+Multiconnect is a way to manage your server conenction fallbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multiconnect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multiconnect
+
+## Usage
+
+Let's say you have an object that wraps [JsonApiClient](http://github.com/chingor13/json_api_client) and you want to make sure that your client server has some level of failure tolerance.
+
+You want your client to make a request to the server, but if it fails you want to try to pull from cache. Here's a simple way to do this:
+
+```ruby
+module Zappos
+  module Client
+    class Shoe
+      self.site = "http://zappos.com/api"
+    end
+  end
+end
+
+class Shoe
+  self.client_class = Zappos::Client::Shoe
+
+  include Multiconnect::Connectable
+
+  # block of connections
+
+  # try to hit the server directly. If the server fails, disallow calls for 30 seconds
+  add_connection :server, client: client_class, class: CircuitBreakerServerConnection
+
+  # If the server call failed, try to fetch the value from cache. This assumes you cache that somewhere
+  add_connection :cache_fallback
+  
+
+  # whatever your client calling code is
+  def self.call_client(action, *args)
+    request(action, *args)
+  end
+end
+```
+
+You can find all these connections in the [examples file](/example_connections.rb)
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/gaorlov/multiconnect/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multiconnect"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example_connections.rb

@@ -0,0 +1,187 @@
+
+
+# crude implementation without resource helpers
+class Object << JsonApiResource::Resource
+  add_connection CacheFirstToCircuitBreakerServerConnection, client: client_class # no autmatic fallthrough to the server IN the connection. No client_class because it'll use Rails.cache
+                                  # Solicitor::Client::Lawyer
+  add_connection CircuitBreakerServerConnection, client: client_class
+  add_connection CacheFallbackConnection # no use trying to hit the client now. We laready know the server is unresponsive
+  add_connection DefaultValueConnection, client: self
+end
+
+
+module JsonApiResource
+  module Connection
+    class ServerConnection < Multiconnect::Connection::Base
+      
+      def report_error(e)
+        Honeybadger.notify(e)
+      end
+
+      def request(action, *args)
+        client.send action, *args
+
+      rescue JsonApiClient::Errors::NotFound => e
+        result = JsonApiClient::ResultSet.new
+
+        result.meta = {status: status}
+
+        result.errors = ActiveModel::Errors.new(result)
+        result.errors.add("NofFound", e.message)
+
+        result
+      end
+    end
+  end
+end
+      
+
+module JsonApiResource
+  module Connection
+    class CacheFallbackConnection < Multiconnect::Connection::Base
+
+      def report_error(e)
+      end
+
+      def request(action, *args)
+        key = sorted_args(args)
+        Rails.cache.fetch key
+      end
+    end
+  end
+end
+
+
+module JsonApiResource
+  module Connection
+    class CacheFirstToCircuitBreakerServerConnection < CircuitBreakerServerConnection
+
+      def report_error(e)
+        Honeybadger.notify(e)
+        InfluxDB.notify(e)
+      end
+
+      def request(action, *args)
+        key = key_from_args(args)
+        Rails.cache.fetch key do
+          super
+        end
+      end
+
+      private
+
+      def key_from_args(args)
+        # downcase everything and sort the keys alpabetically so that {q: "dui", loc: "seattle"} is the same as {loc:"seattle", q: "dui"}
+      end
+    end
+  end
+end
+
+module JsonApiResource
+  module Connection
+    class CircuitBreakerServerConnection < Multiconnect::Connection::Base
+
+      def report_error(e)
+        Honeybadger.notify(e)
+        InfluxDB.notify(e)
+      end
+
+      def request(action, *args)
+        if ready_for_request?
+          client.send :find, args
+        else
+          raise "fall through!"
+        end
+
+      rescue JsonApiClient::Errors::NotFound => e
+        result = JsonApiClient::ResultSet.new
+
+        result.meta = {status: status}
+
+        result.errors = ActiveModel::Errors.new(result)
+        result.errors.add( "FileNotFound", e.message )
+
+        result
+      rescue => e
+        @responding = false
+        # default circuit broken for 30 seconds. This should probably be 1 - 2 - 5 - 15 - 30 - 1 min - 2 min*
+        @timeout = 30.seconds.from.
+
+        # propagate the error up to be handled by Connection::Base
+        raise e
+      end
+
+      private 
+
+      def ready_for_request?
+        @responding || Time.now > @timeout
+      end
+    end
+  end
+end
+
+
+class Shoe
+  self.client_class = Faraday
+
+  include Multiconnect::Connectable
+
+  # block of connections
+
+  # try to hit the server directly. If the server fails, disallow calls for 30 seconds
+  add_connection :server, client: Solicitor::Client::Lawyer, class: CircuitBreakerServerConnection
+
+  # If the server call failed, try to fetch the value from cache. This assumes you cache that somewhere
+  add_connection :cache_fallback
+
+
+  # whatever your client calling code is
+  def self.where(opts)
+    request opts do
+      client.where
+  end
+
+  def self.find(opts)
+    request(:find, opts).data
+  end
+end
+
+
+Shoe.request(key: 'asdf') do |connection_client|
+  connection_client.where(foo: 'bar').first
+end
+
+
+class Lawyer < JsonApiResource::Resource
+  wraps Solicitor::Client::Lawyer
+
+  self.legal_zoom_client = LZ::Client::Lawyer
+
+  add_connection :avvo_api, client: Faraday
+  add_connection :legal_zoom, client: legal_zoom_client
+
+  def self.find(*args)
+    request = request( :find, args )
+    connection_status = request.connection
+    request.data
+  end
+
+end
+
+# controler
+
+def show
+  @lawyer = Lawyer.find(params[:id])
+  render_500 if @lawyer.using_fallback(:cache_fallback)?
+end
+
+def search
+  @lawyers = Lawyer.search(params)
+  
+  @lawyers.using_fallback(:cache_fallback)?
+
+end
+
+def index
+  @lawyers = Lawyer.where(params[:whatever], per_page: 4, order: :created_at)
+end

data/lib/multiconnect.rb

@@ -0,0 +1,9 @@
+require "multiconnect/version"
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+
+module Multiconnect
+  autoload :Connection,     'multiconnect/connection'
+  autoload :Connectable,    'multiconnect/connectable'
+end

data/lib/multiconnect/connectable.rb

@@ -0,0 +1,26 @@
+module Multiconnect
+  module Connectable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        class_attribute :_connections
+        self._connections = []
+        
+        def add_connection(connection_class, options = {})
+          
+          self._connections = _connections + [connection_class.new(options)]
+
+        end
+
+        def request(action, *args)
+          self._connections.each do |connection|
+            result = connection.execute(action, *args)
+            return result if result.success?
+          end
+          raise "Multiconnect Error: #{self} has failed to request #{action}"
+        end
+      end
+    end
+  end
+end

data/lib/multiconnect/connection.rb

@@ -0,0 +1,6 @@
+module Multiconnect
+  module Connection
+    autoload :Base,       'multiconnect/connection/base'
+    autoload :Result,     'multiconnect/connection/result'
+  end
+end

data/lib/multiconnect/connection/base.rb

@@ -0,0 +1,33 @@
+module Multiconnect
+  module Connection
+    class Base
+
+      attr_accessor :client
+
+      def initialize(options = {})
+        self.client = options.fetch :client, nil
+        @except = Array(options.fetch :except, [])
+      end
+
+      def request(action, *args)
+        raise NotImplementedError
+      end
+
+      def report_error(e)
+        raise NotImplementedError
+      end
+
+      def execute(action, *args)
+        if @except.include? action
+          Result.new 
+        else
+          Result.new status: Result::SUCCESS, data: request(action, *args), connection: self.class
+        end
+
+      rescue => e
+        report_error(e)
+        Result.new
+      end
+    end
+  end
+end

data/lib/multiconnect/connection/result.rb

@@ -0,0 +1,26 @@
+module Multiconnect
+  module Connection
+    class Result
+      SUCCESS = :success
+      FAILURE = :failure
+      
+      def initialize(opts = {})
+        @status = opts.fetch :status, FAILURE
+        @data = opts.fetch :data, nil
+        @connection = opts.fetch :connection, nil
+      end
+
+      def success?
+        @status == SUCCESS
+      end
+
+      def using_fallback?(connection)
+        @connection == connection
+      end
+
+      def method_missing(method, *args, &block)
+        @data.send method, *args, &block
+      end
+    end
+  end
+end

data/lib/multiconnect/version.rb

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

data/multiconnect.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multiconnect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multiconnect"
+  spec.version       = Multiconnect::VERSION
+  spec.authors       = ["Greg Orlov"]
+  spec.email         = ["gaorlov@gmail.com"]
+
+  spec.summary       = %q{Allows a client to try several methods of fetching data with fallbacks}
+  spec.description   = %q{Allows a client to try several methods of fetching data with fallbacks}
+  spec.homepage      = "https://github.com/gaorlov/multiconnect"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "m"
+  spec.add_development_dependency "simplecov"
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: multiconnect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Orlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: m
+  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: simplecov
+  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: Allows a client to try several methods of fetching data with fallbacks
+email:
+- gaorlov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example_connections.rb
+- lib/multiconnect.rb
+- lib/multiconnect/connectable.rb
+- lib/multiconnect/connection.rb
+- lib/multiconnect/connection/base.rb
+- lib/multiconnect/connection/result.rb
+- lib/multiconnect/version.rb
+- multiconnect.gemspec
+homepage: https://github.com/gaorlov/multiconnect
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Allows a client to try several methods of fetching data with fallbacks
+test_files: []