webservice 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4edd2b67e6b95a73140481707e95618cc95e1fff
-  data.tar.gz: c6c27bc0393659f8282e46fe3ade997b6e8312e0
+  metadata.gz: 8ad7a2790f5e6914233060b188e91202c2d02bca
+  data.tar.gz: e790a006ecbaa61295205a44936b7bf7802849b1
 SHA512:
-  metadata.gz: 217c555d56853dd4343a57a729cf5b32abc96798d84b01716bd4a7195bf793a674c243f7d0fdc839d30bc6d72b88a9392ddf8a8ce8410116ba0aeaffe85b7d28
-  data.tar.gz: a3364296545ad1016a188303fa8f99a1f7963bf4fc8b6bbd53e6ccbad638f58312444716d1db980d4e3a5a51b91fd968d2fcec3708a4590aeaa3025968071f15
+  metadata.gz: 03ea246f0daf6d8602774d681886afb70f3a4ec7e2626747c4d6f5311a0629146a1407335896b10d18bc83c39a05f9a60514bf4cdf8aa47300bc5feffbaf4997
+  data.tar.gz: 5c5ef7e78019811e996f65b9daf1cbb5462f9016fd341a58976fa794777c3b520a00d898766c3b80961f1f66ec3f39819d018b8cb99f772ce76ae2859d772d04

data/Manifest.txt

@@ -4,12 +4,14 @@ README.md
 Rakefile
 assets/webservice-32x32.png
 lib/webservice.rb
-lib/webservice/base.rb
-lib/webservice/response_handler.rb
+lib/webservice/base/base.rb
+lib/webservice/base/response_handler.rb
+lib/webservice/metal.rb
 lib/webservice/version.rb
 test/helper.rb
 test/service/app.rb
-test/test_app.rb
+test/service/debug.rb
+test/test_metal.rb
 test/test_mustermann.rb
-test/test_samples.rb
-test/test_samples_debug.rb
+test/test_service_app.rb
+test/test_service_debug.rb

data/README.md

@@ -134,7 +134,7 @@ get '/beer/(r|rnd|rand|random)' do    # special keys for random beer
 end
 
 get '/beer/:key'
-  Beer.find_by! key: params[:key]
+  Beer.find_by! key: params['key']
 end
 
 get '/brewery/(r|rnd|rand|random)' do    # special keys for random brewery
@@ -142,13 +142,33 @@ get '/brewery/(r|rnd|rand|random)' do    # special keys for random brewery
 end
 
 get '/brewery/:key'
-  Brewery.find_by! key: params[:key]
+  Brewery.find_by! key: params['key']
 end
+
+...
 ```
 
+
 [**`worlddb / world.db.service`**](https://github.com/worlddb/world.db.service) -
 world.db HTTP JSON API (web service) scripts
 
+```ruby
+get '/countries(.:format)?' do
+  Country.by_key.all    # sort/order by key
+end
+
+get '/cities(.:format)?' do
+  City.by_key.all       # sort/order by key
+end
+
+get '/tag/:slug(.:format)?' do   # e.g. /tag/north_america.csv
+  Tag.find_by!( slug: params['slug'] ).countries
+end
+
+...
+```
+
+
 [**`sportdb / sport.db.service`**](https://github.com/sportdb/sport.db.service) -
 sport.db (football.db) HTTP JSON API (web service) scripts
 

data/lib/webservice.rb

@@ -22,9 +22,10 @@ require 'rack'
 
 # our own code
 require 'webservice/version'   # note: let version always go first
-require 'webservice/base'
+require 'webservice/metal'
 
-require 'webservice/response_handler'     ## default (built-in) response handler (magic)
+require 'webservice/base/base'
+require 'webservice/base/response_handler'     ## default (built-in) response handler (magic)
 
 
 

data/lib/webservice/base/base.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+
+module Webservice
+
+class Base < Metal
+
+
+  ## note: before (filter) for now is just a method (NOT a chain for blocks, etc.);
+  ##   override method to change before (filter)
+  def before
+     ### move cors headers to responseHandler to initialize!!!! - why? why not??
+     ## (auto-)add (merge in) cors headers
+     ##   todo: move into a before filter ??  lets you overwrite headers - needed - why? why not??
+     headers 'Access-Control-Allow-Origin'  => '*',
+             'Access-Control-Allow-Headers' => 'Authorization,Accepts,Content-Type,X-CSRF-Token,X-Requested-With',
+             'Access-Control-Allow-Methods' => 'GET,POST,PUT,DELETE,OPTIONS'
+  end
+
+
+  # note: for now use "plugable" response handler
+  ##   rename to respond_with or something? why? why not??
+  ##    make it a "stateless" function e.g. just retrun tripled [status, headers, body] - why? why not??
+  def handle_response( obj, opts={} )
+    handler   = ResponseHandler.new( self )    ## for now "hard-coded"; make it a setting later - why? why not?
+    handler.handle_response( obj )   ## prepare response
+  end
+
+
+  ##################################
+  ##  add some fallback (builtin) routes
+
+  get '/favicon.ico' do
+    ## use 302 to redirect
+    ##  note: use strg+F5 to refresh page (clear cache for favicon.ico)
+    redirect '/webservice-32x32.png'
+  end
+
+  get '/webservice-32x32.png' do
+    send_file "#{Webservice.root}/assets/webservice-32x32.png"
+  end
+
+  get '/routes' do
+    msg =<<TXT
+#{dump_routes}
+
+#{dump_version}
+TXT
+end
+
+  ## catch all (404 not found)
+  get '/*' do
+    pp env
+    pp self.class.routes   ## note: dump routes of derived class
+
+    msg =<<TXT
+  404 Not Found
+
+  No route matched >#{request.request_method} #{request.path_info}<:
+
+    REQUEST_METHOD: >#{request.request_method}<
+    PATH_INFO:      >#{request.path_info}<
+    QUERY_STRING:   >#{request.query_string}<
+
+    SCRIPT_NAME:    >#{request.script_name}<
+    REQUEST_URI:    >#{request.url}<
+
+
+#{dump_routes}
+
+#{dump_version}
+TXT
+
+    halt 404, msg
+  end
+
+
+############################
+## fallback helpers
+
+  def dump_routes    ## todo/check - rename to build_routes/show_routes/etc. - why? why not?
+    buf = ""
+    walk_routes_for( buf, self.class )
+    buf
+  end
+
+  def walk_routes_for( buf, base=self.class )
+
+    buf << "  Routes >#{base.name}<:\n\n"
+
+    base.routes.each do |method,routes|
+      buf << "    #{method}:\n"
+      routes.each do |pattern,block|
+        buf << "      #{pattern.to_s}\n"
+      end
+    end
+
+    if base.superclass.respond_to? :routes
+      buf << "\n\n"
+      walk_routes_for( buf, base.superclass )
+    end
+  end
+
+
+  def dump_version
+    ## single line version string
+    buf = "  "   # note: start with two leading spaces (indent)
+    buf << "webservice/#{VERSION} "
+    buf << "(#{self.class.environment}), "
+    buf << "rack/#{Rack::RELEASE} (#{Rack::VERSION.join('.')}) - "
+    buf << "ruby/#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}/#{RUBY_PLATFORM})"
+    buf
+  end
+
+end # class Base
+
+end # module Webservice

data/lib/webservice/{base.rb → metal.rb}

@@ -1,381 +1,297 @@
-# encoding: utf-8
-
-
-module Webservice
-
-  ## use (an reuse from Rack) some freezed string constants
-  ##  HTTP verbs
-  GET     = Rack::GET
-  POST    = Rack::POST
-  PATCH   = Rack::PATCH
-  PUT     = Rack::PUT
-  DELETE  = Rack::DELETE
-  HEAD    = Rack::HEAD
-  OPTIONS = Rack::OPTIONS
-
-  ##  HTTP headers
-  CONTENT_LENGTH = Rack::CONTENT_LENGTH
-  CONTENT_TYPE   = Rack::CONTENT_TYPE
-  # -- more HTTP headers - not available from Rack
-  LOCATION       = 'Location'.freeze
-  LAST_MODIFIED  = 'Last-Modified'.freeze
-
-
-module Helpers
-    ## add some more helpers
-    ##   "inspired" by sinatra (mostly) - for staying compatible
-    ##   see https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
-
-    ## todo -- add status -- why? why not??
-
-    # Halt processing and return the error status provided.
-    def error( code, body=nil )
-      response.body = body unless body.nil?
-      halt code
-    end
-
-    # Halt processing and return a 404 Not Found.
-    def not_found( body=nil )
-      error 404, body
-    end
-
-
-    def redirect_to( uri, status=302 )    ## Note: 302 == Found, 301 == Moved Permanently
-      halt status, { LOCATION => uri }
-    end
-    alias_method :redirect, :redirect_to
-
-
-    # Set multiple response headers with Hash.
-    def headers( hash=nil )
-      response.headers.merge! hash if hash
-      response.headers
-    end
-
-
-
-    ## (simple) content_type helper - all "hard-coded" for now; always uses utf-8 too
-    def content_type( type=nil )
-      return response[ CONTENT_TYPE ] unless type
-
-      if type.to_sym == :json
-        response[ CONTENT_TYPE ] = 'application/json; charset=utf-8'
-      elsif type.to_sym == :js || type.to_sym == :javascript
-        response[ CONTENT_TYPE ] = 'application/javascript; charset=utf-8'
-        ## use 'text/javascript; charset=utf-8'  -- why? why not??
-        ## note: ietf recommends application/javascript
-      elsif type.to_sym == :csv || type.to_sym == :text || type.to_sym == :txt
-        response[ CONTENT_TYPE ] = 'text/plain; charset=utf-8'
-      elsif type.to_sym == :html || type.to_sym == :htm
-        response[ CONTENT_TYPE ] = 'text/html; charset=utf-8'
-      else
-        ### unknown type; do nothing - sorry; issue warning - why? why not??
-      end
-    end  ## method content_type
-
-
-  ## simple send file (e.g. for images/binary blobs, etc.) helper
-  def send_file( path )
-    ## puts "send_file path=>#{path}<"
-
-    ## puts "HTTP_IF_MODIFIED_SINCE:"
-    ## puts request.get_header('HTTP_IF_MODIFIED_SINCE')
-
-    last_modified = File.mtime(path).httpdate
-    ## puts "last_modified:"
-    ## puts last_modified
-
-    ## HTTP 304 => Not Modified
-    halt 304     if request.get_header('HTTP_IF_MODIFIED_SINCE') == last_modified
-
-    headers[ LAST_MODIFIED ] = last_modified
-
-    bytes = File.open( path, 'rb' ) { |f| f.read }
-
-    ## puts "encoding:"
-    ## puts bytes.encoding
-
-    ## puts "size:"
-    ## puts bytes.size
-
-    extname = File.extname( path )
-    ## puts "extname:"
-    ## puts extname
-
-    ## puts "headers (before):"
-    ## pp headers
-
-    if extname == '.png'
-      headers[ CONTENT_TYPE ] = 'image/png'
-    else
-      ## fallback to application/octet-stream
-      headers[ CONTENT_TYPE ] = 'application/octet-stream'
-    end
-
-    headers[ CONTENT_LENGTH ] = bytes.size.to_s   ## note: do NOT forget to use to_s (requires string!)
-
-    ## puts "headers (after):"
-    ## pp headers
-
-    halt 200, bytes
-  end # method send_file
-
-
-
-end  ## module Helpers
-
-
-class Base
-  include Helpers
-
-
-  class << self
-
-    def call( env )    ## note self.call(env) lets you use =>  run Base instead of run Base.new
-      ## puts "calling #{self.name}.call"
-      prototype.call( env )
-    end
-
-    def prototype
-      ## puts "calling #{self.name}.prototype"
-      @prototype ||= self.new
-      ## pp @prototype
-      ## @prototype
-    end
-
-
-    ## todo/check: all verbs needed! (supported) - why, why not??
-    ##   e.g. add LINK, UNLINK ??
-
-    # Note: for now defining a `GET` handler also automatically defines
-    # a `HEAD` handler  (follows sinatra convention)
-    def get( pattern, &block )
-      route( GET,   pattern, &block )
-      route( HEAD,  pattern, &block )
-    end
-
-    def post( pattern, &block)    route( POST,    pattern, &block ); end
-    def patch( pattern, &block)   route( PATCH,   pattern, &block ); end
-    def put( pattern, &block)     route( PUT,     pattern, &block ); end
-    def delete( pattern, &block)  route( DELETE,  pattern, &block ); end
-    def head( pattern, &block)    route( HEAD,    pattern, &block ); end
-    def options( pattern, &block) route( OPTIONS, pattern, &block ); end
-
-    def route( method, pattern, &block )
-      puts "[debug] Webservice::Base.#{method.downcase} - add route #{method} '#{pattern}' to #<#{self.name}:#{self.object_id}> : #{self.class.name}"
-
-      ## note: for now use the sintatra-style patterns (with mustermann)
-      routes[method] << [Mustermann::Sinatra.new(pattern), block]
-    end
-
-
-    def routes
-      @routes ||= Hash.new { |hash, key| hash[key]=[] }
-    end
-
-
-    ##########################
-    ##  support for "builtin" fallback routes
-    ##
-    ##  e.g. use like
-    ##   fallback_route GET, '/' do
-    ##     "Hello, World!"
-    ##   end
-    def fallback_route( method, pattern, &block )
-      puts "[debug] Webservice::Base.#{method.downcase} - add (fallback) route #{method} '#{pattern}' to #<#{self.name}:#{self.object_id}> : #{self.class.name}"
-
-      ## note: for now use the sintatra-style patterns (with mustermann)
-      fallback_routes[method] << [Mustermann::Sinatra.new(pattern), block]
-    end
-
-    def fallback_routes
-      ## note: !!! use @@ NOT just @ e.g.
-      ##   routes get shared/used by all classes/subclasses
-      @@fallback_routes ||= Hash.new { |hash, key| hash[key]=[] }
-    end
-
-
-    def environment
-      ## include APP_ENV why? why not?
-      ##   todo -- cache value? why why not?  (see/follow sinatara set machinery ??)
-      (ENV['APP_ENV'] || ENV['RACK_ENV'] || :development).to_sym
-    end
-
-    def development?() environment == :development; end
-    def production?()  environment == :production;  end
-    def test?()        environment == :test;        end
-
-
-    ## convenience method
-    def run!
-      puts "[debug] Webservice::Base.run! - self = #<#{self.name}:#{self.object_id}> : #{self.class.name}"  # note: assumes self is class
-      app    = self     ## note: use self; will be derived class (e.g. App and not Base)
-      port   = 4567
-      Rack::Handler::WEBrick.run( app, Port:port ) do |server|
-        ## todo: add traps here - why, why not??
-      end
-    end
-
-  end  ## class << self
-
-
-  attr_reader :request
-  attr_reader :response
-  attr_reader :params
-  attr_reader :env
-
-  attr_reader :handler   # default response_handler/respond_with handler magic
-
-
-  def call( env )
-    dup.call!( env )
-  end
-
-  def call!( env )
-    env['PATH_INFO'] = '/'  if env['PATH_INFO'].empty?
-
-    @request   = Rack::Request.new( env )
-    @response  = Rack::Response.new
-    @params    = request.params
-    @env       = env
-
-    @handler   = ResponseHandler.new( self )    ## for now "hard-coded"; make it a setting later - why? why not?
-
-    ### move cors headers to responseHandler to initialize!!!! - why? why not??
-    ## (auto-)add (merge in) cors headers
-    ##   todo: move into a before filter ??  lets you overwrite headers - needed - why? why not??
-    headers 'Access-Control-Allow-Origin'  => '*',
-            'Access-Control-Allow-Headers' => 'Authorization,Accepts,Content-Type,X-CSRF-Token,X-Requested-With',
-            'Access-Control-Allow-Methods' => 'GET,POST,PUT,DELETE,OPTIONS'
-
-    route_eval
-
-    @response.finish
-  end
-
-
-  def halt( *args )
-    response.status = args.detect{ |arg| arg.is_a?(Fixnum) } || 200
-    response.header.merge!( args.detect{ |arg| arg.is_a?(Hash) } || {} )
-    response.body = [args.detect{ |arg| arg.is_a?(String) } || '']
-    throw :halt, response
-  end
-
-private
-
-  def route_eval
-    puts "  [#{self.class.name}] try matching route >#{request.request_method} #{request.path_info}<..."
-
-    catch(:halt) do
-      ## pass 1
-      routes = self.class.routes[ request.request_method ]
-      routes.each do |pattern, block|
-        ## puts "trying matching route >#{request.path_info}<..."
-        url_params = pattern.params( request.path_info )
-        if url_params   ## note: params returns nil if no match
-          ## puts "  BINGO! url_params: #{url_params.inspect}"
-          if !url_params.empty?   ## url_params hash NOT empty (e.g. {}) merge with req params
-            ## todo/fix: check merge order - params overwrites url_params - why? why not??
-            @params = url_params.merge( @params )
-          end
-          handler.handle_response( instance_eval( &block ))
-          return
-        end
-      end
-
-      ## pass 2 - (builtin) fallbacks
-      routes = self.class.fallback_routes[ request.request_method ]
-      routes.each do |pattern, block|
-        url_params = pattern.params( request.path_info )
-        if url_params   ## note: params returns nil if no match
-          if !url_params.empty?   ## url_params hash NOT empty (e.g. {}) merge with req params
-            @params = url_params.merge( @params )
-          end
-          handler.handle_response( instance_eval( &block ))
-          return
-        end
-      end
-
-      # no match found for route/request
-      halt 404
-    end
-  end
-
-
-
-  ##################################
-  ### add some fallback (builtin) routes
-
-    fallback_route GET, '/favicon.ico' do
-      ## use 302 to redirect
-      ##  note: use strg+F5 to refresh page (clear cache for favicon.ico)
-      redirect_to '/webservice-32x32.png'
-    end
-
-    fallback_route GET, '/webservice-32x32.png' do
-      send_file "#{Webservice.root}/assets/webservice-32x32.png"
-    end
-
-    fallback_route GET, '/routes' do
-    msg =<<TXT
-#{dump_routes}
-
-#{dump_version}
-TXT
-end
-
-  ## catch all (404 not found)
-  fallback_route GET, '/*' do
-    pp env
-    pp self.class.routes
-
-    msg =<<TXT
-  404 Not Found
-
-  No route matched >#{request.request_method} #{request.path_info}<:
-
-    REQUEST_METHOD: >#{request.request_method}<
-    PATH_INFO:      >#{request.path_info}<
-    QUERY_STRING:   >#{request.query_string}<
-
-    SCRIPT_NAME:    >#{request.script_name}<
-    REQUEST_URI:    >#{env['REQUEST_URI']}<
-
-
-#{dump_routes}
-
-#{dump_version}
-TXT
-
-    halt 404, msg
-  end
-
-############################
-## fallback helpers
-
-  def dump_routes    ## todo/check - rename to build_routes/show_routes/etc. - why? why not?
-    buf = ""
-    buf << "  Routes >#{self.class.name}<:\n\n"
-
-    self.class.routes.each do |method,routes|
-      buf << "    #{method}:\n"
-      routes.each do |pattern,block|
-        buf << "      #{pattern.to_s}\n"
-      end
-    end
-    buf
-  end
-
-  def dump_version
-    ## single line version string
-    buf = "  "   # note: start with two leading spaces (indent)
-    buf << "webservice/#{VERSION} "
-    buf << "(#{self.class.environment}), "
-    buf << "rack/#{Rack::RELEASE} (#{Rack::VERSION.join('.')}) - "
-    buf << "ruby/#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}/#{RUBY_PLATFORM})"
-    buf
-  end
-
-end # class Base
-
-end # module Webservice
+# encoding: utf-8
+
+
+module Webservice
+
+  ## use (an reuse from Rack) some freezed string constants
+  ##  HTTP verbs
+  GET     = Rack::GET
+  POST    = Rack::POST
+  PATCH   = Rack::PATCH
+  PUT     = Rack::PUT
+  DELETE  = Rack::DELETE
+  HEAD    = Rack::HEAD
+  OPTIONS = Rack::OPTIONS
+
+  ##  HTTP headers
+  CONTENT_LENGTH = Rack::CONTENT_LENGTH
+  CONTENT_TYPE   = Rack::CONTENT_TYPE
+  # -- more HTTP headers - not available from Rack
+  LOCATION       = 'Location'.freeze
+  LAST_MODIFIED  = 'Last-Modified'.freeze
+
+
+module Helpers
+    ## add some more helpers
+    ##   "inspired" by sinatra (mostly) - for staying compatible
+    ##   see https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
+
+    ## todo -- add status -- why? why not??
+
+    # Halt processing and return the error status provided.
+    def error( code, body=nil )
+      response.body = body unless body.nil?
+      halt code
+    end
+
+    # Halt processing and return a 404 Not Found.
+    def not_found( body=nil )
+      error 404, body
+    end
+
+
+    def redirect( uri, status=302 )    ## Note: 302 == Found, 301 == Moved Permanently
+
+      ##
+      ## todo/fix: add/prepepand SCRIPT_NAME if NOT empty - why? why not??
+      ##    without SCRIPT_NAME redirect will not work with (non-root) mounted apps
+
+      halt status, { LOCATION => uri }
+    end
+    alias_method :redirect_to, :redirect
+
+
+    # Set multiple response headers with Hash.
+    def headers( hash=nil )
+      response.headers.merge! hash if hash
+      response.headers
+    end
+
+
+
+    ## (simple) content_type helper - all "hard-coded" for now; always uses utf-8 too
+    def content_type( type=nil )
+      return response[ CONTENT_TYPE ] unless type
+
+      if type.to_sym == :json
+        response[ CONTENT_TYPE ] = 'application/json; charset=utf-8'
+      elsif type.to_sym == :js || type.to_sym == :javascript
+        response[ CONTENT_TYPE ] = 'application/javascript; charset=utf-8'
+        ## use 'text/javascript; charset=utf-8'  -- why? why not??
+        ## note: ietf recommends application/javascript
+      elsif type.to_sym == :csv || type.to_sym == :text || type.to_sym == :txt
+        response[ CONTENT_TYPE ] = 'text/plain; charset=utf-8'
+      elsif type.to_sym == :html || type.to_sym == :htm
+        response[ CONTENT_TYPE ] = 'text/html; charset=utf-8'
+      else
+        ### unknown type; do nothing - sorry; issue warning - why? why not??
+      end
+    end  ## method content_type
+
+
+  ## simple send file (e.g. for images/binary blobs, etc.) helper
+  def send_file( path )
+    ## puts "send_file path=>#{path}<"
+
+    ## puts "HTTP_IF_MODIFIED_SINCE:"
+    ## puts request.get_header('HTTP_IF_MODIFIED_SINCE')
+
+    last_modified = File.mtime(path).httpdate
+    ## puts "last_modified:"
+    ## puts last_modified
+
+    ## HTTP 304 => Not Modified
+    halt 304     if request.get_header('HTTP_IF_MODIFIED_SINCE') == last_modified
+
+    headers[ LAST_MODIFIED ] = last_modified
+
+    bytes = File.open( path, 'rb' ) { |f| f.read }
+
+    ## puts "encoding:"
+    ## puts bytes.encoding
+
+    ## puts "size:"
+    ## puts bytes.size
+
+    extname = File.extname( path )
+    ## puts "extname:"
+    ## puts extname
+
+    ## puts "headers (before):"
+    ## pp headers
+
+    if extname == '.png'
+      headers[ CONTENT_TYPE ] = 'image/png'
+    else
+      ## fallback to application/octet-stream
+      headers[ CONTENT_TYPE ] = 'application/octet-stream'
+    end
+
+    headers[ CONTENT_LENGTH ] = bytes.size.to_s   ## note: do NOT forget to use to_s (requires string!)
+
+    ## puts "headers (after):"
+    ## pp headers
+
+    halt 200, bytes
+  end # method send_file
+
+
+
+end  ## module Helpers
+
+
+class Metal    ## bare bones core (use base for more built-in functionality)
+  include Helpers
+
+
+  class << self
+
+    def call( env )    ## note self.call(env) lets you use =>  run Base instead of run Base.new
+      ## puts "calling #{self.name}.call"
+      prototype.call( env )
+    end
+
+    def prototype
+      ## puts "calling #{self.name}.prototype"
+      @prototype ||= self.new
+      ## pp @prototype
+      ## @prototype
+    end
+
+
+    ## todo/check: all verbs needed! (supported) - why, why not??
+    ##   e.g. add LINK, UNLINK ??
+
+    # Note: for now defining a `GET` handler also automatically defines
+    # a `HEAD` handler  (follows sinatra convention)
+    def get( pattern, &block )
+      route( GET,   pattern, &block )
+      route( HEAD,  pattern, &block )
+    end
+
+    def post( pattern, &block)    route( POST,    pattern, &block ); end
+    def patch( pattern, &block)   route( PATCH,   pattern, &block ); end
+    def put( pattern, &block)     route( PUT,     pattern, &block ); end
+    def delete( pattern, &block)  route( DELETE,  pattern, &block ); end
+    def head( pattern, &block)    route( HEAD,    pattern, &block ); end
+    def options( pattern, &block) route( OPTIONS, pattern, &block ); end
+
+    def route( method, pattern, &block )
+      puts "[debug] Webservice::Metal.#{method.downcase} - add route #{method} '#{pattern}' to #<#{self.name}:#{self.object_id}> : #{self.class.name}"
+
+      ## note: for now use (default to) the sintatra-style patterns (with mustermann)
+      routes[method] << [Mustermann::Sinatra.new(pattern), block]
+    end
+
+    def routes
+      @routes ||= Hash.new { |hash, key| hash[key]=[] }
+    end
+
+    def environment
+      ## include APP_ENV why? why not?
+      ##   todo -- cache value? why why not?  (see/follow sinatara set machinery ??)
+      (ENV['APP_ENV'] || ENV['RACK_ENV'] || :development).to_sym
+    end
+
+    def development?() environment == :development; end
+    def production?()  environment == :production;  end
+    def test?()        environment == :test;        end
+
+    ## convenience method
+    def run!
+      puts "[debug] Webservice::Metal.run! - self = #<#{self.name}:#{self.object_id}> : #{self.class.name}"  # note: assumes self is class
+      app    = self     ## note: use self; will be derived class (e.g. App and not Base)
+      port   = 4567
+      Rack::Handler::WEBrick.run( app, Port:port ) do |server|
+        ## todo: add traps here - why, why not??
+      end
+    end
+  end  ## class << self
+
+
+  attr_reader :request
+  attr_reader :response
+  attr_reader :params
+  attr_reader :env
+
+
+  def call( env )
+    dup.call!( env )
+  end
+
+  def call!( env )
+    env['PATH_INFO'] = '/'  if env['PATH_INFO'].empty?
+
+    @request   = Rack::Request.new( env )
+    @response  = Rack::Response.new
+    @params    = request.params
+    @env       = env
+
+    catch(:halt) do
+      ## call before if defined in derived (sub)classes
+      before  if respond_to? :before
+
+      route!
+    end
+
+    @response.finish
+  end
+
+
+  def halt( *args )
+    response.status = args.detect{ |arg| arg.is_a?(Fixnum) } || 200
+    response.header.merge!( args.detect{ |arg| arg.is_a?(Hash) } || {} )
+    response.body = [args.detect{ |arg| arg.is_a?(String) } || '']
+    throw :halt, response           ## todo/check response arg used - what for??
+  end
+
+
+private
+
+  ## run a route block and throw :halt
+  def route_eval( &block )
+    obj = instance_eval( &block )    ## return result - for now assumes a single object
+
+    if respond_to? :handle_response
+      handle_response( obj )    ## prepare response
+    else
+      ## default response; string expected
+      ##   if string pass it along
+      ##   if NOT string for debugging / dump to string with inspect
+      response.status = 200
+      response.body   = [obj.is_a?(String) ? obj.to_s : obj.inspect]
+    end
+
+    throw :halt
+  end
+
+
+  def route!( base=self.class )
+
+    puts "  [#{base.name}] try matching route >#{request.request_method} #{request.path_info}<..."
+
+      routes = base.routes[ request.request_method ]
+      routes.each do |pattern, block|
+        ## puts "trying matching route >#{request.path_info}<..."
+        url_params = pattern.params( request.path_info )
+        if url_params   ## note: params returns nil if no match
+          ## puts "  BINGO! url_params: #{url_params.inspect}"
+          if !url_params.empty?   ## url_params hash NOT empty (e.g. {}) merge with req params
+            ## todo/fix: check merge order - params overwrites url_params - why? why not??
+
+            ## todo/fix: check params - params works with string keys only - check for indiffent keys - why? why not?
+            ##   check rack params - works with indifferent keys by default??
+            @params = url_params.merge( @params )
+          end
+          route_eval( &block )
+          ##  todo/check: keep return - why? why not?  - note: route_eval will always throw :halt
+          ## handler.handle_response( instance_eval( &block ))
+          ## return
+        end
+      end
+
+      ## check recursive - all super(parent)classes too (e.g. App > Base > Metal etc.)
+      ##   note: superclass is the parent class (returns nil if no more parent class)
+      if base.superclass.respond_to? :routes
+        route!( base.superclass )
+        return
+      end
+
+      # no match found for route/request
+      halt 404
+  end
+
+
+end # class Metal
+
+end # module Webservice

data/lib/webservice/version.rb

@@ -4,8 +4,8 @@ module Webservice
 
    module Version
      MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-     MINOR = 6
-     PATCH = 1    ## note: if not put in module will overwrite PATCH (HTTP Verb Constant)!!!
+     MINOR = 7
+     PATCH = 0    ## note: if not put in module will overwrite PATCH (HTTP Verb Constant)!!!
    end
 
    VERSION = [Version::MAJOR,

data/test/helper.rb

@@ -2,11 +2,6 @@
 ## minitest setup
 require 'minitest/autorun'
 
-## deps
-
-### require 'worlddb'
-## require 'sportdb/models'   # note: will include worlddb
-
 
 ## our own code
 require 'webservice'    ## includes rack
@@ -14,4 +9,3 @@ require 'webservice'    ## includes rack
 
 ## more libs
 require 'rack/test'
-

data/test/service/debug.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+
+##  gets evaluated in class context (self is class) -- uses class_eval
+puts "[debug] eval (top) self = #<#{self.name}:#{self.object_id}> : #{self.class.name}"
+
+get '/hello' do
+
+  ## gets evaluated in object context (self is object) -- uses instance_eval
+  puts "[debug] eval (get /hello) self = #<#{self.class.name}:#{self.class.object_id}> : #{self.class.class.name}"
+
+  data = { text: 'hello' }
+  data
+end

data/test/test_metal.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_metal.rb
+
+
+require 'helper'
+
+
+class MetalApp < Webservice::Metal
+
+   get '/hello' do
+     'Hello, World!'
+   end
+
+end # class MetalApp
+
+
+
+class TestMetal < MiniTest::Test
+
+  include Rack::Test::Methods
+
+  def app
+    ## return (rack-ready) app object
+    @@app ||= begin
+      app_class = MetalApp
+      pp app_class.routes
+      app_class
+    end
+  end
+
+
+  def test_get
+    get '/hello'
+    assert last_response.ok?
+
+    get '/'
+    assert_equal 404, last_response.status
+  end
+
+end # class TestMetal

data/test/test_mustermann.rb

@@ -12,12 +12,16 @@ class TestMustermann < MiniTest::Test
 
   def test_hello
 
-    pp Rack::VERSION
+    pp Rack::VERSION            #  e.g. [1,2]
+    pp Rack::VERSION.join('.')  #   e.g. 1.2
+    pp Rack::RELEASE
     pp Mustermann::VERSION
 
+
     pattern = Mustermann::Sinatra.new( '/:name' )
     pp pattern
     pp pattern.names
+    pp pattern.to_s    # prints passed in pattern (as "plain" string as is)
 
     m = pattern.match( "/test" )
     pp m

data/test/{test_app.rb → test_service_app.rb}

@@ -2,13 +2,13 @@
 
 ###
 #  to run use
-#     ruby -I ./lib -I ./test test/test_app.rb
+#     ruby -I ./lib -I ./test test/test_service_app.rb
 
 
 require 'helper'
 
 
-class TestApp < MiniTest::Test
+class TestServiceApp < MiniTest::Test
 
   include Rack::Test::Methods
 
@@ -17,7 +17,7 @@ class TestApp < MiniTest::Test
     @@app ||= begin
       app_class = Webservice.load_file( "#{Webservice.root}/test/service/app.rb" )
       pp app_class.routes
-      app_class.new
+      app_class
     end
   end
 
@@ -113,4 +113,4 @@ HTML
     assert_equal "Error fatal", last_response.body
   end
 
-end # class TestApp
+end # class TestServiceApp

data/test/test_service_debug.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_service_debug.rb
+
+
+require 'helper'
+
+
+class TestServiceDebug < MiniTest::Test
+
+  include Rack::Test::Methods
+
+  def app
+    ## return (rack-ready) app object
+    @@app ||= begin
+      app_class = Webservice.load_file( "#{Webservice.root}/test/service/debug.rb" )
+      pp app_class.routes
+      app_class
+    end
+  end
+
+  def test_get
+    get '/hello'
+    assert last_response.ok?
+
+    get '/'
+    assert_equal 404, last_response.status
+  end
+
+end # class TestServiceDebug

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webservice
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -95,15 +95,17 @@ files:
 - Rakefile
 - assets/webservice-32x32.png
 - lib/webservice.rb
-- lib/webservice/base.rb
-- lib/webservice/response_handler.rb
+- lib/webservice/base/base.rb
+- lib/webservice/base/response_handler.rb
+- lib/webservice/metal.rb
 - lib/webservice/version.rb
 - test/helper.rb
 - test/service/app.rb
-- test/test_app.rb
+- test/service/debug.rb
+- test/test_metal.rb
 - test/test_mustermann.rb
-- test/test_samples.rb
-- test/test_samples_debug.rb
+- test/test_service_app.rb
+- test/test_service_debug.rb
 homepage: https://github.com/rubylibs/webservice
 licenses:
 - Public Domain

data/test/test_samples.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_samples.rb
-
-
-require 'helper'
-
-
-class TestSamples < MiniTest::Test
-
-  def test_beer
-    app_class = Webservice.load_file( "#{Webservice.root}/samples/beer.rb" )
-    pp app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-  def test_football
-    app_class = Webservice.load_file( "#{Webservice.root}/samples/football.rb" )
-    pp app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-  def test_world
-    app_class = Webservice.load_file( "#{Webservice.root}/samples/world.rb" )
-    pp app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-end # class TestSamples

data/test/test_samples_debug.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_samples_debug.rb
-
-
-require 'helper'
-
-
-class TestSamplesDebug < MiniTest::Test
-
-  def test_debug
-    app_class = Webservice.load_file( "#{Webservice.root}/samples/debug.rb" )
-    pp app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-end # class TestSamplesDebug