phaedra 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8a4e661423271591485445de16dbbbd5921bfd3f677e4c9cccfd08a3634b79b
-  data.tar.gz: 513392234c9c02188d0fc20de6b83e0642133c0abdf246f4af9a7c06d72264dd
+  metadata.gz: 65ebfc3c9c8023c4a680704a085d9b4b62505fce1df1a82ca6d57bd9785c5ec2
+  data.tar.gz: d3384f2fa5d94ba594427970aad49cabe47b1d59d6f2a3289ba608c413e8d3db
 SHA512:
-  metadata.gz: 8e6421d7c5bab7f3acc94e5858c1b7695df4ce71d2613c5f4d87821d9fcd96f23286c01bf49ea715343f51a23f534d91923498b0bd99265f7fb31474de42ffac
-  data.tar.gz: d90e7402c1e8ea1d6c9afdd4fb530f4ad3fbbe289d59bff67d7dcf55b3783ec65778c5f41b625d1f4046acb3fc7d64f78160aec43f14d0738f8457bdc47b52eb
+  metadata.gz: c40e0c8017d3bb172a144b365ecaf62bc1d9b602c575740fefff8e0876ab54d853d1c5434aa2da8b8f02cda11d8f43084b5354d86464195374ee76799fd2e9c5
+  data.tar.gz: 763f60081477658fd4cfad3461cc8f9148c3c1c3e4d7f20d4571e1cf4d136c24c55a6aecfbc2c39c4ec3471bfadf7cca101be51dc7f3bcceb72c5e4eb21a2cdd

data/README.md

@@ -1,9 +1,15 @@
 # Phaedra: Serverless Ruby Functions
 
