phaedra 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50fe608ca2567e6f1262fcfd1d7a9cc4171a5b467989b115692442dd1ae82e4a
-  data.tar.gz: 3a0da1de124ebd66b6d70ab25a9eee6e9288f28bad0adca7b800e8d82ecd0c31
+  metadata.gz: f9629e11c78d2a35fa9929d69a79f57fe1711fa4c6f6b4d73e70f8be43019918
+  data.tar.gz: 65a0caf688ea9172723fe398e29861f2c22f99df02dce2d2e34523fbbb4c929b
 SHA512:
-  metadata.gz: 6ef12e516dbbbfdbc487554d6422bfba931933598934a960c71bb4946b31c3d0b9e2e568bd818b1dd3c2bfbda5ebd556af99f8df62284f33d14ff8578b30c1b9
-  data.tar.gz: ae9bd0c2850334dd67b58e18e19a3444b7230539c45fb1b995b7441240930abecb3ff47c6211da5cb2bd2998b4454f3a7a6390fe7f2509d2718e2af13b0932f5
+  metadata.gz: 8c54e4a03e0cbbd16c4d444215ce29102315e1be92942a9c1d3542eb6eeb948de8b78fff6f5f5913e3ef1ee2c7eae11aaac70545682bcc8f4884987cdb5c28a1
+  data.tar.gz: 666994b4fbb211c6a3bc555ac4f663997d6ed9ae24fcae4d670c76fe6392bb1f3761206000657edaa21e51778a2ebac5dad5a0171cfa45f032d9dbd69939f7d6

data/README.md

@@ -1,10 +1,8 @@
 # Phaedra: Serverless Ruby Functions
 
