cardflex-ruby 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ef2bceb03de84a741378a2761eb5bb7c6736316
-  data.tar.gz: afb94e6ff243cee5a76ec19051fdedb46b1dbfda
+  metadata.gz: 1da29dfbacec65d1aeb178a2aca6f0814f17ebbb
+  data.tar.gz: 17ac130da88ce00fd6b42e3c9225561b87c8a3ec
 SHA512:
-  metadata.gz: 2169e2f0d1cbb395ad6099b5b66a74160270dc3de4a577d4189434fe85c61952b378119b4b6a59170f3f2792f715ae21877a52d596155ed5ce1b4ac81722341e
-  data.tar.gz: 7e894a100ca40369a959849ab5efb8fefef68d9f2e80bd1c2f11f038da2ce259fb61fd943e4ed1bac7e06434129d7a9fb7cbddf3a438385d9a66e421ced08a9f
+  metadata.gz: 0703d9e0b1500fed41ae0f4f6ea6ce2af0fc08d955bc8541c2ad14b393e98baa1932b25a30d63c559b5411391c6b911c584c659e6dbd7c8e28b9002c1be93cd5
+  data.tar.gz: 293bd2099846cf4d887c219fc42cc22c39e138d58b75de68341e41d0dacb89316eb298c93115d008c58258830a471d8d5f718eb2d40422ccae7366d92a8c3413

data/README.md

@@ -55,8 +55,10 @@ result = Cardflex::ThreeStep.complete(token_id)
 
 if result.success?
   # payment has been processed, send user the all clear
+  # the result of the transaction is in result.transaction
+  result.transaction.transaction_id
 else
