agilib 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a02f38c6455b68e441786611c3517e57f1f2728
-  data.tar.gz: af96f96e3fb27a279a9d4a9a9d525bf250e5cc3b
+  metadata.gz: fc9deaf2be5e4a69fc444229b6ba64f9ecf2aef4
+  data.tar.gz: 2ec8ec06863cbbe8231aa8aa024f6a9e71a8a38c
 SHA512:
-  metadata.gz: d2fb50bd99e0161ed38234329b2f2be61b92a272f405f9c65d441fbedef74f27439560d8238fc25aa7c757c8903b58764f64eb244679fa1e9ed725608b53adf2
-  data.tar.gz: 2672e7113bb0119f2bf289e381d31ab34c751e0f039b8a59c69c570fac2ba6fb589d6b8103800cdb656aa807def31ea69f57774d4dd13d77c663761411dc2808
+  metadata.gz: 9e34f93cb5b3ce6b062b005abb29a82c95b73461ac8796cf9b3e6e26b383b7035ae66211c52983ea21e7ed5be48aae39813e1854c129b0efb00ed7d0cc403d0b
+  data.tar.gz: ae8a8a786913b14e79471e80f8c82f79f55d3804889a3f831b93afc39f2bf20f42f13be345367ce28343183dcf18b9af0b3b1364810e6a3824cce29fff0de445

data/app/views/apitome/docs/_all_examples.html.erb

@@ -0,0 +1,10 @@
+<% resources.each do |resource| %>
+  <section class="example" id="<%= id_for(resource['name']) %>">
+    <h2 class="resource-name"><%= resource['name'] %></h2>
+    <% resource['examples'].each do |example| %>
+      <article id="<%= id_for(example['link'].gsub('.json', '')) %>">
+        <%= render partial: 'example', locals: { example: set_example(example['link'].gsub('.json', '')) } %>
+      </article>
+    <% end %>
+  </section>
+<% end %>

data/app/views/apitome/docs/_body.html.erb

@@ -0,0 +1,4 @@
+<section class="body">
+  <h4>Body</h4>
+  <pre><code class="<%= type %>"><%= formatted_body(body, type) %></code></pre>
+</section>

data/app/views/apitome/docs/_curl.html.erb

@@ -0,0 +1,4 @@
+<section class="curl">
+  <h4>cURL</h4>
+  <pre><%= request['curl'] %></pre>
+</section>

data/app/views/apitome/docs/_example.html.erb

@@ -0,0 +1,24 @@
+<h3><%= example['description'] %></h3>
+
+<%= render partial: 'apitome/docs/explanation',    locals: {explaination: example['explanation']} if example['explanation'] %>
+<%= render partial: 'apitome/docs/params',         locals: {params: example['parameters']} if example['parameters'].size > 0 %>
+
+<% example['requests'].each_with_index do |request, index| %>
+  <div id="<%= "request-#{index}" %>">
+    <h3>Request</h3>
+    <div class="request">
+      <%= render partial: 'apitome/docs/route',    locals: {request: request, index: index} %>
+      <%= render partial: 'apitome/docs/headers',  locals: {request: request, index: index, headers: request['request_headers']} %>
+      <%= render partial: 'apitome/docs/query',    locals: {request: request, index: index} unless request['request_query_parameters'].empty? %>
+      <%= render partial: 'apitome/docs/body',     locals: {request: request, index: index, body: request['request_body'], type: request['request_content_type']} if request['request_body'] %>
+      <%= render partial: 'apitome/docs/curl',     locals: {request: request, index: index} if request['curl'] %>
+    </div>
+
+    <h3>Response</h3>
+    <div class="response">
+      <%= render partial: 'apitome/docs/status',   locals: {request: request, index: index} %>
+      <%= render partial: 'apitome/docs/headers',  locals: {request: request, index: index, headers: request['response_headers']} %>
+      <%= render partial: 'apitome/docs/body',     locals: {request: request, index: index, body: request['response_body'], type: request['response_content_type']} if request['response_body'] %>
+    </div>
+  </div>
+<% end %>

data/app/views/apitome/docs/_explanation.html.erb

@@ -0,0 +1,3 @@
+<p class="explanation">
+  <%= raw example['explanation'] %>
+</p>

data/app/views/apitome/docs/_header.html.erb

@@ -0,0 +1,8 @@
+<header class="navbar navbar-fixed-top docs-nav" role="banner">
+  <div class="container">
+    <div class="navbar-header">
+      <h1 class="navbar-brand"><a href="<%= Apitome.configuration.mount_at %>"><%= Apitome.configuration.title %></a></h1>
+    </div>
+    <p class="navbar-text pull-right"><%= link_to '<img src="http://agivis.com.br/assets/logo_agivis-af5e30b64fe8cc778c0b0010b613e88c.jpg" alt="" height="25">'.html_safe, "http://www.agivis.com.br", :target => "_blank" %></hp>
+  </div>
+</header>

data/app/views/apitome/docs/_headers.html.erb

@@ -0,0 +1,4 @@
+<section class="headers">
+  <h4>Headers</h4>
+  <pre><code class="http"><%= headers.map{ |k,v| "#{k}: #{v}" }.join("\n") %></code></pre>
+</section>

data/app/views/apitome/docs/_navigation.html.erb

@@ -0,0 +1,28 @@
+<ul class="nav sidenav">
+  <li>
+    <% if Apitome.configuration.single_page %>
+      <a href="#readme">README</a>
+    <% else %>
+      <a href="<%= Apitome.configuration.mount_at %>">README</a>
+    <% end %>
+  </li>
+  <% resources.each do |resource| %>
+    <li>
+      <% if Apitome.configuration.single_page %>
+        <a href="#<%= id_for(resource['examples'].first['link']) %>"><%= resource['name'] %></a>
+        <ul class="nav">
+          <% resource['examples'].each do |example| %>
+            <li><%= link_to example['description'], "##{id_for(example['link'])}" %></li>
+          <% end %>
+        </ul>
+      <% else %>
+        <li><%= link_to resource['name'], "#{Apitome.configuration.mount_at}/#{resource['examples'].first['link'].gsub(/\.json$/, '')}" %></li>
+        <ul class="nav">
+          <% resource['examples'].each do |example| %>
+            <li><%= link_to example['description'], "#{Apitome.configuration.mount_at}/#{example['link'].gsub(/\.json$/, '')}" %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

data/app/views/apitome/docs/_params.html.erb

@@ -0,0 +1,30 @@
+<section class="params">
+  <h3>Parameters</h3>
+  <div class="table-responsive">
+    <table class="table table-bordered">
+      <tr>
+        <% param_headers(params).each do |title| %>
+          <th><%= title %></th>
+        <% end %>
+      </tr>
+      <% params.each do |param| %>
+        <tr>
+          <td class="name">
+            <% if param['scope'] %>
+              <%= "#{param['scope']}[#{param['name']}]" %>
+            <% else %>
+              <%= param['name'] %>
+            <% end %>
+            <% if param['required'] %>
+              <span class="label label-danger required">required</span>
+            <% end %>
+          </td>
+          <td class="description"><%= param['description'] %></td>
+          <% param_extras(params).each do |extra| %>
+            <td class="extra"><%= param[extra] %></td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</section>

data/app/views/apitome/docs/_query.html.erb

@@ -0,0 +1,4 @@
+<section class="query-parameters">
+  <h4>Query Parameters</h4>
+  <pre><%= request['request_query_parameters'].map{ |k,v| "#{k}=#{v}" }.join("\n") %></pre>
+</section>

data/app/views/apitome/docs/_route.html.erb

@@ -0,0 +1,4 @@
+<section class="route">
+  <h4>Route</h4>
+  <pre><%= "#{request['request_method']} #{request['request_path']}" %></pre>
+</section>

data/app/views/apitome/docs/_status.html.erb

@@ -0,0 +1,4 @@
+<section class="status">
+  <h4>Status</h4>
+  <pre><code class="http"><%= request['response_status'] %></code></pre>
+</section>

data/app/views/apitome/docs/index.html.erb

@@ -0,0 +1,6 @@
+<section class="readme" id="readme">
+  <article>
+    <%= raw formatted_readme %>
+  </article>
+</section>
+<%= render 'all_examples' if Apitome.configuration.single_page %>

data/app/views/apitome/docs/show.html.erb

@@ -0,0 +1,2 @@
+<h2 class="resource-name"><%= resource['name'] %></h2>
+<%= render 'example' %>

data/lib/agilib/composer/templates/recipes/apitome.rb

@@ -0,0 +1,13 @@
+gem 'apitome'
+
+if defined? app_name
+	name = app_name
+elsif defined? application_name
+	name = application_name
+end
+
+templater.post_bundler do 
+	generate 'apitome:install'
+
+	gsub_file 'config/initializers/apitome.rb', 'Apitome Documentation', "#{name.humanize} Api Documentation"
+end

data/lib/agilib/composer/templates/recipes/push.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 templater.post_bundler do
 
-	if Agilib::Composer.options[:all] || yes?("\nO projeto deverá ter Notificação por Push? [yes,no]", :green)
+	# if Agilib::Composer.options[:all] || yes?("\nO projeto deverá ter Notificação por Push? [yes,no]", :green)
 	
-		do_configure = yes?("\nDeseja configurar agora? [yes,no]", :green)
+		do_configure = yes?("\nDeseja configurar o módulo Push Notification agora? [yes,no]", :green)
 
   	generate 'agilib:push'
   	rake 'db:migrate'
@@ -42,5 +42,5 @@ templater.post_bundler do
 
 		end
 
-	end
+	# end
 end

data/lib/agilib/composer/templates/recipes/rspec.rb

@@ -6,7 +6,6 @@ gem "database_cleaner",   :group => :test
 gem "email_spec",     		:group => :test
 gem 'simplecov', 					:require => false, :group => :test
 gem 'rspec_api_documentation', 	:group => [:development, :test]
-gem 'raddocs', :github => "smartlogic/raddocs"
 gem 'json_spec', :group => [:development, :test]
 
 templater.post_bundler do 
@@ -136,13 +135,11 @@ SimpleCov.start
 	
 	say("\nConfigurando RSpec API Documentation...\n", :green)
 
-	inject_into_file "config/routes.rb", "\n\n  get \"/docs\" => Raddocs::App, :anchor => false\n\n", :after => "agilib"
-
 	append_file spec_helper_path do 
 		<<-TEXT
 RspecApiDocumentation.configure do |config|
   config.format = [:json]
-  config.keep_source_order = true
+  config.keep_source_order = false
 end
 		TEXT
 	end

data/lib/agilib/composer/templates/recipes/token.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 templater.post_bundler do
 	
-	if Agilib::Composer.options[:all] || yes?("\nO projeto deverá ter Autenticação por Token? [yes,no]\n", :green)
+	# if Agilib::Composer.options[:all] || yes?("\nO projeto deverá ter Autenticação por Token? [yes,no]\n", :green)
 		say("\nConfigurando o módulo Token Authenticatable... \n\n", :green)
   	generate 'agilib:token'
   	rake 'db:migrate'
-	end
+	# end
 
 end

data/lib/agilib/composer/templates/runner.rb

@@ -4,7 +4,7 @@ require File.join(File.expand_path('./../../../../', __FILE__), 'agilib.rb')
 require 'composer'
 require File.join(File.dirname(__FILE__), 'core_ext.rb')
 
-%w(default gems responders simple_form bootstrap rspec devise token push cancan better_errors layout finalize).each do |recipe|
+%w(default gems responders simple_form bootstrap rspec apitome devise token push cancan better_errors layout finalize).each do |recipe|
   apply templater.recipe(recipe)
 end
 

data/lib/agilib/composer/templates/snippets/rspec/tokens_acceptance_spec.rb

@@ -1,7 +1,9 @@
+# encoding: utf-8
+
 require 'spec_helper'
 require 'rspec_api_documentation/dsl'
 
-resource "Tokens" do
+resource "1 - Tokens de Autenticação" do
   header "Accept", "application/json"
   header "Content-Type", "application/json"
 
@@ -11,15 +13,29 @@ resource "Tokens" do
   # POST /tokens
   post "/tokens" do
 
