giact 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wynn Netherland
+
+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,45 @@
+# Giact
+
+If you have to use the Giact recurring eCheck POST API my heart goes out to you. Here's a Ruby wrapper to ease your burden.
+
+## Installation
+
+    sudo gem install giact
+    
+## TODO
+
+API calls left to implement:
+
+* list installment checks by order ID
+* list installment checks by transaction ID
+* cancel future installment checks by order ID
+* cancel future installment checks by transaction ID
+* cancel a transaction by order ID that has not been batched
+* cancel a transaction by transaction ID that has not been batched
+* request a refund by order ID
+* request a refund by transaction ID
+* request a partial refund by order ID
+* request a partial refund by transaction ID
+* return a daily summary
+* list daily deposits for a given date
+* list checks returned for a given date
+* list checks refunded for a given date
+* list transactions scrubbed for a given date
+* list errored transactions for a given date
+* list checks returned for a given date range
+* list checks refunded for a given date range
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "giact"
+    gem.summary = %Q{Ruby wrapper for the Giact real time checks API}
+    gem.description = %Q{Ruby wrapper for the Giact real time checks API}
+    gem.email = "wynn.netherland@gmail.com"
+    gem.homepage = "http://github.com/pengwynn/giact"
+    gem.authors = ["Wynn Netherland"]
+    gem.add_dependency('hashie', '~> 0.1.3')
+    gem.add_dependency('httparty', '~> 0.4.5')
+    gem.add_dependency('activesupport', '>= 2.3')
+
+    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('fakeweb', '>= 1.2.5')
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/giact.rb

@@ -0,0 +1,106 @@
+require 'rubygems'
+require 'time'
+gem 'activesupport', '~> 2.3.2'
+require 'activesupport'
+
+gem 'hashie', '~> 0.1.3'
+require 'hashie'
+
+gem 'httparty', '>= 0.5.0'
+require 'httparty'
+
+gem 'validatable', '~> 1.6.7'
+require 'validatable'
+
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+Hash.send :include, Hashie::HashExtensions
+
+class Hash
+ 
+  # Converts all of the keys to strings, optionally formatting key name
+  def camelize_keys!
+    keys.each{|k|
+      v = delete(k)
+      new_key = k.to_s.camelize.gsub(/Id/, "ID")
+      self[new_key] = v
+      v.camelize_keys! if v.is_a?(Hash)
+      v.each{|p| p.camelize_keys! if p.is_a?(Hash)} if v.is_a?(Array)
+    }
+    self
+  end
+ 
+end
+
+module Giact
+  
+  class GiactError < StandardError
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+      super
+    end
+  end
+
+  class Unauthorized      < StandardError; end
+  class InvalidRequest    < GiactError; end
+  
+  # config/initializers/giact.rb (for instance)
+  # 
+  # Giact.configure do |config|
+  #   config.company_id =  'your_company_id'
+  #   config.username = 'your_api_username'
+  #   config.password = 'your_api_password'
+  # end
+  def self.configure
+    yield self
+    
+    Giact.company_id = company_id
+    Giact.username = username
+    Giact.password = password
+    true
+  end
+  
+  def self.company_id
+    @company_id
+  end
+  
+  def self.company_id=(company_id)
+    @company_id = company_id
+  end
+  
+  def self.username
+    @username
+  end
+  
+  def self.username=(username)
+    @username = username
+  end
+  
+  def self.password
+    @password
+  end
+  
+  def self.password=(password)
+    @password = password
+  end
+  
+  def self.test_mode?
+    @test_mode || false
+  end
+  
+  def self.test_mode=(test_mode)
+    @test_mode = test_mode
+  end
+end
+
+require File.join(directory, 'giact', 'cancel_recurring_check_list')
+require File.join(directory, 'giact', 'recurring_check_list')
+require File.join(directory, 'giact', 'transaction_result')
+require File.join(directory, 'giact', 'payment_reply')
+require File.join(directory, 'giact', 'payment_request')
+require File.join(directory, 'giact', 'installment_payment_request')
+require File.join(directory, 'giact', 'recurring_payment_request')
+require File.join(directory, 'giact', 'client')

data/lib/giact/cancel_recurring_check_list.rb

@@ -0,0 +1,17 @@
+module Giact
+  class CancelRecurringCheckList
+    attr_accessor :cancelled, :details
+    
+    def initialize(row="")
+      @cancelled, @details = row.split("|")
+    end
+    
+    def cancelled?
+      @cancelled.downcase == 'true'
+    end
+    
+    def self.from_response(response)
+      response.split(/\n/).map{|line| Giact::CancelRecurringCheckList.new(line)}
+    end
+  end
+end

data/lib/giact/client.rb

@@ -0,0 +1,136 @@
+module Giact
+  class Client
+    include HTTParty
+    format :xml
+    
+    attr_reader :company_id
+        
+    # @param [Hash] options method options
+    # @option options [Integer] :gateway Number (1-3) of gateway server to use
+    # @option options [String] :company_id Your Giact company ID
+    # @option options [String] :username Your Giact API username
+    # @option options [String] :password Your Giact API password
+    def initialize(options={})
+      options[:gateway] ||= 1
+      self.class.base_uri("https://gatewaydtx#{options[:gateway]}.giact.com/RealTime/POST/RealTimeChecks.asmx")
+      
+      @company_id ||= Giact.company_id ||= options[:company_id]
+      @username ||= Giact.username ||= options[:username]
+      @password ||= Giact.password ||= options[:password]
+    end
+    
+    
+    # Return an authentication token 
+    #
+    # @return [String] authentication token
+    def login
+      response = self.class.post("/Login", :body => {:companyID => @company_id, :un => @username, :pw => @password})
+      if auth_token = response['string']
+        @token = auth_token
+      else
+        raise Giact::Unauthorized.new(response.body)
+        
+      end
+    end
+    
+    # Returns current authentication token or calls login
+    #
+    # @return [String] authentication token
+    def token
+      @token ||= self.login
+    end
+    
+    # Process a single payment
+    #
+    # @param [Giact::PaymentRequest] payment_request Customer and payment info to be processed
+    # @return [Giact::PaymentReply] Transaction information
+    def single_payment(payment_request)
+      payment_request.merge!(:company_id => self.company_id, :token => self.token)
+      raise Giact::InvalidRequest.new(payment_request.errors.full_messages) unless payment_request.valid?
+      
+      response = self.class.post("/SinglePayment", :body => payment_request.to_request_hash)
+      if reply = response['string']
+        Giact::PaymentReply.new(reply)
+      else
+        raise response.body
+      end
+    end
+    
+    # Process recurring payments
+    #
+    # @param [Giact::RecurringPaymentRequest] payment_request Customer and payment info to be processed
+    # @return [Giact::PaymentReply] Transaction information
+    def recurring_payments(payment_request)
+      payment_request.merge!(:company_id => self.company_id, :token => self.token)
+      raise Giact::InvalidRequest.new(payment_request.errors.full_messages) if not payment_request.is_a?(Giact::RecurringPaymentRequest) or not payment_request.valid?
+      
+      response = self.class.post("/RecurringPayments", :body => payment_request.to_request_hash)
+      if reply = response['string']
+        Giact::PaymentReply.new(reply)
+      else
+        
+      end
+    end
+    
+    # Process installment payments
+    #
+    # @param [Giact::InstallmentPaymentRequest] payment_request Customer and payment info to be processed
+    # @return [Giact::PaymentReply] Transaction information
+    def installments_payments(payment_request)
+      payment_request.merge!(:company_id => self.company_id, :token => self.token)
+      raise Giact::InvalidRequest.new(payment_request.errors.full_messages) if not payment_request.is_a?(Giact::InstallmentPaymentRequest) or not payment_request.valid?
+      
+      response = self.class.post("/InstallmentsPayments", :body => payment_request.to_request_hash)
+      if reply = response['string']
+        Giact::PaymentReply.new(reply)
+      else
+        
+      end
+    end
+    
+    # @param [Hash] options method options
+    # @option options [String] :transaction_id Transaction ID to list checks
+    # @option options [String] :order_id Order ID to list checks
+    def recurring_checks(options={})
+      
+      path = "/RecurringChecksBy#{options.keys.first.to_s.camelize.gsub(/Id$/, "ID")}"
+      options.merge!(:company_id => self.company_id, :token => self.token)
+      options.camelize_keys!
+      
+      response = self.class.post(path, :body => options)['string']
+      Giact::RecurringCheckList.from_response(response)
+    end
+    
+    # @param [Hash] options method options
+    # @option options [String] :transaction_id Transaction ID for which to cancel checks
+    # @option options [String] :order_id Order ID for which to cancel checks
+    def cancel_recurring(options={})
+      
+      path = "/CancelRecurringBy#{options.keys.first.to_s.camelize.gsub(/Id$/, "ID")}"
+      options.merge!(:company_id => self.company_id, :token => self.token)
+      options.camelize_keys!
+      
+      response = self.class.post(path, :body => options)['string']
+      Giact::CancelRecurringCheckList.from_response(response)
+    end
+    
+
+    # @param [Hash] options method options
+    # @option options [String] :name_on_check Name on check to search
+    # @option options [String] :customer_id Customer ID to search
+    # @option options [String] :order_id Order ID to search
+    def search_transactions(options={})
+      
+      path = "/TransactionsBy#{options.keys.first.to_s.camelize.gsub(/Id$/, "ID")}"
+      options.merge!(:company_id => self.company_id, :token => self.token)
+      options.camelize_keys!
+      
+      response = self.class.post(path, :body => options)['string']
+      Giact::TransactionResult.from_response(response)
+    end
+    
+    
+
+  
+  end
+end

data/lib/giact/installment_payment_request.rb

@@ -0,0 +1,20 @@
+module Giact
+  class InstallmentPaymentRequest < PaymentRequest
+        
+    validates_each :installment_amount, :logic => lambda { errors.add(:installment_amount, "must be greater than zero") if installment_amount.to_f == 0.0 }
+    
+    
+    def installment_count
+      self[:installment_amount].to_i
+    end
+    
+    def installments_start_date
+      if self[:installments_start_date].respond_to?(:year)
+        self[:installments_start_date].strftime("%m/%d/%Y")
+      else
+        self[:installments_start_date]
+      end
+    end
+    
+  end
+end

data/lib/giact/payment_reply.rb

@@ -0,0 +1,22 @@
+module Giact
+  class PaymentReply
+    attr_reader :transaction_id, :error, :pass, :details, :code
+    
+    def initialize(response)
+      @transaction_id, @error, @pass, @details, @code = response.split("|")
+    end
+    
+    def transaction_id
+      @transaction_id.to_i == 0 ? nil : @transaction_id.to_i
+    end
+    
+    def error?
+      @error.to_s == 'true'
+    end
+    
+    def pass?
+      @pass.to_s == 'true'
+    end
+    
+  end
+end