phaedra 0.3.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f0e4c33ad4a5241f2a6b7455522db8389a1bc2323ef4542ad75546b2b874a08
-  data.tar.gz: 42f380fa9cb7a620da9591862c7fd7abbd4022e8046c1ed8f089e902a052c1c2
+  metadata.gz: 00d5ba6f3bc10860baef3bf63867665db4ef610b7cf14a8281495cf929339bc3
+  data.tar.gz: 5d1c500a8cbe79a89182497e7881fdeba3d129e5e2f2ddcce19012f9ae713171
 SHA512:
-  metadata.gz: 0003a862d70c030695b33c1318c69c14eb3f0eda149590e485083827d6c703c06d68dbf8daa6c39e911274b5a5527c2e043aa327e18759bdb8ff970179e764cd
-  data.tar.gz: a5a22957adcb6c3e1fbce24e39e4c7b582381936b3d832d23ea32813888d5789ea779e89116fb3b16ac1a7122db97ac77d6de2fdd909ee791d351629f3c7dfcb
+  metadata.gz: 3f3a8145df4a02f5362dfffb66f1de44ccd650425504007f2f49fa666c68bd9d228d0e8ade98daa2d318c57b220013009bd2c9b37d10d375a7cecca2cee0c4ac
+  data.tar.gz: f0effbf926248e56c67da411bd688cc3f6783d7710bdedf141029d523b4e55667df18b1e509cb68aa55795a01b74369ac8e007a91754ac9b3c6046741d166258

data/README.md

@@ -118,7 +118,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 +180,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 +216,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
 ```

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=staging
+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/api/simple.rb

@@ -1,9 +1,9 @@
-require "phaedra"
+require_relative "../phaedra/initializers"
 
 class PhaedraFunction < Phaedra::Base
   def get(params)
     response["Content-Type"] = "text/html; charset=utf-8"
-    "<p>This is Interesting. 😁</p>"
+    "<p>😁 #{Phaedra.the_time} - #{ENV["PHAEDRA_ENV"]} - #{Time.new}</p>"
   end
 end
 

data/example/api/the-time.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]}"
   end
 
   def post(params)

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,11 @@
+require "phaedra"
+
+module Phaedra
+  Initializers.register self do
+    the_time("123")
+  end
+
+  def self.the_time(init = nil)
+    @the_time ||= "#{Time.now} + #{init}"
+  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

data/lib/phaedra/rack_middleware.rb

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

data/lib/phaedra/rack_middleware/not_found.rb

@@ -0,0 +1,21 @@
+module Phaedra
+  module Middleware
+    class NotFound
+      def initialize(app, path, content_type = 'text/html; charset=utf-8')
+        @app = app
+        @content = File.read(path)
+        @length = @content.bytesize.to_s
+        @content_type = content_type
+      end
+
+      def call(env)
+        response = @app.call(env)
+        if response[0] == 404
+          [404, {'Content-Type' => @content_type, 'Content-Length' => @length}, [@content]]
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/phaedra/rack_middleware/static.rb

@@ -0,0 +1,26 @@
+module Phaedra
+  module Middleware
+    # Based on Rack::TryStatic middleware
+    # https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/try_static.rb
+
+    class Static
+      def initialize(app, options)
+        @app = app
+        @try = ["", ".html", "index.html", "/index.html", *options[:try]]
+        @static = Rack::Static.new(
+          lambda { |_| [404, {}, []] },
+          options)
+      end
+
+      def call(env)
+        orig_path = env['PATH_INFO']
+        found = nil
+        @try.each do |path|
+          resp = @static.call(env.merge!({'PATH_INFO' => orig_path + path}))
+          break if !(403..405).include?(resp[0]) && found = resp
+        end
+        found or @app.call(env.merge!('PATH_INFO' => orig_path))
+      end
+    end
+  end
+end

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.3.2"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phaedra
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.2
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,14 +80,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Dockerfile
 - example/Gemfile
 - example/api/simple.rb
 - example/api/the-time.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/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
@@ -109,7 +117,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