RubyGems - avocado-docs - Versions diffs - 3.0.10 → 3.1.0 - Mend

avocado-docs 3.0.10 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

checksums.yaml +5 -13
data/app/assets/javascripts/avocado/app.coffee +1 -0
data/app/assets/javascripts/avocado/application.js.coffee +1 -18
data/app/assets/javascripts/avocado/avocado-ctrl.coffee +50 -0
data/app/assets/javascripts/avocado/{services/request.js.coffee → factories/request.coffee} +5 -3
data/app/assets/javascripts/avocado/factories/resource.coffee +6 -0
data/app/assets/javascripts/avocado/factories/response.coffee +11 -0
data/app/assets/javascripts/avocado/factories/spec.coffee +27 -0
data/app/assets/javascripts/avocado/filters/request-method-filter.coffee +15 -0
data/app/assets/javascripts/avocado/filters/response-status-filter.coffee +15 -0
data/app/controllers/avocado/specs_controller.rb +32 -2
data/app/views/avocado/specs/index.html.erb +51 -0
data/app/views/layouts/avocado.html.erb +20 -0
data/config/routes.rb +1 -1
data/lib/avocado-docs.rb +33 -15
data/lib/avocado/adapters/base_adapter.rb +36 -0
data/lib/avocado/adapters/cucumber_adapter.rb +15 -0
data/lib/avocado/adapters/minitest_adapter.rb +10 -0
data/lib/avocado/adapters/rspec_adapter.rb +13 -0
data/lib/avocado/controller_patch.rb +24 -0
data/lib/avocado/controller_response.rb +22 -0
data/lib/avocado/cucumber.rb +14 -0
data/lib/avocado/logger.rb +13 -0
data/lib/avocado/minitest.rb +10 -23
data/lib/avocado/rspec.rb +9 -18
data/lib/avocado/serializers/request_serializer.rb +43 -0
data/lib/avocado/serializers/resource_serializer.rb +20 -0
data/lib/avocado/serializers/response_serializer.rb +16 -0
data/lib/avocado/{request_store.rb → storage.rb} +6 -9
data/lib/avocado/uploader.rb +41 -31
data/lib/avocado/version.rb +1 -1
metadata +59 -55
data/app/assets/javascripts/avocado/angular-route.min.js +0 -14
data/app/assets/javascripts/avocado/angular.min.js +0 -235
data/app/assets/javascripts/avocado/app.js.coffee +0 -4
data/app/assets/javascripts/avocado/controllers/avocado_ctrl.js.coffee +0 -93
data/app/assets/javascripts/avocado/md5.js +0 -19
data/app/assets/javascripts/avocado/services/endpoint.js.coffee +0 -23
data/app/assets/javascripts/avocado/services/resource.js.coffee +0 -5
data/app/assets/javascripts/avocado/services/response.js.coffee +0 -9
data/app/assets/javascripts/avocado/ui-utils.min.js +0 -7
data/app/controllers/avocado/avocado_controller.rb +0 -20
data/app/models/avocado/endpoint.rb +0 -13
data/app/models/avocado/parser.rb +0 -56
data/app/models/avocado/request.rb +0 -37
data/app/models/avocado/resource.rb +0 -17
data/app/views/layouts/avocado/avocado.html.erb +0 -15
data/app/views/template.html.erb +0 -46
data/lib/avocado/config.rb +0 -36
data/lib/avocado/controller.rb +0 -26
data/lib/avocado/middleware.rb +0 -37
data/lib/avocado/middleware/defaults.rb +0 -17
data/lib/avocado/middleware/document_if_configuration.rb +0 -12
data/lib/avocado/middleware/document_metadata.rb +0 -14
data/lib/avocado/middleware/example_serialization.rb +0 -10
data/lib/avocado/middleware/ignore_xhr_requests.rb +0 -10
data/lib/avocado/middleware/request_serialization.rb +0 -48
data/lib/avocado/middleware/resource_serialization.rb +0 -20
data/lib/avocado/middleware/response_serialization.rb +0 -20
data/lib/avocado/packages/minitest_package.rb +0 -15
data/lib/avocado/packages/package.rb +0 -23
data/lib/avocado/packages/rspec_package.rb +0 -15

