api_explorer 0.0.1

data/app/controllers/api_explorer/api_controller.rb

@@ -0,0 +1,103 @@
+require_dependency "api_explorer/application_controller"
+
+module ApiExplorer
+  class ApiController < ApplicationController
+    before_filter :read_file
+
+    def index
+
+    end
+
+    def method
+      @method = @methods[params[:position].to_i - 1]
+
+      render :json=> {
+        :parameters_html=> (
+          render_to_string("api_explorer/api/parameters", :locals=>{:parameters=>@method['parameters']} ,:layout => false)
+          ), :description=>@method['description']
+      }
+    end
+
+    def execute
+      require 'net/http'
+      headers = params[:header][:name].zip(params[:header][:value])
+      headers.select!{|header| !header[0].empty? && !header[1].empty?}
+      
+      headers.map!{|header| {:name=> header[0], :value=> header[1]}}
+      
+      uri = URI::HTTP.build(:host=>request.host, :port=> request.port, :path=>'/' + params[:url])
+      http = Net::HTTP.new(uri.host, uri.port) 
+
+      if params[:method].upcase == 'GET'
+        request = Net::HTTP::Get.new(uri.request_uri) 
+      elsif params[:method].upcase == 'POST'
+        request = Net::HTTP::Post.new(uri.request_uri) 
+      elsif params[:method].upcase == 'PUT'
+        request = Net::HTTP::Put.new(uri.request_uri) 
+      elsif params[:method].upcase == 'DELETE'
+        request = Net::HTTP::Delete.new(uri.request_uri) 
+      end
+      
+      request.set_form_data( params.except([:action, :controller, :header, :authentication_type, :auth]) )
+      headers.each do |header|
+        request[header[:name]] = header[:value]
+      end
+      if params[:authentication_type] == 'basic_auth'
+        request.basic_auth params[:auth][:basic_auth_user], params[:auth][:basic_auth_password]
+      elsif params[:authentication_type] == 'hash_url_auth'
+        string_to_convert = uri.to_s
+        hash_verification = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), params[:auth][:secret_key], string_to_convert)).strip
+        request[params[:auth][:header_field]] = hash_verification
+      end
+
+
+      response = http.request(request)
+
+      raw_response = response.body
+      response_html = ''
+
+      if response.header['Content-Type'].include? 'application/json'
+        tokens = CodeRay.scan(JSON.pretty_generate(JSON.parse(raw_response)), :json)
+        response_html = tokens.div
+      elsif response.header['Content-Type'].include? 'application/xml'
+        tokens = CodeRay.scan(raw_response, :xml)
+        response_html = tokens.div
+      elsif response.header['Content-Type'].include? 'text/html'
+        tokens = CodeRay.scan(raw_response, :html)
+        response_html = tokens.div
+      else
+        response_html = '<div>' + raw_response + '</div>'
+      end
+
+      request_html = CodeRay.scan(request.to_yaml, :yaml).div
+
+
+      curr_time = DateTime.now
+      timestamp = curr_time.strftime('%Y%m%d%H%M%S%L')
+      
+      history_html = render_to_string 'api_explorer/api/history', :locals=>{:request_html=>request_html, 
+        :response_html=>response_html, :timestamp=>timestamp}, :layout=>false
+
+      
+
+      render :json =>{ :response_html=> response_html , :request_html => request_html, 
+        :history_html=>history_html, :date=> curr_time.strftime('%H:%M:%S'), 
+        :timestamp => timestamp,
+        :http_method=>params[:method].upcase, :request_url=>params[:url]
+      } , :layout=>false
+          
+    end
+  protected
+    def read_file
+      json_string = ''
+      if ApiExplorer::use_file
+        json_path = ApiExplorer::json_path
+        json_string = File.read(json_path)
+      else
+        json_string = ApiExplorer::json_string
+      end
+       
+      @methods = JSON.parse(json_string)["methods"]
+    end
+  end
+end

