tynn 0.0.4 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4782dd0580d83defcbda873cd5cd6286e9471dff
-  data.tar.gz: 4084f3b30cec83e6147b1e2afdde38a381285fe2
+  metadata.gz: 4778b186382c25ab99b1687323ec3562c045a0ee
+  data.tar.gz: 3b8c8d0c9a80cf5cce5cfb235e27be3b34093197
 SHA512:
-  metadata.gz: 99d8b65373259f09d6c340ea148c4da3f1c33c55bdd7686b4ac278a5ed609955bed273f31371842b6521e74580e29def9c6c155e26ab8cdda9da2702edba2d65
-  data.tar.gz: e6571863d347e2c749582fa4db18abdf79938727e47cc4b8f1d912b650c26a8464c690995385e6f4fe1a34dd1c22e2add4720c4f7ec248c7b7aeff9acdf085a2
+  metadata.gz: ef2895b73ebb6b9180e747a28499de003fb430a6e6eaee6027f7d7ae5c2569c9161347aed31aacb25552ce010dff48a01ebdbdf39af026f61702316c38ac3036
+  data.tar.gz: 47e3ccf946f417ba6c444d4197d511eef8df1c987e83468214a5949d3ffa6c46a89e891da13d032e077bdd6b1781ec64313a60a3a399e5eb259ced0513fe6869

data/lib/tynn/all_methods.rb

@@ -0,0 +1,17 @@
+module Tynn::AllMethods
+  def head
+    if root? && req.head?
+      yield
+
+      halt(res.finish)
+    end
+  end
+
+  def options
+    if root? && req.options?
+      yield
+
+      halt(res.finish)
+    end
+  end
+end

data/lib/tynn/environment.rb

@@ -1,19 +1,23 @@
 # Adds helper methods to get and check the current environment.
 #
-#     require "tynn"
-#     require "tynn/environment"
+# ```
+# require "tynn"
+# require "tynn/environment"
 #
-#     Tynn.helpers(Tynn::Environment)
+# Tynn.helpers(Tynn::Environment)
 #
-#     Tynn.environment  # => :development
+# Tynn.environment  # => :development
 #
-#     Tynn.development? # => true
-#     Tynn.production?  # => false
-#     Tynn.test?        # => false
+# 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"])
+# ```
+# Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
+# ```
 #
 module Tynn::Environment
   def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:

data/lib/tynn/matchers.rb

@@ -1,22 +1,26 @@
 # Adds extra matchers to Tynn.
 #
-#     require "tynn"
-#     require "tynn/matchers"
+# ```
+# require "tynn"
+# require "tynn/matchers"
 #
-#     Tynn.helpers(Tynn::Matchers)
+# Tynn.helpers(Tynn::Matchers)
+# ```
 #
 module Tynn::Matchers
   # A catch-all matcher.
   #
-  #     Tynn.define do
-  #       authenticated? do
-  #         # ...
-  #       end
+  # ```
+  # Tynn.define do
+  #   authenticated? do
+  #     # ...
+  #   end
   #
-  #       default do # on true
-  #         # ...
-  #       end
-  #     end
+  #   default do # on true
+  #     # ...
+  #   end
+  # end
+  # ```
   #
   # :call-seq: default(&block)
   #
@@ -26,15 +30,29 @@ module Tynn::Matchers
     halt(res.finish)
   end
 
-  # Match if the given `params` are present.
+  # Match if the given `key` is present in `req.params`.
   #
-  #     Tynn.define do
-  #       on param?(:token) do
-  #         # ...
-  #       end
-  #     end
+  # ```
+  # Tynn.define do
+  #   param(:user) do |params|
+  #     user = User.create(params)
   #
-  def param?(*params)
-    return params.all? { |param| (v = req[param]) && !v.empty? }
+  #     # ...
+  #   end
+  #
+  #   default do
+  #     res.write("missing param")
+  #   end
+  # end
+  # ```
+  #
+  # :call-seq: param(key, &block)
+  #
+  def param(key)
+    if (v = req[key]) && !v.empty?
+      yield(v)
+
+      halt(res.finish)
+    end
   end
 end

data/lib/tynn/request.rb

@@ -0,0 +1,4 @@
+class Tynn
+  class Request < Rack::Request
+  end
+end

data/lib/tynn/response.rb

@@ -0,0 +1,151 @@
+class Tynn
+  class Response < Syro::Response
+    ##
+    # :method: []
+    #
+    # Returns the response header corresponding to `key`.
+    #
+    #     res["Content-Type"]   # => "text/html"
+    #     res["Content-Length"] # => "42"
+
+    ##
+    # :method: []=
+    # :call-seq: []=(value)
+    #
+    # Sets the given `value` with the header corresponding to `key`.
+    #
+    #     res["Content-Type"] = "application/json"
+    #     res["Content-Type"] # => "application/json"
+
+    ##
+    # :method: body
+    #
+    # Returns the body of the response.
+    #
+    #     res.body
+    #     # => []
+    #
+    #     res.write("there is")
+    #     res.write("no try")
+    #
+    #     res.body
+    #     # => ["there is", "no try"]
+
+    ##
+    # :method: finish
+    #
+    # Returns an array with three elements: the status, headers and body.
+    # If the status is not set, the status is set to 404 if empty body,
+    # otherwise the status is set to 200 and updates the `Content-Type`
+    # header to `text/html`.
+    #
+    #     res.status = 200
+    #     res.finish
+    #     # => [200, {}, []]
+    #
+    #     res.status = nil
+    #     res.finish
+    #     # => [404, {}, []]
+    #
+    #     res.status = nil
+    #     res.write("yo!")
+    #     res.finish
+    #     # => [200, { "Content-Type" => "text/html" }, ["yo!"]]
+
+    ##
+    # :method: headers
+    #
+    # Returns a hash with the response headers.
+    #
+    #     res.headers
+    #     # => { "Content-Type" => "text/html", "Content-Length" => "42" }
+
+    ##
+    # :method: redirect
+    # :call-seq: redirect(path, 302)
+    #
+    # Sets the `Location` header to `path` and updates the status to
+    # `status`. By default, `status` is `302`.
+    #
+    #     res.redirect("/path")
+    #
+    #     res["Location"] # => "/path"
+    #     res.status      # => 302
+    #
+    #     res.redirect("http://tynn.ru", 303)
+    #
+    #     res["Location"] # => "http://tynn.ru"
+    #     res.status      # => 303
+
+    ##
+    # :method: status
+    #
+    # Returns the status of the response.
+    #
+    #     res.status # => 200
+    #
+
+    ##
+    # :method: status=
+    # :call-seq: status=(status)
+    #
+    # Sets the status of the response.
+    #
+    #     res.status = 200
+    #
+
+    ##
+    # :method: write
+    # :call-seq: write(str)
+    #
+    # Appends `str` to `body` and updates the `Content-Length` header.
+    #
+    #     res.body # => []
+    #
+    #     res.write("foo")
+    #     res.write("bar")
+    #
+    #     res.body
+    #     # => ["foo", "bar"]
+    #
+    #     res["Content-Length"]
+    #     # => 6
+
+    ##
+    # :method: set_cookie
+    # :call-seq: set_cookie(key, value)
+    #
+    # Sets a cookie into the response.
+    #
+    #     res.set_cookie("foo", "bar")
+    #     res["Set-Cookie"] # => "foo=bar"
+    #
+    #     res.set_cookie("foo2", "bar2")
+    #     res["Set-Cookie"] # => "foo=bar\nfoo2=bar2"
+    #
+    #     res.set_cookie("bar", {
+    #       domain: ".example.com",
+    #       path: "/",
+    #       # max_age: 0,
+    #       # expires: Time.now + 10_000,
+    #       secure: true,
+    #       httponly: true,
+    #       value: "bar"
+    #     })
+    #
+    #     res["Set-Cookie"].split("\n").last
+    #     # => "bar=bar; domain=.example.com; path=/; secure; HttpOnly
+    #
+    # **NOTE:** This method doesn't sign and/or encrypt the value of the cookie.
+
+    ##
+    # :method: delete_cookie
+    # :call-seq: delete_cookie(key, value = {})
+    #
+    # Deletes cookie.
+    #
+    #     res.set_cookie("foo", "bar")
+    #     res["Set-Cookie"]
+    #     # => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
+  end
+end

