wd_sinatra 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Weasel Diesel Sinatra Changelog
+
+
+## 0.1.0
+
+* Updated  `sinatra_config.rb` to automatically store exceptions in
+  `rack.exception` so rack middleware like airbrake can properly make
+  use of the exceptions without exposing any details to the end users.
+
+* Added support for documenting the service params as they are defined.
+  (thanks rwfowler)
+
+```ruby
+service.params do |p|
+  p.string :email, :doc => "Email address of the recipient."
+end
+```
+
+* Started porting test helpers to facilitate API testing.
+
+* Updated the guard files. (thanks drnic)

data/lib/wd_sinatra/test_helpers.rb

@@ -3,17 +3,11 @@ require 'test/unit'
 require 'rack'
 require 'rack/test'
 require 'json'
+require 'weasel_diesel'
 require 'json_response_verification'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'bootloader')
 
-require 'minitest/autorun'
-
-ENV['NO_PRINT_ROUTES'] = 'true'
-Bootloader.start
 WeaselDiesel.send(:include, JSONResponseVerification)
 
-ActiveRecord::Base.logger = nil
-
 class Requester
   include ::Rack::Test::Methods
 
@@ -26,8 +20,12 @@ module TestApi
   module_function
 
   URL_PLACEHOLDER   = /\/*(:[a-z A-Z _]+)\/*/
-  INTERNAL_X_HEADER = AuthHelpers::INTERNAL_X_HEADER[/HTTP_(.*)/, 1] # strip the header marker added by Rack
-  MOBILE_X_HEADER   = AuthHelpers::MOBILE_X_HEADER[/HTTP_(.*)/, 1]   # strip the header marker added by Rack
+  if defined?(AuthHelpers::INTERNAL_X_HEADER)
+    INTERNAL_X_HEADER = AuthHelpers::INTERNAL_X_HEADER[/HTTP_(.*)/, 1] # strip the header marker added by Rack
+  end
+  if defined?(AuthHelpers::MOBILE_X_HEADER)
+    MOBILE_X_HEADER   = AuthHelpers::MOBILE_X_HEADER[/HTTP_(.*)/, 1]   # strip the header marker added by Rack
+  end
 
   def request(verb, uri, params={}, headers=nil)
     params ||= {}
@@ -178,27 +176,3 @@ class JsonWrapperResponse
 
   def_delegators :rest_response, :code, :headers, :raw_headers, :cookies, :status, :errors
 end
-
-
-# Custom assertions
-def assert_api_response(response=nil, message=nil)
-  response ||= TestApi.json_response
-  print response.rest_response.errors if response.status === 500
-  assert response.success?, message || ["Body: #{response.rest_response.body}", "Errors: #{response.errors}", "Status code: #{response.status}"].join("\n")
-  service = WSList.all.find{|s| s.verb == response.verb && s.url == response.uri[1..-1]}
-  raise "Service for (#{response.verb.upcase} #{response.uri[1..-1]}) not found" unless service
-  unless service.response.nodes.empty?
-    assert response.body.is_a?(Hash), "Invalid JSON response:\n#{response.body}"
-    valid, errors = service.validate_hash_response(response.body)
-    assert valid, errors.join(" & ") || message
-  end
-end
-
-def assert_api_response_with_redirection(redirection_url=nil)
-  response = TestApi.json_response
-  print response.rest_response.errors if response.status === 500
-  assert response.status == 302, "Redirection expect, but got #{response.status}"
-  if redirection_url
-    assert response.headers["location"], redirection_url
-  end
-end

data/lib/wd_sinatra/test_unit_helpers.rb

@@ -0,0 +1,26 @@
+require 'wd_sinatra/test_helpers'
+
+module TestUnitHelpers
+  # Custom assertions
+  def assert_api_response(response=nil, message=nil)
+    response ||= TestApi.json_response
+    print response.rest_response.errors if response.status === 500
+    assert response.success?, message || ["Body: #{response.rest_response.body}", "Errors: #{response.errors}", "Status code: #{response.status}"].join("\n")
+    service = WSList.all.find{|s| s.verb == response.verb && s.url == response.uri[1..-1]}
+    raise "Service for (#{response.verb.upcase} #{response.uri[1..-1]}) not found" unless service
+    unless service.response.nodes.empty?
+      assert response.body.is_a?(Hash), "Invalid JSON response:\n#{response.body}"
+      valid, errors = service.validate_hash_response(response.body)
+      assert valid, errors.join(" & ") || message
+    end
+  end
+
+  def assert_api_response_with_redirection(redirection_url=nil)
+    response = TestApi.json_response
+    print response.rest_response.errors if response.status === 500
+    assert response.status == 302, "Redirection expect, but got #{response.status}"
+    if redirection_url
+      assert response.headers["location"], redirection_url
+    end
+  end
+end

data/lib/wd_sinatra/version.rb

@@ -1,5 +1,5 @@
 module WD
   module Sinatra
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/templates/Guardfile

@@ -3,7 +3,7 @@
 
 guard 'puma' do
   watch('Gemfile.lock')
-  watch(%r{^config|lib/.*})
+  watch(%r{^config|lib|api/.*})
 end
 
 guard 'minitest', :test_file_patterns => '*_test.rb' do

data/templates/config/sinatra_config.rb

@@ -10,3 +10,9 @@ set :raise_errors, false
 # enable that option to run by calling this file automatically (without using the config.ru file)
 # enable :run
 use Rack::ContentLength
+
+# Store the caught exception in the rack env so it can be used
+# by 3rd party apps like airbrake.
+error(Sinatra::Base::Exception) do |exception|
+  @env['rack.exception'] = exception
+end

data/templates/lib/tasks/doc_generator/template.erb

@@ -72,7 +72,7 @@
                     <% api.send(rule_meth).each do |rule| %> 
                       <li>
                         <span class='label notice'><%= rule.name %></span> of type <span class='label success'><%= rule.options[:type] || 'String' %></span>
-                        <% if desc = api.doc.params_doc[rule.name.to_sym] %>
+                        <% if desc = (api.doc.params_doc[rule.name.to_sym] || rule.options[:doc]) %>
                            <%= desc %>&nbsp;
                         <% end %>
                         <% if options = rule.options[:options] %>

metadata

@@ -1,48 +1,62 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: wd_sinatra
-version: !ruby/object:Gem::Version
-  version: 0.0.2
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Matt Aimonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: weasel_diesel
-  requirement: &70130821083780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70130821083780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: thor
-  requirement: &70130821083360 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70130821083360
-description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra
-  apps using the Weasel Diesel DSL
-email:
+  version_requirements: *id002
+description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the Weasel Diesel DSL
+email: 
 - mattaimonetti@gmail.com
-executables:
+executables: 
 - wd_sinatra
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -52,6 +66,7 @@ files:
 - lib/wd_sinatra/app_loader.rb
 - lib/wd_sinatra/sinatra_ext.rb
 - lib/wd_sinatra/test_helpers.rb
+- lib/wd_sinatra/test_unit_helpers.rb
 - lib/wd_sinatra/version.rb
 - templates/Gemfile
 - templates/Guardfile
@@ -127,28 +142,36 @@ files:
 - wd-sinatra.gemspec
 homepage: https://github.com/mattetti/wd_sinatra
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
-summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps
-  using the Weasel Diesel DSL
+summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the Weasel Diesel DSL
 test_files: []
-has_rdoc: 
+