apic 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e91d7da069396fc04033442798fcfa93717c2e
-  data.tar.gz: 09884be511addc4b3a701d8a16ce9e1373a08358
+  metadata.gz: f7f55ccf1ff4c22f1b24ad1969ee107cfa416030
+  data.tar.gz: 8080b18679726d48795dced26b908354edb83b41
 SHA512:
-  metadata.gz: 34c1269243b0ffe1e7908d577a8776703445a62dfd1cd4aea88a88f2d166e964580c7d4420d2a83296324709b3f8721364fcbb79b2e04f7f62bf97ad538c0a09
-  data.tar.gz: 4353172bb5077836055d5778326664e3b05a84a6347b4026d3c6f9ed4a65a0fff394e614d997d71bd35cd2ea08b733c8766b332bd72978f49fb09307787a162b
+  metadata.gz: 4d66f4291f31f76ebe2b763dabe201a45c0b2d0523f0be8db6d373c9ef2d7cb8200d8dbf3ad53b6756aae9e9852309423a35ce12ca4505f906fbac4925dcf8d2
+  data.tar.gz: 2a482d14f24c4aa53db611e89fa10060b981a46d0562d68c07d1511866e7af791ca1ba9d787f29c9588165ae623cf37675cd0d3dda45df6c9206696d2fa9f850

data/README.md

@@ -1,4 +1,4 @@
-= APIc
+# APIc
 
 ## What is it?
 
@@ -46,7 +46,7 @@ To make this as simple and painless as possible, APIc exposes a DSL to your cont
 APIc knows what type of routes are available and will automatically add in the _method parameter and value for PATCH and DELETE requests.
 
 ```
-class TestController << ActionController.base
+class TestController < ActionController.base
 
   apic_action_params create: [:name, :acceptance]
 
@@ -59,7 +59,7 @@ end
 
 ### Initializer
 
-The apic:install generator will add in a default intializer providing examples of the route matching and authentication filtering.
+The apic:install generator will mount APIc to /apic and add in a default intializer providing examples of the route matching and authentication filtering.
 
 ```
 config/initializers/apic.rb
@@ -76,6 +76,21 @@ For example, if you have namespecs all of your api endpoints to /api/v1/ simply
 Apic.route_matcher = /\/api\/v1\//
 ```
 
+#### Custom Headers
+
+When you add headers in APIc we automatically create typeahead options for standard request headers.
+However, many, many people define their own headers for use in a custom API. APIc lets you specify
+any custom headers you want to make available to the typeahead by setting an array of header names
+in the apic.rb initializer.
+
+```
+Apic.custom_headers = %w(HTTP-MY-AWESOME-HEADER HTTP-ANTOHER-AWESOME-HEADER)
+```
+
+Of course you can create any header you want in the UI, even if it is not defined as a custom header,
+but for other people using this tool in your organization or even in public would probably appreciate it if
+they didn't have to remember exactly what that header field name was!.
+
 #### Authentication filters
 
 When testing your API it is often convenient to know which routes require authentication as you will need to add those headers before sending your request.
@@ -85,4 +100,40 @@ If you specify in your configuration the before_filter you are using for authent
 Apic.authentication_filter = :authenticate
 ```
 
+## Requirements
+
+APIc _should_ work on any Rails 3.2+ application out of the box.
+If it doesn't, send me a pull request!!
+
+## Roadmap
+
+APIc is still in the very early days. I've gone with greater developer (as in me!) productivity at the cost of more dependencies
+in the gem. Moving forward, I'd like to see the following:
+
+- Rebuild views with vanilla erb so I can drop slim-rails
+- Find someone who rocks at css/design and ditch bootstrap/sass
+- Rewrite the jquery plugins in vanilla js so I can drop jquery and coffee
+
+Under the 'fun' section comes
+
+- Implement OAuth and Basic authentication as well as token caching
+- Collect and display response time metrics
+- Spec and Doc the crap out of it!
+
+I guess when all that is done, APIc goes to 1.0.0
+
+# Contribute
+
+Just Do It!
+
 This project rocks and uses MIT-LICENSE.
