tsurezure 0.0.1 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04f09bb09e26d531a84b5738dd7719b2dee55ef2c73845bca3700c1a5f20c25
-  data.tar.gz: 6b3c83431259f111dd024f00860dfa9e10a8caad5e123f51b7085ca6dbced9db
+  metadata.gz: 1278a0f85466408f80cdf8978acb8ebe6bd34faa4b5824d7e0fde9a323839454
+  data.tar.gz: 1d98b1c81f4a81955c5983c34aabf9390b953fee5778892a8f1705c573b6669b
 SHA512:
-  metadata.gz: '038ed41337233b9e7debfaed3da1d2984f8d2e11b46e02ed175da71e12eab878433a4151cefa06fbf0b247dd19d4eff5acb2fb252b6951f0df0084397eae4c14'
-  data.tar.gz: b9a87b64323fb67155ff68f24f3c390807663de010b39c57d2a73a5aa4559181994603bc41b11ba44af74bc3824b78e317368166a63a37e4c2091b2159b342fa
+  metadata.gz: 4174e3d1fb4fac4d64ff98e128df388a64ab0e95c41aa67e1e97e70dbaef24f7944b38a191b703218a62a5688cd923fc68e569e197b2937421cd7d37ab47735d
+  data.tar.gz: e707b8e7871b1b47dd6aca8cfee1953b1b3794b3d9c8b7cfc5d226096bb1648e7b95bab439ac9d142739a708eb73de1ca49d847d47c9ea9f0e3064fd8685d614

data/lib/tsurezure.rb

@@ -12,6 +12,10 @@ require_relative 'utils/response' # handles request and generates responses.
 
 $TRZR_PROCESS_MODE = nil
 $TRZR_LOG = true
+TRZR_STARTED_AT = Time.now.to_i
+
+INVALID_RESPONSE_FORMAT = "if responding from a middleware, \
+you must return a hash that includes a :message property."
 
 ARGV.each do |arg|
   $TRZR_PROCESS_MODE = 'development' if arg == '--development'
@@ -85,7 +89,7 @@ class Tsurezure
 
     def get_correct_middleware(request_object)
       @middleware.keys.select do |pat|
-        HTTPUtils::URLUtils.matches_url_regex(pat, request_object[:url]) ||
+        HTTPUtils::URLUtils.matches_url_regex?(pat, request_object[:url]) ||
           pat == '*'
       end
     end
@@ -102,16 +106,29 @@ class Tsurezure
       request
     end
 
+    def respond_with_error(error)
+      Logbook::Dev.log(error)
+
+      message = { error: error }.to_json
+
+      responder = HTTPUtils::ServerResponse.new(
+        @session,
+        message.bytesize
+      )
+
+      responder.respond message, {}, 500, 'application/json'
+    end
+
     def send_middleware_response(req, resp, type)
       res = resp.merge req
 
+      return respond_with_error INVALID_RESPONSE_FORMAT if res[:message].nil?
+
       responder = HTTPUtils::ServerResponse.new(
         @session,
         res[:message].bytesize
       )
 
-      # pp res
-
       responder.respond res[:message], res[:options] || {}, res[:status], type
     end
 
@@ -205,8 +222,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 +238,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 +307,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/lib/utils/http_utils.rb

@@ -25,6 +25,8 @@ module HTTPUtils
     end
 
     def self.url_path_matches?(url, path)
+      return true if url == path
+
       split_url = url.split '/'
       split_path = path.split '/'
 
@@ -49,7 +51,7 @@ module HTTPUtils
       hash_with_variables
     end
 
-    def self.matches_url_regex(url, regex)
+    def self.matches_url_regex?(url, regex)
       return unless url_path_matches? url, regex
 
       matches = url.scan %r{((?<=\/):[^\/]+)}

data/lib/utils/response.rb

@@ -2,6 +2,19 @@
 
 require_relative './http_utils' # mainly used to create http responses.
 
+VALID_METHODS = %w[
+  CONNECT COPY DELETE GET HEAD
+  LINK LOCK MKCOL MOVE OPTIONS
+  PATCH POST PROPFIND PROPPATCH
+  PURGE PUT TRACE UNLINK UNLOCK
+  VIEW
+].freeze
+
+CHECK_METHOD_WARNING = "not found. \
+please ensure you're using the right method!"
+
+INVALID_METHOD_WARNING = 'an invalid method was used!'
+
 ##
 # module for handling all incoming requests to the server
 # stands for TsurezureResponse
@@ -9,36 +22,24 @@ module TResponse
   include HTTPUtils
   # anything that will be needed to create responses
   class Utils
+    attr_reader :valid_methods
+
     def initialize
-      @valid_methods = %w[
-        CONNECT COPY DELETE GET HEAD
-        LINK LOCK MKCOL MOVE OPTIONS
-        OPTIONS PATCH POST PROPFIND
-        PROPPATCH PURGE PUT TRACE
-        UNLINK UNLOCK VIEW
-      ]
+      @valid_methods = VALID_METHODS
     end
 
-    attr_reader :valid_methods
-
     def self.validate_request(request_params)
       # make sure the user has provided a valid http
       # method, a valid uri, and a valid response /
       # response type
-      valid_methods = %w[
-        CONNECT COPY DELETE GET HEAD
-        LINK LOCK MKCOL MOVE OPTIONS
-        OPTIONS PATCH POST PROPFIND
-        PROPPATCH PURGE PUT TRACE
-        UNLINK UNLOCK VIEW
-      ]
-
-      return false unless valid_methods.include? request_params[:method]
+      return true if VALID_METHODS.include? request_params[:method]
+
+      Logbook::Dev.log(INVALID_METHOD_WARNING)
     end
 
     def self.get_correct_endpoint(request_object, endpoints)
       endpoints.keys.select do |pat|
-        HTTPUtils::URLUtils.matches_url_regex(pat, request_object[:url])
+        HTTPUtils::URLUtils.matches_url_regex?(pat, request_object[:url])
       end
     end
 
@@ -61,8 +62,9 @@ module TResponse
     @endpoints = endpoints[request[:method]]
 
     # if no endpoint, respond with root endpoint or 404 middleware
-
     unless Utils.ensure_response(request, @endpoints) == true
+      Logbook::Dev.log(CHECK_METHOD_WARNING)
+
       return { options: { content_type: 'application/json' },
                code: 22, status: 404,
                message: { status: 404, message: 'undefined endpoint' }.to_json }

data/readme.md

@@ -23,17 +23,26 @@ 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
+-   `rake build` will build a `.gem` file based on `tsurezure.gemspec`
+
 ### 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'
 
 # create an instance of tsurezure
-server = Tsurezure.new(8888)
+server = Tsurezure.new 8888
 
-# url: http://localhost:8888/user/1
+# url: http://localhost:8888
 
 # create an endpoint
 server.register 'get', '/user/:id', lambda { |req|
@@ -78,6 +87,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 +119,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.
 
@@ -108,6 +135,8 @@ add_middleware path, callback, options
 
 `options` for middleware are the same as the `options` for endpoints.
 
+**anything** returned from a middleware will be interpreted as you trying to send a modified response. and of course, ruby will interpret the last reached statement in a method as an implicit return. to avoid this, if you want to have a middleware that doesn't necessarily send a response, just use a `return` at the end of your method to return `nil`.
+
 * * *
 
 ## todo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsurezure
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.33
 platform: ruby
 authors:
 - jpegzilla
@@ -14,22 +14,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement