rails_api_explorer 0.0.2.pre.1 → 0.0.3.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92e109fe3ecbff439ba1527c91138e8aea97cae1
-  data.tar.gz: 6ae0e546fab6cb707335daaefe25c6b496658eaa
+  metadata.gz: dacad37d291f229361c45ca9d3e110c4b17f0012
+  data.tar.gz: ff5df9502368e73e237550cb4f1cbc80e51d510b
 SHA512:
-  metadata.gz: 5941e240df85be5594187045bed33bda332cda60ca1d5115a118eaa09b1ff2724a74be737c22c544fa93b67ab3902abc7c0aee04783c4490cd5e0b2bc31bcde5
-  data.tar.gz: 6a201c1994bd8100f41e6f700e669003c2b2ceae847ccd4c1974f719292f56e8c08179571cb44d26b104900f2a5aea17a831bfc8040297d391c78f1edd11649b
+  metadata.gz: b6a90cf0709ce9c7e1d08fb79277116d4d0a7b1ebb9582d5699217728595363e991b6601ec1e11c775699974e7e24c0282e8d9f23b7e34441e5d2f2993133ee1
+  data.tar.gz: 6013f6dfb5d59b644c9b3218006f81018186dfe57854af33c0aea2fae1c840d51573eec186f6199e07c7ace2eafc5acb61b7380ea0ab58c969735ac19a9b69b6

data/README.md

@@ -1,11 +1,9 @@
 # rails_api_explorer
 
-Provides a simple DSL to describe your API, and let's you mount an interactive sandbox to explore and test it.
+Provides a simple DSL to describe your JSON API, and let's you mount an interactive sandbox to explore and test it.
 
 [Here's a demo.](http://rails-api-explorer.herokuapp.com)
 
-This project is in the early stages of development and missing some features. Pull requests are more than welcome!
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,8 +16,21 @@ And then execute:
 
     $ bundle
 
+
 ## Usage
 
+### Assets
+Include the JavaScript in your `application.js`, make sure to require it *after* jQuery:
+
+    //= require jquery
+    //= require api_explorer
+
+Include the CSS in `application.css`:
+
+    *= require api_explorer
+
+
+### Describe your API
 Describe your API in `config/initializers/api_explorer.rb`:
 
 ```ruby
@@ -74,7 +85,7 @@ Then mount it in your `routes.rb`:
 mount ApiExplorer::Engine => '/api/explore', as: 'api_explorer'
 ```
 
-
+### Access control
 If you don't want the public to access the explorer, you can provide a lambda that will be executed in the `before_filter` of the controller:
 
 ```ruby
@@ -84,6 +95,7 @@ ApiExplorer.auth = lambda do
 end
 ```
 
+## Notes
 The explorer is rendered within your application layout and uses bootstrap 3 classes, so it's prettier if you have that included.
 Bootstrap is optional, but it requires jQuery.
 

data/Rakefile

@@ -14,10 +14,8 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 
 
 Bundler::GemHelper.install_tasks
-

data/app/assets/javascripts/api_explorer/serialize_object.js

@@ -1,54 +1,54 @@
-    $.fn.serializeObject = function() {
-        var self = this,
-        json = {},
-        push_counters = {},
-        patterns = {
-            "validate": /^[a-zA-Z][a-zA-Z0-9_\-]*(?:\[(?:\d*|[a-zA-Z0-9_\-]+)\])*$/,
-            "key":      /[a-zA-Z0-9_\-]+|(?=\[\])/g,
-            "push":     /^$/,
-            "fixed":    /^\d+$/,
-            "named":    /^[a-zA-Z0-9_\-]+$/
-        };
+$.fn.serializeObject = function() {
+    var self = this,
+    json = {},
+    push_counters = {},
+    patterns = {
+        "validate": /^[a-zA-Z][a-zA-Z0-9_\-]*(?:\[(?:\d*|[a-zA-Z0-9_\-]+)\])*$/,
+        "key":      /[a-zA-Z0-9_\-]+|(?=\[\])/g,
+        "push":     /^$/,
+        "fixed":    /^\d+$/,
+        "named":    /^[a-zA-Z0-9_\-]+$/
+    };
 
-        this.build = function(base, key, value){
-            base[key] = value;
-            return base;
-        };
-        this.push_counter = function(key){
-            if(push_counters[key] === undefined){
-                push_counters[key] = 0;
-            }
-            return push_counters[key]++;
-        };
-        $.each($(this).serializeArray(), function(){
-            // skip invalid keys
-            if(!patterns.validate.test(this.name)) {
-                return;
-            }
-            var k,
-            keys = this.name.match(patterns.key),
-            merge = this.value,
-            reverse_key = this.name;
+    this.build = function(base, key, value){
+        base[key] = value;
+        return base;
+    };
+    this.push_counter = function(key){
+        if(push_counters[key] === undefined){
+            push_counters[key] = 0;
+        }
+        return push_counters[key]++;
+    };
+    $.each($(this).serializeArray(), function(){
+        // skip invalid keys
+        if(!patterns.validate.test(this.name)) {
+            return;
+        }
+        var k,
+        keys = this.name.match(patterns.key),
+        merge = this.value,
+        reverse_key = this.name;
 
-            while((k = keys.pop()) !== undefined){
+        while((k = keys.pop()) !== undefined){
 
-                // adjust reverse_key
-                reverse_key = reverse_key.replace(new RegExp("\\[" + k + "\\]$"), '');
+            // adjust reverse_key
+            reverse_key = reverse_key.replace(new RegExp("\\[" + k + "\\]$"), '');
 
-                // push
-                if(k.match(patterns.push)){
-                    merge = self.build([], self.push_counter(reverse_key), merge);
-                }
-                // fixed
-                else if(k.match(patterns.fixed)){
-                    merge = self.build([], k, merge);
-                }
-                // named
-                else if(k.match(patterns.named)){
-                    merge = self.build({}, k, merge);
-                }
+            // push
+            if(k.match(patterns.push)){
+                merge = self.build([], self.push_counter(reverse_key), merge);
             }
-            json = $.extend(true, json, merge);
-        });
-        return json;
-    };
+            // fixed
+            else if(k.match(patterns.fixed)){
+                merge = self.build([], k, merge);
+            }
+            // named
+            else if(k.match(patterns.named)){
+                merge = self.build({}, k, merge);
+            }
+        }
+        json = $.extend(true, json, merge);
+    });
+    return json;
+};

data/app/assets/javascripts/{api_explorer/application.js → api_explorer.js}

@@ -10,7 +10,5 @@
 // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-//= require jquery
-//= require jquery_ujs
 //= require api_explorer/serialize_object
-//= require_tree .
+//= require api_explorer/explorer

data/app/views/api_explorer/explorer/_request.html.erb

@@ -1,5 +1,5 @@
 <div class="row request" id="node<%= id %>">
-  <%= form_for :request, url: request_path, html: { class: "col-sm-6" } do |f| %>
+  <%= form_for :request, html: { class: "col-sm-6" } do |f| %>
     <%= f.hidden_field :method, value: req.method %>
     <%= f.hidden_field :path, value: req.full_path %>
 
@@ -9,7 +9,6 @@
         <% req.url_segments.each do |type, s| %>
           <% if type == :param %>
             <%= pf.text_field s, placeholder: ":#{s}" %>
-            <!-- span contenteditable="true" data-ph="<%= ":#{s}" %>" data-name="<%= s %>"></span -->
           <% else %>
             <%= raw s %>
           <% end %>
@@ -20,7 +19,6 @@
     <div>
       <p><%= simple_format req.description %></p>
 
-      <!-- %= render 'api_explorer/explorer/form/url_params', params: req.url_params, f: f % -->
       <%= render 'api_explorer/explorer/form/headers', request: req, f: f %>
       <% if req.params.any? %>
         <fieldset>

data/app/views/api_explorer/explorer/form/_headers.html.erb

@@ -6,8 +6,6 @@
   <% @description.headers.each do |h| %>
     <% next if request.excluded_shared_headers.include?(h.name) %>
 
-    <!--%= hf.label h.name, h.name %-->
-    <!--%= raw " (<a class='shared-link' href='#shared-header-#{h.name}'>shared</a>)" %-->
     <%= hf.hidden_field h.name, class: "shared header", data: { name: h.name } %>
   <% end %>
 <% end %>

data/app/views/api_explorer/explorer/index.html.erb

@@ -3,9 +3,6 @@
     window.api_explorer_base_url = "<%= @description.base_url %>";
   </script>
 
-  <%= stylesheet_link_tag    "api_explorer/application", media: "all" %>
-  <%= javascript_include_tag "api_explorer/application" %>
-
   <div class="row">
     <div class="col-sm-12">
       <h1>Index</h1>

data/config/routes.rb

@@ -1,4 +1,3 @@
 ApiExplorer::Engine.routes.draw do
   root to: 'explorer#index'
-  post 'request' => 'explorer#perform_request'
 end

data/lib/api_explorer/engine.rb

@@ -1,5 +1,9 @@
 module ApiExplorer
   class Engine < ::Rails::Engine
     isolate_namespace ApiExplorer
+
+    initializer "rails_api_explorer.assets.precompile" do |app|
+      app.config.assets.precompile += %w(api_explorer.css api_explorer.js)
+    end
   end
 end

data/lib/api_explorer/version.rb

@@ -1,3 +1,3 @@
 module ApiExplorer
-  VERSION = "0.0.2.pre.1"
+  VERSION = "0.0.3.pre.1"
 end

data/lib/api_explorer.rb

@@ -8,12 +8,11 @@ require "api_explorer/request"
 require "api_explorer/dsl"
 
 module ApiExplorer
-  mattr_accessor :description, :shared_headers, :shared_params, :auth
+  mattr_accessor :description, :auth
 
   def self.describe(&block)
     self.description = Description.new("", "", [], [], [])
     proxy = DescriptionProxy.new(description)
     proxy.collect(&block)
-    #self.description = Description.new(proxy.path, proxy.children, proxy.shared_headers, proxy.shared_params)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_explorer
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre.1
+  version: 0.0.3.pre.1
 platform: ruby
 authors:
 - Max Hollmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -90,11 +76,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/api_explorer/application.js
+- app/assets/javascripts/api_explorer.js
 - app/assets/javascripts/api_explorer/explorer.js
 - app/assets/javascripts/api_explorer/scroll.js
 - app/assets/javascripts/api_explorer/serialize_object.js
-- app/assets/stylesheets/api_explorer/application.css
+- app/assets/stylesheets/api_explorer.css
 - app/assets/stylesheets/api_explorer/explorer.css
 - app/controllers/api_explorer/application_controller.rb
 - app/controllers/api_explorer/explorer_controller.rb