tsurezure 0.0.2 → 0.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dd0633006bc7ba5837c37817e78d1f7a1fdc38520557c10a528fd40acff2573
-  data.tar.gz: 420c2cc0bd0387c24cbe5d12b40aad574edd1e4e0f2a4bbf6b39eeb323ccdaec
+  metadata.gz: 818cbc747a3775c0d73c76bad34638238d99bdbb3363adf1bd1104e635e8ab3e
+  data.tar.gz: 00c69ab8c119c41aa6481460518b27b5b9d29b7405263473be83d0fdb2a3a0c9
 SHA512:
-  metadata.gz: 358fbcfcd4504ea64c5afad8b80f5600a4bab693e48bcf536700315ce6766b54988bf4b25e8e6aeeb71facf7773515bdf0bb0bf4c2c1fc27687f984562af0ad1
-  data.tar.gz: 6a581bcabeb9556e2649c6893b9cfdf7553e27726f86446e35feaaba48f19126b124f0019ad45090d095704102a00e3b5834908e3ab045c70c1d11913a021636
+  metadata.gz: a7c352282df3696c3e2458d0c883d416a5202d16d2df7394ea36989cd8b31985b5fad00040eed6b7771fd2294a4c888f713f70280205540b626016804afa488e
+  data.tar.gz: e2e008a906f18c39fddf09c64fd238d2fdf06b73ea9e2f89425d8a8d4fdaea91b86cd0dbc1083b10d3d95c390dcd7b14e5ef9893c2f59917919878bcab73a59f

data/lib/tsurezure.rb

@@ -14,6 +14,9 @@ $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'
   $TRZR_PROCESS_MODE = 'production' if arg == '--production'
@@ -78,7 +81,7 @@ class Tsurezure
       # to initialize: session and length of response
       responder = HTTPUtils::ServerResponse.new(
         @session,
-        res[:message].bytesize
+        res[:message].nil? ? '' : res[:message].bytesize
       )
 
       go_through_middleware request_object, responder, res, type
@@ -86,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
@@ -103,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
 
@@ -294,7 +310,7 @@ class Tsurezure
 end
 
 at_exit do
-  if $TRZR_PROCESS_MODE == 'development' && $TRZR_LOG.true?
+  if $TRZR_PROCESS_MODE == 'development' && $TRZR_LOG == true
     time = Time.now.to_i - TRZR_STARTED_AT
     puts
     puts '[trzr_dev] 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

@@ -30,6 +30,7 @@ to build the gem: run `gem build tsurezure.gemspec`. then, install using `gem in
 -   `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:
 
@@ -39,9 +40,9 @@ as for how to use tsurezure, here's a simple script to get started:
 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|
@@ -134,10 +135,14 @@ 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
 
+-   [ ]  I'm wondering if I should change the implementation of the middleware functionality. currently, the middleware has no idea where the request it's processing is about to go. I'm thinking it may be a good idea to pass in the request's determined `responder` function which is determined before middleware is called (see `tsurezure.rb:135-160`). this will allow users to choose whether to call the final responder function. I don't know if this would be better or just different.
+
 -   [ ]  make it so registered uris can only be accessed with the specified method, and everything else returns a 405 (maybe make this an option??)
 
 -   [ ]  give the user an option to add middleware specifically for catching errors

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsurezure
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.34
 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