webservice 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64db4f0483ecfe48d4e3cfd610da49d8a9d8f855
-  data.tar.gz: d4d0db3429872b4eb0a19075431cb6a4876a8ac4
+  metadata.gz: b43248423b9aeba87a88f63b6a708167bbf7d723
+  data.tar.gz: 35b9cd86f34c708a4d55f7f61a08a878f4e19d12
 SHA512:
-  metadata.gz: 3d62d10f13fead1c48ed70b2ff03cadfd185046446f0478cc9ddb5b4da7ac03a68dddbfe418bfde039279a43fec946c5dba692996857b020de5fb186fc6ba5ca
-  data.tar.gz: f89d934fcc0efc22e3a3a9ae86ff3f07fb0e26fb8f606e178e7b6aabdcbf1a50a4c6c8c1e8f2acc529133560d8a5a9ac218403ef50fc1945ac31a4fe252ac68f
+  metadata.gz: def6d86899d29ca10acb0c70af15de8887005fc47dc9f1d5586103eb98033d7e68d5c44744c51b30493cbcef344a565f9dbcc21c6681aa55257e42c772c0f307
+  data.tar.gz: 2417ece5303df96025515574a343e2b21eaa1e08015ff7cfe11822a9d9d757c918a798e149d1d03f24b74a7574e0ef6e4625778b6b63b6b42fa0f403c31adb19

data/lib/webservice.rb

@@ -2,6 +2,7 @@
 
 ## stdlib
 require 'json'
+require 'csv'
 require 'pp'
 
 

data/lib/webservice/base.rb

@@ -3,21 +3,85 @@
 
 module Webservice
 
-class Base
 
-  HTTP_VERBS = %w(GET POST PATCH PUT DELETE HEAD OPTIONS)
+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 redirect/redirect_to
+    ##         add status -- why? why not??
+
+    # Halt processing and return the error status provided.
+    def error(code, body=nil)
+      code = 500
+      body = code.to_str if code.respond_to? :to_str
+
+      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
+
+    # 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
+end  ## module Helpers
 
 
+class Base
+  include Helpers
+
   class << self
 
     ## todo/check: all verbs needed! (supported) - why, why not??
-    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}> : #{self.class.name}"
+    ##   e.g. add LINK, UNLINK ??
 
-        ## note: for now use the sintatra-style patterns (with mustermann)
-        routes[method] << [Mustermann::Sinatra.new(pattern), block]
-      end
+    # 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
 
 
@@ -26,6 +90,17 @@ class Base
     end
 
 
+    def environment
+      ## include APP_ENV why? why not?
+      ##   todo -- cache value? why why not?  (see/follow sinatara set machinery ??)
+      (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
@@ -39,7 +114,6 @@ class Base
   end  ## class << self
 
 
-
   attr_reader :request
   attr_reader :response
   attr_reader :params
@@ -67,7 +141,6 @@ class Base
     throw :halt, response
   end
 
-
 private
 
   def route_eval
@@ -78,6 +151,7 @@ private
         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
           handle_response( instance_eval( &block ))
@@ -89,20 +163,97 @@ private
   end
 
 
+
+
   def handle_response( obj )
-    puts "[Webservice::Base#handle_response] - obj : #{obj.class.name}"
+    puts "[Webservice::Base#handle_response (#{request.path_info}) params: #{params.inspect}] - obj : #{obj.class.name}"
+    pp obj
 
-    ### todo/fix: set content type to json
+    ## "magic" param format; default to json
+    format = params['format'] || 'json'
 
-    if obj.respond_to?( :as_json_v2 )
-      response.write obj.as_json_v2
+    if format == 'csv' || format == 'txt'
+      text = generate_csv( obj )
+      content_type :text
+      response.write text
+    elsif format == 'html' || format == 'htm'
+      text = generate_html_table( obj )
+      content_type :html
+      response.write text
     else
-      ## just try/use to_json
-      response.write obj.to_json
+      json = generate_json( obj )
+
+      callback = params.delete('callback')
+
+      if callback
+        content_type :js
+        response.write "#{callback}(#{json})"
+      else
+        content_type :json
+        response.write json
+      end
+    end
+  end  # method handle_response
+
+
+  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', ...},
+    ##     ...
+    ## ]
+
+    ## :col_sep => "\t"
+    ## :col_sep => ";"
+
+    ## todo: use rec.key for headers/first row
+
+    ## pp recs
+
+    CSV.generate do |csv|
+      recs.each do |rec|
+        csv << rec.values
+      end
     end
   end
 
 
+  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', ...},
+    ##     ...
+    ## ]
+
+    ## pp recs
+
+    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
+  end
+
+
+  def generate_json( obj )
+    if 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_v2
+    else
+      ## just try/use to_json
+      obj.to_json
+    end
+  end
+
 end # class Base
 
 end # module Webservice

data/lib/webservice/version.rb

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

data/test/service/app.rb

@@ -22,6 +22,14 @@ get '/halt_error' do
 end
 
 
+get '/countries(.:format)?' do
+  ## array of hash records
+   [ { key: 'at', name: 'Austria' },
+     { key: 'mx', name: 'Mexico'  } ]
+end
+
+
+
 get '/:message/:name' do
   message = params['message']
   name    = params['name']

data/test/test_app.rb

@@ -57,9 +57,9 @@ class TestApp < MiniTest::Test
     assert last_response.ok?
     assert_equal %q{"key format"}, last_response.body
 
-    get '/ottakringer.csv'
+    get '/ottakringer.xxx'
     assert last_response.ok?
-    assert_equal %q{"ottakringer csv"}, last_response.body
+    assert_equal %q{"ottakringer xxx"}, last_response.body
 
     get '/ottakringer'
     assert last_response.ok?
@@ -67,6 +67,34 @@ class TestApp < MiniTest::Test
   end
 
 
+  def test_countries
+
+    get '/countries.csv'
+    assert last_response.ok?
+    assert_equal <<CSV, last_response.body
+at,Austria
+mx,Mexico
+CSV
+
+    get '/countries.html'
+    assert last_response.ok?
+    assert_equal <<HTML, last_response.body
+<table>
+  <tr><td>at</td><td>Austria</td></tr>
+  <tr><td>mx</td><td>Mexico</td></tr>
+</table>
+HTML
+
+   get '/countries.json'
+   assert last_response.ok?
+   assert_equal %q<[{"key":"at","name":"Austria"},{"key":"mx","name":"Mexico"}]>, last_response.body
+
+   get '/countries'
+   assert last_response.ok?
+   assert_equal %q<[{"key":"at","name":"Austria"},{"key":"mx","name":"Mexico"}]>, last_response.body
+  end  # method test_countries
+
+
   def test_halt
     ## get '/halt/404'
     get '/halt/404'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webservice
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils