apic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f34a4f4aab7e80104a44cadc30f087c953b02f26
-  data.tar.gz: f3f170ca3ddf9ce1d90bdc222a9f31786dbf91e6
+  metadata.gz: 62e91d7da069396fc04033442798fcfa93717c2e
+  data.tar.gz: 09884be511addc4b3a701d8a16ce9e1373a08358
 SHA512:
-  metadata.gz: 43bf31780842c732681233c1e55a9b2abbcb20a25d6182b80b5c6fa30f082d0143df9a3442f2dced1eb01596b2495f3bde042662cf5dfab4e2a088571e939891
-  data.tar.gz: 0779a4e019559f14b99e10a0bfc7d463ff4ae2e42380438c6aa3dcdf5e4f6e51fd33163a1defa4ab8b589b738d120cd7897d91e103098d446f10cdcfa6b4928c
+  metadata.gz: 34c1269243b0ffe1e7908d577a8776703445a62dfd1cd4aea88a88f2d166e964580c7d4420d2a83296324709b3f8721364fcbb79b2e04f7f62bf97ad538c0a09
+  data.tar.gz: 4353172bb5077836055d5778326664e3b05a84a6347b4026d3c6f9ed4a65a0fff394e614d997d71bd35cd2ea08b733c8766b332bd72978f49fb09307787a162b

data/README.md

@@ -1,7 +1,12 @@
-= Apic
+= APIc
 
