otto 0.2.1.003 → 0.3.0

data/CHANGES.txt

@@ -1,5 +1,10 @@
 OTTO, CHANGES
 
+#### 0.3.0 (2011-12-17) ###############################
+
+* ADDED: Example app, better docs in readme
+* CHANGE: No default value for user agent
+
 #### 0.2.1 (2011-07-07) ###############################
 
 * ADDED: Otto#add_static_path

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Delano Mandelbaum
+Copyright (c) 2011,2012 Delano Mandelbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,112 @@
 # Otto - 0.2
 
-**Auto-define your rack-apps in plaintext.**
+**Auto-define your rack-apps in plain-text.**
+
+## Overview ##
+
+Apps build with Otto have three, basic parts: a rackup file, a ruby file, and a routes file. If you've built a [Rack app](http://rack.rubyforge.org/) before, then you've seen a rackup file before. The ruby file is your actual app and the routes file is what Otto uses to map URI paths to a Ruby method.
 
+A barebones app directory looks something like this:
 
+    $ cd myapp
+    $ ls
+    config.ru app.rb routes
+
+See the examples/ directory for a working app.
+
+
+### Routes ###
+
+The routes file is just a plain-text file which defines the end points of your application. Each route has three parts:
+
+ * HTTP verb (GET, POST, PUT, DELETE or HEAD)
+ * URI path
+ * Ruby class and method to call
+
+Here is an example:
+
+    GET   /                         App#index
+    POST  /                         App#receive_feedback
+    GET   /redirect                 App#redirect
+    GET   /robots.txt               App#robots_text
+    GET   /product/:prodid          App#display_product
+
+    # You can also define these handlers when no 
+    # route can be found or there's a server error. (optional) 
+    GET   /404                      App#not_found
+    GET   /500                      App#server_error
+
+### App ###
+
+There is nothing special about the Ruby class. The only requirement is that the first two arguments to initialize be a Rack::Request object and a Rack::Response object. Otherwise, you can do anything you want. You're free to use any templating engine, any database mapper, etc. There is no magic.
+
+    class App
+      attr_reader :req, :res
+
+      # Otto creates an instance of this class for every request
+      # and passess the Rack::Request and Rack::Response objects.
+      def initialize req, res
+        @req, @res = req, res
+      end
+
+      def index
+        res.header['Content-Type'] = "text/html; charset=utf-8"
+        lines = [
+          '<img src="/img/otto.jpg" /><br/><br/>',
+          'Send feedback:<br/>',
+          '<form method="post"><input name="msg" /><input type="submit" /></form>',
+          '<a href="/product/100">A product example</a>'
+        ]
+        res.body = lines.join($/)
+      end
+
+      def receive_feedback
+        res.body = req.params.inspect
+      end
+
+      def redirect
+        res.redirect '/robots.txt'
+      end
+
+      def robots_text
+        res.header['Content-Type'] = "text/plain"
+        rules = 'User-agent: *', 'Disallow: /private'
+        res.body = rules.join($/)
+      end
+      
+      def display_product
+        res.header['Content-Type'] = "application/json; charset=utf-8"
+        prodid = req.params[:prodid]
+        res.body = '{"product":%s,"msg":"Hint: try another value"}' % [prodid]
+      end
+      
+      def not_found
+        res.status = 404
+        res.body = "Item not found!"
+      end
+
+      def server_error
+        res.status = 500
+        res.body = "There was a server error!"
+      end
+    end
+
+### Rackup ###
+
+There is also nothing special about the rackup file. It just builds a Rack app using your routes file. 
+
+    require 'otto'
+    require 'app'
+    
+    app = Otto.new("./routes")
+    
+    map('/') { 
+      run app
+    }
+
+See the examples/ directory for a working app.
+
+    
 ## Installation
 
 Get it in one of the following ways:
@@ -14,23 +118,28 @@ Get it in one of the following ways:
 You can also download via [tarball](http://github.com/delano/otto/tarball/latest) or [zip](http://github.com/delano/otto/zipball/latest). 
 
 
-
 ## More Information
 
 * [Codes](http://github.com/delano/otto)
 * [RDocs](http://solutious.com/otto)
 
 
-## Credits
+## In the wild ##
 
-* [Delano Mandelbaum](http://solutious.com)
+Services that use Otto:
+
+* [One-Time Secret](https://onetimesecret.com/) -- A safe way to share sensitive data.
+* [BlameStella](https://www.blamestella.com/) -- Web monitoring for devs and designers.
 
 
-## Thanks 
+## Credits
+
+* [Delano Mandelbaum](http://solutious.com)
 
 
 ## Related Projects
 
+* [Sinatra](http://www.sinatrarb.com/)
 
 ## License
 

data/Rakefile

@@ -3,11 +3,7 @@ require "rake"
 require "rake/clean"
 require 'yaml'
 
-begin
-  require 'hanna/rdoctask'
-rescue LoadError
-  require 'rake/rdoctask'
-end
+require 'hanna/rdoctask'
  
 config = YAML.load_file("VERSION.yml")
 task :default => ["build"]
@@ -17,7 +13,7 @@ name = "otto"
 begin
   require "jeweler"
   Jeweler::Tasks.new do |gem|
-    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}.#{config[:BUILD]}"
+    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
     gem.name = "otto"
     gem.rubyforge_project = gem.name
     gem.summary = "Auto-define your rack-apps in plaintext."
@@ -35,7 +31,7 @@ end
 
 
 Rake::RDocTask.new do |rdoc|
-  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}.#{config[:BUILD]}"
+  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
   rdoc.rdoc_dir = "doc"
   rdoc.title = "otto #{version}"
   rdoc.rdoc_files.include("README*")

data/VERSION.yml

@@ -1,4 +1,3 @@
 :MAJOR: 0
-:MINOR: 2
-:PATCH: 1
-:BUILD: '003'
+:MINOR: 3
+:PATCH: 0

data/example/app.rb

@@ -0,0 +1,57 @@
+
+
+class App
+  
+  # An instance of Rack::Request
+  attr_reader :req
+  # An instance of Rack::Response
+  attr_reader :res
+  
+  # Otto creates an instance of this class for every request
+  # and passess the Rack::Request and Rack::Response objects.
+  def initialize req, res
+    @req, @res = req, res
+    res.header['Content-Type'] = "text/html; charset=utf-8"
+  end
+  
+  def index
+    lines = [
+      '<img src="/img/otto.jpg" /><br/><br/>',
+      'Send feedback:<br/>',
+      '<form method="post"><input name="msg" /><input type="submit" /></form>',
+      '<a href="/product/100">A product example</a>'
+    ]
+    res.body = lines.join($/)
+  end
+  
+  def receive_feedback
+    res.body = req.params.inspect
+  end
+  
+  def redirect
+    res.redirect '/robots.txt'
+  end
+  
+  def robots_text
+    res.header['Content-Type'] = "text/plain"
+    rules = 'User-agent: *', 'Disallow: /private'
+    res.body = rules.join($/)
+  end
+  
+  def display_product
+    res.header['Content-Type'] = "application/json; charset=utf-8"
+    prodid = req.params[:prodid]
+    res.body = '{"product":%s,"msg":"Hint: try another value"}' % [prodid]
+  end
+  
+  def not_found
+    res.status = 404
+    res.body = "Item not found!"
+  end
+
+  def server_error
+    res.status = 500
+    res.body = "There was a server error!"
+  end
+  
+end

data/example/config.ru

@@ -0,0 +1,35 @@
+# OTTO EXAMPLE APP CONFIG - 2011-12-17
+#
+# Usage:
+# 
+#     $ thin -e dev -R config.ru -p 10770 start
+#     $ tail -f /var/log/system.log
+
+ENV['RACK_ENV'] ||= 'prod'
+ENV['APP_ROOT'] = ::File.expand_path(::File.join(::File.dirname(__FILE__)))
+$:.unshift(::File.join(ENV['APP_ROOT']))
+$:.unshift(::File.join(ENV['APP_ROOT'], '..', 'lib'))
+
+require 'otto'
+require 'app'
+
+PUBLIC_DIR = "#{ENV['APP_ROOT']}/public"
+APP_DIR = "#{ENV['APP_ROOT']}"
+
+app = Otto.new("#{APP_DIR}/routes")
+
+if Otto.env?(:dev)      # DEV: Run web apps with extra logging and reloading
+  map('/') { 
+    use Rack::CommonLogger
+    use Rack::Reloader, 0
+    app.option[:public] = PUBLIC_DIR
+    app.add_static_path '/favicon.ico'
+    run app
+  }
+  # Specify static paths to serve in dev-mode only
+  map('/etc/') { run Rack::File.new("#{PUBLIC_DIR}/etc") }
+  map('/img/') { run Rack::File.new("#{PUBLIC_DIR}/img") }
+
+else                     # PROD: run barebones webapp
+  map('/') { run app }
+end

data/example/routes

@@ -0,0 +1,17 @@
+# OTTO - ROUTES EXAMPLE
+
+# Each route has three parts:
+#  * HTTP verb (GET, POST, PUT, DELETE or HEAD)
+#  * URI path
+#  * Ruby class and method to call
+
+GET   /                         App#index
+POST  /                         App#receive_feedback
+GET   /redirect                 App#redirect
+GET   /robots.txt               App#robots_text
+GET   /product/:prodid          App#display_product
+
+# You can also define these handlers when no 
+# route can be found or there's a server error. (optional) 
+GET   /404                      App#not_found
+GET   /500                      App#server_error

data/lib/otto.rb

@@ -13,8 +13,7 @@ class Otto
       [@version[:MAJOR], @version[:MINOR], @version[:PATCH]].join('.')
     end
     def self.inspect
-      load_config
-      [@version[:MAJOR], @version[:MINOR], @version[:PATCH], @version[:BUILD]].join('.')
+      to_s
     end
     def self.load_config
       require 'yaml'
@@ -320,9 +319,8 @@ class Otto
   end
   module RequestHelpers
     def user_agent
-      env['HTTP_USER_AGENT'] || '[no-user-agent]'
+      env['HTTP_USER_AGENT']
     end
-    
     # HTTP_X_FORWARDED_FOR is from the ELB (non-https only)
     # and it can take the form: 74.121.244.2, 10.252.130.147
     # HTTP_X_REAL_IP is from nginx
@@ -332,62 +330,49 @@ class Otto
       env['HTTP_X_FORWARDED_FOR'].to_s.split(/,\s*/).first ||
       env['HTTP_X_REAL_IP'] || env['REMOTE_ADDR']
     end
-  
     def request_method
       env['REQUEST_METHOD']
     end
-    
     def current_server
       [current_server_name, env['SERVER_PORT']].join(':')
     end
-
     def current_server_name
       env['SERVER_NAME']
     end
-        
     def http_host
       env['HTTP_HOST']
     end
     def request_path
       env['REQUEST_PATH']
     end
-    
     def request_uri
       env['REQUEST_URI']
     end
-        
     def root_path
       env['SCRIPT_NAME']
     end
-    
     def absolute_suri host=current_server_name
       prefix = local? ? 'http://' : 'https://'
       [prefix, host, request_path].join
     end
-    
     def local?
       Otto.env?(:dev, :development) && client_ipaddress == '127.0.0.1' 
     end
-    
     def secure?
       # X-Scheme is set by nginx
       # X-FORWARDED-PROTO is set by elastic load balancer
       (env['HTTP_X_FORWARDED_PROTO'] == 'https' || env['HTTP_X_SCHEME'] == "https")
     end 
-    
     def cookie name
       cookies[name.to_s]
     end
-    
     def cookie? name
       !cookie(name).to_s.empty?
     end
-    
     def current_absolute_uri
       prefix = secure? && !local? ? 'https://' : 'http://'
       [prefix, http_host, request_path].join
     end
-    
   end
   module ResponseHelpers
     attr_accessor :request

data/otto.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "otto"
-  s.version = "0.2.1.003"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Delano Mandelbaum"]
-  s.date = "2011-10-19"
+  s.date = "2011-12-20"
   s.description = "Auto-define your rack-apps in plaintext."
   s.email = "delano@solutious.com"
   s.extra_rdoc_files = [
@@ -22,6 +22,11 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION.yml",
+    "example/app.rb",
+    "example/config.ru",
+    "example/public/favicon.ico",
+    "example/public/img/otto.jpg",
+    "example/routes",
     "lib/otto.rb",
     "otto.gemspec"
   ]

metadata

@@ -2,7 +2,7 @@
 name: otto
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1.003
+  version: 0.3.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-19 00:00:00 Z
+date: 2011-12-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -49,6 +49,11 @@ files:
 - README.md
 - Rakefile
 - VERSION.yml
+- example/app.rb
+- example/config.ru
+- example/public/favicon.ico
+- example/public/img/otto.jpg
+- example/routes
 - lib/otto.rb
 - otto.gemspec
 homepage: http://github.com/delano/otto