wd_sinatra 1.0.6 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcfdd3f7270b9b8af82313f82834e1a552ce38b0
+  data.tar.gz: 329ae8fdcadd521ca9b2e9897bc345f3845dcdf1
+SHA512:
+  metadata.gz: 7de8b03a85a980d0c46f5745a41d40ee6bdaef49fada627559f8ebdfc047a81cc8d445c69d2177c9e34e30e8e13858f4cfe3ba20e37e0fe68ecb6fe538ad938f
+  data.tar.gz: 9b5d02e48b015b6c811927d80f3f81dc7bf8a361483490f3209232c904a3811853ea1d2e6865fbed5bb3599f1dc9ac04f4752c9c158d10bb0b11993b02e98363

data/.travis.yml

@@ -1,15 +1,12 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-18mode
+  - 2.0.0
   - rbx-19mode
   - ruby-head
   - jruby-head
-  - ree
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-18mode

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Weasel Diesel Sinatra Changelog
 
+## 2.0.0:
+### Major Changes (Backwards Incompatible)
+* Switch generated Sinatra app from classic to modular style.
+* Set content_type depending on service.formats and http accept header.
+* Drop support for ruby `1.8.7`.
+
+### New Features
+* Replace custom BodyParser with `rack-parser` middleware.
+* Use `rerun` gem for auto code reloading in development/test.
+* Wrap doc generation from WeaselDiesel::CLI. Documentation is
+generated via thor now, instead of rake.
+* Update doc generation to support optional namespaces.
+* Simpler, more compact documentation template.
+  Removes `WD::Response::Element#to_html` and Bootstrap dependencies.
+* Remove activesupport as a dependency, use inflecto for inflection support.
+
+### Resolved issues
+* Fix conflict with current Sinatra's `template`.
+* Fix ul tag not rendering in doc generator.
+
 ## 1.0.6
 * Updated various dependencies to get the latest versions of WD, Rack,
 Sinatra to get the bug & security fixes.

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wd-sinatra.gemspec
-gem 'backports', '2.3.0', :platform => 'ruby_18'
-gem 'json', :platform => 'ruby_18'
 gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2012 Matt Aimonetti
+MIT: http://mattaimonetti.mit-license.org
+
+Copyright (c) 2013 Matt Aimonetti
 
 MIT License
 
