optic-middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd867496cc991cb06560b3ee9d479a288b50a4fa9b0ed17e1f123d8be46c9bc3
+  data.tar.gz: b9744fc4637bc22a2ff672e07836761c4a8da57329c041ecb674dc3dfc83718d
+SHA512:
+  metadata.gz: 4349a7a8609289b828db44e2925c88ec799c46c68b6828564b9230ed2b383f23c03d350e0f1b88a9a81dcce89e6db45a58a200842548b078dc778ddcd6eddca5
+  data.tar.gz: 14fd40a4919697dbd1571a9f88590570cef9421914d6e3d696e4bacdf367634702014e2fbee520cb2d535f07d12a638343346367f90e26e5b11341eaa460a762

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aidan Cunniffe
+
+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,49 @@
+# Optic::Middleware
+
+Rails projects or those built on top of Rack are easy to connect to Optic using our custom middleware. In this tutorial we'll show you how to connect the Optic Documenting Middleware to your Rack API so that your integration tests document your code as they execute.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'optic-middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optic-middleware
+
+
+### Making the Middleware Run During Testing
+Now add the middleware to your Rack configuration, in a Rails app it's best to do this in `config/enviroments/test.rb` so the middleware is only used during testing. 
+
+> Note: If you use multiple middlewares, make sure the Documenting Middleware is added at the bottom of the stack so the documentation is accurate. In most cases putting it last in your configuration file is sufficient. 
+
+```ruby
+Rails.application.configure do {
+  # All your current configuration settings...
+  
+  # The Documenting middleware. Only used if 'OPTIC_SERVER_LISTENING' flag is found in ENV. 
+  if ENV['OPTIC_SERVER_LISTENING']
+    config.middleware.use OpticTestFixture::DocumentingMiddleware
+  end
+}
+``` 
+
+> Note for RSpec users: Optic will only document specs of type :request since only integration tests contain enough data to generate REST docs. Specs of type :controller skip the Rack stack so documentation generated from them would be incomplete.  
+
+## Using the Proxy Fixture
+The Documenting middleware will document all the requests/responses that your tests run. Since it is integrated at the middleware level there's no need to update any of your tests files or fixtures. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/opticdev/optic-middleware.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optic/middleware"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/optic/middleware.rb

@@ -0,0 +1,83 @@
+require "optic/version"
+require 'net/http'
+
+module Optic
+  class DocumentingMiddleware
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      res = @app.call(env)
+      # Log request and response
+      logRequestAndResponse(req, res)
+      # Return Response without changing
+      res
+    end
+
+    private
+
+    def headerHash(message)
+      Hash[*message.select {|k, v| k.start_with? 'HTTP_'}
+                .collect {|k, v| [k.sub(/^HTTP_/, ''), v]}
+                .collect {|k, v| [k.split('_').collect(&:capitalize).join('-'), v]}
+                .sort
+                .flatten]
+    end
+
+    def addHeaders(headers, request)
+      headers.each do |key, value|
+        request.add_field(key, value)
+      end
+    end
+
+    def logRequestAndResponse(req, res)
+
+      # Log Request to Optic
+
+      logging_request = Net::HTTP.const_get(req.request_method.capitalize).new(req.fullpath)
+      # Include Headers
+      addHeaders(headerHash(req.env), logging_request)
+      # Include body
+      if logging_request.request_body_permitted? && req.body
+        logging_request.body_stream = req.body
+        logging_request.content_length = req.content_length.to_i
+        logging_request.content_type = req.content_type if req.content_type
+        logging_request.body_stream.rewind
+      end
+
+      # Send request to request logging endpoint
+      http = Net::HTTP.new("localhost", 30334)
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      logging_request_response = http.start do
+        http.request(logging_request)
+      end
+
+      logging_request_response.code
+      # Save the ID Optic assigns this request
+      interactionId = logging_request_response.body || ""
+
+      # Log Response to Optic
+      resStatus, resHeaders, resBody = res
+
+      logging_response = Net::HTTP.const_get("Post").new("/interactions/" + interactionId + "/status/" + resStatus.to_s)
+      addHeaders(resHeaders, logging_response)
+      if logging_response.request_body_permitted? && resBody
+        bodyData = ""
+        resBody.each do |line|
+          bodyData << line
+        end
+        logging_response.body = bodyData
+        logging_response.content_length = bodyData.bytesize.to_s
+      end
+
+      http = Net::HTTP.new("localhost", 30335)
+      logging_response_response = http.start do
+        http.request(logging_response)
+      end
+
+    end
+  end
+end

data/lib/optic/version.rb

@@ -0,0 +1,5 @@
+module Optic
+  module Middleware
+    VERSION = "0.1.0"
+  end
+end

data/optic-middleware.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "optic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "optic-middleware"
+  spec.version       = Optic::Middleware::VERSION
+  spec.authors       = ["Aidan Cunniffe"]
+  spec.email         = ["acunniffe@useoptic.com"]
+
+  spec.summary       = "Document an API written in Rack/Rails by running tests"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/opticdev/ruby-rack-fixture"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: optic-middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Cunniffe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- acunniffe@useoptic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/optic/middleware.rb
+- lib/optic/version.rb
+- optic-middleware.gemspec
+homepage: https://github.com/opticdev/ruby-rack-fixture
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Document an API written in Rack/Rails by running tests
+test_files: []