coder_decorator 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0565842f5d3c837685232a7b349511616ad779b
-  data.tar.gz: 9e87db8f9dc04ad0795ab0daaf1741e01ba34603
+  metadata.gz: 7155de757d7a11efebe6aaee8a3cdb785fde54cf
+  data.tar.gz: fa86ce84c8c168822da29def9df4b93786fbdc01
 SHA512:
-  metadata.gz: 193e8eaff80c90c4db9633149461399f8782f0c7538fe3f5154e9ea23f9a543835b76c5e637950b45606dce99961e35bc758804b33e57eadbfb7a4d046060ea2
-  data.tar.gz: 18e1e8afd7ba035dced6c5fc76f1f4c261110520a757333e493d616504b78666e84cebe1256658b106094d3fa3d74f726565dc93e464c4e088fad55b92514edc
+  metadata.gz: 77458a9ed211be9a4770bd7a91d3e88343ccfe7da701beb1e220b580db1a7689478a5666c8392ef7830af6244e1d6bd0d258ab3177a50df91cd537eb6e545f9d
+  data.tar.gz: b7fd8de88992caaa41dcd38ab35287f5d6e38b3dedf0304ea8c4beae84f09c202b183ee1029bb04b2ab7e4dcdb558d706041380e49fa809307590be8bb89e495

data/README.md

@@ -15,8 +15,7 @@ gem install 'coder_decorator'
 Encode data with Marshal and Base64:
 
 ```ruby
-require 'coder_decorator/coders/base64'
-require 'coder_decorator/coders/marshal'
+require 'coder_decorator'
 include CoderDecorator
 coder = Coders::Base64.new(Coders::Marshal.new)
 encoded_data = coder.encode(data)
@@ -26,52 +25,20 @@ coder.decode(encoded_data)
 Encode data with JSON and Zip:
 
 ```ruby
-require 'coder_decorator/coders/json'
-require 'coder_decorator/coders/zip'
+require 'coder_decorator'
 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.
+Coders are listed in [lib/coder_decorator/coders](lib/coder_decorator/coders).
 
 ## Integration with Rack
 
 ```ruby
 require 'rack'
-require 'coder_decorator/builder'
+require 'coder_decorator'
 
 include CoderDecorator
 
@@ -82,11 +49,14 @@ app = lambda do |env|
   [200, {}, [session[:count].to_s]]
 end
 
-coder = CoderDecorator::Builder.build(
-  :marshal,
-  [:cipher, {secret: 'x' * 32}],
-  [:hmac, {secret: 'y' * 32}],
-  :rescue
+coder = Coders::Rescue.new(
+  Coders::HMAC.new(
+    Coders::Cipher.new(
+      Coders::JSON.new,
+      secret: 'x' * 32
+    ),
+    secret: 'y' * 32
+  )
 )
 
 app = Rack::Builder.app(app) do

data/lib/coder_decorator.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
+
 module CoderDecorator # :nodoc:
+  module Coders # :nodoc:
+    autoload :Base64, 'coder_decorator/coders/base64'
+    autoload :Cipher, 'coder_decorator/coders/cipher'
+    autoload :Coder, 'coder_decorator/coders/coder'
+    autoload :HMAC, 'coder_decorator/coders/hmac'
+    autoload :Identity, 'coder_decorator/coders/identity'
+    autoload :JSON, 'coder_decorator/coders/json'
+    autoload :Marshal, 'coder_decorator/coders/marshal'
+    autoload :Rescue, 'coder_decorator/coders/rescue'
+    autoload :Zip, 'coder_decorator/coders/zip'
+  end
+
   def self.coder_names
     @coder_names ||= begin
       coder_names = Dir["#{__dir__}/coder_decorator/coders/*"].map! { |name| File.basename(name, '.rb') }

data/lib/coder_decorator/coders/base64.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 module CoderDecorator
   module Coders
@@ -14,8 +15,6 @@ module CoderDecorator
 
       def decode(str)
         coder.decode(str.unpack(@template_str).first)
-      rescue ::ArgumentError
-        raise InvalidEncoding
       end
     end
   end

data/lib/coder_decorator/coders/cipher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
-require 'coder_decorator/coders/base64'
 require 'openssl'
 
 module CoderDecorator
@@ -14,8 +14,7 @@ module CoderDecorator
         super(coder)
         @secret = secret
         @old_secret = old_secret
-        @cipher = ::OpenSSL::Cipher.new(cipher)
-        @base64 = Coders::Base64.new
+        @cipher = OpenSSL::Cipher.new(cipher)
       end
 
       def encode(obj)
@@ -23,29 +22,23 @@ module CoderDecorator
         @cipher.key = @secret
         iv = @cipher.random_iv
         encrypted_data = @cipher.update(coder.encode(obj)) << @cipher.final
-        blob = "#{@base64.encode(encrypted_data)}--#{@base64.encode(iv)}"
-        @base64.encode(blob)
+        "#{[encrypted_data].pack('m0')}--#{[iv].pack('m0')}"
       end
 
-      def decode(str)
-        [@secret, @old_secret].each do |secret|
+      def decode(data)
+        secrets = [@old_secret, @secret]
+        until secrets.empty?
+          secret = secrets.pop
           begin
-            return decrypt(secret, str)
-          rescue ::OpenSSL::Cipher::CipherError, ::TypeError
-            next
+            encrypted_data, iv = data.split('--').map! { |v| v.unpack('m0').first }
+            @cipher.decrypt
+            @cipher.key = secret
+            @cipher.iv  = iv
+            return coder.decode(@cipher.update(encrypted_data) << @cipher.final)
+          rescue StandardError
+            secrets.empty? ? raise : next
           end
         end
-        raise InvalidEncoding
-      end
-
-      private
-
-      def decrypt(secret, data)
-        encrypted_data, iv = @base64.decode(data).split('--').map! { |v| @base64.decode(v) }
-        @cipher.decrypt
-        @cipher.key = secret
-        @cipher.iv  = iv
-        coder.decode(@cipher.update(encrypted_data) << @cipher.final)
       end
     end
   end

data/lib/coder_decorator/coders/coder.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'coder_decorator/errors'
+
 module CoderDecorator
   module Coders
     # The abstract class of coder, must implement #encode and #decode.
@@ -24,41 +24,26 @@ module CoderDecorator
     #       end
     #     end
     #
-    class Coder < BasicObject
-      DELEGATE = %i(raise respond_to? respond_to_missing?).freeze
+    class Coder
+      attr_reader :coder
 
       # Can optionally pass a base coder which is going to be decorated.
       def initialize(coder = nil)
-        @_coder = coder
-      end
-
-      def coder
-        @_coder ||= Null.new
+        @coder = coder || Null.new
       end
 
       def encode(_obj)
-        ::Kernel.raise ::NotImplementedError
+        raise NotImplementedError
       end
 
       # It decodes +_obj+, returning decoded data,
       # or +nil+ if it can't decode.
       def decode(_obj)
-        ::Kernel.raise ::NotImplementedError
-      end
-
-      private
-
-      def method_missing(name, *args, &block)
-        super unless DELEGATE.include? name
-        ::Kernel.send(name, *args, &block)
-      end
-
-      def respond_to_missing?(name, include_private = false)
-        DELEGATE.include?(name) || super
+        raise NotImplementedError
       end
     end
 
-    class Null < BasicObject # :nodoc:
+    class Null # :nodoc:
       def encode(obj)
         obj
       end

data/lib/coder_decorator/coders/hmac.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 require 'openssl'
 
@@ -10,6 +11,8 @@ module CoderDecorator
     #     "#{data}--#{hmac}"
     #
     class HMAC < Coder
+      class InvalidSignature < StandardError; end
+
       REGEXP = /\A(.*)--(.*)\z/
 
       def initialize(coder = nil, secret:, old_secret: nil, digest: 'SHA1')
@@ -27,9 +30,9 @@ module CoderDecorator
 
       def decode(str)
         match_data = REGEXP.match(str)
-        data, hmac = match_data && match_data.captures
+        data, hmac = match_data.captures if match_data
         secrets = [@secret, @old_secret]
-        raise InvalidEncoding unless data && hmac && secrets.any? { |secret| secure_compare(hmac, generate_hmac(secret, data)) }
+        raise InvalidSignature unless data && hmac && secrets.any? { |secret| secure_compare(hmac, generate_hmac(secret, data)) }
         coder.decode(data)
       end
 
@@ -39,7 +42,7 @@ module CoderDecorator
         ::OpenSSL::HMAC.hexdigest(@digest.new, secret, str)
       end
 
-      def secure_compare(a, b)
+      def secure_compare(a, b) # rubocop:disable Naming/UncommunicativeMethodParamName
         return false unless a.bytesize == b.bytesize
         l = a.unpack('C*')
         r = 0

data/lib/coder_decorator/coders/identity.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 module CoderDecorator
   module Coders

data/lib/coder_decorator/coders/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 require 'json'
 module CoderDecorator
@@ -10,8 +11,6 @@ module CoderDecorator
 
       def decode(str)
         coder.decode(::JSON.parse(str))
-      rescue ::JSON::ParserError
-        raise InvalidEncoding
       end
     end
   end

data/lib/coder_decorator/coders/marshal.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
+
 module CoderDecorator
   module Coders
     class Marshal < Coder # :nodoc:
@@ -9,8 +11,6 @@ module CoderDecorator
 
       def decode(str)
         coder.decode(::Marshal.load(str))
-      rescue ::TypeError
-        raise InvalidEncoding
       end
     end
   end

data/lib/coder_decorator/coders/rescue.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 module CoderDecorator
   module Coders
@@ -10,7 +11,7 @@ module CoderDecorator
 
       def decode(obj)
         coder.decode(obj)
-      rescue
+      rescue StandardError
         nil
       end
     end

data/lib/coder_decorator/coders/zip.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'coder_decorator/coders/coder'
 require 'zlib'
 module CoderDecorator
@@ -10,8 +11,6 @@ module CoderDecorator
 
       def decode(str)
         coder.decode(::Zlib::Inflate.inflate(str))
-      rescue ::Zlib::DataError
-        raise InvalidEncoding
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coder_decorator
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jian Weihang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.53.0
 description: An encoding/decoding library with decorator pattern.
 email: tonytonyjan@gmail.com
 executables: []
@@ -60,7 +60,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/coder_decorator.rb
-- lib/coder_decorator/builder.rb
 - lib/coder_decorator/coders/base64.rb
 - lib/coder_decorator/coders/cipher.rb
 - lib/coder_decorator/coders/coder.rb
@@ -70,8 +69,6 @@ files:
 - lib/coder_decorator/coders/marshal.rb
 - lib/coder_decorator/coders/rescue.rb
 - lib/coder_decorator/coders/zip.rb
-- lib/coder_decorator/errors.rb
-- lib/coder_decorator/name_converter.rb
 homepage: https://github.com/tonytonyjan/coder_decorator
 licenses:
 - MIT
@@ -92,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An encoding/decoding library with decorator pattern.

data/lib/coder_decorator/builder.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-require 'coder_decorator/name_converter'
-module CoderDecorator
-  # It provides a convenient interface to build a coder by passing arguments
-  # instead of tediously initializing and wrapping, for example:
-  #
-  #     require 'coder_decorator/builder'
-  #     CoderDecorator::Builder.build(:marshal, :base64)
-  #
-  # is equivalent to:
-  #
-  #     require 'coder_decorator/coders/marshal'
-  #     require 'coder_decorator/coders/base64'
-  #     CoderDecorator::Coders::Marshal.new(CoderDecorator::Coders::Base64.new)
-  #
-  # To pass arguments to a coder, use array:
-  #
-  #     CoderDecorator::Builder.build(:marshal, [:base64, {strict: true}])
-  #
-  class Builder
-    # equivalent to +new(*coder_names).build+
-    def self.build(*coder_names)
-      new(*coder_names).build
-    end
-
-    # all coder names are listed as filenames under +lib/coder_decorator/coders+,
-    def initialize(*coder_names)
-      @coder_names = coder_names
-    end
-
-    def build
-      coder = nil
-      @coder_names.each do |coder_name|
-        case coder_name
-        when String, Symbol, Array
-          name, *arguments = Array(coder_name)
-          coder_class = NameConverter.new(name).constantize
-          coder = coder_class.new(coder, *arguments)
-        else
-          raise ArgumentError, "Each argument should be one of Symbol, String or Array instance, but #{coder_name.inspect} was given."
-        end
-      end
-      coder
-    end
-  end
-end

data/lib/coder_decorator/errors.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-module CoderDecorator
-  class Error < RuntimeError; end
-  class InvalidEncoding < Error; end
-end

data/lib/coder_decorator/name_converter.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-module CoderDecorator
-  # It converts coder names into class name or constant, for example:
-  #
-  #     NameConverter.new('base64').to_class_name # => 'Base64'
-  #     NameConverter.new('base64').constantize # => Coders::Base64
-  #     NameConverter.new('json').to_class_name # => 'JSON'
-  #     NameConverter.new('json').to_class_name # => Coders::JSON
-  #
-  class NameConverter
-    def initialize(coder_name)
-      @coder_name = coder_name.to_s
-    end
-
-    def constantize
-      @constantize ||= begin
-        require_relative "coders/#{@coder_name}"
-        CoderDecorator.const_get("Coders::#{to_class_name}")
-      rescue LoadError
-        raise "The coder \"#{@coder_name}\" doesn't exist, use `CoderDecorator.coder_names` to see all available coders."
-      end
-    end
-
-    def to_class_name
-      case @coder_name
-      when 'hmac', 'json' then @coder_name.upcase
-      else @coder_name.to_s.split('_').map!(&:capitalize!).join
-      end
-    end
-  end
-end