bank_link 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf7f8b590b2742c1ae490a77ad95036bf87eac3a
-  data.tar.gz: e81b6cbbb3aa1389d868076e81f432e0bd8a7528
+  metadata.gz: 6f1f740303014c35a3e0973b7e434e2c014279aa
+  data.tar.gz: 98aa010fd3057255e52dc0a53458063a31e60d52
 SHA512:
-  metadata.gz: 819995ba76040b17c1e8090b40c25704e8bf35d209940c8da6eb8c31c91da9ae142ad7938c82c017dd59d8eb35f302b36ea5994d0fdf1d4479fb3a4be865e857
-  data.tar.gz: e404ddf596bba1842b645592f56f728f404ed92d412f31b1b8c396f31de1cf2042dc5f9fb4967bfea601cafbccb4bf82c19e5b5526b276797d6ec72c4b9a0cf9
+  metadata.gz: 223593b63c1650511b08874da3ed73ceadf58a3850cd9a557b744ebbe9fbafc864c2f7b5126665d352f24f4c6603066f3c3e8b2826e19d33dd21cd0f5b4708a5
+  data.tar.gz: e18324989715dc1bdf7798264e955002ee71aec21f6ac66c12e9003e6a521650f6bd02ed52f59e87c63bfde51eefee58daea527069021a1a7aa55048f3629159

data/README.md

@@ -21,69 +21,108 @@ $ gem install bank_link
 ### Set Up Initializer
 ```ruby
 BankLink.configuration do |config|
-  config.default_encoding = "UTF-8" #used only if link.data.encoding_key is set
-
-  config.links(:name_of_link, "https://url.of.link") do |data, form|
-    form[:VK_SERVICE] = "1001"
-    form[:VK_VERSION] = "008"
-    form[:VK_AMOUNT] = Proc.new { |link, object| object.price }
-    form[:VK_CURR] = "EUR"
-```
-#### Additional Options
-##### Encoding
+```
 ```ruby
-    data.encoding_key = "VK_CHARSET"
-    data.encoding_key = "VK_ENCODING"
-    data.encoding = "UTF-8"
+BankLink do |config|
 ```
-##### Mac
+#### Override mac fields if you so wish
+Defaults can be found in [mac_fields.yml](https://github.com/jhaesus/bank_link/blob/master/mac_fields.yml)
 ```ruby
-    data.mac_class = BankLink::Mac::VK #default
-    data.mac_key = File.read("my/private_key.pem")
-    data.mac_key_passphrase = File.read("my_password")
-    data.algorithm = OpenSSL::Digest::SHA1 #default for VK
-
-    data.mac_class = BankLink::Mac::Solo
-    data.mac_key = File.read("my_key.txt")
-    data.algorithm = OpenSSL::Digest::MD5 #default for Solo
-
+  config.mac_fields do |mac_fields|
+    mac_fields.SOLOPMT_VERSION["0003"] = [
+      :VERSION,
+      :STAMP,
+      :RCV_ID,
+      :AMOUNT,
+      :REF,
+      :DATE,
+      :CUR
+    ]
+  end
+```
+#### Add banks
+```ruby
+  config.banks :name_of_bank do |bank|
+```
+##### Change bank settings
+```ruby
+    bank.settings do |settings|
+```
+###### Encoding
+```ruby
+      settings.encoding_key = "VK_CHARSET"
+      settings.encoding = "UTF-8"
+```
+###### Private/Public keys and passphrases
+```ruby
+      settings.private_key = File.read("my/private_key.pem")
+      settings.private_key_passphrase = File.read("my_password")
+      settings.public_key = File.read("bank/certificate")
+```
+###### Mac calculation settings
+```ruby
+      settings.mac_class = BankLink::Mac::VK
+      settings.digest = OpenSSL::Digest::SHA1
 
+      settings.mac_class = BankLink::Mac::Solo
+      settings.digest = OpenSSL::Digest::MD5
 
-    data.mac_class = BankLink::Mac::Custom
+      settings.mac_class = BankLink::Mac::Custom #Or roll your own
+    end
+```
+##### Add link(s)
+All the correct form fields can be found in various bank documentations, [listed below](https://github.com/jhaesus/bank_link/edit/master/README.md#additional-info). "Have fun"
+```ruby
+    bank.payment_link "https://url.of.link" do |form|
+      form[:VK_SERVICE] = "1001"
+      form[:VK_VERSION] = "008"
+      form[:VK_AMOUNT] = Proc.new { |link, object| object.price }
+      form[:VK_CURR] = "EUR"
+    end
+    bank.authorization_link "https://url.of.link/auth" do |form|
+      form[:VK_SERVICE] = "1001"
+      form[:VK_VERSION] = "008"
+    end
 ```
 ### View Helper
 ```haml
-= bank_links @object do |link|
-  = submit_tag(link.name)
+= payment_links @object do |link|
+  = submit_tag(link.bank.name)
 ```
 ```haml
-- BankLink.each do |link|
+- BankLink.payment_links do |link|
   = bank_link_tag link, @object do
-    = submit_tag(link.name)
+    = submit_tag(link.bank.name)
 ```
-#### Additional Options
-##### Override/Set Form Values
+#### Override/Set Form Values
 ```haml
-- BankLink.each do |link|
+- payment_links @object, { :values => { :VK_AMOUNT => Proc.new { |link, object| object.price * 2 } }} do |link|
+  = submit_tag
+```
+```haml
+- BankLink.payment_links do |link|
   = bank_link_tag link, @object, { :values => {:VK_AMOUNT => @object.price }} do
     = submit_tag
 ```
-##### Override/Set Form Attributes
+#### Override/Set Form Attributes
 ```haml
-- BankLink.each do |link|
+- payment_links @object, { :form => { :data => { :something => "other" } } } do |link|
+  = submit_tag
+```
+```haml
+- BankLink.payment_links do |link|
   = bank_link_tag link, @object, { :form => {:method => :get }} do
     = submit_tag
 ```
-
-#### Verifying Responses
+### Verifying Responses
 ```ruby
-  link = BankLink.configuration.links.name_of_link
+  link = BankLink.configuration.banks.name_of_link
   link.verify params
 ```
 
-### Additional Info
+## Additional Info
 [Pangalink.net](https://pangalink.net/info)
-#### Documentations
+### Documentations
 - [Danske Bank Documentation](http://www.danskebank.ee/et/14732.html)
 - [Krediidipank Documentation](http://www.krediidipank.ee/business/settlements/bank-link/tehniline_kirjeldus.pdf)
 - [LHV Documentation](http://www.lhv.ee/images/docs/Bank_Link_Technical_Specification-ET.pdf)

data/bank_link.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "hashie"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2"

data/lib/bank_link/bank.rb

@@ -0,0 +1,28 @@
+require "bank_link/link"
+
+module BankLink
+  class Bank
+    attr_accessor :name, :settings, :payment_link, :authorization_link
+
+    def initialize name, &block
+      self.name = name
+      self.settings = Hashie::Mash.new(
+        :mac_class => Mac::VK,
+        :digest => OpenSSL::Digest::SHA1
+      )
+      yield(self) if block_given?
+    end
+
+    def settings &block
+      block_given? ? yield(@settings) : @settings
+    end
+
+    def payment_link url=nil, &block
+      url ? (@payment_link = Link.new(self, url, &block)) : @payment_link
+    end
+
+    def authorization_link url=nil, &block
+      url ? (@authorization_link = Link.new(self, url, &block)) : @authorization_link
+    end
+  end
+end

data/lib/bank_link/configuration.rb

@@ -1,92 +1,44 @@
-require "bank_link/estruct"
-require "bank_link/link"
+require "bank_link/bank"
 require "singleton"
 
 module BankLink
   class Configuration
     include Singleton
 
-    attr_accessor :links, :mac_fields, :default_encoding
+    attr_accessor :banks, :mac_fields, :default_encoding
 
-    def links name=nil, url=nil, &block
-      if name && url
-        links[name] = Link.new(name, url, &block)
+    def banks name=nil, &block
+      if name && block_given?
+        @banks[name] = Bank.new(name, &block)
+      elsif name
+        @banks[name]
       else
-        @links ||= EStruct.new
+        @banks
       end
     end
 
-    def each &block
-      links.marshal_dump.each_value(&block)
+    def authorization_links &block
+      each_link :authorization_link, &block
+    end
+
+    def payment_links &block
+      each_link :payment_link, &block
     end
 
     def mac_fields &block
-      block_given? ? yield(mac_fields) : (@mac_fields ||= EStruct.new)
+      block_given? ? yield(mac_fields) : (@mac_fields ||= Hashie::Mash.new)
     end
 
     def initialize
-      mac_fields do |ml|
-        ml.VK_SERVICE = EStruct.new(
-          "1001" => [
-            :VK_SERVICE,
-            :VK_VERSION,
-            :VK_SND_ID,
-            :VK_STAMP,
-            :VK_AMOUNT,
-            :VK_CURR,
-            :VK_ACC,
-            :VK_NAME,
-            :VK_REF,
-            :VK_MSG
-          ],
-          "1101" => [
-            :VK_SERVICE,
-            :VK_VERSION,
-            :VK_SND_ID,
-            :VK_REC_ID,
-            :VK_STAMP,
-            :VK_T_NO,
-            :VK_AMOUNT,
-            :VK_CURR,
-            :VK_REC_ACC,
-            :VK_REC_NAME,
-            :VK_SND_ACC,
-            :VK_SND_NAME,
-            :VK_REF,
-            :VK_MSG,
-            :VK_T_DATE
-          ],
-          "1901" => [
-            :VK_SERVICE,
-            :VK_VERSION,
-            :VK_SND_ID,
-            :VK_REC_ID,
-            :VK_STAMP,
-            :VK_REF,
-            :VK_MSG
-          ]
-        )
-        ml.SOLOPMT_VERSION = EStruct.new(
-          "0003" => [
-            :SOLOPMT_VERSION,
-            :SOLOPMT_STAMP,
-            :SOLOPMT_RCV_ID,
-            :SOLOPMT_AMOUNT,
-            :SOLOPMT_REF,
-            :SOLOPMT_DATE,
-            :SOLOPMT_CUR
-          ],
-          "0002" => [
-            :SOLOPMT_VERSION,
-            :SOLOPMT_STAMP,
-            :SOLOPMT_RCV_ID,
-            :SOLOPMT_AMOUNT,
-            :SOLOPMT_REF,
-            :SOLOPMT_DATE,
-            :SOLOPMT_CUR
-          ]
-        )
+      file_data = YAML.load(File.read(File.dirname(__FILE__) + "/../../mac_fields.yml"))
+      file_data.each do |type, versions|
+        mac_fields { |mf| mf[type] = Hashie::Mash.new(versions) }
       end
+      @banks ||= Hashie::Mash.new
+    end
+
+    def each_link type, &block
+      banks.collect { |name, bank| bank.method(type).call() }.compact.each(&block)
     end
   end
-end
+end

data/lib/bank_link/link.rb

@@ -1,40 +1,47 @@
-require "bank_link/estruct"
-require "bank_link/mac"
-
 module BankLink
   class Link
-    attr_accessor :name, :url, :data, :form
+    attr_accessor :bank, :url, :form
 
-    def initialize name, url, &block
-      self.name = name
+    def initialize bank, url, &block
+      self.bank = bank
       self.url = url
-      self.data = EStruct.new(
-        :mac_class => Mac::VK,
-        :encoding => BankLink.configuration.default_encoding
-      )
-      self.form = EStruct.new
-      yield(data, form) if block_given?
+      self.form = Hashie::Mash.new
+      yield(form) if block_given?
+    end
+
+    def settings *args, &block
+      bank.settings *args, &block
     end
 
     def processed_data object, overrides={}
-      content = EStruct.new(form.marshal_dump.merge(overrides))
+      content = Hashie::Mash.new(form.merge(overrides))
+      apply_encoding content
+      calculate_keys content, object
+      calculate_mac content
+      content
+    end
 
+    def verify params
+      content = Hashie::Mash.new(params)
+      mac = settings.mac_class.new(self, content)
+      version = params[mac.query_key]
+      mac.verify version, params[mac.key]
+    end
+
+    def calculate_keys content, object
       content.each do |key, value|
         content[key] = content[key].call(self, object) if content[key].is_a?(Proc)
       end
+    end
 
-      content[data.encoding_key] = data.encoding if data.encoding && data.encoding_key
+    def apply_encoding content
+      content[settings.encoding_key] = settings.encoding if settings.encoding && settings.encoding_key
+    end
 
-      mac = data.mac_class.new(self, content)
+    def calculate_mac content
+      mac = settings.mac_class.new(self, content)
       content[mac.key] = mac.generate
-      content
     end
 
-    def verify params
-      content = EStruct.new(params)
-      mac = data.mac_class.new(self, content)
-      version = params[mac.query_key]
-      mac.verify version, params[mac.key]
-    end
   end
-end
+end

data/lib/bank_link/mac/base.rb

@@ -3,16 +3,8 @@ module BankLink
     class Base
       attr_accessor :link, :data
 
-      def self.query_key
-        raise NotImplementedError
-      end
-
-      def self.key
-        raise NotImplementedError
-      end
-
-      def self.default_algorithm
-        raise NotImplementedError
+      def settings *args, &block
+        link.settings *args, &block
       end
 
       def initialize link, data
@@ -20,30 +12,25 @@ module BankLink
         self.data = data
       end
 
-      def generate
+      def generate *args
         raise NotImplementedError
       end
 
-      def verify version, mac
-        public_key = OpenSSL::X509::Certificate.new(link.data.public_key).public_key
-        public_key.verify algorithm.new, Base64.strict_decode64(mac), request_data(version)
+      def key *args
+        raise NotImplementedError
       end
 
-      def key
-        self.class.key
+      def query_key *args
+        raise NotImplementedError
       end
 
-      def query_key
-        self.class.query_key
+      def verify *args
+        raise NotImplementedError
       end
 
-      def order version
+      def keys version
         BankLink.configuration.mac_fields[query_key][version.intern]
       end
-
-      def algorithm
-        link.data.algorithm || self.class.default_algorithm
-      end
     end
   end
 end

data/lib/bank_link/mac/solo.rb

@@ -1,30 +1,25 @@
 require "bank_link/mac/base"
-require "openssl"
 
 module BankLink
   module Mac
     class Solo < BankLink::Mac::Base
-      def self.query_key
+      def query_key
         :SOLOPMT_VERSION
       end
 
-      def self.key
+      def key
         :SOLOPMT_MAC
       end
 
-      def self.default_algorithm
-        OpenSSL::Digest::MD5
-      end
-
       def generate version=data[query_key]
-        algorithm.hexdigest(request_data(version).join).upcase
+        settings.digest.hexdigest(request_data(version).join).upcase
       end
 
       private
       def request_data version
-        order(version).collect { |key_name|
+        keys(version).collect { |key_name|
           field_for data[key_name].to_s
-        } + [field_for(link.data.mac_key)]
+        } + [field_for(settings.private_key)]
       end
 
       def field_for value

data/lib/bank_link/mac/vk.rb

@@ -6,27 +6,29 @@ require "base64"
 module BankLink
   module Mac
     class VK < BankLink::Mac::Base
-      def self.query_key
+      def query_key
         :VK_SERVICE
       end
 
-      def self.key
+      def key
         :VK_MAC
       end
 
-      def self.default_algorithm
-        OpenSSL::Digest::SHA1
-      end
-
       def generate version=data[query_key]
         Base64.strict_encode64(
-          algorithm_key.sign(algorithm.new, request_data(version))
+          private_key.sign(settings.digest.new, request_data(version))
         )
       end
 
+      def verify version, mac
+        public_key = OpenSSL::X509::Certificate.new(settings.public_key).public_key
+        public_key.verify settings.digest.new, Base64.strict_decode64(mac), request_data(version)
+      end
+
       private
-      def algorithm_key
-        OpenSSL::PKey::RSA.new(link.data.mac_key, link.data.mac_key_passphrase)
+
+      def private_key
+        OpenSSL::PKey::RSA.new(settings.private_key, settings.private_key_passphrase)
       end
 
       def field_for value
@@ -34,7 +36,7 @@ module BankLink
       end
 
       def request_data version
-        order(version).collect { |key_name|
+        keys(version).collect { |key_name|
           field_for data[key_name].to_s
         }.flatten.join
       end

data/lib/bank_link/version.rb

@@ -1,3 +1,3 @@
 module BankLink
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/bank_link/view_helpers.rb

@@ -1,19 +1,8 @@
-require "bank_link/estruct"
-
 module BankLink
   module ViewHelpers
     def bank_link_tag link, object=nil, options={}, &block
-      form_data = BankLink::EStruct.new(link.processed_data(object, options[:values] || {}))
-
-      form_options = { :action => link.url, :method => :post }
-
-      if encoding_key = link.data.encoding_key
-        if encoding = form_data[link.data.encoding_key]
-          form_options[:"accept-charset"] = encoding
-        end
-      end
-
-      form_options.merge!(options[:form] || {})
+      form_data = Hashie::Mash.new(link.processed_data(object, options[:values] || {}))
+      form_options = bank_link_form_options link, form_data, options
 
       content_tag(:form, form_options) do
         form_data.each do |key, value|
@@ -23,12 +12,36 @@ module BankLink
       end
     end
 
-    def bank_links object=nil, options={}, &block
+    def authorization_links object=nil, options={}, &block
+      content_tag(:div, (options[:container] || {})) do
+        BankLink.authorization_links do |link|
+          concat(bank_link_tag(link, object, options, &block))
+        end
+      end
+    end
+
+    def payment_links object=nil, options={}, &block
       content_tag(:div, (options[:container] || {})) do
-        BankLink.each do |link|
+        BankLink.payment_links do |link|
           concat(bank_link_tag(link, object, options, &block))
         end
       end
     end
+
+    private
+
+    def bank_link_form_options link, form_data, options={}
+      form_options = { :action => link.url, :method => :post }
+
+      if encoding_key = link.settings.encoding_key
+        if encoding = form_data[link.settings.encoding_key]
+          form_options[:"accept-charset"] = encoding
+        end
+      end
+
+      form_options.merge!(options[:form] || {})
+
+      form_options
+    end
   end
-end
+end

data/lib/bank_link.rb

@@ -1,5 +1,9 @@
 require "bank_link/version"
 require "bank_link/configuration"
+require "bank_link/mac"
+
+require "hashie"
+
 begin
   require "rails/all"
 rescue LoadError
@@ -13,8 +17,16 @@ module BankLink
       block_given? ? yield(configuration) : (@configuration ||= Configuration.instance)
     end
 
-    def each &block
-      configuration.each(&block)
+    def payment_links *args, &block
+      configuration.payment_links(*args, &block)
+    end
+
+    def authorization_links *args, &block
+      configuration.authorization_links(*args, &block)
     end
   end
 end
+
+def BankLink &block
+  ::BankLink.configuration(&block)
+end