data/app/models/avocado/parser.rb DELETED

@@ -1,56 +0,0 @@
-module Avocado
-  class Parser
-    attr_reader :resources, :endpoints, :requests
-    def initialize(json)
-      @resources = SortedSet.new
-      @endpoints = Set.new
-      @requests  = Set.new
-      parse(json)
-    end
-    def resource(name)
-      @resources.find { |r| r.name == name }
-    end
-    private
-      def parse(json)
-        json.each do |req|
-          resource = find_or_create_resource_by_name req[:resource][:name]
-          endpoint = find_or_create_endpoint_by_signature resource, req[:request]
-          request  = instantiate_request_object_from(req)
-          request.endpoint = endpoint
-          if request.unique?(@requests)
-            endpoint.requests << request
-            resource.endpoints << endpoint
-            @resources << resource
-            @endpoints << endpoint
-            @requests  << request
-          end
-        end
-      end
-      def instantiate_request_object_from(params)
-        Avocado::Request.new \
-          path:        params[:request][:path],
-          params:      params[:request][:params],
-          headers:     params[:request][:headers],
-          status:      params[:response][:status],
-          body:        params[:response][:body],
-          description: params[:description]
-      end
-      def find_or_create_resource_by_name(name)
-         resource(name) || Avocado::Resource.new(name: name)
-      end
-      def find_or_create_endpoint_by_signature(resource, request)
-        signature = "#{request[:method]} #{request[:path]}"
-        resource.endpoints.find { |e| e.signature == signature } || Avocado::Endpoint.new(signature: signature)
-      end
-  end
-end

data/app/models/avocado/request.rb DELETED

@@ -1,37 +0,0 @@
-module Avocado
-  class Request
-    include ActiveModel::Model
-      attr_accessor :uid, :url, :path, :params, :status, :body, :headers
-      attr_accessor :endpoint, :description
-      def initialize(*)
-        super
-        self.uid = SecureRandom.hex
-      end
-      def ==(other)
-        other.path  == path &&
-        other.params == params &&
-        other.status == status &&
-        other.body == body
-      end
-      def <=>(other)
-        status <=> other.status
-      end
-      def unique?(requests)
-        requests.none? { |req| self == req }
-      end
-      def params
-        @params || {}
-      end
-      def body
-        @body || {}
-      end
-  end
-end

data/app/models/avocado/resource.rb DELETED

@@ -1,17 +0,0 @@
-module Avocado
-  class Resource
-    include ActiveModel::Model
-    attr_accessor :name, :endpoints
-    def initialize(*)
-      @endpoints = Set.new
-      super
-    end
-    def <=>(other)
-      name <=> other.name
-    end
-  end
-end

data/app/views/layouts/avocado/avocado.html.erb DELETED

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>API Docs</title>
-  <%= stylesheet_link_tag    "avocado/application", media: "all" %>
-  <%= javascript_include_tag "avocado/application" %>
-  <%= csrf_meta_tags %>
-  <script type="text/javascript">
-    var data = <%= @data.html_safe %>;
-  </script>
-</head>
-<body ng-app="avocado" ng-controller="AvocadoCtrl">
-<%= yield %>
-</body>
-</html>

data/app/views/template.html.erb DELETED

@@ -1,46 +0,0 @@
-<div class="top-bar">
-  <a href="#" id="toggle-filter"><%= image_tag 'avocado/filter-icon.png'%></a>
-  <select ng-model="selectedResource" ng-change="switchResource()">
-    <option ng-selected="true">All</option>
-    <option ng-repeat="endpoint in allEndpoints | unique: 'resource.name' | orderBy: 'resource.name'"/>
-      {{endpoint.resource.name}}
-    </option>
-  </select>
-  <input type="text" ng-model="query" placeholder="Search..." />
-  <div class="filters">
-    <label ng-repeat="filter in filters">
-      <input type="checkbox" ng-model="filter.selected" value="{{filter.name}}" />
-      {{filter.name}}
-    </label>
-  </div>
-</div>
-<div class="left-side">
-  <ul>
-    <li ng-repeat="endpoint in filteredEndpoints | filter: search" ng-click="chooseEndpoint(endpoint)" ng-class="{ 'active': (endpoint == currentEndpoint) }">
-      <span class="status-code">{{endpoint.response.statusCode}}</span>
-      <span class="url">{{endpoint.request.method}} {{endpoint.request.path}}</span>
-      <span class="description">{{endpoint.description}}</span>
-    </li>
-  </ul>
-</div>
-<div class="right-side">
-  <div ng-if="currentEndpoint">
-    <span class="url">{{currentEndpoint.request.method}} {{currentEndpoint.request.path}}</span>
-    <desc>Request Parameters</desc>
-    <code class="request-params">
-{{currentEndpoint.request.params}}
-    </code>
-    <desc>Headers</desc>
-    <code class="headers">
-{{currentEndpoint.request.headers}}
-    </code>
-    <desc>Response Status</desc>
-    <code class="response-status">
-{{currentEndpoint.response.statusCode}}
-    </code>
-    <desc>Response Body</desc>
-    <code class="response-body">
-{{currentEndpoint.response.body}}
-    </code>
-  </div>
-</div>

data/lib/avocado/config.rb DELETED

@@ -1,36 +0,0 @@
-module Avocado
-  class Config
-    class << self
-      attr_accessor :url, :headers, :document_if, :json_path, :ignored_params
-      def configure(&block)
-        yield self
-      end
-      def headers
-        Array(@headers) || []
-      end
-      def document_if
-        @document_if || -> { true }
-      end
-      def json_path
-        @json_path || Rails.application.root
-      end
-      def ignored_params
-        @ignored_params ||= ['controller', 'action']
-      end
-      def reset!
-        @headers = nil
-        @document_if = nil
-        @json_path = nil
-        @ignored_params = nil
-      end
-    end
-  end
-end

data/lib/avocado/controller.rb DELETED

@@ -1,26 +0,0 @@
-# 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 Controller
-    extend ActiveSupport::Concern
-    included do
-      prepend_around_action :store_request_and_response_in_avocado
-    end
-    def documentable?
-      (response.status == 204 && response.body.blank?) || !!JSON.parse(response.body)
-    rescue
-      false
-    end
-    def store_request_and_response_in_avocado
-      yield
-    ensure
-      Avocado::RequestStore.instance.reset!
-      Avocado::RequestStore.instance.store(request, response) if documentable?
-    end
-  end
-end

data/lib/avocado/middleware.rb DELETED

@@ -1,37 +0,0 @@
-module Avocado
-  class Middleware
-    attr_accessor :entries
-    def initialize
-      @entries = []
-    end
-    def <<(klass)
-      @entries << klass
-    end
-    def invoke(*args, &finally)
-      chain = entries.map(&:new).dup
-      traversal = -> (continue = true) do
-        return if !continue
-        if chain.empty?
-          finally.call
-        else
-          chain.shift.call(*args, &traversal)
-        end
-      end
-      traversal.call
-    end
-    def self.configure(&block)
-      @chain ||= new
-      yield @chain
-    end
-    def self.invoke(*args, &block)
-      @chain.invoke(*args, &block)
-    end
-  end
-end

data/lib/avocado/middleware/defaults.rb DELETED

@@ -1,17 +0,0 @@
-require 'avocado/middleware/document_metadata'
-require 'avocado/middleware/document_if_configuration'
-require 'avocado/middleware/request_serialization'
-require 'avocado/middleware/response_serialization'
-require 'avocado/middleware/resource_serialization'
-require 'avocado/middleware/example_serialization'
-require 'avocado/middleware/ignore_xhr_requests'
-Avocado::Middleware.configure do |chain|
-  chain << Avocado::Middleware::DocumentMetadata
-  chain << Avocado::Middleware::DocumentIfConfiguration
-  chain << Avocado::Middleware::RequestSerialization
-  chain << Avocado::Middleware::ResponseSerialization
-  chain << Avocado::Middleware::ResourceSerialization
-  chain << Avocado::Middleware::ExampleSerialization
-  chain << Avocado::Middleware::IgnoreXhrRequests
-end

data/lib/avocado/middleware/document_if_configuration.rb DELETED

@@ -1,12 +0,0 @@
-module Avocado
-  class Middleware::DocumentIfConfiguration
-    # return false if document_if returns false, so it will
-    # stop the middleware chain and not upload anything
-    def call(*)
-      continue = Avocado::Config.document_if.call
-      yield continue
-    end
-  end
-end

data/lib/avocado/middleware/document_metadata.rb DELETED

@@ -1,14 +0,0 @@
-module Avocado
-  class Middleware::DocumentMetadata
-    # return false if the :document metadata is given and is explicitly false
-    def call(package)
-      if package.document?
-        yield
-      else
-        yield false
-      end
-    end
-  end
-end

data/lib/avocado/middleware/example_serialization.rb DELETED

@@ -1,10 +0,0 @@
-module Avocado
-  class Middleware::ExampleSerialization
-    def call(package)
-      Avocado::RequestStore.instance.json[:description] = package.description
-      yield
-    end
-  end
-end

data/lib/avocado/middleware/ignore_xhr_requests.rb DELETED

@@ -1,10 +0,0 @@
-module Avocado
-  class Middleware::IgnoreXhrRequests
-    # return false and bail if the request is AJAX
-    def call(package)
-      yield !package.request.xhr?
-    end
-  end
-end

data/lib/avocado/middleware/request_serialization.rb DELETED

@@ -1,48 +0,0 @@
-module Avocado
-  class Middleware::RequestSerialization
-    def call(package)
-      @request = package.request
-      Avocado::RequestStore.instance.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 v.is_a? Hash
-            deep_replace_file_uploads_with_text(v)
-          elsif v.is_a? Array
-            v.each { |element| deep_replace_file_uploads_with_text(_: element) }
-          elsif v.respond_to? :eof
-            hash[k] = '<Multipart File Upload>'
-          end
-        end
-      end
-  end
-end

data/lib/avocado/middleware/resource_serialization.rb DELETED

@@ -1,20 +0,0 @@
-module Avocado
-  class Middleware::ResourceSerialization
-    def call(package)
-      request = package.request
-      name = infer_resource_name_from_request(request)
-      Avocado::RequestStore.instance.json.merge! resource: { name: name }
-      yield
-    end
-    private
-      def infer_resource_name_from_request(request)
-        controller = request.params[:controller]
-        name = controller.partition('/').reject(&:blank?).last
-        name.titleize.split('/').last
-      end
-  end
-end

data/lib/avocado/middleware/response_serialization.rb DELETED

@@ -1,20 +0,0 @@
-module Avocado
-  class Middleware::ResponseSerialization
-    def call(package)
-      response = package.response
-      Avocado::RequestStore.instance.json.merge! response: serialize(response)
-      yield
-    end
-    private
-      def serialize(response)
-        {
-          status: response.status,
-          body:   response.body
-        }
-      end
-  end
-end

data/lib/avocado/packages/minitest_package.rb DELETED

@@ -1,15 +0,0 @@
-module Avocado
-  module Packages
-    class MinitestPackage < Package
-      def description
-        example
-      end
-      def document?
-        true
-      end
-    end
-  end
-end