data/app/controllers/api_explorer/application_controller.rb

@@ -0,0 +1,4 @@
+module ApiExplorer
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/api_explorer/api_helper.rb

@@ -0,0 +1,4 @@
+module ApiExplorer
+  module ApiHelper
+  end
+end

data/app/helpers/api_explorer/application_helper.rb

@@ -0,0 +1,4 @@
+module ApiExplorer
+  module ApplicationHelper
+  end
+end

data/app/views/api_explorer/api/_authentication.html.erb

@@ -0,0 +1,36 @@
+<div id="authentication_container" class="fields_section">
+	<div id="clear_authentication" title="Clear authentication"></div>
+	<div id="minimize_authentication" class="minimize" title="Minimize"></div>
+
+	<h2>Authentication</h2>
+	<br />
+	<div class="editor-label"> Method</div>
+		
+	<%= select_tag 'authentication_type', options_for_select([['None', ''], ['Basic', 'basic_auth'], ["Hash URL", 'hash_url_auth']]) %>
+	<div id="basic_auth" class="auth_wrapper">
+		<div class="editor-label"> User</div>
+		<div class="editor-field"> <input type="text" placeholder="Value" name="auth[basic_auth_user]" class="parameter_input"/> </div>
+		<div class="editor-label"> Password</div>
+		<div class="editor-field"> <input type="text" placeholder="Value" name="auth[basic_auth_password]" class="parameter_input"/> </div>
+	</div>
+
+	<div id="hash_url_auth" class="auth_wrapper">
+		<div class="auth_method_description">
+			Hash authentication uses HMAC-SHA1 method to encrypt the requested URL using the specified secret key. It sends on the specified HTTP header the results, encoding it using Base 64.
+		</div>
+		<div class="information_field">
+			<div class="editor-label">Hash method</div>
+			<div class="editor-label">HMAC-SHA1</div>
+			<div style="clear: both"></div>
+		</div>
+		<div class="editor-label">Header field</div>
+		<div class="editor-field"> <input type="text" placeholder="Value" name="auth[header_field]" class="parameter_input"/> </div>
+		<div class="editor-label">Secret Key</div>
+		<div class="editor-field"> <input type="text" placeholder="Value" name="auth[secret_key]" class="parameter_input"/> </div>
+		
+	</div>
+
+	<div id="hash_url_auth">
+	</div>
+
+</div>

data/app/views/api_explorer/api/_headers.html.erb

@@ -0,0 +1,16 @@
+<div id="headers_container" class="fields_section">
+	<div id="clear_headers" title="Clear parameters"></div>
+	<div id="minimize_headers" class="minimize" title="Minimize"></div>
+
+	<h2>HTTP Headers</h2>
+	<div class="headers_line">
+		<div class="header_field">
+			<input type="text" placeholder="Header name" name="header[name][]" class="parameter_input" />
+		</div>
+		<div class="header_field">
+			<input type="text" placeholder="Value" name="header[value][]" class="parameter_input" />
+		</div>
+	</div>
+
+
+</div>

data/app/views/api_explorer/api/_response.html.erb

@@ -0,0 +1,44 @@
+<div id="response_placeholder" class="fields_section">
+	<h2>Requests</h2>
+	<div class="tabs">
+	        
+	   <div class="tab tab_request">
+	       <input type="radio" id="tab-1" name="tab-group-1">
+	       <label for="tab-1">Request</label>
+	       
+	       <div class="content  overflow">
+	           Please make a request
+	       </div> 
+	   </div>
+	    
+	   <div class="tab tab_response">
+	       <input type="radio" id="tab-2" name="tab-group-1" checked="">
+	       <label for="tab-2">Response</label>
+	       
+	       <div class="content overflow">
+	           Please make a request
+	       </div> 
+	   </div>
+	    
+	    <div class="tab tab_history">
+	       <input type="radio" id="tab-3" name="tab-group-1">
+	       <label for="tab-3">History</label>
+	     
+	       <div class="content  overflow">
+	       		<div class="history_wrapper">
+	       			<div class="history_content">
+	       			</div>
+		       		<div class="history_menu">
+
+					</div>
+					<div style="clear:both">
+					</div>
+				</div>
+					       		
+	       </div> 
+	   </div>
+	    
+	</div>
+
+</div>
+	

