rails_api_explorer 0.0.1.pre.1 → 0.0.2.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072d32c87b27d505bb62ce22a1d491668db4e48d
-  data.tar.gz: ae39b35ef35b5ddf691b3a3dfcd3fcfa8e5f1841
+  metadata.gz: 92e109fe3ecbff439ba1527c91138e8aea97cae1
+  data.tar.gz: 6ae0e546fab6cb707335daaefe25c6b496658eaa
 SHA512:
-  metadata.gz: f447e761837f2647ab0bd4dc022d6f044185ffed149547581c5e14973878cf56c2637943cf75fddda2375034fd97e2dd298995be235ea2b77235661d94bfc079
-  data.tar.gz: 976d4f7a37d9fe5d215a0ed0896cae9f6e58f038015dda0f7b22e7be61da777b36aeca76903b07aa6a9cc0058a9b4abe9716dab7ba0a8fc7acdd6271d07094a6
+  metadata.gz: 5941e240df85be5594187045bed33bda332cda60ca1d5115a118eaa09b1ff2724a74be737c22c544fa93b67ab3902abc7c0aee04783c4490cd5e0b2bc31bcde5
+  data.tar.gz: 6a201c1994bd8100f41e6f700e669003c2b2ceae847ccd4c1974f719292f56e8c08179571cb44d26b104900f2a5aea17a831bfc8040297d391c78f1edd11649b

data/README.md

@@ -0,0 +1,96 @@
+# rails_api_explorer
+
+Provides a simple DSL to describe your 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:
+
+```ruby
+gem 'rails_api_explorer'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Describe your API in `config/initializers/api_explorer.rb`:
+
+```ruby
+ApiExplorer.describe do
+  base_url 'http://localhost:3000/api/'
+
+  shared do
+    header 'X-AUTH-TOKEN', source: { request: "POST:users/sign_in", accessor: "['auth_token']"}
+    # The source option makes the value get set automatically when a request to the given url succeeds.
+    # The accessor is evaluated on the JSON object returned by the server.
+  end
+
+  post 'users/sign_in' do
+    desc "Authenticate a user, returns the auth token. Anything except blank values will work for this example."
+
+    exclude_shared_header 'X-AUTH-TOKEN'
+
+    struct 'user_login' do
+      string 'email'
+      string 'password'
+    end
+  end
+
+  group "Posts" do
+    get 'posts'
+
+    get 'posts/:id' do
+      desc "Returns details for a single post."
+    end
+
+    post 'posts' do
+      desc "Create a post."
+      struct 'post' do
+        string 'title', desc: "Required."
+        string 'body'
+      end
+    end
+
+    patch 'posts/:id' do
+      struct 'post' do
+        string 'title', desc: "Required."
+        string 'body'
+      end
+    end
+  end
+end
+```
+
+Then mount it in your `routes.rb`:
+
+```ruby
+mount ApiExplorer::Engine => '/api/explore', as: 'api_explorer'
+```
+
+
+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
+ApiExplorer.auth = lambda do
+  authenticate_user!
+  current_user.admin? or redirect_to main_app.root_path
+end
+```
+
+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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

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

@@ -12,4 +12,5 @@
 //
 //= require jquery
 //= require jquery_ujs
+//= require api_explorer/serialize_object
 //= require_tree .

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

@@ -1,146 +1,89 @@
-$(function() {
-    $(".hidden").hide().removeClass("hidden");
+// Generated by CoffeeScript 1.4.0
+(function() {
 
+  $(function() {
+    var setValuesFromRequest, updateShareds;
+    $(".hidden").hide().removeClass("hidden");
     window.responses = {};
-
     $(".shared-input.header").change(function() {
-        updateShareds();
-    });
-    $(".shared-link").click(function() {
-        $($(this).attr("href")).find("input").focus();
+      return updateShareds();
     });
-
-    function updateShareds() {
-        $(".shared-input.header").each(function() {
-            name = $(this).attr("data-name");
-            $(".shared.header[data-name=" + name + "]").val($(this).val());
+    updateShareds = function() {
+      return $(".shared-input.header").each(function() {
+        var name;
+        name = $(this).attr("data-name");
+        return $(".shared.header[data-name=" + name + "]").val($(this).val());
+      });
+    };
+    setValuesFromRequest = function(request) {
+      $("[data-source-request='" + request + "']").each(function(input) {
+        var v;
+        v = eval("responses['" + request + "']" + $(this).attr("data-source-accessor"));
+        return $(this).val(v);
+      });
+      return updateShareds();
+    };
+    $(".param input").prop("disabled", false);
+    $(".send-toggle").click(function(event) {
+      var param, send, setState;
+      event.preventDefault();
+      setState = function(elements, state) {
+        return elements.each(function(i, el) {
+          $(el).attr("data-send", state ? "true" : "false");
+          $(el).find("input").first().prop("disabled", !state);
+          $(el).find(".send-toggle").first().text(state ? "don't send" : "send");
+          return $(el).find(".name").first().toggleClass("strikethrough", !state);
         });
-    }
-
-    function setValuesFromRequest(request) {
-        $("[data-source-request='" + request + "']").each(function(input) {
-            v = eval("responses['" + request + "']" + $(this).attr("data-source-accessor"));
-            $(this).val(v);
+      };
+      param = $(this).closest(".param");
+      send = param.attr("data-send") !== "true";
+      setState(param.add(param.find(".param")), send);
+      if (send) {
+        return setState(param.parents(".param"), true);
+      }
+    });
+    return $("form").submit(function(event) {
+      var form, path, req;
+      event.preventDefault();
+      form = $(this);
+      req = form.serializeObject().request;
+      form.closest(".request").find(".status").html("Requesting...");
+      path = req.path;
+      if (req.url_params) {
+        $.each(req.url_params, function(p, v) {
+          return path = path.replace(":" + p, v);
         });
-        updateShareds();
-    }
-
-    // Enable / disable params
-    $(".param input").prop("disabled", false); // Firefox autocomplete workaround
-    $(".send-toggle").click(function(event) {
-        event.preventDefault();
-
-        var setState = function(elements, state) {
-            elements.each(function(i, el) {
-                $(el).attr("data-send", state ? "true" : "false");
-                $(el).find("input").first().prop("disabled", !state);
-                $(el).find(".send-toggle").first().text(state ? "don't send" : "send");
-                $(el).find(".name").first().toggleClass("strikethrough", !state);
-            });
+      }
+      return $.ajax({
+        url: path,
+        type: req.method,
+        headers: req.headers,
+        data: req.params,
+        dataType: 'json'
+      }).always(function(data, status, error) {
+        var code, key;
+        if (status === 'success') {
+          code = 200;
+          key = req.method.toUpperCase() + ":" + req.path.replace(api_explorer_base_url, "");
+          window.responses[key] = data;
+          setValuesFromRequest(key);
+        } else {
+          code = data.status;
+          try {
+            data = $.parseJSON(data.responseText);
+          } catch (SyntaxError) {
+
+          }
         }
-
-        var param = $(this).closest(".param");
-        var send = param.attr("data-send") == "true" ? false : true;
-        setState(param.add(param.find(".param")), send); // enable or disable children
-        if (send)
-            setState(param.parents(".param"), true); // enable parents
-    });
-
-    $("form").submit(function(event) {
-        event.preventDefault();
-
-        var form = $(this);
-        var req = form.serializeObject().request;
-        form.closest(".request").find(".status").html("Requesting...");
-
-        path = req.path;
-        if (req.url_params) {
-            $.each(req.url_params, function(p, v) {
-                path = path.replace(":" + p, v);
-            });
+        if (code === 0) {
+          form.closest(".request").find(".status").text("Can't reach server");
+          return form.closest(".request").find(".response").hide();
+        } else {
+          form.closest(".request").find(".status").text(code);
+          return form.closest(".request").find(".response").text(JSON.stringify(data, null, 4)).show();
         }
-
-        $.ajax({
-            url: path,
-            type: req.method,
-            headers: req.headers,
-            data: req.params,
-            dataType: 'json'
-        }).always(function(data, status, error) {
-            if(status == 'success') {
-                code = 200;
-                var key = req.method.toUpperCase() + ":" + req.path.replace(api_explorer_base_url, "");
-                window.responses[key] = data;
-                setValuesFromRequest(key);
-            } else {
-                code = data.status;
-                try {
-                    data = $.parseJSON(data.responseText);
-                } catch(SyntaxError) {}
-            }
-            if (code == 0) {
-                form.closest(".request").find(".status").text("Can't reach server");
-                form.closest(".request").find(".response").hide();
-            } else {
-                form.closest(".request").find(".status").text(code);
-                form.closest(".request").find(".response").text(JSON.stringify(data, null, 4)).show();
-            }
-        });
+      });
     });
+  });
 
-
-    $.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;
-
-            while((k = keys.pop()) !== undefined){
-
-                // 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);
-                }
-            }
-            json = $.extend(true, json, merge);
-        });
-        return json;
-    };
-});
+}).call(this);

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

@@ -6,6 +6,7 @@ $(function() {
    */
   function scroll_if_anchor(href) {
       href = typeof(href) == "string" ? href : $(this).attr("href");
+      if (typeof(href) == 'undefined') return
 
       var fromTop = 0;
 

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

@@ -0,0 +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_\-]+$/
+        };
+
+        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){
+
+                // 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);
+                }
+            }
+            json = $.extend(true, json, merge);
+        });
+        return json;
+    };