+
+
+### Change log
+
+#### 2013.10.05
+- Removed the default 'api' route matching.
+- Rationalized route matching to ensure that internal and apic routes are not exposed as endpoints.
+- Altered history links to replay on single click instead of double click.
+- added support for customized headers typeahead matching when setting a header.
+

data/app/assets/javascripts/apic/application.js

@@ -13,3 +13,4 @@
 //= require_tree .
 //
 //= require bootstrap-modal
+//= require bootstrap-typeahead

data/app/assets/javascripts/apic/components/endpoints.js.coffee

@@ -13,7 +13,7 @@ $.fn.extend
 
     $.each endpoints, (key, value) ->
       option = $('<option>'+ key + '</option>')
-      option.text('[restricted] ' + option.text()) if value.authorization_required
+      option.text('[restricted] ' + option.text()) if value.authentication_required
       $(settings.select).append(option)
 
     change = ->

data/app/assets/javascripts/apic/components/http-headers.js.coffee

@@ -1,21 +1,56 @@
 $.fn.extend
   httpHeaders: (options) ->
-    settings =
-      presets: {'Content-Type': 'application/json'}
+    defaults =
+      presets: {'Content-Type': 'application/json'},
+      headers: [
+        'Accept',
+        'Accept-Charset',
+        'Accept-Datetime',
+        'Accept-Encoding',
+        'Accept-Language',
+        'Authorization',
+        'Cache-Control',
+        'Connection',
+        'Content-Length',
+        'Content-MD5',
+        'Content-Type',
+        'Cookie',
+        'Date',
+        'Expect',
+        'From',
+        'Host',
+        'If-Match',
+        'If-Modified-Since',
+        'If-None-Match',
+        'If-Range',
+        'If-Unmodified-Since',
+        'Max-Forwards',
+        'Origin',
+        'Pragma',
+        'Proxy-Authorization',
+        'Range',
+        'Referer',
+        'TE',
+        'Upgrade',
+        'User-Agent',
+        'Via',
+        'Warning'
+      ]
 
     $.each $(this).data(), (key, value) ->
-      settings[key] = value
+      defaults[key] = $.extend defaults[key], value
 
-    settings = $.extend settings, options
+    settings = $.extend defaults, options
 
     $(this).data('items', settings.presets)
 
     self = this
 
+    $('#inputHttpHeaderFieldName').typeahead({source: settings.headers})
     selected = undefined
 
     add = ->
-      name = $('#selectHttpHeaderFieldName').val()
+      name = $('#inputHttpHeaderFieldName').val()
       value = $('#inputHttpHeaderValue').val()
       if !!name and !!value
         tmp_items = items()
@@ -37,12 +72,12 @@ $.fn.extend
       name = self.selected.data('key')
       headers = items()
       value = headers[name]
-      $('#selectHttpHeaderFieldName').val(name)
+      $('inputHttpHeaderFieldName').val(name)
       $('#inputHttpHeaderValue').val(value)
       $('#httpHeadersModal').modal('show')
 
     create = ->
-      $('#selectHttpHeaderFieldName').prop("selectedIndex",0)
+      $('#inputHttpHeaderFieldName').val('')
       $('#inputHttpHeaderValue').val('')
       $('#httpHeadersModal').modal('show')
 

data/app/assets/javascripts/apic/components/xhr_history.js.coffee

@@ -41,8 +41,9 @@ $.fn.extend
       else
         li.removeClass('active')
 
-    #$(self).on('refresh', -> refresh.apply self)
+    $(self).on('refresh', -> refresh.apply self)
     $(self).on('add', (e, item) -> add.apply self, [item])
-    $('.xhr-history').on('dblclick', 'li', (e) -> replay this)
+    $('.xhr-history').on('click', 'li', (e) -> replay this)
     $('.toggle-history').on('click', -> show.apply self)
+
     this

data/app/controllers/apic/application_controller.rb

@@ -1,8 +1,13 @@
 module Apic
   class ApplicationController < ActionController::Base
+
+    before_filter :custom_headers, :endpoints
+
     def index
-      Rails.logger.debug endpoints
-      endpoints
+    end
+
+    def custom_headers
+      @custom_headers ||= Apic::custom_headers
     end
 
     def endpoints

data/app/views/apic/application/components/_http_headers.html.slim

@@ -1,7 +1,7 @@
 div.row.headers
   div.http-headers-component
     h4 HTTP Headers
-    div.http-headers
+    div.http-headers(data-headers="#{@custom_headers}")
       ul.http-headers-list.nav.nav-list
 
     div.http-headers-controls
@@ -18,45 +18,13 @@ div.row.headers
     div.modal-body
       form.form-horizontal
         div.control-group
-          label.control-label(for='selectHttpHeaderFieldName') Header
+          label.control-label(for='inputHttpHeaderFieldName') Header
           div.controls
-            select(id='selectHttpHeaderFieldName')
-              option Accept
-              option Accept-Charset
-              option Accept-Datetime
-              option Accept-Encoding
-              option Accept-Language
-              option Authorization
-              option Cache-Control
-              option Connection
-              option Content-Length
-              option Content-MD5
-              option Content-Type
-              option Cookie
-              option Date
-              option Expect
-              option From
-              option Host
-              option If-Match
-              option If-Modified-Since
-              option If-None-Match
-              option If-Range
-              option If-Unmodified-Since
-              option Max-Forwards
-              option Origin
-              option Pragma
-              option Proxy-Authorization
-              option Range
-              option Referer
-              option TE
-              option Upgrade
-              option User-Agent
-              option Via
-              option Warning
+            input#inputHttpHeaderFieldName
         div.control-group
           label.control-label(for='inputHttpHeaderValue') Value
           div.controls
-            input.input-xxlarge(type='text' id='inputHttpHeaderValue' placeholder='value')
+            input.input-xxlarge#inputHttpHeaderValue(type='text' placeholder='value')
 
     div.modal-footer
       a.btn(href='#' data-dismiss='modal') Cancel

data/lib/apic.rb

@@ -2,52 +2,39 @@ require 'apic/params_cache'
 require "apic/extension"
 require "apic/engine"
 require "apic/generators/install_generator"
+require 'apic/route_wrapper'
 module Apic
 
   mattr_accessor :authentication_filter
   @@authentication_filter = nil
 
   mattr_accessor :route_matcher
-  @@route_matcher = /\/api\//
+  @@route_matcher = /.*/
 
+  mattr_accessor :custom_headers
+  @@custom_headers = []
 
+  class << self
 
-  def self.endpoints
-    @endpoints ||= Rails.application.routes.routes.reduce({}) do |hash, route|
-      if route.path.spec.to_s =~ @@route_matcher
-        route_spec = {
-          path: route.path.spec.to_s.gsub("(.:format)",".json"),
-          parts: route.parts - [:format],
-          verb: route.verb.source.gsub(/[\^\$]/,''),
-          template: template_for(route.defaults[:controller], route.defaults[:action])
-        }
-        if %(PATCH DELETE).include? route_spec[:verb]
-          route_spec[:template] = route_spec[:template] + ['_method']
-        end
-        if requires_authorization route.defaults[:controller], route.defaults[:action]
-          route_spec[:authorization_required] = true
-        end
-
-        hash[[route_spec[:verb],route_spec[:path]].join(' ')] = route_spec
-      end
-      hash
+    def endpoints
+      @endpoints ||= endpoints_hash
     end
-  end
 
-  def self.requires_authorization(controller, action_name)
-    return false unless @@authentication_filter
-    controller = (controller + '_controller').camelize.constantize
-    controller._process_action_callbacks.any? do |callback|
-      eval <<-RUBY_EVAL
-      #{callback.filter == @@authentication_filter} && #{callback.instance_values['compiled_options']}
-      RUBY_EVAL
+    private
+
+    def endpoints_hash
+      Hash.new do |hash, route|
+        wrapper = RouteWrapper.new(route)
+        hash[wrapper.endpoint] = wrapper.to_h unless wrapper.internal?
+      end.tap do |hash|
+        Rails.application.routes.routes.each do |route|
+          if route.path.spec.to_s =~ @@route_matcher
+            hash[route]
+          end
+        end
+      end
     end
   end
-
-  def self.template_for(controller, action)
-    (controller + '_controller').camelize.constantize
-    Apic::ParamsCache.params_for(controller, action) || []
-  end
 end
 
 

data/lib/apic/generators/templates/apic.rb

@@ -1,10 +1,18 @@
 # Specify a route matcher to restrict which application routes are available
 # in the console. By default all routes will be loaded
 #
-# Apic.route_matcher = /\/api\/v1\//
+# Apic.route_matcher = /.*/
 #
 #
-# Specify your authentication filter. Requests that use this filter will be marked
+# Specify your authentication filter.
+# Requests that use this filter will be marked
 # as restricted in the Api endpoints list.
 #
 # Apic.authentication_filter = :authenticate
+#
+#
+# Declare custom headers.
+# These headers are added to the list of matches in the UI's typeahead
+# used to set headers for requests.
+#
+# Apic.custom_headers = %w(Total-Awesomeness Http-More-Awesome-Than-Awesome)

data/lib/apic/route_wrapper.rb

@@ -0,0 +1,70 @@
+require 'delegate'
+
+module Apic
+  class RouteWrapper < SimpleDelegator
+
+    def to_h
+      endpoint = {
+        path: path,
+        parts: parts - [:format],
+        verb: verb,
+        template: template,
+        key: key,
+        authentication_required: authentication_required
+      }
+
+      if %(PATCH DELETE).include? verb
+        endpoint[:template] << '_method'
+      end
+
+      endpoint
+    end
+
+    def endpoint
+      [verb, path].join(' ')
+    end
+
+    def internal?
+      requirements[:controller].to_s =~ %r{\Arails/(info|welcome)} ||
+        path =~ %r{\A#{Rails.application.config.assets.prefix}} ||
+        path =~ %r{\A\/apic}
+    end
+
+  private
+
+    def authentication_required
+      return false unless Apic.authentication_filter
+      controller._process_action_callbacks.any? do |callback|
+        eval <<-RUBY_EVAL
+        #{callback.filter == Apic.authentication_filter} && #{callback.instance_values['compiled_options']}
+        RUBY_EVAL
+      end
+    end
+
+    def controller
+      if controller = requirements[:controller]
+        [controller.to_s, 'controller'].join('_').camelize.constantize
+      end
+    end
+
+    def verb
+      super.source.gsub(/[$^]/, '')
+    end
+
+    def path
+      super.spec.to_s.gsub("(.:format)",".json")
+    end
+
+    def action_name
+      requirements[:action]
+    end
+
+    def key
+      [verb, path].join(' ')
+    end
+
+    def template
+      Apic::ParamsCache.params_for(controller, action_name) || []
+    end
+  end
+end

data/lib/apic/version.rb

@@ -1,3 +1,3 @@
 module Apic
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Randy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,8 +94,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Apic is a mountable rails engine that enables a web based console for
-  testing api endpoints.
+description: APIc is a bolt on API console for Rails 3+ applications. It rounds up
+  your endpoints and makes it dead easy to configure, send, review and replay any
+  request.
 email:
 - digital.ipseity@gmail.com
 executables: []
@@ -128,6 +129,7 @@ files:
 - lib/apic/generators/install_generator.rb
 - lib/apic/generators/templates/apic.rb
 - lib/apic/params_cache.rb
+- lib/apic/route_wrapper.rb
 - lib/apic/version.rb
 - lib/apic.rb
 - lib/tasks/apic_tasks.rake