tynn 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5991d5053c18550ff9e4640a0fb6ce8877e2e8d9
-  data.tar.gz: 546da7cc32f33b70f95abb79557fb05a1045bc01
+  metadata.gz: 8e2fe7081578c608775773d67ab5e4dc92a33414
+  data.tar.gz: 96e869a9ec51ed45ab5baf116cd8126c32c4b597
 SHA512:
-  metadata.gz: 73682ff6496225b2fee11bdf76bf262ded91308c5db2b7c4bd4442a5b152247b5a8ea5a23d57b7f96acc96f67e180eca4165518a38f5bb7b2feb9f84481e0b1a
-  data.tar.gz: 0a4b872f14749623d88aaac9e6ade93a787a67ac1ee5eb93350028845ba5d55f217923dd8f5d62aed61b2bfd4b40c29d238763659dec36cb4778570a20495d3f
+  metadata.gz: dd4c49a2f298af29cefebca3650c488ab2bbb527299f700e9a72964e01a4fc1352fa7da6ef2264b25be24cedaaf6272ac53b5a603619da19c3d24a1b207235e4
+  data.tar.gz: 4ba63a68c74cbc71463b0e010ae985b8dab7d34d55e2043f1ed776774c8de93b4e07a33d7b08724fb1bacfd9e3156fa70bde9a37fe0912c214ecff1c159f6779

data/README.md

