securetrading 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79415e27c8e12d4d5c2665453b2b297fb747eaf0
-  data.tar.gz: 7d83ddb86ca77c924e264c7a0ca0b7f65b319c44
+  metadata.gz: fa0b858de02b3d93f7394e6b2b2b86de5bd544c7
+  data.tar.gz: de7c1bc1b95797567c9789ee960af85b7b498cc2
 SHA512:
-  metadata.gz: 6ad10220ac03be131c8b22fc5378ffadaa1c320097a7d25b54dc1943935b428d77678eeef6756fe803382626902c9d2e109f9d26620017cfa4b5cabd2fd0333c
-  data.tar.gz: 1c817f6c672cfde5c01e7afe71c2409cb50751a2bc4d8decc25eecdb89e505064ddc85a770256fc0e28b5585df57c5e04ae337973d2bc378d994286ae6bc5923
+  metadata.gz: 6b8441e9c2d9edfef640a416d84dfa10a52fba29417361652e53376f275fad4a121cc54ac3347bd769b1707a8cd263dcaf9d3c2bb683dd9a52fa7de28c0f962b
+  data.tar.gz: 9fb7c71a6538567f39e6f9a5acc986c535b481e82920a994fb1c460a7164968b426b661e865528918049d75baedc12a383a87455b68bf5f5414d0a1aa01d2a43

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Securetrading change log
 
-## 0.2.0 / Unreleased
+## 0.4.0 / Unreleased
 
-* [Added] Filter - query API for transactions details.
+* [Added] 
 
 * [Deprecated]
 
@@ -10,6 +10,21 @@
 
 * [Fixed]
 
+## 0.3.0 / 2015-08-25
+
+* [Added] 
+  * Securetrading::SiteSecurity.hash(fields) to return SHA256 encoded sitesecurity value from hash of fields to encode.
+  * auth_method configuration value
+  * site_security_password configuration value
+  * Securetrading::Response to objectify response from httparty
+
+* [Deprecated]
+  * Renamed Filter class to TransactionQuery class as much more relevant.
+
+## 0.2.0 / 2015-08-14
+
+* [Added] Filter - query API for transactions details.
+
 ## 0.1.0 / 2015-08-13
 
 * [Added] Possibility to send REFUND request to API.

data/README.md

@@ -75,7 +75,7 @@ Will send post request with xml:
 </requestblock>
 ```
 
-#### FILTER
+#### TRANSACTIONQUERY
 
 Parameters: 
 - filters - list of filter xml subtags. You may find full list of filters in this doc: [http://www.securetrading.com/support/document/xml-reference-transaction-query/](http://www.securetrading.com/support/document/xml-reference-transaction-query/)
@@ -83,8 +83,8 @@ Parameters:
 Example:
 
 ```ruby
-> filter = Securetrading::Filter.new({ transactionreference: [ '5-9-1982481', '5-9-1980795'] })
-> filter.perform
+> query = Securetrading::TransactionQuery.new(transactionreference: [ '5-9-1982481', '5-9-1980795'])
+> query.perform
 ```
 It will send post request with xml:
 
@@ -100,6 +100,14 @@ It will send post request with xml:
 </requestblock>
 ```
 
+#### SiteSecurity
+
+Helper class for sitesecurity value calculation.
+More details in [STPP-Payment-Pages-Setup-Guide-V2](http://www.securetrading.com/files/documentation/STPP-Payment-Pages-Setup-Guide-V2.pdf) chapter 6.
+
+Methods:
+ * hash(fields) - calculates SHA256 hash from fields. List of fields you can check in doc above.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/securetrading.rb

@@ -25,4 +25,6 @@ end
 require 'securetrading/connection'
 require 'securetrading/xml_doc'
 require 'securetrading/refund'
-require 'securetrading/filter'
+require 'securetrading/transaction_query'
+require 'securetrading/site_security'
+require 'securetrading/models'

data/lib/securetrading/amount.rb

@@ -0,0 +1,13 @@
+module Securetrading
+  class Amount < BaseModel
+    def value
+      attributes_hash['__content__']
+    end
+
+    def ox_xml
+      el = XmlDoc.new_element(xml_tag_name)
+      el['currencycode'] = currencycode
+      el << value.to_s
+    end
+  end
+end

data/lib/securetrading/base_model.rb

@@ -0,0 +1,39 @@
+module Securetrading
+  class BaseModel
+    def initialize(attrs_hash = {})
+      @attributes_hash = attrs_hash.presence && attrs_hash.stringify_keys
+    end
+
+    def ox_xml
+      XmlDoc.elements(xml_tag_name => @attributes_hash).first
+    end
+
+    private
+
+    def xml_tag_name
+      self.class.name.demodulize.downcase
+    end
+
+    def method_missing(m, *args, &block)
+      return super unless attributes_hash.key?(m.to_s)
+      determine_value(m.to_s)
+    end
+
+    def determine_value(name)
+      if name == 'error'
+        Securetrading::ResponseError.new(attributes_hash[name])
+      elsif name.in?(sub_classes)
+        "Securetrading::#{name.capitalize}".constantize
+          .public_send(:new, attributes_hash[name])
+      else
+        attributes_hash[name]
+      end
+    end
+
+    def sub_classes
+      []
+    end
+
+    attr_reader :attributes_hash
+  end
+end

data/lib/securetrading/billing.rb

@@ -0,0 +1,9 @@
+ module Securetrading
+   class Billing < BaseModel
+     private
+
+     def sub_classes
+       %w(amount name dcc payment)
+     end
+   end
+ end

data/lib/securetrading/configuration.rb

@@ -2,7 +2,17 @@ module Securetrading
   class ConfigurationError < StandardError; end
   class Configuration
     attr_accessor :user, :password
-    attr_writer :site_reference
+    attr_writer :site_reference, :auth_method, :site_security_password
+
+    def site_security_password
+      return @site_security_password if @site_security_password.present?
+      fail ConfigurationError, 'You are trying to use site security '\
+        'but your password is empty. Please check gem configuration.'
+    end
+
+    def auth_method
+      @auth_method ||= 'FINAL'.freeze
+    end
 
     def site_reference
       return @site_reference if @site_reference.present?

data/lib/securetrading/connection.rb

@@ -24,18 +24,18 @@ module Securetrading
     end
 
     def request_type
-      fail NotImplementedError, 'Implement :request_type method in subclas!'
+      fail NotImplementedError, 'Implement :request_type method in sub-class!'
     end
 
     def ox_xml
-      fail NotImplementedError, 'Implement :ox_xml method in subclas!'
+      fail NotImplementedError, 'Implement :ox_xml method in sub-class!'
     end
 
     def perform_with(method, xml, options = {})
-      self.class.public_send(method,
-                             '/',
-                             options.merge(body: xml,
-                                           headers: dynamic_headers))
+      party = self.class.public_send(
+        method, '/', options.merge(body: xml, headers: dynamic_headers)
+      )
+      Securetrading::Response.new(party)
     end
 
     def dynamic_headers

data/lib/securetrading/models.rb

@@ -0,0 +1,18 @@
+require 'securetrading/base_model'
+
+module Securetrading
+  class Customer < BaseModel; end
+  class Dcc < BaseModel; end
+  class Merchant < BaseModel; end
+  class Name < BaseModel; end
+  class Operation < BaseModel; end
+  class Payment < BaseModel; end
+  class ResponseError < BaseModel; end
+  class Settlement < BaseModel; end
+  class Security < BaseModel; end
+end
+
+require 'securetrading/amount'
+require 'securetrading/billing'
+require 'securetrading/record'
+require 'securetrading/response'

data/lib/securetrading/record.rb

@@ -0,0 +1,9 @@
+module Securetrading
+  class Record < BaseModel
+    private
+
+    def sub_classes
+      %w(operation settlement billing merchant customer)
+    end
+  end
+end

data/lib/securetrading/refund.rb

@@ -25,22 +25,20 @@ module Securetrading
     end
 
     def operation
-      XmlDoc.elements(
-        operation: {
-          sitereference: Securetrading.config.site_reference,
-          accounttypedescription: @account_type,
-          parenttransactionreference: @parent_transaction
-        }
-      ).first
+      Operation.new(
+        sitereference: Securetrading.config.site_reference,
+        accounttypedescription: @account_type,
+        parenttransactionreference: @parent_transaction
+      ).ox_xml
     end
 
     def billing
-      XmlDoc.elements(billing: { amount: @amount }).first
+      Billing.new(amount: @amount).ox_xml
     end
 
     def merchant
       return '' unless @options[:merchant].present?
-      XmlDoc.elements(merchant: @options[:merchant]).first
+      Merchant.new(@options[:merchant]).ox_xml
     end
   end
 end

data/lib/securetrading/response.rb

@@ -0,0 +1,47 @@
+module Securetrading
+  class Response < BaseModel
+    attr_reader :httparty
+
+    def initialize(httparty)
+      @httparty = httparty
+    end
+
+    def data
+      rows.map { |row| Record.new(row) }
+    end
+
+    def found
+      attributes_hash['found'].to_i
+    end
+
+    private
+
+    def rows
+      case found
+      when 0 then []
+      when 1 then [record]
+      else record
+      end
+    end
+
+    def attributes_hash
+      return @attributes_hash if @attributes_hash.present?
+      @attributes_hash = responseblock
+      @attributes_hash.merge!(additional_attributes)
+    end
+
+    def additional_attributes
+      if responseblock['type'] == 'ERROR'
+        {}
+      elsif responseblock['response']['type'] == 'TRANSACTIONQUERY'
+        @attributes_hash.delete('response')
+      else
+        { 'record' => @attributes_hash.delete('response'), 'found' => '1' }
+      end
+    end
+
+    def responseblock
+      @responseblock ||= @httparty.parsed_response['responseblock']
+    end
+  end
+end

data/lib/securetrading/site_security.rb

@@ -0,0 +1,20 @@
+module Securetrading
+  class SiteSecurity
+    def self.hash(fields)
+      Digest::SHA256.hexdigest(str_to_encode(fields))
+    end
+
+    def self.str_to_encode(fields)
+      str = ''
+      fields.reverse_merge!(authmethod: Securetrading.config.auth_method)
+      [:currencyiso3a, :mainamount, :sitereference, :settlestatus,
+       :settleduedate, :authmethod, :paypaladdressoverride,
+       :strequiredfields, :version, :stprofile, :ruleidentifier,
+       :successfulurlredirect, :declinedurlredirect].each do |field|
+        str << fields[field].to_s
+      end
+      str << Securetrading.config.site_security_password
+    end
+    private_class_method :str_to_encode
+  end
+end

data/lib/securetrading/{filter.rb → transaction_query.rb}

@@ -1,5 +1,5 @@
 module Securetrading
-  class Filter < Connection
+  class TransactionQuery < Connection
     def initialize(filters)
       @filters = filters
     end

data/lib/securetrading/version.rb

@@ -1,3 +1,3 @@
 module Securetrading
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securetrading
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bitgamelabs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -174,10 +174,17 @@ files:
 - bin/guard
 - bin/setup
 - lib/securetrading.rb
+- lib/securetrading/amount.rb
+- lib/securetrading/base_model.rb
+- lib/securetrading/billing.rb
 - lib/securetrading/configuration.rb
 - lib/securetrading/connection.rb
-- lib/securetrading/filter.rb
+- lib/securetrading/models.rb
+- lib/securetrading/record.rb
 - lib/securetrading/refund.rb
+- lib/securetrading/response.rb
+- lib/securetrading/site_security.rb
+- lib/securetrading/transaction_query.rb
 - lib/securetrading/version.rb
 - lib/securetrading/xml_doc.rb
 - securetrading.gemspec