wd_sinatra 1.0.6 → 2.0.0

data/templates/api/hello_world.rb

@@ -1,10 +1,18 @@
 describe_service "/hello_world" do |service|
-  service.formats   :json
+  service.formats   :json, :xml
   service.http_verb :get
   service.disable_auth # on by default
 
+  # DOCUMENTATION
+  service.documentation do |doc|
+    doc.overall "Be polite and say hello"
+    doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
+  end
+
   # INPUT
-  service.param.string  :name, :default => 'World'
+  service.params do |p|
+    p.string  :name, :default => 'World'
+  end
 
   # OUTPUT
   service.response do |response|
@@ -14,16 +22,15 @@ describe_service "/hello_world" do |service|
     end
   end
 
-  # DOCUMENTATION
-  service.documentation do |doc|
-    doc.overall "This service provides a simple hello world implementation example."
-    doc.param :name, "The name of the person to greet."
-    doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
-  end
-
   # ACTION/IMPLEMENTATION
   service.implementation do
-    {:message => "Hello #{params[:name]}", :at => Time.now}.to_json
+    data = {:message => "Hello #{params[:name]}", :at => Time.now}
+    case env["wd.format"]
+    when :json
+      data.to_json
+    when :xml
+      # data.to_xml # serialize to xml
+    end
   end
 
 end

data/templates/bin/console

@@ -5,5 +5,5 @@ require 'bundler'
 Bundler.setup
 require 'wd_sinatra/app_loader'
 root = File.expand_path('..', File.dirname(__FILE__))
-WDSinatra::AppLoader.console(root)
+WDSinatra::AppLoader.setup(root)
 IRB.start(__FILE__)

data/templates/config.ru.tt

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'wd_sinatra/app_loader'
+root = File.expand_path(File.dirname(__FILE__))
+WDSinatra::AppLoader.setup(root)
+WDSinatra::AppLoader.server(<%= name_const %>)
+map("/") { run <%= name_const %> }

data/templates/config/sinatra_config.rb.tt

@@ -0,0 +1,50 @@
+class <%= name_const %> < Sinatra::Base
+  set :environment, RACK_ENV
+  set :root, WDSinatra::AppLoader.root_path
+  set :app_file, __FILE__
+  set :public_folder, File.join(WDSinatra::AppLoader.root_path, "public")
+  set :method_override, true
+
+  # enable logging in certain environments
+  configure :development, :production do
+    enable :logging
+  end
+
+  # Checks on static files before dispatching calls
+  enable :static
+
+  # enable rack session
+  enable :session
+
+  set :raise_errors, false
+
+  # enable that option to run by calling this file automatically (without using the config.ru file)
+  # enable :run
+
+  # Store the caught exception in the rack env so it can be used
+  # by 3rd party apps like airbrake.
+  error(::Exception) do |exception|
+    @env['rack.exception'] = exception
+  end
+
+  # Use this middleware with AR to avoid threading issues.
+  # require 'active_record'
+  # use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+  use Airbrake::Rack if defined?(Airbrake)
+
+  use Rack::ContentLength
+
+  require "rack/parser"
+  use Rack::Parser
+
+  if defined?(NewRelic)
+    #if RACK_ENV == 'development'
+      #require 'new_relic/rack/developer_mode'
+      #use NewRelic::Rack::DeveloperMode
+    #end
+    if NewRelic::Agent.config[:agent_enabled]
+      LOGGER.info "New Relic monitoring enabled App name: '#{NewRelic::Control.instance['app_name']}', Mode: '#{NewRelic::Control.instance.app}'"
+    end
+  end
+end

data/templates/lib/{app.rb → app.rb.tt}

@@ -13,7 +13,7 @@ if File.exist?(airbrake_config_file)
     require 'airbrake'
     Airbrake.configure do |config|
       config.api_key = airbrake_config['api_key']
