webservice 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fca9552fa4818068271c81022e7ab9a4ec277d30
-  data.tar.gz: 23e2d0051213a5834cafff2762df4324c6907935
+  metadata.gz: 1cbf8b69b97842dcc85d69c5941b1df7533183d3
+  data.tar.gz: 21a647b38f0143f1075be6f1171b22a8f333e10b
 SHA512:
-  metadata.gz: 6b53f3b4ea61aed918b16b5b73ad3be4e162131599d6cb1222607097d5cff3f8757222458373a2a3e30dbea91d47f32c092f6557e274bebcbdaf0ae8c121f992
-  data.tar.gz: b32faf56e9286e1b4283d900f59f7b1af4bfd89b70366e849200c014540c8e80c45a9110a1d51239372eb414aec5f5f308149960786d6d32f254a942fd404a85
+  metadata.gz: 8a55ee94ae9ad07ddfe3dd1428c5e503ceaca7b9180c965f99c3891ca3952caf008b53aaf51dd18ce71f228ca5aca716377d227f112c1cbcf99c9b8caaa4fcc8
+  data.tar.gz: e3d677611c7240886b37380b9cd36ae546abbf561cb2ee9dbc2501eee04e3b0f888d0dd6192949d43c2fb5c3d207da2534903372c813dbe8607e82590b8ee8a0

data/Manifest.txt

@@ -2,8 +2,10 @@ HISTORY.md
 Manifest.txt
 README.md
 Rakefile
+assets/webservice-32x32.png
 lib/webservice.rb
 lib/webservice/base.rb
+lib/webservice/response_handler.rb
 lib/webservice/version.rb
 test/helper.rb
 test/service/app.rb

data/lib/webservice.rb

@@ -24,6 +24,8 @@ require 'rack'
 require 'webservice/version'   # note: let version always go first
 require 'webservice/base'
 
+require 'webservice/response_handler'     ## default (built-in) response handler (magic)
+
 
 
 module Webservice

data/lib/webservice/base.rb

@@ -16,8 +16,9 @@ module Webservice
   ##  HTTP headers
   CONTENT_LENGTH = Rack::CONTENT_LENGTH
   CONTENT_TYPE   = Rack::CONTENT_TYPE
-
-  LOCATION      = 'Location'.freeze      # not available from Rack
+  # -- more HTTP headers - not available from Rack
+  LOCATION       = 'Location'.freeze
+  LAST_MODIFIED  = 'Last-Modified'.freeze
 
 
 module Helpers
@@ -71,6 +72,56 @@ module Helpers
         ### 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
 
 
@@ -123,6 +174,27 @@ class Base
     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 ??)
@@ -152,6 +224,9 @@ class Base
   attr_reader :params
   attr_reader :env
 
+  attr_reader :handler   # default response_handler/respond_with handler magic
+
+
   def call( env )
     dup.call!( env )
   end
@@ -164,7 +239,9 @@ class Base
     @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'  => '*',
@@ -187,7 +264,10 @@ class Base
 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}<..."
@@ -198,10 +278,24 @@ private
             ## todo/fix: check merge order - params overwrites url_params - why? why not??
             @params = url_params.merge( @params )
           end
-          handle_response( instance_eval( &block ))
+          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
@@ -209,157 +303,77 @@ private
 
 
 
-  ## todo: add as_json like opts={}  why? why not?
-  def handle_response( obj, opts={} )
-    puts "[Webservice::Base#handle_response (#{request.path_info}) params: #{params.inspect}] - obj : #{obj.class.name}"
-    pp obj
-
-    ## "magic" param format; default to json
-    format = params['format'] || 'json'
-
-    ## note: response.body must be (expects) an array!!!
-    ##   thus, [json] etc.
-
-    if format == 'csv'  || format == 'txt' ||
-       format == 'html' || format == 'htm'
-
-      data = as_tabular( obj )
+  ##################################
+  ### add some fallback (builtin) routes
 
-      ## note: array required!!!
-      #   array   => multiple records (array of hashes)
-      if data.is_a?( Array )
-        if format == 'csv'  || format == 'txt'
-           content_type :txt   ## use csv content type - why? why not??
-           response.body = [generate_csv( data )]
-        else
-          ## asume html
-          content_type :html
-          response.body = [generate_html_table( data )]
-        end
-      else
-        ## wrong format (expect array of hashes)
-        ##   todo: issue warning/notice about wrong format - how?
-        ##   use different http status code - why? why not??
-        content_type :txt
-        ##  todo/check: use just data.to_s  for all - why? why not?
-        ## for now return as is (convert to string with to_s or inspect)
-        response.body = [data.is_a?( String ) ? data.to_s : data.inspect]
-      end
-    else
-      data = as_json( obj )
-
-      ## note: hash or array required!!! for now for json generation
-      #   hash   => single record
-      #   array  => multiple records (that is, array of hashes)
-
-      if data.is_a?( Hash ) || data.is_a?( Array )
-        json = JSON.pretty_generate( data )   ## use pretty printer
-
-        callback = params.delete( 'callback' )
+    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
 
-        if callback
-          content_type :js
-          response.body = ["#{callback}(#{json})"]
-        else
-          content_type :json
-          response.body = [json]
-        end
-      else
-         ## todo/fix/check: change http status to unprocessable entity
-         ##   or something --  why ??? why not??
-         ##
-         ##  allow "standalone" number, nils, strings - why? why not?
-         ##   for now valid json must be wrapped in array [] or hash {}
-         content_type :txt
-         ##  todo/check: use just data.to_s  for all - why? why not?
-         ## for now return as is (convert to string with to_s or inspect)
-         response.body = [data.is_a?( String ) ? data.to_s : data.inspect]
-      end
+    fallback_route GET, '/webservice-32x32.png' do
+      send_file "#{Webservice.root}/assets/webservice-32x32.png"
     end
-  end  # method handle_response
 
+    fallback_route GET, '/routes' do
+    msg =<<TXT
+#{dump_routes}
 
+#{dump_version}
+TXT
+end
 
-  def generate_csv( recs )
-    ## note: for now assumes (only works with) array of hash records e.g.:
-    ## [
-    ##     { key: 'at', name: 'Austria', ...},
-    ##     { key: 'mx', name: 'Mexico', ...},
-    ##     ...
-    ## ]
+  ## catch all (404 not found)
+  fallback_route GET, '/*' do
+    pp env
+    pp self.class.routes
 
-    ## :col_sep => "\t"
-    ## :col_sep => ";"
+    msg =<<TXT
+  404 Not Found
 
-    ## todo: use rec.key for headers/first row
+  No route matched >#{request.request_method} #{request.path_info}<:
 
-    ## pp recs
+    REQUEST_METHOD: >#{request.request_method}<
+    PATH_INFO:      >#{request.path_info}<
+    QUERY_STRING:   >#{request.query_string}<
 
-    CSV.generate do |csv|
-      recs.each do |rec|
-        csv << rec.values
-      end
-    end
-  end
+    SCRIPT_NAME:    >#{request.script_name}<
+    REQUEST_URI:    >#{env['REQUEST_URI']}<
 
 
-  def generate_html_table( recs )
-    ## note: for now assumes (only works with) array of hash records e.g.:
-    ## [
-    ##     { key: 'at', name: 'Austria', ...},
-    ##     { key: 'mx', name: 'Mexico', ...},
-    ##     ...
-    ## ]
+#{dump_routes}
 
-    ## pp recs
+#{dump_version}
+TXT
 
-    buf = ""
-    buf << "<table>\n"
-    recs.each do |rec|
-      buf << "  <tr>"
-      rec.values.each do |value|
-        buf << "<td>#{value}</td>"
-      end
-      buf << "</tr>\n"
-    end
-    buf << "</table>\n"
-    buf
+    halt 404, msg
   end
 
+############################
+## fallback helpers
 
-  ##########################################
-  ## auto-generate/convert "magic"
-
-  def as_tabular( obj, opts={} )
-    ##  for now allow
-    ##    as_tab, as_tabular  - others too? e.g. as_table why? why not?
-    ##   like as_json will return a hash or array of hashes NOT a string!!!!
+  def dump_routes    ## todo/check - rename to build_routes/show_routes/etc. - why? why not?
+    buf = ""
+    buf <<"  Routes >#{self.class.name}<:\n\n"
 
-    if obj.respond_to? :as_tab
-      obj.as_tab
-    elsif obj.respond_to? :as_tabular
-      obj.as_tabular
-    else
-      ## note: use as_json will return hash (for record) or array of hashes (for records)
-      if obj.respond_to? :as_json
-        obj.as_json
-      else
-        obj   ## just try/use as is (assumes array of hashesd)
+    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 as_json( obj, opts={} )
-    if obj.respond_to? :as_json_v3     ## try (our own) serializer first
-      obj.as_json_v3
-    elsif obj.respond_to? :as_json_v2     ## try (our own) serializer first
-      obj.as_json_v2
-    elsif obj.respond_to? :as_json     ## try (activerecord) serializer
-      obj.as_json
-    else
-      obj   ## just try/use as is
-    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

