laundry 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ach-direct.gemspec
+gemspec
+
+group :development do
+  # for travis-ci.org
+  gem "rake"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wil Gieseler
+
+MIT License
+
+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,34 @@
+#Laundry [![Build Status](https://secure.travis-ci.org/supapuerco/laundry.png)](http://travis-ci.org/supapuerco/laundry) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/supapuerco/laundry)
+
+TODO: Write a gem description
+
+    merchant = Laundry::PaymentsGateway::Merchant.new(id: '12345', api_login_id: 'abcd', api_password: 'secret')
+    merchant.clients.find(10).accounts.create!
+
+[View the Rdoc](http://rdoc.info/github/supapuerco/laundry/master/frames)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'laundry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install laundry
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "bundle exec irb -rubygems -I lib -r laundry.rb"
+end
+
+task :default => [:travis]
+task :travis do
+  
+end

data/laundry.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/laundry/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  
+  gem.authors       = ["Wil Gieseler"]
+  gem.email         = ["supapuerco@gmail.com"]
+  gem.description   = "A soapy interface to ACH Direct's PaymentsGateway.com service."
+  gem.summary       = "A soapy interface to ACH Direct's PaymentsGateway.com service."
+  gem.homepage      = "https://github.com/supapuerco/laundry"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "laundry"
+  gem.require_paths = ["lib"]
+  gem.version       = Laundry::VERSION
+  
+  gem.add_dependency 'savon'
+  
+end

data/lib/laundry/lib/soap_model.rb

@@ -0,0 +1,113 @@
+module Laundry
+
+  # = Savon::Model
+  #
+  # Model for SOAP service oriented applications.
+  module SOAPModel
+
+    def self.extended(base)
+      base.setup
+    end
+
+    def setup
+        class_action_module
+        instance_action_module
+      end
+
+      # Accepts one or more SOAP actions and generates both class and instance methods named
+      # after the given actions. Each generated method accepts an optional SOAP body Hash and
+      # a block to be passed to <tt>Savon::Client#request</tt> and executes a SOAP request.
+      def actions(*actions)
+        actions.each do |action|
+          define_class_action(action)
+          define_instance_action(action)
+        end
+      end
+
+      private
+
+      # Defines a class-level SOAP action method.
+      def define_class_action(action)
+        class_action_module.module_eval %{
+          def #{action.to_s.snakecase}(body = nil, &block)
+            client.request :wsdl, #{action.inspect}, :body => body, &block
+          end
+        }
+      end
+
+      # Defines an instance-level SOAP action method.
+      def define_instance_action(action)
+        instance_action_module.module_eval %{
+          def #{action.to_s.snakecase}(body = nil, &block)
+            self.class.#{action.to_s.snakecase} merged_default_body(body), &block
+          end
+        }
+      end
+    
+      # Class methods.
+      def class_action_module
+        @class_action_module ||= Module.new do
+
+          # Returns the memoized <tt>Savon::Client</tt>.
+          def client(&block)
+            @client ||= Savon::Client.new(&block)
+          end
+
+          # Sets the SOAP endpoint to the given +uri+.
+          def endpoint(uri)
+            client.wsdl.endpoint = uri
+          end
+
+          # Sets the target namespace.
+          def namespace(uri)
+            client.wsdl.namespace = uri
+          end
+
+          # Sets the WSDL document to the given +uri+.
+          def document(uri)
+            client.wsdl.document = uri
+          end
+
+          # Sets the HTTP headers.
+          def headers(headers)
+            client.http.headers = headers
+          end
+
+          # Sets basic auth +login+ and +password+.
+          def basic_auth(login, password)
+            client.http.auth.basic(login, password)
+          end
+
+          # Sets WSSE auth credentials.
+          def wsse_auth(*args)
+            client.wsse.credentials(*args)
+          end
+        
+        end.tap { |mod| extend(mod) }
+      end
+
+      # Instance methods.
+      def instance_action_module
+        @instance_action_module ||= Module.new do
+
+          # Returns the <tt>Savon::Client</tt> from the class instance.
+          def client(&block)
+            self.class.client(&block)
+          end
+          
+          def default_body(hash)
+            @default_body = hash
+          end
+        
+          private
+        
+          def merged_default_body(body = {})
+            (@default_body || {}).merge (body || {})
+          end
+
+        end.tap { |mod| include(mod) }
+      end
+
+    end
+
+end

data/lib/laundry/payments_gateway/drivers/account_driver.rb

@@ -0,0 +1,48 @@
+module Laundry
+  module PaymentsGateway
+
+    class AccountDriver < MerchantAuthenticatableDriver
+      
+      attr_accessor :client
+      def initialize(client, merchant)
+        super merchant
+        self.client = client
+      end
+    
+      def client_driver
+        @client_driver ||= ClientDriver.new(self.merchant)
+      end
+      
+      def find(payment_method_id)
+        r = client_driver.get_payment_method({'ClientID' => self.client.id, 'PaymentMethodID' => payment_method_id}) do
+          http.headers["SOAPAction"] = 'https://ws.paymentsgateway.net/v1/IClientService/getPaymentMethod'
+        end
+        Account.new(r, self.merchant)
+      end
+      
+      # Returns the payment method id
+      def create!(options = {})
+        options = {merchant_id: self.merchant.id, client_id: self.client.id, payment_method_id: 0}.merge(options)
+        options = AccountDriver.uglify_hash(options)
+        r = client_driver.create_payment_method({'payment' => options}) do
+          http.headers["SOAPAction"] = 'https://ws.paymentsgateway.net/v1/IClientService/createPaymentMethod'
+        end
+        r[:create_payment_method_response][:create_payment_method_result]
+      end
+            
+      def self.prettifiable_fields
+        ['MerchantID',
+         'ClientID',
+         'PaymentMethodID',
+         'AcctHolderName',
+         'EcAccountNumber',
+         'EcAccountTRN',
+         'EcAccountType',
+         'Note',
+         'IsDefault']
+      end
+    
+    end
+  
+  end
+end

data/lib/laundry/payments_gateway/drivers/client_driver.rb

@@ -0,0 +1,73 @@
+module Laundry
+  module PaymentsGateway
+
+    class ClientDriver < MerchantAuthenticatableDriver
+    
+     # Setup WSDL
+      if Laundry.sandboxed?
+        document "https://sandbox.paymentsgateway.net/WS/Client.wsdl"
+      else
+        document "https://ws.paymentsgateway.net/Service/v1/Client.wsdl"
+      end
+    
+      actions "createClient", "getClient", "getPaymentMethod", "createPaymentMethod"
+    
+      def find(id)
+        r = get_client({'ClientID' => id}) do
+          http.headers["SOAPAction"] = 'https://ws.paymentsgateway.net/v1/IClientService/getClient'
+        end
+        Client.new(r, self.merchant)
+      end
+      
+      # Creates a client and returns the newly created client id.
+      def create!(options = {})
+        r = create_client({'client' => ClientDriver.default_hash.merge(options).merge({'MerchantID' => self.merchant.id, 'ClientID' => 0, 'Status' => 'Active'})} ) do
+          http.headers["SOAPAction"] = 'https://ws.paymentsgateway.net/v1/IClientService/createClient'
+        end
+        r[:create_client_response][:create_client_result]
+      end
+      
+      private
+      
+      def self.default_fields
+        ['MerchantID',
+         'ClientID',
+         'FirstName',
+         'LastName',
+         'CompanyName',
+         'Address1',
+         'Address2',
+         'City',
+         'State',
+         'PostalCode',
+         'CountryCode',
+         'PhoneNumber',
+         'FaxNumber',
+         'EmailAddress',
+         'ShiptoFirstName',
+         'ShiptoLastName',
+         'ShiptoCompanyName',
+         'ShiptoAddress1',
+         'ShiptoAddress2',
+         'ShiptoCity',
+         'ShiptoState',
+         'ShiptoPostalCode',
+         'ShiptoCountryCode',
+         'ShiptoPhoneNumber',
+         'ShiptoFaxNumber',
+         'ConsumerID',
+         'Status']
+      end
+      
+      def self.default_hash
+        h = {}
+        self.default_fields.each do |f|
+          h[f] = ""
+        end
+        h
+      end
+    
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/drivers/merchant_authenticatable_driver.rb

@@ -0,0 +1,40 @@
+module Laundry
+  module PaymentsGateway
+
+    class MerchantAuthenticatableDriver
+      extend Laundry::SOAPModel
+    
+      attr_accessor :merchant
+    
+      def initialize(merchant)
+        # Save the merchant.
+        self.merchant = merchant
+      
+        # Log in via the merchant's login credentials.
+        default_body self.merchant.login_credentials.merge("MerchantID" => self.merchant.id)
+      end
+      
+      def self.prettifiable_fields
+        []
+      end
+
+      def self.uglify_hash(hash)
+        translation = {}
+        self.prettifiable_fields.each do |f|
+          translation[f.snakecase.to_sym] = f
+        end
+        ugly_hash = {}
+        hash.each do |k, v|
+          if translation.has_key?(k)
+            ugly_hash[translation[k]] = v
+          else
+            ugly_hash[k] = v
+          end
+        end
+        ugly_hash
+      end
+          
+    end
+    
+  end
+end

data/lib/laundry/payments_gateway/drivers/socket_driver.rb

@@ -0,0 +1,24 @@
+module Laundry
+  module PaymentsGateway
+
+    class SocketDriver < MerchantAuthenticatableDriver
+    
+      # Setup WSDL
+      if Laundry.sandboxed?
+        document "https://ws.paymentsgateway.net/pgtest/paymentsgateway.asmx?WSDL"
+      else
+        document "https://ws.paymentsgateway.net/pg/paymentsgateway.asmx?WSDL"
+      end
+    
+      actions "ExecuteSocketQuery"
+      
+      def exec(options = {})
+        execute_socket_query(options) do
+          http.headers["SOAPAction"] = "http://paymentsgateway.achdirect.com/ExecuteSocketQuery"
+        end
+      end
+    
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/drivers/transaction_driver.rb

@@ -0,0 +1,25 @@
+module Laundry
+  module PaymentsGateway
+
+    class TransactionDriver < MerchantAuthenticatableDriver
+    
+      # Setup WSDL
+      if Laundry.sandboxed?
+        document 'https://sandbox.paymentsgateway.net/WS/Transaction.wsdl'
+      else
+        document 'https://ws.paymentsgateway.net/Service/v1/Transaction.wsdl'
+      end
+    
+      actions "getTransaction"
+      
+      def find(client_id, transaction_id)
+        r = get_transaction({'ClientID' => client_id, 'TransactionID' => transaction_id}) do
+          http.headers["SOAPAction"] = "https://ws.paymentsgateway.net/v1/ITransactionService/getTransaction"
+        end
+        Transaction.new(r, self.merchant)
+      end
+
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/account.rb

@@ -0,0 +1,61 @@
+module Laundry
+  module PaymentsGateway
+
+    class Account < ResponseModel
+      
+      def record
+        response[:get_payment_method_response][:get_payment_method_result][:payment_method]
+      end
+      
+      # EFT TRANSACTION_CODES
+      EFT_SALE = 20
+      EFT_AUTH_ONLY = 21
+      EFT_CAPTURE = 22
+      EFT_CREDIT = 23
+      EFT_VOID = 24
+      EFT_FORCE = 25
+      EFT_VERIFY_ONLY = 26
+      
+      def debit_cents(cents, *args)
+        debit_dollars(dollarize(cents), *args)
+      end
+
+      def credit_cents(cents, *args)
+        credit_dollars(dollarize(cents), *args)
+      end
+      
+      def debit_dollars(dollars, *args)
+        perform_transaction(dollars, EFT_SALE, *args)
+      end
+      
+      def credit_dollars(dollars, *args)
+        perform_transaction(dollars, EFT_CREDIT, *args)
+      end
+      
+      def perform_transaction(dollars, type, options = {})
+        options = {
+         'pg_merchant_id' => self.merchant.id, 
+         'pg_password' => self.merchant.transaction_password,       
+         'pg_total_amount' => dollars,
+         'pg_client_id' => self.client_id,
+         'pg_payment_method_id' => self.id,
+         'pg_transaction_type' => type
+         }.merge(options)
+        r = self.merchant.socket_driver.exec(options)
+        TransactionResponse.new(r, self.merchant)
+      end
+            
+      def id
+        payment_method_id
+      end
+      
+      private
+      
+      def dollarize(cents)
+        cents.to_f / 100.0
+      end
+
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/client.rb

@@ -0,0 +1,22 @@
+module Laundry
+  module PaymentsGateway
+
+    class Client < ResponseModel
+      
+      def record
+        response[:get_client_response][:get_client_result][:client_record]
+      end
+
+      def id
+        client_id
+      end
+      
+      def accounts_driver
+        AccountDriver.new(self, self.merchant)
+      end
+      alias_method :accounts, :accounts_driver
+      
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/merchant.rb

@@ -0,0 +1,54 @@
+module Laundry
+  module PaymentsGateway
+
+    class Merchant
+      extend Laundry::SOAPModel
+    
+      # Setup WSDL
+      if Laundry.sandboxed?
+        document "https://sandbox.paymentsgateway.net/WS/Merchant.wsdl"
+      else
+        document "https://ws.paymentsgateway.net/Service/v1/Merchant.wsdl"
+      end
+      
+      def self.default_merchant(options = nil)
+        @@default_merchant = Merchant.new(options) if options
+        @@default_merchant
+      end
+    
+      attr_accessor :id, :api_login_id, :api_password, :transaction_password
+    
+      def initialize(options = {})
+      
+        self.id = options[:id]
+        self.api_login_id = options[:api_login_id]
+        self.api_password = options[:api_password]
+        self.transaction_password = options[:transaction_password]
+              
+      end
+          
+      def client_driver
+        @client_driver ||= ClientDriver.new(self)
+      end
+      alias_method :clients, :client_driver
+    
+      def transaction_driver
+        @transaction_driver ||= TransactionDriver.new(self)
+      end
+      alias_method :transactions, :transaction_driver
+    
+      def socket_driver
+        @socket_driver ||= SocketDriver.new(self)
+      end
+    
+      def login_credentials
+        # Time diff from 1/1/0001 00:00:00 to 1/1/1970 00:00:00
+        utc_time = (Time.now.to_i + 62135596800).to_s + '0000000'
+        ts_hash = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('md5'), self.api_password, "#{self.api_login_id}|#{utc_time}")
+        {'ticket' => {'APILoginID' => self.api_login_id, 'TSHash' => ts_hash, 'UTCTime' => utc_time}}
+      end
+    
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/response_model.rb

