method_interceptor 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brian Zeligson
+
+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,68 @@
+# ParameterTransformers
+
+This gem provides a proxy which can encapsulate transformers to be
+applied to given method/parameter combinations before the target
+method is called or method response after it is called.
+
+It is useful for scenarios where you might have a stateful value that
+needs to be consistently applied to other parameters being passed to
+library code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parameter_transformers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parameter_transformers
+
+## Usage
+
+Here's an example of using the proxy to consistently apply an authentication header to all requests made with the RestClient gem and parse responses as JSON:
+
+```ruby
+require 'rest_client'
+require 'parameter_transformers'
+require 'json'
+
+add_auth_header = ->(headers) { (headers || {}).merge('AUTH-HEADER' => 'key') }
+p_transformers = [:get, :post, :put, :delete].map do |method|
+  [[method, :headers], add_auth_header]
+end
+r_transformers = [:get, :post, :put, :delete].map do |method|
+  [method, JSON.method(:parse)]
+end
+rc = ParameterTransformers::Proxy.new(RestClient, Hash[p_transformers], Hash[r_transformers])
+
+# automatically adds {'AUTH-HEADER' => 'key'} to headers on all calls now
+# and automatically parses responses as json
+rc.get('http://somesite.com')
+rc.post('http://somesite.com', {foo: 'bar'})
+rc.put('http://somesite.com', {foo: 'bar'})
+rc.delete('http://somesite.com')
+```
+
+Note per example above the format for transformers is a hash where
+keys are an array of [:method_name, :argument_name] and values
+are procs which receive a copy of the passed argument, and return the
+transformed value to be passed to the method on the target object
+
+Meanwhile for the response transformers, the format is a hash where
+keys are the method name, and values are procs which receive the actual
+response
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/parameter_transformers/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/method_interceptor/version.rb

@@ -0,0 +1,3 @@
+module MethodInterceptor
+  VERSION = "0.0.1"
+end

data/lib/method_interceptor.rb

@@ -0,0 +1,40 @@
+require "method_interceptor/version"
+
+module MethodInterceptor
+
+  class Proxy
+
+    instance_methods.each do |m|
+      undef_method(m) unless m =~ /(^__|^nil\?$|^send$|^object_id$)/
+    end
+
+    def initialize(target, p_transformers={}, r_transformers={})
+      @target = target
+      @p_transformers = p_transformers
+      @r_transformers = r_transformers
+    end
+
+    def respond_to?(symbol, include_priv=false)
+      @target.respond_to?(symbol, include_priv)
+    end
+
+    def method_missing(m, *args, &block)
+      params = @target.method(m).parameters.map(&:last)
+      t_args = args.dup
+      params.each_with_index do |param, ix|
+        if @p_transformers[[m, param]] &&
+          @p_transformers[[m, param]].kind_of?(Proc)
+            t_args[ix] =
+              @p_transformers[[m, param]].call(t_args[ix])
+        end
+      end
+      r = @target.send(m, *t_args, &block)
+      if @r_transformers[m] &&
+        @r_transformers[m].kind_of?(Proc)
+          @r_transformers[m].call(r)
+      else
+        r
+      end
+    end
+  end
+end

data/method_interceptor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_interceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "method_interceptor"
+  spec.version       = MethodInterceptor::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["brian.zeligson@gmail.com"]
+  spec.summary       = %q{Provides a proxy object that allows consistent transformation of arguments passed to and responses received from target object methods}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/method_interceptor_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MethodInterceptor::Proxy do
+
+  class Tester
+
+    def add_one_to_both(a, b)
+      [a+1, b+1]
+    end
+
+    def self.add_one_to_both(a, b)
+      [a+1, b+1]
+    end
+  end
+
+  it 'takes given parameter/response transformers and applies whenever matched' do
+    parameter_transformers = {
+      [:add_one_to_both, :a] => ->(x) { x + 3 },
+      [:add_one_to_both, :b] => ->(x) { x - 3 }
+    }
+    tc = MethodInterceptor::Proxy.new(Tester, parameter_transformers)
+    r = tc.add_one_to_both(4, 5)
+    expect(r.first).to eq(8)
+    expect(r.last).to eq(3)
+
+    t = MethodInterceptor::Proxy.new(Tester.new, parameter_transformers)
+    r = t.add_one_to_both(4, 5)
+    expect(r.first).to eq(8)
+    expect(r.last).to eq(3)
+
+    response_transformers = {
+      add_one_to_both: ->(x) { x.map {|i| i * 3} }
+    }
+    t = MethodInterceptor::Proxy.new(Tester.new,
+                                     parameter_transformers,
+                                     response_transformers)
+    r = t.add_one_to_both(4, 5)
+    expect(r.first).to eq(24)
+    expect(r.last).to eq(9)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  require_relative '../lib/method_interceptor'
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: method_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- brian.zeligson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/method_interceptor.rb
+- lib/method_interceptor/version.rb
+- method_interceptor.gemspec
+- spec/method_interceptor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a proxy object that allows consistent transformation of arguments
+  passed to and responses received from target object methods
+test_files:
+- spec/method_interceptor_spec.rb
+- spec/spec_helper.rb