webservice 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07c8ee13d83466e51e8f64a5e99b2a6888cfcfbf
-  data.tar.gz: 97ac77aaa41f5d2e6cc2da96eedf56113a651b56
+  metadata.gz: c0ff082b8bd1417341423a5a5abdee33a74725e8
+  data.tar.gz: da6f80a3b3196dff209bab205bb5576c0c891876
 SHA512:
-  metadata.gz: b37abaf32931d4c68dd8156570339c7be5a5d60bab3715ed6469eea5f5d111a43a3add567baa67821ca68852d3de1c6288a759f0064a0c2e8f31ecd123842c32
-  data.tar.gz: ea119606858cfd41bb05e81880939a478c0d5d587b5f5b42db049c0cd126f3b3f8cb5a946baeb3ee9021b71a84304236ca41fadeb08197f1962d67847ddec3df
+  metadata.gz: 0755f9c681941673028c0951c89ba2b34e832ff9bdc3a9f1c79eaad9ba7c3fa2c56db3beddc87a85bac337d03488bbd61389fcdb30e6cd23b61f8267bc6b048a
+  data.tar.gz: 8580d408cb8fb79baf05c4a9480c7c5b6f59ca2880e608388d62be9d4ced01cc843e5124399a380c91b4c325d5a4ca13a3a022366b1ea0333950535a79d66e64

data/Manifest.txt

@@ -1,9 +1,13 @@
-HISTORY.md
-Manifest.txt
-README.md
-Rakefile
-lib/webservice.rb
-lib/webservice/builder.rb
-lib/webservice/version.rb
-test/helper.rb
-test/test_builder.rb
+HISTORY.md
+Manifest.txt
+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

data/Rakefile

@@ -11,21 +11,21 @@ Hoe.spec 'webservice' do
   self.urls    = ['https://github.com/rubylibs/webservice']
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'ruby-talk@ruby-lang.org'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
-    ['logutils' ],
-    ['textutils' ]   # note: use for File.read_utf8
+    ['logutils'],
+    ['rack', '>=2.0.3']
   ]
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   required_ruby_version: '>= 1.9.2'
+   required_ruby_version: '>= 2.3'
   }
 
 

data/lib/webservice.rb

@@ -3,15 +3,15 @@
 # 3rd party gems/libs
 
 require 'logutils'
-require 'textutils'   # note: used for File.read_utf8 for now
 
+require 'rack'
 
 # our own code
 require 'webservice/version'   # note: let version always go first
 require 'webservice/builder'
-
+require 'webservice/base'
 
 
 
 # say hello
-puts Webservice.banner
+puts Webservice.banner    if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG

data/lib/webservice/base.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+
+module Webservice
+
+class Base
+  class << self
+
+    ## todo/check: all verbs needed! (supported) - why, why not??
+    %w(GET POST PATCH PUT DELETE HEAD OPTIONS).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]
+      end
+    end
+
+##    def builder
+##      @builder ||= Rack::Builder.new
+##    end
+
+    def routes
+      @routes ||= Hash.new { |hash, key| hash[key]=[] }
+    end
+
+
+    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
+      port   = 4567
+      Rack::Handler.get('webrick').run( app, Port:port ) do |server|
+        ## todo: add traps here - why, why not??
+      end
+    end
+
+
+  private
+
+    def compile_pattern( pattern )
+      keys = []
+      pattern.gsub!( /(:\w+)/ ) do |match|
+        keys << $1[1..-1]
+        '([^/?#]+)'
+      end
+      [%r{^#{pattern}$}, keys]
+    end
+  end
+
+
+  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
+    route_eval
+    @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
+    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
+    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)
+          end
+          handle_response( instance_eval( &block ))
+          return
+        end
+      end
+      halt 404
+    end
+  end
+
+  def handle_response( obj )
+    ### todo/fix: set content type to json
+    ###  call serializer or to_json
+
+    ## note: dummy for now
+    if obj.is_a?(String)
+      response.write obj
+    else
+      response.write "hello - obj: #{obj.class.name} - to be done"
+    end
+  end
+
+end # class Base
+  
+end # module Webservice
+

data/lib/webservice/builder.rb

@@ -5,28 +5,28 @@ module Webservice
 class Builder
 
   def self.load_file( path)
-    code = File.read_utf8( path )
+    code = File.open( path, 'r:bom|utf-8' ).read
     self.load( code )
   end
 
   def self.load( code )
-    builder = Builder.new
-    builder.instance_eval( code )
-    builder
+     app_class = Class.new( Base )
+     app_class.instance_eval( code )  ## use class_eval ??
+
+     builder = Builder.new
+     builder.app_class = app_class
+     builder
   end
 
 
   include LogUtils::Logging
 
+  attr_accessor :app_class
+
   def initialize
-    # to be done
   end
 
-  def get( pattern, &block )
-    puts "add route get '#{pattern}'"
-  end
 
 end # class Builder
 
 end # module Webservice
-

data/lib/webservice/version.rb

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

data/test/helper.rb

@@ -9,5 +9,9 @@ require 'minitest/autorun'
 
 
 ## our own code
-require 'webservice'
+require 'webservice'    ## includes rack
+
+
+## more libs
+require 'rack/test'
 

data/test/service/app.rb

@@ -0,0 +1,25 @@
+
+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
+
+get '/halt/404' do
+  halt 404  # 404 - not found
+  ## todo: check why log reports 200-OK (for status code)!!
+end
+
+get '/halt_error' do
+  halt 500, "Error fatal"  # 500 - internal server error
+  ## todo: check why log reports 200-OK (for status code)!!
+end
+

data/test/test_app.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_app.rb
+
+
+require 'helper'
+
+
+class TestApp < MiniTest::Test
+
+  include Rack::Test::Methods
+
+  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
+    end
+  end
+
+  def test_get
+    get '/'
+    assert last_response.ok?
+    assert_equal 'Hello World', last_response.body
+
+    get '/hello/world'
+    assert last_response.ok?
+    assert_equal 'Hello world', last_response.body
+
+    ##############################
+    ## get '/hello/:name'
+    get '/hello/ruby'
+    assert last_response.ok?
+    assert_equal 'Hello ruby', last_response.body
+
+    get '/hello/ruby?test=t'   ## try w/ extra query string/params
+    assert last_response.ok?
+    assert_equal 'Hello ruby', last_response.body
+
+    ##################################
+    ## get '/:message/:name'
+    get '/servus/wien'
+    assert last_response.ok?
+    assert_equal 'servus wien', last_response.body
+
+    get '/Hallo/Welt'
+    assert last_response.ok?
+    assert_equal 'Hallo Welt', last_response.body
+  end
+
+  def test_halt
+    ## get '/halt/404'
+    get '/halt/404'
+
+    ## get '/halt_error'   - 500, "Error fatal"  # 500 - internal server error
+    get '/halt_error'
+
+    ## todo: check error codes
+    assert true
+  end
+
+end # class TestApp

data/test/test_builder.rb

@@ -12,18 +12,21 @@ 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

data/test/test_builder_debug.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webservice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: textutils
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -58,16 +58,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.16'
 description: webservice - yet another HTTP JSON API (web service) builder
-email: webslideshow@googlegroups.com
+email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -75,16 +75,19 @@ extra_rdoc_files:
 - Manifest.txt
 - README.md
 files:
-- ".gemtest"
 - HISTORY.md
 - Manifest.txt
 - 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
 homepage: https://github.com/rubylibs/webservice
 licenses:
 - Public Domain
@@ -99,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: webservice - yet another HTTP JSON API (web service) builder
-test_files:
-- test/test_builder.rb
+test_files: []