-_NOTE: not yet released! Check back in June 2020!_
+Phaedra is a web microframework for writing serverless Ruby functions. They are isolated pieces of logic which respond to HTTP requests (GET, POST, etc.) and typically get mounted at a particular URL path. They can be tested locally and deployed to a supported serverless hosting platform or to any [Rack-compatible web server](https://github.com/rack/rack).
 
-Phaedra is a REST microframework for writing serverless Ruby functions. They are isolated pieces of logic which respond to HTTP requests (GET, POST, etc.) and typically get mounted at a particular URL path. They can be tested locally and deployed to a supported serverless hosting platform or to any [Rack-compatible web server](https://github.com/rack/rack).
-
-Serverless compatibility is presently focused on [Vercel](https://vercel.com), but there are likely additional platforms we'll be adding support for in the future (OpenFaaS, Fission, etc.).
+Serverless compatibility is presently focused on [Vercel](https://vercel.com) and [OpenFaaS](https://openfaas.com), but there are likely additional platforms we'll be adding support for in the future.
 
 ## Installation
 
@@ -32,7 +30,7 @@ Functions are single Ruby files which respond to a URL path (aka `/api/path/to/f
 
 Functions are written as subclasses of `Phaedra::Base` using the name `PhaedraFunction`. The `params` argument is a Hash containing the parsed contents of the incoming query string, form data, or body JSON. The response object returned by your function is typically a Hash which will be transformed into JSON output automatically, but it can also be plain text.
 
-Some platforms require the function class name to be `Handler`, so you can put that at the bottom of your file for full compatibility.
+Some platforms such as Vercel require the function class name to be `Handler`, so you can put that at the bottom of your file for full compatibility.
 
 Here's a basic example:
 
@@ -79,6 +77,55 @@ end
 
 You can modify the `request` object in a `before_action` callback to perform setup tasks before the actions are executed, or you can modify `response` in a `after_action` to further process the response.
 
+## OpenFaaS
+
+We recommend using OpenFaaS' [ruby-http template](https://github.com/openfaas-incubator/ruby-http). It boots up a Sinatra/WEBrick server and then passes all requests along to a Handler object.
+
+In your OpenFaaS project's function folder (e.g., `testphaedra`), simply define a file `handler.rb` which will load Phaedra's default Rack app:
+
+```ruby
+# testphaedra/handler.rb
+
+require "phaedra"
+
+class Handler
+  def run(_body, env)
+    status, headers, body = Phaedra::RackApp.new({
+      "root_dir" => File.join(Dir.pwd, "function")
+    }).call(env)
+
+    # The OpenFaaS ruby-http return array is backwards from Rack :/
+    [body.join(""), headers, status]
+  end
+end
+```
+
+Next, add a YAML file that lives alongside your function folder:
+
+```yaml
+# testphaedra.yml
+
+version: 1.0
+provider:
+  name: openfaas
+  gateway: http://127.0.0.1:8080
+functions:
+  testphaedra:
+    lang: ruby-http
+    handler: ./testphaedra
+    image: yourdockerusername/testphaedra:latest
+```
+
+Now run `faas-cli up -f testphaedra.yml` to build and deploy the function. Given the Ruby function `testphaedra/api/run-me.rb`, you'd call it like so:
+
+```sh
+curl http://127.0.0.1:8080/function/testphaedra/api/run-me
+
+# output of the Ruby function
+```
+
+In case you're wondering: yes, with Phaedra you can write multiple Ruby functions accessible via different URL paths that will all get handled by a single OpenFaaS function. Obviously you're welcome to set up multiple Phaedra projects and deploy them as separate OpenFaaS functions if you wish.
+
 ## Rack
 
 Booting Phaedra up as Rack app is very simple. All you need is a `config.ru` file alongside your `api` folder:
@@ -105,13 +152,13 @@ server.mount_proc "/#{base_api_folder}" do |req, res|
   ruby_path = File.join(full_api_path, api_folder, "#{endpoint}.rb")
 
   if File.exist?(ruby_path)
-    original_verbosity = $VERBOSE
-    $VERBOSE = nil
+    if Object.constants.include?(:PhaedraFunction)
+      Object.send(:remove_const, :PhaedraFunction)
+    end
     load ruby_path
-    $VERBOSE = original_verbosity
 
-    handler = Handler.new(server)
-    handler.service(req, res)
+    func = PhaedraFunction.new
+    func.service(req, res)
   else
     raise HTTPStatus::NotFound, "`#{req.path}' not found."
   end

data/example/api/simple.rb

@@ -0,0 +1,10 @@
+require "phaedra"
+
+class PhaedraFunction < Phaedra::Base
+  def get(params)
+    response["Content-Type"] = "text/html"
+    "<p>This is Interesting. 😁</p>"
+  end
+end
+
+Handler = PhaedraFunction

data/example/api/the-time.rb

@@ -4,7 +4,6 @@ class PhaedraFunction < Phaedra::Base
   before_action :earlier_stuff
 
   def get(params)
-    response["Content-Type"] = 'text/plain; charset=utf-8'
     "The Current Time is: #{Time.new} and Search Param is #{params[:search]}."
   end
 

data/lib/phaedra/base.rb

@@ -112,7 +112,7 @@ module Phaedra
 
     def set_initial_status
       @res.status = 200
-      @res["Content-Type"] = 'application/json'
+      @res["Content-Type"] = "application/json"
     end
 
     def call_method_action(params)
@@ -121,7 +121,11 @@ module Phaedra
     end
 
     def complete_response
-      @res.body = @res.body.to_json if @res["Content-Type"] == "application/json"
+      if @res.body.is_a?(String) && !@res["Content-Type"].start_with?("text/")
+        @res["Content-Type"] = "text/plain"
+      elsif @res["Content-Type"] == "application/json"
+        @res.body = @res.body.to_json
+      end
     end
 
     def error_condition

data/lib/phaedra/rack_app.rb

@@ -33,10 +33,10 @@ module Phaedra
       endpoint = File.basename(req.path)
       ruby_path = File.join(full_api_path, api_folder, "#{endpoint}.rb")
       if File.exist?(ruby_path)
-        original_verbosity = $VERBOSE
-        $VERBOSE = nil
+        if Object.constants.include?(:PhaedraFunction)
+          Object.send(:remove_const, :PhaedraFunction)
+        end
         load ruby_path
-        $VERBOSE = original_verbosity
         
         func = PhaedraFunction.new
         func.service(req, res)

data/lib/phaedra/version.rb

@@ -1,3 +1,3 @@
 module Phaedra
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/phaedra.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jared White"]
   spec.email         = ["jared@whitefusion.io"]
 
-  spec.summary       = %q{Write serverless Ruby functions via a REST microframework compatible with Rack or WEBrick.}
+  spec.summary       = %q{Write serverless Ruby functions via a REST-like microframework compatible with Rack or WEBrick.}
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/whitefusionhq/phaedra"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phaedra
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
-description: Write serverless Ruby functions via a REST microframework compatible
+description: Write serverless Ruby functions via a REST-like microframework compatible
   with Rack or WEBrick.
 email:
 - jared@whitefusion.io
@@ -80,6 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/api/simple.rb
 - example/api/the-time.rb
 - example/config.ru
 - lib/phaedra.rb
@@ -110,6 +111,6 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Write serverless Ruby functions via a REST microframework compatible with
-  Rack or WEBrick.
+summary: Write serverless Ruby functions via a REST-like microframework compatible
+  with Rack or WEBrick.
 test_files: []