@@ -19,4 +21,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/mattetti/wd-sinatra.png?branch=master)](https://next.travis-ci.org/mattetti/wd-sinatra)
 
-Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the Weasel Diesel DSL
+Weasel Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the [Weasel-Diesel](https://github.com/mattetti/Weasel-Diesel) DSL.
 
 
 ## Installation
@@ -38,16 +38,15 @@ The app is now ready to use, to start it you can use rack:
 This will start the server on port 9292 and the default GET `/hello_world` service will be available at: `http://localhost:9292/hello_world'.
 
 Note that the code won't be reloading automatically in the server when
-you make a modification to the source code. For that, you might want to
-use Puma + [Guard](https://github.com/jc00ke/guard-puma) or another tool that allows you to do that.
-While it's a nice feature to have, a lot of developers like to do that
-differently and it seems more sensitive to let them pick the way they
-like the most.
+you make a modification to the source code. For that, we include
+[rerun](https://github.com/alexch/rerun), which is only enabled in the
+development and test environments. Use it like this:
 
+    $ bundle exec rerun -- rackup
 
 ### Generating a new service
 
-You need to have thor installed for that, you might want to add it yo
+You need to have thor and active support installed for that, you might want to add it to
 your gemfile.
 
     $ thor :service get /foo/bar foo_bar.rb
@@ -73,15 +72,19 @@ $abspath/../../bin/console
 
 ### ORM
 
-By default the generated app doesn't come with any ORMs, but if you want to use ActiveRecord, you can use this gem:
-[wd_sinatra_active_record](https://github.com/mattetti/wd_sinatra_active_record)
+By default the generated app doesn't come with any ORMs, but if you want to use ActiveRecord, you can use these gems:
+
+* [wd_sinatra_active_record](https://github.com/mattetti/wd_sinatra_active_record)
+* [wd_sinatra_sequel](https://github.com/kamui/wd_sinatra_sequel)
 
 
 ### Documentation generation
 
-    $ rake doc:services
+```bash
+    $ thor generate_doc <DESTINATION PATH>
+```
 
-To generate documentation for the APIs you created in the api folder.
+To generate documentation for the APIs you created in the api folder. The destination is optional, 'doc' is the default.
 
 ### Testing
 
@@ -156,7 +159,7 @@ TODO see Weasel Diesel for now and the generated service example.
 
 ### app.rb
 
-The `config/app.rb` file is being required after the environment is set
+The `lib/app.rb` file is being required after the environment is set
 but before the models are loaded. This is the perfect place to load
 custom libraries and set your datastore.
 
@@ -201,22 +204,28 @@ These hooks have access to the entire request context, including the
 `service` being called. You can use the service `extra` option to set
 some custom settings that can then be used in this pre dispatch hook.
 
-In the default generated application, a body parser is provided to parse
-JSON requests when the HTTP verb is PUT, POST or DELETE. The json parser is set by default to use the `JSON` module but you might want to change it to use Yajl for instance.
-To do that, edit the `config/hooks.rb` file and change the following:
+In the default generated application, [rack-parser](https://github.com/achiu/rack-parser)
+is used to parse the body of json requests. By default, this uses the `JSON`
+to parse the body. This can be [overwritten](https://github.com/achiu/rack-parser#content-type-parsing)
+if you choose.
+
+Say you want to use [Oj](https://github.com/ohler55/oj) instead. To do
+that, edit the `config/sinatra_config.rb` file and change the following:
 
 ```ruby
-BodyParser.json_parser = JSON
+  use Rack::Parser
 ```
 
 to:
 
 ```ruby
-BodyParser.json_parser = Yajl::Parser
+  use Rack::Parser, :parsers => {
+    'application/json' => proc { |body| Oj.dump body }
+  }
 ```
 
-Of course, you'll need to require `Yajl` first and add it to your
-Gemfile if you want to use Bundler.
+Of course, you'll need to `require 'oj'` first and add it to your
+Gemfile if use Bundler.
 
 
 ## Update

data/bin/wd_sinatra

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require "rubygems"
 require "thor/group"
+require "inflecto"
 
 class WdSinatra < Thor::Group
   include Thor::Actions
@@ -14,37 +15,18 @@ class WdSinatra < Thor::Group
     File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
   end
 
-  def create_lib_directory
-    directory "lib", "#{name}/lib"
+  def create_app
+    directory ".", "#{name}"
   end
 
-  def create_config_directory
-    directory "config", "#{name}/config"
-  end
-
-  def create_bin_directory
-    directory "bin", "#{name}/bin"
+  def chmod_bin_console
     chmod "#{name}/bin/console", 0755
   end
 
-  def create_public_directory
-    directory "public", "#{name}/public"
+  protected
+  def name_const
+    @name_const ||= Inflecto.camelize(name.gsub(/\W/, '_').squeeze('_'))
   end
-
-  def create_api_directory
-    directory "api", "#{name}/api"
-  end
-
-  def create_test_directory
-    directory "test", "#{name}/test"
-  end
-
-  def create_files
-    %W{Rakefile Gemfile config.ru Guardfile Thorfile}.each do |filename|
-      copy_file filename, "#{name}/#{filename}"
-    end
-  end
-
 end
 
 WdSinatra.start

data/lib/wd_sinatra/app_loader.rb

@@ -1,10 +1,7 @@
-if RUBY_VERSION =~ /1.8/
-  require 'rubygems'
-  require 'backports'
-end
 require 'bundler'
 Bundler.setup
 require 'logger'
+require 'sinatra/base'
 require 'weasel_diesel'
 require 'wd_sinatra/ws_list_ext'
 
@@ -12,20 +9,18 @@ module WDSinatra
   module AppLoader
     module_function
 
-    # Boot in server mode
-    def server(root_path)
-      @root = root_path
-      unless @booted
-        console(root_path)
-        load_middleware
-        set_sinatra_routes
+    # Boot server
+    def server(sinatra_app=nil)
+      raise StandardError, "WDSinatra::AppLoader#setup must be run first." unless root_path
+      unless @server_loaded
         set_sinatra_settings
+        set_sinatra_routes(sinatra_app)
         load_hooks
+        @server_loaded = true
       end
     end
 
-    # Boot in console mode
-    def console(root_path)
+    def setup(root_path)
       @root = root_path
       unless @booted
         set_env
@@ -84,7 +79,7 @@ module WDSinatra
     def load_lib_dependencies
       # WeaselDiesel is the web service DSL gem used to define services.
       require 'weasel_diesel'
-      require 'sinatra'
+      require 'sinatra/base'
       require 'wd_sinatra/sinatra_ext'
     end
 
@@ -106,12 +101,9 @@ module WDSinatra
       end
     end
 
-    def set_sinatra_routes
-      WSList.sorted_for_sinatra_load.each{|api| api.load_sinatra_route }
-    end
-
-    def load_middleware
-      require File.join(root_path, 'config', 'middleware')
+    def set_sinatra_routes(sinatra_app)
+      sinatra_app ||= Sinatra::Base
+      WSList.sorted_for_sinatra_load.each{|api| api.load_sinatra_route(sinatra_app) }
     end
 
     def set_sinatra_settings

data/lib/wd_sinatra/sinatra_ext.rb

@@ -57,11 +57,11 @@ class WeaselDiesel
       @request  = app.request
       @response = app.response
       @service  = service
-  
+
       begin
         # raises an exception if the params are not valid
-        # otherwise update the app params with potentially new params (using default values)   
-        # note that if a type is mentioned for a params, the object will be cast to this object type 
+        # otherwise update the app params with potentially new params (using default values)
+        # note that if a type is mentioned for a params, the object will be cast to this object type
         #
         # removing the fake sinatra params since v1.3 added this. (should be eventually removed)
         if app.params['splat']
@@ -73,7 +73,7 @@ class WeaselDiesel
         @params = params_preprocessor_hook(@params) if self.respond_to?(:params_preprocessor_hook)
         @params = ParamsVerification.validate!(@params, service.defined_params)
         @params = params_postprocessor_hook(@params) if self.respond_to?(:params_postprocessor_hook)
-      rescue Exception => e
+      rescue ParamsVerification::ParamError => e
         LOGGER.error e.message
         LOGGER.error "passed params: #{app.params.inspect}"
         if self.respond_to?(:params_exception_handler)
@@ -89,7 +89,7 @@ class WeaselDiesel
 
     # Forwarding some methods to the underlying app object
     def_delegators :app, :settings, :halt, :compile_template, :session
- 
+
     private ##################################################
 
   end # of RequestHandler
@@ -109,7 +109,8 @@ class WeaselDiesel
     @alpha_handler
   end
 
-  def load_sinatra_route
+  def load_sinatra_route(sinatra_app=nil)
+    sinatra_app ||= Sinatra::Base
     service     = self
     upcase_verb = service.verb.to_s.upcase
     unless ENV['DONT_PRINT_ROUTES']
@@ -120,7 +121,7 @@ class WeaselDiesel
     # Define the route directly to save some object allocations on the critical path
     # Note that we are using a private API to define the route and that unlike sinatra usual DSL
     # we do NOT define a HEAD route for every GET route.
-    Sinatra::Base.send(:route, upcase_verb, self.url) do
+    sinatra_app.send(:route, upcase_verb, self.url) do
       env['wd.service'] = service
       service.handler.dispatch(self)
     end

data/lib/wd_sinatra/test_helpers.rb

@@ -14,7 +14,7 @@ class Requester
   include ::Rack::Test::Methods
 
   def app
-    Sinatra::Application
+    raise 'NotImplemented, This should be an instance of your sinatra application'
   end
 end
 

data/lib/wd_sinatra/version.rb

@@ -1,5 +1,3 @@
-module WD
-  module Sinatra
-    VERSION = "1.0.6"
-  end
+module WDSinatra
+  VERSION = "2.0.0"
 end

data/templates/Gemfile

@@ -1,21 +1,26 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# web engine
-gem "sinatra", "1.3.2"
-# service DSL
-gem "weasel_diesel"
 gem "wd_sinatra"
-# gem 'wd_newrelic_rpm', :require => 'newrelic_rpm'
+gem "inflecto"
+# gem "wd_newrelic_rpm", :require => "newrelic_rpm"
 
-gem 'backports', '2.3.0', :platform => 'ruby_18'
-gem 'json', :platform => 'ruby_18'
+gem "backports", ">= 2.3.0", :platforms => "ruby_18"
+gem "json", :platforms => "ruby_18"
 
 group :development, :test do
-  gem "rack-test", "0.6.1"
+  gem "rack-test", ">= 0.6.1"
   # gem "foreman"
   # gem "puma"
-  gem "minitest"
-  # gem "guard-puma"
+  gem "minitest", "~> 4.7.4"
   # gem "guard-minitest"
   gem "rake"
+
+  gem "rerun"
+  # You can optionally comment out libraries not matching your OS platform
+  # Even if you don't, only the gem supported by your OS will be used by rerun
+  gem "rb-fsevent", ">= 0.9.3" # Mac OS X
+  gem "rb-inotify", ">= 0.9" # Linux
+  gem "rb-kqueue", ">= 0.2" # FreeBSD, NetBSD, OpenBSD, and Darwin
+  require "rbconfig"
+  gem "wdm", ">= 0.1.0" if RbConfig::CONFIG["target_os"] =~ /mswin|mingw/i # Windows
 end

data/templates/{Rakefile → Rakefile.tt}

@@ -1,4 +1,3 @@
-require 'rbconfig'
 require 'rake/testtask'
 require 'rubygems'
 require 'bundler'
@@ -19,7 +18,7 @@ task :default => :test
 task :setup_app do
   ENV['DONT_CONNECT'] ||= 'true'
   begin
-    WDSinatra::AppLoader.console(root)
+    WDSinatra::AppLoader.setup(root)
   rescue Exception => e
     if defined?(ActiveRecord) && e.is_a?(ActiveRecord::ConnectionNotEstablished)
       ENV['DONT_CONNECT'] == 'true' ? print(e.message+"\n") : raise(e)
@@ -31,12 +30,13 @@ end
 
 task :environment do
   ENV['DONT_CONNECT'] = nil
-  WDSinatra::AppLoader.server(root)
+  WDSinatra::AppLoader.setup(root)
+  WDSinatra::AppLoader.server(<%= name_const %>)
 end
 
 desc "Print the available routes"
 task :routes do
-  WDSinatra::AppLoader.console(root)
+  WDSinatra::AppLoader.setup(root)
   print "Available routes: \n"
   WSList.all.each do |service|
     print "#{service.http_verb.upcase}\t#{service.url}\n"

data/templates/Thorfile

@@ -1,11 +1,17 @@
 # encoding: utf-8
 $:.unshift File.expand_path("../lib", __FILE__)
 require 'bundler'
-require 'active_support/inflector'
+require 'inflecto'
+require 'weasel_diesel/cli'
 
 class Default < Thor
   include Thor::Actions
-  
+
+  desc "generate_doc DESTINATION_PATH", "Generate HTML documentation"
+  def generate_doc(destination_path="doc")
+    WeaselDiesel::CLI.new.generate_doc('api', destination_path)
+  end
+
   desc "service VERB URI FILENAME", "Generate scaffolding for a new service"
   def service(verb, route, path)
     route = route.gsub(/^\//, "") # strip leading forward slash
@@ -16,10 +22,10 @@ class Default < Thor
         service.formats   :json
         service.http_verb :#{verb.downcase}
         service.disable_auth # on by default
-        
+
         # INPUT
         service.param.string :name, :default => 'World', :doc => "The name of the person to greet."
-        
+
         # OUTPUT
         service.response do |response|
           response.object do |obj|
@@ -27,13 +33,13 @@ class Default < Thor
             obj.datetime :at, :doc => "The timestamp of when the message was dispatched"
           end
         end
-        
+
         # DOCUMENTATION
         service.documentation do |doc|
           doc.overall "This service provides a simple hello world implementation example."
           doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
         end
-        
+
         # ACTION/IMPLEMENTATION
         service.implementation do
           halt 501, "Not Implemented, which is a pity, I'm sure"
@@ -41,8 +47,8 @@ class Default < Thor
       end
       RUBY
     end
-    
-    class_name = path_without_suffix.classify.gsub(/::/, '') # strip modules; just want a unique class name for spec
+
+    class_name = Inflecto.classify(path_without_suffix).gsub(/::/, '') # strip modules; just want a unique class name for spec
     create_file(File.join("test", "integration", "#{path_without_suffix}_test.rb")) do
       <<-RUBY.gsub(/^\s{6}/, '')
       require 'test_helpers'