-    parameter :email, "User email", :required => true
-    parameter :password, "User Password", :required => true
+    parameter :email, "Email do Usuário", :required => true
+    parameter :password, "Senha do Usuário", :required => true
 
     let(:email) { user.email }
     let(:password) { user.password }
 
     let(:raw_post) { params.to_json }
 
-    example_request "Getting an session token" do
+    example_request "1.1 Solicitar Token de Autenticação" do
+      expect(status).to eq(200)
+    end
+  end
+
+  # GET /tokens
+  get "/tokens/check" do
+
+    parameter :user_token, "Token de Autenticação", :required => true
+
+    let(:user_token) { user.authentication_token }
+
+    let(:raw_post) { params.to_json }
+
+    example_request "1.2 Checar validade do Token" do
       expect(status).to eq(200)
     end
   end
@@ -27,13 +43,13 @@ resource "Tokens" do
   # DELETE /tokens
   delete "/tokens" do
 
-    parameter :auth_token, "The token", :required => true
+    parameter :user_token, "Token de Autenticação", :required => true
 
-    let(:auth_token) { user.authentication_token }
+    let(:user_token) { user.authentication_token }
 
     let(:raw_post) { params.to_json }
 
-    example_request "Deleting an token" do
+    example_request "1.3 Remover Token de Autenticação" do
       expect(status).to eq(200)
     end
   end

data/lib/agilib/composer/templates/snippets/rspec/users_acceptance_spec.rb

@@ -1,23 +1,23 @@
+# encoding: utf-8
+
 require 'spec_helper'
 require 'rspec_api_documentation/dsl'
 
-resource "Users" do
+resource "2 - Usuários" do
   header "Accept", "application/json"
   header "Content-Type", "application/json"
 
   let(:current_user) { create(:user) }
 
-  let(:auth_token) { current_user.authentication_token if current_user }
-  let(:auth_email) { current_user.email if current_user }
+  let(:user_token) { current_user.authentication_token if current_user }
+  let(:user_email) { current_user.email if current_user }
 
   # POST /users
   post "/users" do
-    parameter :name, "Name of user", :required => true, :scope => :user
-    parameter :email, "Email of user", :required => true, :scope => :user
-    parameter :password, "Password", :required => true, :scope => :user
-    parameter :password_confirmation, "Password Confirmation", :required => true, :scope => :user
-    parameter :auth_token, "User token",  :required => true
-    parameter :auth_email, "User email",  :required => true
+    parameter :name, "Nome do usuário", :required => true, :scope => "user"
+    parameter :email, "E-mail do usuário", :required => true, :scope => "user"
+    parameter :password, "Senha do usuário", :required => true, :scope => "user"
+    parameter :password_confirmation, "Confirmação da Senha", :required => true, :scope => "user"
 
     let(:name) { "User Test" }
     let(:email) { "usertest@email.com" }
@@ -25,61 +25,67 @@ resource "Users" do
     let(:password_confirmation) { "password1234" }
 
     let(:raw_post) do
-      params.to_json 
+      # puts params.to_json
+      params.to_json
     end
 
-    example_request "Creating an user" do
+    example_request "2.1 Criação de um usuário" do
+      # puts response_body
       expect(status).to eq(201)
       
       current_user = JSON.parse(response_body)
     end
   end
 
-  # GET /users/:id
-  get "/users/:id" do
-    parameter :auth_token, "User token", :required => true
-    parameter :auth_email, "User email", :required => true
-
-    let(:id) { current_user.id }
-
-    let(:raw_post) { params.to_json }
-
-    example_request "Getting a specific user" do
-      status.should == 200
-    end
-  end
-
   # PUT /users/:id
   put "/users/:id" do
-    parameter :name, "Name of user",      :scope => :user
-    parameter :email, "Email of user",    :scope => :user
-    parameter :password, "Email of user",    :scope => :user
-    parameter :password_confirmation, "Email of user",    :scope => :user
-    parameter :auth_token, "User token",  :required => true
-    parameter :auth_email, "User email",  :required => true
+    parameter :name, "Nome do usuário", :required => false, :scope => "user"
+    parameter :email, "E-mail do usuário", :required => false, :scope => "user"
+    parameter :password, "Senha do usuário", :required => false, :scope => "user"
+    parameter :password_confirmation, "Confirmação da Senha", :required => true, :scope => "user"
+    parameter :user_token, "Token de Autenticação",  :required => true
+    parameter :user_email, "Email de Autenticação",  :required => true
 
     let(:id) { current_user.id }
     let(:name) { "Updated Name" }
 
     let(:raw_post) { params.to_json }
 
-    example_request "Updating an user" do
+    example_request "2.2 Alteração do Perfil" do
+      puts response_body
       expect(status).to eq(204)
+
     end
   end
 
-  # DELETE /users/:id
-  delete "/users/:id" do
-    parameter :id, "Id of user", :required => true, :scope => :user
-    parameter :auth_token, "User token",  :required => true
-    parameter :auth_email, "User email",  :required => true
+  # # GET /users/:id
+  # get "/users/:id" do
+  #   parameter :user_token, "User token", :required => true
+  #   parameter :user_email, "User email", :required => true
 
-    let(:raw_post) { params.to_json }
-    let(:id) { current_user.id }
+  #   let(:id) { current_user.id }
 
-    example_request "Deleting an user" do
-      status.should == 204
-    end
-  end
+  #   example_request "Getting a specific user" do
+      
+  #     puts response_body
+
+  #     response_body.should == current_user.to_json
+  #     status.should == 200
+  #   end
+  # end
+
+  # # DELETE /users/:id
+  # delete "/users/:id" do
+  #   parameter :id, "Id of user", :required => true, :scope => :user
+  #   parameter :user_token, "User token",  :required => true
+  #   parameter :user_email, "User email",  :required => true
+
+  #   let(:raw_post) { params.to_json }
+  #   let(:id) { user.id }
+
+  #   example_request "Deleting an user" do
+  #     status.should == 204
+  #   end
+  # end
 
 end

data/lib/agilib/version.rb

@@ -2,7 +2,7 @@ module Agilib
 	module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 7
+    PATCH = 8
     BUILD = ''
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/lib/generators/agilib/install/templates/config/initializers/agilib.rb

@@ -42,7 +42,7 @@ Agilib.setup do |config|
 		#
 		# Default: {:user_token => :user_token, :user_email => :user_email}
 		# 
-  	options.auth_params = {:user_token => :auth_token, :user_email => :auth_email}
+  	options.auth_params = {:user_token => :user_token, :user_email => :user_email}
 
   	# ===============================================================================
   	# Define quais parâmetros serão passados para solicitar o token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agilib
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Marcos Junior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: executable-hooks
@@ -184,6 +184,20 @@ files:
 - app/views/agilib/devices/show.json.jbuilder
 - app/views/agilib/welcome/index.html
 - app/views/agilib/welcome/index.html.erb
+- app/views/apitome/docs/_all_examples.html.erb
+- app/views/apitome/docs/_body.html.erb
+- app/views/apitome/docs/_curl.html.erb
+- app/views/apitome/docs/_example.html.erb
+- app/views/apitome/docs/_explanation.html.erb
+- app/views/apitome/docs/_header.html.erb
+- app/views/apitome/docs/_headers.html.erb
+- app/views/apitome/docs/_navigation.html.erb
+- app/views/apitome/docs/_params.html.erb
+- app/views/apitome/docs/_query.html.erb
+- app/views/apitome/docs/_route.html.erb
+- app/views/apitome/docs/_status.html.erb
+- app/views/apitome/docs/index.html.erb
+- app/views/apitome/docs/show.html.erb
 - bin/agilib
 - lib/.DS_Store
 - lib/agilib.rb
@@ -192,6 +206,7 @@ files:
 - lib/agilib/composer/composer.rb
 - lib/agilib/composer/templater.rb
 - lib/agilib/composer/templates/core_ext.rb
+- lib/agilib/composer/templates/recipes/apitome.rb
 - lib/agilib/composer/templates/recipes/better_errors.rb
 - lib/agilib/composer/templates/recipes/bootstrap.rb
 - lib/agilib/composer/templates/recipes/cancan.rb