@@ -0,0 +1,30 @@
+module Laundry
+  module PaymentsGateway
+
+    class ResponseModel
+
+      attr_accessor :response
+      attr_accessor :merchant
+      def initialize(response, merchant)
+        self.response = response
+        self.merchant = merchant
+      end
+      
+      # Override please.
+      def record
+        response.try(:to_hash) || {}
+      end
+      
+      def to_hash
+        record
+      end
+      
+      def method_missing(id, *args)
+        return record[id.to_sym] if record.has_key? id.to_sym
+        super
+      end
+        
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/transaction.rb

@@ -0,0 +1,17 @@
+module Laundry
+  module PaymentsGateway
+
+    class Transaction < ResponseModel
+    
+      def record
+        response[:get_transaction_response][:get_transaction_result]
+      end
+      
+      def status
+        record[:response][:status].downcase
+      end
+    
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/models/transaction_response.rb

@@ -0,0 +1,42 @@
+module Laundry
+  module PaymentsGateway
+
+    class TransactionResponse < ResponseModel
+      
+      attr_accessor :response_record
+      
+      def initialize(response, merchant)
+        super
+        parse
+      end
+      
+      def record
+        self.response_record
+      end
+      
+      def success?
+        pg_response_type == 'A'
+      end
+      
+      def full_transaction
+        self.merchant.transactions.find pg_payment_method_id, pg_trace_number
+      end
+            
+      private
+        
+      def parse
+        data = {}
+        res = self.response[:execute_socket_query_response][:execute_socket_query_result].split("\n")
+        res.each do |key_value_pair|
+          kv = key_value_pair.split('=')
+          if kv.size == 2
+            data[ kv[0].to_sym ] = kv[1]
+          end
+        end
+        self.response_record = data
+      end
+      
+    end
+
+  end
+end

