cuba-sugar-cj 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f506ff8fc03e0d2b3b062560a8ccd3c2c6bc2be
+  data.tar.gz: 44522f5a29909b4c2f8dbbeecba8f00d40f4101c
+SHA512:
+  metadata.gz: ffd3e45ac89400ae2669b0ebee717527cd66a73bc9e6b95f60e0c3f300de1acd39e2c517b41592e78507793b25b741d7f5dc4ab7a7bc2f279c67591b6f0223e2
+  data.tar.gz: a1f4d31a9d67fe11f3c705f5f43e2cf26ee4e1f2b8a3e7cbeee92a1130e9313f4a58573302135776534cfd4d0e7b83e49a5a58d913d4d4f42d1bc539d8cbe930

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    cuba-sugar (0.3.0)
+      cuba (~> 3.1.0)
+      json (~> 1.7.3)
+      rack_csrf (~> 2.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    cuba (3.1.0)
+      rack
+    cutest (1.1.3)
+    json (1.7.3)
+    rack (1.4.1)
+    rack_csrf (2.4.0)
+      rack (>= 0.9)
+    rake (0.9.2.2)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cuba-sugar!
+  cutest (~> 1.1.3)
+  rake
+  tilt (~> 1.3.3)

data/LICENSE

@@ -0,0 +1,8 @@
+/*
+ * ----------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * elcuervo wrote this file. As long as you retain this notice you
+ * can do whatever you want with this stuff. If we meet some day, and you think
+ * this stuff is worth it, you can buy me a beer in return Bruno Aguirre
+ * ----------------------------------------------------------------------------
+ */

data/README.md

@@ -0,0 +1,176 @@
+Cuba/Sugar
+==========
+
+![Build Status](https://secure.travis-ci.org/elcuervo/cuba-sugar.png)
+
+_n_. bundled sugar for [cuba](https://github.com/soveran/cuba)
+
+!["See this fucking sugar road? I just fucking made it"](http://maynardswitzer.com/library/Cuba/2002CubaSugarCaneCutterInField.A.jpg)
+
+Description
+-----------
+
+It's like contrib stuff but with a cooler name.
+Provides helpers and utilities to use with cuba.
+
+Usage
+-----
+
+Like any other cuba app, but provides:
+
+You have two choices:
+
+* `require` only the tool you want eg: `require 'cuba/sugar/content_for'`
+* `require` all the tools eg: `require 'cuba/sugar'`
+
+### content_for
+
+```ruby
+require "cuba"
+require "cuba/sugar/content_for"
+
+Cuba.plugin Cuba::Sugar::ContentFor
+```
+
+In your views to define where the content block will be rendered
+
+```erb
+<% yield_for :menu %>
+
+# And when you want to define a content
+<% content_for :menu %>
+  <ul id="menu">
+    <li class="active">Home</li>
+    <li>Users</li>
+  </ul>
+<% end %>
+```
+
+### as
+
+```ruby
+require "cuba"
+require "cuba/sugar/as"
+
+Cuba.use Rack::Session::Cookie
+
+Cuba.plugin Cuba::Sugar::As
+Cuba.define do
+  on post do
+    on "users" do
+      # create user
+      as 201, {"Content-Location" => "http://somewhere.com/users/705"} do
+        "user #{user.id} created"
+      end
+    end
+  end
+end
+```
+
+### as_json
+
+```ruby
+require "cuba"
+require "cuba/sugar/as"
+
+Cuba.use Rack::Session::Cookie
+
+Cuba.plugin Cuba::Sugar::As
+Cuba.define do
+  on get do
+    on "weather" do
+      as_json do
+        {
+          city:         'La Habana',
+          temperature:  '19 °C',
+          pressure:     '1014 hPa',
+        }
+      end
+    end
+  end
+end
+```
+
+### csrf_tag && csrf_token
+
+In the forms:
+
+```ruby
+<%= csrf_tag %>
+```
+
+In the code:
+
+```ruby
+require "cuba"
+require "cuba/sugar/csrf"
+
+Cuba.use Rack::Csrf
+
+Cuba.plugin Cuba::Sugar::Csrf
+Cuba.define do
+  # Automatic csrf validation
+  on post
+  end
+end
+```
+
+### helpers
+
+```ruby
+require "cuba"
+require "cuba/sugar"
+
+Cuba.plugin Cuba::Sugar
+Cuba.define do
+  helpers do
+    def now
+      Time.now
+    end
+  end
+
+  on "time" do
+    as { "The current time is: #{now}" }
+  end
+end
+```
+
+### subdomain
+
+```ruby
+require "cuba"
+require "cuba/sugar/routes"
+
+Cuba.plugin Cuba::Sugar::Routes
+Cuba.define do
+  on subdomain("wsdl") do
+    run WSDL
+  end
+
+  on subdomain("api") do
+    on root do
+      as do
+        "Welcome to API"
+      end
+    end
+
+    on "users" do
+      as_json do
+        Users.all.to_json
+      end
+    end
+  end
+end
+```
+
+Contributors
+------------
+
+  * [bemurphy](https://github.com/bemurphy) (Brendon Murphy)
+
+Installation
+------------
+
+```bash
+$ gem install cuba-sugar
+```

data/Rakefile

@@ -0,0 +1,8 @@
+$: << "test"
+
+task :test do
+  require "cutest"
+  Cutest.run(Dir["test/*.rb"])
+end
+
+task :default => :test

data/cuba-sugar.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = "cuba-sugar-cj"
+  s.version           = "0.3.1"
+  s.summary           = "Give Cuba some Sugar!"
+  s.description       = "Useful stuff to use with cuba"
+  s.authors           = ["elcuervo"]
+  s.email             = ["yo@brunoaguirre.com"]
+  s.homepage          = "http://github.com/elcuervo/cuba-sugar"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files test`.split("\n")
+
+  s.add_dependency("cuba",      ">= 3.1.0")
+  s.add_dependency("rack_csrf", ">= 2.4.0")
+
+  s.add_development_dependency("cutest", ">= 1.1.3")
+  s.add_development_dependency("tilt",   ">= 1.3.3")
+end

data/lib/cuba/sugar.rb

@@ -0,0 +1,28 @@
+require 'cuba/sugar/as'
+require 'cuba/sugar/csrf'
+require 'cuba/sugar/routes'
+require 'cuba/sugar/content_for'
+
+module Cuba::Sugar
+  include As
+  include Csrf
+  include Routes
+  include ContentFor
+
+  # Public: Sugar to include helpers
+  #
+  # *extensions - Modules to be evaluated
+  # &block      - Methods to be included
+  #
+  # Examples:
+  #
+  #   helpers do
+  #     def now
+  #       Time.now
+  #     end
+  #   end
+  def helpers(*extensions, &block)
+    instance_eval(&block) if block
+    extend(*extensions)   if extensions.any?
+  end
+end

data/lib/cuba/sugar/as.rb

@@ -0,0 +1,38 @@
+module Cuba::Sugar
+  module As
+    # Public: Sugar to do some common response tasks
+    #
+    # http_code     - Response status code (default: 200)
+    # extra_headers - Extra headers hash (default: {})
+    #
+    # Examples:
+    #
+    #   on post, "users" do
+    #     as 201 do
+    #       "User successfully created!"
+    #     end
+    #   end
+    def as(http_code = 200, extra_headers = {}, &block)
+      res.status = http_code
+      res.headers.merge! extra_headers
+      yield if block
+    end
+
+    # Public: Sugar to do some common response tasks as_json
+    #
+    # http_code     - Response status code (default: 200)
+    # extra_headers - Extra headers hash (default: {})
+    # Examples:
+    #
+    #   on post, "users" do
+    #     as_json 201 do
+    #       "User successfully created!"
+    #     end
+    #   end
+    def as_json(http_code = 200, extra_headers = {}, &block)
+      require 'json'
+      extra_headers["Content-Type"] ||= "application/json"
+      as(http_code, extra_headers) { yield.to_json if block }
+    end
+  end
+end

data/lib/cuba/sugar/content_for.rb

@@ -0,0 +1,35 @@
+module Cuba::Sugar
+  module ContentFor
+    # Public: yields a content in a view
+    #
+    # symbol - The symbol to be searched
+    #
+    # Examples:
+    #
+    #   <% yield_for :menu %>
+    def yield_for(symbol)
+      content_blocks[symbol].map(&:call)
+    end
+
+    # Public: Sets a content for a given symbol
+    #
+    # symbol - The symbol key
+    # &block - Block to be called
+    #
+    # Examples:
+    #
+    #   <% content_for :menu do %>
+    #     Home | Admin
+    #   <% end %>
+    def content_for(symbol, &block)
+      content_blocks[symbol] << block
+    end
+
+    private
+
+    # Private: Hash of arrays to store content blocks
+    def content_blocks
+      @content_blocks ||= Hash.new { |h, k| h[k] = [] }
+    end
+  end
+end

data/lib/cuba/sugar/csrf.rb

@@ -0,0 +1,26 @@
+require "rack/csrf"
+
+module Cuba::Sugar
+  module Csrf
+    # Public: Sugar to include a csrf tag
+    #
+    # Examples:
+    #
+    #   <form action="/new">
+    #     <%= csrf_tag %>
+    #     <input type="text" />
+    #   </form>
+    def csrf_tag
+      Rack::Csrf.tag(env)
+    end
+
+    # Public: Sugar to access the csrf token
+    #
+    # Examples:
+    #
+    #   <%= csrf_token %>
+    def csrf_token
+      Rack::Csrf.token(env)
+    end
+  end
+end

data/lib/cuba/sugar/routes.rb

@@ -0,0 +1,31 @@
+module Cuba::Sugar
+  module Routes
+    # Public: Sugar to access an option verb
+    #
+    # Examples:
+    #
+    #   on options do
+    #     as_json do
+    #       API.interaction_methods
+    #     end
+    #   end
+    def options
+      req.options?
+    end
+
+    # Public: Sugar to do match a given subdomain. eg. blog.example.com
+    #
+    # subdomain - subdomain to be checked
+    #
+    # Examples:
+    #
+    #   on subdomain("blog") do
+    #     as do
+    #       run Blog
+    #     end
+    #   end
+    def subdomain(sub)
+      sub == req.host.split(".").first
+    end
+  end
+end

data/test/as.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+require "cuba/sugar/as"
+
+test "set status and headers through helper" do
+  Cuba.plugin Cuba::Sugar::As
+  Cuba.define do
+    on "users" do
+      as 201, {"Content-Location" => "http://somewhere.com/users/705"} do
+        "User Created"
+      end
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/users" }
+
+  code, headers, resp = Cuba.call(env)
+
+  assert_equal 201, code
+  assert_equal ["User Created"], resp
+  assert_equal "http://somewhere.com/users/705", headers["Content-Location"]
+end
+
+test "set a block to return json" do
+  rum_and_coke = { "rum" => "hot", "coke" => "sweet" }
+
+  Cuba.plugin Cuba::Sugar::As
+  Cuba.define do
+    on "drinks" do
+      as_json 201, {"Content-Location" => "http://somewhere.com/drinks/42"} do
+        rum_and_coke
+      end
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/drinks" }
+
+  code, headers, resp = Cuba.call(env)
+
+  assert_equal 201, code
+  assert_equal "application/json", headers["Content-Type"]
+  assert_equal [rum_and_coke.to_json], resp
+  assert_equal "http://somewhere.com/drinks/42", headers["Content-Location"]
+end

data/test/content_for.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "cuba/render"
+require "cuba/sugar/content_for"
+
+scope do
+  setup do
+    Cuba.plugin Cuba::Render
+    Cuba.plugin Cuba::Sugar::ContentFor
+
+    Cuba.settings[:render][:views] = "./test/views"
+    Cuba.settings[:render][:template_engine] = "erb"
+
+    Cuba.define do
+      on root do
+        res.write view("home")
+      end
+    end
+  end
+
+  test "content for the menu" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/", "SCRIPT_NAME" => "/" })
+
+    assert_equal body, ["  alpha\nbeta\ngamma\n\n"]
+  end
+end

data/test/csrf.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "cuba/render"
+require "cuba/sugar/as"
+require "cuba/sugar/csrf"
+
+test "set status and headers through helper" do
+  Cuba.plugin Cuba::Sugar::As
+  Cuba.plugin Cuba::Sugar::Csrf
+  Cuba.plugin Cuba::Render
+  Cuba.define do
+    on "users" do
+      as do
+        render "test/fixtures/csrf.erb"
+      end
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/users", "rack.session" => {} }
+
+  code, headers, resp = Cuba.call(env)
+
+  assert env.fetch("rack.session").has_key?("csrf.token")
+  assert /_csrf/ =~ resp.first
+  assert_equal 44, env.fetch("rack.session").fetch("csrf.token").size
+end

data/test/fixtures/csrf.erb

@@ -0,0 +1,5 @@
+<form method="post" action="/secure">
+  <%= csrf_tag %>
+  <input type="text" name="message"/>
+  <input type="submit" value="Submit!"/>
+</form>

data/test/helpers.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "cuba/sugar"
+
+test "set status and headers through helpers" do
+  Cuba.plugin Cuba::Sugar
+  Cuba.define do
+    helpers do
+      def upperize(string)
+        string.upcase
+      end
+    end
+
+    on "users" do
+      as do
+        "I will shout: #{upperize("hello")}"
+      end
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/users" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["I will shout: HELLO"], resp
+end

data/test/routes.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+require "cuba/sugar/as"
+require "cuba/sugar/routes"
+
+test "eval only in a given subdomain" do
+  Cuba.plugin Cuba::Sugar::As
+  Cuba.plugin Cuba::Sugar::Routes
+  Cuba.define do
+    on subdomain("api"), root do
+      as do
+        "Subdomain"
+      end
+    end
+
+    on root do
+      as do
+        "Main"
+      end
+    end
+  end
+
+  subdomain_env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/", "HTTP_HOST" => "api.example.com" }
+  standard_env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/", "HTTP_HOST" => "example.com" }
+
+  _, _, sub_resp = Cuba.call(subdomain_env)
+  _, _, resp = Cuba.call(standard_env)
+
+  assert_equal ["Subdomain"], sub_resp
+  assert_equal ["Main"], resp
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$: << "lib"
+
+require "cuba"
+require "cutest"
+
+prepare { Cuba.reset! }

data/test/views/home.erb

@@ -0,0 +1,4 @@
+gamma
+<% content_for :menu do %>
+  alpha
+<% end %>

data/test/views/layout.erb

@@ -0,0 +1,4 @@
+<% yield_for :menu %>
+<% yield_for :not %>
+beta
+<%= content %>

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: cuba-sugar-cj
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- elcuervo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rack_csrf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: Useful stuff to use with cuba
+email:
+- yo@brunoaguirre.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- cuba-sugar.gemspec
+- lib/cuba/sugar.rb
+- lib/cuba/sugar/as.rb
+- lib/cuba/sugar/content_for.rb
+- lib/cuba/sugar/csrf.rb
+- lib/cuba/sugar/routes.rb
+- test/as.rb
+- test/content_for.rb
+- test/csrf.rb
+- test/fixtures/csrf.erb
+- test/helpers.rb
+- test/routes.rb
+- test/test_helper.rb
+- test/views/home.erb
+- test/views/layout.erb
+homepage: http://github.com/elcuervo/cuba-sugar
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Give Cuba some Sugar!
+test_files:
+- test/as.rb
+- test/content_for.rb
+- test/csrf.rb
+- test/fixtures/csrf.erb
+- test/helpers.rb
+- test/routes.rb
+- test/test_helper.rb
+- test/views/home.erb
+- test/views/layout.erb
+has_rdoc: