coder_decorator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f29535d9096afdc19576192bc1f3c8417ab764f0
+  data.tar.gz: bcb43020e75dcc1d579ab24108b897d8b1f205bf
+SHA512:
+  metadata.gz: 734f600c21637fb446c8188933581d405e955900b4bb75423ab0a9e882e48e846e04ea4b40daac85d73d76169e8ef4b02849ec446128b3a5330762db87a21df1
+  data.tar.gz: 54f858ea180c61ef4639926b08dcc86062f8c4734c1e55adb2fb0c558da7eb6bf1482e54fb95ed36c17a28d16fa5c2ea57d99f392ebcd343915de131493adb99

data/lib/coder_decorator.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+module CoderDecorator; end # :nodoc:
+Dir[File.join(__dir__, 'coder_decorator', '**', '*.rb')].each { |path| require path }

data/lib/coder_decorator/coders/base64.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+module CoderDecorator
+  module Coders
+    class Base64 < Coder # :nodoc:
+      def initialize(coder = nil, strict: true)
+        super(coder)
+        @template_str = strict ? 'm0' : 'm'
+      end
+
+      def encode(obj)
+        [coder.encode(obj)].pack(@template_str)
+      end
+
+      def decode(str)
+        coder.decode(str.unpack(@template_str).first)
+      rescue ::ArgumentError
+        raise InvalidEncoding
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/cipher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+require 'coder_decorator/coders/base64'
+require 'openssl'
+
+module CoderDecorator
+  module Coders
+    # Encrypt the data into this format:
+    #
+    #     "#{encrypted_data}--#{initial_vector}"
+    #
+    class Cipher < Coder
+      def initialize(coder = nil, secret:, cipher: 'AES-256-CBC')
+        super(coder)
+        @secret = secret
+        @cipher = ::OpenSSL::Cipher.new(cipher)
+        @base64 = Coders::Base64.new
+      end
+
+      def encode(obj)
+        @cipher.encrypt
+        @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)
+      end
+
+      def decode(str)
+        encrypted_data, iv = @base64.decode(str).split('--').map! { |v| @base64.decode(v) }
+        @cipher.decrypt
+        @cipher.key = @secret
+        @cipher.iv  = iv
+        begin
+          coder.decode(@cipher.update(encrypted_data) << @cipher.final)
+        rescue ::OpenSSL::Cipher::CipherError
+          raise InvalidEncoding
+        end
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/coder.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require 'coder_decorator/errors'
+module CoderDecorator
+  module Coders
+    # The abstract class of coder, must implement #encode and #decode.
+    # It's designed with decorator pattern, which makes it more flexible,
+    # and can be wrapped infinitely using Ruby instantiation.
+    #
+    # To implement a custom coder decorator, inherit from Coders::Coder, and use
+    # +coder.encode+, +coder.decode+ to get results from base coder:
+    #
+    #    class Reverse < Coders::Coder
+    #       def encode(str); coder.encode(str).reverse; end
+    #       def decode(str); coder.decode(str.reverse); end
+    #    end
+    #    coder = Reverse.new(Coder::Base64.new)
+    #
+    # If you want to customize options, be sure to call super:
+    #
+    #     class MyCoder < Coders::Coder
+    #       def initialize(gueset_coder, options = {})
+    #         super(guest_coder)
+    #         @options = options
+    #       end
+    #     end
+    #
+    class Coder < BasicObject
+      # Can optionally pass a base coder which is going to be decorated.
+      def initialize(coder = nil)
+        @_coder = coder
+      end
+
+      def coder
+        @_coder ||= Null.new
+      end
+
+      def encode(_obj)
+        ::Kernel.raise ::NotImplementedError
+      end
+
+      # It decodes +_obj+, returning decoded data,
+      # or +nil+ if it can't decode.
+      def decode(_obj)
+        ::Kernel.raise ::NotImplementedError
+      end
+
+      def raise(*args)
+        ::Kernel.raise(*args)
+      end
+    end
+
+    class Null < BasicObject # :nodoc:
+      def encode(obj)
+        obj
+      end
+
+      def decode(obj)
+        obj
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/hmac.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+require 'openssl'
+
+module CoderDecorator
+  module Coders
+    # Actuall, it doesn't encode, instead, it appends a hex HMAC to the input data
+    # in this format:
+    #
+    #     "#{data}--#{hmac}"
+    #
+    class HMAC < Coder
+      REGEXP = /\A(.*)--(.*)\z/
+
+      def initialize(coder = nil, secret:, digest: 'SHA1')
+        super(coder)
+        @secret = secret
+        @digest = ::OpenSSL::Digest.new(digest)
+      end
+
+      def encode(str)
+        data = coder.encode(str)
+        hmac = generate_hmac(data)
+        "#{data}--#{hmac}"
+      end
+
+      def decode(str)
+        data, hmac = REGEXP.match(str)&.captures
+        raise InvalidEncoding unless data && hmac && secure_compare(hmac, generate_hmac(data))
+        coder.decode(data)
+      end
+
+      private
+
+      def generate_hmac(str)
+        ::OpenSSL::HMAC.hexdigest(@digest.new, @secret, str)
+      end
+
+      def secure_compare(a, b)
+        return false unless a.bytesize == b.bytesize
+        l = a.unpack('C*')
+        r = 0
+        i = -1
+        b.each_byte { |v| r |= v ^ l[i += 1] }
+        r.zero?
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/identity.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+module CoderDecorator
+  module Coders
+    class Identity < Coder # :nodoc:
+      def encode(obj)
+        coder.encode(obj)
+      end
+
+      def decode(obj)
+        coder.decode(obj)
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/json.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+require 'json'
+module CoderDecorator
+  module Coders
+    class JSON < Coder # :nodoc:
+      def encode(obj)
+        ::JSON.dump(coder.encode(obj))
+      end
+
+      def decode(str)
+        coder.decode(::JSON.parse(str))
+      rescue ::JSON::ParserError
+        raise InvalidEncoding
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/marshal.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+module CoderDecorator
+  module Coders
+    class Marshal < Coder # :nodoc:
+      def encode(obj)
+        ::Marshal.dump(coder.encode(obj))
+      end
+
+      def decode(str)
+        coder.decode(::Marshal.load(str))
+      rescue ::TypeError
+        raise InvalidEncoding
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/rescue.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+module CoderDecorator
+  module Coders
+    # When there's exception raised, it rescues and return +nil+.
+    class Rescue < Coder # :nodoc:
+      def encode(obj)
+        coder.encode(obj)
+      end
+
+      def decode(obj)
+        coder.decode(obj)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/coder_decorator/coders/zip.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'coder_decorator/coders/coder'
+require 'zlib'
+module CoderDecorator
+  module Coders
+    class Zip < Coder # :nodoc:
+      def encode(str)
+        ::Zlib::Deflate.deflate(coder.encode(str))
+      end
+
+      def decode(str)
+        coder.decode(::Zlib::Inflate.inflate(str))
+      rescue ::Zlib::DataError
+        raise InvalidEncoding
+      end
+    end
+  end
+end

data/lib/coder_decorator/errors.rb

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: coder_decorator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jian Weihang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An encoding/decoding library with decorator pattern.
+email: tonytonyjan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coder_decorator.rb
+- lib/coder_decorator/coders/base64.rb
+- lib/coder_decorator/coders/cipher.rb
+- lib/coder_decorator/coders/coder.rb
+- lib/coder_decorator/coders/hmac.rb
+- lib/coder_decorator/coders/identity.rb
+- lib/coder_decorator/coders/json.rb
+- lib/coder_decorator/coders/marshal.rb
+- lib/coder_decorator/coders/rescue.rb
+- lib/coder_decorator/coders/zip.rb
+- lib/coder_decorator/errors.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: An encoding/decoding library with decorator pattern.
+test_files: []