tsurezure 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04f09bb09e26d531a84b5738dd7719b2dee55ef2c73845bca3700c1a5f20c25
-  data.tar.gz: 6b3c83431259f111dd024f00860dfa9e10a8caad5e123f51b7085ca6dbced9db
+  metadata.gz: 1dd0633006bc7ba5837c37817e78d1f7a1fdc38520557c10a528fd40acff2573
+  data.tar.gz: 420c2cc0bd0387c24cbe5d12b40aad574edd1e4e0f2a4bbf6b39eeb323ccdaec
 SHA512:
-  metadata.gz: '038ed41337233b9e7debfaed3da1d2984f8d2e11b46e02ed175da71e12eab878433a4151cefa06fbf0b247dd19d4eff5acb2fb252b6951f0df0084397eae4c14'
-  data.tar.gz: b9a87b64323fb67155ff68f24f3c390807663de010b39c57d2a73a5aa4559181994603bc41b11ba44af74bc3824b78e317368166a63a37e4c2091b2159b342fa
+  metadata.gz: 358fbcfcd4504ea64c5afad8b80f5600a4bab693e48bcf536700315ce6766b54988bf4b25e8e6aeeb71facf7773515bdf0bb0bf4c2c1fc27687f984562af0ad1
+  data.tar.gz: 6a581bcabeb9556e2649c6893b9cfdf7553e27726f86446e35feaaba48f19126b124f0019ad45090d095704102a00e3b5834908e3ab045c70c1d11913a021636

data/lib/tsurezure.rb

@@ -12,6 +12,7 @@ require_relative 'utils/response' # handles request and generates responses.
 
 $TRZR_PROCESS_MODE = nil
 $TRZR_LOG = true
+TRZR_STARTED_AT = Time.now.to_i
 
 ARGV.each do |arg|
   $TRZR_PROCESS_MODE = 'development' if arg == '--development'
@@ -205,8 +206,14 @@ class Tsurezure
 
   ##
   # run when the server is prepared to accept requests.
-  def listen
-    puts "running on port #{@port}!"
+  def listen(callback = nil)
+    if $TRZR_PROCESS_MODE == 'development'
+      puts "[trzr_dev] running on port #{@port}!"
+    end
+
+    # call the callback if there's one provided
+    callback.call server_opts if callback.is_a? Proc
+
     # create a new thread for handle each incoming request
     loop do
       Thread.start(@server.accept) do |client|
@@ -215,8 +222,20 @@ class Tsurezure
     end
   end
 
+  def kill
+    abort
+  end
+
   private
 
+  def server_opts
+    {
+      port: @port,
+      endpoints: @endpoints,
+      middleware: @middleware
+    }
+  end
+
   # ----------------------------------------
   # :section: registration of endpoints and
   # all endpoint management methods follow.
@@ -272,10 +291,14 @@ class Tsurezure
     # add endpoint to list of registered endpoints
     @endpoints[method][endpoint[:path]] = endpoint
   end
+end
 
-  def kill
-    abort
+at_exit do
+  if $TRZR_PROCESS_MODE == 'development' && $TRZR_LOG.true?
+    time = Time.now.to_i - TRZR_STARTED_AT
+    puts
+    puts '[trzr_dev] shutting down. goodbye...'
+    puts "[trzr_dev] shut down after #{Time.at(time).utc.strftime('%H:%M:%S')}."
+    puts
   end
 end
-
-at_exit { puts 'shutting down. goodbye...' }

data/readme.md

@@ -23,9 +23,17 @@ after cloning this repo, from the root project directory, just run `rake start`
 
 to build the gem: run `gem build tsurezure.gemspec`. then, install using `gem install tsurezure-version-number`. `version-number` is whatever version is installed based on the `.gemspec` file.
 
+### commands
+
+-   `rake install` will install dependencies
+-   `rake check_deps` will install dependencies if not installed
+-   `rake start` will run the server in production mode
+-   `rake dev` will run the server in development mode
+-   `rake dev_silent` will run the server in development mode with no logs
+
 ### actually using tsurezure:
 
-as for how to use tsurezure, here's a simple hello world to get started:
+as for how to use tsurezure, here's a simple script to get started:
 
 ```ruby
 require 'tsurezure'
@@ -78,6 +86,24 @@ after you run this file, open up your browser or whatever and go to `http://loca
 }
 ```
 
+the `listen` method can be called with no arguments to just start the server. you can also pass in a lambda or proc that will run when the server has started. the only argument that will be passed to that proc is a hash called `server_opts`. it contains some information about the current configuration:
+
+```ruby
+{
+  port, # port that tsurezure is running on
+  endpoints, # endpoints object containing the endpoints you've added
+  middleware # middleware object containing the middleware you've added
+}
+```
+
+simple example of usage:
+
+```ruby
+server.listen lambda { |opts|
+  puts "listening on port #{opts[:port]}!"
+}
+```
+
 the registration function for creating endpoints is very simple:
 
 ```ruby
@@ -92,7 +118,7 @@ register http_method, path, callback, options
 
 `options` is a hash containing various options to somehow modify the response. valid options:
 
--   `content_type` - determines the mime type of the response
+-   `content_type (default: text/plain)` - determines the mime type of the response
 -   `location` - if a location header is required (301, etc), this is used to provide it.
 -   `method` - if an allow header is required (405), this is used to provide it.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsurezure
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - jpegzilla