-      (airbrake_config['params_filters'] - config.params_filters).each do |param| 
+      (airbrake_config['params_filters'] - config.params_filters).each do |param|
         config.params_filters << param
       end
       config.environment_name = RACK_ENV
@@ -22,3 +22,6 @@ if File.exist?(airbrake_config_file)
     end
   end
 end
+
+class <%= name_const %> < Sinatra::Base
+end

data/templates/lib/hooks.rb

@@ -1,13 +1,13 @@
-require 'body_parser' # from the lib folder
-# Change the JSON parser if you want to use Yajl for instance.
-require 'json'
-BodyParser.json_parser = JSON
-
 module WDSinatraHooks
 
   MOBILE_X_HEADER   = 'HTTP_X_MOBILE_TOKEN'
   INTERNAL_X_HEADER = 'HTTP_X_INTERNAL_API_KEY'
-  JSON_BODY_VERBS   =  %w(POST PUT DELETE)
+  SUPPORTED_MEDIA_TYPES = {
+    "application/json" => :json,
+    "application/xml" => :xml,
+    # add custom media types here, for example:
+    # "application/vnd.example+json" => :json,
+  }
 
   ####### HOOKS #############################
   #
@@ -21,18 +21,13 @@ module WDSinatraHooks
   # @param [Hash] params the incoming params.
   # processed.
   # @returns [Hash] the pre processed params.
-  def params_preprocessor_hook(params)
-    if JSON_BODY_VERBS.include?(request.request_method)
-      BodyParser.parse(params, request.body, request.content_type)
-    else
-      params
-    end
-  end
+  # def params_preprocessor_hook(params)
+  # end
 
 
   # This hooks gets called when an exception is raised while preprocessing the params,
   # verifying them or post processing them.
-  # If this method isn't defined, the default handler is used (a 400 error is returned with the 
+  # If this method isn't defined, the default handler is used (a 400 error is returned with the
   # exception message sent back as a json.
   #
   # @param [Exception] exception The exception that was rescued.
@@ -53,9 +48,24 @@ module WDSinatraHooks
 
   # This hook gets called before dispatching any
   # requests.
-  # 
+  #
   # Implementation example
   def pre_dispatch_hook
+    # content negotiation
+    accept = env["rack-accept.request"]
+    if accept
+      service_media_types = SUPPORTED_MEDIA_TYPES.select {|k,v| service.formats.include?(v)}
+      env["wd.media_type"] = accept.media_type.best_of(service_media_types.keys)
+      halt 406 unless env["wd.media_type"]
+      env["wd.format"] =  SUPPORTED_MEDIA_TYPES[env["wd.media_type"]]
+    else
+      env["wd.media_type"] = "*/*"
+      env["wd.format"] =  service.formats.first
+      halt 406 unless env["wd.format"] # 406 if no defined service.formats
+    end
+
+    content_type env["wd.format"], charset: "utf-8"
+
     if service.extra[:mobile]
       mobile_auth_check
     elsif service.extra[:internal]

data/templates/test/{test_helpers.rb → test_helpers.rb.tt}

@@ -8,21 +8,23 @@ require 'wd_sinatra/test_helpers'
 
 ENV['DONT_PRINT_ROUTES'] = 'true'
 root = File.expand_path('..', File.dirname(__FILE__))
-WDSinatra::AppLoader.server(root)
+WDSinatra::AppLoader.setup(root)
+WDSinatra::AppLoader.server(<%= name_const %>)
 WeaselDiesel.send(:include, JSONResponseVerification)
 
-if RUBY_VERSION =~ /1.8/
-  require 'minitest/autorun'
-end
-
 require 'wd_sinatra/test_unit_helpers'
 include TestUnitHelpers
 
 TestApi.auth_request_x_header = WDSinatraHooks::INTERNAL_X_HEADER[/HTTP_(.*)/, 1] # strip the header marker added by Rack
 TestApi.mobile_request_x_header = WDSinatraHooks::MOBILE_X_HEADER[/HTTP_(.*)/, 1]   # strip the header marker added by Rack
 
-module TestApi
+class Requester
+  def app
+    <%= name_const %>.new
+  end
+end
 
+module TestApi
   # Edit this method to reflect your own Auth strategy
   def self.valid_internal_api_headers(headers)
     custom_headers = {TestApi.auth_request_x_header => WDSinatraHooks::ALLOWED_API_KEYS[0]}

data/test/test_helper.rb

@@ -3,10 +3,6 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 require 'test/unit'
-if RUBY_VERSION.to_f < 1.9
-  require 'minitest/autorun'
-end
 
 $: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'wd_sinatra'
-

data/test/ws_list_ext_test.rb

@@ -1,5 +1,5 @@
 require 'uri'
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+require_relative 'test_helper'
 
 class WsListExtTest < MiniTest::Unit::TestCase
 
@@ -27,11 +27,11 @@ class WsListExtTest < MiniTest::Unit::TestCase
 
   # A snapshot of a working sorting of url array
   # The sorting doesn't have to actually be similar to that
-  # but this allows us to have a baseline to measure against in case 
+  # but this allows us to have a baseline to measure against in case
   # of tests.
   def expected_sorted_urls
     [
-      "/foo/bar/bazz", 
+      "/foo/bar/bazz",
       "/foo/bart",
       "/foo/bar/",
       "/foo/bar/:baz",
@@ -44,9 +44,9 @@ class WsListExtTest < MiniTest::Unit::TestCase
   def matched_route(url_query, reference_urls)
     sorted_regexps = reference_urls.map do |url|
       ignore = ""
-      pattern = url.gsub(/[^\?\%\\\/\:\*\w]/){ |c| 
+      pattern = url.gsub(/[^\?\%\\\/\:\*\w]/){ |c|
         ignore << escaped(c).join if c.match(/[\.@]/)
-        char_encoded(c) 
+        char_encoded(c)
       }
       pattern.gsub!(/((:\w+)|\*)/) do |match|
         if match == "*"
@@ -78,7 +78,7 @@ class WsListExtTest < MiniTest::Unit::TestCase
     assert_equal nil, matched_route("/fooz", base_urls), "shouldn't match /fooz"
     assert_equal nil, matched_route("/foo/bar/baz/baz", base_urls), "shouldn't match /foo/bar/baz/baz"
     assert_equal nil, matched_route("/foo/", base_urls), "shouldn't match /foo/"
-    assert_equal "/foo/([^/?#]+)/bazz", matched_route("/foo/123/bazz", base_urls), "Should match /foo/123/bazz" 
+    assert_equal "/foo/([^/?#]+)/bazz", matched_route("/foo/123/bazz", base_urls), "Should match /foo/123/bazz"
   end
 
   def test_route_matching_expectations

data/wd-sinatra.gemspec

@@ -1,5 +1,7 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/wd_sinatra/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wd_sinatra/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Matt Aimonetti"]
@@ -13,15 +15,17 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "wd_sinatra"
   gem.require_paths = ["lib"]
-  gem.version       = WD::Sinatra::VERSION
+  gem.version       = WDSinatra::VERSION
+  gem.license       = 'MIT'
 
   gem.add_dependency('sinatra', ">= 1.3.3")
   gem.add_dependency('rake')
-  gem.add_dependency('weasel_diesel', ">= 1.2.1")
+  gem.add_dependency('weasel_diesel', ">= 1.2.2")
   gem.add_dependency('rack', ">= 1.4.4")
+  gem.add_dependency('rack-parser', ">= 0.2.0")
+  gem.add_dependency('rack-accept', ">= 0.4.5")
   gem.add_dependency('rack-test')
   gem.add_dependency('thor')
-  gem.add_dependency('minitest')
+  gem.add_dependency('minitest', "~> 4.7.4")
+  gem.add_dependency('inflecto')
 end
-
-

metadata

@@ -1,126 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: wd_sinatra
 version: !ruby/object:Gem::Version
-  version: 1.0.6
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Aimonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: weasel_diesel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: rack-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rack-accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra
@@ -149,109 +176,50 @@ files:
 - lib/wd_sinatra/ws_list_ext.rb
 - templates/Gemfile
 - templates/Guardfile
-- templates/Rakefile
+- templates/Rakefile.tt
 - templates/Thorfile
 - templates/api/hello_world.rb
 - templates/bin/console
-- templates/config.ru
+- templates/config.ru.tt
 - templates/config/airbrake.yml.sample
 - templates/config/environments/default.rb
 - templates/config/environments/production.rb
 - templates/config/environments/test.rb
-- templates/config/middleware.rb
-- templates/config/sinatra_config.rb
-- templates/lib/app.rb
-- templates/lib/body_parser.rb
+- templates/config/sinatra_config.rb.tt
+- templates/lib/app.rb.tt
 - templates/lib/hooks.rb
 - templates/lib/newrelic_instrumentation.rb
-- templates/lib/tasks/doc.rake
-- templates/lib/tasks/doc_generator/bootstrap/.gitignore
-- templates/lib/tasks/doc_generator/bootstrap/LICENSE
-- templates/lib/tasks/doc_generator/bootstrap/Makefile
-- templates/lib/tasks/doc_generator/bootstrap/README.md
-- templates/lib/tasks/doc_generator/bootstrap/bootstrap.css
-- templates/lib/tasks/doc_generator/bootstrap/bootstrap.min.css
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/css/docs.css
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/ico/bootstrap-apple-114x114.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/ico/bootstrap-apple-57x57.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/ico/bootstrap-apple-72x72.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/ico/favicon.ico
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/bird.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/browsers.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/example-diagram-01.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/example-diagram-02.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/example-diagram-03.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/grid-18px.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/img/twitter-logo-no-bird.png
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/js/application.js
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/js/google-code-prettify/prettify.css
-- templates/lib/tasks/doc_generator/bootstrap/docs/assets/js/google-code-prettify/prettify.js
-- templates/lib/tasks/doc_generator/bootstrap/docs/index.html
-- templates/lib/tasks/doc_generator/bootstrap/docs/javascript.html
-- templates/lib/tasks/doc_generator/bootstrap/examples/container-app.html
-- templates/lib/tasks/doc_generator/bootstrap/examples/fluid.html
-- templates/lib/tasks/doc_generator/bootstrap/examples/hero.html
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-alerts.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-buttons.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-dropdown.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-modal.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-popover.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-scrollspy.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-tabs.js
-- templates/lib/tasks/doc_generator/bootstrap/js/bootstrap-twipsy.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/index.html
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-alerts.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-buttons.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-dropdown.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-modal.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-popover.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-scrollspy.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-tabs.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/unit/bootstrap-twipsy.js
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/vendor/qunit.css
-- templates/lib/tasks/doc_generator/bootstrap/js/tests/vendor/qunit.js
-- templates/lib/tasks/doc_generator/bootstrap/lib/bootstrap.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/forms.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/mixins.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/patterns.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/reset.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/scaffolding.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/tables.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/type.less
-- templates/lib/tasks/doc_generator/bootstrap/lib/variables.less
-- templates/lib/tasks/doc_generator/template.erb
 - templates/public/favicon.ico
 - templates/test/integration/hello_world_test.rb
-- templates/test/test_helpers.rb
+- templates/test/test_helpers.rb.tt
 - test/test_helper.rb
 - test/ws_list_ext_test.rb
 - wd-sinatra.gemspec
 homepage: https://github.com/mattetti/wd-sinatra
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps
   using the Weasel Diesel DSL
 test_files:
 - test/test_helper.rb
 - test/ws_list_ext_test.rb
-has_rdoc: