phaedra 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9629e11c78d2a35fa9929d69a79f57fe1711fa4c6f6b4d73e70f8be43019918
-  data.tar.gz: 65a0caf688ea9172723fe398e29861f2c22f99df02dce2d2e34523fbbb4c929b
+  metadata.gz: 1ac7eff901bd41a6da00ead154dc726635a7663597f5dd263fbe07c6f8df8821
+  data.tar.gz: 3eaafe5f99657959f22bd097191329404469087fc864ea980ba85a15156c87ce
 SHA512:
-  metadata.gz: 8c54e4a03e0cbbd16c4d444215ce29102315e1be92942a9c1d3542eb6eeb948de8b78fff6f5f5913e3ef1ee2c7eae11aaac70545682bcc8f4884987cdb5c28a1
-  data.tar.gz: 666994b4fbb211c6a3bc555ac4f663997d6ed9ae24fcae4d670c76fe6392bb1f3761206000657edaa21e51778a2ebac5dad5a0171cfa45f032d9dbd69939f7d6
+  metadata.gz: 83c5681c356986221a82202728e3efdfe912f9db5c82bf66b388bb38a1e9450aac8269bda442fbca528230f64e8615446e7f8231cae9080fabd11c02fefee216
+  data.tar.gz: 5631c0968e80834d7b571547151e1e9addcc64136e07e73c91828afcde277996763bf05b9591896ec530eefabbd2ede670f3fffbbdd902d26cadbcfe3a173138

data/README.md

@@ -53,7 +53,7 @@ Your function can support `get`, `post`, `put`, `patch`, and `delete` methods wh
 
 Each method is provided access to `request` and `response` objects. If your function was directly instantiated by WEBrick, those will be `WEBrick::HTTPRequest` and `WEBrick::HTTPResponse` respectively. If your function was instantiated by Rack, those will be `Phaedra::Request` (a thin wrapper around `Rack::Request`) and `Rack::Response` respectively.
 
-## Callbacks
+### Callbacks
 
 Functions can define `action` callbacks:
 
@@ -77,30 +77,106 @@ 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
+### Shared Code You Only Want to Run Once
 
-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:
+You can use `require_relative` to load and execute shared Ruby code from another folder, say `lib`. This is particularly useful when setting up a database connection or performing expensive operations you only want to do once, rather than for every request.
 
 ```ruby
-# testphaedra/handler.rb
+# api/run-it-once.rb
 
 require "phaedra"
+require_relative "../lib/shared_code"
 
-class Handler
-  def run(_body, env)
-    status, headers, body = Phaedra::RackApp.new({
-      "root_dir" => File.join(Dir.pwd, "function")
-    }).call(env)
+class PhaedraFunction < Phaedra::Base
+  def get(params)
+    "Run it once! #{SharedCode.run_once}"
+  end
+end
+```
 
-    # The OpenFaaS ruby-http return array is backwards from Rack :/
-    [body.join(""), headers, status]
+```ruby
+# lib/shared_code.rb
+module SharedCode
+  def self.run_once
+    @one_time ||= Time.now
   end
 end
 ```
 
