restivus 0.0.1

data/lib/restivus.rb

@@ -0,0 +1,131 @@
+require 'json'
+require 'csv'
+require 'uri'
+require 'sinatra'
+
+class Restivus < Sinatra::Base
+  
+  # Doc helpers
+  # these methods generate text for the docs pages
+  # ------------
+  
+  def curl_req(url)
+    `curl #{url}`
+  end
+  
+  def format_curl_req(url, description="TODO", http="TODO", url_schema="TODO", div="TODO")
+    result = {
+      :cmd => "$ curl #{url}",
+      :raw_response => curl_req(url),
+      :pretty_response => JSON.pretty_generate(JSON.parse(curl_req(url))),
+      :description => description,
+      :http_verb => http,
+      :url_schema => url_schema,
+      :div_id => div
+    }
+      
+    result
+  end
+  
+  def resource_name
+    self.class.name
+  end
+  
+  def self.fields
+    @@fields
+  end
+  
+  # ----------
+  
+  def self.csv(filename)
+    csv_data = CSV.read filename
+    headers = csv_data.shift.map {|i| i.to_s }
+    headers.map! {|h| h.gsub(" ", "_")}
+    @@fields = headers
+    string_data = csv_data.map {|row| row.map {|cell| cell.to_s } }
+    array_of_hashes = string_data.map {|row| Hash[*headers.zip(row).flatten] }
+    @@results = array_of_hashes
+  end
+  
+  def self.pk(key="id")
+    @@pk = key
+  end
+  
+  def self.find(id)
+    where(@@pk => id.to_s).first
+  end
+
+  def self.where(conditions={})    
+    results = @@results.select do |result|
+      conditions.all? { |k,v| result[k] == v }
+    end
+  end
+  
+  def self.all
+    @@results
+  end
+  
+  def delete_splat(params)
+    %w[splat captures resource].each {|w| params.delete(w)}
+    params
+  end
+  
+  def base_uri
+    uri = "http://#{request.host}"
+    
+    if request.port
+      uri << ":#{request.port}"
+    end
+    
+    uri
+  end
+  
+  get "/docs" do
+    @fields = self.class.fields
+    @base_uri = base_uri
+    @resource_name = resource_name
+    
+    @sample_calls = []
+    #description="TODO", http="TODO", url_schema="TODO"
+    @sample_calls << get_index = format_curl_req("#{@base_uri}/#{@resource_name.downcase}", "Show all #{@resource_name} objects", "GET", "#{@base_uri}/#{@resource_name.downcase}", "index")    
+    
+    obj = self.class.all.first
+    pk_val = URI.encode(obj[@@pk])
+    
+    @sample_calls << get_show = format_curl_req("#{@base_uri}/#{@resource_name.downcase}/#{pk_val}", "Show individual #{@resource_name} objects by #{@@pk}", "GET", "#{@base_uri}/#{@resource_name.downcase}/&lt;#{@@pk}&gt;", "show")
+    
+    key = obj.keys.last
+    val = obj[key]    
+    
+    @sample_calls << get_find = format_curl_req("#{@base_uri}/#{@resource_name.downcase}?#{key}=#{val}", "Query #{@resource_name} objects based on parameters", "GET", "#{@base_uri}/#{@resource_name.downcase}?&lt;param&gt;=&lt;value&gt;", "find")
+    erb :docs
+  end
+  
+  get "/:resource" do
+    content_type :json
+    case params.keys.length
+    when 0 # /:resource
+      {"results" => self.class.all}.to_json
+    else # /:resource?key=value&...
+      constraints = delete_splat(params)
+      {"results" => self.class.where(constraints)}.to_json
+    end
+  end
+  
+  get "/:resource/:id" do
+    content_type :json
+    self.class.find(params[:id].to_s).to_json
+  end
+
+end
+
+# Usage:
+
+#class Person < Restivus
+#  csv "example.csv"
+#end
+
+#class Bank < Restivus
+#  csv "banks.csv"
+#  pk "Bank_Name"
+#end

data/lib/views/_sample_request.erb

@@ -0,0 +1,6 @@
+<div id="<%= sample[:div_id] %>" class="span7">
+	<h3><%= sample[:description] %></h3>
+	<pre><%= sample[:cmd]%></pre>
+	<p>Response (prettified):</p>
+	<pre><%= sample[:pretty_response] %></pre>
+</div>

data/lib/views/docs.erb

@@ -0,0 +1,53 @@
+<br /><br /><br />
+<h2>REST API</h2>
+
+<p>The REST API lets you interact with <%= @resource_name %> objects using HTTP calls.</p>
+
+<h3>Quick Reference</h3>
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>URL</th>
+      <th>HTTP Verb</th>
+	  <th>Functionality</th>
+    </tr>
+  </thead>
+  <tbody>
+	<% @sample_calls.each do |call| %>
+		<tr>
+			<td><%= call[:url_schema] %></td>
+			<td><%= call[:http_verb] %>
+			<td>
+				<a href="#<%= call[:div_id] %>">
+					<%= call[:description] %>
+				</a>
+			</td>
+		</tr>
+	<% end %>
+  </tbody>
+</table>
+
+<div id="fields" class="span7">
+<h3>Fields</h3>
+
+<p>The following are the valid fields of <%= @resource_name %> objects:</p>
+<ul>
+<% @fields.each do |field| %>
+	<li><%= field %></li>
+<% end %>
+</ul>
+
+</div>
+
+<% @sample_calls.each do |call| %>
+	<%= erb :_sample_request, :locals => {:sample => call} %>
+<% end %>
+
+
+<div class="span6">
+<footer class="footer">
+  <p class="pull-right"><a href="#">Back to top</a></p>
+
+</footer>
+</div>

data/lib/views/layout.erb

@@ -0,0 +1,58 @@
+<html>
+  <head>
+	
+	<meta charset="utf-8">
+	<title><%= @resource_name %> REST API Documentation</title>
+	<meta name="apple-mobile-web-app-capable" content="yes" />
+
+	<meta name="viewport" 
+	        content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
+	<meta name="description" content="">
+	<meta name="author" content="">
+	<!--<link rel="stylesheet" href="http://twitter.github.com/bootstrap/1.4.0/bootstrap.min.css">-->
+    <link href="/bootstrap.css" rel="stylesheet">
+    <link href="/bootstrap-responsive.css" rel="stylesheet">
+
+	<script type="text/javascript">
+		window.addEventListener("load",function() {
+			// Set a timeout...
+			setTimeout(function(){
+				// Hide the address bar!
+				window.scrollTo(0, 1);
+			}, 0);
+		});
+	
+	</script
+
+  </head>
+
+  <body data-spy="scroll" data-target=".subnav" data-offset="100">
+	<div class="navbar navbar-fixed-top">
+	      <div class="navbar-inner">
+	        <div class="container">
+	          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+	            <span class="i-bar"></span>
+	            <span class="i-bar"></span>
+	            <span class="i-bar"></span>
+	          </a>
+	          <a class="brand" href="/"><%= @resource_name %> Docs</a>
+	          <div class="nav-collapse">
+	            
+	          </div>
+	        </div>
+	      </div>
+	    </div>
+
+	    <div class="container">
+
+	      <!-- Main hero unit for a primary marketing message or call to action -->
+	      
+			<%= yield %>
+	      
+
+
+  </div> <!-- /container -->
+
+  </body>
+</html>
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'restivus'
+
+class Test::Unit::TestCase
+end

data/test/test_restivus.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRestivus < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: restivus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70359564562260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359564562260
+- !ruby/object:Gem::Dependency
+  name: sinatra-respond_to
+  requirement: &70359564561380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359564561380
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70359564528980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359564528980
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70359564526800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359564526800
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70359564525340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70359564525340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70359564522980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70359564522980
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70359564521340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70359564521340
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70359564519680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70359564519680
+description: Restivus eats CSV files and spits out fully-documented RESTful endpoints.
+email: adelevie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .DS_Store
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/banks/Gemfile
+- examples/banks/banklist.csv
+- examples/banks/config.ru
+- examples/banks/main.rb
+- lib/.DS_Store
+- lib/public/.DS_Store
+- lib/public/bootstrap.css
+- lib/restivus.rb
+- lib/views/.DS_Store
+- lib/views/_sample_request.erb
+- lib/views/docs.erb
+- lib/views/layout.erb
+- test/helper.rb
+- test/test_restivus.rb
+homepage: http://github.com/adelevie/restivus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1920547086008092273
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: REST APIs for the rest of us.
+test_files: []