tsurezure 0.0.3 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea5a7cacb68e7a40425ab3e5bd34441a9c332011af18eb29c17d1b4efb558c57
-  data.tar.gz: 64375f61e8060485b344f9b25bb5e2f5287f974b0e5accad0d6f2f08a37db621
+  metadata.gz: a3f470685236ef86ac858933ef4c913a99f21a4e0d42572971518781056c68f1
+  data.tar.gz: b6aede8db5d91dc1be40ddca3fc5011e1494084eb5e38f7df30edd8a426a316d
 SHA512:
-  metadata.gz: 30f7604ff09e33af954dfba8ce4ff1d42ddcee8fe7d876060045b8519587467d0dab1ae907b3d911426f3195dceca4299c57bd27ee0f8556278675b415228b2b
-  data.tar.gz: 81f2b015395092371bb8452169ec4231987788bc28feb9a41c7f826bd3b0fa6a4a67ad52ef6174f7ceeae3e5e21ca088137e9d173da71f001d04492dff848533
+  metadata.gz: 73dc499f770f090d7c5ad90ebfd3cf59922c105e84bb4a65713694b0d802c79ecc1e1a36191de3dd6e90984df689319bc4d3cdfb9e89de3e87891448bf543c91
+  data.tar.gz: 4e9f7c5e21fa6b3f9d422c21026a9bf07a1c02269fad26c1a16f36f155bb8a17f48c045a22b637fdd3ed31e6f0dde8b4b70d11449c0ff6b0fc7a0eadd8cd091f

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'
@@ -103,9 +106,24 @@ 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

data/readme.md

