avocado-docs 3.0.10 → 3.1.0

data/lib/avocado/controller_patch.rb

@@ -0,0 +1,24 @@
+# This concern gets patched into ActionController::Base during testing
+# The after_action will ensure every request gets documented regardless of the
+# type of test (controller, integration, etc)
+module Avocado
+  module ControllerPatch
+    def self.included(base)
+      base.around_action :_avocado_store_request
+    end
+
+    def self.apply
+      ActionController::Base.send :include, Avocado::ControllerPatch
+    end
+
+    def _avocado_store_request
+      yield
+    ensure
+      Avocado.storage.store(request, response) if _avocado_response.documentable?
+    end
+
+    def _avocado_response
+      @__avocado_response ||= Avocado::ControllerResponse.new response
+    end
+  end
+end

data/lib/avocado/controller_response.rb

@@ -0,0 +1,22 @@
+module Avocado
+  class ControllerResponse
+    def initialize(response)
+      @response = response
+    end
+
+    def documentable?
+      blank_204? || json?
+    end
+
+    private
+      def blank_204?
+        @response.status == 204 && @response.body.blank?
+      end
+
+      def json?
+        JSON.parse @response.body
+      rescue JSON::ParserError, TypeError
+        false
+      end
+  end
+end

data/lib/avocado/cucumber.rb

@@ -0,0 +1,14 @@
+Avocado::ControllerPatch.apply
+
+After do |scenario|
+  request  = Avocado.storage.request
+  response = Avocado.storage.response
+  adapter  = Avocado::Adapters::CucumberAdapter.new scenario, request, response
+
+  Avocado.uploader.payload << adapter.to_h if adapter.upload?
+  Avocado.storage.clear
+end
+
+at_exit do
+  Avocado.uploader.upload
+end

data/lib/avocado/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Avocado
+  module Logger
+    def logger
+      @_logger ||= begin
+        logger = ::Logger.new STDOUT
+        logger.formatter = proc { |_, _, _, msg| "\n[Avocado] #{msg}\n" }
+        logger
+      end
+    end
+  end
+end

data/lib/avocado/minitest.rb

@@ -1,36 +1,23 @@
-module MinitestAvocadoPlugin
+module Avocado::Minitest
   def before_setup
     super
-    ActionController::Base.send :include, Avocado::Controller
-    ActionController::API.send  :include, Avocado::Controller if defined?(ActionController::API)
+    Avocado::ControllerPatch.apply
   end
 
   def before_teardown
     super
-    request  = Avocado::RequestStore.instance.request
-    response = Avocado::RequestStore.instance.response
 
-    if request && response
-      package = Avocado::Packages::MinitestPackage.new(name, request, response)
-      Avocado::Middleware.invoke(package) do
-        Avocado::Uploader.instance.payload << Avocado::RequestStore.instance.json
-      end
-    end
+    request  = Avocado.storage.request
+    response = Avocado.storage.response
+    adapter  = Avocado::Adapters::MinitestAdapter.new name, request, response
 
-    Avocado::RequestStore.instance.reset!
+    Avocado.uploader.payload << adapter.to_h if adapter.upload?
+    Avocado.storage.clear
   end
 end
 
-class MiniTest::Test
-  include MinitestAvocadoPlugin
-end
+Minitest::Test.send :include, Avocado::Minitest
 
-if MiniTest::Unit.respond_to? :after_run
-  MiniTest::Unit.after_run do
-    Avocado::Uploader.instance.upload!
-  end
-else
-  MiniTest.after_run do
-    Avocado::Uploader.instance.upload!
-  end
+Minitest.after_run do
+  Avocado.uploader.upload
 end

data/lib/avocado/rspec.rb

@@ -1,30 +1,21 @@
 RSpec.configure do |config|
-
   config.before(:suite) do
-    ActionController::Base.send :include, Avocado::Controller
-    ActionController::API.send  :include, Avocado::Controller if defined?(ActionController::API)
+    Avocado::ControllerPatch.apply
   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|
-    _ex = defined?(example) ? example : ex
-    request  = Avocado::RequestStore.instance.request
-    response = Avocado::RequestStore.instance.response
+    # Older versions of RSpec use the global `example` object
+    spec = defined?(example) ? example : ex
 
-    if request && response
-      package = Avocado::Packages::RSpecPackage.new(_ex, request, response)
-      Avocado::Middleware.invoke(package) do
-        Avocado::Uploader.instance.payload << Avocado::RequestStore.instance.json
-      end
-    end
+    request  = Avocado.storage.request
+    response = Avocado.storage.response
+    adapter  = Avocado::Adapters::RSpecAdapter.new spec, request, response
 
-    Avocado::RequestStore.instance.reset!
+    Avocado.uploader.payload << adapter.to_h if adapter.upload?
+    Avocado.storage.clear
   end
 
-  # Upload avocado.json to the configured URL if one is given
   config.after(:suite) do
-    Avocado::Uploader.instance.upload!
+    Avocado.uploader.upload
   end
-
 end

data/lib/avocado/serializers/request_serializer.rb

@@ -0,0 +1,43 @@
+module Avocado
+  module Serializers
+    class RequestSerializer
+      def initialize(request)
+        @request = request
+      end
+
+      def to_h
+        {
+          method:  @request.method,
+          path:    @request.path,
+          params:  sanitize_params(@request.params).to_h,
+          headers: headers
+        }
+      end
+
+      private
+        def headers
+          hash = {}
+          Avocado.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.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 v.respond_to? :eof
+              hash[k] = '<Multipart File Upload>'
+            elsif v.is_a? Hash
+              deep_replace_file_uploads_with_text v
+            end
+          end
+        end
+    end
+  end
+end

data/lib/avocado/serializers/resource_serializer.rb

@@ -0,0 +1,20 @@
+module Avocado
+  module Serializers
+    class ResourceSerializer
+      def initialize(request)
+        @request = request
+      end
+
+      def to_h
+        { name: infer_resource_name_from_request }
+      end
+
+      private
+        def infer_resource_name_from_request
+          controller = @request.params[:controller]
+          name = controller.partition('/').reject(&:blank?).last
+          name.titleize.split('/').last
+        end
+    end
+  end
+end

data/lib/avocado/serializers/response_serializer.rb

@@ -0,0 +1,16 @@
+module Avocado
+  module Serializers
+    class ResponseSerializer
+      def initialize(response)
+        @response = response
+      end
+
+      def to_h
+        {
+          body: @response.body,
+          status: @response.status
+        }
+      end
+    end
+  end
+end

data/lib/avocado/{request_store.rb → storage.rb}

@@ -1,22 +1,19 @@
 # Temporarily store a JSON request/response. Ultimately RSpec will determine
 # if this request/response gets documented or not in an after(:each) block
 module Avocado
-  class RequestStore
+  class Storage
     include Singleton
 
-    attr_accessor :request, :response, :json
+    attr_accessor :request, :response
 
     def store(request, response)
-      @json = {}
-      @request = request
+      @request  = request
       @response = response
     end
 
-    def reset!
-      @json = nil
-      @request = nil
+    def clear
+      @request  = nil
       @response = nil
     end
-
   end
-end
+end

data/lib/avocado/uploader.rb

@@ -1,54 +1,64 @@
+require 'net/http/post/multipart'
+
 module Avocado
   class Uploader
     include Singleton
+    include Logger
 
     attr_accessor :payload
 
     def initialize
+      reset
+    end
+
+    def reset
       @payload = []
     end
 
-    def upload!
-      return unless should_upload?
-      WebMock.allow_net_connect! if defined? WebMock
-      write_payload_to_json_file do |file|
-        request = Net::HTTP::Post::Multipart.new uri.path, 'file' => UploadIO.new(file, 'text/json', 'avocado.json')
-        net_request = Net::HTTP.new(uri.host, uri.port)
-        net_request.use_ssl = (uri.scheme == 'https')
-        response = net_request.start { |http| http.request(request) }
-
-        if response.is_a?(Net::HTTPRedirection)
-          raise "Avocado was redirected to '#{response['location']}', update your initializer!"
-        else
-          response
-        end
+    def upload
+      return if payload.blank? || url.blank?
+
+      response = Net::HTTP.start(url.host, url.port, use_ssl: https?) do |http|
+        http.request multipart_req
+      end
+
+      if success? response
+        logger.info "Successfully uploaded to #{url}"
+      else
+        logger.error "Failed to upload to #{url} (response code #{response.code}). Full response:"
+        logger.error response.body
       end
-    ensure
-      WebMock.disable_net_connect! if defined? WebMock
+    end
+
+    def url
+      URI.parse Avocado.url.to_s if Avocado.url
+    rescue URI::InvalidURIError
+      logger.error "Could not parse the URI #{Avocado.url}--Avocado will not upload documentation!"
+      nil
     end
 
     private
+      def multipart_req
+        @_multipart_req ||= Net::HTTP::Post::Multipart.new url.path, file: uploadable_file, upload_id: upload_id
+      end
 
