rack-session-smart_cookie 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccfe1e78018ea5fe84485f07aa4f7e192a84f6f4
-  data.tar.gz: 7452755223ebb2ac46fdcb39c407c31c5fffc7b4
+  metadata.gz: e682138e9aecc0f8acefb54f729c959536974345
+  data.tar.gz: 681900b1c6f1305a3e9bea1a8373de8715916ed6
 SHA512:
-  metadata.gz: 3cef56db48bce136ae73a44b98bfbf8ff25458d6436c6d7783e6c511194f86903620023786b2d097805514af8cf20129368613f8b924243d881475ff9e33238d
-  data.tar.gz: 8734ea8cc650b99ccac644a5e0f70f9f021709517923834618b33b9b6b1756ba2e6f0cb330ffbb57c0dc836e1a216a1f64269fe26ad812aeb32d9b028cc086a9
+  metadata.gz: 881d18f4b0f1dfd52990d6e850c6c7661ca2901632e4082b8ce71f75b8afe791f01847f8ed3d7697532bd40c4a60892c9d66dbc64d42ed70124e7f6d48f579fa
+  data.tar.gz: 4a581360b1a4ba190134cd6dc9211fe11c030cfd582789645702bffb54e4b4b78276082642da1a5c3cce8216ac75c26a761b2eae8bb4b0f017abbcea24777278

data/Gemfile

@@ -4,4 +4,4 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-#gem 'openssl', '>= 2.0.3'
+gem 'openssl', '>= 2.0.3'

data/README.md

@@ -43,10 +43,10 @@ serialized and stringified (in the case of the session payload) or merely
 stringified (in the case of the digest).
 
 The other key realization is that the method Rack uses to escape cookie data
-([URI.encode_www_form_component][5]) will only ever allow URL-safe Base64 plus
-period (`.`) and asterisk (`*`), so there's no sense in using any
-stringification scheme other than URL-safe Base64! It doesn't need to be
-configurable. The serializer remains configurable as the `:coder`.
+([URI.encode_www_form_component][5]) will only ever allow non-padded, URL-safe
+Base64 plus period (`.`) and asterisk (`*`), so there's no sense in using any
+stringification scheme other than non-padded, URL-safe Base64! It doesn't need
+to be configurable. The serializer remains configurable as the `:coder`.
 
 The remaining differences are mostly just better defaults: MessagePack and
 SHA2.
@@ -77,19 +77,23 @@ $ gem install rack-session-smart_cookie
 use Rack::Session::SmartCookie
 ```
 
-Rack::Session::SmartCookie accepts the same options as
-[Rack::Session::Cookie][6]. If you choose to override the default `:coder`, it
-should *not* perform the Base64 steps.
+Rack::Session::SmartCookie is a sub-class of [Rack::Session::Cookie][6] and
+accepts all the same options. If you choose to override the default `:coder`,
+it should *not* perform Base64 encoding or decoding.
 
-You can easily register additional custom types on the default coder's factory:
+The default `:coder` registers Symbol as a custom type on the factory. You can
+easily register additional custom types like so:
 
 ```ruby
-my_coder = Rack::Session::SmartCookie::MessagePack.new
-my_coder.factory.register_type(0x00, MyCustomType) # 0x60..0xFF are reserved
+my_coder = Rack::Session::SmartCookie::MessagePack.new do |factory|
+  factory.register_type(0x00, MyCustomType) # 0x60..0xFF are reserved
+end
 
 use Rack::Session::SmartCookie, :coder=>my_coder
 ```
 
+Please see the [MessagePack][3] documentation for more details.
+
 ## Comparisons
 
 For general size and performance benchmarks of the encoding schemes, see

data/lib/rack/session/smart_cookie.rb

@@ -55,10 +55,12 @@ module Rack
           # Create our own factory so we don't pollute the global namespace
           # with our custom type.
           @factory = ::MessagePack::Factory.new
-          # user gets 0x00...0x60
+
+          # MessagePack gets custom types 0x80..0xFF
           # we get 0x60...0x80
-          # MessagePack gets 0x80..0xFF
           @factory.register_type(0x60, Symbol)
+          # user gets 0x00...0x60
+          yield @factory if block_given?
         end
 
         def encode(data)

data/lib/rack/session/smart_cookie/version.rb

@@ -10,7 +10,7 @@ module Rack
     Cookie = Class.new unless defined?(Cookie)
 
     class SmartCookie < Cookie
-      VERSION = '0.1.1'.freeze
+      VERSION = '0.1.2'.freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-session-smart_cookie
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mike Pastore