@@ -1,149 +1,150 @@
-# tsurezure
-
-this is a simple web server framework written in ruby. mainly made as a way for me to quickly put together rest apis in my favorite language.
-
-it can be used in a very similar manner to the javascript framework express.
-
-* * *
-
-## usage
-
-### installing (from rubygems)
-
-just run `gem install tsurezure` and you'll have whatever the latest version is that I've put up.
-
-### installing (from source):
-
-requires:
-
--   ruby
--   nodejs + nodemon (**only** for hot reloading server in development mode, not necessarily required)
-
-after cloning this repo, from the root project directory, just run `rake start` to start in production mode, or `rake dev` to run in development mode, which adds hot reloading with nodemon. gem dependencies will install automatically.
-
-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 script to get started:
-
-```ruby
-require 'tsurezure'
-
-# create an instance of tsurezure
-server = Tsurezure.new(8888)
-
-# url: http://localhost:8888/user/1
-
-# create an endpoint
-server.register 'get', '/user/:id', lambda { |req|
-  url_vars = req[:vars] # { "id" => "1" }
-  params = req[:params] # {}
-
-  # create a respsonse for the endpoint
-  {
-    status: 200,
-    message: {
-      message: "hello user ##{url_vars['id']}!"
-    }.to_json
-  }
-}, content_type: 'application/json' # options hash
-
-# throw in some middleware
-server.add_middleware '/user/:id', lambda { |req|
-  url_vars = req[:vars]
-
-  # show a different response based on the request itself.
-  # if you return from middleware, the return value will
-  # be sent as the final response.
-  if req[:vars]['id'] == '1'
-    return {
-      status: 200, message: {
-      message: "hey user #1! you're the first one here!"
-    }.to_json
-  }
-
-  end
-}, content_type: 'application/json'
-
-#listen for connections
-server.listen
-```
-
-after you run this file, open up your browser or whatever and go to `http://localhost:8888/user/1`. you should see a json response that looks like this:
-
-```json
-{
-    "message": "hey user #1! you're the first one here!"
-}
-```
-
-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
-register http_method, path, callback, options
-```
-
-`http_method` is the method to access the endpoint with. `path` is just the url.
-
-`path` can be a path that contains variables (such as `/user/:id`). see the example above to see how it works.
-
-`callback` is a lambda that contains the logic used to send a response. it will recieve one argument: the request that was sent to that endpoint. whatever is returned from the proc will be sent as the response from that endpoint.
-
-`options` is a hash containing various options to somehow modify the response. valid options:
-
--   `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.
-
-for middleware, it's much the same:
-
-```ruby
-add_middleware path, callback, options
-```
-
-`path` can be a path that contains variables. used in the same way as the `path` for endpoints.
-
-`callback` is a lambda that you can use to intercept and pre-process responses. if you return from a callback in middleware, then that return value will be sent as the final response.
-
-`options` for middleware are the same as the `options` for endpoints.
-
-* * *
-
-## todo
-
--   [ ]  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
-
-## misc
-
-disclaimer: I don't know ruby, and this is my first time using it to make something.
-
-the name comes from yukueshirezutsurezure, one of my favorite bands. it's pronounced 'tsɯ-ɾe-dzɯ-ɾe.'
+# tsurezure
+
+this is a simple web server framework written in ruby. mainly made as a way for me to quickly put together rest apis in my favorite language.
+
+it can be used in a very similar manner to the javascript framework express.
+
+* * *
+
+## usage
+
+### installing (from rubygems)
+
+just run `gem install tsurezure` and you'll have whatever the latest version is that I've put up.
+
+### installing (from source):
+
+requires:
+
+-   ruby
+-   nodejs + nodemon (**only** for hot reloading server in development mode, not necessarily required)
+
+after cloning this repo, from the root project directory, just run `rake start` to start in production mode, or `rake dev` to run in development mode, which adds hot reloading with nodemon. gem dependencies will install automatically.
+
+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 script to get started:
+
+```ruby
+require 'tsurezure'
+
+# create an instance of tsurezure
+server = Tsurezure.new(8888)
+
+# url: http://localhost:8888/user/1
+
+# create an endpoint
+server.register 'get', '/user/:id', lambda { |req|
+  url_vars = req[:vars] # { "id" => "1" }
+  params = req[:params] # {}
+
+  # create a respsonse for the endpoint
+  {
+    status: 200,
+    message: {
+      message: "hello user ##{url_vars['id']}!"
+    }.to_json
+  }
+}, content_type: 'application/json' # options hash
+
+# throw in some middleware
+server.add_middleware '/user/:id', lambda { |req|
+  url_vars = req[:vars]
+
+  # show a different response based on the request itself.
+  # if you return from middleware, the return value will
+  # be sent as the final response.
+  if req[:vars]['id'] == '1'
+    return {
+      status: 200, message: {
+      message: "hey user #1! you're the first one here!"
+    }.to_json
+  }
+
+  end
+}, content_type: 'application/json'
+
+#listen for connections
+server.listen
+```
+
+after you run this file, open up your browser or whatever and go to `http://localhost:8888/user/1`. you should see a json response that looks like this:
+
+```json
+{
+    "message": "hey user #1! you're the first one here!"
+}
+```
+
+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
+register http_method, path, callback, options
+```
+
+`http_method` is the method to access the endpoint with. `path` is just the url.
+
+`path` can be a path that contains variables (such as `/user/:id`). see the example above to see how it works.
+
+`callback` is a lambda that contains the logic used to send a response. it will recieve one argument: the request that was sent to that endpoint. whatever is returned from the proc will be sent as the response from that endpoint.
+
+`options` is a hash containing various options to somehow modify the response. valid options:
+
+-   `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.
+
+for middleware, it's much the same:
+
+```ruby
+add_middleware path, callback, options
+```
+
+`path` can be a path that contains variables. used in the same way as the `path` for endpoints.
+
+`callback` is a lambda that you can use to intercept and pre-process responses. if you return from a callback in middleware, then that return value will be sent as the final response.
+
+`options` for middleware are the same as the `options` for endpoints.
+
+* * *
+
+## todo
+
+-   [ ]  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
+
+## misc
+
+disclaimer: I don't know ruby, and this is my first time using it to make something.
+
+the name comes from yukueshirezutsurezure, one of my favorite bands. it's pronounced 'tsɯ-ɾe-dzɯ-ɾe.'

metadata

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