securetrading 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 267c87fa55b87574dfa58dea6a4da76083a27bd4
-  data.tar.gz: bcbf98e2f5be0cd29a71bc99e8eb87d6ae0cb994
+  metadata.gz: 79415e27c8e12d4d5c2665453b2b297fb747eaf0
+  data.tar.gz: 7d83ddb86ca77c924e264c7a0ca0b7f65b319c44
 SHA512:
-  metadata.gz: bbd79a4d7f3700ae3da76a66027ab92dbce3a90ecb00fe12e62262fb1024f4c4af4d5b09ceffeeea4051fc292a2bcb10e33bccd32d03bf9ef920dd296c346135
-  data.tar.gz: eff794acdbf6cb1be1ec7545a97512fd73573e5863469bf40e27db9d395a59ff12caa264b580e4aa7030f6767b5bedbdf3958c7037ade6791baa5f02da85e7be
+  metadata.gz: 6ad10220ac03be131c8b22fc5378ffadaa1c320097a7d25b54dc1943935b428d77678eeef6756fe803382626902c9d2e109f9d26620017cfa4b5cabd2fd0333c
+  data.tar.gz: 1c817f6c672cfde5c01e7afe71c2409cb50751a2bc4d8decc25eecdb89e505064ddc85a770256fc0e28b5585df57c5e04ae337973d2bc378d994286ae6bc5923

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Securetrading change log
+
+## 0.2.0 / Unreleased
+
+* [Added] Filter - query API for transactions details.
+
+* [Deprecated]
+
+* [Removed]
+
+* [Fixed]
+
+## 0.1.0 / 2015-08-13
+
+* [Added] Possibility to send REFUND request to API.

data/README.md

@@ -75,6 +75,31 @@ Will send post request with xml:
 </requestblock>
 ```
 
+#### FILTER
+
+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/)
+
+Example:
+
+```ruby
+> filter = Securetrading::Filter.new({ transactionreference: [ '5-9-1982481', '5-9-1980795'] })
+> filter.perform
+```
+It will send post request with xml:
+
+```XML
+<requestblock version=\"3.67\">
+  <alias>user_site1234@securetrading.com</alias>
+  <request type=\"TRANSACTIONQUERY\">
+    <filter>
+      <transactionreference>5-9-1982481</transactionreference>
+      <transactionreference>5-9-1980795</transactionreference>
+    </filter>
+  </request>
+</requestblock>
+```
+
 ## 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,3 +25,4 @@ end
 require 'securetrading/connection'
 require 'securetrading/xml_doc'
 require 'securetrading/refund'
+require 'securetrading/filter'

data/lib/securetrading/connection.rb

@@ -13,14 +13,44 @@ module Securetrading
       'Connection' => 'close'
     )
 
-    def post_with(xml, options = {})
-      self.class.post('/', options.merge(body: xml, headers: dynamic_headers))
+    def to_xml
+      Ox.dump(ox_xml)
     end
 
     private
 
+    def doc
+      @doc ||= XmlDoc.new(request_type, @account_type).doc
+    end
+
+    def request_type
+      fail NotImplementedError, 'Implement :request_type method in subclas!'
+    end
+
+    def ox_xml
+      fail NotImplementedError, 'Implement :ox_xml method in subclas!'
+    end
+
+    def perform_with(method, xml, options = {})
+      self.class.public_send(method,
+                             '/',
+                             options.merge(body: xml,
+                                           headers: dynamic_headers))
+    end
+
     def dynamic_headers
       { 'Authorization' => "Basic #{Securetrading.config.auth}" }
     end
+
+    def prepare_doc
+      return doc if xml_prepared?
+      yield
+      @xml_prepared = true
+      doc
+    end
+
+    def xml_prepared?
+      @xml_prepared
+    end
   end
 end

data/lib/securetrading/filter.rb

@@ -0,0 +1,23 @@
+module Securetrading
+  class Filter < Connection
+    def initialize(filters)
+      @filters = filters
+    end
+
+    def perform(options = {})
+      perform_with(:post, to_xml, options)
+    end
+
+    private
+
+    def ox_xml
+      prepare_doc do
+        doc.requestblock.request << XmlDoc.elements(filter: @filters).first
+      end
+    end
+
+    def request_type
+      'TRANSACTIONQUERY'.freeze
+    end
+  end
+end

data/lib/securetrading/refund.rb

@@ -8,31 +8,30 @@ module Securetrading
     end
 
     def perform(options = {})
-      post_with(to_xml, options)
-    end
-
-    def to_xml
-      Ox.dump(ox_xml)
+      perform_with(:post, to_xml, options)
     end
 
     private
 
     def ox_xml
-      return doc if xml_prepared?
-      req = doc.requestblock.request
-      req << merchant << billing
-      req.operation << transaction_reference
-      @xml_prepared = true
-      doc
+      prepare_doc do
+        req = doc.requestblock.request
+        req << merchant << operation << billing
+      end
     end
 
-    def doc
-      @doc ||= XmlDoc.new('REFUND', @account_type).doc
+    def request_type
+      'REFUND'.freeze
     end
 
-    def transaction_reference
-      return '' unless @parent_transaction.present?
-      XmlDoc.elements(parenttransactionreference: @parent_transaction).first
+    def operation
+      XmlDoc.elements(
+        operation: {
+          sitereference: Securetrading.config.site_reference,
+          accounttypedescription: @account_type,
+          parenttransactionreference: @parent_transaction
+        }
+      ).first
     end
 
     def billing
@@ -43,9 +42,5 @@ module Securetrading
       return '' unless @options[:merchant].present?
       XmlDoc.elements(merchant: @options[:merchant]).first
     end
-
-    def xml_prepared?
-      @xml_prepared
-    end
   end
 end

data/lib/securetrading/version.rb

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

data/lib/securetrading/xml_doc.rb

@@ -14,18 +14,21 @@ module Securetrading
       @doc << root
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.elements(hash)
-      return unless hash.present?
-      hash.map do |k, v|
+      return '' unless hash.present?
+      hash.flat_map do |k, v|
+        return v.flat_map { |e| elements(k => e) } if v.is_a?(Array)
         el = new_element(k.to_s)
-        if v.is_a? Hash
+        if v.is_a?(Hash)
           elements(v).each { |e| el << e }
         else
           el << v.to_s
         end
-        el
+        [el]
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.new_element(name)
       Ox::Element.new(name)
@@ -37,15 +40,6 @@ module Securetrading
       self.class.new_element(name)
     end
 
-    def operation
-      self.class.elements(
-        operation: {
-          sitereference: Securetrading.config.site_reference,
-          accounttypedescription: @account_type
-        }
-      ).first
-    end
-
     def alias_el
       self.class.elements(alias: Securetrading.config.user).first
     end
@@ -53,7 +47,7 @@ module Securetrading
     def request_el
       el = new_element('request')
       el[:type] = @request_type
-      el << operation
+      el
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securetrading
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bitgamelabs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -162,6 +162,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -175,6 +176,7 @@ files:
 - lib/securetrading.rb
 - lib/securetrading/configuration.rb
 - lib/securetrading/connection.rb
+- lib/securetrading/filter.rb
 - lib/securetrading/refund.rb
 - lib/securetrading/version.rb
 - lib/securetrading/xml_doc.rb