-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 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, using a container via Docker & Docker Compose, or to any [Rack-compatible web server](https://github.com/rack/rack).
+
+Phaedra is well-suited for building an API layer which you attach to a static site (aka [the Jamstack](https://www.bridgetownrb.com/docs/jamstack)) to provide dynamic functionality accessible any time after the static site loads in the browser.
 
 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.
 
+For swift deployment via Docker, we recommend [Fly.io](https://fly.io).
+
+(P.S. Wondering how you can deploy a static site on [Netlify](https://www.netlify.com) and still use a Ruby API? Scroll down for a suggested approach!)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,18 +30,26 @@ Or install it yourself as:
 $ gem install phaedra
 ```
 
+## Examples
+
+[Here's an example](https://github.com/whitefusionhq/phaedra/tree/master/example) of what the structure of a typical Phaedra app looks like. It includes `config.ru` for booting it up as a Rack app using Puma, as well as a `Dockerfile` and `docker-compose.yml` so you can run the app containerized in virtually any development or production hosting environment.
+
+[Here's a demo](https://phaedra-demo.whitefusion.design/api/env) of one of the functions. [And another one.](https://phaedra-demo.whitefusion.design/api/params?search=Waiting%20for%20Guffman)
+
 ## Usage
 
 Functions are single Ruby files which respond to a URL path (aka `/api/path/to/function`). The path is determined by the location of the file on the filesystem relative to the functions root (aka `api`). So, given a path of `./api/folder/run-me.rb`, the URL path would be `/api/folder/run-me`.
 
 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.
 
+Code to be run once upon function initialization and shared between multiple functions should be placed in the `phaedra/initializers.rb` file (see more on that below).
+
 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:
 
 ```ruby
-require "phaedra"
+require_relative "../phaedra/initializers"
 
 class PhaedraFunction < Phaedra::Base
   def get(params)
@@ -60,17 +74,23 @@ Functions can define `action` callbacks:
 ```ruby
 class PhaedraFunction < Phaedra::Base
   before_action :do_stuff_before
-  after_action :do_stuff_after
+  after_action do
+    # process response object further...
+  end
   around_action :do_it_all_around
 
   def do_stuff_before
-    # code
+    # process request object before action handler...
   end
 
-  # do_stuff_after, etc.
+  def do_it_all_around
+    # run code before
+    yield
+    # run code after
+  end
 
   def get(params)
-    # this will be run within the callback chain
+    # this will be run within the entire callback chain
   end
 end
 ```
@@ -79,34 +99,51 @@ You can modify the `request` object in a `before_action` callback to perform set
 
 ### Shared Code You Only Want to Run Once
 
-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.
+Phaedra provides a default location to place shared modules and code that should be run once upon first deployment of your functions. 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.
+
+Here's an example of how that works:
 
 ```ruby
 # api/run-it-once.rb
 
-require "phaedra"
-require_relative "../lib/shared_code"
+require_relative "../phaedra/initializers"
 
 class PhaedraFunction < Phaedra::Base
   def get(params)
-    "Run it once! #{SharedCode.run_once} / #{Time.now}"
+    "Run it once! #{Phaedra::Shared.run_once} / #{Time.now}"
   end
 end
 ```
 
 ```ruby
-# lib/shared_code.rb
+# phaedra/initializers.rb
+
+module Phaedra
+  module Shared
+    Initializers.register self do
+      run_once
+    end
 
-module SharedCode
-  def self.run_once
-    @one_time ||= Time.now
+    def self.run_once
+      @only_once ||= Time.now
+    end
   end
 end
 ```
 
-Now each time you invoke the function at `/api/run-it-once`, the first timestamp will never change until the next redeployment.
+Now each time you invoke the function at `/api/run-it-once`, the timestamp will never change until the next redeployment.
+
+**NOTE:** When running in a Rack-based configuration (see below), Ruby's `load` method is invoked for every request to any Phaedra function. This means Ruby has to parse and compile the code in your function each time. For small functions this happens extremely quickly, but if you find yourself writing a large function and seeing some performance slowdowns, consider extracting most of the function code to additional Ruby files and using the `require_relative` technique as mentioned above. The Ruby code in those required files will only be compiled once and all classes/modules/etc. will be saved in memory until the next redeployment.
+
+## Environment
+
+You can set the environment of your Phaedra app using the `PHAEDRA_ENV` environment variable. That is then available via the `Phaedra.environment` method. By default, the value is `:development`.
+
+```ruby
+# ENV["PHAEDRA_ENV"] == "production"
 
-**NOTE:** When running in a Rack-based configuration (see below), Ruby's `load` method is invoked for every request to any Phaedra function. This means Ruby has to parse and compile the code in your function each time. For small functions this happens extremely quickly, but if you find yourself writing a large function and seeing some performance slowdowns, consider extracting most of the function code to additional Ruby files and use the `require_relative` technique as mentioned above. The Ruby code in those required files will only be compiled once and all classes/modules/etc. will be saved in memory until the next redeployment.
+Phaedra.environment == :production  # true
+```
 
 ## Deployment
 
@@ -118,7 +155,13 @@ All you have to do is create a static site repo ([Bridgetown](https://www.bridge
 
 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:
+First make sure you've added Puma to your Gemfile:
+
+```
+gem "puma"
+```
+
+Then make sure you've pulled down the OpenFaaS template:
 
 ```sh
 faas-cli template store pull dockerfile
@@ -174,7 +217,7 @@ Next add the `config.ru` file to boot Rack:
 ```ruby
 # testphaedra/config.ru
 
-require "phaedra"
+require "phaedra/rack_app"
 
 run Phaedra::RackApp.new
 ```
@@ -210,7 +253,7 @@ In case you're wondering: yes, with Phaedra you can write multiple Ruby function
 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"
+require "phaedra/rack_app"
 
 run Phaedra::RackApp.new
 ```
@@ -246,6 +289,45 @@ server {
 
 Change the `server_name`, `root`, and `passenger_ruby` paths to your particular setup and you'll be good to go. (If you run into any errors, double-check there's a `config.ru` in the parent folder of your site destination folder.)
 
+### Docker
+
+[In the example app provided](https://github.com/whitefusionhq/phaedra/tree/master/example), there is a `config.ru` file for booting it up as a Rack app using Puma. The `Dockerfile` and `docker-compose.yml` files allow you to easily build and deploy the app at port 8080 (but that can easily be changed). Using the Docker Compose commands:
+
+```sh
+# Build (if necessary) and deploy:
+docker-compose up
+
+# Get information on the running container:
+docker-compose ps
+
+# Inspect the output logs:
+docker-compose logs
+
+# Exit the running container:
+docker-compose down
+
+# If you make changes to the code and need to rebuild:
+docker-compose up --build
+```
+
+#### Fly.io
+
+Deploying your Phaedra app's Docker container via [Fly.io](https://fly.io) couldn't be easier. Simply create a new app and deploy using Fly.io's command line utility:
+
+```sh
+# Create the new app using your Fly.io account:
+flyctl apps create
+
+# Deploy using the Dockerfile:
+flyctl deploy
+
+# Print out the URL and other info on your new app:
+flyctl info
+
+# Change the Phaedra app environment:
+flyctl secrets set PHAEDRA_ENV=production
+```
+
 ### WEBrick
 
 Integrating Phaedra into a WEBrick server is pretty straightforward. Given a `server` object, it can be accomplished thusly:
@@ -280,7 +362,21 @@ 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.)
+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](https://github.com/vercel/vercel/blob/master/packages/now-ruby/now_init.rb).)
+
+## Connecting a Static Site on Netlify to a Phaedra API
+
+[Netlify](https://www.netlify.com) is a popular hosting solution for Jamstack (static) sites, but its serverless functions feature doesn't support Ruby. However, using proxy rewrites, you can deploy the static site part of your repository to Netlify and set the `/api` endpoint to route requests to your Phaedra app on the fly (hosted elsewhere).
+
+For example, if your Phaedra app is hosted on Fly.io (see above), you'll want Netlify's CDN to proxy all requests to `/api/*` to that app's URL. We can accomplish that by adding a `_redirects` file to the static site's source folder (for Bridgetown sites, that's `src`):
+
+```
+/api/*  https://super-awesome-phaedra-api.fly.dev/api/:splat  200
+```
+
+Once that deploys, you can go to your Netlify site URL, append `/api/whatever`, and under-the-hood that will connect to `https://super-awesome-phaedra-api.fly.dev/api/whatever` in a completely transparent manner.
+
+If you want to change the proxy URL for different contexts (staging vs. production, etc.), you can follow Netlify's "[Separate _redirects files for separate contexts or branches](https://community.netlify.com/t/support-guide-making-redirects-work-for-you-troubleshooting-and-debugging/13433)" instructions here.
 
 ----
 

data/example/Dockerfile

@@ -0,0 +1,46 @@
+FROM ruby:2.6-alpine3.11 as builder
+
+RUN apk add --no-cache --virtual \\
+    #
+    # required
+    bash tzdata build-base libffi-dev \\
+    #
+    # nice to haves
+    curl git
+
+FROM builder as phaedra-app
+
+# This is to fix an issue on Linux with permissions issues
+ARG USER_ID=${USER_ID:-1000}
+ARG GROUP_ID=${GROUP_ID:-1000}
+ARG DOCKER_USER=${DOCKER_USER:-user}
+ARG APP_DIR=${APP_DIR:-/home/user/phaedra-app}
+
+# Change with --build-arg PHAEDRA_ENV=production
+ARG PHAEDRA_ENV=development
+ENV PHAEDRA_ENV=$PHAEDRA_ENV
+
+# Create a non-root user
+RUN addgroup -g $GROUP_ID -S $GROUP_ID
+RUN adduser --disabled-password -G $GROUP_ID --uid $USER_ID -S $DOCKER_USER
+
+# Create and then own the directory to fix permissions issues
+RUN mkdir -p $APP_DIR
+RUN chown -R $USER_ID:$GROUP_ID $APP_DIR
+
+# Define the user running the container
+USER $USER_ID:$GROUP_ID
+
+# . now == $APP_DIR
+WORKDIR $APP_DIR
+
+# COPY is run as a root user, not as the USER defined above, so we must chown it
+COPY --chown=$USER_ID:$GROUP_ID Gemfile* ./
+RUN gem install bundler
+RUN bundle install
+
+COPY --chown=$USER_ID:$GROUP_ID . .
+
+EXPOSE 8080
+
+CMD ["bundle", "exec", "rackup", "-p", "8080", "-o", "0.0.0.0"]

data/example/Gemfile

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

data/example/README.md

@@ -0,0 +1,19 @@
+# Example Phaedra App
+
+This will spin up a Phaedra demo API running on port 8080 (which can be changed).
+
+## Local Exec
+
+Requires Ruby 2.6 or greater.
+
+```sh
+bundle install
+
+bundle exec rackup -p 8080
+```
+
+## Docker Compose
+
+```sh
+docker-compose up
+```

data/example/api/env.rb

@@ -0,0 +1,15 @@
+require_relative "../phaedra/initializers"
+
+class PhaedraFunction < Phaedra::Base
+  def get(params)
+    response["Content-Type"] = "text/html; charset=utf-8"
+    <<~HTML
+      <p>Hello friend! 😃</p>
+      <p>Startup Time: #{Phaedra::Shared.the_time}</p>
+      <p>Environment: #{Phaedra.environment}</p>
+      <p>Current Time: #{Time.new}</p>
+    HTML
+  end
+end
+
+Handler = PhaedraFunction

data/example/api/{the-time.rb → params.rb}

@@ -1,10 +1,10 @@
-require "phaedra"
+require_relative "../phaedra/initializers"
 
 class PhaedraFunction < Phaedra::Base
   before_action :earlier_stuff
 
   def get(params)
-    "The Current Time is: #{Time.new} and Search Param is #{params[:search]}."
+    "The ?search= param is #{params[:search] || "-missing-"}"
   end
 
   def post(params)
@@ -14,10 +14,10 @@ class PhaedraFunction < Phaedra::Base
   private
 
   def earlier_stuff
-    request.query["search"] += " SEARCH!" if request.query["search"]
+    request.query["search"] += " (nice!)" if request.query["search"]
 
     if request.body
-      request.body.sub!("Works", "Lurks")
+      request.body.sub!("Works", "Totally Works")
     end
   end
 end

data/example/config.ru

@@ -1,3 +1,3 @@
-require "phaedra"
+require "phaedra/rack_app"
 
 run Phaedra::RackApp.new

data/example/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+services:
+  web:
+    build: .
+    ports:
+      - "8080:8080"
+    environment:
+      - PHAEDRA_ENV

data/example/phaedra/initializers.rb

@@ -0,0 +1,14 @@
+require "phaedra"
+require "securerandom"
+
+module Phaedra
+  module Shared
+    Initializers.register self do
+      the_time SecureRandom.hex(10)
+    end
+
+    def self.the_time(init = nil)
+      @the_time ||= "#{Time.now} (random seed: #{init})"
+    end
+  end
+end

data/lib/phaedra.rb

@@ -1,7 +1,5 @@
 require "phaedra/version"
-
 require "webrick"
-require "rack"
-
+require "phaedra/initializers_module"
+require "phaedra/startup_initializers"
 require "phaedra/base"
-require "phaedra/rack_app"

data/lib/phaedra/base.rb

@@ -7,6 +7,10 @@ module Phaedra
   class Base
     include CallbacksActionable
 
+    before_action do
+      Initializers.run
+    end
+
     # Used by WEBrick
     def self.get_instance(server, *options)
       self.new(server, *options)
@@ -112,7 +116,7 @@ module Phaedra
 
     def set_initial_status
       @res.status = 200
-      @res["Content-Type"] = "application/json"
+      @res["Content-Type"] = "application/json; charset=utf-8"
     end
 
     def call_method_action(params)
@@ -123,7 +127,7 @@ module Phaedra
     def complete_response
       if @res.body.is_a?(String) && !@res["Content-Type"].start_with?("text/")
         @res["Content-Type"] = "text/plain; charset=utf-8"
-      elsif @res["Content-Type"] == "application/json"
+      elsif @res["Content-Type"].start_with? "application/json"
         @res.body = @res.body.to_json
       end
     end

data/lib/phaedra/concerns/callbacks_actionable.rb

@@ -11,14 +11,14 @@ module Phaedra
     end
 
     module ClassMethods
-      def before_action(*args)
-        set_callback :action, :before, *args
+      def before_action(*args, &block)
+        set_callback :action, :before, *args, &block
       end
-      def after_action(*args)
-        set_callback :action, :after, *args
+      def after_action(*args, &block)
+        set_callback :action, :after, *args, &block
       end
-      def around_action(*args)
-        set_callback :action, :around, *args
+      def around_action(*args, &block)
+        set_callback :action, :around, *args, &block
       end
     end
   end

data/lib/phaedra/initializers_module.rb

@@ -0,0 +1,69 @@
+module Phaedra
+  module Initializers
+    Registration = Struct.new(
+      :origin,
+      :priority,
+      :block,
+      keyword_init: true
+    ) do
+      def to_s
+        "#{owner}:#{priority} for #{block}"
+      end
+    end
+
+    DEFAULT_PRIORITY = 20
+
+    PRIORITY_MAP = {
+      low: 10,
+      normal: 20,
+      high: 30,
+    }.freeze
+
+    # initial empty hooks
+    @registry = []
+
+    NotAvailable = Class.new(RuntimeError)
+    Uncallable = Class.new(RuntimeError)
+
+    # Ensure the priority is a Fixnum
+    def self.priority_value(priority)
+      return priority if priority.is_a?(Integer)
+
+      PRIORITY_MAP[priority] || DEFAULT_PRIORITY
+    end
+
+    def self.register(origin, priority: DEFAULT_PRIORITY, &block)
+      raise Uncallable, "Initializers must respond to :call" unless block.respond_to? :call
+
+      @registry << Registration.new(
+        origin: origin,
+        priority: priority_value(priority),
+        block: block
+      )
+
+      block
+    end
+
+    def self.remove(origin)
+      @registry.delete_if { |item| item.origin == origin }
+    end
+
+    def self.run(force: false)
+      if !@initializers_ran || force
+        prioritized_initializers.each do |initializer|
+          initializer.block.call
+        end
+      end
+
+      @initializers_ran = true
+    end
+
+    def self.prioritized_initializers
+      # sort initializers according to priority and load order
+      grouped_initializers = @registry.group_by(&:priority)
+      grouped_initializers.keys.sort.reverse.map do |priority|
+        grouped_initializers[priority]
+      end.flatten
+    end
+  end
+end

data/lib/phaedra/rack_app.rb

@@ -1,3 +1,6 @@
+require "rack"
+require "phaedra"
+
 module Phaedra
   class Request < Rack::Request
     def query
@@ -5,11 +8,18 @@ module Phaedra
     end
 
     def header
-      @env.dup.transform_keys do |key|
+      @transformed_headers ||= @env.dup.transform_keys do |key|
         key.respond_to?(:downcase) ? key.downcase : key
+      end.tap do |headers|
+        # TODO: normalize a few common headers
+        headers["authorization"] = headers["http_authorization"]
       end
     end
 
+    def [](key)
+      header[key]
+    end
+
     def body
       @request_body ||= "" + get_header(Rack::RACK_INPUT).read
     end

data/lib/phaedra/rack_middleware.rb

@@ -0,0 +1,2 @@
+require "phaedra/rack_middleware/not_found"
+require "phaedra/rack_middleware/static"

data/lib/phaedra/{middleware → rack_middleware}/static.rb

@@ -6,7 +6,7 @@ module Phaedra
     class Static
       def initialize(app, options)
         @app = app
-        @try = [".html", "index.html", "/index.html"] #, *options[:try]]
+        @try = ["", ".html", "index.html", "/index.html", *options[:try]]
         @static = Rack::Static.new(
           lambda { |_| [404, {}, []] },
           options)

data/lib/phaedra/startup_initializers.rb

@@ -0,0 +1,9 @@
+module Phaedra
+  Initializers.register self, priority: :high do
+    environment
+  end
+
+  def self.environment
+    @environment ||= ENV.fetch("PHAEDRA_ENV", :development).to_sym
+  end
+end

data/lib/phaedra/version.rb

@@ -1,3 +1,3 @@
 module Phaedra
-  VERSION = "0.4.0"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phaedra
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,17 +80,23 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Dockerfile
 - example/Gemfile
-- example/api/simple.rb
-- example/api/the-time.rb
+- example/README.md
+- example/api/env.rb
+- example/api/params.rb
 - example/config.ru
+- example/docker-compose.yml
+- example/phaedra/initializers.rb
 - lib/phaedra.rb
 - lib/phaedra/base.rb
 - lib/phaedra/concerns/callbacks_actionable.rb
-- lib/phaedra/middleware.rb
-- lib/phaedra/middleware/not_found.rb
-- lib/phaedra/middleware/static.rb
+- lib/phaedra/initializers_module.rb
 - lib/phaedra/rack_app.rb
+- lib/phaedra/rack_middleware.rb
+- lib/phaedra/rack_middleware/not_found.rb
+- lib/phaedra/rack_middleware/static.rb
+- lib/phaedra/startup_initializers.rb
 - lib/phaedra/version.rb
 - phaedra.gemspec
 homepage: https://github.com/whitefusionhq/phaedra
@@ -112,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Write serverless Ruby functions via a REST-like microframework compatible

data/example/api/simple.rb

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

data/lib/phaedra/middleware.rb

@@ -1,2 +0,0 @@
-require "phaedra/middleware/not_found"
-require "phaedra/middleware/static"