cuba-sugar 0.2.1 → 0.2.2

data/README.md

@@ -26,6 +26,7 @@ require "cuba/sugar"
 
 Cuba.use Rack::Session::Cookie
 
+Cuba.plugin Cuba::Sugar
 Cuba.define do
   on post do
     on "users" do
@@ -46,6 +47,7 @@ require "cuba/sugar"
 
 Cuba.use Rack::Session::Cookie
 
+Cuba.plugin Cuba::Sugar
 Cuba.define do
   on get do
     on "weather" do
@@ -77,6 +79,7 @@ require "cuba/sugar"
 
 Cuba.use Rack::Csrf
 
+Cuba.plugin Cuba::Sugar
 Cuba.define do
   # Automatic csrf validation
   on post
@@ -90,6 +93,7 @@ end
 require "cuba"
 require "cuba/sugar"
 
+Cuba.plugin Cuba::Sugar
 Cuba.define do
   helpers do
     def now
@@ -109,6 +113,7 @@ end
 require "cuba"
 require "cuba/sugar"
 
+Cuba.plugin Cuba::Sugar
 Cuba.define do
   on subdomain("wsdl") do
     run WSDL

data/cuba-sugar.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name              = "cuba-sugar"
-  s.version           = "0.2.1"
+  s.version           = "0.2.2"
   s.summary           = "Give Cuba some Sugar!"
-  s.description       = "Bundled contrib utils to use with cuba"
+  s.description       = "Useful stuff to use with cuba-contrib"
   s.authors           = ["elcuervo"]
   s.email             = ["yo@brunoaguirre.com"]
   s.homepage          = "http://github.com/elcuervo/cuba-sugar"
@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.test_files        = `git ls-files test`.split("\n")
 
   s.add_dependency("cuba")
+  s.add_dependency("cuba-contrib")
   s.add_dependency("json")
   s.add_dependency("rack_csrf")
 

data/lib/cuba/sugar.rb

@@ -1,11 +1,36 @@
-require 'json'
+require "cuba/contrib"
 require "rack/csrf"
 
-class Cuba
+module Cuba::Sugar
 
+  # Sugar to access root of a page
+  #
+  # @example
+  # on post, root do
+  #   as do
+  #     "Welcome!"
+  #   end
+  # end
   def root; "" end
+
+  # Sugar to access an option verb
+  #
+  # @example
+  # on options do
+  #   as_json do
+  #     API.interaction_methods
+  #   end
+  # end
   def options; req.options? end
 
+  # Sugar to easily access params
+  #
+  # @example
+  # on get, root do
+  #   as do
+  #     "This id: #{params['id']}"
+  #   end
+  # end
   def params; req.params end
 
   # Sugar to do some common response tasks
@@ -22,36 +47,86 @@ class Cuba
     res.write yield if block_given?
   end
 
+  # Sugar to do some common response tasks as_json
+  #
+  # @example
+  # on post, "users" do
+  #   as_json 201 do
+  #     "User successfully created!"
+  #   end
+  # end
   def as_json(http_code = 200, extra_headers = {})
+    require 'json'
     extra_headers["Content-Type"] ||= "application/json"
     as(http_code, extra_headers) do
       (yield).to_json if block_given?
     end
   end
 
+  # Sugar to do match a given subdomain.
+  # eg. blog.example.com
+  #
+  # @example
+  # on subdomain("blog") do
+  #   as do
+  #     run Blog
+  #   end
+  # end
   def subdomain(sub)
     sub == req.host.split(".").first
   end
 
+  # Sugar to access session info
+  #
+  # @example
+  # on root do
+  #   as do
+  #     "User name: #{session['name']}"
+  #   end
+  # end
   def session
     env["rack.session"]
   end
 
+  # Sugar to redirect a request
+  #
+  # @example
+  # on "old" do
+  #   redirect "/new"
+  # end
   def redirect(*args)
     res.redirect(*args)
-    @matched = true
   end
 
-  # From sinatra/base
+  # Sugar to include helpers and access them from
+  # views
+  #
+  # @example
+  # helpers do
+  #   def now
+  #     Time.now
+  #   end
+  # end
   def helpers(*extensions, &block)
     instance_eval(&block) if block_given?
     extend(*extensions)   if extensions.any?
   end
 
+  # Sugar to include a csrf tag
+  #
+  # @example
+  # <form action="/new">
+  #   <%= csrf_tag %>
+  #   <input type="text" />
+  # </form>
   def csrf_tag
     Rack::Csrf.tag(env)
   end
 
+  # Sugar to access the csrf token
+  #
+  # @example
+  # <%= csrf_token %>
   def csrf_token
     Rack::Csrf.token(env)
   end

data/test/as.rb

@@ -1,6 +1,7 @@
 require File.expand_path("helper", File.dirname(__FILE__))
 
 test "set status and headers through helper" do
+  Cuba.plugin Cuba::Sugar
   Cuba.define do
     on "users" do
       as 201, {"Content-Location" => "http://somewhere.com/users/705"} do

data/test/as_json.rb

@@ -3,6 +3,8 @@ require 'json'
 
 test "set a block to return json" do
   rum_and_coke = { "rum" => "hot", "coke" => "sweet" }
+
+  Cuba.plugin Cuba::Sugar
   Cuba.define do
     on "drinks" do
       as_json 201, {"Content-Location" => "http://somewhere.com/drinks/42"} do

data/test/csrf.rb

@@ -1,6 +1,7 @@
 require File.expand_path("helper", File.dirname(__FILE__))
 
 test "set status and headers through helper" do
+  Cuba.plugin Cuba::Sugar
   Cuba.define do
     on "users" do
       as do

data/test/helpers.rb

@@ -1,6 +1,7 @@
 require File.expand_path("helper", File.dirname(__FILE__))
 
 test "set status and headers through helpers" do
+  Cuba.plugin Cuba::Sugar
   Cuba.define do
     helpers do
       def upperize(string)

data/test/redirect.rb

@@ -0,0 +1,17 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "redirect helper" do
+  Cuba.plugin Cuba::Sugar
+  Cuba.define do
+    on "old" do
+      redirect "/new"
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/old" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal 302, resp.status
+  assert_equal "/new", resp.headers["Location"]
+end

data/test/subdomain.rb

@@ -1,6 +1,7 @@
 require File.expand_path("helper", File.dirname(__FILE__))
 
 test "eval only in a given subdomain" do
+  Cuba.plugin Cuba::Sugar
   Cuba.define do
     on subdomain("api"), root do
       as do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuba-sugar
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000Z
+date: 2011-12-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuba
-  requirement: &70347365836240 !ruby/object:Gem::Requirement
+  requirement: &70204609640940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70347365836240
+  version_requirements: *70204609640940
+- !ruby/object:Gem::Dependency
+  name: cuba-contrib
+  requirement: &70204609640500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70204609640500
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70347365835400 !ruby/object:Gem::Requirement
+  requirement: &70204605330560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70347365835400
+  version_requirements: *70204605330560
 - !ruby/object:Gem::Dependency
   name: rack_csrf
-  requirement: &70347365834740 !ruby/object:Gem::Requirement
+  requirement: &70204605330140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70347365834740
+  version_requirements: *70204605330140
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &70347365834080 !ruby/object:Gem::Requirement
+  requirement: &70204605329720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,8 +65,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70347365834080
-description: Bundled contrib utils to use with cuba
+  version_requirements: *70204605329720
+description: Useful stuff to use with cuba-contrib
 email:
 - yo@brunoaguirre.com
 executables: []
@@ -75,6 +86,7 @@ files:
 - test/fixtures/csrf.erb
 - test/helper.rb
 - test/helpers.rb
+- test/redirect.rb
 - test/subdomain.rb
 homepage: http://github.com/elcuervo/cuba-sugar
 licenses: []
@@ -107,4 +119,5 @@ test_files:
 - test/fixtures/csrf.erb
 - test/helper.rb
 - test/helpers.rb
+- test/redirect.rb
 - test/subdomain.rb