data/lib/webservice/response_handler.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+
+## default (built-in) response handler
+
+module Webservice
+
+
+class ResponseHandler
+
+
+  def initialize( app )
+    @app = app
+  end
+
+  ## delegate request, response, params, env
+  ##   todo/fix: use def_delegate - why? why not???
+  def request()   @app.request;   end
+  def response()  @app.response;  end
+  def params()    @app.params;    end
+  def env()       @app.env;       end
+
+  ## delegate some helpers too
+  def content_type( type=nil )  @app.content_type( type ); end
+
+
+
+  ## todo: add as_json like opts={}  why? why not?
+  def handle_response( obj, opts={} )
+    puts "[Webservice::Handler#handle_response (#{request.path_info}) params: #{params.inspect}] - obj : #{obj.class.name}"
+    pp obj
+
+    ## "magic" param format; default to json
+    format = params['format'] || 'json'
+
+    ## note: response.body must be (expects) an array!!!
+    ##   thus, [json] etc.
+
+    if format == 'csv'  || format == 'txt' ||
+       format == 'html' || format == 'htm'
+
+      data = as_tabular( obj )
+
+      if data.is_a? Tabular
+        if format == 'csv'  || format == 'txt'
+           content_type :txt   ## use csv content type - why? why not??
+           response.body = [data.to_csv]
+        else
+          ## assume html
+          content_type :html
+          response.body = [data.to_html_table]
+        end
+      else
+        ## wrong format (expected Tabular from as_tabular - cannot convert)
+        ##   todo: issue warning/notice about wrong format - how?
+        ##   use different http status code - why? why not??
+        content_type :txt
+        ##  todo/check: use just data.to_s  for all - why? why not?
+        ## for now return as is (convert to string with to_s or inspect)
+        response.body = [data.is_a?( String ) ? data.to_s : data.inspect]
+      end
+    else    ## default/assume json
+      data = as_json( obj )
+
+      ## note: hash or array required!!! for now for json generation
+      #   hash   => single record
+      #   array  => multiple records (that is, array of hashes)
+
+      if data.is_a?( Hash ) || data.is_a?( Array )
+        json = JSON.pretty_generate( data )   ## use pretty printer
+
+        callback = params.delete( 'callback' )
+
+        if callback
+          content_type :js
+          response.body = ["#{callback}(#{json})"]
+        else
+          content_type :json
+          response.body = [json]
+        end
+      else
+         ## todo/fix/check: change http status to unprocessable entity
+         ##   or something --  why ??? why not??
+         ##
+         ##  allow "standalone" number, nils, strings - why? why not?
+         ##   for now valid json must be wrapped in array [] or hash {}
+         content_type :txt
+         ##  todo/check: use just data.to_s  for all - why? why not?
+         ## for now return as is (convert to string with to_s or inspect)
+         response.body = [data.is_a?( String ) ? data.to_s : data.inspect]
+      end
+    end
+  end  # method handle_response
+
+
+  ##########################################
+  ## auto-generate/convert "magic"
+
+  def as_tabular( obj, opts={} )
+     headers = []
+     headers_clone = []  ## keep an unmodified (e.g. with symbols not string) headers/keys clone
+     rows    = []
+     errors  = []
+
+     if obj.respond_to? :to_a    ### convert activerecord relation to array (of records)
+       recs = obj.to_a
+     elsif obj.is_a? Array
+       recs = obj
+     else
+       ## return as is; cannot convert
+       ##   todo/fix: handle cannot convert different (e.g. except etc.) - why? why not??
+       puts "!!!! [as_tabular] sorry; can't convert <#{obj.class.name}> - Array or to_a method required"
+       return obj
+     end
+
+
+       recs.each do |rec|
+         puts "rec #{rec.class.name}"
+         if rec.respond_to? :as_row
+           row = rec.as_row
+           rows << row.values   ## add rows as is 1:1
+         elsif rec.respond_to?( :as_json_v3 ) ||
+               rec.respond_to?( :as_json_v2 ) ||
+               rec.respond_to?( :as_json )    ||
+               rec.is_a?( Hash )   ## allow (plain) hash too  - give it priority (try first?) - why? why not??
+
+           if rec.respond_to? :as_json_v3
+               row = rec.as_json_v3
+           elsif rec.respond_to? :as_json_v2
+               row = rec.as_json_v2
+           elsif rec.respond_to? :as_json
+               row = rec.as_json
+           else
+               row = rec    ## assume it's already a hash (with key/value pairs)
+           end
+
+           ##  convert nested values e.g. array and hash to strings
+           values = row.values.map do |value|
+             if value.is_a? Hash
+               ## todo: use our own "pretty printer" e.g. use unqouted strings - why? why not?
+               value.to_json  ## use to_json "key": "value" instead of :key => "value"
+             elsif value.is_a? Array
+               ## todo: use our own "pretty printer" e.g. use unqouted strings - why? why not?
+               ## value = "[#{value.join('|')}]" ## use | for joins (instead of ,) - why? why not?? keep comma(,) - why? why not??
+               value.to_json
+             else
+               value
+             end
+           end
+           pp values
+           rows << values
+         else
+            ## todo: add record index - why? why not?
+            puts "sorry; can't convert - as_row or as_json method or hash required"
+            errors << "sorry; can't convert <#{rec.class.name}> - as_row or as_json method or hash required"
+            next
+         end
+
+         ## check headers - always must match!!!!!!!
+         if headers.empty?
+           headers_clone = row.keys
+           pp headers_clone
+           headers = headers_clone.map { |header| header.to_s }
+           pp headers
+         else
+           ## todo: check if headers match!!!
+         end
+       end  # recs.each
+
+    if errors.empty?
+      Tabular.new( headers, rows )
+    else   ## return row of errors
+      ##  return errors as a (simple) multi-line string - why? why not??
+      errors.join( "\n" )
+    end
+
+  end   # method as_tabular
+
+
+  def as_json( obj, opts={} )
+    if obj.respond_to? :as_json_v3     ## try (our own) serializer first
+      obj.as_json_v3
+    elsif obj.respond_to? :as_json_v2     ## try (our own) serializer first
+      obj.as_json_v2
+    elsif obj.respond_to? :as_json     ## try (activerecord) serializer
+      obj.as_json
+    else
+      obj   ## just try/use as is
+    end
+  end
+
+
+######
+#  Tabular helper/support class
+
+  class Tabular
+
+    attr_reader :headers
+    attr_reader :rows
+
+    def initialize( headers, rows )
+      @headers = headers
+      @rows    = rows
+    end
+
+    def to_csv( opts={} )
+       ## allow changing of column/value separator (col_sep) - why? why not?
+       ##   :col_sep => "\t"
+       ##   :col_sep => ";"
+
+       pp self
+
+       CSV.generate( headers: true ) do |csv|
+        csv << headers
+        rows.each do |row|
+          csv << row
+        end
+      end
+    end # method to_csv
+
+
+    def to_html_table( opts={} )
+
+      ## todo/fix: html escape values - why? why not??
+
+      pp self
+
+      buf = ""
+      buf << "<table>\n"
+      buf << "  <tr>"
+      headers.each do |header|
+        buf << "<th>#{header}</th>"
+      end
+      buf << "</tr>\n"
+
+      rows.each do |row|
+        buf << "  <tr>"
+        row.each do |value|
+          buf << "<td>#{value}</td>"
+        end
+        buf << "</tr>\n"
+      end
+      buf << "</table>\n"
+      buf
+    end # method to_html_table
+  end # class Tabular
+
+end  # class ResponseHandler
+end # module Webservice

