blest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a8f112cb397ac2725175231766a0ca838e9ce898180cfc8be6e59e7fa498b8
-  data.tar.gz: b9f91cdfb82e5058d889fd6abddc8f14248c567567a3cb0acbd673d04b99f84c
+  metadata.gz: 6307985d2fcaa8aa558a9d6fa55bd61787de23accd0d762d12843cf1202784c8
+  data.tar.gz: b58fc887beb5b6312f14f7332daab521b37baa037750eb3b1b406191160ae0d1
 SHA512:
-  metadata.gz: 7fc3d8ae042c5b9dc96cb9fda9edeada1e34c26d1d08e890e72359c74f675e7c874b3c71ec78e4c056a8aaa886081be3374d87a46e22f86fd8689019149a9c8f
-  data.tar.gz: a862d3210e033fdf7b9d71b6b65b710a169955b49804df64aacfe0aacc73486f28e42a5dbf37994e66fa7a66ade5a39bbb2ecb5984941f5cf2c7284cc87308a8
+  metadata.gz: 1f0b5c80b2ae39259d5386c60a7a27deb6b04dc35a5162c30be64056d10581de3b6a6ee47cd800e27f4e4cac1f52a6cb692b47abbda7533ed48dc85c3eafe403
+  data.tar.gz: 964ab1acc3ca2db12a2918bb141efa3f254438c095b47c7e81313c4b5140d7a10b13712b3a4773e6fa1b76158ccc75dffa2af591df45fdb55a767278ea72e470

data/README.md

@@ -2,7 +2,7 @@
 
 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.
 
-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
 
@@ -15,158 +15,111 @@ For a front-end implementation in React, please visit https://github.com/jhuntde
 - Single Endpoint - Reduce complexity and improve data privacy
 - Fully Encrypted - Improve data privacy
 
-<!-- ## Installation
+## Installation
 
-Install BLEST Python from PyPI.
+Install BLEST Ruby from Rubygems.
 
 ```bash
-python3 -m pip install blest
-``` -->
+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
+This core class of this library has an interface somewhat 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 'socket'
-require 'json'
-require './blest.rb'
+require 'blest'
 
-server = TCPServer.new('localhost', 8080)
+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 |params, context|
+  if params['name'].present?
+    context['user'] = {
+      name: params['name']
     }
     nil
   else
     raise RuntimeError, "Unauthorized"
   end
-}
+end
 
 # Create a route controller
-greet_controller = ->(params, context) {
+app.route('greet') do |params, context|
   {
-    greeting: "Hi, #{context[:user][:name]}!"
+    greeting: "Hi, #{context['user']['name']}!"
   }
-}
-
-# Create a router
-router = {
-  greet: [auth_middleware, greet_controller]
-}
-
-# Create a request handler
-handler = create_request_handler(router)
-
-puts "Server listening on port 8080"
-
-loop do
-
-  client = server.accept
-
-  request = client.gets
-  if request.nil?
-    client.close
-  else
-
-    method, path, _ = request.split(' ')
-
-    if method != 'POST' 
-      client.puts "HTTP/1.1 405 Method Not Allowed"
-      client.puts "\r\n"
-    elsif path != '/'
-      client.puts "HTTP/1.1 404 Not Found"
-      client.puts "\r\n"
-    else
-      content_length = 0
-      while line = client.gets
-        break if line == "\r\n"
-        content_length = line.split(': ')[1].to_i if line.start_with?('Content-Length')
-      end
-
-      body = client.read(content_length)
-      data = JSON.parse(body)
-
-      context = {
-        headers: request.headers
-      }
-
-      # Use the request handler]
-      result, error = handler.(data, context)
-
-      if error
-          response = error.to_json
-          client.puts "HTTP/1.1 500 Internal Server Error"
-          client.puts "Content-Type: application/json"
-          client.puts "Content-Length: #{response.bytesize}"
-          client.puts "\r\n"
-          client.puts response
-      elsif result
-          response = result.to_json
-          client.puts "HTTP/1.1 200 OK"
-          client.puts "Content-Type: application/json"
-          client.puts "Content-Length: #{response.bytesize}"
-          client.puts "\r\n"
-          client.puts response
-      else
-          client.puts "HTTP/1.1 204 No Content"
-      end
-    end
-
-    client.close
-
-  end
 end
+
+# Start the server
+app.listen
 ```
 
-### create_http_server
+### Router
+
+The following example uses Sinatra.
 
 ```ruby
-require 'socket'
+require 'sinatra'
 require 'json'
-require './blest.rb'
+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 |params, context|
+  if params['name'].present?
+    context['user'] = {
+      name: params['name']
     }
     nil
   else
     raise RuntimeError, "Unauthorized"
   end
-}
+end
 
 # Create a route controller
-greet_controller = ->(params, context) {
+router.route('greet') do |params, context|
   {
-    greeting: "Hi, #{context[:user][:name]}!"
+    greeting: "Hi, #{context['user']['name']}!"
   }
-}
-
-# Create a router
-router = {
-  greet: [auth_middleware, greet_controller]
-}
+end
 
-# Create a request handler
-handler = create_request_handler(router)
+# 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 the server
-server = create_http_server(handler, { port: 8080 })
+### HttpClient
 
-# Run the server
-server.()
+```ruby
+require 'blest'
+
+# Create a client
+client = HttpClient.new('http://localhost:8080', max_batch_size = 25, buffer_delay = 10, 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).