blest 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cbe0f3613fd73841d959cad671fb7ec368ff5de50a2e5e874048871070d70b5
-  data.tar.gz: 209e015fa2bd51a03476ab597bbc4c4109037cfea52b79904a27f2a54fc1b368
+  metadata.gz: c4f44d941bb783457e67fa52ada69792f5f645a76bac399165d59c73f4ba7b4b
+  data.tar.gz: 8f7ee45d396ae4cab3c8178f1bef7e6605612efb94e259cbb35bcd3da842e347
 SHA512:
-  metadata.gz: 8d9a2f9db5673835a9d0187374b52be72dd596a5ec9a3744a164cb6aecbefddfa0d96b3cd23bce63a706dd39fcdcde0e2c5f0231cd71086208d34820280b1d05
-  data.tar.gz: e5d92953980bfe4a4e9a0d9c6c98db057cb5f5067af87680b2e83b4dc37df7ac52c5c3042697f63e9652dbefd3db2b0740f7c124b1837d330accd4b0360bfd57
+  metadata.gz: aecfa3005a9a29bcfd4b4f501710a0f8a49251ff7fc62f4043bfe8e5b0e7f6c8e2ddbb09df2ae14c08bc7617a09ab08d84ed52d9023272bd9bb05dabd1fb8e41
+  data.tar.gz: 2855b895975b23f418e0e084ecd3d15bd8df43764a896aca1f8fa5788d21e74ab7fb5ff5fdc4bbcd79a074dff7ce2f14bb3a10ee4e497d8ef1d63b1a645066c3

data/README.md

@@ -1,8 +1,8 @@
 # BLEST Ruby
 
-The Ruby reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching and selective returns, and provides a modern alternative to REST.
+The Ruby reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching by default, and provides a modern alternative to REST.
 
-To learn more about BLEST, please refer to the white paper: https://jhunt.dev/BLEST%20White%20Paper.pdf
+To learn more about BLEST, please visit the website: https://blest.jhunt.dev
 
 For a front-end implementation in React, please visit https://github.com/jhuntdev/blest-react
 
@@ -10,9 +10,8 @@ For a front-end implementation in React, please visit https://github.com/jhuntde
 
 - Built on JSON - Reduce parsing time and overhead
 - Request Batching - Save bandwidth and reduce load times
-- Compact Payloads - Save more bandwidth
-- Selective Returns - Save even more bandwidth
-- Single Endpoint - Reduce complexity and improve data privacy
+- Compact Payloads - Save even more bandwidth
+- Single Endpoint - Reduce complexity and facilitate introspection
 - Fully Encrypted - Improve data privacy
 
 ## Installation
@@ -25,139 +24,101 @@ gem install blest
 
 ## Usage
 
-Use the `create_request_handler` function to create a request handler suitable for use in an existing Python application. Use the `create_http_server` function to create a standalone HTTP server for your request handler.
-
-<!-- Use the `create_http_client` function to create a BLEST HTTP client. -->
-
-### create_request_handler
+The `Blest` class of this library has an interface similar to Sinatra. It also provides a `Router` class with a `handle` method for use in an existing Ruby API and an `HttpClient` class with a `request` method for making BLEST HTTP requests.
 
 ```ruby
-require 'webrick'
-require 'json'
 require 'blest'
 
+app = Blest.new(timeout: 1000, port: 8080, host: 'localhost', cors: 'http://localhost:3000')
+
 # Create some middleware (optional)
-auth_middleware = ->(params, context) {
-  if params[:name].present?
-    context[:user] = {
-      name: params[:name]
+app.before do |body, context|
+  if context.dig('headers', 'auth') == 'myToken'?
+    context['user'] = {
+      # user info for example
     }
     nil
   else
     raise RuntimeError, "Unauthorized"
   end
-}
+end
 
 # Create a route controller
-greet_controller = ->(params, context) {
+app.route('greet') do |body, context|
   {
-    greeting: "Hi, #{context[:user][:name]}!"
+    greeting: "Hi, #{body['name']}!"
   }
-}
-
-# Create a router
-router = {
-  greet: [auth_middleware, greet_controller]
-}
-
-# Create a request handler
-handler = create_request_handler(router)
-
-class HttpRequestHandler < WEBrick::HTTPServlet::AbstractServlet
-  def do_OPTIONS(request, response)
-    response.status = 200
-    response['Access-Control-Allow-Origin'] = '*'
-    response['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-    response['Access-Control-Allow-Headers'] = 'Content-Type'
-  end
-
-  def do_POST(request, response)
-    response['Content-Type'] = 'application/json'
-    response['Access-Control-Allow-Origin'] = '*'
-
-    # Parse JSON body
-    begin
-      payload = JSON.parse(request.body)
-      
-      # Define the request context
-      context = {
-        headers: request.headers
-      }
-
-      # Use the request handler
-      result, error = handler.(payload, context)
-
-      # Do something with the result or error
-      if error
-        response_body = error.to_json
-        response.status = 500
-        response.body = response_body
-      elsif result
-        response_body = result.to_json
-        response.status = 200
-        response.body = response_body
-      else
-        response.status = 204
-      end
-
-    rescue JSON::ParserError
-      response.status = 400
-      response.body = { message: 'Invalid JSON' }.to_json
-    end
-  end
 end
 
-# Create WEBrick server
-server = WEBrick::HTTPServer.new(Port: 8000)
-
-# Mount custom request handler
-server.mount('/', HttpRequestHandler)
-
-trap('INT') { server.shutdown }
-
 # Start the server
-server.start
+app.listen
 ```
 
-### create_http_server
+### Router
+
+The following example uses Sinatra.
 
 ```ruby
+require 'sinatra'
+require 'json'
 require 'blest'
 
+# Instantiate the Router
+router = Router.new(timeout: 1000)
+
 # Create some middleware (optional)
-auth_middleware = ->(params, context) {
-  if params[:name].present?
-    context[:user] = {
-      name: params[:name]
+router.before do |body, context|
+  if context.dig('headers', 'auth') == 'myToken'?
+    context['user'] = {
+      # user info for example
     }
     nil
   else
     raise RuntimeError, "Unauthorized"
   end
-}
+end
 
 # Create a route controller
-greet_controller = ->(params, context) {
+router.route('greet') do |body, context|
   {
-    greeting: "Hi, #{context[:user][:name]}!"
+    greeting: "Hi, #{body['name']}!"
   }
-}
+end
 
-# Create a router
-router = {
-  greet: [auth_middleware, greet_controller]
-}
+# Handle BLEST requests
+post '/' do
+  json_body = JSON.parse(request.body.read)
+  headers = request.env.select { |k, _| k.start_with?('HTTP_') }
+  result, error = router.handle.call(json_body, { 'headers' => headers })
+  content_type :json
+  if error
+    raise Sinatra::Error.new(error.status || 500, error)
+  else
+    result
+  end
+end
+```
 
-# Create a request handler
-handler = create_request_handler(router)
+### HttpClient
 
-# Create the server
-server = create_http_server(handler, { port: 8080 })
+```ruby
+require 'blest'
 
-# Run the server
-server.()
+# Create a client
+client = HttpClient.new('http://localhost:8080', max_batch_size = 25, buffer_delay = 10, http_headers = {
+  'Authorization': 'Bearer token'
+})
+
+# Send a request
+begin
+  result = client.request('greet', { 'name': 'Steve' }, ['greeting']).value
+  # Do something with the result
+rescue => error
+  # Do something in case of error
+end
 ```
 
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE).