cardia 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-08-30
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Marius Mårnes Mathiesen
+
+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/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/cardia.rb
+lib/cardia/credit_card_transaction.rb
+lib/cardia/customer.rb
+lib/cardia/merchant.rb
+lib/cardia/order.rb
+lib/cardia/transaction_status.rb
+lib/cardia/version.rb
+lib/credit_card.rb
+lib/enum.rb
+lib/validateable.rb
+log/debug.log
+script/destroy
+script/generate
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_cardia.rb
+test/test_credit_card_transaction.rb
+test/test_helper.rb
+test/test_transaction_status.rb

data/README.txt

@@ -0,0 +1,8 @@
+= Cardia
+Implements payments through Norwegian payment gateway Cardia's Cardia Service.
+
+See Cardia::CreditCardTransaction for example usage
+
+== Other sources of information
+* Cardia's own documentation is available at http://www.cardia.no/Resource/Documentation/Services/Cardia.Services.Card.pdf
+* SOAP interface description: https://secure.cardia.no/service/card/transaction/1.2/transaction.asmx

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'cardia/version'
+
+AUTHOR = 'Marius Mårnes Mathiesen'  # can also be an array of Authors
+EMAIL = "marius.mathiesen@gmail.com"
+DESCRIPTION = "provides credit card payments through Cardia"
+GEM_NAME = 'cardia' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cardia' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "zmalltalker"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Cardia::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'cardia documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'cardia'

data/lib/cardia/credit_card_transaction.rb

@@ -0,0 +1,207 @@
+module Cardia
+
+  # This class represents a credit card transaction against Cardia
+  # These are created at Cardia using one of the register methods:
+  # - register, which keeps the control with us (we dont redirect the user away), but gives the merchant full responsibility
+  # - register_3d, which forces our user into foreign territory, hopefully returning to us afterwards; but limits the merchants liabilities
+  # 
+  # == Minimal usage example
+  #   require 'cardia'
+  # 
+  #   customer = Cardia::Customer.new("John","Doe")
+  #   amount = 1000
+  #   order = Cardia::Order.new(amount, "My test order")
+  #   order.customer = customer
+  #   merchant = Cardia::Merchant.test_merchant
+  #   transaction = Cardia::CreditCardTransaction.with_http_connection(order)
+  #   transaction.merchant = merchant
+  # 
+  #   card = ActiveMerchant::Billing::CreditCard.valid_card_for_testing
+  # 
+  #   status = transaction.register(card)
+  # 
+  class CreditCardTransaction
+
+    attr_reader :order, :verification_address
+    attr_reader :merchant
+
+    def initialize(an_order, http_connection) #:nodoc:
+      @order= an_order
+      @http = http_connection
+    end
+
+    # Creates a new instance. Send along your Order as the parameter, see Billing::Order for methods that should be implemented in your order
+    def self.with_http_connection(an_order)
+      http = Net::HTTP.new(self.server_name,"443")
+      http.use_ssl = true
+      return self.new(an_order, http)
+    end
+    
+    # Send along the Cardia::Merchant that the payment is for
+    def merchant=(a_merchant)
+      @merchant = a_merchant
+    end
+    
+    def invoke_transaction_web_service(method, values) #:nodoc:
+      doc = do_invoke_web_service("/Service/Card/Transaction/1.2/Transaction.asmx/",
+                                  method,
+                                  values)
+      status_code = doc.root.elements["StatusCode"].text.to_i
+      return status_code, doc
+    end
+
+    def invoke_teller_web_service(method, values) #:nodoc:
+      doc = do_invoke_web_service("/Service/Card/Mpi/TellerMpi/1.2/TellerMpi.asmx/", method, values)
+      status_code = doc.root.elements["ResponseCode"].text.to_i
+      return status_code, doc
+    end
+
+    # Implements the vanilla plain calls to Cardia
+    def invoke(method, values) #:nodoc:
+      status, doc = invoke_transaction_web_service(method, values)
+      return status
+    end
+
+    # Register the payment, keeping our user with us
+    def register_with_doc(a_credit_card) #:nodoc:
+      raise "Invalid credit card" unless a_credit_card.valid?
+      params =
+        {
+        :merchantToken                  => @merchant.token,
+        :userToken                                      => @order.customer.token,
+        :merchantReference      => @order.reference,
+        :store                                                  => store_name,
+        :orderDescription               => @order.description,
+        :cardNumber                                     => a_credit_card.number,
+        :expiryDate                                     => a_credit_card.expires,
+        :cvc2Code                                               => a_credit_card.verification_value,
+        :currencyCode                           => "NOK",
+        :instanceId                                     => "",
+        :amount                                                 => @order.amount.to_i, # croaks on floating point
+        :purchaseDate                           => Date.today.strftime("%Y-%m-%d"),
+        :isOnHold                                               => "true",
+        :isPreRegistered                => "false"
+      }
+      opts = []
+      params.each{|k,v| opts<<"#{k}=#{v}"}
+
+      values = opts.join("&")
+      method = "RegisterCardTransaction"
+      status, doc = invoke_transaction_web_service(method, values)
+      return status, doc
+    end
+
+    # Register the transaction with Cardia. Once this has been done, the amount is reserved on the users credit card, given that the the returned status says so...
+    def register(a_credit_card)
+      status, doc = register_with_doc(a_credit_card)
+      return status
+    end
+
+    def wait_until_approved #:nodoc:
+      (1..10).each do |n|
+        status = check_status
+        if status == TransactionStatus.approved
+          yield
+          return
+        end
+        puts n
+        sleep(2)
+      end
+      raise "Out of retries, Order not approved"
+    end
+
+    def http_connection
+      @http
+    end
+
+    def do_invoke_web_service(base_url, method, values) #:nodoc:
+      http = http_connection
+      url = base_url + method
+      response, body = http.post(url, values, {"Content-Type" => "application/x-www-form-urlencoded"})
+      response.value
+      return REXML::Document.new(response.body)
+    end
+
+    # Register using 3DSecure. After doing this, we should redirect the customer to the location stored in @verification_address
+    def register_3d(a_credit_card, success_url, failure_url)
+      raise "No verification code supplied" if a_credit_card.verification_value.nil?
+      params = {
+        :merchantToken                      => @merchant.token,
+        :applicationIdentifier              => "", # not in use
+        :cardNumber                         => a_credit_card.number,
+        :expiryDate                         => a_credit_card.expires,
+        :cv2Code                            => a_credit_card.verification_value,
+        :merchantReference                  => @order.reference,
+        :successfulTransactionUrl           => CGI::escape(success_url),
+        :unsuccessfulTransactionUrl         => CGI::escape(failure_url),
+        :authorizedNotAuthenticatedUrl      => "", # not in use
+        :currencyCode                       => "NOK",
+        :amount                             => @order.amount.to_i,
+        :isOnHold                           => "true",
+        :paymentType                        => a_credit_card.payment_type
+      }
+      opts = []
+      params.each{|k,v| opts << "#{k}=#{v}"}
+      values = opts.join("&")
+      status, doc = invoke_teller_web_service("PrepareTransaction", values)
+      unless status == 1
+        raise doc.root.elements["Error"].text
+      end
+      address = doc.root.elements["Address"].text
+      guid = doc.root.elements["ReferenceGuid"].text
+      @verification_address = "#{address}?preparationGuid=#{guid}"
+      return @verification_address
+    end
+
+
+    # Cancels a transaction. A good practice is probably to have a before_destroy filter in your order that does this
+    def void
+      return invoke("VoidTransaction", "merchantToken=#{@merchant.token}&userToken=#{@order.customer.token}&merchantReference=#{@order.reference}")
+    end
+
+
+    # Credits the transaction. This is bank-speak for reversing it; giving the customer a full refund
+    # If you want to, you can supply the amount manually
+    def credit(amount=nil)
+      amount = @order.amount if amount.nil?
+      return invoke("CreditTransaction", "merchantToken=#{@merchant.token}&amount=#{amount}&merchantReference=#{@order.reference}")
+    end
+    alias_method :refund, :credit
+
+    # This method confirms payments that are "on hold". Cardia calls this RevertOnHold
+    def confirm!
+      return invoke_transaction_web_service("RevertOnHoldTransaction", "merchantToken=#{@merchant.token}&merchantReference=#{@order.reference}")
+    end
+
+    # This method changes the amount on a transaction
+    # You should probably investigate about the terms around this before actually using it
+    def change_amount(new_amount)
+      return invoke("ChangeAmount", "merchantToken=#{@merchant.token}&amount=#{new_amount}&merchantReference=#{@order.reference}")
+    end
+
+    # Returns the transaction status as a Cardia::TransactionStatus instance
+    def check_status
+      status, doc = invoke_transaction_web_service("ReturnTransactionStatus", "merchantToken=#{@merchant.token}&merchantReference=#{@order.reference}")
+      response_code = doc.root.elements["ResponseCode"].text
+      currency_code = doc.root.elements["CurrencyCode"].text
+      recurring_code = doc.root.elements["RecurringCode"].text
+      amt = doc.root.elements["Amount"]
+      s = TransactionStatus.new(status)
+      unless amt.nil?
+        s.amount = Money.kroner(amt.text.to_i)
+      end
+      s.response_code = response_code.to_i
+      s.currency_code = currency_code
+      s.recurring_code = recurring_code
+      return s
+    end
+    
+    def store_name #:nodoc:
+      "AS Juks og Bedrag"
+    end
+
+    def self.server_name #:nodoc:
+      "secure.cardia.no"
+    end
+  end
+end

