cardflex-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ef2bceb03de84a741378a2761eb5bb7c6736316
+  data.tar.gz: afb94e6ff243cee5a76ec19051fdedb46b1dbfda
+SHA512:
+  metadata.gz: 2169e2f0d1cbb395ad6099b5b66a74160270dc3de4a577d4189434fe85c61952b378119b4b6a59170f3f2792f715ae21877a52d596155ed5ce1b4ac81722341e
+  data.tar.gz: 7e894a100ca40369a959849ab5efb8fefef68d9f2e80bd1c2f11f038da2ce259fb61fd943e4ed1bac7e06434129d7a9fb7cbddf3a438385d9a66e421ced08a9f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License (MIT)
+
+Copyright (c) 2014 Tom King
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# Cardflex Ruby Client Library (Unofficial)
+
+This gem provides client integration with the Cardflex API: https://secure.cardflexonline.com/gw/merchants/resources/integration/integration_portal.php. Currently, only the operations under the Three Step Integration are supported. This gem is supported by the community and is not associated with Cardflex.
+
+## Installation
+
+```shell
+gem install cardflex-ruby
+```
+
+Or add this line to your Gemfile:
+
+```ruby
+gem "cardflex-ruby"
+```
+
+And run a bundle install
+
+## Usage
+
+Before you can perform any actions, you must set your api_key:
+
+```ruby
+Cardflex::Configuration.api_key = "my_api_key"
+```
+
+You can also change the logger (default is stdout):
+
+```ruby
+Cardflex::Configuration.logger 
+```
+
+To start step 1 of a transaction, use the Three Step API to initiatialize the request process, and use the result to set the form URL for part 2:
+
+```ruby
+# See Cardflex documentation for required parameters
+step_one = Cardflex::ThreeStep.sale({
+  :redirect_url => "https://example.com",
+  :amount => 5.00
+})
+
+if step_one.success?
+  @form_url = step_one.three_step.form_url
+else
+  @error_message = step_one.result_text
+end
+```
+
+During step 2, you will present to your users a form that will POST to Cardflex using the form_url you received from Cardflex in step 1. Then, the user will be redirected to the :redirect_url supplied in the initial request, with a token_id that you send back to Cardflex to complete the transaction in the query string:
+
+```ruby
+token_id = params['token_id']
+
+result = Cardflex::ThreeStep.complete(token_id)
+
+if result.success?
+  # payment has been processed, send user the all clear
+else
+  @error_message = step_one.result_text
+end
+```
+
+The library will automatically add your api key to each request. You can also access these methods via the ThreeStep API:
+
+```
+# Transactional Methods
+ThreeStep#sale
+ThreeStep#credit
+ThreeStep#auth
+ThreeStep#offline
+ThreeStep#validate
+
+# Recurring Methods
+ThreeStep#add_subscription
+ThreeStep#update_subscription
+
+# Customer Vault Methods
+ThreeStep#add_customer
+ThreeStep#update_customer
+ThreeStep#add_billing
+ThreeStep#update_billing
+```
+
+The methods above exist for your convenience, and take care of adding the root level XML node to the request. If you want to control the full XML request, you can use this method to do it all yourself (api key is still added):
+
+```ruby
+# Step One
+Cardflex::ThreeStep.get_form_url(:sale => {
+  :redirect_url => "https://example.com",
+  :amount => 5.00
+})
+```
+
+## Other Features
+
+In addition to supporting the Three Step API, you can also perform a few other actions that do not involve sensitive information, and so you are freed from having to use the Three Step process:
+
+```
+Plan#create
+Subscription#delete
+CustomerVault#sale
+CustomerVault#credit
+CustomerVault#auth
+CustomerVault#offline
+CustomerVault#delete_customer
+CustomerVault#delete_billing
+Transaction#void
+Transaction#capture
+Transaction#refund
+```
+
+## More Information
+
+You can find all the Cardflex documentation here: https://secure.cardflexonline.com/gw/merchants/resources/integration/integration_portal.php 
+
+## Tests
+
+The tests run against the Cardflex API using the testing account. You will need an internet connection to run some of the tests.
+
+## Contributing
+
+All pull requests that add tests, clean up the code, add features, or fix issues are welcome. Be sure to write tests for any and all changes to the code base, and make sure all tests pass before submitting.
+
+## License
+MIT. See LICENSE file.

