phaedra 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac7eff901bd41a6da00ead154dc726635a7663597f5dd263fbe07c6f8df8821
-  data.tar.gz: 3eaafe5f99657959f22bd097191329404469087fc864ea980ba85a15156c87ce
+  metadata.gz: c1bdff92530752ce6f23f3b1e5e5763ac60ea46f0ff941147949790133a8d54e
+  data.tar.gz: 940607642ec362c3eeb5a88629cfd5f42125990f0d0437fd160e7e27ce0f66e2
 SHA512:
-  metadata.gz: 83c5681c356986221a82202728e3efdfe912f9db5c82bf66b388bb38a1e9450aac8269bda442fbca528230f64e8615446e7f8231cae9080fabd11c02fefee216
-  data.tar.gz: 5631c0968e80834d7b571547151e1e9addcc64136e07e73c91828afcde277996763bf05b9591896ec530eefabbd2ede670f3fffbbdd902d26cadbcfe3a173138
+  metadata.gz: e151d4bf1a2471acf06e5331dde65dc97988403a873916062f08f46b37c6bfbc54a780e448bda0bada253cefe74747abd3811e3071ec7a8474e1346aa53cb863
+  data.tar.gz: 16343524b69c5d67c228f4b69154faf816a996e9b6a15b66b01d10dbaf7510a3c1e747296e1c5d8b42100e7ca01c3e7e8492f4e2b5844946967a28bc1dd20799

data/README.md

@@ -89,13 +89,14 @@ require_relative "../lib/shared_code"
 
 class PhaedraFunction < Phaedra::Base
   def get(params)
-    "Run it once! #{SharedCode.run_once}"
+    "Run it once! #{SharedCode.run_once} / #{Time.now}"
   end
 end
 ```
 
 ```ruby
 # lib/shared_code.rb
+
 module SharedCode
   def self.run_once
     @one_time ||= Time.now
@@ -103,7 +104,9 @@ module SharedCode
 end
 ```
 
-Now each time you invoke the function at `/api/run-it-once`, the timestamp will never change until the next redeployment.
+Now each time you invoke the function at `/api/run-it-once`, the first 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 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.
 
 ## Deployment
 
@@ -212,7 +215,7 @@ require "phaedra"
 run Phaedra::RackApp.new
 ```
 
-Then run `rackup` in the terminal.
+Then run `rackup` in the terminal, or use another Rack-compatible server like Puma or Passenger.
 
 The settings (and their defaults) you can pass to the `new` method are as follows:
 
@@ -223,6 +226,26 @@ The settings (and their defaults) you can pass to the `new` method are as follow
 }
 ```
 
+Wondering if you can deploy a static site with an `api` folder via Nginx + Passenger? Yes, you can! Just configure your `my_site.conf` file like so:
+
+```nginxconf
+server {
+    listen 80;
+    server_name www.domain.com;
+
+    # Tell Nginx and Passenger where your site destination folder is
+    root /home/me/my_site/output;
+
+    # Turn on Passenger
+    location /api {
+      passenger_enabled on;
+      passenger_ruby /usr/local/rvm/gems/ruby-2.6.6@mysite/wrappers/ruby;
+    }
+}
+```
+
+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.)
+
 ### WEBrick
 
 Integrating Phaedra into a WEBrick server is pretty straightforward. Given a `server` object, it can be accomplished thusly:

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"
-    "<p>This is Interesting. 😁</p>"
+    response["Content-Type"] = "text/html; charset=utf-8"
+    "<p>This is Interesting. 😁 #{Phaedra.the_time}</p>"
   end
 end
 

data/example/config.ru

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

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,4 @@
 require "phaedra/version"
-
 require "webrick"
-require "rack"
-
+require "phaedra/initializers_module"
 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)
@@ -122,8 +126,8 @@ module Phaedra
 
     def complete_response
       if @res.body.is_a?(String) && !@res["Content-Type"].start_with?("text/")
-        @res["Content-Type"] = "text/plain"
-      elsif @res["Content-Type"] == "application/json"
+        @res["Content-Type"] = "text/plain; charset=utf-8"
+      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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phaedra
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,10 +84,15 @@ files:
 - example/api/simple.rb
 - example/api/the-time.rb
 - example/config.ru
+- 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/version.rb
 - phaedra.gemspec
 homepage: https://github.com/whitefusionhq/phaedra
@@ -109,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Write serverless Ruby functions via a REST-like microframework compatible