ofx-data 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155da44fb8b964ef9362d6c5f5964a740aefbc7f
-  data.tar.gz: 90aaee4334f3e503ce94e97d22b99f55d6bbba7f
+  metadata.gz: d49bd2a900b068d029a4bae1e934a2e416776a40
+  data.tar.gz: d40240302747bef7b6316ff106e017a7a18b9d82
 SHA512:
-  metadata.gz: 3d15ccf1823d3837a7b5df69531c4c653c6694f6d48ae12a4166dd2e04b035e61cbd7805acf476971e40070321ca4741db1c68c9485377ebb7936740ad1e4e48
-  data.tar.gz: 35593573c42cb4807033a57482c94e6f5cd82a4cb4380f474d8b3895db7afcf1e737fe4f8208bd465bac6a5a9a89dc566d58474beadd272b5b2c93dacc588f64
+  metadata.gz: 8bedff47358dce38eff3c351ab5b64402270cd18b3e4f55dcdc7c026679ebba9c059ad7d85d8cd425228dde9c63a7af8b25eb9edbd291f2139f141e699e1224f
+  data.tar.gz: 9ac7297a6108ad4267199a0a2100dafa2fa4e3c596ed6241d0ad6a5eda33ebda10d28b28548bcc54243ddbc9b687f1d3f53d4071d0a4907c4d086200a6808fca

data/lib/ofx/data.rb

@@ -1,9 +1,7 @@
 require "ofx/data/version"
 require "ofx/data/objects"
-require "ofx/data/serialization"
 
 module OFX
   module Data
-    # Your code goes here...
   end
 end

data/lib/ofx/data/document.rb

@@ -6,7 +6,7 @@ module OFX
       attr_reader :message_sets, :declaration
 
       def initialize(opts = {})
-        @message_sets = opts.fetch(:message_sets, []).freeze
+        @message_sets = opts.fetch(:message_sets)
         @declaration = opts.fetch(:declaration, Declaration.default)
       end
 

data/lib/ofx/data/message_sets.rb

@@ -0,0 +1,33 @@
+require "ofx/data/message_sets/signon"
+require "ofx/data/message_sets/banking"
+
+module OFX
+  module Data
+    class MessageSets
+      ORDER = [
+        :signon, :signup, :banking, :credit_card_statements,
+        :investment_statements, :interbank_funds_transfers,
+        :wire_funds_transfers, :payments, :general_email,
+        :investment_security_list, :biller_directory,
+        :bill_delivery, :fi_profile
+      ]
+      ORDER_LOOKUP = Hash[ORDER.each_with_index.map { |k, v| [k, v] }]
+
+      def initialize(message_sets)
+        @message_sets = message_sets
+      end
+
+      def ofx_type
+        :message_sets
+      end
+
+      def ordered_sets
+        @message_sets.sort_by { |set| ORDER_LOOKUP[set.message_set_type] }
+      end
+
+      def each(&block)
+        ordered_sets.each(&block)
+      end
+    end
+  end
+end

data/lib/ofx/data/{message_set → message_sets}/banking.rb

@@ -1,6 +1,6 @@
 module OFX
   module Data
-    module MessageSet
+    class MessageSets
       module Banking
         MESSAGE_SET_TYPE = :banking
 

data/lib/ofx/data/{message_set → message_sets}/signon.rb

@@ -1,6 +1,6 @@
 module OFX
   module Data
-    module MessageSet
+    class MessageSets
       module Signon
         MESSAGE_SET_TYPE = :signon
 
@@ -11,9 +11,19 @@ module OFX
         end
 
         class Response
+          attr_reader :message
+
+          def initialize(message)
+            @message = message
+          end
+
           def message_set_type
             MESSAGE_SET_TYPE
           end
+
+          def ofx_type
+            :"message_sets.signon.response"
+          end
         end
       end
     end

data/lib/ofx/data/objects.rb

@@ -1,5 +1,5 @@
 require "ofx/data/document"
 require "ofx/data/transaction/status"
-require "ofx/data/message_set"
+require "ofx/data/message_sets"
 require "ofx/data/banking"
 

data/lib/ofx/data/serialization.rb

@@ -1,18 +1,11 @@
-require "builder"
-require "ofx/data/serialization/registry"
 require "ofx/data/serialization/document"
-require "ofx/data/serialization/message_set"
+require "ofx/data/serialization/message_sets"
 require "ofx/data/serialization/banking"
 require "ofx/data/serialization/transaction/status"
 
 module OFX
   module Data
     module Serialization
-      def self.serialize(object)
-        xml = Builder::XmlMarkup.new
-        registry.serializer_for(object).serialize(object, xml)
-        xml.target!
-      end
     end
   end
 end

data/lib/ofx/data/serialization/banking/balance.rb

@@ -1,4 +1,3 @@
-require "ofx/data/serialization"
 require "ofx/data/serialization/common"
 
 module OFX
@@ -6,16 +5,18 @@ module OFX
     module Serialization
       module Banking
         class Balance
-          extend Serialization::Common
+          include Serialization::Common
 
-          def self.serialize(balance, builder)
+          def default_registry_entry_args
+            [:"banking.balance", nil]
+          end
+
+          def serialize(balance, builder)
             builder.BALAMT balance.amount.to_s("F")
             builder.DTASOF balance.date.strftime("%Y%m%d%H%M%S")
           end
         end
       end
-
-      register Banking::Balance, :"banking.balance"
     end
   end
 end

data/lib/ofx/data/serialization/banking/bank_account.rb

@@ -1,4 +1,3 @@
-require "ofx/data/serialization"
 require "ofx/data/serialization/common"
 
 module OFX
@@ -6,7 +5,6 @@ module OFX
     module Serialization
       module Banking
         class BankAccount
-          extend Serialization::Common
           ACCT_TYPES = {
             checking: "CHECKING".freeze,
             savings: "SAVINGS".freeze,
@@ -14,7 +12,13 @@ module OFX
             credit_line: "CREDITLINE"
           }
 
-          def self.serialize(bank_account, builder)
+          include Serialization::Common
+
+          def default_registry_entry_args
+            [:"banking.bank_account", nil]
+          end
+
+          def serialize(bank_account, builder)
             builder.BANKID bank_account.bank_id
             if bank_account.branch_id != ""
               builder.BRANCHID bank_account.branch_id
@@ -26,13 +30,11 @@ module OFX
             end
           end
 
-          def self.acct_type(type)
+          def acct_type(type)
             ACCT_TYPES.fetch(type)
           end
         end
       end
-
-      register Banking::BankAccount, :"banking.bank_account"
     end
   end
 end

data/lib/ofx/data/serialization/banking/statement/response.rb

@@ -1,4 +1,3 @@
-require "ofx/data/serialization"
 require "ofx/data/serialization/common"
 
 module OFX
@@ -7,9 +6,13 @@ module OFX
       module Banking
         module Statement
           class Response
-            extend Serialization::Common
+            include Serialization::Common
 
-            def self.serialize(response, builder)
+            def default_registry_entry_args
+              [:"banking.statement.response", nil]
+            end
+
+            def serialize(response, builder)
               builder.STMTRS do |builder|
                 builder.CURDEF response.curdef.to_s.upcase
                 builder.BANKACCTFROM do |builder|
@@ -31,8 +34,6 @@ module OFX
           end
         end
       end
-
-      register Banking::Statement::Response, :"banking.statement.response"
     end
   end
 end

data/lib/ofx/data/serialization/banking/statement/transaction.rb

@@ -1,4 +1,3 @@
-require "ofx/data/serialization"
 require "ofx/data/serialization/common"
 
 module OFX
@@ -8,24 +7,26 @@ module OFX
         module Statement
           module Transaction
             class Response
-              extend Common
+              include Common
 
-              def self.serialize(transaction, builder)
+              def default_registry_entry_args
+                [:"banking.statement.transaction.response", nil]
+              end
+
+              def serialize(transaction, builder)
                 builder.STMTTRNRS do |builder|
                   builder.TRNUID transaction.trnuid
                   serialize_collection(children(transaction), builder)
                 end
               end
 
-              def self.children(transaction)
+              def children(transaction)
                 [transaction.status, transaction.response]
               end
             end
           end
         end
       end
-
-      register Banking::Statement::Transaction::Response, :"banking.statement.transaction.response"
     end
   end
 end

data/lib/ofx/data/serialization/banking/transaction.rb

@@ -1,4 +1,3 @@
-require "ofx/data/serialization"
 require "ofx/data/serialization/common"
 
 module OFX
@@ -6,9 +5,14 @@ module OFX
     module Serialization
       module Banking
         class Transaction
-          extend Serialization::Common
+          include Serialization::Common
 
-          def self.serialize(transaction, builder)
+          def default_registry_entry_args
+            [:"banking.statement_transaction", nil]
+          end
+
+
+          def serialize(transaction, builder)
             builder.STMTTRN do |builder|
               builder.TRNTYPE transaction.type.to_s.upcase
               builder.DTPOSTED transaction.date_posted.strftime("%Y%m%d%H%M%S")
@@ -21,8 +25,6 @@ module OFX
           end
         end
       end
-
-      register Banking::Transaction, :"banking.statement_transaction"
     end
   end
 end

data/lib/ofx/data/serialization/common.rb

@@ -1,9 +1,37 @@
+require "ofx/data/serialization/registry"
+
 module OFX
   module Data
     module Serialization
       module Common
+        module ClassMethods
+          def register_with(registry)
+            serializer = new(registry)
+            registry.register(serializer.registry_entry)
+          end
+        end
+
+        def self.included(base)
+          base.extend ClassMethods
+          base.class_eval do
+            attr_reader :registry
+          end
+        end
+
+        def initialize(registry)
+          @registry = registry
+        end
+
+        def default_registry_entry_args
+          raise NotImplementedError, "must be implemented in includer"
+        end
+
+        def registry_entry
+          Registry::Entry.new(self, *default_registry_entry_args)
+        end
+
         def serialize_object(object, builder)
-          registry.serializer_for(object).serialize(object, builder)
+          registry.serializer_for(object.ofx_type).serialize(object, builder)
         end
 
         def serialize_collection(collection, builder)
@@ -11,10 +39,6 @@ module OFX
             serialize_object(object, builder)
           end
         end
-
-        def registry
-          OFX::Data::Serialization.registry
-        end
       end
     end
   end

data/lib/ofx/data/serialization/document.rb

@@ -5,9 +5,28 @@ module OFX
   module Data
     module Serialization
       class Document
-        extend Common
+        include Common
 
-        def self.serialize(document, builder)
+        def self.register_with(registry)
+          serializer = new(registry)
+          registry.register(serializer.registry_entry)
+        end
+
+        attr_reader :registry
+
+        def initialize(registry)
+          @registry = registry
+        end
+
+        def default_registry_entry_args
+          [:document, nil]
+        end
+
+        def registry_entry
+          Registry::Entry.new(self, *default_registry_entry_args)
+        end
+
+        def serialize(document, builder)
           decl = document.declaration
           builder.instruct!
           builder.instruct!(:OFX, {
@@ -18,12 +37,10 @@ module OFX
             NEWFILEUID: decl.newfileuid
           })
           builder.OFX do |builder|
-            MessageSet.serialize(document.message_sets, builder)
+            serialize_object(document.message_sets, builder)
           end
         end
       end
-
-      register(Document, :document)
     end
   end
 end

data/lib/ofx/data/serialization/message_sets.rb

@@ -0,0 +1,21 @@
+require "ofx/data/serialization/common"
+require "ofx/data/serialization/message_sets/banking"
+require "ofx/data/serialization/message_sets/signon"
+
+module OFX
+  module Data
+    module Serialization
+      class MessageSets
+        include Common
+
+        def default_registry_entry_args
+          [:message_sets, nil]
+        end
+
+        def serialize(message_sets, builder)
+          serialize_collection(message_sets, builder)
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/serialization/{message_set → message_sets}/banking.rb

@@ -4,15 +4,19 @@ require "ofx/data/serialization/common"
 module OFX
   module Data
     module Serialization
-      module MessageSet
+      class MessageSets
         module Banking
           class Request
           end
 
           class Response
-            extend Serialization::Common
+            include Serialization::Common
 
-            def self.serialize(message_set, builder)
+            def default_registry_entry_args
+              [:"message_sets.banking.response", nil]
+            end
+
+            def serialize(message_set, builder)
               builder.BANKMSGSRSV1 do |builder|
                 serialize_collection(message_set.messages, builder)
               end
@@ -20,8 +24,6 @@ module OFX
           end
         end
       end
-
-      register MessageSet::Banking::Response, :"message_sets.banking.response"
     end
   end
 end