-[![Build Status](https://secure.travis-ci.org/hsbt/whispered.png)](https://travis-ci.org/hsbt/whispered) [![Coverage Status](https://coveralls.io/repos/randym/apic/badge.png?branch=master)](https://coveralls.io/r/randym/apic) [![Dependency Status](https://gemnasium.com/randym/apic.png)](https://gemnasium.com/randym/apic) [![Code Climate](https://codeclimate.com/github/randym/apic.png)](https://codeclimate.com/github/randym/apic)
+## What is it?
 
+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.
+
+
+![Screen 1](https://github.com/randym/apic/raw/master/sample.png)
 
 What you need to do?
 
@@ -11,35 +16,73 @@ add the gem to your Gemfile
 gem 'apic'
 ```
 
-require the gem in your application.rb
+Run the generator!
 
 ```
-require 'apic'
+rails generate apic:install
 ```
 
-mount the gem in your routes.rb
+If you are using bundler:
 
 ```
-mount Apic::Engine => "/apic"
+bundle exec rails generate apic:install
+
 ```
 
-## and some groovy stuff too
+Spin up your Rails application and navigate to
+
+```
+localhost:3000/apic
+```
 
-Filter routes on a regex match
 
 
+## Configuration
+
+### Controller Parameters
+
+APIc needs to know about the parameters your PUT, PATCH and UPDATE requests require.
+To make this as simple and painless as possible, APIc exposes a DSL to your controllers so you can specify what you need.
+APIc knows what type of routes are available and will automatically add in the _method parameter and value for PATCH and DELETE requests.
+
 ```
-Apic.routes_matcher = /\/api\//
+class TestController << ActionController.base
+
+  apic_action_params create: [:name, :acceptance]
+
+  def create
+    # all your cool stuff that creates a new object
+  end
+
+end
+```
+
+### Initializer
+
+The apic:install generator will add in a default intializer providing examples of the route matching and authentication filtering.
+
 ```
+config/initializers/apic.rb
+```
+
+#### Route Matching
+
+APIc will load all routes in your rails app by default under the assumption that you are building your api as a dedicated service.
+If this is not the case, you can specify a matching regular expression that APIc will use to find your API routes.
 
-Tell us what your authorization filter is!
+For example, if you have namespecs all of your api endpoints to /api/v1/ simply uncomment out the Apic.routes_matcher line in config/initializers/apic.rb
 
 ```
-Apic.authorization_filter = :authenticate
+Apic.route_matcher = /\/api\/v1\//
 ```
 
+#### Authentication filters
 
-git remote add origin https://github.com/randym/apic.git
+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.
+If you specify in your configuration the before_filter you are using for authentication APIc will mark those routes as restricted.
 
+```
+Apic.authentication_filter = :authenticate
+```
 
 This project rocks and uses MIT-LICENSE.

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

@@ -2,4 +2,5 @@ $(document).ready ->
   $('.http-headers').httpHeaders()
   $('.endpoints-component').endpoints()
   $('.console').apic_console(host: $('.console').data('host'))
+  $('.xhr-history').xhr_history()
   true

data/app/assets/javascripts/apic/components/{console.js.coffee → apic_console.js.coffee}

@@ -9,6 +9,7 @@ $.fn.extend
       params: '.parameter',
       console: '.console',
       console_log: '.console-log',
+      history: '.xhr-history',
       host: 'localhost:3000',
       request_timeout: 10000,
       timeout_callback: null,
@@ -16,6 +17,8 @@ $.fn.extend
 
     self = this
 
+    history = []
+
     settings = $.extend settings, options
 
     log_timeline = (method, uri) ->
@@ -25,13 +28,14 @@ $.fn.extend
 
     log_request = (xhr)  ->
       self._start = new Date().getTime()
-      console.log xhr
-      log_message "Request URL", uri()
-      log_message "Request Method", endpoint().verb
-      log_message "Response Code", [xhr.status, xhr.statusText].join(' ')
-      log_message "Request Headers", xhr.getAllResponseHeaders()
 
-    log_message = (title, message) ->
+      $(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 = ->
@@ -57,7 +61,6 @@ $.fn.extend
         path += query_string()
       path
 
-    $('#do-me').on('click', -> send.apply self)
 
     value_for = (name) ->
       $(settings.params + ' [name="' + name + '"]').val()
@@ -89,14 +92,19 @@ $.fn.extend
         $(settings.console).text(xhr.responseText)
 
       log_request xhr
+      record(xhr)
 
     onerror = (response) ->
       console.log response
 
-    request = () ->
+    request = (endpoint, headers, uri) ->
       xhr = new XMLHttpRequest
-      xhr.open endpoint().verb, uri()
-      set_headers xhr
+      xhr.open endpoint.verb, uri, true
+      $.each headers, (key, value) ->
+        if key is 'Authorization'
+          xhr.withCredentials = true
+        xhr.setRequestHeader(key, value)
+
       xhr.onerror = (xhr) ->
         onerror.apply self, [xhr]
       xhr.onload = (response) ->
@@ -105,6 +113,8 @@ $.fn.extend
 
     set_headers = (xhr) ->
       $.each headers(), (key, value) ->
+        if key is 'Authorization'
+          xhr.withCredentials = true
         xhr.setRequestHeader(key, value)
 
     validate_params = () ->
@@ -112,14 +122,34 @@ $.fn.extend
       for part in endpoint().parts
         if value_for(part) is ""
           missing.push(part)
-        if missing.length > 0
-          alert('url parts reqired: ' + missing)
+      if missing.length > 0
+        alert('url parts reqired: ' + missing)
       missing.length is 0
 
-    send = () ->
+    record = (xhr) ->
+      history_item =
+        endpoint: endpoint()
+        headers: headers()
+        body: body()
+        uri: uri()
+        xhr: xhr
+
+      $(settings.history).trigger('add', [history_item])
+
+    send = (_point, _head, _bod, _u) ->
+      _point ||= endpoint()
+      _head ||= headers()
+      _bod ||= body()
+      _u ||= uri()
+
       if validate_params()
-        xhr = request()
-        if endpoint().verb is 'GET'
+        xhr = request(_point, _head, _u)
+        if _point.verb is 'GET'
           xhr.send()
         else
-          xhr.send JSON.stringify(body)
+          data = JSON.stringify(_bod)
+          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])
+    true

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

@@ -13,7 +13,6 @@ $.fn.extend
 
     $.each endpoints, (key, value) ->
       option = $('<option>'+ key + '</option>')
-      console.log value
       option.text('[restricted] ' + option.text()) if value.authorization_required
       $(settings.select).append(option)
 
@@ -32,7 +31,7 @@ $.fn.extend
           el.find('#input-_method').val(endpoint.verb.toLowerCase())
 
     selected = ->
-      endpoints[$(settings.select).val()]
+      endpoints[$(settings.select).val().replace('[restricted] ', '')]
 
     field_set_for = (name, options={}) ->
       clone = $(self).find(settings.template).clone()

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

@@ -1,7 +1,7 @@
 $.fn.extend
   httpHeaders: (options) ->
     settings =
-      presets: {}
+      presets: {'Content-Type': 'application/json'}
 
     $.each $(this).data(), (key, value) ->
       settings[key] = value

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

@@ -0,0 +1,48 @@
+
+$.fn.extend
+
+  xhr_history: (options) ->
+    defaults = {}
+    self = this
+    $(self).data('items', [])
+
+    refresh = ->
+      $(self).empty()
+      $.each items(), (index, item) ->
+        el = list_item(item)
+        el.data('request', item)
+
+        $(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>')
+
+    items = ->
+      $(self).data('items')
+
+    add = (item)->
+      i = items()
+      i.push item
+      $(self).data('items',i)
+      refresh()
+
+    replay = (el) ->
+      request = $(el).data('request')
+      $('.console').trigger('send', [request.endpoint, request.headers, request.body, request.uri])
+      console.log($(el).data('request'))
+
+    show = ->
+      el = $('.history')
+      el.toggle()
+
+      li = $(event.target).closest('li')
+      if $(el).is(':visible')
+        li.addClass('active')
+      else
+        li.removeClass('active')
+
+    #$(self).on('refresh', -> refresh.apply self)
+    $(self).on('add', (e, item) -> add.apply self, [item])
+    $('.xhr-history').on('dblclick', 'li', (e) -> replay this)
+    $('.toggle-history').on('click', -> show.apply self)
+    this

data/app/assets/stylesheets/apic/components/http-headers.css.scss

@@ -10,9 +10,6 @@
   margin-left: 10px;
   min-height: 130px;
   overflow-y: scroll;
-  h4 {
-    text-align: center;
-  }
   .http-headers {
     ul {
       border: 1px solid #eee;

data/app/assets/stylesheets/apic/components/xhr-history.css.scss

@@ -0,0 +1,16 @@
+.history {
+  display: none;
+  border-top: 1px solid #DDD;
+  padding: 5px;
+}
+.xhr-history {
+  list-style-type: none;
+  i.forbidden {
+    background-color: red;
+    margin-right: 5px;
+  }
+  i.ok {
+    background-color: green;
+    margin-right: 5px;
+  }
+}

data/app/controllers/apic/application_controller.rb

@@ -1,4 +1,12 @@
 module Apic
   class ApplicationController < ActionController::Base
+    def index
+      Rails.logger.debug endpoints
+      endpoints
+    end
+
+    def endpoints
+      @endpoints ||= Apic.endpoints
+    end
   end
 end

data/app/views/apic/application/_navigation.html.slim

@@ -7,3 +7,5 @@ div.navbar.navbar-inverse.navbar-fixed-top
           a(href="#headers") Headers
         li.edit-endpoints.active
           a(href="#endpoints") Endpoints
+        li.toggle-history
+          a(href='#history') History

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

@@ -5,7 +5,7 @@ div.endpoints-component( data-endpoints="#{@endpoints.to_json}")
       div.control-group
         label.control-label(for="selectEndpoint") Api Endpoint
         div.controls
-          select(id='selectEndpoint')
+          select.input-xxlarge(id='selectEndpoint')
 
       div.control-group.template
         label.control-label(for="inputParam") Param Name

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

@@ -0,0 +1,2 @@
+h4 History
+ul.xhr-history

data/app/views/apic/application/index.html.slim

@@ -8,3 +8,5 @@ div.container
       button#do-me.btn.btn-primary(href='#') Send
   div.row
     == render :partial => "apic/application/components/console"
+  div.row.history
+    == render :partial => "apic/application/components/xhr_history"

data/config/routes.rb

@@ -1,3 +1,12 @@
-Apic::Engine.routes.draw do
-  root "#index"
+if Rails.version < '4.0.0'
+
+  Apic::Engine.routes.draw do
+    match "/" => "application#index"
+  end
+else
+
+
+  Apic::Engine.routes.draw do
+    get "/" => "application#index"
+  end
 end

data/lib/apic/engine.rb

@@ -1,6 +1,7 @@
 module Apic
   class Engine < ::Rails::Engine
     isolate_namespace Apic
+    require 'slim'
     require 'jquery-rails'
     require 'bootstrap-sass'
     ActiveSupport.on_load(:action_controller) do

data/lib/apic/generators/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+module Apic
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../generators/templates", __FILE__)
+
+      desc "creates initializer and add engine mount point to your routes"
+
+      def copy_initializer
+        template 'apic.rb', 'config/initializers/apic.rb'
+      end
+
+      def mount_engine
+        if Rails.version < '4.0.0'
+          route 'mount Apic::Engine, :at => "/apic"'
+        else
+          route 'mount Apic::Engine => "/apic"'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# 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\//
+#
+#
+# Specify your authentication filter. Requests that use this filter will be marked
+# as restricted in the Api endpoints list.
+#
+# Apic.authentication_filter = :authenticate

data/lib/apic/version.rb

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

data/lib/apic.rb

@@ -1,11 +1,11 @@
 require 'apic/params_cache'
 require "apic/extension"
 require "apic/engine"
-
+require "apic/generators/install_generator"
 module Apic
 
-  mattr_accessor :authorization_filter
-  @@authorization_filter = nil
+  mattr_accessor :authentication_filter
+  @@authentication_filter = nil
 
   mattr_accessor :route_matcher
   @@route_matcher = /\/api\//
@@ -35,12 +35,11 @@ module Apic
   end
 
   def self.requires_authorization(controller, action_name)
-    return false unless @@authorization_filter
+    return false unless @@authentication_filter
     controller = (controller + '_controller').camelize.constantize
     controller._process_action_callbacks.any? do |callback|
-      p @@authorization_filter
       eval <<-RUBY_EVAL
-      #{callback.filter == @@authorization_filter} && #{callback.instance_values['compiled_options']}
+      #{callback.filter == @@authentication_filter} && #{callback.instance_values['compiled_options']}
       RUBY_EVAL
     end
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: apic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Randy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 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: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: slim-rails
   requirement: !ruby/object:Gem::Requirement
@@ -104,25 +104,29 @@ extra_rdoc_files: []
 files:
 - app/assets/javascripts/apic/apic.js.coffee
 - app/assets/javascripts/apic/application.js
-- app/assets/javascripts/apic/components/console.js.coffee
+- app/assets/javascripts/apic/components/apic_console.js.coffee
 - app/assets/javascripts/apic/components/endpoints.js.coffee
 - app/assets/javascripts/apic/components/http-headers.js.coffee
+- app/assets/javascripts/apic/components/xhr_history.js.coffee
 - app/assets/stylesheets/apic/application.css.scss
 - app/assets/stylesheets/apic/components/console.css.scss
 - app/assets/stylesheets/apic/components/endpoints.css.scss
 - app/assets/stylesheets/apic/components/http-headers.css.scss
+- app/assets/stylesheets/apic/components/xhr-history.css.scss
 - app/controllers/apic/application_controller.rb
-- app/controllers/apic/controller.rb
 - app/helpers/apic/application_helper.rb
 - app/views/apic/application/_navigation.html.slim
 - app/views/apic/application/components/_console.html.slim
 - app/views/apic/application/components/_endpoints.html.slim
 - app/views/apic/application/components/_http_headers.html.slim
+- app/views/apic/application/components/_xhr_history.html.slim
 - app/views/apic/application/index.html.slim
 - app/views/layouts/apic/application.html.erb
 - config/routes.rb
 - lib/apic/engine.rb
 - lib/apic/extension.rb
+- lib/apic/generators/install_generator.rb
+- lib/apic/generators/templates/apic.rb
 - lib/apic/params_cache.rb
 - lib/apic/version.rb
 - lib/apic.rb

data/app/controllers/apic/controller.rb

@@ -1,13 +0,0 @@
-module Apic
-  class Controller < ApplicationController
-
-
-    def index
-      endpoints
-    end
-
-    def endpoints
-      @endpoints ||= Apic.endpoints
-    end
-  end
-end