sabisu_rails 0.0.1.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 284b0d527cd0903c0553fdbb85a121935c342e83
+  data.tar.gz: db4e336d9dfeee82b8f322b67d2730f19290db15
+SHA512:
+  metadata.gz: 54ba3eaf47892f081eed2a42fb0ea1d6d7d7cdd8a6a9ec16a89c45ce5ecc737f0206c3c86ce292565c404a4257a077aa26bc691cdf62cdfd386ba0f1c8d63f7f
+  data.tar.gz: bfa4740da7113d819377b2313bc03714d41b2e90ca22e43e5cb357972b37ec41caf7df7c29b93ba89c032065b3136653355fea0765aa5a59d88c550e710e8e1d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sabisu.gemspec
+gemspec
+
+gem 'railties', github: 'rails/rails'
+gem 'activemodel', github: 'rails/rails'
+gem 'actionpack', github: 'rails/rails'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Abraham Kuri
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# [Sabisu](https://github.com/IcaliaLabs/sabisu)
+
+Sabisu is a powerful postman-like engine client to explore your Rails application api. It's still under heavy development, but it is quite impressive and beautiful. Give it a try!
+
+It was created by [Abraham Kuri](https://twitter.com/kurenn) from [Icalia Labs](http://twitter.com/icalialabs).
+
+To get started, checkout:
+
+#### [http://icalialabs.github.io/sabisu-rails/](http://icalialabs.github.io/sabisu-rails/)
+
+## Table of contents
+
+- [Installation](#installation)
+- [Customization](#customization)
+- [Bug tracker & feature request](#bug-tracker-&-feature-request)
+- [Contributing](#contributing)
+- [Community](#community)
+- [Heroes](#heroes)
+- [License](#license)
+
+## Quick start
+
+Install sabisu is extremely easy, just add some gems to your `Gemfile`
+
+```ruby
+gem 'sabisu-rails'
+gem 'compass-rails'
+gem 'furatto'
+gem 'font-awesome-rails'
+```
+And then execute:
+
+```console
+$ bundle install
+```
+
+After you install Sabisu you need to run the generator:
+
+```console
+rails g sabisu_rails:install
+```
+
+The generator will install in initializer which describes all the Sabisu configuration options.
+
+Some of these configuration options include you api endpoint base uri, so as your resources, so you better take a look at it.
+
+Once you are done with the configuration, start your rails application and navigate to `http://localhost:3000/sabisu_rails/explorer`
+
+If everything went good you should see a nice explorer interface with your resources.
+
+## Customization
+
+Sabisu is highly customizable to make your life easier, here is a quick example of a real app configuration, remember you have the configuration file under `config/initializers/sabisu_rails.rb`.
+
+```ruby
+SabisuRails.setup do |config|
+
+  # Base uri for posting the 
+   config.base_api_uri = 'api.sabisu.dev'
+
+  # Ignored attributes for building the forms
+  # config.ignored_attributes = %w{ created_at updated_at id }
+  
+  # HTTP methods
+  # config.http_methods = %w{ GET POST PUT DELETE PATCH }
+  
+  # Headers to include on each request
+  config.api_headers = {'Accept' => 'application/vnd.sabisu.v1'}
+  
+  # Resources on the api
+  config.resources = [:products, :users]
+
+end
+```
+We invite you to look at the full file for further customization.
+
+## Bug tracker & feature request
+
+Have a bug or a feature request? [Please open a new issue](https://github.com/IcaliaLabs/sabisu-rails/issues). Before opening any issue, please search for existing issues.
+
+We recommend you to read the version [milestiones](https://github.com/IcaliaLabs/sabisu-rails/issues?milestone=2&state=open) if you feel like want to collaborate.
+
+## Contributing
+
+Please submit all pull requests against a separate branch. Although it does not have tests yet, be a nice guy and add some for your feature. We'll be working hard to add them too.
+
+In case you are wondering what to attack, we have a milestone with the version to work, some fixes and refactors. Feel free to start one.
+
+Thanks!
+
+## Community
+
+Keep track of new feautres, development issues and community news.
+
+* Follow [@kurenn](https://twitter.com/kurenn)
+* Have a question about anything, email us at weare@icalialabs.com
+
+## Heroes
+
+**Abraham Kuri**
+
++ [http://twitter.com/kurenn](http://twitter.com/kurenn)
++ [http://github.com/kurenn](http://github.com/kurenn)
++ [http://klout.com/#/kurenn](http://klout.com/#/kurenn)
+
+
+## Copyright and license
+
+Code and documentation copyright 2013-2014 Icalia Labs. Code released under [the MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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

@@ -0,0 +1,12 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require sabisu_rails/KelpJSONView
+//= require furatto
+//= require sabisu_rails/sabisu
+//= require sabisu_rails/pace

data/app/assets/javascripts/sabisu_rails/sabisu.js.coffee

@@ -0,0 +1,40 @@
+capitalize = (str) ->
+  str[0].toUpperCase() + str.slice(1)
+
+$ ->
+  $addButtons = $('.explorer-fields-link-js')
+  fieldId = 1
+
+  $addButtons.on 'click', (e) ->
+    e.preventDefault()
+    $wrapperTarget = $($(@).data('target'))
+    inputType = $(@).data('type')
+    singleInputType = capitalize(inputType.substring(0, inputType.length - 1).replace("_", " "))
+
+    fieldsToAppend = "<div class='row'>
+    <div class='col-5'>
+    <input type='text' name='explorer[#{inputType}][#{fieldId}][#{inputType}_name_#{fieldId}]' id='explorer_#{inputType}_name_#{fieldId}' placeholder='#{singleInputType} name'/>
+    </div>
+    <div class='col-6'>
+    <input type='text' name='explorer[#{inputType}][#{fieldId}][#{inputType}_value_#{fieldId}]' id='explorer_#{inputType}_value_#{fieldId}' placeholder='#{singleInputType} value'/>
+    </div>
+    <div class='col-1'>
+    <a href='#' class='remove_input button radius nomargin danger three-d' data-counter='##{inputType}_counter_js'><i class='fa fa-trash-o'></i></a>
+    </div>
+    </div>"
+
+    $wrapperTarget.append(fieldsToAppend)
+    $("##{inputType}_counter_js").text($wrapperTarget.children().length)
+    fieldId++
+
+  $(document).on 'click', '.remove_input', (e) ->
+    e.preventDefault()
+    inputsWrapper = $(@).parent().parent().parent()
+    counter = $($(@).data('counter'))
+    $(@).parent().parent().remove()
+    counter.text(inputsWrapper.children().length)
+
+  $('#explorer_form').submit ->
+    Pace.start()
+
+    

data/app/assets/stylesheets/sabisu_rails/application.css.scss

@@ -0,0 +1,9 @@
+@import 'furatto/functions';
+@import 'furatto/selectors';
+@import 'normalize';
+@import 'sabisu_rails/furatto_overrides';
+@import 'font-awesome';
+@import 'furatto';
+@import 'sabisu_rails/KelpJSONView';
+@import 'sabisu_rails/explorer';
+@import 'sabisu_rails/pace';

data/app/assets/stylesheets/sabisu_rails/explorer.css.scss

@@ -0,0 +1,117 @@
+.main-content {
+  border-left: 1px solid darken(#F5F5F5, 5%);
+  padding-left: 30px;
+  background: #FFF;
+  padding-bottom: 20px;
+}
+
+.navigation {
+  &.side {
+    height: 100%;
+    padding: 0;
+    .header {
+      background: #EA5D5F;
+      border: 1px solid darken(#EA5D5F, 4%);
+      padding-left: 20px;
+      padding-top: 50px;
+      padding-bottom: 10px;
+
+      &:hover {
+        background: #EA5D5F;
+        border: 1px solid darken(#EA5D5F, 4%);
+      }
+    }
+
+    li {
+      padding-left: 20px;
+      cursor: pointer;
+      &:hover {
+        background: #7BD5D3; 
+      }
+    }
+
+    li.active {
+      position: relative;
+      background: #7BD5D3; 
+      border: 1px solid darken(#7BD5D3, 4%);
+
+      &:after {
+        content: '';
+        position: absolute;
+        right: -2px;
+        top: 12px;
+        width: 0; 
+        height: 0; 
+        border-top: 12px solid transparent;
+        border-bottom: 12px solid transparent; 
+
+        border-right:12px solid #FFF;
+      }
+    }
+  }
+}
+
+.nomargin {
+  margin: 0;
+}
+
+fieldset {
+  border: none;
+  padding: 0 0 8px 0;
+  margin-top: 15px;
+  color: #555;
+  text-transform: uppercase;
+
+  legend {
+    border-bottom: 1px solid rgba(#b3b3b3, 0.5);
+    display: block;
+    width: 100%;
+    padding-bottom: 8px;
+  }
+}
+
+.button {
+  &.danger {
+    color: #777; 
+  }
+}
+
+.navigation {
+  &.inline {
+    li {
+      a {
+        padding: 2px 5px;
+        font-weight: lighter;
+      }
+
+      &.active {
+        border-top: 2px solid darken($navigation-inline-active-background, 10%);
+      }
+    }
+  }
+}
+
+.response-details {
+  float: right;
+  padding-right: 25px;
+}
+
+.response-wrapper {
+  padding-right: 10px;
+}
+
+.text-strong {
+  font-weight: bold;
+}
+
+.headers {
+  span {
+    display: inline-block;
+    margin-bottom: 10px;
+    font-size: 13px;
+  }
+
+  i.fa {
+    margin: 0 8px;
+  }
+}

data/app/assets/stylesheets/sabisu_rails/furatto_overrides.scss

@@ -0,0 +1,24 @@
+// Navigation overrides
+$navigation-header-color: #FFF;
+$navigation-header-font-size: px-to-rems(16);
+$navigation-list-item-active-color: #FFF;
+$navigation-list-link-display: block;
+$navigation-list-link-padding: 12px 0;
+$navigation-link-color: #333;
+$navigation-list-item-font-size: 1rem;
+
+$navigation-inline-active-background: #B2789C;
+$navigation-inline-active-padding: 2px 10px;
+
+// Base overrides
+$body-background-color: #F5F5F5;
+
+// Buttons
+$button-default-background-color: #EA5D5F;
+$button-primary-background: #7BD5D3;
+$button-danger-background: #ecf0f1;
+$button-success-background: #8ABD68;
+
+// Labels
+$label-default-background: $button-default-background-color;
+$label-primary-background: #34495e;

data/app/controllers/sabisu_rails/base_controller.rb

@@ -0,0 +1,16 @@
+module SabisuRails
+  class BaseController < ApplicationController
+
+    layout SabisuRails.layout
+
+    before_filter :authenticate
+
+    protected
+
+      def authenticate
+        authenticate_or_request_with_http_basic do |username, password|
+          username == SabisuRails.authentication_username && password == SabisuRails.authentication_password
+        end
+      end
+  end
+end

data/app/controllers/sabisu_rails/explorer_controller.rb

@@ -0,0 +1,15 @@
+module SabisuRails
+  class ExplorerController < SabisuRails::BaseController
+
+    def index
+      @resources = SabisuRails.resources
+      @explorer = SabisuRails::Explorer.new(params[:explorer] || {})
+      @response = SabisuRails::Request.new(@explorer, params[@explorer.resource_name], params[:explorer]).response
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+  end
+end

data/app/helpers/sabisu_rails/explorer_helper.rb

@@ -0,0 +1,28 @@
+module SabisuRails::ExplorerHelper
+
+  def label_attribute(explorer, attr)
+    explorer.required_attribute?(attr) ? "* #{attr.capitalize}" : attr.capitalize
+  end
+
+  def active_resource_state(resource)
+    loaded_resource = SabisuRails.default_resource
+    if params[:explorer].nil?
+      "active" if loaded_resource  == resource
+    else
+      "active" if params[:explorer][:resource] == resource
+    end
+  end
+
+  def prettify_headers(headers)
+    html = ""
+    headers.each do |k, v|
+      k = k.titleize.split(' ').join('-')
+      header_name = content_tag :span, k, class: 'text-muted text-strong'
+      arrow = content_tag :span," <i class='fa fa-long-arrow-right'></i> ".html_safe, class: 'text-muted'
+      header_value = content_tag :span, v, class: 'text-muted'
+      html << (header_name + arrow + header_value)
+      html << "<br />"
+    end
+    html.html_safe
+  end
+end

data/app/helpers/sabisu_rails_helper.rb

@@ -0,0 +1,3 @@
+module SabisuRailsHelper
+
+end

data/app/views/layouts/sabisu_rails.html.erb

@@ -0,0 +1,28 @@
+<html lang="en">
+
+<head>
+  <!--includes meta tags, title and more header definitions-->
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1, user-scalable=no">
+  <link href="http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
+
+  <title>Sabisu Explorer</title>
+
+  <!-- Furatto core CSS -->
+  <%= stylesheet_link_tag "sabisu_rails/application", :cache => true %>
+  <%= csrf_meta_tag %>
+
+  <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+  <!--[if lt IE 9]>
+    <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+    <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+  <![endif]-->
+</head>
+
+<body>
+  <%= yield %>
+  <%= javascript_include_tag "sabisu_rails/application" %>
+  <%= yield :javascripts %>
+</body>
+</html>

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

@@ -0,0 +1,86 @@
+<div class="row">
+  <div class="col-2 nopadding">
+    <ul class="navigation side">
+      <li class="header"><%= SabisuRails.app_name %> - <br /> Api Explorer</li>
+      <% @resources.each do |resource| %>
+        <li class="<%= active_resource_state(resource) %>"><%= link_to resource.capitalize, explorer_path(explorer: { resource: resource }) %></li>
+    <% end %>
+    </ul>
+  </div>
+  <div class="col-10 nopadding">
+    <div class="main-content">
+      <div class="row">
+        <div class="col-2">
+          <h4 class="text-muted"><%= "/#{@explorer.resource}/" %></h4>
+        </div>
+        <div class="col-10">
+
+          <%= form_for :explorer, url: explorer_path, html: {id: 'explorer_form'}, method: :get, remote: true do |f| %>
+            <%= f.hidden_field :resource, value: @explorer.resource %>
+          <div class="row">
+            <div class="col-6">
+              <%= f.text_field :uri_pattern, value: @explorer.uri_pattern, placeholder: "URI pattern. 1 or bids or orders/1" %>
+            </div>
+            <div class="col-2">
+              <%= f.select :http_method, options_for_select(SabisuRails.http_methods, @explorer.http_method.upcase) %>
+            </div>
+            <div class="col-2">
+              <a href="#" class="button radius block nomargin three-d explorer-fields-link-js" data-target="#url_params_inputs" data-type="url_params"><i class="fa fa-link"></i>Url params</a>
+            </div>
+            <div class="col-2">
+              <a href="#" class="button radius block nomargin three-d explorer-fields-link-js" data-target="#header_inputs" data-type="headers"><i class="fa fa-indent"></i> Headers</a>
+            </div>
+          </div>
+          <br />
+          <fieldset>
+            <legend>Url params (<span class="label round" id="url_params_counter_js">0</span>)</legend>
+            <div class="row" id="url_params_inputs">
+
+            </div>
+          </fieldset>
+          <fieldset>
+            <legend>Headers (<span class="label round" id="headers_counter_js">0</span>)</legend>
+            <div class="row" id="header_inputs">
+
+            </div>
+          </fieldset>
+
+          <%= f.submit "Send", class: 'button large radius three-d success', data: { :disable_with => "Processing..." } %>
+        <% end %>
+        </div>
+      </div>
+
+      <div class="response-wrapper">
+      <hr />
+
+      <div class="row">
+        <div class="response-details">
+           <ul class="navigation inline">
+             <li><small><strong>STATUS:</strong></small> <span class="label primary radius" id="response_status"><%= @response.code %></span></li>
+             <li><small><strong>TIME:</strong></small> <span class="label primary radius" id="response_time"><%= @response.headers['x-runtime'] %> ms</span></li>
+           </ul>
+        </div>
+        <ul class="navigation inline" data-tabu>
+          <li><a href="#result">Body</a></li>
+          <li><a href="#headers_result">(<span id="headers_count"><%= @response.headers.count %></span>) Headers</a></li>
+        </ul>
+        <div class="tabu-content">
+          <div class="content row" id="result">
+          </div>
+          <div class="content row headers" id="headers_result">
+            <%= prettify_headers @response.headers %>
+          </div>
+        </div>
+      </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= content_for :javascripts do %>
+  <script type="text/javascript" charset="utf-8">
+$(document).ready(function(){
+    $.JSONView(<%= @response.body.html_safe %>, $('#result'));
+    });
+</script>
+<% end %>

data/app/views/sabisu_rails/explorer/index.js.erb

@@ -0,0 +1,6 @@
+$.JSONView(<%= @response.body.html_safe %>, $('#result'));
+$("#response_status").text(<%= @response.code %>);
+$("#response_time").text(<%= @response.headers['x-runtime'] %>);
+$('#headers_result').html("<%= j prettify_headers @response.headers %>");
+$('#headers_count').text(<%= @response.headers.count %>)
+Pace.stop();

data/config/routes.rb

@@ -0,0 +1,3 @@
+SabisuRails::Engine.routes.draw do
+  get "explorer", to: "explorer#index"
+end

data/lib/generators/sabisu_rails/install_generator.rb

@@ -0,0 +1,17 @@
+module SabisuRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__) 
+
+      desc "Creates a Sabisu initializer in your application"
+
+       def copy_initializer
+        template "sabisu_rails.rb", "config/initializers/sabisu_rails.rb"
+       end
+
+       def mount_sabisu_engine
+         route %Q(mount SabisuRails::Engine => "/sabisu_rails") 
+       end
+    end
+  end
+end

data/lib/generators/sabisu_rails/templates/sabisu_rails.rb

@@ -0,0 +1,34 @@
+# Use this module to configure the sabisu available options
+
+SabisuRails.setup do |config|
+
+  # Base uri for posting the 
+  # config.base_api_uri = nil 
+
+  # Ignored attributes for building the forms
+  # config.ignored_attributes = %w{ created_at updated_at id }
+  
+  # HTTP methods
+  # config.http_methods = %w{ GET POST PUT DELETE PATCH }
+  
+  # Headers to include on each request
+  # config.api_headers = {}
+
+  # Layout configuration
+  # config.layout = "sabisu"
+
+  # Resources on the api
+  # config.resources = [:products, :users...]
+
+  # Application name
+  # mattr_accessor :app_name
+  # @@app_name = Rails.application.class.parent_name
+
+  # Authentication
+  # mattr_accessor :authentication_username
+  # @@authentication_username = "admin"
+
+  # mattr_accessor :authentication_password
+  # @@authentication_password = "sekret"
+
+end

data/lib/sabisu_rails/builders/base.rb

@@ -0,0 +1,26 @@
+module SabisuRails
+  module Builders
+    class Base
+
+      def initialize(params)
+        @params = params || {} 
+        sanitize_params
+      end
+
+      def build
+        query_params = {}
+        @sanitized_params.each do |k,v|
+          values = v.values #returns the nested hash, and we get the values from that hash
+        query_params[values[0]] = values[1]
+        end
+        query_params
+      end
+
+      private 
+
+        def sanitize_params
+          @sanitized_params = @params.reject { |k,v| v.blank? } 
+        end
+    end
+  end
+end

data/lib/sabisu_rails/builders/headers_builder.rb

@@ -0,0 +1,6 @@
+module SabisuRails
+  module Builders
+    class HeadersBuilder < SabisuRails::Builders::Base
+    end
+  end
+end

data/lib/sabisu_rails/builders/url_params_builder.rb

@@ -0,0 +1,6 @@
+module SabisuRails
+  module Builders
+    class UrlParamsBuilder < SabisuRails::Builders::Base
+    end
+  end
+end