data/lib/webservice/version.rb

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

data/test/test_app.rb

@@ -72,6 +72,7 @@ class TestApp < MiniTest::Test
     get '/countries.csv'
     assert last_response.ok?
     assert_equal <<CSV, last_response.body
+key,name
 at,Austria
 mx,Mexico
 CSV
@@ -80,32 +81,25 @@ CSV
     assert last_response.ok?
     assert_equal <<HTML, last_response.body
 <table>
+  <tr><th>key</th><th>name</th></tr>
   <tr><td>at</td><td>Austria</td></tr>
   <tr><td>mx</td><td>Mexico</td></tr>
 </table>
 HTML
 
 
-countries_json = <<JSON.strip
-[
-  {
-    "key": "at",
-    "name": "Austria"
-  },
-  {
-    "key": "mx",
-    "name": "Mexico"
-  }
-]
-JSON
+  countries_json = [
+    { 'key' => 'at', 'name' => 'Austria' },
+    { 'key' => 'mx', 'name' => 'Mexico'  },
+  ]
 
    get '/countries.json'
    assert last_response.ok?
-   assert_equal countries_json, last_response.body
+   assert_equal countries_json, JSON.parse( last_response.body )
 
    get '/countries'
    assert last_response.ok?
-   assert_equal countries_json, last_response.body
+   assert_equal countries_json, JSON.parse( last_response.body )
   end  # method test_countries
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webservice
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-26 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -93,8 +93,10 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- assets/webservice-32x32.png
 - lib/webservice.rb
 - lib/webservice/base.rb
+- lib/webservice/response_handler.rb
 - lib/webservice/version.rb
 - test/helper.rb
 - test/service/app.rb