data/app/assets/stylesheets/api_explorer/explorer.css

@@ -1,70 +1,44 @@
-.hidden {
-    display: none;
-}
-
-.params .params {
-    margin-left: 30px;
-}
-
-.param-inputs .param-inputs {
-    margin-left: 30px;
-}
-
-.param-inputs fieldset {
-    border: none;
-    padding: 0;
-}
-.param-inputs input {
-    border: none;
-}
-h3 input {
-    border: none;
-    width: 120px;
-    text-align: center;
-}
-
-legend {
-    margin-bottom: 5px;
-}
-.param-inputs legend {
-    font-size: 100%;
-    border: none;
-    margin-bottom: 0;
-}
-label {
-    font-weight: normal;
-    margin-bottom: 0;
-}
-
-.response {
+.api-explorer .hidden {
+  display: none; }
+.api-explorer .params .params {
+  margin-left: 30px; }
+.api-explorer .param-inputs .param-inputs {
+  margin-left: 30px; }
+.api-explorer .param-inputs fieldset {
+  border: none;
+  padding: 0; }
+.api-explorer .param-inputs input {
+  border: none; }
+.api-explorer h3 input {
+  border: none;
+  width: 120px;
+  text-align: center; }
+.api-explorer legend {
+  margin-bottom: 5px; }
+.api-explorer .param-inputs legend {
+  font-size: 100%;
+  border: none;
+  margin-bottom: 0; }
+.api-explorer label {
+  font-weight: normal;
+  margin-bottom: 0; }
+.api-explorer .response {
   border: solid 1px black;
   background-color: #CCC;
   padding: 20px;
   max-height: 400px;
-  overflow: scroll;
-}
-
-.description {
-    font-size: 80%;
-}
-
-fieldset {
-    margin-bottom: 5px;
-}
-
-legend, label {
-    position: relative;
-}
-
-.send-toggle {
-    font-size: 80%;
-    cursor: pointer;
-    display: none;
-}
-:hover > .send-toggle {
-    display: inline;
-}
-
-.strikethrough {
-    text-decoration: line-through;
-}
+  overflow: scroll; }
+.api-explorer .description {
+  font-size: 80%; }
+.api-explorer fieldset {
+  margin-bottom: 5px; }
+.api-explorer legend, .api-explorer label {
+  position: relative; }
+.api-explorer .send-toggle {
+  font-size: 80%;
+  cursor: pointer;
+  display: none; }
+.api-explorer :hover > .send-toggle {
+  display: inline; }
+.api-explorer .strikethrough {
+  text-decoration: line-through; }

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

@@ -1,20 +1,22 @@
-<script type="text/javascript">
-  window.api_explorer_base_url = "<%= @description.base_url %>";
-</script>
+<div class="api-explorer">
+  <script type="text/javascript">
+    window.api_explorer_base_url = "<%= @description.base_url %>";
+  </script>
 
-<%= stylesheet_link_tag    "api_explorer/application", media: "all" %>
-<%= javascript_include_tag "api_explorer/application" %>
+  <%= 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>
-    <ul class="contents">
-      <% @description.children.each_with_index do |ch, i| %>
-        <%= render 'content_node', node: ch, id: i %>
-      <% end %>
-    </ul>
+  <div class="row">
+    <div class="col-sm-12">
+      <h1>Index</h1>
+      <ul class="contents">
+        <% @description.children.each_with_index do |ch, i| %>
+          <%= render 'content_node', node: ch, id: i %>
+        <% end %>
+      </ul>
+    </div>
   </div>
-</div>
 
-<%= render 'shared' %>
-<%= render 'node', node: @description, id: "", depth: 0 %>
+  <%= render 'shared' %>
+  <%= render 'node', node: @description, id: "", depth: 0 %>
+</div>

data/lib/api_explorer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_explorer
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.1
+  version: 0.0.2.pre.1
 platform: ruby
 authors:
 - Max Hollmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - maxhollmann@gmail.com
@@ -60,10 +88,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/api_explorer/application.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/explorer.css
 - app/controllers/api_explorer/application_controller.rb
@@ -121,6 +151,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Provides a simple DSL to describe your API, and let's you mount an interactive
+summary: Provides a simple DSL to describe your JSON API, and let's you mount an interactive
   sandbox to explore and test it.
 test_files: []