tynn 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2017e12fdca96b52fb5c2f954307b33e208c2ecb
-  data.tar.gz: 02cc565109da5f90593c370f818f213969c63c86
+  metadata.gz: a5bd012f5ff0f594ab60d1fa1a3f657e433558b4
+  data.tar.gz: 8d82f66b729cc4ed0ab9298e90c5dedce400b5dc
 SHA512:
-  metadata.gz: afcf9ebeb3457d3a7a9bd06878aa98cd9c88f8bf47dc1ecfeea008e4ad7571f3a9d1b0abff93b8ea68073edce4d2e0d59de72ce479c89e2fff458b4d5d954cfd
-  data.tar.gz: 4da2694ca6ec7484471c7c3ae51ca4406be40e0663ba6dce147adc2cc38d5d0abef0b88a214bc81cc8efe7334b2adcde456f6fe5e93ff66bbdc4921c094b8338
+  metadata.gz: a8798001b4bc3f4d4a3503e159e45a9516d8ce2310dbedfbd219f5d3cdfd1f5b24be7927b055c32d7db2d3feb2f37365ca94a888385248a34dccac60c0e71162
+  data.tar.gz: 7406e6aa902dab2bab7d46ce7b9cc5ca8378d4f8e40b8dfd309744cb84368f357d57b2113706b44bf34d6a50b6c25d30f8d28cef1b332ff82a73901bd00f568c

data/README.md

