angelo 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97eb8856cc0b4c9756d65b3c76f78bab570357b8
-  data.tar.gz: 1af8e5001731811ee47ba1f1009e18f06a84bbf5
+  metadata.gz: 29657358947009a8401893f8db01b0c3522706ed
+  data.tar.gz: 721f0e9ef56f280f761518a620aa2a7ef562ae57
 SHA512:
-  metadata.gz: 53958da09949dc42c914752ba7142c08464f1d088d1e7d3b7d84cb438274e0b6518d32b26cffeb911df4261a2d2e3ad81f774ad0e9361c78b690ac0508d3313a
-  data.tar.gz: f8fa0eabc251e38884a6d58f5f99ad2d70ba1a9d9acad2cb3d3723bc15341b4fafd86dafd76309d4ac3ecbed9ab9d870e9e9405b28dcc7b7697e14bfba2c8faa
+  metadata.gz: 6519c472ea84aa9098fd2bb186323a21b7c216d7e3b6e4927666b77f0226bb57c379159784a38d83305cf64908defb2d9c3ebcfb0d126c59916ec35c00ea5069
+  data.tar.gz: 110fffc25ad3e75c459aa0a484f52b2c73b8b9a318b5c8c904ec45135abfdd5aca658219910a0d993c6befe1493e9286e76b895528eeadd0fe79eeb74be58c30

data/.travis.yml

@@ -1,10 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - "2.1.5"
-  - "2.2.0"
-  - "rbx-2"
+  - "2.2.4"
+  - "2.3.0"
 script: rake
-matrix:
-  allow_failures:
-    - rvm: rbx-2

data/CHANGELOG.md

@@ -1,7 +1,21 @@
 changelog
 =========
 
-### 0.4.1
+### 0.5.0 mar 2016
+
+thanks: @tommay, @gunnarmarten, @nagius
+
+* add Angelo::Templates as a better interface to Tilt
+    * haml / markdown support
+* JSON array post body support (#48)
+* add `request_body` helper for access to JSON array post bodies or `request.body.to_s`
+* move `reload_templates!` to `Angelo::Base::DSL`
+* support `Regexp` as only arg to `before` and `after` filters
+* add post override support via `X-Angelo-PostOverride` header
+* update celluloid API usage (#58)
+* add `default_headers` DSL method (#61)
+
+### 0.4.1 8 feb 2015
 
 thanks: @tommay
 

data/Gemfile

@@ -1,14 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'reel', '~>0.5'
-gem 'tilt', '~>2.0'
-gem 'mime-types', '~>2.4'
-gem 'websocket-driver', '~>0.3'
-gem 'mustermann', '~>0.4'
+gem 'reel', '~>0.6.1'
+gemspec
 
 group :development do
   gem 'pry', '~>0.10'
-  gem 'pry-nav', '~>0.2'
 end
 
 group :profile do
@@ -22,6 +18,6 @@ group :test do
   gem 'minitest', '~>5.4'
 
   platform :mri do
-    gem 'simplecov', '~>0.9.1'
+    gem 'simplecov', '~>0.11'
   end
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Kenichi Nakamura
+Copyright 2013-2015 Kenichi Nakamura
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -12,7 +12,7 @@ A [Sinatra](https://github.com/sinatra/sinatra)-like DSL for [Reel](https://gith
 * contextual websocket/sse stashing via `websockets` and `sses` helpers
 * `task` handling via `async` and `future` helpers
 * no rack
-* tilt/erb support
+* erb, haml, and markdown support
 * mustermann support
 
 ### What is Angelo?
@@ -22,7 +22,7 @@ notable differences, but the basics remain the same: you can either create a "cl
 by requiring 'angelo/main' and using the DSL at the top level of your script, or a "modular"
 application by requiring 'angelo', subclassing `Angelo::Base`, and calling `.run!` on that class for the
 service to start.
-In addition, and perhaps more importantly, **Angelo is built upon Reel, which is, in turn, built upon
+In addition, and perhaps more importantly, **Angelo is built on Reel, which is built on
 Celluloid::IO and gives you a reactor with evented IO in Ruby!**
 
 Things will feel very familiar to anyone experienced with Sinatra. You can define
@@ -525,6 +525,21 @@ end
 HelloApp.run!
 ```
 
+### JSON HTTP API
+
+If you post JSON data with a JSON Content-Type, angelo will:
+
+* merge objects into the `params` SymHash
+* parse arrays and make them available via `request_body`
+
+N.B. `request_body` is functionally equivalent to `request.body.to_s` otherwise.
+
+If your `content_type` is set to `:json`, angelo will convert:
+
+* anything returned from a route block that `respond_to? :to_json`
+* `RequestError` message data
+* `halt` data
+
 ### Documentation
 
 **I'm bad at documentation and I feel bad.**
@@ -665,11 +680,33 @@ Foo.run!
 
 ### Contributing
 
-YES, HAVE SOME
+Anyone is welcome to contribute. Conduct is guided by the [Contributor Covenant](http://contributor-covenant.org).
+See `code_of_conduct.md`.
+
+To contribute to Angelo, please:
+
+* fork the repository to your GitHub account
+* create a branch for the feature or fix
+* commit your changes to that branch, please include tests if applicable
+* submit a Pull Request back to the main repository's `master` branch
 
-* :fork_and_knife: Fork this repo, make changes, send PR!
-* :shipit: if Good stuff?
+After review and acceptance, your changes will be merged and noted in `CHANGLOG.md`.
+
+### Testing
+
+Unit tests are done with Minitest. Run them with :
+
+```
+bundle install
+rake test
+```
 
 ### License
 
 [Apache 2.0](LICENSE)
+
+### Name
+
+Why the name "Angelo"? Since the project mimics Sinatra's DSL, I thought it best to keep a reference to
+The Chairman in the name. It turns out that Frank Sinatra won an Academy Award for his role 'Angelo
+Maggio' in 'From Here to Eternity'. I appropriated the name since this is like Sinatra on Reel (film).

data/angelo.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.version          = Angelo::VERSION
   gem.license          = 'apache'
   gem.required_ruby_version = '>= 2.1.0'
-  gem.add_runtime_dependency 'reel', '~>0.5'
+  gem.add_runtime_dependency 'reel', '~>0.6.1'
   gem.add_runtime_dependency 'tilt', '~>2.0'
   gem.add_runtime_dependency 'mustermann', '~>0.4'
   gem.add_runtime_dependency 'mime-types', '~>2.4'

data/code_of_conduct.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project <a href="mailto:kenichi.nakamura@gmail.com">maintainer</a>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/lib/angelo.rb

@@ -18,9 +18,13 @@ module Angelo
 
   HTTPABLE = [:get, :post, :put, :delete, :options]
   STATICABLE = [:get, :head]
+  POST_OVERRIDABLE = [:put, :delete]
 
   ACCEPT_REQUEST_HEADER_KEY = 'Accept'
 
+  POST_OVERRIDE_REQUEST_HEADER_KEY = 'X-Angelo-PostOverride'
+  REAL_IP_REQUEST_HEADER_KEY = 'X-Real-IP'
+
   CONTENT_TYPE_HEADER_KEY = 'Content-Type'
   CONTENT_DISPOSITION_HEADER_KEY = 'Content-Disposition'
   CONTENT_LENGTH_HEADER_KEY = 'Content-Length'
@@ -79,22 +83,23 @@ module Angelo
 
   end
 
-  def self.log connection, request, socket, status, body_size = '-'
+  def self.log meth, connection, request, socket, status, body_size = '-'
 
-    remote_ip = ->{
-      if socket.nil?
-        connection.remote_ip rescue 'unknown'
-      else
-        socket.peeraddr(false)[3]
-      end
-    }
+    remote_ip = case
+                when request.headers[REAL_IP_REQUEST_HEADER_KEY]
+                  request.headers[REAL_IP_REQUEST_HEADER_KEY]
+                when socket
+                  socket.peeraddr(false)[3]
+                else
+                  connection.remote_ip rescue 'unknown'
+                end
 
-    Celluloid::Logger.__send__ Angelo.response_log_level, LOG_FORMAT % [
-      remote_ip[],
-      request.method,
+    Celluloid::Internals::Logger.__send__ Angelo.response_log_level, LOG_FORMAT % [
+      remote_ip,
+      (meth && meth.upcase) || request.method,
       request.url,
       request.version,
-      Symbol === status ? HTTP::Response::SYMBOL_TO_STATUS_CODE[status] : status,
+      Symbol === status ? HTTP::Response::Status::SYMBOL_CODES[status] : status,
       body_size
     ]
 
@@ -133,6 +138,7 @@ require 'angelo/server'
 require 'angelo/responder'
 require 'angelo/responder/eventsource'
 require 'angelo/responder/websocket'
+require 'angelo/templates'
 require 'angelo/tilt/erb'
 require 'angelo/base'
 require 'angelo/stash'

data/lib/angelo/base.rb

@@ -3,60 +3,21 @@ module Angelo
   class Base
     extend Forwardable
     include ParamsParser
-    include Celluloid::Logger
+    include Celluloid::Internals::Logger
+    include Templates
     include Tilt::ERB
     include Mustermann
 
-    def_delegators :@responder, :content_type, :headers, :mustermann, :redirect, :request, :transfer_encoding
+    def_delegators :@responder, :content_type, :headers, :mustermann, :redirect, :redirect!, :request, :transfer_encoding
     def_delegators :@klass, :public_dir, :report_errors?, :sse_event, :sse_message, :sses, :websockets
 
     attr_accessor :responder
-
-    class << self
-
-      attr_accessor :app_file, :server
-
-      def inherited subclass
-
-        # Set app_file by groveling up the caller stack until we find
-        # the first caller from a directory different from __FILE__.
-        # This allows base.rb to be required from an arbitrarily deep
-        # nesting of require "angelo/<whatever>" and still set
-        # app_file correctly.
-        #
-        subclass.app_file = caller_locations.map(&:absolute_path).find do |f|
-          !f.start_with?(File.dirname(__FILE__) + File::SEPARATOR)
-        end
-
-        # bring RequestError into this namespace
-        #
-        subclass.class_eval 'class RequestError < Angelo::RequestError; end'
-
-        subclass.addr DEFAULT_ADDR
-        subclass.port DEFAULT_PORT
-
-        subclass.ping_time DEFAULT_PING_TIME
-        subclass.log_level DEFAULT_LOG_LEVEL
-
-        # Parse command line options if angelo/main has been required.
-        # They could also be parsed in run, but this makes them
-        # available to and overridable by the DSL.
-        #
-        subclass.parse_options(ARGV.dup) if @angelo_main
-
-        class << subclass
-
-          def root
-            @root ||= File.expand_path '..', app_file
-          end
-
-        end
-
-      end
-    end
+    attr_writer :request_body
 
     # Methods defined in module DSL will be available in the DSL both
-    # in Angelo::Base subclasses and in the top level DSL.
+    # in Angelo::Base subclasses as class methods and, if angelo/main
+    # is required, in the top level DSL by forwarding to an anonymous
+    # Angelo::Base subclass.
 
     module DSL
       def addr a = nil
@@ -64,6 +25,11 @@ module Angelo
         @addr
       end
 
+      def port p = nil
+        @port = p if p
+        @port
+      end
+
       def log_level ll = nil
         @log_level = ll if ll
         @log_level
@@ -74,20 +40,17 @@ module Angelo
         @ping_time
       end
 
-      def port p = nil
-        @port = p if p
-        @port
-      end
-
       def views_dir d = nil
         @views_dir = d if d
-        @views_dir ||= DEFAULT_VIEWS_DIR
         File.join root, @views_dir
       end
 
+      def reload_templates!(on = true)
+        @reload_templates = on
+      end
+
       def public_dir d = nil
         @public_dir = d if d
-        @public_dir ||= DEFAULT_PUBLIC_DIR
         File.join root, @public_dir
       end
 
@@ -98,13 +61,13 @@ module Angelo
       HTTPABLE.each do |m|
         define_method m do |path, opts = {}, &block|
           path = ::Mustermann.new path, opts
-          routes[m][path] = Responder.new &block
+          routes[m][path] = Responder.new m, &block
         end
       end
 
       def websocket path, &block
         path = ::Mustermann.new path
-        routes[:websocket][path] = Responder::Websocket.new &block
+        routes[:websocket][path] = Responder::Websocket.new nil, &block
       end
 
       def eventsource path, headers = nil, &block
@@ -125,21 +88,61 @@ module Angelo
       end
 
       def on_pong &block
-        Responder::Websocket.on_pong = block
+        @on_pong = block if block
+        @on_pong
       end
 
       def content_type type
         Responder.content_type type
       end
 
+      def default_headers hs
+        Responder.default_headers = Responder.default_headers.merge hs
+      end
     end
 
-    # Make the DSL methods available to subclass-level code.
-    # main.rb makes them available to the top level.
+    class << self
+      include DSL
 
-    extend DSL
+      attr_accessor :app_file, :server
+
+      def inherited subclass
+
+        # Set app_file by groveling up the caller stack until we find
+        # the first caller from a directory different from __FILE__.
+        # This allows base.rb to be required from an arbitrarily deep
+        # nesting of require "angelo/<whatever>" and still set
+        # app_file correctly.
+        #
+        subclass.app_file = caller_locations.map(&:absolute_path).find do |f|
+          !f.start_with?(File.dirname(__FILE__) + File::SEPARATOR)
+        end
+
+        # bring RequestError into this namespace
+        #
+        subclass.class_eval 'class RequestError < Angelo::RequestError; end'
+
+        subclass.addr DEFAULT_ADDR
+        subclass.port DEFAULT_PORT
+
+        subclass.ping_time DEFAULT_PING_TIME
+        subclass.log_level DEFAULT_LOG_LEVEL
+
+        subclass.views_dir DEFAULT_VIEWS_DIR
+        subclass.public_dir DEFAULT_PUBLIC_DIR
+
+        # Parse command line options if angelo/main has been required.
+        # They could also be parsed in run, but this makes them
+        # available to and overridable by the DSL.
+        #
+        subclass.parse_options(ARGV.dup) if @angelo_main
+
+      end
+
+      def root
+        @root ||= File.expand_path '..', app_file
+      end
 
-    class << self
       def report_errors?
         !!@report_errors
       end
@@ -149,12 +152,15 @@ module Angelo
       end
 
       def filters
-        @filters ||= {before: {default: []}, after: {default: []}}
+        @filters ||= {
+          before: Hash.new{|h,k| h[k] = []},
+          after: Hash.new{|h,k| h[k] = []},
+        }
       end
 
       def filter which, opts = {}, &block
         case opts
-        when String
+        when String, Regexp
           filter_by which, opts, block
         when Hash
           if opts[:path]
@@ -167,7 +173,6 @@ module Angelo
 
       def filter_by which, path, block
         pattern = ::Mustermann.new path
-        filters[which][pattern] ||= []
         filters[which][pattern] << block
       end
 
@@ -247,12 +252,16 @@ module Angelo
         if Symbol === key
           k = key.to_s.upcase
           k.gsub! UNDERSCORE, DASH
-          rhv = request.headers.select {|header_key,v| header_key.upcase == k}
-          hash[key] = rhv.values.first
+          _, value = request.headers.find {|header_key,v| header_key.upcase == k}
+          hash[key] = value
         end
       end
     end
 
+    def request_body
+      @request_body ||= request.body.to_s
+    end
+
     task :handle_websocket do |ws|
       begin
         while !ws.closed? do
@@ -266,9 +275,7 @@ module Angelo
 
     task :ping_websockets do
       every(@base.ping_time) do
-        websockets.all_each do |ws|
-          ws.socket << ::WebSocket::Message.ping.to_data
-        end
+        websockets.all_each {|ws| ws.ping &@base.on_pong }
       end
     end
 
@@ -353,11 +360,11 @@ module Angelo
         when :default
           filters.each {|filter| instance_eval &filter}
         when ::Mustermann
-          if pattern.match request.path
-            @pre_filter_params = params
-            @params = @pre_filter_params.merge pattern.params(request.path)
+          if mustermann_params = pattern.params(request.path)
+            pre_filter_params = params
+            @params = pre_filter_params.merge mustermann_params
             filters.each {|filter| instance_eval &filter}
-            @params = @pre_filter_params
+            @params = pre_filter_params
           end
         end
       end
@@ -402,11 +409,8 @@ module Angelo
       end
 
       def [] route
-        responder = nil
-        if mustermann = @hash.keys.select {|k| k.match(route)}.first
-          responder = @hash.fetch mustermann
-          responder.mustermann = mustermann
-        end
+        mustermann, responder = @hash.find {|k,v| k.match(route)}
+        responder.mustermann = mustermann if mustermann
         responder
       end