data/lib/ofx/data/serialization/message_sets/signon.rb

@@ -0,0 +1,29 @@
+require "ofx/data/serialization"
+require "ofx/data/serialization/common"
+
+module OFX
+  module Data
+    module Serialization
+      class MessageSets
+        module Signon
+          class Request
+          end
+
+          class Response
+            include Serialization::Common
+
+            def default_registry_entry_args
+              [:"message_sets.signon.response", nil]
+            end
+
+            def serialize(message, builder)
+              builder.SIGNONMSGSRSV1 do |builder|
+                serialize_object(message.message, builder)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/serialization/ofx203.rb

@@ -0,0 +1,37 @@
+require "builder"
+require "ofx/data/serialization/registry"
+require "ofx/data/serialization"
+
+module OFX
+  module Data
+    module Serialization
+      module OFX203
+        SERIALIZER_CLASSES = [
+          Document, Transaction::Status,
+          MessageSets, MessageSets::Banking,
+          Banking::Balance, Banking::BankAccount,
+          Banking::Transaction, Banking::Statement::Response,
+          Banking::Statement::Transaction
+        ]
+
+        def self.registry
+          Registry.build { |r|
+            SERIALIZER_CLASSES.each do |klass|
+              klass.register_with(r)
+            end
+          }
+        end
+
+        def self.builder
+          Builder::XmlMarkup.new
+        end
+
+        def self.serialize(object)
+          output = builder
+          registry.serializer_for(object.ofx_type).serialize(object, output)
+          output.target!
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/serialization/registry.rb

@@ -1,30 +1,42 @@
+require "ofx/data/serialization/registry/entry"
+
 module OFX
   module Data
     module Serialization
       class Registry
-        def initialize
-          @registry = {}
+        def self.build(&block)
+          registry = new
+          block.call(registry)
+          registry
         end
 
-        def register(serialization_class, ofx_type)
-          @registry[ofx_type] = serialization_class
+        attr_reader :entries
+
+        def initialize
+          @entries = []
         end
 
-        def serializer_for(data_instance)
-          @registry.fetch(data_instance.ofx_type)
+        def register(entry)
+          entries << entry
         end
 
-        def registered_for(serialization_class)
-          @registry.find(->() { [] }) { |ofx_type, klass| klass == serialization_class }.first
+        def matching_entry(ofx_type, context_name)
+          match = entries.find { |entry| entry.match?(ofx_type, context_name) }
+          raise SerializerNotFoundError.generate(ofx_type, context_name) if match.nil?
+          match
         end
-      end
 
-      def self.registry
-        @registry ||= OFX::Data::Serialization::Registry.new
+        def serializer_for(ofx_type, context_name = nil)
+          matching_entry(ofx_type, context_name).serializer
+        end
       end
 
-      def self.register(*args)
-        registry.register(*args)
+      class SerializerNotFoundError < StandardError
+        def self.generate(ofx_type, context_name)
+          message = "Cannot find serializer for OFX type #{ofx_type.inspect}"
+          message << " with context name #{context_name.inspect}" if context_name
+          new(message)
+        end
       end
     end
   end

data/lib/ofx/data/serialization/registry/entry.rb

@@ -0,0 +1,21 @@
+module OFX
+  module Data
+    module Serialization
+      class Registry
+        class Entry
+          attr_reader :serializer, :ofx_type, :context_name
+
+          def initialize(serializer, ofx_type, context_name = nil)
+            @serializer = serializer
+            @ofx_type = ofx_type
+            @context_name = context_name
+          end
+
+          def match?(ofx_type, context_name = nil)
+            self.ofx_type == ofx_type && self.context_name == context_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/serialization/signon/response.rb

@@ -0,0 +1,25 @@
+require "ofx/data/serialization/common"
+
+module OFX
+  module Data
+    module Serialization
+      module Signon
+        class Response
+          include Serialization::Common
+
+          def default_registry_entry_args
+            [:"signon.response", nil]
+          end
+
+          def serialize(response, builder)
+            builder.SONRS do |builder|
+              serialize_object(response.status, builder)
+              builder.DTSERVER response.dtserver.strftime("%Y%m%d%H%M%S")
+              builder.LANGUAGE response.language.to_s.upcase
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/serialization/transaction/status.rb

@@ -6,9 +6,13 @@ module OFX
     module Serialization
       module Transaction
         class Status
-          extend Serialization::Common
+          include Serialization::Common
 
-          def self.serialize(status, builder)
+          def default_registry_entry_args
+            [:"transaction.status", nil]
+          end
+
+          def serialize(status, builder)
             builder.STATUS do |builder|
               builder.CODE status.code
               builder.SEVERITY status.severity.to_s.upcase
@@ -19,8 +23,6 @@ module OFX
           end
         end
       end
-
-      register Transaction::Status, :"transaction.status"
     end
   end
 end

data/lib/ofx/data/signon.rb

@@ -0,0 +1 @@
+require "ofx/data/signon/response"

data/lib/ofx/data/signon/response.rb

@@ -0,0 +1,19 @@
+module OFX
+  module Data
+    module Signon
+      class Response
+        attr_reader :status, :dtserver, :language
+
+        def initialize(opts)
+          @status = opts.fetch(:status)
+          @dtserver = opts.fetch(:dtserver)
+          @language = opts.fetch(:language)
+        end
+
+        def ofx_type
+          :"signon.response"
+        end
+      end
+    end
+  end
+end

data/lib/ofx/data/version.rb

@@ -1,5 +1,5 @@
 module OFX
   module Data
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: ofx-data
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Matt Patterson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 description: |
@@ -90,8 +90,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -110,9 +110,9 @@ files:
 - lib/ofx/data/banking/transaction.rb
 - lib/ofx/data/declaration.rb
 - lib/ofx/data/document.rb
-- lib/ofx/data/message_set.rb
-- lib/ofx/data/message_set/banking.rb
-- lib/ofx/data/message_set/signon.rb
+- lib/ofx/data/message_sets.rb
+- lib/ofx/data/message_sets/banking.rb
+- lib/ofx/data/message_sets/signon.rb
 - lib/ofx/data/objects.rb
 - lib/ofx/data/serialization.rb
 - lib/ofx/data/serialization/banking.rb
@@ -124,10 +124,16 @@ files:
 - lib/ofx/data/serialization/banking/transaction.rb
 - lib/ofx/data/serialization/common.rb
 - lib/ofx/data/serialization/document.rb
-- lib/ofx/data/serialization/message_set.rb
-- lib/ofx/data/serialization/message_set/banking.rb
+- lib/ofx/data/serialization/message_sets.rb
+- lib/ofx/data/serialization/message_sets/banking.rb
+- lib/ofx/data/serialization/message_sets/signon.rb
+- lib/ofx/data/serialization/ofx203.rb
 - lib/ofx/data/serialization/registry.rb
+- lib/ofx/data/serialization/registry/entry.rb
+- lib/ofx/data/serialization/signon/response.rb
 - lib/ofx/data/serialization/transaction/status.rb
+- lib/ofx/data/signon.rb
+- lib/ofx/data/signon/response.rb
 - lib/ofx/data/transaction/status.rb
 - lib/ofx/data/version.rb
 - ofx-data.gemspec
@@ -141,17 +147,17 @@ 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.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generate OFX XML documents

data/lib/ofx/data/message_set.rb

@@ -1,2 +0,0 @@
-require "ofx/data/message_set/signon"
-require "ofx/data/message_set/banking"

data/lib/ofx/data/serialization/message_set.rb

@@ -1,32 +0,0 @@
-require "ofx/data/serialization"
-require "ofx/data/serialization/common"
-require "ofx/data/serialization/message_set/banking"
-
-module OFX
-  module Data
-    module Serialization
-      module MessageSet
-        extend Common
-
-        ORDER = [
-          :signon, :signup, :banking, :credit_card_statements,
-          :investment_statements, :interbank_funds_transfers,
-          :wire_funds_transfers, :payments, :general_email,
-          :investment_security_list, :biller_directory,
-          :bill_delivery, :fi_profile
-        ]
-        ORDER_LOOKUP = Hash[ORDER.each_with_index.map { |k, v| [k, v] }]
-
-        def self.order_sets(message_sets)
-          message_sets.sort_by { |set| ORDER_LOOKUP[set.message_set_type] }
-        end
-
-        def self.serialize(message_sets, builder)
-          serialize_collection(order_sets(message_sets), builder)
-        end
-      end
-
-      register(MessageSet, :message_sets)
-    end
-  end
-end