data/lib/laundry/payments_gateway/payments_gateway.rb

@@ -0,0 +1,12 @@
+require "laundry/payments_gateway/models/response_model"
+require "laundry/payments_gateway/models/client"
+require "laundry/payments_gateway/models/account"
+require "laundry/payments_gateway/models/merchant"
+require "laundry/payments_gateway/models/transaction_response"
+require "laundry/payments_gateway/models/transaction"
+
+require "laundry/payments_gateway/drivers/merchant_authenticatable_driver"
+require "laundry/payments_gateway/drivers/account_driver"
+require "laundry/payments_gateway/drivers/client_driver"
+require "laundry/payments_gateway/drivers/socket_driver"
+require "laundry/payments_gateway/drivers/transaction_driver"

data/lib/laundry/version.rb

@@ -0,0 +1,3 @@
+module Laundry
+  VERSION = "0.0.1"
+end

data/lib/laundry.rb

@@ -0,0 +1,22 @@
+require "laundry/version"
+require 'savon'
+
+module Laundry
+  
+  @@sandboxed = true
+
+  def self.sandboxed?
+    @@sandboxed
+  end
+  
+  def self.sandboxed=(yn)
+    @@sandboxed = yn
+  end
+
+end
+
+# Lib
+require "laundry/lib/soap_model"
+
+# Payments Gateway
+require "laundry/payments_gateway/payments_gateway"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: laundry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wil Gieseler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A soapy interface to ACH Direct's PaymentsGateway.com service.
+email:
+- supapuerco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- laundry.gemspec
+- lib/laundry.rb
+- lib/laundry/lib/soap_model.rb
+- lib/laundry/payments_gateway/drivers/account_driver.rb
+- lib/laundry/payments_gateway/drivers/client_driver.rb
+- lib/laundry/payments_gateway/drivers/merchant_authenticatable_driver.rb
+- lib/laundry/payments_gateway/drivers/socket_driver.rb
+- lib/laundry/payments_gateway/drivers/transaction_driver.rb
+- lib/laundry/payments_gateway/models/account.rb
+- lib/laundry/payments_gateway/models/client.rb
+- lib/laundry/payments_gateway/models/merchant.rb
+- lib/laundry/payments_gateway/models/response_model.rb
+- lib/laundry/payments_gateway/models/transaction.rb
+- lib/laundry/payments_gateway/models/transaction_response.rb
+- lib/laundry/payments_gateway/payments_gateway.rb
+- lib/laundry/version.rb
+homepage: https://github.com/supapuerco/laundry
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1235405825976968960
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1235405825976968960
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A soapy interface to ACH Direct's PaymentsGateway.com service.
+test_files: []