Add serializers for Dates, Integers and Floats

lib/vault/rails.rb

@@ -1,21 +1,27 @@
-require "vault"
+require 'vault'
 
-require "base64"
-require "json"
+require 'base64'
+require 'json'
 
-require_relative "encrypted_model"
-require_relative "rails/configurable"
-require_relative "rails/errors"
-require_relative "rails/serializer"
-require_relative "rails/version"
+require_relative 'encrypted_model'
+require_relative 'rails/configurable'
+require_relative 'rails/errors'
+require_relative 'rails/serializers/json_serializer'
+require_relative 'rails/serializers/date_serializer'
+require_relative 'rails/serializers/integer_serializer'
+require_relative 'rails/serializers/float_serializer'
+require_relative 'rails/version'
 
 module Vault
   module Rails
     # The list of serializers.
     #
     # @return [Hash<Symbol, Module>]
     SERIALIZERS = {
-      json: Vault::Rails::JSONSerializer,
+      json:     Vault::Rails::Serializers::JSONSerializer,
+      date:     Vault::Rails::Serializers::DateSerializer,
+      integer:  Vault::Rails::Serializers::IntegerSerializer,
+      float:    Vault::Rails::Serializers::FloatSerializer
     }.freeze
 
     # The default encoding.
@@ -136,7 +142,7 @@ def serializer_for(key)
         if serializer = SERIALIZERS[key]
           return serializer
         else
-          raise Vault::Rails::UnknownSerializerError.new(key)
+          raise Vault::Rails::Serializers::UnknownSerializerError.new(key)
         end
       end
 

lib/vault/rails/errors.rb

@@ -1,19 +1,20 @@
 module Vault
   module Rails
     class VaultRailsError < RuntimeError; end
+    class ValidationFailedError < VaultRailsError; end
 
-    class UnknownSerializerError < VaultRailsError
-      def initialize(key)
-        super <<-EOH
-  Unknown Vault serializer `:#{key}'. Valid serializers are:
+    module Serializers
+      class UnknownSerializerError < VaultRailsError
+        def initialize(key)
+          super <<-EOH
+  Unknown Vault serializer `:#{key}`. Valid serializers are:
 
-      #{SERIALIZERS.keys.sort.map(&:inspect).join(", ")}
+          #{SERIALIZERS.keys.sort.map(&:inspect).join(", ")}
 
   Please refer to the documentation for more examples.
-  EOH
+          EOH
+        end
       end
     end
-
-    class ValidationFailedError < VaultRailsError; end
   end
 end

lib/vault/rails/serializers/date_serializer.rb

@@ -0,0 +1,22 @@
+module Vault
+  module Rails
+    module Serializers
+      # Converts date objects to and from ISO 8601 format (%F)
+      module DateSerializer
+        module_function
+
+        def encode(raw)
+          return nil if raw.blank?
+
+          raw = Date.parse(raw) if raw.is_a? String
+          raw.strftime('%F')
+        end
+
+        def decode(raw)
+          return nil if raw.blank?
+          Date.strptime(raw, '%F')
+        end
+      end
+    end
+  end
+end

lib/vault/rails/serializers/float_serializer.rb

@@ -0,0 +1,21 @@
+module Vault
+  module Rails
+    module Serializers
+      module FloatSerializer
+        module_function
+
+        def encode(raw)
+          return nil if raw.blank?
+          raw.to_s
+        end
+
+        def decode(raw)
+          return nil if raw.blank?
+          raw.to_f
+        end
+      end
+    end
+  end
+end
+
+

lib/vault/rails/serializers/integer_serializer.rb

@@ -0,0 +1,19 @@
+module Vault
+  module Rails
+    module Serializers
+      module IntegerSerializer
+        module_function
+
+        def encode(raw)
+          return nil if raw.blank?
+          raw.to_s
+        end
+
+        def decode(raw)
+          return nil if raw.blank?
+          raw.to_i
+        end
+      end
+    end
+  end
+end

lib/vault/rails/serializers/json_serializer.rb

@@ -0,0 +1,35 @@
+module Vault
+  module Rails
+    module Serializers
+      module JSONSerializer
+        DECODE_OPTIONS = {
+          max_nested:       false,
+          create_additions: false,
+        }.freeze
+
+        def self.encode(raw)
+          self._init!
+
+          raw = {} if raw.nil?
+
+          JSON.fast_generate(raw)
+        end
+
+        def self.decode(raw)
+          self._init!
+
+          return {} if raw.nil? || raw.empty?
+          JSON.parse(raw, DECODE_OPTIONS)
+        end
+
+        protected
+
+        def self._init!
+          return if defined?(@_init)
+          require "json"
+          @_init = true
+        end
+      end
+    end
+  end
+end

spec/unit/rails/serializers/date_serializer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Vault::Rails::Serializers::DateSerializer do
+  it 'encodes values to strings' do
+    expect(subject.encode(Date.new(1999, 1, 1))). to eq '1999-01-01'
+  end
+
+  it 'decodes values from strings' do
+    expect(subject.decode('1999-12-31')). to eq Date.new(1999, 12, 31)
+  end
+end
+

spec/unit/rails/serializers/float_serializer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Vault::Rails::Serializers::FloatSerializer do
+  it 'encodes values to strings' do
+    expect(subject.encode(1.0)). to eq '1.0'
+    expect(subject.encode(42.00001)). to eq '42.00001'
+    expect(subject.encode(435345.40035)). to eq '435345.40035'
+  end
+
+  it 'decodes values from strings' do
+    expect(subject.decode('1.0')). to eq 1.0
+    expect(subject.decode('42')). to eq 42.0
+    expect(subject.decode('435345.40035')). to eq 435345.40035
+  end
+end

spec/unit/rails/serializers/integer_serializer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Vault::Rails::Serializers::IntegerSerializer do
+  it 'encodes values to strings' do
+    expect(subject.encode(1)). to eq '1'
+    expect(subject.encode(42)). to eq '42'
+    expect(subject.encode(23425)). to eq '23425'
+  end
+
+  it 'decodes values from strings' do
+    expect(subject.decode('1')). to eq 1
+    expect(subject.decode('42')). to eq 42
+    expect(subject.decode('23425')). to eq 23425
+  end
+end

spec/unit/rails_spec.rb

@@ -1,22 +1,22 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Vault::Rails do
-  describe ".serializer_for" do
-    it "accepts a string" do
-      serializer = Vault::Rails.serializer_for("json")
-      expect(serializer).to be(Vault::Rails::JSONSerializer)
+  describe '.serializer_for' do
+    it 'accepts a string' do
+      serializer = Vault::Rails.serializer_for('json')
+      expect(serializer).to be(Vault::Rails::Serializers::JSONSerializer)
     end
 
-    it "accepts a symbol" do
+    it 'accepts a symbol' do
       serializer = Vault::Rails.serializer_for(:json)
-      expect(serializer).to be(Vault::Rails::JSONSerializer)
+      expect(serializer).to be(Vault::Rails::Serializers::JSONSerializer)
     end
 
-    it "raises an exception when there is no serializer for the key" do
+    it 'raises an exception when there is no serializer for the key' do
       expect {
         Vault::Rails.serializer_for(:not_a_serializer)
-      }.to raise_error(Vault::Rails::UnknownSerializerError) { |e|
-        expect(e.message).to match("Unknown Vault serializer `:not_a_serializer'")
+      }.to raise_error(Vault::Rails::Serializers::UnknownSerializerError) { |e|
+        expect(e.message).to match('Unknown Vault serializer `:not_a_serializer`')
       }
     end
   end