data/lib/tynn/secure_headers.rb

@@ -1,9 +1,33 @@
 # Adds security related HTTP headers.
 #
-#   require "tynn"
-#   require "tynn/secure_headers"
+# ```
+# require "tynn"
+# require "tynn/secure_headers"
 #
-#   Tynn.helpers(Tynn::SecureHeaders)
+# Tynn.helpers(Tynn::SecureHeaders)
+# ```
+#
+# This helper applies the following headers:
+#
+# * **X-Content-Type-Options:** Prevents IE and Chrome from
+#   [content type sniffing][mime-sniffing].
+#
+# * **X-Frame-Options (XFO):** Provides [Clickjacking][clickjacking]
+#   protection. Check the [X-Frame-Options draft][x-frame-options] for
+#   more information.
+#
+# * **X-Permitted-Cross-Domain-Policies:** Restricts Adobe Flash Player's
+#   access to data. Check this [article][pcdp] for more information.
+#
+# * **X-XSS-Protection:** Enables the [XSS][xss] protection filter built
+#   into IE, Chrome and Safari. This filter is usually enabled by default,
+#   the use of this header is to re-enable it if it was disabled by the user.
+#
+# [clickjacking]: https://www.owasp.org/index.php/Clickjacking
+# [mime-sniffing]: https://msdn.microsoft.com/library/gg622941(v=vs.85).aspx
+# [pcdp]: https://www.adobe.com/devnet/adobe-media-server/articles/cross-domain-xml-for-streaming.html
+# [x-frame-options]: https://tools.ietf.org/html/draft-ietf-websec-x-frame-options-02
+# [xss]: https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)
 #
 module Tynn::SecureHeaders
   HEADERS = {
@@ -13,7 +37,7 @@ module Tynn::SecureHeaders
     "X-XSS-Protection" => "1; mode=block"
   } # :nodoc:
 
-  def default_headers
+  def default_headers # :nodoc:
     return super.merge(HEADERS)
   end
 end

data/lib/tynn/session.rb

@@ -1,13 +1,84 @@
+# Adds simple cookie based session management. If a secret token is
+# given, it signs the cookie data to ensure that it cannot be altered
+# by unauthorized means.
+#
+# ```
+# require "tynn"
+# require "tynn/session"
+#
+# Tynn.helpers(Tynn::Session, secret: "__change_me__")
+#
+# Tynn.define do
+#   root do
+#     res.write(sprintf("hei %s", session[:username]))
+#   end
+#
+#   on(:username) do |username|
+#     session[:username] = username
+#   end
+# end
+# ```
+#
+# The following command generates a cryptographically secure secret ready
+# to use:
+#
+# ```
+# $ ruby -r securerandom -e "puts SecureRandom.hex(64)"
+# ```
+#
+# It's important to keep the token secret. Knowing the token allows an
+# attacker to tamper the data. So, it's recommended to load the token
+# from the environment.
+#
+# ```
+# Tynn.helpers(Tynn::Session, secret: ENV["SESSION_SECRET"])
+# ```
+#
+# Under the hood, Tynn::Session uses the [Rack::Session::Cookie][rack-session]
+# middleware. Thus, supports all the options available for this middleware.
+#
+# * `:key` - the name of the cookie. Defaults to `"rack.session"`.
+# * `:expire_after` - sets the lifespan of the cookie. If `nil`,
+#     the cookie will be deleted after the user close the browser.
+#     Defaults to `nil`.
+# * `:httponly` - if `true`, sets the [HttpOnly][cookie-httponly] attribute.
+#   This mitigates the risk of client side scripting accessing the cookie.
+#   Defaults to `true`.
+# * `:secure` - if `true`, sets the [Secure][cookie-secure] attribute.
+#   This tells the browser to only transmit the cookie over HTTPS. Defaults
+#   to `false`.
+#
+# ```
+# Tynn.helpers(
+#   Tynn::Session,
+#   key: "app",
+#   secret: ENV["SESSION_SECRET"],
+#   expire_after: 36_000, # seconds
+#   httponly: true,
+#   secure: true
+# )
+# ```
+#
+# [cookie-httponly]: https://www.owasp.org/index.php/Session_Management_Cheat_Sheet#HttpOnly_Attribute
+# [cookie-secure]: https://www.owasp.org/index.php/Session_Management_Cheat_Sheet#Secure_Attribute
+# [rack-session]: http://www.rubydoc.info/gems/rack/Rack/Session/Cookie
+#
 module Tynn::Session
   RACK_SESSION = "rack.session".freeze # :nodoc:
 
   def self.setup(app, options = {}) # :nodoc:
-    options = options.dup
-    options[:http_only] ||= true
-
     app.use(Rack::Session::Cookie, options)
   end
 
+  # Returns the session hash.
+  #
+  # ```
+  # session # => {}
+  #
+  # session[:foo] = "foo"
+  # session[:foo] # => "foo"
+  # ```
+  #
   def session
     return env[RACK_SESSION]
   end

data/lib/tynn/ssl.rb

@@ -1,6 +1,6 @@
 module Tynn::SSL
-  def self.setup(app, options = {}) # :nodoc:
-    app.use(Tynn::SSL::Middleware, options)
+  def self.setup(app, hsts: {}) # :nodoc:
+    app.use(Tynn::SSL::Middleware, hsts: hsts)
   end
 
   class Middleware # :nodoc:

data/lib/tynn/static.rb

@@ -1,3 +1,29 @@
+# Adds support for static files (javascript files, images, stylesheets, etc).
+#
+# ```
+# require "tynn"
+# require "tynn/static"
+#
+# Tynn.helpers(Tynn::Static, ["/js", "/css"])
+# ```
+#
+# By default, serve all requests beginning with the given paths from the folder
+# `public` in the current directory (e.g. `public/js/*`, `public/css/*`). You
+# can change the default by passing the `:root` option.
+#
+# ```
+# Tynn.helpers(Tynn::Static, ["/js", "/css"], root: "assets")
+# ```
+#
+# Under the hood, it uses the [Rack::Static][rack-static] middleware.
+# Thus, supports all the options available for this middleware.
+#
+# ```
+# Tynn.helpers(Tynn::Static, ["/js", "/css"], index: "index.html")
+# ```
+#
+# [rack-static]: http://www.rubydoc.info/gems/rack/Rack/Static
+#
 module Tynn::Static
   def self.setup(app, urls, options = {}) # :nodoc:
     options = options.dup

data/lib/tynn/test.rb

@@ -1,10 +1,45 @@
 require "rack/test"
 
+# A simple helper class that uses [rack-test][rack-test] to simulate requests
+# to your application.
+#
+# ```
+# require "tynn"
+# require "tynn/test"
+#
+# Tynn.define do
+#   root do
+#     res.write("hei")
+#   end
+# end
+#
+# app = Tynn::Test.new
+# app.get("/")
+#
+# 200   == app.res.status # => true
+# "hei" == app.res.body   # => true
+# ```
+#
+# **NOTE:** Tynn doesn't ship with [rack-test][rack-test]. In order to
+# use this plugin, you need to install it first.
+#
+# [rack-test]: http://rubygems.org/gems/rack-test
+#
 class Tynn::Test
   include Rack::Test::Methods
 
-  def initialize(app = Tynn) # :nodoc:
-    @app = app
+  # Instantiates a new Tynn::Test object with the given `application` to test.
+  #
+  # ```
+  # class API < Tynn
+  # end
+  #
+  # app = Tynn::Test.new(API)
+  # app.get("/json")
+  # ```
+  #
+  def initialize(application = Tynn)
+    @app = application
   end
 
   def app # :nodoc:

data/lib/tynn/version.rb