data/lib/cardia/customer.rb

@@ -0,0 +1,15 @@
+module Cardia
+
+  # A very basic Customer, you probably want to roll your own
+  class Customer
+    def initialize(first_name, last_name)
+      @first_name, @last_name           = first_name, last_name
+    end
+
+    # You need to generate a unique token identifying your Customer
+    def token
+      "867B5C54-B763-4D7C-B180-8766A5505656"
+    end
+  end
+  
+end

data/lib/cardia/merchant.rb

@@ -0,0 +1,23 @@
+module Cardia
+
+  # A merchant is the entity who requests payments/transactions. It is identified by a merchant token, which you'll get from Cardia
+  class Merchant
+    attr_accessor :token
+    class << self
+      
+      # The test merchant. Using this merchant, no transactions are done for real.
+      def test_merchant
+        m = self.new
+        m.token = "CF4B6B54-6C28-4FA3-86B0-E9A347D75C6C"
+        m
+      end
+
+      # Create an instance with your real token
+      def with_token(a_token)
+        m = self.new
+        m.token = a_token
+        m
+      end
+    end
+  end  
+end

data/lib/cardia/order.rb

@@ -0,0 +1,37 @@
+module Cardia
+  # This is the very minimum that's required in order for and Order to function. You probably have your own...
+  # For home baked order classes, you need to implement methods listed below
+  class Order
+    attr_reader :amount, :description, :reference
+    attr_accessor :customer, :status
+    
+    # Creates an instance: Parameters:
+    # * +amount+: The amount as an integer
+    # * +description+: Give a describing name (not used for much...)
+    def initialize(amount, description)
+      @amount,@description = amount, description
+      @reference = rand(10000)
+    end
+    
+    # You need to provide a reference that's guaranteed to be unique for your merchant
+    def reference
+      @reference
+    end
+
+    def compute_access_key #:nodoc:
+      "ello"
+    end
+    
+    # Callback that's called when an order is confirmed
+    def be_confirmed
+      @status = Status.confirmed
+    end
+
+    class Status #:nodoc:
+      def self.confirmed
+
+      end
+    end
+  end
+
+end

data/lib/cardia/transaction_status.rb

@@ -0,0 +1,60 @@
+module Cardia
+  # Wrapper around the result of the ReturnTransactionStatus call to Cardia
+  class TransactionStatus < Enum
+    attr_accessor :amount, :response_code, :currency_code, :recurring_code
+    map :approved, 1, "Transaction is approved"
+    map :not_approved, 2, "Transaction not approved"
+    map :not_registered, 3, "No transaction registered"
+    map :error, 4, "General error"
+    map :void, 5, "Transaction is approved, but voided afterwards."
+
+    # Explains the current status
+    def explanation
+      if self.response_success?
+        return description
+      end
+      return "#{response_message}, #{description}"
+    end
+    
+    # Whether the transaction was successful
+    def response_success?
+      response_code == 0
+    end
+    
+    # Returns the response code as a human readable text
+    def response_message
+      result = response_code_to_string[response_code]
+      if result.nil?
+        result = "Unknown response code %s" % response_code
+      end
+      return result
+    end
+
+    def response_code_to_string #:nodoc:
+      result =  {
+        0 => "Success",
+        6 => "Invalid card number",
+        7 => "Card is hot listed (known card used for fraud)",
+        17 => "Card is expired",
+        18 => "Invalid expiry date",
+        19 => "Card number is not valid",
+        22 => "Card type is not registered for merchant",
+
+        45 => "Amount exceeds allowed amount",
+
+        46 => "Amount is below minimum amount",
+
+        54 => "Card can not be used for internet purchases",
+
+        69 => "The bank do not authorise the payment (authorisation not OK)",
+        74 => "Card is rejected",
+
+        75 => "Not authorised"}
+      [25, 26, 27, 28, 29, 31].each do |each|
+        result[each] = "Card can not be used for internet purchases"
+      end
+      return result
+    end
+  end
+  
+end

data/lib/cardia/version.rb

@@ -0,0 +1,9 @@
+module Cardia #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/cardia.rb

@@ -0,0 +1,19 @@
+require 'date'
+require 'net/https'
+require 'uri'
+require 'validateable'
+require 'cgi'
+require 'credit_card'
+require 'rexml/document'
+require 'enum'
+require 'cardia/credit_card_transaction'
+require 'cardia/customer'
+require 'cardia/merchant'
+require 'cardia/order'
+require 'cardia/transaction_status'
+require 'cardia/version'
+$:.unshift File.dirname(__FILE__)
+
+module Cardia
+  
+end