avocado-docs 2.0.5

data/lib/avocado/middleware/request_serialization.rb

@@ -0,0 +1,46 @@
+module Avocado
+  class Middleware::RequestSerialization
+
+    def call(example, request, response)
+      @request = request
+      Avocado::Cache.json.merge! request: serialize(@request)
+      yield
+    end
+
+    private
+
+      def serialize(request)
+        {
+          method:  request.method,
+          path:    request.path,
+          params:  sanitize_params(request.params).to_h,
+          headers: headers
+        }
+      end
+
+      def headers
+        hash = {}
+        Avocado::Config.headers.each do |name|
+          hash[name] = @request.headers.env["HTTP_#{name.tr('-', '_')}".upcase]
+        end
+        hash.select { |_, value| !value.nil? }
+      end
+
+      def sanitize_params(params)
+        params = params.except(*Avocado::Config.ignored_params.flatten)
+        deep_replace_file_uploads_with_text(params)
+        params
+      end
+
+      def deep_replace_file_uploads_with_text(hash)
+        hash.each do |k, v|
+          if Hash === v
+            deep_replace_file_uploads_with_text(v)
+          else
+            hash[k] = '<Multipart File Upload>' if v.respond_to? :path
+          end
+        end
+      end
+
+  end
+end

data/lib/avocado/middleware/resource_serialization.rb

@@ -0,0 +1,22 @@
+module Avocado
+  class Middleware::ResourceSerialization
+
+    def call(example, request, response)
+      name = infer_name_from_route(request.path, request.method) || ""
+      Avocado::Cache.json.merge! resource: { name: name }
+      yield
+    end
+
+    private
+
+      def infer_name_from_route(path, method)
+        controller = Rails.application.routes.recognize_path(path, method: method)[:controller]
+        name = controller.partition('/').reject(&:blank?).last
+        name.titleize.split('/').last
+      rescue ActionController::RoutingError
+        puts "Path #{path} not found in controller routes; Defaulting name to path."
+        path
+      end
+
+  end
+end

data/lib/avocado/middleware/response_serialization.rb

@@ -0,0 +1,19 @@
+module Avocado
+  class Middleware::ResponseSerialization
+
+    def call(example, request, response)
+      Avocado::Cache.json.merge! response: serialize(response)
+      yield
+    end
+
+    private
+
+      def serialize(response)
+        {
+          status: response.status,
+          body:   response.body
+        }
+      end
+
+  end
+end

data/lib/avocado/rspec.rb

@@ -0,0 +1,27 @@
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    ActionController::Base.send :include, Avocado::Controller
+    ActionController::API.send  :include, Avocado::Controller if defined?(ActionController::API)
+  end
+
+  # Invoke all middleware with the request/response stored from the after_action in the controller
+  # The final action is to store the request JSON in the Avocado module until after(:suite) executes
+  config.after(:each) do |ex|
+    _example = defined?(example) ? example : ex
+    request  = Avocado::Cache.request
+    response = Avocado::Cache.response
+
+    if request && response
+      Avocado::Middleware.invoke(_example, request, response) do
+        Avocado.payload << Avocado::Cache.json
+      end
+    end
+
+    Avocado::Cache.clean
+  end
+
+  # Upload avocado.yml to the configured URL if one is given
+  config.after(:suite) { Avocado.upload! }
+
+end

data/lib/avocado/uploader.rb

@@ -0,0 +1,26 @@
+module Avocado
+  class Uploader
+
+    def upload(filename)
+      WebMock.allow_net_connect!
+      uri  = URI.parse Avocado::Config.url
+      file = File.open(filename)
+      req  = Net::HTTP::Post::Multipart.new uri.path, 'file' => UploadIO.new(file, 'text/yaml', 'avocado.yml')
+      Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+    ensure
+      WebMock.disable_net_connect!
+      file.close
+      File.delete file.path
+    end
+
+    private
+
+      def uri
+        @uri ||= URI.parse Avocado::Config.url
+      rescue URI::InvalidURIError
+        raise "Avocado::Config.url is set but is not a valid URL!"
+      end
+
+  end
+end
+

data/lib/avocado/version.rb

@@ -0,0 +1,3 @@
+module Avocado
+  VERSION = "2.0.5"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: avocado-docs
+version: !ruby/object:Gem::Version
+  version: 2.0.5
+platform: ruby
+authors:
+- Logan Serman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Avocado listens for JSON responses in the test environment and generates
+  a YAML file describing them, which it sends to a configurable URL.
+email:
+- loganserman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/avocado/application.js
+- app/assets/stylesheets/avocado/application.css.scss
+- app/assets/stylesheets/avocado/bootstrap.css
+- app/controllers/avocado/avocado_controller.rb
+- app/controllers/avocado/specs_controller.rb
+- app/helpers/avocado/application_helper.rb
+- app/models/avocado/endpoint.rb
+- app/models/avocado/parser.rb
+- app/models/avocado/request.rb
+- app/models/avocado/resource.rb
+- app/views/layouts/avocado/avocado.html.erb
+- app/views/template.html.erb
+- config/routes.rb
+- lib/avocado/cache.rb
+- lib/avocado/config.rb
+- lib/avocado/controller.rb
+- lib/avocado/engine.rb
+- lib/avocado/middleware/defaults.rb
+- lib/avocado/middleware/document_if_configuration.rb
+- lib/avocado/middleware/document_metadata.rb
+- lib/avocado/middleware/example_serialization.rb
+- lib/avocado/middleware/request_serialization.rb
+- lib/avocado/middleware/resource_serialization.rb
+- lib/avocado/middleware/response_serialization.rb
+- lib/avocado/middleware.rb
+- lib/avocado/rspec.rb
+- lib/avocado/uploader.rb
+- lib/avocado/version.rb
+- lib/avocado.rb
+- MIT-LICENSE
+- Rakefile
+homepage: http://github.com/metova/avocado
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Automatic API documentation from RSpec tests
+test_files: []