webservice 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 416e55a694b9934f1c75b576856d80557c2b51aa
-  data.tar.gz: 0fe846b71eb385cf11d539258f64edc270899b0b
+  metadata.gz: ca3b0a962413d171c662477e7626930cfbbc39f4
+  data.tar.gz: 437d9beda6547d451098a9cfdb8af7bcef051d08
 SHA512:
-  metadata.gz: 9c0d5927c80e79c50e20ed3018167cdc43be38b12f6839bfb080e8cf4ddf3944761d0612b5f0a2966b912845159f3450273c19e1067ca5e4fd252acab1808cf2
-  data.tar.gz: e4ae8fc7423e975ae7a0337be183ffa4e3107eb071e4d5de89f9afd27d323680bd8c99a6d53b203f10ec08a1437252c49feaa6f6a3af6aed8a884652c45428c6
+  metadata.gz: 8ccadcc3b2d95a13fda4de2b9f9259a410231b7bfb6ac854f5552da3ce45f8dd15345e785d6f47b62032b3b4304f21f9ec219d9b624022cb61e541b2e69c1b23
+  data.tar.gz: 71d1d5ce9f811b32c498ddf7074f82efd9fa3cb42e45d1e5e6b246b9371033fe0509a443360fb80b415d381d098649d9c34cc5a7d470476f7f4c7ee166165c24

data/Manifest.txt

@@ -4,10 +4,10 @@ README.md
 Rakefile
 lib/webservice.rb
 lib/webservice/base.rb
-lib/webservice/builder.rb
 lib/webservice/version.rb
 test/helper.rb
 test/service/app.rb
 test/test_app.rb
-test/test_builder.rb
-test/test_builder_debug.rb
+test/test_mustermann.rb
+test/test_samples.rb
+test/test_samples_debug.rb

data/Rakefile

@@ -19,7 +19,8 @@ Hoe.spec 'webservice' do
 
   self.extra_deps = [
     ['logutils'],
-    ['rack', '>=2.0.3']
+    ['mustermann', '>=2.0.0'],
+    ['rack',       '>=2.0.3']
   ]
 
   self.licenses = ['Public Domain']
@@ -28,5 +29,4 @@ Hoe.spec 'webservice' do
    required_ruby_version: '>= 2.3'
   }
 
-
 end

data/lib/webservice.rb

@@ -9,14 +9,32 @@ require 'pp'
 
 require 'logutils'
 
+require 'mustermann'
+require 'mustermann/version'
+require 'mustermann/sinatra'
+
 require 'rack'
 
+
 # our own code
 require 'webservice/version'   # note: let version always go first
-require 'webservice/builder'
 require 'webservice/base'
 
 
 
+module Webservice
+  def self.load_file( path )
+    code = File.open( path, 'r:bom|utf-8' ).read
+    self.load( code )
+  end
+
+  def self.load( code )
+    app_class = Class.new( Base )     ## create new app_class or just use Base itself - why? why not?
+    app_class.class_eval( code )   ## note: use class_eval (NOT instance_eval)
+    app_class
+  end
+end # module Webservice
+
+
 # say hello
 puts Webservice.banner    if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG

data/lib/webservice/base.rb

@@ -4,49 +4,40 @@
 module Webservice
 
 class Base
+
+  HTTP_VERBS = %w(GET POST PATCH PUT DELETE HEAD OPTIONS)
+
+
   class << self
 
     ## todo/check: all verbs needed! (supported) - why, why not??
-    %w(GET POST PATCH PUT DELETE HEAD OPTIONS).each do |method|
+    HTTP_VERBS.each do |method|
       define_method( method.downcase ) do |pattern, &block|
