rack-transform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 159e21b98524f2d792e7d5cc802adb86687fd4bd
+  data.tar.gz: a98e77d6fe21712cfc4fbb3366386b51a1d72a47
+SHA512:
+  metadata.gz: 418a12346b5624c6b3103201dfca8c33dd488a1716205f0630e9fe1762ef84fa3e0f9ec055362a1c43226f7df3811b20edb83a104b121e4420af822227c81d09
+  data.tar.gz: 33face941575973e25352b5d32dbf1bfed76d992769ef61aaf785f992517d7cce8ee9961db2fc1fae8e43a7653894e9f151575c733059c8872a093d4bbe1e5e9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Esteban Pastorino
+
+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,62 @@
+# Rack::Transform
+
+`Rack::Transform` is a middleware that attemps to make a compatibility layer
+between two different request/responses that should hit the same endpoint.
+
+The need arouse when migrating an API from PHP to Ruby, where the URLs were
+different and the response body used to have more metadata that was moved to
+headers.
+
+---
+
+## Usage
+
+```ruby
+use Rack::Transform do |map|
+  map.on "playlist-get-cues" do |transformer|
+    transformer.request = proc do |env|
+      ...
+    end
+    transformer.response = proc do |status, header, body|
+      ...
+    end
+  end
+
+  map.on "search" do |transformer|
+    ...
+  end
+  ...
+end
+```
+
+`map.on` will receive a string that should match the `type` parameter from the
+URL and then a block to set the request and response transformers. For more
+information, see `Rack::Transform::Transformer`
+
+## Rack::Transform::Transformer
+
+`Rack:Transform::Transformer` intent is to transform rack requests and/or
+responses into a different format.
+It can manipulate the request, the response, or both.
+
+Usage:
+```ruby
+Transformer.new do |transformer|
+  transformer.request = proc do |env|
+    ...
+  end
+  transformer.response = proc do |status, header, body|
+    ...
+  end
+end
+```
+
+`resquest` and `response` methods should receinve and object that responds to
+`call`, it can be a proc # or and object. And they will receive an `env`
+object and `status`, `header`, # `body` tuple accordingly. Should return the
+same modified as needed.
+
+## Contributing
+
+See the [contributing guide](./CONTRIBUTING.md).
+

data/lib/rack/transform/transformer.rb

@@ -0,0 +1,16 @@
+module Rack
+  class Transform
+    class Transformer
+      REQUEST_NOOP = Proc.new { |env| env }
+      RESPONSE_NOOP = Proc.new { |status, header, body| [status, header, body] }
+
+      attr_accessor :request, :response
+
+      def initialize
+        @request = REQUEST_NOOP
+        @response = RESPONSE_NOOP
+        yield self if block_given?
+      end
+    end
+  end
+end

data/lib/rack/transform/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Transform
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rack/transform.rb

@@ -0,0 +1,34 @@
+require "rack/transform/transformer"
+
+module Rack
+  class Transform
+    def initialize(app)
+      @app = app
+      @transformers = {}
+      yield self if block_given?
+    end
+
+    def call(env)
+      if transformer = request_transformer(env)
+        env = transformer.request.call(env)
+        status, header, body = @app.call(env)
+        transformer.response.call(status, header, body)
+      else
+        @app.call(env)
+      end
+    end
+
+    def on(type, &block)
+      @transformers[type] ||= Transformer.new(&block)
+    end
+
+    private
+
+    def request_transformer(env)
+      if env[Rack::REQUEST_METHOD] == Rack::GET
+        req = Rack::Request.new(env)
+        @transformers[req.params["type"]]
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require "rspec"
+require "rack"
+require "rack/transform"

data/spec/rack/transform/transformer_spec.rb

@@ -0,0 +1,35 @@
+require_relative "../../helper"
+
+RSpec.describe Rack::Transform::Transformer do
+  let(:formatter) { Rack::Transform::Transformer.new }
+
+  describe "#request" do
+    it "defaults to noop" do
+      result = formatter.request.call("foo")
+      expect(result).to eq "foo"
+    end
+
+    it "can assign a block" do
+      formatter.request = proc do |env|
+        "new env"
+      end
+
+      expect(formatter.request.call(1)).to eq "new env"
+    end
+  end
+
+  describe "#response" do
+    it "defaults to noop" do
+      result = formatter.response.call("foo", "bar", "baz")
+      expect(result).to eq ["foo", "bar", "baz"]
+    end
+
+    it "can assign a block" do
+      formatter.response = proc do |status, header, body|
+        ["new status", "new header", "new body"]
+      end
+
+      expect(formatter.response.call(1, 2, 3)).to eq ["new status", "new header", "new body"]
+    end
+  end
+end

data/spec/rack/transform_spec.rb

@@ -0,0 +1,53 @@
+require_relative "../helper"
+
+RSpec.describe Rack::Transform do
+  context "request" do
+    it "transforms a request" do
+      stack = Rack::Builder.new do
+        use Rack::Transform do |map|
+          map.on("foo") do |transformer|
+            transformer.request = proc do |env|
+              env[Rack::REQUEST_METHOD] = "POST"
+              env
+            end
+          end
+        end
+
+        run Proc.new { |env|
+          [200, {}, ["method: #{env[Rack::REQUEST_METHOD]}"]]
+        }
+      end
+
+      request = Rack::MockRequest.new(stack)
+
+      response = request.get("?type=foo")
+
+      expect(response.body).to eq "method: POST"
+    end
+  end
+
+  context "response" do
+    it "transforms a response" do
+      stack = Rack::Builder.new do
+        use Rack::Transform do |map|
+          map.on("bar") do |transformer|
+            transformer.response = proc do |status, header, body|
+              new_body = ["response: #{body.join("")}"]
+              [status, header, new_body]
+            end
+          end
+        end
+
+        run Proc.new { |env|
+          [200, {}, ["lorem ipsum"]]
+        }
+      end
+
+      request = Rack::MockRequest.new(stack)
+
+      response = request.get("?type=bar")
+
+      expect(response.body).to eq "response: lorem ipsum"
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rack-transform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esteban Pastorino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Rack::Transform is a middleware that attemps to make a compatibility
+  layer between two different request/responses that should hit the same endpoint.
+email:
+- ejpastorino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/rack/transform.rb
+- lib/rack/transform/transformer.rb
+- lib/rack/transform/version.rb
+- spec/helper.rb
+- spec/rack/transform/transformer_spec.rb
+- spec/rack/transform_spec.rb
+homepage: http://github.com/kitop/rack-transform
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Transform Rack request and responses on the fly.
+test_files:
+- spec/helper.rb
+- spec/rack/transform/transformer_spec.rb
+- spec/rack/transform_spec.rb