data/cardflex.gemspec

@@ -0,0 +1,14 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'cardflex/version'
+
+Gem::Specification.new do |s|
+  s.name = "cardflex-ruby"
+  s.summary = "Cardflex gateway ruby client library"
+  s.version = Cardflex::Version::Full
+  s.license = "MIT"
+  s.author = "Tom King"
+  s.homepage = "https://github.com/twking7/cardflex-ruby"
+  s.has_rdoc = false
+  s.files = Dir.glob ["README.md", "LICENSE", "lib/**/*.{rb,crt}", "spec/**/*", "*.gemspec"]
+  s.add_dependency "builder", ">= 2.0.0"
+end

data/lib/cardflex.rb

@@ -0,0 +1,32 @@
+# Libraries
+require 'logger'
+require 'net/http'
+require 'net/https'
+
+require 'builder'
+
+# Test Values
+require 'cardflex/test/test_values'
+
+# Cardflex
+require 'cardflex/version'
+require 'cardflex/configuration'
+require 'cardflex/errors'
+require 'cardflex/xml/parser'
+require 'cardflex/xml/serializer'
+require 'cardflex/xml'
+require 'cardflex/http'
+require 'cardflex/base_module'
+require 'cardflex/success_response'
+require 'cardflex/error_response'
+require 'cardflex/gateway'
+require 'cardflex/transaction_gateway'
+require 'cardflex/transaction'
+require 'cardflex/plan_gateway'
+require 'cardflex/plan'
+require 'cardflex/subscription_gateway'
+require 'cardflex/subscription'
+require 'cardflex/customer_vault'
+require 'cardflex/customer_vault_gateway'
+require 'cardflex/three_step_gateway'
+require 'cardflex/three_step'

data/lib/cardflex/base_module.rb

@@ -0,0 +1,34 @@
+module Cardflex
+  module BaseModule
+    module ClassMethods
+      def set_instance_variables_from_hash(hash)
+        hash.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      def snakecase(str)
+        str.gsub('-', '_').downcase
+      end
+
+      # takes a module that contains constants with method names.
+      # create class methods using these names that add the root
+      # xml node to the request. these methods are just sugar
+      def create_helper_methods(type)
+        method_names = type.constants.map { |t| type.const_get(t) }
+
+        method_names.each do |name|
+          define_singleton_method(name) do |attributes|
+            yield(name => attributes)
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(self)
+    end
+
+    include ClassMethods
+  end
+end

data/lib/cardflex/configuration.rb

@@ -0,0 +1,96 @@
+module Cardflex
+  class Configuration
+    API_VERSION = 3
+    SERVER = "secure.cardflexonline.com"
+    PORT = 443
+
+    class << self
+      attr_writer :logger, :api_key
+    end
+
+    attr_reader :api_key
+
+    def self.expectant_reader(*attributes)
+      attributes.each do |attribute|
+        (class << self; self; end).send(:define_method, attribute) do
+          value = instance_variable_get("@#{attribute}")
+          raise ConfigurationError.new(attribute.to_s, "needs to be set") unless value
+          value
+        end
+      end
+    end
+    expectant_reader :api_key, :environment
+
+    def initialize(options={})
+      [:environment, :api_key, :logger].each do |attr|
+        instance_variable_set("@#{attr}", options[attr])
+      end
+    end
+
+    def self.environment=(env)
+      unless [:development, :test, :production].include?(env)
+        raise ArgumentError, "#{env} is not a valid environment"
+      end
+
+      @environment = env
+    end
+
+    def self.gateway
+      Cardflex::Gateway.new(instantiate)
+    end
+
+    def self.instantiate
+      config = new(
+        :environment => @environment,
+        :logger => logger,
+        :api_key => api_key
+      )
+    end
+
+    def ca_file
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "ssl", "ca-certificates.ca.crt"))
+    end
+
+    def http
+      Http.new(self)
+    end
+
+    def three_step_path
+      "/api/v2/three-step"
+    end
+
+    def server
+      SERVER
+    end
+
+    def protocol
+      "https"
+    end
+
+    def port
+      PORT
+    end
+
+    def ssl?
+      true
+    end
+
+    def api_version
+      API_VERSION
+    end
+
+    def logger
+      @logger ||= self.class._default_logger
+    end
+
+    def self.logger
+      @logger ||= _default_logger
+    end
+
+    def self._default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      logger
+    end
+  end
+end

data/lib/cardflex/customer_vault.rb

@@ -0,0 +1,35 @@
+module Cardflex
+  class CustomerVault
+    include BaseModule
+
+    module Type
+      Sale = 'sale'
+      Auth = 'auth'
+      Credit = 'credit'
+      Offline = 'offline'
+      DeleteCustomer = 'delete_customer'
+      DeleteBilling = 'delete_billing'
+    end
+
+    attr_reader :config
+    attr_reader :result, :result_text, :result_code, :action_type
+    attr_reader :customer_vault_id
+    attr_reader :type, :billing, :shipping
+
+    def initialize(gateway, attributes)
+      @gateway = gateway
+      @config = gateway.config
+      @type = attributes[:action_type]
+
+      set_instance_variables_from_hash(attributes)
+    end
+
+    def self.request(attributes)
+      Configuration.gateway.customer_vault.request(attributes)
+    end
+
+    create_helper_methods(Type) do |attributes|
+      request(attributes)
+    end
+  end
+end

data/lib/cardflex/customer_vault_gateway.rb

@@ -0,0 +1,26 @@
+module Cardflex
+  class CustomerVaultGateway
+    attr_reader :config
+
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def request(attributes)
+      root = attributes.keys[0]
+      raise ArgumentError, 'missing redirect_url' unless attributes[root][:redirect_url]
+      raise ArgumentError, 'missing customer_vault_id' unless attributes[root][:customer_vault_id]
+
+      @config.http.post(attributes)
+    end
+
+    def _handle_response(res)
+      if res[:response][:result] == '1'
+        SuccessResponse.new(:customer_vault => CustomerVault.new(@gateway, res[:response]))
+      else
+        ErrorResponse.new(@gateway, res[:response])
+      end
+    end
+  end
+end

data/lib/cardflex/error_response.rb

@@ -0,0 +1,18 @@
+module Cardflex
+  class ErrorResponse
+    include BaseModule
+
+    attr_reader :result, :result_code, :result_text
+
+    def initialize(gateway, hash={})
+      @gateway = gateway
+      @result = hash[:result].to_i
+      @result_code = hash[:result_code]
+      @result_text = hash[:result_text]
+    end
+
+    def success?
+      false
+    end
+  end
+end

data/lib/cardflex/errors.rb

@@ -0,0 +1,11 @@
+module Cardflex
+  class CardflexError < ::StandardError; end
+
+  class ConfigurationError < CardflexError
+    def initialize(setting, message)
+      super "Cardflex::Configuration.#{setting} #{message}"
+    end
+  end
+
+  class SSLCertificateError < CardflexError; end
+end

data/lib/cardflex/gateway.rb

@@ -0,0 +1,35 @@
+module Cardflex
+  class Gateway
+    attr_reader :config
+
+    def initialize(config)
+      if config.is_a? Hash
+        @config = Configuration.new(config)
+      elsif config.is_a? Configuration
+        @config = config
+      else
+        raise ArgumentError, "config is an invalid type"
+      end
+    end
+
+    def transaction
+      TransactionGateway.new(self)
+    end
+
+    def plan
+      PlanGateway.new(self)
+    end
+
+    def three_step
+      ThreeStepGateway.new(self)
+    end
+
+    def customer_vault
+      CustomerVaultGateway.new(self)
+    end
+
+    def subscription
+      SubscriptionGateway.new(self)
+    end
+  end
+end