apic 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f55ccf1ff4c22f1b24ad1969ee107cfa416030
-  data.tar.gz: 8080b18679726d48795dced26b908354edb83b41
+  metadata.gz: c0e7799efebd063e0552aaa1e4d228a52cf7686f
+  data.tar.gz: 275901e0611bfe5f365b369f5b3875ebeab71e07
 SHA512:
-  metadata.gz: 4d66f4291f31f76ebe2b763dabe201a45c0b2d0523f0be8db6d373c9ef2d7cb8200d8dbf3ad53b6756aae9e9852309423a35ce12ca4505f906fbac4925dcf8d2
-  data.tar.gz: 2a482d14f24c4aa53db611e89fa10060b981a46d0562d68c07d1511866e7af791ca1ba9d787f29c9588165ae623cf37675cd0d3dda45df6c9206696d2fa9f850
+  metadata.gz: 01d892744c5de8ba1fd36943517c9452ee3d57d907be6fff7ae8eb1198cd6ce275ade2f47c4d9b1501ad14e530b33b880af277879c45061b179705a127e511ed
+  data.tar.gz: 47347d896f2546785217e2af4ddbde1bc6ef3919b18495a078f4aa29c6fe456c601d52f10873f8206c0113d67c84ad9e1e050b0d82ac47fcbd76cbda150d46cb

data/README.md

@@ -57,6 +57,8 @@ class TestController < ActionController.base
 end
 ```
 
+Additionally, you can specify custom parameters via the UI so if you dont want to declare your action parameters in your controllers you can always add them from the APIc console.
+
 ### Initializer
 
 The apic:install generator will mount APIc to /apic and add in a default intializer providing examples of the route matching and authentication filtering.
@@ -131,7 +133,13 @@ This project rocks and uses MIT-LICENSE.
 
 ### Change log
 
-#### 2013.10.05
+#### 2013.10.05 version 0.0.4
+- Added support for declaring customized parameters in the APIc console UI.
+- Patched bug in action_params collection
+- Improved log output to show full request and response details.
+- Improved replay to rebuild the headers and endpoint section of the APIc console UI when you click on a history item.
+
+#### 2013.10.05 version 0.0.3
 - 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.

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

@@ -4,15 +4,15 @@
 $.fn.extend
   apic_console: (options) ->
     settings =
-      endpoint: '.endpoints-component',
-      headers: '.http-headers',
-      params: '.parameter',
-      console: '.console',
-      console_log: '.console-log',
-      history: '.xhr-history',
-      host: 'localhost:3000',
-      request_timeout: 10000,
-      timeout_callback: null,
+      endpoint: '.endpoints-component'
+      headers: '.http-headers'
+      params: '.parameter'
+      console: '.console'
+      console_log: '.console-log'
+      history: '.xhr-history'
+      host: 'localhost:3000'
+      request_timeout: 10000
+      timeout_callback: null
       response_callback: null
 
     self = this
@@ -21,31 +21,14 @@ $.fn.extend
 
     settings = $.extend settings, options
 
-    log_timeline = (method, uri) ->
-      self._end = new Date().getTime()
-      if console.log
-        console.log 'Finished: (time: ' + duration() + '):' + method + ' ' + uri
-
-    log_request = (xhr)  ->
-      self._start = new Date().getTime()
-
-      $(settings.console_log).empty()
-      log_item "Request URL", uri()
-      log_item "Request Method", endpoint().verb
-      log_item "Response Code", [xhr.status, xhr.statusText].join(' ')
-      log_item "Request Headers", xhr.getAllResponseHeaders()
-
-    log_item = (title, message) ->
-      $(settings.console_log).append('<div><span class="log-header">' + title + '</span>:<span class="log-data"> ' + message + '</span></div>')
-
     duration = ->
       seconds = 0
-      time = _end - _start
+      time = self._end - self._start
       try
         seconds = ((time/10) / 60).toFixed(2)
       catch e
         0
-      seconds
+      seconds + ' seconds'
 
     endpoint = ->
       $(settings.endpoint).data('endpoint')
@@ -57,21 +40,23 @@ $.fn.extend
       path  = endpoint().path
       for part in endpoint().parts
          path = path.replace(':' + part, value_for part)
-      if endpoint().verb is 'GET'
-        path += query_string()
+       if endpoint().verb is 'GET' and query_string().lenght > 0
+         path = [path, query_string()].join('?')
       path
 
 
     value_for = (name) ->
-      $(settings.params + ' [name="' + name + '"]').val()
+      $(settings.params + ' input[name="' + name + '"]').val()
 
     parameters = ->
       endpoint().template
 
     body = ->
       hash = {}
-      for param in parameters()
-        hash[param] = value_for param
+      $.each $(settings.params + ' input'), (index, input) ->
+        name = $(input).attr 'name'
+        unless endpoint().parts.indexOf(name) >= 0
+          hash[name] = value_for name
       hash
 
     query_string = ->
@@ -81,6 +66,10 @@ $.fn.extend
       args.join '&'
 
     onload = (xhr) ->
+      self._end = new Date().getTime()
+      request = record(xhr)
+      $(settings.console_log).text JSON.stringify(request, undefined, 2)
+
       if xhr.status is 200
         try
           json = JSON.parse(xhr.responseText)
@@ -91,11 +80,8 @@ $.fn.extend
       else
         $(settings.console).text(xhr.responseText)
 
-      log_request xhr
-      record(xhr)
-
     onerror = (response) ->
-      console.log response
+      $(settings.console).text 'A network error has occurred. Please refresh the page and ensure that network connections to your API are possible'
 
     request = (endpoint, headers, uri) ->
       xhr = new XMLHttpRequest
@@ -127,16 +113,32 @@ $.fn.extend
       missing.length is 0
 
     record = (xhr) ->
+      params = {}
+      $.map $(settings.params +  " input"), (param) ->
+        params[$(param).attr('name')] = $(param).val()
+
       history_item =
-        endpoint: endpoint()
-        headers: headers()
-        body: body()
         uri: uri()
-        xhr: xhr
+        duration: duration()
+        headers: headers()
+        parameters: params
+        response: {status: xhr.status, statusText: xhr.statusText }
+        responseHeaders: xhr.getAllResponseHeaders().split('\r\n')
+        endpoint: endpoint()
+      if endpoint().verb != 'GET'
+        history_item['body'] = body()
 
       $(settings.history).trigger('add', [history_item])
+      history_item
+
+    replay = (request) ->
+      r = $.extend true, {}, request
+      $(settings.headers).trigger 'set', [r.headers]
+      $(settings.endpoint).trigger 'set', [r.endpoint, r.parameters]
+      send r.endpoint, r.headers, r.body, r.uri
 
     send = (_point, _head, _bod, _u) ->
+      self._start = new Date().getTime()
       _point ||= endpoint()
       _head ||= headers()
       _bod ||= body()
@@ -151,5 +153,7 @@ $.fn.extend
           xhr.send(data)
 
     $('#do-me').on('click', -> send.apply self, [null])
-    $(self).on('send', (e, point, head, bod, u) -> send.apply self, [point, head, bod, u])
+
+    $(self).on('replay', (e, request) -> replay.apply self, [request])
+
     true

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

@@ -3,7 +3,8 @@ $.fn.extend
     settings =
       select: '#selectEndpoint',
       template: '.template',
-      parameter: '.parameter'
+      parameter: '.parameter',
+      restricted: '[restricted] '
 
     self = this
 
@@ -13,14 +14,39 @@ $.fn.extend
 
     $.each endpoints, (key, value) ->
       option = $('<option>'+ key + '</option>')
-      option.text('[restricted] ' + option.text()) if value.authentication_required
+      option.text(settings.restricted + option.text()) if value.authentication_required
       $(settings.select).append(option)
 
+    add = (name) ->
+      if !!name
+        el = field_set_for name
+        $(el).find('.icon-remove').removeClass('hide')
+        $(el).find('.remove-parameter').on('click', -> remove.apply self, [el])
+        $('#endpointsModal').modal('hide')
+
+    create = ->
+      $('#inputParameterFieldName').val('')
+      $('#endpointsModal').modal('show')
+
+    remove = (el) ->
+      el.remove()
+
     change = ->
       endpoint = selected()
       $(self).data('endpoint', endpoint)
       populate_params endpoint
 
+    set = (point, param) ->
+      option = if point.authentication_required then settings.restricted + point.key else point.key
+      $(settings.select).val(option)
+
+      change()
+
+      $.each param, (key, value) ->
+        add(key) if $('input[name="' + key + '"]').length == 0
+        field = $('input[name="' + key + '"]')
+        $(field).val(value)
+
     populate_params = (endpoint) ->
       $(self).find(settings.parameter).remove()
       $.each endpoint.parts, (index, name) ->
@@ -31,7 +57,7 @@ $.fn.extend
           el.find('#input-_method').val(endpoint.verb.toLowerCase())
 
     selected = ->
-      endpoints[$(settings.select).val().replace('[restricted] ', '')]
+      endpoints[$(settings.select).val().replace(settings.restricted, '')]
 
     field_set_for = (name, options={}) ->
       clone = $(self).find(settings.template).clone()
@@ -45,8 +71,14 @@ $.fn.extend
       if options.required
         clone.find('input').prop('required',true)
       $(self).find('form').append(clone)
+      clone
 
     $(settings.select).on 'change', -> change.apply self
+    $('.create-parameter').on 'click', -> create.apply self
+    $('.add-parameter').on 'click', -> 
+      add.apply self, [$('#inputParameterFieldName').val()]
+
+    $(self).on 'set', (e, point, params) -> set.apply self, [point, params]
     change.apply self
 
     this

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

@@ -49,6 +49,11 @@ $.fn.extend
     $('#inputHttpHeaderFieldName').typeahead({source: settings.headers})
     selected = undefined
 
+    set = (data) ->
+      $(self).data('items', data)
+      populate()
+      true
+
     add = ->
       name = $('#inputHttpHeaderFieldName').val()
       value = $('#inputHttpHeaderValue').val()
@@ -126,6 +131,7 @@ $.fn.extend
     $('.http-headers-list').on('click', 'li', -> select this)
     $('.http-headers-list').on('dblclick', 'li', -> edit.apply self)
     $('.edit-headers').on('click', -> show.apply self)
+    $(self).on 'set', (e, headers) -> set.apply self, [headers]
 
     this
 

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

@@ -15,7 +15,7 @@ $.fn.extend
         $(self).append el
 
     list_item = (item) ->
-      $('<li class="xhr-history-item ' + item.xhr.statusText.toLowerCase() + '"><a href="#"><i class="icon-refresh icon-white ' + item.xhr.statusText.toLowerCase() + '"/><i>' + item.xhr.status + ' '+ item.endpoint.verb + ' ' + item.uri + '</span></a></li>')
+      $('<li class="xhr-history-item ' + item.response.statusText.toLowerCase() + '"><a href="#"><i class="icon-refresh icon-white ' + item.response.statusText.toLowerCase() + '"/><i>' + item.response.status + ' '+ item.endpoint.verb + ' ' + item.uri + '</span></a></li>')
 
     items = ->
       $(self).data('items')
@@ -28,8 +28,7 @@ $.fn.extend
 
     replay = (el) ->
       request = $(el).data('request')
-      $('.console').trigger('send', [request.endpoint, request.headers, request.body, request.uri])
-      console.log($(el).data('request'))
+      $('.console').trigger('replay', [request])
 
     show = ->
       el = $('.history')

data/app/assets/stylesheets/apic/components/endpoints.css.scss

@@ -4,6 +4,9 @@
 .template {
   display: none;
 }
+.remove-parameter {
+  display: none;
+}
 input.required {
   border-color: red;
 }

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

@@ -1,4 +1,4 @@
-div.endpoints-component( data-endpoints="#{@endpoints.to_json}")
+div.endpoints-component(data-endpoints="#{@endpoints.to_json}")
   h4 Endpoints
   div.endpoints
     form.form-horizontal
@@ -6,9 +6,36 @@ div.endpoints-component( data-endpoints="#{@endpoints.to_json}")
         label.control-label(for="selectEndpoint") Api Endpoint
         div.controls
           select.input-xxlarge(id='selectEndpoint')
-
-      div.control-group.template
-        label.control-label(for="inputParam") Param Name
+      div.control-group
+        label.control-label Parameters
         div.controls
+          a.btn.create-parameter(href='#endpointsModal')
+            == "+"
+
+      div.controls.parameters
+
+    div.control-group.template
+      label.control-label(for="inputParam") Param Name
+      div.controls
+        div.input-prepend
+          span.add-on.remove-parameter
+            i.icon-remove.hide
           input.input-xxlarge(id="inputParam" type="text")
 
+div.modal.hide.fade#endpointsModal
+  div.modal-header
+    button.close(type='button' data-dismiss='modal' aria-hidden='true')
+      == "×"
+    h4 Custom Parameter
+  div.modal-body
+    form.form-horizontal
+      div.control-group
+        label.control-label(for='inputParameterFieldName') Value
+        div.controls
+          input.input-xlarge#inputParameterFieldName(type='text' placeholder='Parameter Name')
+
+  div.modal-footer
+    a.btn(href='#' data-dismiss='modal') Cancel
+    a.btn.btn-primary.add-parameter(href='#') Ok
+
+

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

@@ -10,7 +10,7 @@ div.row.headers
       a(href='#' class='btn remove-http-header')
         == "-"
 
-  div.modal.hide.fade(id='httpHeadersModal')
+  div.modal.hide.fade#httpHeadersModal
     div.modal-header
       button.close(type='button' data-dismiss='modal' aria-hidden='true')
         == "×"

data/lib/apic/route_wrapper.rb

@@ -64,7 +64,7 @@ module Apic
     end
 
     def template
-      Apic::ParamsCache.params_for(controller, action_name) || []
+      Apic::ParamsCache.params_for(requirements[:controller], action_name) || []
     end
   end
 end

data/lib/apic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apic
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Randy Morgan