-  @error_message = step_one.result_text
+  @error_message = result.result_text
 end
 ```
 

data/cardflex.gemspec

@@ -4,6 +4,7 @@ require 'cardflex/version'
 Gem::Specification.new do |s|
   s.name = "cardflex-ruby"
   s.summary = "Cardflex gateway ruby client library"
+  s.description = "A ruby library for interacting with the Cardflex payment gateway API"
   s.version = Cardflex::Version::Full
   s.license = "MIT"
   s.author = "Tom King"

data/lib/cardflex/base_module.rb

@@ -29,6 +29,15 @@ module Cardflex
       base.extend(self)
     end
 
+    # add support for merchant_defined_field_#
+    def method_missing(method, *args)
+      if method =~ /^merchant_defined_field_\d+$/
+        instance_variable_get("@#{method}")
+      else
+        super
+      end
+    end
+
     include ClassMethods
   end
 end

data/lib/cardflex/configuration.rb

@@ -1,14 +1,15 @@
 module Cardflex
   class Configuration
-    API_VERSION = 3
+    API_VERSION = 2
     SERVER = "secure.cardflexonline.com"
     PORT = 443
 
     class << self
       attr_writer :logger, :api_key
+      attr_accessor :username, :password
     end
 
-    attr_reader :api_key
+    attr_reader :api_key, :username, :password
 
     def self.expectant_reader(*attributes)
       attributes.each do |attribute|
@@ -22,7 +23,7 @@ module Cardflex
     expectant_reader :api_key, :environment
 
     def initialize(options={})
-      [:environment, :api_key, :logger].each do |attr|
+      [:environment, :api_key, :username, :password, :logger].each do |attr|
         instance_variable_set("@#{attr}", options[attr])
       end
     end
@@ -43,6 +44,8 @@ module Cardflex
       config = new(
         :environment => @environment,
         :logger => logger,
+        :username => username,
+        :password => password,
         :api_key => api_key
       )
     end
@@ -59,6 +62,10 @@ module Cardflex
       "/api/v2/three-step"
     end
 
+    def query_path
+      "/api/query.php"
+    end
+
     def server
       SERVER
     end

data/lib/cardflex/http.rb

@@ -6,13 +6,19 @@ module Cardflex
       @config = config
     end
 
+    def get(params={})
+      uri = "#{@config.query_path}#{_hash_to_query_string(params)}"
+      response = _do_http(Net::HTTP::Get, uri)
+      Xml.parse(response.body)
+    end
+
     def post(params={})
       params = _add_api_key(params)
-      response = _do_http(Net::HTTP::Post, Xml.hash_to_xml(params))
+      response = _do_http(Net::HTTP::Post, @config.three_step_path, Xml.hash_to_xml(params))
       Xml.parse(response.body)
     end
 
-    def _do_http(http_verb, body=nil)
+    def _do_http(http_verb, path, body=nil)
       connection = Net::HTTP.new(@config.server, @config.port)
       connection.open_timeout = 60
       connection.read_timeout = 60
@@ -24,7 +30,7 @@ module Cardflex
       end
 
       connection.start do |http|
-        request = http_verb.new("#{@config.three_step_path}")
+        request = http_verb.new(path)
         request['Accept'] = 'text/xml'
         @config.logger.debug("[Cardflex] [#{_current_time}] #{request.method} as text/xml")
         if body
@@ -42,6 +48,20 @@ module Cardflex
       raise Cardflex::SSLCertificateError
     end
 
+    def _hash_to_query_string(hash)
+      str = "?"
+      hash.each do |key, value|
+        case value
+        when ::Array
+          str << "#{key}=#{value.join(',')}&"
+        when ::String
+          str << "#{key}=#{value}&"
+        end
+      end
+
+      str.gsub(/&$/, '') # remove trailing &, if any
+    end
+
     def _current_time
       Time.now.utc.strftime("%d/%b/%Y %H:%M:%S %Z")
     end

data/lib/cardflex/three_step_gateway.rb

@@ -7,6 +7,7 @@ module Cardflex
       @config = gateway.config
     end
 
+    # Three Step API
     def get_form_url(attributes)
       root = attributes.keys[0]
       raise ArgumentError, 'missing :redirect_url' unless attributes[root][:redirect_url]

data/lib/cardflex/transaction.rb

@@ -41,6 +41,7 @@ module Cardflex
       set_instance_variables_from_hash(attributes)
     end
 
+    # Three Step API
     def self.request(attributes)
       Configuration.gateway.transaction.request(attributes)
     end
@@ -48,5 +49,10 @@ module Cardflex
     create_helper_methods(Type) do |attributes|
       request(attributes)
     end
+
+    # Query API
+    def self.query(attributes)
+      Configuration.gateway.transaction.query(attributes)
+    end
   end
 end

data/lib/cardflex/transaction_gateway.rb

@@ -7,11 +7,22 @@ module Cardflex
       @config = gateway.config
     end
 
+    # Three Step API
     def request(attributes)
       res = @config.http.post(attributes)
       _handle_response(res)
     end
 
+    # Query API
+    def query(attributes)
+      unless username = @config.username && password = @config.password
+        raise ArgumentError, 'missing username and/or password'
+      end
+
+      res = @config.http.get(attributes.merge(:username => username, :password => password))
+      _handle_query_response(res)
+    end
+
     def _handle_response(res)
       if res[:response][:result] == '1'
         SuccessResponse.new(:transaction => Transaction.new(@gateway, res[:response]))
@@ -19,5 +30,13 @@ module Cardflex
         ErrorResponse.new(@gateway, res[:response])
       end
     end
+
+    def _handle_query_response(res)
+      if res[:nm_response].keys.include?(:error_response)
+        ErrorResponse.new(@gateway, :result => 3, :result_text => res[:nm_response][:error_response])
+      else
+        SuccessResponse.new(:transaction => Transaction.new(@gateway, res[:nm_response][:transaction]))
+      end
+    end
   end
 end

data/lib/cardflex/version.rb

@@ -1,9 +1,9 @@
 module Cardflex
   module Version
     Major = '0'
-    Minor = '0'
-    Tiny = '1'
+    Minor = '1'
+    Patch = '1'
 
-    Full = "#{Major}.#{Minor}.#{Tiny}"
+    Full = "#{Major}.#{Minor}.#{Patch}"
   end
 end

data/lib/cardflex/xml/parser.rb

@@ -25,24 +25,6 @@ module Cardflex
       def self._snakecase(key)
         key.tr('-', '_').to_sym
       end
-
-      def self.parse(string)
-        return {} if string.nil?
-
-        doc = REXML::Document.new(string)
-        { _snakecase(doc.root.name).to_sym => _to_hash({}, doc.root) }
-      end
-
-      def self._to_hash(hash, element)
-        if element.has_elements?
-          element.each_element do |child|
-            hash[_snakecase(child.name).to_sym] = child.text
-          end
-        end
-
-        hash
-      end
-
     end
   end
 end

data/spec/integration/cardflex/http_spec.rb

@@ -13,7 +13,7 @@ describe Cardflex::Http do
           new_output = StringIO.new
           Cardflex::Configuration.logger = Logger.new(new_output)
           Cardflex::Configuration.logger.level = Logger::DEBUG
-          Cardflex::Configuration.instantiate.http._do_http(Net::HTTP::Get, '/')
+          Cardflex::Configuration.instantiate.http._do_http(Net::HTTP::Get, '/api/v2/three-step')
           expect(new_output.string).to include("[Cardflex] [01/Jan/2014 00:00:00 UTC] GET")
           expect(new_output.string).to include("[Cardflex] [01/Jan/2014 00:00:00 UTC] GET 200")
         end

data/spec/integration/cardflex/query_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+# Unfortunately, there is no testing account for the query API. Stub it instead
+
+describe Cardflex::Transaction do
+  it 'should raise an argument error if no username/password supplied' do
+    expect do
+      Cardflex::Transaction.query(:transaction_id => 1)
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'should fail to query the cardflex api' do
+    allow_any_instance_of(Cardflex::Http).to receive(:_do_http).and_return(
+      SpecHelper::FakeResponse.new("<nm_response><error_response>failure</error_response></nm_response>")
+    )
+    Cardflex::Configuration.username = "demo"
+    Cardflex::Configuration.password = "password"
+    result = Cardflex::Transaction.query(:transaction_id => 1)
+
+    expect(result.success?).to be false
+    expect(result.result_text).to eq "failure"
+  end
+
+  it 'should query the cardflex api' do
+    allow_any_instance_of(Cardflex::Http).to receive(:_do_http).and_return(
+      SpecHelper::FakeResponse.new("<nm_response><transaction><transaction_id>1</transaction_id></transaction></nm_response>")
+    )
+    Cardflex::Configuration.username = "demo"
+    Cardflex::Configuration.password = "password"
+    result = Cardflex::Transaction.query(:transaction_id => 1)
+
+    expect(result.success?).to be true
+    expect(result.transaction.transaction_id.to_i).to eq 1
+  end
+end

data/spec/unit/cardflex/base_module_spec.rb

@@ -8,6 +8,10 @@ describe Cardflex::BaseModule do
       B = 'b'
       C = 'c'
     end
+
+    def initialize(attrs)
+      set_instance_variables_from_hash(attrs)
+    end
   end
 
   it 'should assign instance variables from a hash' do
@@ -31,4 +35,13 @@ describe Cardflex::BaseModule do
     TestClass.__send__(:create_helper_methods, TestClass::Type)
     expect(TestClass.methods).to include(:a, :b, :c)
   end
+
+  it 'should have merchant defined fields available' do
+    sut = TestClass.new(:merchant_defined_field_1 => 'test')
+    expect(sut.merchant_defined_field_1).to eq 'test'
+  end
+
+  it 'should raise an undefined method error for non existent merchant field' do
+    expect { TestClass.new.merchant_defined_field_1 }.to raise_error
+  end
 end

data/spec/unit/cardflex/configuration_spec.rb

@@ -23,7 +23,7 @@ describe Cardflex::Configuration do
     expect { Cardflex::Configuration.environment = :invalid }.to raise_error ArgumentError
   end
 
-  it 'should use http in development, https otherwise' do
+  it 'should use https' do
     sut = Cardflex::Configuration.new({ :environment => :test })
     expect(sut.protocol).to eq "https"
     expect(sut.ssl?).to be true
@@ -34,14 +34,19 @@ describe Cardflex::Configuration do
     expect(sut.ca_file).to match "ca-certificates.ca.crt"
   end
 
-  it 'should get the 3 step base url' do
+  it 'should get the 3 step url' do
     sut = Cardflex::Configuration.new({ :environment => :test })
     expect(sut.three_step_path).to match "/api/v2/three-step"
   end
 
+  it 'should get the query url' do
+    sut = Cardflex::Configuration.new({ :environment => :test })
+    expect(sut.query_path).to match "/api/query.php"
+  end
+
   it 'should get the api version' do
     sut = Cardflex::Configuration.new
-    expect(sut.api_version).to eq 3
+    expect(sut.api_version).to eq 2
   end
 
   it 'should get the correct port' do

data/spec/unit/cardflex/http_spec.rb

@@ -14,5 +14,23 @@ describe Cardflex::Http do
       sut = Cardflex::Configuration.instantiate.http._verify_ssl_certificate(false, context)
       expect(sut).to eq false
     end
+
+    it 'should convert a hash to a query string' do
+      http = Cardflex::Configuration.instantiate.http
+      result = http._hash_to_query_string(:field1 => 'test', :field2 => 'test')
+      expect(result).to eq "?field1=test&field2=test"
+    end
+
+    it 'should convert an array to comma separated string values' do
+      http = Cardflex::Configuration.instantiate.http
+      result = http._hash_to_query_string(:field1 => ["a", "b", "c"])
+      expect(result).to eq "?field1=a,b,c"
+    end
+
+    it 'should not convert a nested hash' do
+      http = Cardflex::Configuration.instantiate.http
+      result = http._hash_to_query_string(:field1 => 'test', :field2 => { :field3 => "a" })
+      expect(result).to eq "?field1=test"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardflex-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: 
+description: A ruby library for interacting with the Cardflex payment gateway API
 email: 
 executables: []
 extensions: []
@@ -59,6 +59,7 @@ files:
 - lib/ssl/ca-certificates.ca.crt
 - spec/integration/cardflex/http_spec.rb
 - spec/integration/cardflex/plan_spec.rb
+- spec/integration/cardflex/query_spec.rb
 - spec/integration/cardflex/three_step_gateway_spec.rb
 - spec/integration/cardflex/three_step_spec.rb
 - spec/integration/spec_helper.rb