-      def write_payload_to_json_file(&block)
-        file = File.open 'avocado.json', 'w+:UTF-8'
-        file.write JSON[payload]
-        file.rewind
-        yield file
-      ensure
-        file.close
-        File.delete file.path
+      def uploadable_file
+        @_uploadable_file ||= begin
+          file = StringIO.new JSON[payload]
+          UploadIO.new file, 'application/json'
+        end
       end
 
-      def should_upload?
-        payload.present? && Avocado::Config.url.presence
+      def upload_id
+        @_upload_id ||= Avocado.upload_id.call
       end
 
-      def uri
-        @_uri ||= URI.parse Avocado::Config.url
-      rescue URI::InvalidURIError
-        raise "Avocado::Config.url is set but is not a valid URL!"
+      def https?
+        url.to_s.include? 'https://'
       end
 
+      def success?(response)
+        (200..399).cover? response.code.to_i
+      end
   end
 end
-

data/lib/avocado/version.rb

@@ -1,3 +1,3 @@
 module Avocado
-  VERSION = '3.0.10'
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: avocado-docs
 version: !ruby/object:Gem::Version
-  version: 3.0.10
+  version: 3.1.0
 platform: ruby
 authors:
 - Logan Serman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2016-10-30 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
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2'
 - !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'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Avocado listens for JSON responses in the test environment and generates
   a YAML file describing them, which it sends to a configurable URL.
 email:
@@ -105,47 +119,37 @@ files:
 - MIT-LICENSE
 - Rakefile
 - app/assets/images/avocado/filter-icon.png
-- app/assets/javascripts/avocado/angular-route.min.js
-- app/assets/javascripts/avocado/angular.min.js
-- app/assets/javascripts/avocado/app.js.coffee
+- app/assets/javascripts/avocado/app.coffee
 - app/assets/javascripts/avocado/application.js.coffee
-- app/assets/javascripts/avocado/controllers/avocado_ctrl.js.coffee
-- app/assets/javascripts/avocado/md5.js
-- app/assets/javascripts/avocado/services/endpoint.js.coffee
-- app/assets/javascripts/avocado/services/request.js.coffee
-- app/assets/javascripts/avocado/services/resource.js.coffee
-- app/assets/javascripts/avocado/services/response.js.coffee
-- app/assets/javascripts/avocado/ui-utils.min.js
+- app/assets/javascripts/avocado/avocado-ctrl.coffee
+- app/assets/javascripts/avocado/factories/request.coffee
+- app/assets/javascripts/avocado/factories/resource.coffee
+- app/assets/javascripts/avocado/factories/response.coffee
+- app/assets/javascripts/avocado/factories/spec.coffee
+- app/assets/javascripts/avocado/filters/request-method-filter.coffee
+- app/assets/javascripts/avocado/filters/response-status-filter.coffee
 - 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/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
+- app/views/avocado/specs/index.html.erb
+- app/views/layouts/avocado.html.erb
 - config/routes.rb
 - lib/avocado-docs.rb
-- lib/avocado/config.rb
-- lib/avocado/controller.rb
+- lib/avocado/adapters/base_adapter.rb
+- lib/avocado/adapters/cucumber_adapter.rb
+- lib/avocado/adapters/minitest_adapter.rb
+- lib/avocado/adapters/rspec_adapter.rb
+- lib/avocado/controller_patch.rb
+- lib/avocado/controller_response.rb
+- lib/avocado/cucumber.rb
 - lib/avocado/engine.rb
-- lib/avocado/middleware.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/ignore_xhr_requests.rb
-- lib/avocado/middleware/request_serialization.rb
-- lib/avocado/middleware/resource_serialization.rb
-- lib/avocado/middleware/response_serialization.rb
+- lib/avocado/logger.rb
 - lib/avocado/minitest.rb
-- lib/avocado/packages/minitest_package.rb
-- lib/avocado/packages/package.rb
-- lib/avocado/packages/rspec_package.rb
-- lib/avocado/request_store.rb
 - lib/avocado/rspec.rb
+- lib/avocado/serializers/request_serializer.rb
+- lib/avocado/serializers/resource_serializer.rb
+- lib/avocado/serializers/response_serializer.rb
+- lib/avocado/storage.rb
 - lib/avocado/uploader.rb
 - lib/avocado/version.rb
 homepage: http://github.com/metova/avocado
@@ -157,17 +161,17 @@ 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.4.5
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Automatic API documentation from RSpec tests