zooming-proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ce7fec1ef62580c41fd24d84a9831239006d6dc
+  data.tar.gz: dd8b3d9f1a65bd359c72dde212b995d00c397e44
+SHA512:
+  metadata.gz: 05cb4f51b3b89fd1ab364d0f17bd6656058950daa20f1cd980515a73a107ba4b1439c5f00c816e98f23e771b41672be2f10af88937470fdbbe6e01523f86e4c6
+  data.tar.gz: ff528c17789806d933e245ddaa4f1039ce8eff2068059a25ef712e476918444dc7b5d640c1dfb53d9ce770f347db6798f6a97385d501c484d2b67353b49289b7

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/.wercker/
+/pkg/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15

data/.wercker.yml

@@ -0,0 +1,11 @@
+box: ruby:2.3
+build:
+  steps:
+  - bundle-install:
+    jobs: "8"
+  - script:
+    name: cucumber
+    code: bundle exec cucumber --color --format pretty --quiet --strict --expand --order random --no-duration --tag ~@wip $CUCUMBER_EXTRA_ARGS
+  - script:
+    name: rubocop
+    code: bundle exec  rubocop --display-cop-names --extra-details --display-style-guide

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jean@blendle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Blendle
+
+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,47 @@
+# ZoomingProxy [![wercker status](https://app.wercker.com/status/adedcc914bade602a6114105359d3083/s/master "wercker status")](https://app.wercker.com/project/bykey/adedcc914bade602a6114105359d3083)
+
+Rack middleware implementing the [zooming-proxy spec][spec]
+
+* [Installation](#installation)
+* [Quick Start](#quick-start)
+* [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zooming-proxy'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install zooming-proxy
+```
+
+## Quick Start
+
+```ruby
+# require the proper libraries in your project
+require 'zooming-proxy'
+
+# enable the middleware in your `config.ru`
+use ZoomingProxy::Middleware
+
+# make a request, to see if things work as expected
+curl -sI 'https://example.org/hello/world' | grep 'X-HAL-Zoomed'
+# => X-HAL-Zoomed: 1
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[spec]: https://github.com/blendle/zoomingproxy-spec

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w(--display-cop-names --extra-details --display-style-guide)
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --order random --no-multiline --no-snippets --no-source'
+end
+
+task default: %i(features rubocop)

data/lib/zooming-proxy.rb

@@ -0,0 +1,4 @@
+# rubocop:disable Style/FileName
+# frozen_string_literal: true
+
+require 'zooming-proxy/middleware'

data/lib/zooming-proxy/middleware.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ZoomingProxy
+  # Middleware
+  #
+  class Middleware
+    attr_reader :host, :scheme, :forwarded
+
+    MAX_DEPTH = 10
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @host      = env['SERVER_NAME']
+      @scheme    = env['rack.url_scheme']
+      @forwarded = env['REMOTE_ADDR']
+      @encoding  = env['HTTP_ACCEPT_ENCODING']
+
+      handle_response(*@app.call(env))
+    end
+
+    private
+
+    def handle_response(status, headers, response)
+      proxy_headers = headers.dup
+      proxy_headers['X-Forwarded-For'] = forwarded
+      proxy_headers['X-HAL-Zooming'] = '0'
+
+      proxy_headers.delete('Accept-Encoding')
+
+      compress embed(status, proxy_headers, response)
+    end
+
+    def compress(response)
+      return response unless @encoding.to_s.include?('gzip')
+
+      response[2][0] = string_to_gzip(response[2][0])
+      response[1]['Content-Encoding'] = 'gzip'
+      response[1]['Content-Length'] = response[2][0].bytesize
+
+      response
+    end
+
+    def string_to_gzip(source)
+      output = StringIO.new
+      gz = Zlib::GzipWriter.new(output)
+      gz.write(source)
+      gz.close
+      output.string
+    end
+
+    def embed(status, headers, response, depth: 1)
+      body = response_to_hash(response)
+      return zoomed_response(status, headers, body, depth) unless zoomable?(headers, body, depth)
+
+      body['_embedded'] ||= {}
+      headers['X-HAL-Zooming'] = depth
+
+      requested_links(body, headers).each { |link| body = zoom_rel(headers, body, depth, link) }
+      zoomed_response(status, headers, body, depth)
+    end
+
+    def zoom_rel(headers, body, depth, link)
+      relation, hrefs = link
+      array = hrefs.respond_to?(:to_ary)
+
+      [*hrefs].each do |href|
+        res = request_rel(href, headers)
+        embedded_body = handle_nested_embeds(res, depth)
+
+        if array
+          body['_embedded'][relation] ||= []
+          body['_embedded'][relation] << embedded_body
+        else
+          body['_embedded'][relation] = embedded_body
+        end
+      end
+
+      body
+    end
+
+    def request_rel(href, headers)
+      uri = URI.parse(href)
+      uri.scheme = scheme
+      uri.host = host
+
+      Typhoeus.get(uri, headers: headers)
+    end
+
+    def response_to_hash(response)
+      response = response.to_json if response.respond_to?(:each_key)
+
+      JSON.parse(body_from_rack_response(response))
+    rescue JSON::ParserError
+      nil
+    end
+
+    def handle_nested_embeds(res, depth)
+      _, _, response = embed(res.code, res.headers, res.body, depth: depth + 1)
+      response_to_hash(response)
+    end
+
+    def body_from_rack_response(response)
+      [*response].join
+    end
+
+    def zoomed_response(status, headers, body, depth)
+      json = body.to_json
+
+      headers['Content-Length'] = json.bytesize
+      headers['X-HAL-Zoomed'] = depth.to_s
+
+      [status, headers, [json]]
+    end
+
+    def zoomable?(headers, body, depth)
+      zoomable  = depth <= MAX_DEPTH
+      zoomable &= headers.include?('x-hal-zoom')
+      zoomable &= headers['content-type'].include?('json')
+
+      zoomable && !body.nil?
+    end
+
+    def requested_links(body, headers)
+      links = requested_zooms(headers).select { |rel| body['_links'].key?(rel) }
+      links.map do |rel|
+        link = body['_links'][rel]
+
+        [rel, link.respond_to?(:to_ary) ? link.map { |l| l['href'] } : link['href']]
+      end
+    end
+
+    def requested_zooms(headers)
+      headers['x-hal-zoom'].split(/\s+/)
+    end
+  end
+end

data/lib/zooming-proxy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZoomingProxy
+  VERSION = '0.1.0'
+end

data/script/test

@@ -0,0 +1,2 @@
+#!/bin/sh
+docker-compose run spec bundle exec cucumber "$@"

data/zooming-proxy.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zooming-proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zooming-proxy'
+  spec.version       = ZoomingProxy::VERSION
+  spec.authors       = ['Blendle developers']
+  spec.email         = ['support@blendle.com']
+
+  spec.summary       = 'Rack middleware to simulate the "zooming proxy" spec'
+  spec.description   = 'Using this Rack middleware Gem, you can zoom requests.'
+  spec.homepage      = 'https://blendle.com'
+  spec.license       = 'MIT'
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0")
+                                        .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'cucumber', '~> 2.4'
+  spec.add_development_dependency 'cucumber-blendle-steps', '~> 0.8'
+  spec.add_development_dependency 'json', '~> 1.8'
+  spec.add_development_dependency 'json_spec', '~> 1.1'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: zooming-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blendle developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: cucumber-blendle-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Using this Rack middleware Gem, you can zoom requests.
+email:
+- support@blendle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".wercker.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zooming-proxy.rb
+- lib/zooming-proxy/middleware.rb
+- lib/zooming-proxy/version.rb
+- script/test
+- zooming-proxy.gemspec
+homepage: https://blendle.com
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Rack middleware to simulate the "zooming proxy" spec
+test_files: []