bradphelan-sinatras-hat 0.1.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.sqlite3
+*.*.sw*
+vendor/*
+pkg/*

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2009 Pat Nakajima
+ 
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,235 @@
+# Sinatra's Hat
+
+Easy REST-ful apps with Sinatra.
+
+Using Sinatra's Hat is centered around the `mount` method, which is
+added to `Sinatra::Base`. It takes at bare minimum a model class. This
+class will be mounted as a REST-ful resource, giving you all the CRUD
+actions, as well as `new` and `edit` actions. Let's look at some code:
+
+<pre>
+mount Article
+</pre>
+
+Now you've basically got the same functionality as you'll get in Rails
+by running `script/generate scaffold Article`. The views for your `Article`
+will live in `views/articles`, and be named `index.erb`, `show.erb`, etc.
+
+You can look at my [Hatter](http://github.com/nakajima/hatter/tree/master)
+project, or the `examples/` directory in this one to see this in action.
+
+Go ahead, try it.
+
+## ORM agnostic? Or ORM atheist?
+
+By default, Sinatra's Hat works with ActiveRecord. That means that going
+to `/articles` will simply call `Article.all` to populate the `@articles`
+instance variable. Going to `/articles/2` will call `Article.find_by_id(2)`
+to populate the `@article` instance variable.
+
+We call `find_by_id` instead of `find` because the `record` option should
+simply return `nil` when the record can't be found.
+
+Not every class is an ActiveRecord though (especially if you're not using
+ActiveRecord). That's why you can use the `finder` and `record` options.
+
+This example will show you how to use DataMapper with Sinatra's Hat:
+
+<pre>
+mount Article do
+  finder { |model, params| model.all }
+  record { |model, params| model.first(:id => params[:id]) }
+end
+</pre>
+
+As you can see, both `finder` and `record` take a block, which will get
+passed the "model" and `params` for each request. The reason you should use
+the "model" argument instead of referencing the class directly is that
+when you start nesting mounted models, then Sinatra's Hat will attempt to
+pass the association proxy as the model argument instead of the class itself.
+
+"Nested mounted models?" you ask?
+
+## Nested mounted models.
+
+You don't want to have to expose your entire application at the top level
+of URL paths. That wouldn't be very RESTful, and more importantly, it'd be
+damn ugly. So Sinatra's Hat allows you to nest resources:
+
+<pre>
+mount Article do
+  mount Comment
+end
+</pre>
+
+With this example, you'd get `/articles/1/comments`, `/articles/1/comments/1`
+and all the rest of the actions you get for articles, just nested. As long
+as your `Article` model supports a `comments` association proxy, then the `finder`
+and `record` options for `Comment` will automatically scope their results by
+the parent `Article`.
+
+## Limiting routes
+
+By default, Sinatra's Hat creates seven routes for each mounted model (the
+four ones for <acronym title="Create|Read|Update|Destroy">CRUD</acronym>
+actions plus the routes for index, new and edit action), but you can reduce
+the number of available routes with `only`:
+
+<pre>
+mount Article do
+  only :index, :show
+end
+</pre>
+
+Only the listed actions will return valid responses; requests for the
+"missing" routes will produce 404 "Not Found" HTTP responses.
+
+## Basic Auth
+
+To protect actions using basic authentication, you can use the `protect` method.
+
+<pre>
+mount Article do
+  protect :create, :update, :destroy, :username => "foo", :password => "bar", :realm => "BLOGZ"
+end
+</pre>
+
+The above snippet will protect your <acronym title="Create|Update|Destroy">CUD</acronym>
+actions with basic auth, using the username "foo" and password "bar". The realm
+for the basic auth prompt will say "BLOGZ".
+
+If you want to protect all of your actions, you cay say `protect :all`.
+
+## `.xml`, `.json`, `.yaml`, and whatever else you want
+
+If a request has a format extensions, then Sinatra's Hat will first check
+to see if it has a custom way of serializing that format. To specify a 
+custom formatter, you can use the `formats` hash:
+
+<pre>
+mount Article do
+  formats[:ruby] = { |data| data.inspect }
+end
+</pre>
+
+With that custom formatter, a request to `/articles.ruby` will return
+the equivalent of `Article.all.inspect`.
+
+### Automatic formatters
+
+If you don't specify a custom formatter, then Sinatra's Hat will try to
+call `to_#{format}` on the record object. That means that with most ORMs,
+things like `to_xml`, `to_json`, and `to_yaml` will be supported right out
+of the box.
+
+Requests for unknow formats will produce 406 "Not Acceptable" HTTP responses.
+
+## Default Flows
+
+Sinatra's Hat has some default flows:
+
+### After the `create` action
+
+**On Success**: If a record is successfully created, Sinatra's Hat will redirect to that
+record's show page.
+
+**On Failure**: If a record cannot be saved, Sinatra's Hat will render the `new` action.
+
+### After the `Update` action
+
+**On Success**: If a record is successfully updated, Sinatra's Hat will redirect to that
+record's show page.
+
+**On Failure**: If a record cannot be updated, Sinatra's Hat will render the `edit` action.
+
+## Custom Flows
+
+To specify custom flows for your actions, you can use the `after` method.
+
+Let's say that after a user creates an Article, you want to render the
+article's edit action, and if it can't be created, you want to redirect
+back to the articles index.
+
+<pre>
+mount Article do
+  after :create do |on|
+    on.success { |record| render(:edit) }
+    on.failure { |record| redirect(:index) }
+  end
+end
+</pre>
+
+Only `:create` and `:update` actions allow to handle success and failure
+differently; for the other actions you can customize only the `success` result
+and if something goes wrong (i.e., when a record cannot be found) they will
+simply return a 404 "Not Found" HTTP response.
+
+### `redirect` options
+
+When specifying a custom redirect, you can pass one of a few things:
+
+#### A String
+
+When you pass `redirect` a string, the redirect will go to that string.
+
+<pre>
+after :create do |on|
+  on.success { |record| redirect("/articles/#{record.to_param}") }
+end
+</pre>
+
+#### A Record
+
+When you pass `redirect` a record, the redirect will go to the show
+action for that record.
+
+<pre>
+after :create do |on|
+  on.success { |record| redirect(record) }
+end
+</pre>
+
+#### A symbol
+
+If you pass `redirect` the name of an action as a symbol (like `:index`),
+then the redirect will go to the correct path for that option:
+
+<pre>
+after :create do |on|
+  on.success { redirect(:index) }
+end
+</pre>
+
+When the action requires a record (like `:show`), then just pass the
+record as a second argument:
+
+<pre>
+after :create do |on|
+  on.success { |record| redirect(:show, record) }
+end
+</pre>
+
+### Responding with a `render`
+
+When you want your response to just render a template, just call `render`
+with the name of the template:
+
+<pre>
+after :create do |on|
+  on.failure { |record| render(:new) }
+end
+</pre>
+
+## Todo
+
+* Make `last_modified` calls more efficient
+* Investigate other forms of caching
+
+## Other Info
+
+* [View the Lighthouse Project](http://nakajima.lighthouseapp.com/projects/24609-sinatras-hat/overview)
+* [View the CI build](http://ci.patnakajima.com/sinatra-s-hat)
+* Thanks a ton to the [Sinatra team](http://github.com/sinatra) for such an
+  awesome framework.
+
+(c) Copyright 2008-2009 Pat Nakajima. All Rights Reserved.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'spec/rake/spectask'
+require 'rake/classic_namespace'
+require 'cucumber/rake/task'
+ 
+task :default => [:spec, :features]
+ 
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ['--colour']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "bradphelan-sinatras-hat"
+    gemspec.summary = "Easy peasy CRUD with sinatra"
+    gemspec.description = "Easy peasy CRUD with sinatra"
+    gemspec.email = "bradphelan@xtargets.com"
+    gemspec.homepage = "http://github.com/bradphelan/sinatras-hat"
+    gemspec.authors = ["Pat Nakajima", "Brad Phelan" ]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Cucumber::Rake::Task.new do |c|
+  c.cucumber_opts = '--format progress'
+end
+
+namespace :sinatra do
+  desc "Clone edge Sinatra"
+  task :clone do
+    vendor_dir = File.join(File.dirname(__FILE__), 'vendor')
+    FileUtils.mkdir_p(vendor_dir)
+    puts "* cloning git://github.com/rtomayko/sinatra.git"
+    system("git clone git://github.com/rtomayko/sinatra.git #{File.expand_path(vendor_dir)}/sinatra")
+    puts "* done."
+  end
+  
+  desc "Update edge Sinatra"
+  task :pull do
+    sinatra_dir = File.join(File.dirname(__FILE__), 'vendor', 'sinatra')
+    Task["sinatra:clone"].invoke unless File.exists?(sinatra_dir)
+    
+    puts "* pulling from git://github.com/rtomayko/sinatra.git"
+    system("cd #{File.expand_path(sinatra_dir)} && git pull git://github.com/rtomayko/sinatra.git master")
+    puts "* done."
+  end 
+  
+  desc "Install edge Sinatra"
+  task :install => :pull do
+    sinatra_dir = File.join(File.dirname(__FILE__), 'vendor', 'sinatra')
+    Task["sinatra:clone"].invoke unless File.exists?(sinatra_dir)
+    puts "* installing edge sinatra"
+    system("cd #{File.expand_path(sinatra_dir)} && rake install")
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/bradphelan-sinatras-hat.gemspec

@@ -0,0 +1,145 @@
+# 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{bradphelan-sinatras-hat}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pat Nakajima", "Brad Phelan"]
+  s.date = %q{2010-03-27}
+  s.description = %q{Easy peasy CRUD with sinatra}
+  s.email = %q{bradphelan@xtargets.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bradphelan-sinatras-hat.gemspec",
+     "ci.rb",
+     "example/app-with-auth.rb",
+     "example/app-with-cache.rb",
+     "example/app.rb",
+     "example/lib/comment.rb",
+     "example/lib/common.rb",
+     "example/lib/post.rb",
+     "example/simple-app.rb",
+     "example/views/comments/index.erb",
+     "example/views/comments/show.erb",
+     "example/views/posts/index.erb",
+     "example/views/posts/new.erb",
+     "example/views/posts/show.erb",
+     "features/authenticated.feature",
+     "features/create.feature",
+     "features/destroy.feature",
+     "features/edit.feature",
+     "features/formats.feature",
+     "features/headers.feature",
+     "features/index.feature",
+     "features/layouts.feature",
+     "features/nested.feature",
+     "features/new.feature",
+     "features/only.feature",
+     "features/show.feature",
+     "features/steps/authenticated_steps.rb",
+     "features/steps/common_steps.rb",
+     "features/steps/create_steps.rb",
+     "features/steps/destroy_steps.rb",
+     "features/steps/edit_steps.rb",
+     "features/steps/format_steps.rb",
+     "features/steps/header_steps.rb",
+     "features/steps/index_steps.rb",
+     "features/steps/nested_steps.rb",
+     "features/steps/new_steps.rb",
+     "features/steps/only_steps.rb",
+     "features/steps/show_steps.rb",
+     "features/steps/update_steps.rb",
+     "features/support/env.rb",
+     "features/support/views/comments/index.erb",
+     "features/support/views/layout.erb",
+     "features/support/views/people/edit.erb",
+     "features/support/views/people/index.erb",
+     "features/support/views/people/layout.erb",
+     "features/support/views/people/new.erb",
+     "features/support/views/people/show.erb",
+     "features/update.feature",
+     "lib/core_ext/array.rb",
+     "lib/core_ext/hash.rb",
+     "lib/core_ext/module.rb",
+     "lib/core_ext/object.rb",
+     "lib/sinatras-hat.rb",
+     "lib/sinatras-hat/actions.rb",
+     "lib/sinatras-hat/authentication.rb",
+     "lib/sinatras-hat/extendor.rb",
+     "lib/sinatras-hat/hash_mutator.rb",
+     "lib/sinatras-hat/logger.rb",
+     "lib/sinatras-hat/maker.rb",
+     "lib/sinatras-hat/model.rb",
+     "lib/sinatras-hat/resource.rb",
+     "lib/sinatras-hat/responder.rb",
+     "lib/sinatras-hat/response.rb",
+     "lib/sinatras-hat/router.rb",
+     "sinatras-hat.gemspec",
+     "spec/actions/create_spec.rb",
+     "spec/actions/destroy_spec.rb",
+     "spec/actions/edit_spec.rb",
+     "spec/actions/index_spec.rb",
+     "spec/actions/new_spec.rb",
+     "spec/actions/show_spec.rb",
+     "spec/actions/update_spec.rb",
+     "spec/extendor_spec.rb",
+     "spec/fixtures/views/articles/edit.erb",
+     "spec/fixtures/views/articles/index.erb",
+     "spec/fixtures/views/articles/new.erb",
+     "spec/fixtures/views/articles/show.erb",
+     "spec/hash_mutator_spec.rb",
+     "spec/maker_spec.rb",
+     "spec/model_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/responder_spec.rb",
+     "spec/response_spec.rb",
+     "spec/router_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bradphelan/sinatras-hat}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easy peasy CRUD with sinatra}
+  s.test_files = [
+    "spec/actions/update_spec.rb",
+     "spec/actions/new_spec.rb",
+     "spec/actions/destroy_spec.rb",
+     "spec/actions/show_spec.rb",
+     "spec/actions/index_spec.rb",
+     "spec/actions/edit_spec.rb",
+     "spec/actions/create_spec.rb",
+     "spec/extendor_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/router_spec.rb",
+     "spec/response_spec.rb",
+     "spec/maker_spec.rb",
+     "spec/model_spec.rb",
+     "spec/responder_spec.rb",
+     "spec/hash_mutator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+