avocado-docs 3.0.10 → 3.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWNhYWQ1YzY5NzQ5MmE2N2IwZWRkOWZhMjEwNmExOTI5MjBlMDZiZg==
-  data.tar.gz: !binary |-
-    NTMzMWY2MTU3YjA3YzA3MjMwOGUxNjE2NWQzZDdlZDVmYzk5ODFhYQ==
+SHA1:
+  metadata.gz: d41e3b7113ec16d2179bd7a53a11df303a21abe0
+  data.tar.gz: cadc27ef5996be8a1a349e5a2cefa0a0955d7126
 SHA512:
-  metadata.gz: !binary |-
-    YjA4Y2YyODA4MGViOTg3NWYyNzlkNTQzMmI4NTMyYjJkYWRhZDc0ZTFlNjJl
-    N2IzNjY1Mjg0YTBiNTQ2NjIwMWViNTY0MmM2OGQyNDM4ZWRmNjk0NTZlYTE3
-    ZmMwODNjMjAwMmMxMTg2MmNkOTZlNmVkZWU1ZmZmMmJkMTNkYmU=
-  data.tar.gz: !binary |-
-    YTU2MzM5M2NiZjhjODVmYzQ5MGZjNTc3YWZmMzQ0MmZjYjNmYjVkYjdhYTg4
-    NWZmMmQzYjg3MGNjZDI3M2Q4NjExNTZjYTI5ODFlYWE5MDY2NDliZjVlMzdi
-    MDRiY2Q1YWY1ZWE2NmI1ZmMzNjVlNjQ5YjM0ZDk3MGViOWYwZjA=
+  metadata.gz: 3a299f666560f1bcf1c6f966cec5d34188bd54e250252a5fe9ccc85f32dd48fba534b97d778adc8a5c56ee7ca12ea5aa32e62602a3e93d69c763b79e8478ca04
+  data.tar.gz: cf28d6e25966fd6a8fbea3b3c53b5561afeaba60e24ba9401a61e827bf7d93aad5a4c35b06a0b3e42ff3e59b68cc1e87cd31de8f50314c25ee8750554229b716

data/app/assets/javascripts/avocado/app.coffee

@@ -0,0 +1 @@
+app = angular.module 'avocado', ['angular.filter']

data/app/assets/javascripts/avocado/application.js.coffee

@@ -1,22 +1,5 @@
-# This is a manifest file that'll be compiled into application.js, which will include all the files
-# listed below.
-#
-# Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-# or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-#
-# It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-# compiled file.
-#
-# Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
-# about supported directives.
-#
 #= require jquery
 #= require jquery_ujs
-#= require avocado/angular.min
-#= require avocado/angular-route.min
-#= require avocado/ui-utils.min
-#= require avocado/app
-#= require avocado/md5
 #= require_tree .
 
 $ ->
@@ -27,4 +10,4 @@ $ ->
   $('.left-side, .right-side').mouseup (e) ->
     container = $('.filters')
     if !(container.is(e.target)) && (container.has(e.target).length is 0)
-      container.hide()
+      container.hide()

data/app/assets/javascripts/avocado/avocado-ctrl.coffee

@@ -0,0 +1,50 @@
+angular.module('avocado')
+
+.controller 'AvocadoCtrl', ['$scope', '$location', 'Spec', 'ResponseStatusFilter', 'RequestMethodFilter', ($scope, $location, Spec, ResponseStatusFilter, RequestMethodFilter) ->
+  new class AvocadoCtrl
+    constructor: ->
+      @allSpecs = Spec.all()
+      @specs = Spec.all()
+      @query = undefined
+      @activeSpec = @_findActiveSpec() if @_specUUIDGiven()
+      @activeResource = 'All'
+
+      @filters = [
+        new ResponseStatusFilter(200, 299, true)
+        new RequestMethodFilter('GET')
+        new RequestMethodFilter('POST')
+        new RequestMethodFilter('PATCH', 'PUT')
+        new RequestMethodFilter('DELETE')
+      ]
+
+    chooseSpec: (spec) ->
+      @activeSpec = spec
+      $location.path spec.uuid
+
+    chooseResource: ->
+      resourceName = @activeResource.replace /\s+/g, ''
+      @specs = if resourceName is 'All' then @allSpecs else Spec.forResource(resourceName)
+
+    getFilteredSpecs: ->
+      specs = @specs
+      activeFilters  = @filters.filter (f) -> f.active
+      strictFilters  = activeFilters.filter (f) -> f.strict
+      relaxedFilters = activeFilters.filter (f) -> !f.strict
+
+      specs.filter (spec) ->
+        result = strictFilters.every((f) -> f.apply(spec))
+        result &&= relaxedFilters.some((f) -> f.apply(spec)) if relaxedFilters.length > 0
+        result
+
+    search: (spec) =>
+      return true if !@query
+      [spec.request.path, spec.description].some (term) =>
+        term.toLowerCase().indexOf(@query.toLowerCase()) != -1
+
+    _findActiveSpec: ->
+      specUUID = $location.path().substr 1
+      @activeSpec = @allSpecs.find (spec) -> spec.uuid == specUUID
+
+    _specUUIDGiven: ->
+      $location.path().length > 0
+  ]

data/app/assets/javascripts/avocado/{services/request.js.coffee → factories/request.coffee}

@@ -1,12 +1,14 @@
-angular.module('avocado.services').factory 'Request', ->
+angular.module('avocado')
 
+.factory 'Request', ->
   class Request
     constructor: (json) ->
       @method = json.method
       @path = json.path
       @params = JSON.stringify(json.params, undefined, 2)
+      @headers = ''
 
-      @headers = ""
-      for name,value of json.headers
+      for name, value of json.headers
         @headers = "#{@headers}\n#{name}: #{value}"
+        
       @headers = @headers.trim()

data/app/assets/javascripts/avocado/factories/resource.coffee

@@ -0,0 +1,6 @@
+angular.module('avocado')
+
+.factory 'Resource', ->
+  class Resource
+    constructor: (json) ->
+      @name = json.name

data/app/assets/javascripts/avocado/factories/response.coffee

@@ -0,0 +1,11 @@
+angular.module('avocado')
+
+.factory 'Response', ->
+  class Response
+    constructor: (json) ->
+      @statusCode = json.status
+
+      try
+        @body = JSON.stringify JSON.parse(json.body), undefined, 2
+      catch e
+        @body = ''

data/app/assets/javascripts/avocado/factories/spec.coffee

@@ -0,0 +1,27 @@
+angular.module('avocado')
+
+.factory 'Spec', ['Request', 'Response', 'Resource', (Request, Response, Resource) ->
+
+  class Spec
+    constructor: (json) ->
+      @description = json.description
+      @request = new Request json.request
+      @response = new Response json.response
+      @resource = new Resource json.resource
+      @uuid = @generateMD5Hash @request, @response
+
+    @all: ->
+      specs = []
+      window.data.forEach (data) ->
+        angular.fromJson(data).forEach (data) ->
+          specs.push new Spec(data)
+      specs
+
+    @forResource: (resourceName) ->
+      @all().filter (spec) ->
+        spec.resource.name.replace(/\s+/g, '') == resourceName
+
+    generateMD5Hash: (request, response) ->
+      hashTarget = @description + request.method + request.path + request.params + request.headers
+      md5(hashTarget).toString().substr 0, 7
+]

data/app/assets/javascripts/avocado/filters/request-method-filter.coffee

@@ -0,0 +1,15 @@
+angular.module('avocado')
+
+.factory 'RequestMethodFilter', ->
+  class RequestMethodFilter
+    constructor: (methods...) ->
+      @methods = methods
+      @active  = false
+      @strict  = false
+
+    getName: ->
+      @methods[0]
+
+    apply: (item) ->
+      @methods.some (method) ->
+        item.request.method == method

data/app/assets/javascripts/avocado/filters/response-status-filter.coffee

@@ -0,0 +1,15 @@
+angular.module('avocado')
+
+.factory 'ResponseStatusFilter', ->
+  class ResponseStatusFilter
+    constructor: (minCode, maxCode, active = false) ->
+      @minCode = minCode
+      @maxCode = maxCode
+      @active  = active
+      @strict  = true
+
+    getName: ->
+      @minCode
+
+    apply: (item) ->
+      @minCode <= item.response.statusCode <= @maxCode

data/app/controllers/avocado/specs_controller.rb

@@ -1,4 +1,34 @@
 module Avocado
-  class SpecsController < AvocadoController
+  class SpecsController < ::ActionController::Base
+    layout 'avocado'
+
+    def index
+      @data = json_files.map { |filename| File.read filename }
+    end
+
+    def create
+      File.open(new_json_filename, 'w+') { |f| f.write params[:file].read }
+      File.delete(*json_files_from_past_uploads)
+      head :ok
+    end
+
+    private
+      def upload_id
+        params[:upload_id]
+      end
+
+      def new_json_filename
+        Avocado.json_path.join "avocado-#{Time.current.to_s(:nsec)}-#{Avocado.upload_id.call}.json"
+      end
+
+      def json_files
+        Dir.glob Avocado.json_path.join('avocado*.json')
+      end
+
+      def json_files_from_past_uploads
+        json_files.reject do |spec|
+          spec.end_with? "-#{upload_id}.json"
+        end
+      end
   end
