wire_client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe3d4be5caa3ebae64c94b38c977bd67e8abcbbb7d9a46d1de9996b61991471
-  data.tar.gz: 1e55ddca145585809e267c61fc6f489ea0f4b6295832c26d1ec9bb61743f9254
+  metadata.gz: 2e53215215f03709ef8df3daa7fa130af6d57ceefc4c1bcb3aaec38d679ae007
+  data.tar.gz: a68bab84ea944f30839b31773aba3eaccaebea3f529788b40ad77541cd0ebdae
 SHA512:
-  metadata.gz: e177224667d221c78644bddd1184a8f9fdf0684f453afbd6a38ecac79047bd12d1226cca96ed636ba1f86f01cd861cb449f488d46a7e45801356a570b0cab5e5
-  data.tar.gz: 8122ad4427363ad9f8c6a82d82856320cdef75d0043736dab0f93e399b36ed8730363bb0f5fb933d2649325185cf410089b753970da43352bf6b03730d03a3ad
+  metadata.gz: 153180ab9e2aac835e68d27e19b5190de1ed74c250d26a91af34ecff6aedcc5cad605fb33d0e03be4f46a180a39d2281bc49749fe68a899c4e6303cfe16371a5
+  data.tar.gz: f73d31053413ea8188d168fd874ba66a537b8369e30d4c608170fb581cb974893b79301e71b557dd5defdb6120c1d13b1d89ab2ef4d8497ca0dd580a9ae66323

data/lib/wire_client/account/account.rb

@@ -1,9 +1,11 @@
 require_relative '../base/converters'
 require_relative '../base/validators'
+require_relative '../base/account_transaction_helpers'
 
 module WireClient
   class Account
     include ActiveModel::Validations
+    include AccountTransactionHelpers
     extend Converter
 
     attr_accessor :name,
@@ -12,21 +14,25 @@ module WireClient
                   :account_number,
                   :wire_routing_number,
                   :clear_system_code,
+                  :postal_code,
+                  :address_line,
+                  :city,
+                  :country_subdivision,
+                  :country,
+                  :currency,
                   :schema_code,
                   :identifier,
-                  :country,
-                  :country_subdivision,
-                  :charge_bearer,
-                  :currency
+                  :charge_bearer
 
     convert :name, to: :text
+    validates_length_of :currency, is: 3
     validates_length_of :name, within: 1..70
     validates_with CurrencyValidator,
                    CountryValidator,
                    CountrySubdivisionValidator,
-                   CreditorIdentifierValidator,
                    BICValidator,
                    IBANValidator,
+                   CreditorIdentifierValidator,
                    message: "%{value} is invalid"
 
     def initialize(attributes = {})
@@ -35,25 +41,14 @@ module WireClient
       end
 
       @currency ||= 'USD'
+      @postal_code ||= 'NA'
+      @address_line ||= 'NA'
+      @city ||= 'NA'
       @country ||= 'US'
       @country_subdivision ||= 'MA' if self.country == 'US'
       @schema_code ||= 'CUST'
       @clear_system_code ||= 'USABA'
       custom_defaults if self.respond_to? :custom_defaults
     end
-
-    def country_subdivision_abbr
-      if @country == 'US' && !@country_subdivision.match(/\A[A-Z]{2,2}\z/)
-        return US_STATES[@country_subdivision]
-      end
-      @country_subdivision
-    end
-
-    def country_subdivision_name
-      if @country == 'US' && @country_subdivision.match(/\A[A-Z]{2,2}\z/)
-        return US_STATES.key(@country_subdivision)
-      end
-      @country_subdivision
-    end
   end
 end

data/lib/wire_client/base/account_transaction_helpers.rb

@@ -0,0 +1,31 @@
+module WireClient
+  module AccountTransactionHelpers
+    def country_subdivision_abbr
+      return US_STATES[@country_subdivision] if a_full_name_us_state?
+      @country_subdivision
+    end
+
+    def country_subdivision_name
+      return US_STATES.key(@country_subdivision) if an_abbreviated_us_state?
+      @country_subdivision
+    end
+
+    protected
+
+    def within_the_us?
+      @country == 'US'
+    end
+
+    def an_abrreviated_state_name?
+      @country_subdivision.match(/\A[A-Z]{2,2}\z/)
+    end
+
+    def an_abbreviated_us_state?
+      within_the_us? && an_abrreviated_state_name?
+    end
+
+    def a_full_name_us_state?
+      within_the_us? && !an_abrreviated_state_name?
+    end
+  end
+end

data/lib/wire_client/messages/credit_transfer.rb

