buzzard 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2010, Thomas Lee
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by the <organization>.
+4. Neither the name of the <organization> nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'jeweler'
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "buzzard"
+  gemspec.summary = "Sane web app microframework built on Sinatra."
+  gemspec.description = "Buzzard is a framework and application generator"
+  gemspec.email = "buzzard@tomlee.co"
+  gemspec.homepage = "http://github.com/thomaslee/buzzard"
+  gemspec.authors = ["Thomas Lee"]
+
+  gemspec.add_dependency('dbi', '>= 0.4.4')
+  gemspec.add_dependency('sinatra', '>= 1.1.0')
+#  gemspec.add_dependency('erubis', '>= 2.6.0')
+  gemspec.add_dependency('rack-flash', '>= 0.1.1')
+
+  gemspec.rubyforge_project = gemspec.name
+end
+Jeweler::GemcutterTasks.new
+

data/TODO

@@ -0,0 +1 @@
+* How can we package templates in the gem?

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/buzzard

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require "erb"
+require "fileutils"
+
+include FileUtils
+
+BUZZARDDIR = File.dirname(__FILE__)
+TEMPLATEDIR = File.join(BUZZARDDIR, "..", "data")
+
+def usage
+  puts "usage: #{ARGV[0]} appname [ModuleName]"
+  exit 1
+end
+
+def render_template(name, binding)
+  ERB.new(File.open(File.join(TEMPLATEDIR, "#{name}.erb")) { |f| f.read }).result(binding)
+end
+
+def main
+  appname = ARGV[0]
+  modname = ARGV[1]
+
+  dirname = appname + ".git"
+
+  usage if appname.nil? || appname.empty?
+  modname = appname.capitalize if modname.nil? || modname.empty?
+  modname.gsub!(/[-_]([a-z])/) { |s| s.gsub(/[-_]/, "").upcase }
+
+  #
+  # Build directory structure
+  #
+  ["app", "test", "views", "public/css", "public/js", "script"].each do |dir|
+    path = File.join(dirname, dir)
+    if !File.exists?(path)
+      mkdir_p path
+    end
+  end
+
+  #
+  # Generate skeleton files
+  #
+  [
+    ["app.rb", "#{appname}.rb"],
+    ["home.rb", "app/home.rb"],
+    ["app.css", "public/css/style.css"],
+    ["app.js", "public/js/#{appname}.js"],
+    ["helpers.rb", "app/helpers.rb"],
+    ["index.erb", "views/index.erb"],
+    ["layout.erb", "views/layout.erb"],
+    ["server.rb", "script/server"],
+    ["test_func.rb", "test/functional.rb"]
+  ].each do |source, target|
+    target_path = File.join(dirname, target)
+    if !File.exists?(target_path)
+      File.open(target_path, "w+b") do |stream|
+        stream.write(render_template(source, binding))
+      end
+    else
+      STDERR.puts "WARN: #{target_path} already exists: skipping."
+    end
+  end
+
+  #
+  # Mark scripts as executable
+  #
+  Dir.glob(File.join(dirname, "script", "*")).each do |filename|
+    chmod 0755, filename
+  end
+end
+
+main
+

data/buzzard.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{buzzard}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Lee"]
+  s.date = %q{2010-11-14}
+  s.default_executable = %q{buzzard}
+  s.description = %q{Buzzard is a framework and application generator}
+  s.email = %q{buzzard@tomlee.co}
+  s.executables = ["buzzard"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "bin/buzzard",
+     "buzzard.gemspec",
+     "data/app.css.erb",
+     "data/app.js.erb",
+     "data/app.rb.erb",
+     "data/helpers.rb.erb",
+     "data/home.rb.erb",
+     "data/index.erb.erb",
+     "data/layout.erb.erb",
+     "data/server.rb.erb",
+     "data/test_func.rb.erb",
+     "lib/buzzard/dbi.rb",
+     "lib/buzzard/helpers.rb",
+     "lib/buzzard/json.rb",
+     "lib/buzzard/security.rb",
+     "lib/buzzard/session.rb"
+  ]
+  s.homepage = %q{http://github.com/thomaslee/buzzard}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{buzzard}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Sane web app microframework built on Sinatra.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dbi>, [">= 0.4.4"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.1.0"])
+      s.add_runtime_dependency(%q<rack-flash>, [">= 0.1.1"])
+    else
+      s.add_dependency(%q<dbi>, [">= 0.4.4"])
+      s.add_dependency(%q<sinatra>, [">= 1.1.0"])
+      s.add_dependency(%q<rack-flash>, [">= 0.1.1"])
+    end
+  else
+    s.add_dependency(%q<dbi>, [">= 0.4.4"])
+    s.add_dependency(%q<sinatra>, [">= 1.1.0"])
+    s.add_dependency(%q<rack-flash>, [">= 0.1.1"])
+  end
+end
+

data/data/app.css.erb

@@ -0,0 +1,8 @@
+html, body {
+  margin: 0;
+  padding: 0;
+  background: white;
+  font-size: 9pt;
+  font-family: Verdana, Arial, Sans-Serif;
+}
+

data/data/app.rb.erb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'sinatra/base'
+
+require 'buzzard/dbi'
+require 'buzzard/helpers'
+require 'buzzard/json'
+require 'buzzard/session'
+
+require 'app/helpers'
+require 'app/home'
+
+module <%= modname %>
+  class Application < Sinatra::Base
+    include Buzzard::Helpers
+    include Buzzard::DBI
+    include Buzzard::JSON
+    include Buzzard::Session
+
+    set :public, 'public'
+    set :dbi_dsn, "DBI:Mysql:<%= appname %>"
+    set :dbi_username, "<%= appname %>"
+    set :dbi_password, "<%= appname %>"
+
+    helpers App::Helpers
+
+    register App::Home
+  end
+end
+

data/data/helpers.rb.erb

@@ -0,0 +1,4 @@
+module App
+  module Helpers
+  end
+end

data/data/home.rb.erb

@@ -0,0 +1,10 @@
+module App
+  module Home
+    def self.registered(app)
+      app.get("/") do
+        erb :index
+      end
+    end
+  end
+end
+

data/data/index.erb.erb

@@ -0,0 +1,4 @@
+<h1>Success!</h1>
+
+<p>If you're seeing this message, everything is ready to go!</p>
+

data/data/layout.erb.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= appname %> v1.0</title>
+    <link rel="stylesheet" href="/css/style.css">
+    <script type="text/javascript" src="/js/<%= appname %>.js"></script>
+  </head>
+  <body>
+    <%= "<%= yield %" + ">" %>
+  </body>
+</html>
+

data/data/server.rb.erb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', '<%= appname %>.rb')
+
+<%= modname %>::Application.run!
+

data/data/test_func.rb.erb

@@ -0,0 +1,20 @@
+require "rubygems"
+require "<%= appname %>"
+require "test/unit"
+require "rack/test"
+
+module <%= modname %>
+  class ApplicationTest < Test::Unit::TestCase
+    include Rack::Test::Methods
+
+    def app
+      <%= modname %>::Application
+    end
+
+    def test_home_works
+      get "/"
+      assert last_response.ok?
+    end
+  end
+end
+

data/lib/buzzard/dbi.rb

@@ -0,0 +1,115 @@
+require 'dbi'
+
+module Buzzard
+  module DBI
+    def with_db(&block)
+      dsn = settings.dbi_dsn
+      username = settings.dbi_username
+      password = settings.dbi_password
+
+      dbh = ::DBI.connect(dsn, username, password)
+      begin
+        return yield Wrapper.new(self, dbh)
+      ensure
+        dbh.disconnect
+      end
+    end
+
+    def with_sql(sql, *params, &block)
+      with_db do |db|
+        db.all(sql, *params, &block)
+      end
+    end
+
+    class Wrapper
+      def initialize(app, dbh)
+        @app = app
+        @dbh = dbh
+      end
+
+      def one(sql, *params)
+        sth = @dbh.prepare(sql)
+        res = nil
+        begin
+          sth.execute(*params)
+          row = sth.fetch
+          res = row.shift if row
+        ensure
+          sth.finish
+        end
+        res
+      end
+
+      def row(sql, *params)
+        sth = @dbh.prepare(sql)
+        res = nil
+        begin
+          sth.execute(*params)
+          res = sth.fetch_hash
+        ensure
+          sth.finish
+        end
+        _maybe_normalize(res)
+      end
+
+      def all(sql, *params, &block)
+        sth = @dbh.prepare(sql)
+        res = []
+        begin
+          sth.execute(*params)
+          while row=sth.fetch_hash do
+            if block
+              yield _maybe_normalize(row)
+            else
+              res << row
+            end
+          end
+        ensure
+          sth.finish
+        end
+        _maybe_normalize_all(res)
+      end
+
+      def exec(sql, *params)
+        @dbh.do(sql, *params)
+      end
+
+      def _symbolic_keys?
+        if @app.settings.respond_to?(:dbi_symbolic_keys)
+          @app.settings.dbi_symbolic_keys 
+        else
+          true
+        end
+      end
+
+      def _maybe_normalize(hash)
+        _symbolic_keys? ? _normalize(hash) : hash
+      end
+
+      def _maybe_normalize_all(arr)
+        if _symbolic_keys?
+          r = []
+          arr.each_with_index do |hash, index|
+            r[index] = _normalize(hash)
+          end
+          r
+        else
+          arr
+        end
+      end
+
+      def _normalize(hash)
+        if !hash.nil? && hash.kind_of?(Hash)
+          r = {}
+          hash.each_pair do |key,value|
+            key = key.to_s if !key.kind_of?(Symbol)
+            key = key.to_sym if key.kind_of?(String)
+            r[key] = value
+          end
+          r
+        end
+      end
+    end
+  end
+end
+

data/lib/buzzard/helpers.rb

@@ -0,0 +1,7 @@
+module Buzzard
+  module Helpers
+    include Rack::Utils
+    alias_method :h, :escape_html
+  end
+end
+

data/lib/buzzard/json.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'json'
+
+module Buzzard
+  module JSON
+    def json(obj)
+      content_type "text/json"
+      ::JSON.generate(obj)
+    end
+  end
+end
+

data/lib/buzzard/security.rb

@@ -0,0 +1,74 @@
+#
+# Simple security module providing login/logout
+#
+# Dependencies:
+#
+#   * Buzzard::Session
+#   * Buzzard::DBI (optional)
+#
+module Buzzard
+  module Security
+    module Extension
+      def self.registered(app)
+        app.get("/login") do
+          redirect "/" if logged_in?
+
+          erb :login
+        end
+
+        app.post("/login") do
+          redirect "/" if logged_in?
+
+          user = authenticate(params[:username], params[:password])
+          if !user.nil?
+            session[:user] = user
+            redirect post_auth_url
+          else
+            flash[:errors] = ["Invalid username or password"]
+            redirect "/login"
+          end
+        end
+
+        app.get("/logout") do
+          redirect "/" if !logged_in?
+
+          session.delete(:user)
+          flash[:messages] = ["You have been logged out"]
+          redirect "/login"
+        end
+      end
+    end
+
+    def self.included(base)
+      base.register Extension
+    end
+
+    def current_user
+      session[:user]
+    end
+
+    def logged_in?
+      !session[:user].nil?
+    end
+
+    #
+    # Default implementation of login. Assumes use of Sinatra::DBI.
+    #
+    def authenticate(username, password)
+      with_db do |db|
+        db.row("
+          SELECT * FROM users
+          WHERE
+            (username=? OR email=?) AND
+            password=SHA(?)
+        ", username, username, password)
+      end
+    end
+
+    #
+    # The URL a user is sent to following a successful login.
+    #
+    def post_auth_url; "/"; end
+  end
+end
+

data/lib/buzzard/session.rb

@@ -0,0 +1,21 @@
+require 'rack/flash'
+
+module Buzzard
+  module Session
+    module Extension
+      def self.registered(app)
+        app.enable :sessions
+        app.use Rack::Flash
+      end
+    end
+
+    def self.included(base)
+      base.register Extension
+    end
+
+    def flash
+      env["x-rack.flash"]
+    end
+  end
+end
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: buzzard
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Thomas Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-14 00:00:00 +11:00
+default_executable: buzzard
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dbi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 4
+        - 4
+        version: 0.4.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-flash
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id003
+description: Buzzard is a framework and application generator
+email: buzzard@tomlee.co
+executables: 
+- buzzard
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- TODO
+files: 
+- .gitignore
+- LICENSE
+- Rakefile
+- VERSION
+- bin/buzzard
+- buzzard.gemspec
+- data/app.css.erb
+- data/app.js.erb
+- data/app.rb.erb
+- data/helpers.rb.erb
+- data/home.rb.erb
+- data/index.erb.erb
+- data/layout.erb.erb
+- data/server.rb.erb
+- data/test_func.rb.erb
+- lib/buzzard/dbi.rb
+- lib/buzzard/helpers.rb
+- lib/buzzard/json.rb
+- lib/buzzard/security.rb
+- lib/buzzard/session.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/thomaslee/buzzard
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: buzzard
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Sane web app microframework built on Sinatra.
+test_files: []
+