@@ -1,3 +1,8 @@
-class Tynn
-  VERSION = "0.0.4"
+class Tynn # :nodoc:
+  VERSION = [
+    MAJOR_VERSION = 1,
+    MINOR_VERSION = 0,
+    PATCH_VERSION = 0,
+    PRE_VERSION   = "rc1"
+  ].compact.join(".")
 end

data/lib/tynn.rb

@@ -1,15 +1,48 @@
 require "seteable"
 require "syro"
+require_relative "tynn/request"
+require_relative "tynn/response"
+require_relative "tynn/version"
 
-class Tynn < Syro::Deck
+class Tynn
   include Seteable
+  include Syro::Deck::API
 
+  # Sets the application handler.
+  #
+  # ```
+  # 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
+  # ```
+  #
   def self.define(&block)
     @syro = Syro.new(self, &block)
   end
 
-  def self.use(_middleware, *args, &block)
-    middleware << proc { |app| _middleware.new(app, *args, &block) }
+  # Adds given Rack `middleware` to the stack.
+  #
+  # ```
+  # require "rack/common_logger"
+  # require "rack/show_exceptions"
+  #
+  # Tynn.use(Rack::CommonLogger)
+  # Tynn.use(Rack::ShowExceptions)
+  # ```
+  #
+  def self.use(middleware, *args, &block)
+    __middleware << proc { |app| middleware.new(app, *args, &block) }
   end
 
   def self.call(env) # :nodoc:
@@ -19,14 +52,14 @@ class Tynn < Syro::Deck
   def self.to_app # :nodoc:
     fail("Missing application handler. Try #{ self }.define") unless @syro
 
-    if middleware.empty?
+    if __middleware.empty?
       return @syro
     else
-      return middleware.reverse.inject(@syro) { |a, m| m.call(a) }
+      return __middleware.reverse.inject(@syro) { |a, m| m.call(a) }
     end
   end
 
-  def self.middleware # :nodoc:
+  def self.__middleware # :nodoc:
     return @middleware ||= []
   end
 
@@ -35,6 +68,47 @@ class Tynn < Syro::Deck
     @middleware = []
   end
 
+  # Extends Tynn functionality with the given `helper` module.
+  #
+  # ```
+  # module AppName
+  #   def self.setup(app, name)
+  #     app.settings[:app_name] = name
+  #   end
+  #
+  #   def app_name
+  #     return self.class.app_name
+  #   end
+  #
+  #   module ClassMethods
+  #     def app_name=(new_name)
+  #       settings[:app_name] = new_name
+  #     end
+  #
+  #     def app_name
+  #       return settings[:app_name]
+  #     end
+  #   end
+  # end
+  #
+  # Tynn.helpers(AppName, "MyApplication")
+  #
+  # Tynn.app_name # => "MyApplication"
+  #
+  # Tynn.app_name = "MyGreatestApp"
+  # Tynn.app_name # => "MyGreatestApp"
+  #
+  # Tynn.define do
+  #   root do
+  #     res.write(app_name)
+  #   end
+  # end
+  # ```
+  #
+  # Check the [helpers][examples] that come with tynn for more examples.
+  #
+  # [examples]: https://github.com/harmoni/tynn/tree/master/lib/tynn
+  #
   def self.helpers(helper, *args, &block)
     self.include(helper)
 
@@ -46,6 +120,12 @@ class Tynn < Syro::Deck
       helper.setup(self, *args, &block)
     end
   end
-end
 
-require_relative "tynn/version"
+  def request_class # :nodoc:
+    return Tynn::Request
+  end
+
+  def response_class # :nodoc:
+    return Tynn::Response
+  end
+end

data/test/all_methods_test.rb

@@ -0,0 +1,16 @@
+require_relative "../lib/tynn/all_methods"
+
+Tynn.helpers(Tynn::AllMethods)
+
+test "methods" do
+  [:head, :options].each do |method|
+    Tynn.define do
+      send(method) { res.write "" }
+    end
+
+    app = Tynn::Test.new
+    app.send(method, "/")
+
+    assert_equal 200, app.res.status
+  end
+end