@@ -1,4 +1,4 @@
-tynn [![Gem Version](https://badge.fury.io/rb/tynn.svg)](https://rubygems.org/gems/tynn)
+tynn [![Build Status](https://travis-ci.org/frodsan/tynn.svg)](https://travis-ci.org/frodsan/tynn) [![Code Climate](https://codeclimate.com/github/frodsan/tynn/badges/gpa.svg)](https://codeclimate.com/github/frodsan/tynn)
 ====
 
 A thin library for web development.
@@ -48,8 +48,6 @@ Contributing
 You can install the gems globally, but we recommend [gs][gs] (or
 [gst][gst] if you're using chruby) to keep things isolated.
 
-[cuba]: https://github.com/soveran/cuba
-[rack]: https://github.com/rack/rack
 [syro]: https://github.com/soveran/syro
 [gs]: https://github.com/soveran/gs
 [gst]: https://github.com/tonchis/gst

data/lib/tynn.rb

@@ -1,45 +1,70 @@
-require "seteable"
 require "syro"
 require_relative "tynn/request"
 require_relative "tynn/response"
+require_relative "tynn/settings"
 require_relative "tynn/version"
 
 class Tynn
-  include Seteable
   include Syro::Deck::API
 
-  # Sets the application handler.
+  # Public: Extends Tynn functionality with the given +helper+ module.
   #
-  # ```
-  # class Users < Tynn
-  # end
+  # Examples
   #
-  # Users.define do
-  #   on(:id) do |id|
-  #     get do
-  #       res.write("GET /users")
-  #     end
+  #   require "tynn"
+  #   require "tynn/protection"
+  #
+  #   Tynn.helpers(Tynn::Protection)
   #
-  #     post do
-  #       res.write("POST /users")
+  def self.helpers(helper, *args, &block)
+    if defined?(helper::InstanceMethods)
+      self.include(helper::InstanceMethods)
+    end
+
+    if defined?(helper::ClassMethods)
+      self.extend(helper::ClassMethods)
+    end
+
+    if helper.respond_to?(:setup)
+      helper.setup(self, *args, &block)
+    end
+  end
+
+  # Internal: Default helpers.
+  helpers(Tynn::Settings)
+
+  # Public: Sets the application handler.
+  #
+  # Examples
+  #
+  #   class Users < Tynn
+  #   end
+  #
+  #   Users.define do
+  #     on(:id) do |id|
+  #       get do
+  #         res.write("GET /users")
+  #       end
+  #
+  #       post do
+  #         res.write("POST /users")
+  #       end
   #     end
   #   end
-  # end
-  # ```
   #
   def self.define(&block)
     build_app(Syro.new(self, &block))
   end
 
-  # Adds given Rack `middleware` to the stack.
+  # Public: Adds given Rack +middleware+ to the stack.
+  #
+  # Examples
   #
-  # ```
-  # require "rack/common_logger"
-  # require "rack/show_exceptions"
+  #   require "rack/common_logger"
+  #   require "rack/show_exceptions"
   #
-  # Tynn.use(Rack::CommonLogger)
-  # Tynn.use(Rack::ShowExceptions)
-  # ```
+  #   Tynn.use(Rack::CommonLogger)
+  #   Tynn.use(Rack::ShowExceptions)
   #
   def self.use(middleware, *args, &block)
     __middleware << proc { |app| middleware.new(app, *args, &block) }
@@ -66,57 +91,27 @@ class Tynn
     @middleware = []
   end
 
-  # Extends Tynn functionality with the given `helper` module.
-  #
-  # ```
-  # module AppName
-  #   def self.setup(app, name)
-  #     app.set(:app_name, name)
-  #   end
-  #
-  #   def app_name
-  #     return self.class.app_name
-  #   end
+  # Public: Sets an +option+ to the given +value+.
   #
-  #   module ClassMethods
-  #     def app_name
-  #       return settings[:app_name]
-  #     end
-  #   end
-  # end
+  # Examples
   #
-  # Tynn.helpers(AppName, "MyApplication")
+  #   require "tynn"
+  #   require "tynn/environment"
   #
-  # Tynn.app_name # => "MyApplication"
+  #   Tynn.helpers(Tynn::Environment)
   #
-  # Tynn.set(:app_name, "MyGreatestApp")
-  # Tynn.app_name # => "MyGreatestApp"
-  #
-  # Tynn.define do
-  #   root do
-  #     res.write(app_name)
-  #   end
-  # end
-  # ```
+  #   Tynn.set(:environment, :staging)
+  #   Tynn.environment
+  #   # => :staging
   #
-  # Check the [helpers][examples] that come with tynn for more examples.
-  #
-  # [examples]: https://github.com/frodsan/tynn/tree/master/lib/tynn
-  #
-  def self.helpers(helper, *args, &block)
-    self.include(helper)
-
-    if defined?(helper::ClassMethods)
-      self.extend(helper::ClassMethods)
-    end
-
-    if helper.respond_to?(:setup)
-      helper.setup(self, *args, &block)
-    end
+  def self.set(option, value)
+    settings[option] = value
   end
 
-  def self.set(key, value)
-    settings[key] = value
+  set(:default_headers, {})
+
+  def default_headers # :nodoc:
+    return Hash[settings[:default_headers]]
   end
 
   def request_class # :nodoc:
@@ -126,40 +121,4 @@ class Tynn
   def response_class # :nodoc:
     return Tynn::Response
   end
-
-  ##
-  # :method: halt(response)
-  #
-  # Immediately stops the request and returns `response` as per
-  # Rack's specification.
-  #
-  # ```
-  # halt([200, { "Content-Type" => "text/html" }, ["hello"]])
-  # halt([res.status, res.headers, res.body])
-  # halt(res.finish)
-  # ```
-
-  ##
-  # :method: req
-  #
-  # Returns the incoming request object. This object is an instance
-  # of Tynn::Request.
-  #
-  # ```
-  # req.post?      # => true
-  # req.params     # => { "username" => "bob", "password" => "secret" }
-  # req[:username] # => "bob"
-  # ```
-
-  ##
-  # :method: res
-  #
-  # Returns the current response object. This object is an instance
-  # of Tynn::Response.
-  #
-  # ```
-  # res.status = 200
-  # res["Content-Type"] = "text/html"
-  # res.write("<h1>Welcome back!</h1>")
-  # ```
 end

data/lib/tynn/all_methods.rb

@@ -1,18 +1,20 @@
 class Tynn
   module AllMethods
-    def head
-      if root? && req.head?
-        yield
+    module InstanceMethods
+      def head
+        if root? && req.head?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def options
-      if root? && req.options?
-        yield
+      def options
+        if root? && req.options?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
     end
   end

data/lib/tynn/environment.rb

@@ -1,24 +1,24 @@
 class Tynn
-  # Adds helper methods to get and check the current environment.
+  # Public: Adds helper methods to get and check the current environment.
   #
-  # ```
-  # require "tynn"
-  # require "tynn/environment"
+  # Examples
   #
-  # Tynn.helpers(Tynn::Environment)
+  #   require "tynn"
+  #   require "tynn/environment"
   #
-  # Tynn.environment  # => :development
+  #   Tynn.helpers(Tynn::Environment)
   #
-  # Tynn.development? # => true
-  # Tynn.production?  # => false
-  # Tynn.test?        # => false
-  # ```
+  #   Tynn.environment  # => :development
+  #
+  #   Tynn.development? # => true
+  #   Tynn.production?  # => false
+  #   Tynn.test?        # => false
   #
   # By default, the environment is based on `ENV["RACK_ENV"]`.
   #
-  # ```
-  # Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
-  # ```
+  # Examples
+  #
+  #   Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
   #
   module Environment
     def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:

data/lib/tynn/force_ssl.rb

@@ -0,0 +1,55 @@
+class Tynn
+  # Public: HTTP requests are permanently redirected to their HTTPS
+  # counterparts.
+  #
+  # Examples
+  #
+  #   require "tynn"
+  #   require "tynn/force_ssl"
+  #   require "tynn/test"
+  #
+  #   Tynn.helpers(Tynn::ForceSSL)
+  #
+  #   Tynn.define { }
+  #
+  #   app = Tynn::Test.new
+  #   app.get("/", {}, "HTTP_HOST" => "tynn.ru")
+  #
+  #   app.res.headers["Location"]
+  #   # => "https://tynn.ru/"
+  #
+  module ForceSSL
+    # Internal: Sets the HTTPS redirect middleware.
+    def self.setup(app)
+      app.use(Tynn::ForceSSL::Middleware)
+    end
+
+    class Middleware # :nodoc:
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+
+        if request.ssl?
+          return @app.call(env)
+        else
+          return [301, redirect_headers(request), []]
+        end
+      end
+
+      private
+
+      def redirect_headers(request)
+        return { "Location" => https_location(request) }
+      end
+
+      HTTPS_LOCATION = "https://%s%s".freeze
+
+      def https_location(request)
+        return sprintf(HTTPS_LOCATION, request.host, request.fullpath)
+      end
+    end
+  end
+end

data/lib/tynn/hmote.rb

@@ -0,0 +1,34 @@
+require "hmote"
+
+class Tynn
+  module HMote
+    def self.setup(app, options = {}) # :nodoc:
+      app.set(:layout, options.fetch(:layout, "layout"))
+      app.set(:views, options.fetch(:views, File.expand_path("views", Dir.pwd)))
+    end
+
+    module InstanceMethods
+      include ::HMote::Helpers
+
+      def render(template, locals = {}, layout = settings[:layout])
+        res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
+
+        res.write(view(template, locals, layout))
+      end
+
+      def view(template, locals = {}, layout = settings[:layout])
+        return partial(layout, locals.merge(content: partial(template, locals)))
+      end
+
+      def partial(template, locals = {})
+        return hmote(template_path(template), locals.merge(app: self), TOPLEVEL_BINDING)
+      end
+
+      private
+
+      def template_path(template)
+        return File.join(settings[:views], "#{ template }.mote")
+      end
+    end
+  end
+end

data/lib/tynn/hsts.rb

@@ -0,0 +1,64 @@
+class Tynn
+  # Public: Sets the +Strict-Transport-Security+ header. This ensures the
+  # browser never visits the http version of a website. This reduces the
+  # impact of leaking session data through cookies and external links, and
+  # defends against Man-in-the-middle attacks.
+  #
+  # Examples
+  #
+  #   require "tynn"
+  #   require "tynn/hsts"
+  #
+  #   Tynn.helpers(Tynn::HSTS)
+  #
+  #   Tynn.define { }
+  #
+  #   Tynn.call("PATH_INFO" => "/")[1]["Strict-Transport-Security"]
+  #   # => "max-age=15552000; includeSubdomains"
+  #
+  # It supports the following options:
+  #
+  # expires    - The time, in seconds, that the browser access the site only
+  #              by HTTPS. Defaults to 180 days.
+  # subdomains - If this is +true+, the rule applies to all the site's
+  #              subdomains as well. Defaults to +true+.
+  # preload    - A limitation of HSTS is that the initial request remains
+  #              unprotected if it uses HTTP. The same applies to the first
+  #              request after the activity period specified by +max-age+.
+  #              Modern browsers implements a "STS preloaded list", which
+  #              contains known sites supporting HSTS. If you would like to
+  #              include your website into the list, set this options to +true+
+  #              and submit your domain to this {form}[https://hstspreload.appspot.com/].
+  #              Supported by Chrome, Firefox, IE11+ and IE Edge.
+  #
+  # Examples
+  #
+  #   Tynn.helpers(
+  #     Tynn::HSTS,
+  #     expires: 31_536_000,
+  #     includeSubdomains: true,
+  #     preload: true
+  #   )
+  #
+  #   Tynn.define { }
+  #
+  #   Tynn.call("PATH_INFO" => "/")[1]["Strict-Transport-Security"]
+  #   # => "max-age=31536000; includeSubdomains; preload"
+  #
+  # To disable HSTS, you will need to tell the browser to expire it immediately.
+  #
+  # Examples
+  #
+  #   Tynn.helpers(Tynn::HSTS, expires: 0)
+  #
+  module HSTS
+    # Internal: Sets the HSTS header as a default header.
+    def self.setup(app, options = {})
+      header = sprintf("max-age=%i", options.fetch(:expires, 15_552_000))
+      header << "; includeSubdomains" if options.fetch(:subdomains, true)
+      header << "; preload" if options[:preload]
+
+      app.settings[:default_headers]["Strict-Transport-Security"] = header
+    end
+  end
+end