@@ -43,6 +43,11 @@ A thin library for web development in Ruby.
   * [HTTPS](#https)
 * [Testing](#testing)
 * [API Reference](http://api.tynn.xyz/2.0.0)
+* [Troubleshooting](#troubleshooting)
+  * [Application handler is missing](#missing_handler)
+  * [Application middleware is frozen](#frozen_middleware)
+  * [Secret key is required](#no_secret_key)
+  * [Secret key is shorter than 30 characters](#short_secret_key)
 * [Changelog](#changelog)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -645,6 +650,73 @@ end
 
 If this is not of your flavor, you can use any Rack-based testing library or framework, like: [Rack::Test] or [Capybara].
 
+## Troubleshooting
+
+If you have problems with running Tynn, see below or [ask in GitHub Issues](https://github.com/frodsan/tynn/issues/new).
+
+* <a name="missing_handler"></a>
+  **Application handler is missing**
+  <sup>[[link](#missing_handler)]</sup>
+
+  Application handler is probably not set. Try `#define`:
+
+  ```ruby
+  MyApp.define do
+    # ...
+  end
+
+  run(MyApp)
+  ```
+
+* <a name="frozen_middleware"></a>
+  **Application middleware is frozen**
+  <sup>[[link](#frozen_middleware)]</sup>
+
+  Application middleware is frozen when application handler is set. Please, set the middleware before setting the application handler.
+
+  ```ruby
+  # bad
+  MyApp.define do
+    # ...
+  end
+
+  MyApp.use(Middleware)
+
+  # good
+  MyApp.use(Middleware)
+
+  MyApp.define do
+    # ...
+  end
+  ```
+
+* <a name="no_secret_key"></a>
+  **Secret key is required**
+  <sup>[[link](#no_secret_key)]</sup>
+
+  [Tynn::Session] uses a secret key to sign the cookie's data, thus unauthorized means can't alter it. Please, add the secret option to your code:
+
+  ```ruby
+  MyApp.plugin(Tynn::Session, secret: "__change_me__", ...)
+  ```
+
+  If you're sharing your code publicly, make sure the secret key is kept private. Knowing the secret allows an attacker to tamper the data. You can use environment variables to store the secret key:
+
+  ```ruby
+  MyApp.plugin(Tynn::Session, secret: ENV.fetch("SESSION_SECRET"), ...)
+  ```
+
+* <a name="short_secret_key"></a>
+  **Secret key is shorter than 30 characters**
+  <sup>[[link](#short_secret_key)]</sup>
+
+  The secret provided is shorter than the minimum length. Make sure the secret is long and all random. You can generate a secure secret key with:
+
+  ```
+  $ ruby -r securerandom -e "puts SecureRandom.hex(64)"
+  929234f24e8c7450166a88142a...
+  ```
+
 ## Changelog
 
 To learn about new features, bug fixes, and changes, please refer to the [CHANGELOG](https://github.com/frodsan/tynn/blob/master/CHANGELOG.md).

data/lib/tynn/base.rb

@@ -23,7 +23,6 @@
 
 require "rack"
 require "seg"
-require_relative "errors"
 require_relative "request"
 require_relative "response"
 require_relative "utils"
@@ -77,15 +76,7 @@ class Tynn
       #
       def use(middleware, *args, &block)
         if self.middleware.frozen?
-          raise Tynn::Error, <<~MSG
-            Application middleware is frozen and cannot be changed.
-
-            Please, set the middleware before setting the application handler:
-
-            #{ self }.use(#{ middleware })
-
-            #{ self }.define { ... }
-          MSG
+          Tynn::Utils.raise_error("Application middleware is frozen", tag: :frozen_middleware)
         else
           self.middleware.push(proc { |app| middleware.new(app, *args, &block) })
         end
@@ -101,7 +92,7 @@ class Tynn
 
       def app # :nodoc:
         (defined?(@__app) && @__app) or
-          raise(Tynn::Error, "Application handler is missing. Try #{ self }.define {}")
+          Tynn::Utils.raise_error("Application handler is missing", tag: :missing_handler)
       end
 
       # Copies settings into the subclass. If a setting is not found,
@@ -317,7 +308,9 @@ class Tynn
 
         @__env["PATH_INFO"] = @__seg.curr
         @__env["SCRIPT_NAME"] = @__seg.prev
-        @__env["tynn.inbox"] = inbox
+
+        @__env.delete("tynn.inbox")
+        @__env["tynn.inbox"] = inbox if inbox
 
         halt(app.call(@__env))
       ensure
@@ -341,7 +334,7 @@ class Tynn
       #   end
       #
       def inbox
-        @__env["tynn.inbox"] || {}
+        @__env.fetch("tynn.inbox", {})
       end
 
       # Returns <tt>true</tt> if the request method is <tt>GET</tt> and

data/lib/tynn/request.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rack/request"
+
 class Tynn
   # It provides convenience methods for pulling out information from a request.
   #

data/lib/tynn/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rack/utils"
+
 class Tynn
   # It provides convenience methods to construct a Rack response.
   #

data/lib/tynn/session.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "rack/session/cookie"
+require_relative "utils"
+
 class Tynn
   # Adds simple cookie based session management. You can pass a secret
   # token to sign the cookie data, thus unauthorized means can't alter it.
@@ -77,32 +80,19 @@ class Tynn
       secret = options[:secret]
 
       if secret.nil?
-        raise Tynn::Error, <<~MSG
-          No secret option provided to Tynn::Session.
-
-          Tynn::Session uses a secret token to sign the cookie data, thus
-          unauthorized means can't alter it. Please, add the secret option
-          to your code:
-
-              #{ app }.plugin(Tynn::Session, secret: "__a_long_random_secret__", ...)
-
-          If you're sharing your code publicly, make sure the secret key
-          is kept private. Knowing the secret allows an attacker to tamper
-          the data. You can use environment variables to store the secret:
-
-              #{ app }.plugin(Tynn::Session, secret: ENV.fetch("SESSION_SECRET"), ...)
-        MSG
+        Tynn::Utils.raise_error(
+          "Secret key is required",
+          error: ArgumentError,
+          tag: :no_secret_key
+        )
       end
 
       if secret.length < SECRET_MIN_LENGTH
-        raise Tynn::Error, <<~MSG
-          The secret provided is shorter than the minimum length.
-
-          Make sure the secret is long and all random. You can generate a
-          secure secret key with:
-
-              $ ruby -r securerandom -e "puts SecureRandom.hex(64)"
-        MSG
+        Tynn::Utils.raise_error(
+          "Secret key is shorter than #{ SECRET_MIN_LENGTH } characters",
+          error: ArgumentError,
+          tag: :short_secret_key
+        )
       end
 
       app.use(Rack::Session::Cookie, {

data/lib/tynn/ssl.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "request"
+
 class Tynn
   # Enforces secure HTTP requests by:
   #

data/lib/tynn/static.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rack/static"
+
 class Tynn
   # Serves static files (javascript files, images, stylesheets, etc).
   #

data/lib/tynn/utils.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Tynn
   module Utils # :nodoc:
     module_function
@@ -11,5 +9,9 @@ class Tynn
     ensure
       hash.default_proc = default_proc
     end
+
+    def raise_error(message, error: RuntimeError, tag: "troubleshooting")
+      raise error, sprintf("%s. See http://tynn.xyz/#%s.", message, tag)
+    end
   end
 end

data/lib/tynn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Tynn
-  VERSION = "2.0.0.beta1" # :nodoc:
+  VERSION = "2.0.0.beta2" # :nodoc:
 end

data/test/middleware_test.rb

@@ -91,7 +91,7 @@ class MiddlewareTest < Minitest::Test
 
     app.define {}
 
-    assert_raises(Tynn::Error) do
+    assert_raises(RuntimeError) do
       app.use(Shrimp, name: "foo", bar: 1)
     end
   end

data/test/routing_test.rb

@@ -8,7 +8,7 @@ class RoutingTest < Minitest::Test
   end
 
   def test_raise_if_not_handler
-    assert_raises(Tynn::Error) { @app.call({}) }
+    assert_raises(RuntimeError) { @app.call({}) }
   end
 
   def test_path_matching

data/test/session_test.rb

@@ -8,12 +8,12 @@ class SessionTest < Minitest::Test
     @app = new_app
   end
 
-  def test_raise_error_if_secret_is_empty
-    assert_raises(Tynn::Error) { @app.plugin(Tynn::Session) }
+  def test_raise_error_if_secret_is_nil
+    assert_raises(ArgumentError) { @app.plugin(Tynn::Session) }
   end
 
   def test_raise_error_if_secret_is_short
-    assert_raises(Tynn::Error) { @app.plugin(Tynn::Session, secret: "__not_secure__") }
+    assert_raises(ArgumentError) { @app.plugin(Tynn::Session, secret: "__not_secure__") }
   end
 
   def test_set_and_get_session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tynn
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Francesco Rodriguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.x
 - !ruby/object:Gem::Dependency
   name: hmote
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +91,6 @@ files:
 - lib/tynn.rb
 - lib/tynn/base.rb
 - lib/tynn/environment.rb
-- lib/tynn/errors.rb
 - lib/tynn/json.rb
 - lib/tynn/render.rb
 - lib/tynn/request.rb

data/lib/tynn/errors.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class Tynn
-  # Generic Tynn exception class.
-  class Error < StandardError
-  end
-end