data/app/views/api_explorer/api/history.html.erb

@@ -0,0 +1,3 @@
+<div class="content_wrapper <%= timestamp %>">
+	<%= response_html.html_safe %>
+</div>

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

@@ -0,0 +1,42 @@
+<div class="panel_header">
+	API Explorer
+</div>
+<div class="panel_body">
+	<select class="methods" id="api_methods">
+		<option value="">Select one</option>
+		<%= @methods.each do |method| %>
+			<option data-method="<%= method["method"] %>" value="<%= method["url"] %>"><%= method["name"]%> (<%= method["method"]%> <%= method["url"]%> )</option>
+		<% end %>
+		
+		
+	</select>
+	<br /><br />
+	<div id="method_description"></div>
+	
+
+	
+	<form class="mvm" id="graph_form" action="" method="get">
+		<table>
+			<tbody>
+				<tr>
+					<td>
+						<span id="api_prefix" title="Show host"> → / </span>
+					</td>
+					<td class="full_width_cell">
+						<input type="text" class="inputtext" id="graph_path" name="path">
+					</td>
+					<td></td>
+					<td>
+						<button value="1" class="" id="api_explorer_submit" type="submit">Try</button>
+					</td>
+				</tr>
+			</tbody>
+		</table>
+	</form>
+	<div id="parameters_container" class="fields_section"></div>
+	<%= render 'headers' %>
+	<%= render 'authentication' %>
+	<%= render 'response' %>
+	
+
+</div>

data/app/views/api_explorer/api/parameters.html.erb

@@ -0,0 +1,8 @@
+<div id="clear_parameters" title="Clear parameters"></div>
+<div id="minimize_parameters" class="minimize" title="Minimize"></div>
+
+<h2>Parameters</h2>
+<% parameters.each do |parameter| %>
+	<div class="editor-label"> <%= parameter['name'] %> </div>
+	<div class="editor-field"> <input type="text" placeholder="Value" name="<%= parameter['name']%>" class="parameter_input"/> </div>
+<% end %>

data/app/views/layouts/api_explorer/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ApiExplorer</title>
+  <%= stylesheet_link_tag    "api_explorer/application", :media => "all" %>
+  <%= javascript_include_tag "api_explorer/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body class="api_explorer">
+	<div class="container">
+		<div class="panel">
+			<%= yield %>
+		</div>
+	</div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+ApiExplorer::Engine.routes.draw do
+  root :to => "api#index"
+
+  get :method, :to=>'api#method'
+  post :execute, :to=>'api#execute'
+end

data/lib/api_explorer/engine.rb

@@ -0,0 +1,13 @@
+
+module ApiExplorer
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiExplorer
+    
+   
+  end
+
+  def self.config(&block)
+    yield Engine.config if block
+    Engine.config
+  end
+end

data/lib/api_explorer/version.rb

@@ -0,0 +1,3 @@
+module ApiExplorer
+  VERSION = "0.0.1"
+end

data/lib/api_explorer.rb

@@ -0,0 +1,11 @@
+require "api_explorer/engine"
+
+module ApiExplorer
+  mattr_accessor :json_string
+  mattr_accessor :json_path
+  mattr_accessor :use_file 
+
+  self.use_file = true
+  self.json_path = '/lib/file.json'
+
+end

data/lib/tasks/api_explorer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :api_explorer do
+#   # Task goes here
+# end

data/test/api_explorer_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ApiExplorerTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ApiExplorer
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end