-Next, add a YAML file that lives alongside your function folder:
+Now each time you invoke the function at `/api/run-it-once`, the timestamp will never change until the next redeployment.
+
+## Deployment
+
+### Vercel
+
+All you have to do is create a static site repo ([Bridgetown](https://www.bridgetownrb.com), Jekyll, Middleman, etc.) with an `api` folder and Vercel will automatically set up the serverless functions every time there's a new branch or production deployment. As mentioned above, you'll need to ensure you add `Handler = PhaedraFunction` to the bottom of each Ruby function.
+
+### OpenFaaS
+
+We recommend using OpenFaaS' dockerfile template so you can define your own `Dockerfile` to book Rack + Phaedra using the Puma web server. This also allows you to customize the Docker image configuration to install and configure other tools as necessary.
+
+First, make sure you've pulled down the template:
+
+```sh
+faas-cli template store pull dockerfile
+```
+
+Then add a `Dockerfile` to your OpenFaaS project's function folder (e.g., `testphaedra`):
+
+```dockerfile
+# testphaedra/Dockerfile
+
+FROM openfaas/of-watchdog:0.7.7 as watchdog
+
+FROM ruby:2.6.6-slim-stretch
+
+COPY --from=watchdog /fwatchdog /usr/bin/fwatchdog
+RUN chmod +x /usr/bin/fwatchdog
+
+ARG ADDITIONAL_PACKAGE
+RUN apt-get update \
+  && apt-get install -qy --no-install-recommends build-essential ${ADDITIONAL_PACKAGE}
+
+WORKDIR /home/app
+
+# Use cache layer for Gemfile
+COPY Gemfile   	.
+RUN bundle install
+RUN gem install puma -N
+
+# Copy over the rest
+COPY    .   .
+
+# Create a non-root user
+RUN addgroup --system app \
+    && adduser --system --ingroup app app
+RUN chown app:app -R /home/app
+USER app
+
+# Run Puma as the server process
+ENV fprocess="puma -p 5000"
+
+EXPOSE 8080
+
+HEALTHCHECK --interval=2s CMD [ -e /tmp/.lock ] || exit 1
+
+ENV upstream_url="http://127.0.0.1:5000"
+ENV mode="http"
+
+CMD ["fwatchdog"]
+```
+
+Next add the `config.ru` file to boot Rack:
+
+```ruby
+# testphaedra/config.ru
+
+require "phaedra"
+
+run Phaedra::RackApp.new
+```
+
+Finally, add a YAML file that lives alongside your function folder:
 
 ```yaml
 # testphaedra.yml
@@ -111,24 +187,24 @@ provider:
   gateway: http://127.0.0.1:8080
 functions:
   testphaedra:
-    lang: ruby-http
+    lang: dockerfile
     handler: ./testphaedra
     image: yourdockerusername/testphaedra:latest
 ```
 
+(Replace `yourdockerusername` with your [Docker Hub](https://hub.docker.com) username.)
+
 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.
+In case you're wondering: yes, with Phaedra you can write multiple Ruby functions which will be accessible via different URL paths—all handled by a single OpenFaaS function. Of course it's possible set up multiple Phaedra projects and deploy them as separate OpenFaaS functions if you wish.
 
-## Rack
+### Rack
 
-Booting Phaedra up as Rack app is very simple. All you need is a `config.ru` file alongside your `api` folder:
+Booting Phaedra up as Rack app is very simple. All you need to do is add a `config.ru` file alongside your `api` folder:
 
 ```ruby
 require "phaedra"
@@ -138,7 +214,16 @@ run Phaedra::RackApp.new
 
 Then run `rackup` in the terminal.
 
-## WEBrick
+The settings (and their defaults) you can pass to the `new` method are as follows:
+
+```ruby
+{
+  "root_dir" => Dir.pwd,
+  "serverless_api_dir" => "api"
+}
+```
+
+### WEBrick
 
 Integrating Phaedra into a WEBrick server is pretty straightforward. Given a `server` object, it can be accomplished thusly:
 
@@ -172,6 +257,8 @@ load File.join(Dir.pwd, "api", "func.rb")
 @server.mount '/path', Handler
 ```
 
+This method precludes any automatic routing by Phaedra, so it's discouraged unless you are using WEBrick within a larger setup that utilizes its own routing method. (Interestingly enough, that's how Vercel works under the hood.)
+
 ----
 
 ## Development

data/example/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "phaedra", path: ".."
+gem "puma"

data/lib/phaedra/rack_app.rb

@@ -11,7 +11,7 @@ module Phaedra
     end
 
     def body
-      @request_body ||= get_header(Rack::RACK_INPUT).read
+      @request_body ||= "" + get_header(Rack::RACK_INPUT).read
     end
   end
 

data/lib/phaedra/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phaedra
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Gemfile
 - example/api/simple.rb
 - example/api/the-time.rb
 - example/config.ru