coder_decorator 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a423e4cf25574fb8fc664fb87cfd4aeb6141db36
-  data.tar.gz: a7a5deaa59f369953372cc6503fb4ad2d0123a76
+  metadata.gz: a0565842f5d3c837685232a7b349511616ad779b
+  data.tar.gz: 9e87db8f9dc04ad0795ab0daaf1741e01ba34603
 SHA512:
-  metadata.gz: 7cea41ab6d8ce21c5e5ae102a840bc6322aedc8c9ebff76eeb7fbb0797c2a9c5282628cc3fa4af48ebcb7a12bca71a8d8e56739bc545848eeb0abf143c463a3c
-  data.tar.gz: 4e9a7ced2ee8742b3111a6ace93c60fdb8db2ad5bbab87c466b4ad1f289880223e18418208f1d639822d6f40777c1d3612011ff1536eec33f4a1b12d53656a56
+  metadata.gz: 193e8eaff80c90c4db9633149461399f8782f0c7538fe3f5154e9ea23f9a543835b76c5e637950b45606dce99961e35bc758804b33e57eadbfb7a4d046060ea2
+  data.tar.gz: 18e1e8afd7ba035dced6c5fc76f1f4c261110520a757333e493d616504b78666e84cebe1256658b106094d3fa3d74f726565dc93e464c4e088fad55b92514edc

data/README.md

@@ -0,0 +1,97 @@
+# CoderDecorator [![Build Status](https://travis-ci.org/tonytonyjan/coder_decorator.svg?branch=master)](https://travis-ci.org/tonytonyjan/coder_decorator) [![Yard Docs](https://img.shields.io/badge/yard-doc-blue.svg)](http://www.rubydoc.info/gems/coder_decorator/)
+
+It's a encoding/decoding library for Ruby designed with [decorator pattern](https://en.wikipedia.org/wiki/Decorator_pattern), which makes it more flexible, and can be wrapped infinitely using Ruby instantiation.
+
+This gem can refers to [this pull request](https://github.com/rack/rack/pull/1134).
+
+# Install
+
+```
+gem install 'coder_decorator'
+```
+
+# Usage
+
+Encode data with Marshal and Base64:
+
+```ruby
+require 'coder_decorator/coders/base64'
+require 'coder_decorator/coders/marshal'
+include CoderDecorator
+coder = Coders::Base64.new(Coders::Marshal.new)
+encoded_data = coder.encode(data)
+coder.decode(encoded_data)
+```
+
+Encode data with JSON and Zip:
+
+```ruby
+require 'coder_decorator/coders/json'
+require 'coder_decorator/coders/zip'
+include CoderDecorator
+coder = Coders::Zip.new(Coders::JSON.new)
+encoded_data = coder.encode(data)
+coder.decode(encoded_data)
+```
+
+To load all coders and utilities, simply do:
+
+```ruby
+require 'coder_decorator'
+```
+
+All built-in coders are listed in [lib/coder_decorator/coders](lib/coder_decorator/coders).
+
+## Use `CoderDecorator::Builder` to construct coders
+
+`CoderDecorator::Builder` provides a convenient interface to build a coder by passing arguments instead of tediously initializing and wrapping coders, for example:
+
+```ruby
+require 'coder_decorator/builder'
+CoderDecorator::Builder.build(:marshal, :base64)
+```
+
+is equivalent to:
+
+```ruby
+require 'coder_decorator/coders/marshal'
+require 'coder_decorator/coders/base64'
+CoderDecorator::Coders::Marshal.new(CoderDecorator::Coders::Base64.new)
+```
+
+Use array to pass arguments to the coder:
+
+```ruby
+CoderDecorator::Builder.build(:marshal, [:base64, {strict: true}])
+```
+
+Use `CoderDecorator.coder_names` to see all available coder names.
+
+## Integration with Rack
+
+```ruby
+require 'rack'
+require 'coder_decorator/builder'
+
+include CoderDecorator
+
+app = lambda do |env|
+  session = env['rack.session']
+  session[:count] ||= 0
+  session[:count] += 1
+  [200, {}, [session[:count].to_s]]
+end
+
+coder = CoderDecorator::Builder.build(
+  :marshal,
+  [:cipher, {secret: 'x' * 32}],
+  [:hmac, {secret: 'y' * 32}],
+  :rescue
+)
+
+app = Rack::Builder.app(app) do
+  use Rack::Session::Cookie, coder: coder, let_coder_handle_secure_encoding: true
+end
+
+Rack::Handler::WEBrick.run app
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coder_decorator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jian Weihang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.1
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.1
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/coder_decorator.rb
 - lib/coder_decorator/builder.rb
 - lib/coder_decorator/coders/base64.rb
@@ -71,7 +72,7 @@ files:
 - lib/coder_decorator/coders/zip.rb
 - lib/coder_decorator/errors.rb
 - lib/coder_decorator/name_converter.rb
-homepage: 
+homepage: https://github.com/tonytonyjan/coder_decorator
 licenses:
 - MIT
 metadata: {}