@@ -29,7 +29,9 @@ module WireClient
         builder.PmtInf do
           builder.PmtInfId(payment_information_identification(group))
           builder.PmtMtd('TRF')
+          builder.BtchBookg(group[:batch_booking])
           builder.NbOfTxs(transactions.length)
+          builder.CtrlSum('%.2f' % amount_total(transactions))
           builder.PmtTpInf do
             builder.InstrPrty(group[:service_priority])
             builder.SvcLvl do
@@ -37,13 +39,10 @@ module WireClient
             end
           end
           builder.ReqdExctnDt(group[:requested_date].iso8601)
-          builder.BtchBookg(group[:batch_booking])
-          builder.CtrlSum('%.2f' % amount_total(transactions))
           builder.Dbtr do
             builder.Nm(account.name)
             builder.PstlAdr do
-              builder.CtrySubDvsn(account.country_subdivision_abbr)
-              builder.Ctry(account.country)
+              entity_address(builder, account)
             end
           end
           builder.DbtrAcct do
@@ -51,7 +50,7 @@ module WireClient
           end
           builder.DbtrAgt do
             builder.FinInstnId do
-              account_agent_id(builder, account)
+              entity_agent_id(builder, account)
               builder.PstlAdr do
                 builder.Ctry(account.country)
               end
@@ -85,7 +84,7 @@ module WireClient
         end
         builder.CdtrAgt do
           builder.FinInstnId do
-            transaction_agent_id(builder, transaction)
+            entity_agent_id(builder, transaction)
             builder.Nm(transaction.agent_name)
             builder.PstlAdr do
               builder.Ctry(transaction.country)
@@ -95,7 +94,7 @@ module WireClient
         builder.Cdtr do
           builder.Nm(transaction.name)
           builder.PstlAdr do
-            builder.Ctry(transaction.country)
+            entity_address(builder, transaction)
           end
         end
         builder.CdtrAcct do

data/lib/wire_client/messages/direct_debit.rb

@@ -56,8 +56,7 @@ module WireClient
           builder.Cdtr do
             builder.Nm(group[:account].name)
             builder.PstlAdr do
-              builder.CtrySubDvsn(account.country_subdivision_name)
-              builder.Ctry(account.country)
+              entity_address(builder, account)
             end
           end
           builder.CdtrAcct do
@@ -65,7 +64,7 @@ module WireClient
           end
           builder.CdtrAgt do
             builder.FinInstnId do
-              account_agent_id(builder, group[:account])
+              entity_agent_id(builder, group[:account])
             end
           end
 
@@ -124,10 +123,10 @@ module WireClient
         end
         builder.DbtrAgt do
           builder.FinInstnId do
-            transaction_agent_id(builder, transaction)
+            entity_agent_id(builder, transaction)
             builder.Nm(transaction.agent_name)
             builder.PstlAdr do
-              builder.Ctry(transaction.country)
+              entity_address(builder, transaction)
             end
           end
         end

data/lib/wire_client/messages/message.rb

@@ -151,15 +151,23 @@ module WireClient
       transaction
     end
 
-    def account_agent_id(builder, account)
-      if account.bic
-        builder.BIC(account.bic)
+    def entity_address(builder, entity)
+      builder.PstCd(entity.postal_code)
+      builder.TwnNm(entity.city)
+      builder.CtrySubDvsn(entity.country_subdivision_abbr)
+      builder.AdrLine(entity.address_line)
+      builder.Ctry(entity.country)
+    end
+
+    def entity_agent_id(builder, entity)
+      if entity.bic
+        builder.BIC(entity.bic)
       else
         builder.ClrSysMmbId do
           builder.ClrSysId do
-            builder.Cd(account.clear_system_code)
+            builder.Cd(entity.clear_system_code)
           end
-          builder.MmbId(account.wire_routing_number)
+          builder.MmbId(entity.wire_routing_number)
         end
       end
     end
@@ -182,19 +190,6 @@ module WireClient
       end
     end
 
-    def transaction_agent_id(builder, transaction)
-      if transaction.bic
-        builder.BIC(transaction.bic)
-      else
-        builder.ClrSysMmbId do
-          builder.ClrSysId do
-            builder.Cd(transaction.clear_system_code)
-          end
-          builder.MmbId(transaction.wire_routing_number)
-        end
-      end
-    end
-
     def transaction_account_id(builder, transaction)
       if transaction.iban
         builder.Id do

data/lib/wire_client/providers/base/wire_batch.rb

@@ -30,14 +30,24 @@ module WireClient
       # @return [String] The initiating party's Identifier
       class_attribute :initiator_identifier
 
-      # @return [String] The initiating party's country (2 character country
-      # code; default: US)
-      class_attribute :initiator_country
+      # @return [String] The initiating party's Postal code (default: NA)
+      class_attribute :initiator_postal_code
+
+      # @return [String] The initiating party's Address line (default: NA)
+      class_attribute :initiator_address_line
+
+      # @return [String] The initiating party's City, town or municipality
+      # (default: NA)
+      class_attribute :initiator_city
 
       # @return [String] The initiating party's country subdivision (name or
       # 2 character code; default: MA)
       class_attribute :initiator_country_subdivision
 
+      # @return [String] The initiating party's country (2 character country
+      # code; default: US)
+      class_attribute :initiator_country
+
       ##
       # @return [Array] A list of arguments to use in the initializer, and as
       # instance attributes
@@ -101,8 +111,11 @@ module WireClient
             bic: self.class.initiator_bic,
             iban: self.class.initiator_iban,
             identifier: self.class.initiator_identifier,
-            country: self.class.initiator_country,
-            country_subdivision: self.class.initiator_country_subdivision
+            postal_code: self.class.initiator_postal_code,
+            address_line: self.class.initiator_address_line,
+            city: self.class.initiator_city,
+            country_subdivision: self.class.initiator_country_subdivision,
+            country: self.class.initiator_country
           )
         else
           @payment_initiation = klass.new(
@@ -110,8 +123,11 @@ module WireClient
             wire_routing_number: self.class.initiator_wire_routing_number,
             account_number: self.class.initiator_account_number,
             identifier: self.class.initiator_identifier,
-            country: self.class.initiator_country,
-            country_subdivision: self.class.initiator_country_subdivision
+            postal_code: self.class.initiator_postal_code,
+            address_line: self.class.initiator_address_line,
+            city: self.class.initiator_city,
+            country_subdivision: self.class.initiator_country_subdivision,
+            country: self.class.initiator_country
           )
         end
       end

data/lib/wire_client/transaction/transaction.rb

@@ -1,6 +1,7 @@
 module WireClient
   class Transaction
     include ActiveModel::Validations
+    include AccountTransactionHelpers
     extend Converter
 
     attr_accessor :name,
@@ -9,8 +10,13 @@ module WireClient
                   :account_number,
                   :wire_routing_number,
                   :clear_system_code,
-                  :agent_name,
+                  :postal_code,
+                  :address_line,
+                  :city,
+                  :country_subdivision,
                   :country,
+                  :currency,
+                  :agent_name,
                   :amount,
                   :instruction,
                   :reference,
@@ -20,14 +26,13 @@ module WireClient
                   :currency,
                   :service_priority,
                   :service_level
+
     convert :name,
             :instruction,
             :reference,
             :remittance_information, to: :text
     convert :amount, to: :decimal
 
-    validates_length_of :name, within: 1..70
-    validates_length_of :currency, is: 3
     validates_length_of :instruction, within: 1..35, allow_nil: true
     validates_length_of :reference, within: 1..35, allow_nil: true
     validates_length_of :remittance_information,
@@ -36,8 +41,11 @@ module WireClient
     validates_numericality_of :amount, greater_than: 0
     validates_presence_of :requested_date
     validates_inclusion_of :batch_booking, :in => [true, false]
+    validates_length_of :currency, is: 3
+    validates_length_of :name, within: 1..70
     validates_with CurrencyValidator,
                    CountryValidator,
+                   CountrySubdivisionValidator,
                    BICValidator,
                    IBANValidator,
                    message: "%{value} is invalid"
@@ -48,7 +56,11 @@ module WireClient
       end
 
       @currency ||= 'USD'
+      @postal_code ||= 'NA'
+      @address_line ||= 'NA'
+      @city ||= 'NA'
       @country ||= 'US'
+      @country_subdivision ||= 'MA' if self.country == 'US'
       @clear_system_code ||= 'USABA'
       @agent_name ||= 'NOTPROVIDED'
       @requested_date ||= default_requested_date

data/lib/wire_client/version.rb

@@ -1,4 +1,4 @@
 module WireClient
   # Increment this when changes are published
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wire_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ewerton Carlos Assis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ach_client
@@ -327,6 +327,7 @@ files:
 - lib/wire_client/account/account.rb
 - lib/wire_client/account/creditor_account.rb
 - lib/wire_client/account/debitor_account.rb
+- lib/wire_client/base/account_transaction_helpers.rb
 - lib/wire_client/base/constants.rb
 - lib/wire_client/base/converters.rb
 - lib/wire_client/base/invalid_wire_transaction_error.rb