rack-remote 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ee084f59c76f39f41a7614c79e705f1fb5a72ae
+  data.tar.gz: 99063c7072a7088498a142199775ffc9344455f2
+SHA512:
+  metadata.gz: 502915a20911dcf7c64c2db22dba774a92582c9da83ed672d0bb6d079cf543fe276f5b0ecf5d3d091b4b58da5e743bcea5d860569ac4cd3a9f5edbdd36688873
+  data.tar.gz: 31a421babc4c1a5b8ae7f3da06a362b4b7b8c59e80f3a5789ab32f1c1531a3060c3b55e3e6fa0076d7b7c9ce0c1a579c73b86202ad5af54926b7bf18be0b9d4e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without development
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby
+- rbx-19mode

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Development gems
+#
+gem 'rake'
+gem 'rspec'
+gem 'coveralls'
+gem 'webmock', '~> 1.7'
+gem 'rack-test'
+
+# Specify your gem's dependencies in acfs.gemspec
+gemroot = File.dirname File.absolute_path __FILE__
+gemspec path: gemroot

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+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,51 @@
+# Rack::Remote
+
+*Rack::Remote* is a small request intercepting Rack middleware to invoke
+remote calls over HTTP. This can be used to invoke e.g. factories on
+remote services for running integration tests on distributed applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-remote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-remote
+
+## Usage
+
+### On server/service side
+
+Register available remote calls:
+
+```ruby
+Rack::Remote.register :factory_girl do |params, env, request|
+  FactoryGirl.create params[:factory]
+end
+```
+
+Return value can be a Rack response array or any object that will be converted to JSON.
+
+### On client side
+
+```ruby
+Rack::Remote.add :srv1, 'http://serv.domain.tld/proxyed/path'
+Rack::Remote.invoke :srv1, :factory_girl, factory: 'user'
+Rack::Remote.invoke 'http://serv.domain.tld/proxyed/path', :factory_girl, factory: 'user'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+4. Add specs
+5. Add features
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w(lib/**/*.rb)
+    t.options = %w(--output-dir doc/)
+  end
+rescue LoadError
+end

data/lib/rack/remote.rb

@@ -0,0 +1,105 @@
+require 'rack/remote/version'
+require 'rack/request'
+require 'multi_json'
+
+module Rack
+
+  # Rack::Remote is a Rack middleware for intercepting calls
+  # and invoking remote calls. It can be used to call remote
+  # function for test instructions in distributed systems.
+  #
+  class Remote
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      return @app.call(env) unless env['HTTP_X_RACK_REMOTE_CALL']
+
+      request = ::Rack::Request.new(env)
+      call    = env['HTTP_X_RACK_REMOTE_CALL'].to_s
+
+      if (cb = self.class.calls[call])
+        response = cb.call(request.params, env, request)
+        if response.is_a?(Array) && response.size == 3
+          return response
+        else
+          [200, {'Content-Type' => 'application/json'}, StringIO.new(MultiJson.dump response) ]
+        end
+      else
+        [404, {'Content-Type' => 'application/json'}, StringIO.new('{"error":"remote call not defined"}') ]
+      end
+    end
+
+    class << self
+      # Register a new remote call. Used on server side to
+      # define available remote calls.
+      #
+      # @example
+      #   Rack::Remote.register :factory_girl do |env, request|
+      #     FactoryGirl.create request.params[:factory]
+      #   end
+      #
+      # @params name [String, #to_s] Remote call name
+      #
+      def register(name, &block)
+        calls[name.to_s] = block
+      end
+
+      # Return hash with registered calls.
+      #
+      def calls
+        @calls ||= {}
+      end
+
+      # Removes all registered calls.
+      def clear
+        calls.clear
+        remotes.clear
+      end
+
+      # Add a new remote to be used in `invoke` by symbolic reference.
+      #
+      def add(name, options = {})
+        raise ArgumentError unless options[:url]
+        remotes[name.to_sym] = options
+      end
+
+      def remotes
+        @remotes ||= {}
+      end
+
+      # Invoke remote call.
+      #
+      # @param remote [Symbol, String, #to_s] Symbolic remote name or remote URL.
+      # @param call [String, #to_s] Remote call to invoke.
+      # @param params [Hash] Key-Value pairs that will be converted to json and sent to remote call.
+      # @param headers [Hash] Header added to request.
+      #
+      def invoke(remote, call, params = {}, headers = {})
+        remote = remotes[remote][:url] if remote.is_a? Symbol
+        uri = URI.parse remote.to_s
+        uri.path = '/' if uri.path.empty?
+
+        Net::HTTP.start uri.host, uri.port do |http|
+          request = Net::HTTP::Post.new uri.path
+          headers.each do |key, value|
+            request[key] = value.to_s
+          end
+
+          request['X-Rack-Remote-Call'] = call.to_s
+          request.form_data = params
+
+          response = http.request request
+          raise StandardError, "Rack Remote Error Response: #{response.code}: #{response.body}" if response.code.to_i != 200
+
+          if response['Content-Type'] == 'application/json'
+            MultiJson.load response.body
+          else
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/remote/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Remote
+    VERSION = '1.0.0'
+  end
+end

data/rack-remote.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/remote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-remote'
+  spec.version       = Rack::Remote::VERSION
+  spec.authors       = ['Jan Graichen']
+  spec.email         = %w(jg@altimos.de)
+  spec.summary       = %q{Small request intercepting rack middleware to invoke remote calls over HTTP.}
+  spec.description   = %q{Small request intercepting rack middleware to invoke remote calls over HTTP.}
+  spec.homepage      = 'https://github.com/jgraichen/rack-remote'
+  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 = %w(lib)
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'multi_json'
+
+  spec.add_development_dependency 'bundler'
+end

data/spec/rack/remote_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Rack::Remote do
+  include Rack::Test::Methods
+
+  let(:inner_app) { -> (env) { [200, {'Content-Type' => 'text/plain'}, 'All good!'] } }
+  let(:app) { Rack::Remote.new(inner_app) }
+  let(:block) { -> (_, _, _) { } }
+
+  after(:each) { Rack::Remote.clear }
+
+  describe 'call' do
+    before { Rack::Remote.register :factory_girl, &block }
+
+    context 'with intercept call' do
+      let(:request) { -> { get '/', {}, {'HTTP_X_RACK_REMOTE_CALL' => 'factory_girl'} }}
+
+      it 'should invoke registered call' do
+        expect(block).to receive(:call)
+        request.call
+      end
+
+      it 'should not delegate request to inner app' do
+        expect(inner_app).to_not receive(:call)
+        request.call
+      end
+    end
+
+    context 'with non-rack-remote call' do
+      let(:request) { -> { get '/' }}
+
+      it 'should delegate request to inner app' do
+        expect(inner_app).to receive(:call).and_call_original
+        request.call
+      end
+    end
+  end
+
+  describe 'class' do
+    describe '#register' do
+
+      it 'should add callback' do
+        expect {
+          Rack::Remote.register :factory_girl, &block
+        }.to change{ Rack::Remote.calls.size }.from(0).to(1)
+      end
+
+      it 'should add given callback' do
+        Rack::Remote.register :factory_girl, &block
+        expect(Rack::Remote.calls.values.first).to equal block
+      end
+    end
+
+    describe '#add' do
+      subject { -> { Rack::Remote.add :users, url: 'http://users.example.org' } }
+
+      it 'should add a remote' do
+        expect { subject.call }.to change { Rack::Remote.remotes.size }.from(0).to(1)
+      end
+
+      it 'should add given remote' do
+        subject.call
+        expect(Rack::Remote.remotes[:users]).to eq url: 'http://users.example.org'
+      end
+    end
+
+    describe '#invoke' do
+      before { stub_request(:any, /users\.example\.org/).to_rack(app) }
+      before { Rack::Remote.register :factory_girl, &block }
+      before { Rack::Remote.add :users, url: 'http://users.example.org' }
+
+      it 'should invoke remote call' do
+        expect(block).to receive(:call).with({ 'param1' => 'val1' }, kind_of(Hash), kind_of(Rack::Request)).and_return({id: 1})
+        ret = Rack::Remote.invoke :users, :factory_girl, param1: 'val1'
+        expect(ret).to eq({'id' => 1})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'coveralls'
+Coveralls.wear! do
+  add_filter 'spec'
+end
+
+require 'rack/test'
+require 'rack/remote'
+require 'webmock/rspec'
+
+Dir[File.expand_path('spec/support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # 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'
+
+  config.expect_with :rspec do |c|
+    # Only allow expect syntax
+    c.syntax = :expect
+  end
+
+  config.include WebMock::API
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rack-remote
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: bundler
+  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: Small request intercepting rack middleware to invoke remote calls over
+  HTTP.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/remote.rb
+- lib/rack/remote/version.rb
+- rack-remote.gemspec
+- spec/rack/remote_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jgraichen/rack-remote
+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.3
+signing_key: 
+specification_version: 4
+summary: Small request intercepting rack middleware to invoke remote calls over HTTP.
+test_files:
+- spec/rack/remote_spec.rb
+- spec/spec_helper.rb