-        puts "[debug] Webservice::Base.#{method.downcase} - add route #{method} '#{pattern}' to >#{self.name}< (#{self.object_id})"
-        routes[method] << [compile_pattern(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
     end
 
-##    def builder
-##      @builder ||= Rack::Builder.new
-##    end
 
     def routes
       @routes ||= Hash.new { |hash, key| hash[key]=[] }
     end
 
 
+    ## convenience method
     def run!
-      app_class = self  ## note: self will be derived class (e.g. App and not Base)
-      puts "[debug] Webservice::Base.run! - self: >#{app_class.name}< (#{app_class.object_id}) : #{app_class.class.name}"  # assume self is class
-      app_obj = app_class.new
-      app = Rack::Builder.new
-      app.map( '/' ) { run app_obj }  ## e.g. run App
+      puts "[debug] Webservice::Base.run! - self = #<#{self.name}:#{self.object_id}> : #{self.class.name}"  # note: assumes self is class
+      app    = self.new   ## note: use self; will be derived class (e.g. App and not Base)
       port   = 4567
       Rack::Handler.get('webrick').run( app, Port:port ) do |server|
         ## todo: add traps here - why, why not??
       end
     end
 
+  end  ## class << self
 
-  private
-
-    def compile_pattern( pattern )
-      keys = []
-      pattern.gsub!( /(:\w+)/ ) do |match|
-        keys << $1[1..-1]
-        '([^/?#]+)'
-      end
-      [%r{^#{pattern}$}, keys]
-    end
-  end
 
 
   attr_reader :request
@@ -68,9 +59,6 @@ class Base
     @response.finish
   end
 
-  def session
-    request.env["rack.session"] || raise("Rack::Session handler is missing")
-  end
 
   def halt( *args )
     response.status = args.detect{|arg| arg.is_a?(Fixnum) } || 200
@@ -84,11 +72,13 @@ private
 
   def route_eval
     catch(:halt) do
-      self.class.routes[request.request_method].each do |matcher, block|
-        if match = request.path_info.match( matcher[0] )
-          if (captures = match.captures) && !captures.empty?
-            url_params = Hash[*matcher[1].zip(captures).flatten]
-            @params = url_params.merge(params)
+      self.class.routes[request.request_method].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
+            @params = url_params.merge( params )
           end
           handle_response( instance_eval( &block ))
           return
@@ -98,8 +88,9 @@ private
     end
   end
 
+
   def handle_response( obj )
-    puts "[Webservice::Base#handle_response] - obj: #{obj.class.name}"
+    puts "[Webservice::Base#handle_response] - obj : #{obj.class.name}"
 
     ### todo/fix: set content type to json
 

data/lib/webservice/version.rb

@@ -2,8 +2,8 @@
 
 module Webservice
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 2
-  PATCH = 1
+  MINOR = 3
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/service/app.rb

@@ -3,15 +3,13 @@ get '/' do
   "Hello World"
 end
 
+
 get '/hello/:name' do
   "Hello #{params['name']}"
 end
 
-get '/:message/:name' do
-  @message = params['message']
-  @name    = params['name']
-  "#{@message} #{@name}"
-end
+
+## note: /halt/404 must be before /:message/:name !! otherwise no match!!!
 
 get '/halt/404' do
   halt 404  # 404 - not found
@@ -23,3 +21,15 @@ get '/halt_error' do
   ## todo: check why log reports 200-OK (for status code)!!
 end
 
+
+get '/:message/:name' do
+  message = params['message']
+  name    = params['name']
+  "#{message} #{name}"
+end
+
+get '/:key(.:format)?' do
+  key = params['key']
+  fmt = params['format']
+  "#{key} #{fmt}"
+end

data/test/test_app.rb

@@ -15,9 +15,9 @@ class TestApp < MiniTest::Test
   def app
     ## return (rack-ready) app object
     @@app ||= begin
-      builder = Webservice::Builder.load_file( "#{Webservice.root}/test/service/app.rb" )
-      pp builder.app_class.routes
-      builder.app_class.new
+      app_class = Webservice.load_file( "#{Webservice.root}/test/service/app.rb" )
+      pp app_class.routes
+      app_class.new
     end
   end
 
@@ -51,6 +51,22 @@ class TestApp < MiniTest::Test
     assert_equal %q{"Hallo Welt"}, last_response.body
   end
 
+
+  def test_format
+    get '/key.format'
+    assert last_response.ok?
+    assert_equal %q{"key format"}, last_response.body
+
+    get '/ottakringer.csv'
+    assert last_response.ok?
+    assert_equal %q{"ottakringer csv"}, last_response.body
+
+    get '/ottakringer'
+    assert last_response.ok?
+    assert_equal %q{"ottakringer "}, last_response.body
+  end
+
+
   def test_halt
     ## get '/halt/404'
     get '/halt/404'

data/test/test_mustermann.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_mustermann.rb
+
+
+require 'helper'
+
+
+class TestMustermann < MiniTest::Test
+
+  def test_hello
+
+    pp Rack::VERSION
+    pp Mustermann::VERSION
+
+    pattern = Mustermann::Sinatra.new( '/:name' )
+    pp pattern
+    pp pattern.names
+
+    m = pattern.match( "/test" )
+    pp m
+    pp m.captures
+    params = pattern.params( "/test" )
+    pp params
+
+
+    m = pattern.match( "/test/test" )
+    pp m
+    params = pattern.params( "/test/test" )
+    pp params
+
+    splat = Mustermann::Sinatra.new( '/:prefix/*.*' )
+    params = splat.params('/a/b.c') # => { "prefix" => "a", splat => ["b", "c"] }
+    pp params
+
+    fmt = Mustermann::Sinatra.new( '/:name(.:format)?' )
+    params = fmt.params( '/hello.json' )
+    pp params
+    params = fmt.params( '/hello' )
+    pp params
+
+    rnd = Mustermann::Sinatra.new( '/beer/(r|rnd|random)' )
+    params = rnd.params( '/beer/rnd' )
+    pp params
+    params = rnd.params( '/beer/ottakringer' )
+    pp params
+    params = rnd.params( '/test/beer/ottakringer' )
+    pp params
+
+
+    assert true  # if we get here - test success
+  end
+
+end # class TestMustermann

data/test/test_samples.rb

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webservice
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -81,13 +95,13 @@ files:
 - Rakefile
 - lib/webservice.rb
 - lib/webservice/base.rb
-- lib/webservice/builder.rb
 - lib/webservice/version.rb
 - test/helper.rb
 - test/service/app.rb
 - test/test_app.rb
-- test/test_builder.rb
-- test/test_builder_debug.rb
+- test/test_mustermann.rb
+- test/test_samples.rb
+- test/test_samples_debug.rb
 homepage: https://github.com/rubylibs/webservice
 licenses:
 - Public Domain

data/lib/webservice/builder.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-
-module Webservice
-
-class Builder
-
-  def self.load_file( path)
-    code = File.open( path, 'r:bom|utf-8' ).read
-    self.load( code )
-  end
-
-  def self.load( code )
-     app_class = Class.new( Base )
-     app_class.class_eval( code )   ## note: use class_eval (NOT instance_eval)
-
-     builder = Builder.new
-     builder.app_class = app_class
-     builder
-  end
-
-
-  include LogUtils::Logging
-
-  attr_accessor :app_class
-
-  def initialize
-  end
-
-
-end # class Builder
-
-end # module Webservice

data/test/test_builder.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_builder.rb
-
-
-require 'helper'
-
-
-class TestBuilder < MiniTest::Test
-
-  def test_beer_builder
-    builder = Webservice::Builder.load_file( "#{Webservice.root}/examples/beer.rb" )
-    pp builder.app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-  def test_football_builder
-    builder = Webservice::Builder.load_file( "#{Webservice.root}/examples/football.rb" )
-    pp builder.app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-  def test_world_builder
-    builder = Webservice::Builder.load_file( "#{Webservice.root}/examples/world.rb" )
-    pp builder.app_class.routes
-
-    assert true  # if we get here - test success
-  end
-
-end # class TestBuilder

data/test/test_builder_debug.rb

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