-end
+end

data/app/views/avocado/specs/index.html.erb

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

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

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>API Docs</title>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.5.8/angular.min.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/angular-filter/0.5.11/angular-filter.min.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/blueimp-md5/2.4.0/js/md5.min.js"></script>
+
+  <%= stylesheet_link_tag    "avocado/application", media: "all" %>
+  <%= javascript_include_tag "avocado/application" %>
+  <%= csrf_meta_tags %>
+
+  <script type="text/javascript">
+    var data = <%= @data.to_json.html_safe %>;
+  </script>
+</head>
+<body ng-app="avocado" ng-controller="AvocadoCtrl as ctrl">
+<%= yield %>
+</body>
+</html>

data/config/routes.rb

@@ -1,4 +1,4 @@
 Avocado::Engine.routes.draw do
-  root to: 'specs#index'
   resources :specs, only: [:create]
+  root to: 'specs#index'
 end

data/lib/avocado-docs.rb

@@ -1,21 +1,39 @@
 require 'avocado/engine'
-require 'avocado/config'
+require 'avocado/controller_patch'
+require 'avocado/controller_response'
+require 'avocado/logger'
+require 'avocado/storage'
 require 'avocado/uploader'
-require 'avocado/controller'
-require 'avocado/request_store'
-require 'avocado/packages/package'
-require 'avocado/packages/minitest_package'
-require 'avocado/packages/rspec_package'
-require 'avocado/middleware'
-require 'avocado/middleware/defaults'
-
-require 'yaml'
-require 'net/http/post/multipart'
+require 'avocado/adapters/base_adapter'
+require 'avocado/adapters/minitest_adapter'
+require 'avocado/adapters/rspec_adapter'
+require 'avocado/adapters/cucumber_adapter'
+require 'avocado/serializers/request_serializer'
+require 'avocado/serializers/resource_serializer'
+require 'avocado/serializers/response_serializer'
 
 module Avocado
-  def self.reset!
-    Avocado::Config.reset!
-    Avocado::RequestStore.instance.reset!
-    Avocado::Uploader.instance.payload = []
+  class << self
+    attr_accessor :url, :headers, :json_path, :upload_id, :document_if, :ignored_params, :storage, :uploader
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      self.url = nil
+      self.headers = []
+      self.json_path = ::Rails.root
+      self.upload_id = proc { SecureRandom.uuid }
+      self.document_if = proc { true }
+      self.ignored_params = %w(controller action format)
+      self.storage = Avocado::Storage.instance
+      self.uploader = Avocado::Uploader.instance
+
+      storage.clear
+      uploader.reset
+    end
   end
 end
+
+Avocado.reset!

data/lib/avocado/adapters/base_adapter.rb

@@ -0,0 +1,36 @@
+module Avocado
+  module Adapters
+    class BaseAdapter
+      attr_accessor :spec, :request, :response
+
+      def initialize(spec, request, response)
+        @spec = spec
+        @request = request
+        @response = response
+      end
+
+      def upload?(&block)
+        block ||= proc { true }
+        request && response && !ajax? && document_if? && block.call
+      end
+
+      def to_h
+        {
+          description: spec.description,
+          resource: Avocado::Serializers::ResourceSerializer.new(request).to_h,
+          request: Avocado::Serializers::RequestSerializer.new(request).to_h,
+          response: Avocado::Serializers::ResponseSerializer.new(response).to_h
+        }
+      end
+
+      private
+        def ajax?
+          request.xhr?
+        end
+
+        def document_if?
+          Avocado.document_if.call request, response
+        end
+    end
+  end
+end

data/lib/avocado/adapters/cucumber_adapter.rb

@@ -0,0 +1,15 @@
+module Avocado
+  module Adapters
+    class CucumberAdapter < BaseAdapter
+      def description
+        spec.name
+      end
+
+      def upload?
+        super do
+          spec.tags.none? { |tag| tag.name == 'nodoc' }
+        end
+      end
+    end
+  end
+end

data/lib/avocado/adapters/minitest_adapter.rb

@@ -0,0 +1,10 @@
+module Avocado
+  module Adapters
+    class MinitestAdapter < BaseAdapter
+      # In Minitest case, the spec object is just the name of the spec
+      def description
+        spec
+      end
+    end
+  end
+end

data/lib/avocado/adapters/rspec_adapter.rb

@@ -0,0 +1,13 @@
+module Avocado
+  module Adapters
+    class RSpecAdapter < BaseAdapter
+      def description
+        spec.description
+      end
+
+      def upload?
+        super { spec.metadata[:document] != false }
+      end
+    end
+  end
+end