cardia 0.0.2 → 0.0.3

data/lib/cardia/credit_card_transaction.rb

@@ -17,9 +17,14 @@ module Cardia
   #   transaction.merchant = merchant
   # 
   #   card = Cardia::CreditCard.valid_card_for_testing
-  # 
+  #   
+  # For regular transactions, use:
   #   status = transaction.register(card)
   # 
+  # For 3d secure, use: 
+  #   status = transaction.register_3d(card, "http://my.success.url/", "http://my.failure.url/")  
+  # This will return a URL that the user should be redirected to. When the user is sent to this address he will either be redirected to   
+  # either the success or  failure URL, depending on whether the payment was successful.
   class CreditCardTransaction
 
     attr_reader :order, :verification_address
@@ -30,7 +35,8 @@ module Cardia
       @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
+    # Creates a new instance. Send along your Order as the parameter, see Cardia::Order for methods that should be implemented in your order
+    # * _an_order_ The order
     def self.with_http_connection(an_order)
       http = Net::HTTP.new(self.server_name,"443")
       http.use_ssl = true
@@ -38,6 +44,7 @@ module Cardia
     end
     
     # Send along the Cardia::Merchant that the payment is for
+    # * _a_merchant_ a Cardia::Merchant
     def merchant=(a_merchant)
       @merchant = a_merchant
     end
@@ -122,7 +129,7 @@ module Cardia
       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
+    # Register using 3DSecure. Send along a card, a URL for redirection after successful payments and a URL to redirect to when the payment was unsuccessful.
     def register_3d(a_credit_card, success_url, failure_url)
       raise "No verification code supplied" if a_credit_card.verification_value.nil?
       params = {

data/lib/cardia/money.rb

@@ -1,54 +1,64 @@
 module Cardia
+  # A very basic Money class, at the time being works with Norwegian Kroner
   class Money
     attr_reader :amount
+    
+    # Create an instance for NOK
     def self.kroner(an_amount)
       an_amount = an_amount.to_i
       self.new(an_amount * 100)
     end
-    def initialize(an_amount)
+
+    def initialize(an_amount) #:nodoc:
       @amount = an_amount
     end
 
-    def times(factor_integer)
+    def times(factor_integer) #:nodoc:
       self.class.new(factor_integer * @amount)
     end
 
-    def plus(a_money)
+    def plus(a_money) #:nodoc:
       self.class.new(a_money. amount + @amount)
     end
 
-    def +(a_money)
+    def +(a_money) #:nodoc:
       self.plus(a_money)
     end
 
+    # Return the object as Norwegian Kroner
     def kroner
       (@amount / 100).truncate
     end
 
+    # Return the øre
     def oere
       @amount - kroner * 100
     end
 
-    def nil?
+    def nil? #:nodoc:
       @amount.nil?
     end
 
+    # Return a new instance including tax
     def including_tax(tax_percentage)
       self.class.new((self.amount + self.amount * (tax_percentage / 100.0)).round)
     end
 
+    # Equality test, returns true for two objects of the same amount
     def ==(an_object)
       self.class == an_object.class and self.amount == an_object.amount
     end
 
+    # String representation
     def to_s
       "#{self.to_i},-"
     end
 
-    def to_i
+    def to_i #:nodoc:
       (@amount/100.0).round
     end
-
+    
+    # Formatted print
     def format_kroner_dot_oere
       return "%d.%.2d" % [self.kroner, self.oere]
     end

data/lib/cardia/order.rb

@@ -1,13 +1,13 @@
 module Cardia
-  # This is the very minimum that's required in order for and Order to function. You probably have your own...
+  # This is the very minimum that's required in order for an 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...)
+    # * +_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)

data/lib/cardia/version.rb

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

data/test_integration/test_acceptance.rb

@@ -1,7 +1,7 @@
 class CardiaAcceptanceTest < Test::Unit::TestCase
   def visa_card_for_testing
     result = Cardia::CreditCard.new
-    result.number               = "4000000000000002"
+    result.number               = "4444333322221111"
     result.verification_value   = "081"
     result.expiry_date          = Date.parse("2009-03-01")
     result.type                 = "visa"
@@ -22,7 +22,6 @@ class CardiaAcceptanceTest < Test::Unit::TestCase
   end
 
   def real_merchant
-    # Cardia::Merchant.with_token("0f0c518f-dc4f-4219-a356-9cbec52273d9")
     Cardia::Merchant.test_merchant
   end
 

data/website/index.html

@@ -65,7 +65,7 @@
 	<h2>Forum</h2>
 
 
-	<p><a href="http://rubyforge.org/forum/?group_id=4344">http://rubyforge.org/forum/?group_id=4344</a></p>
+	<p><a href="http://groups.google.com/group/cardia4ruby">We have a Google Group for this code</a></p>
 
 
 	<h2>This is a work in progress</h2>
@@ -73,7 +73,7 @@
 
 	<p>Although this is extracted from production quality code, this is a work in progress.</p>
     <p class="coda">
-      <a href="">TODO</a>, 1st September 2007<br>
+      <a href="">TODO</a>, 3rd September 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -21,8 +21,7 @@ h2. Demonstration of usage
 
 h2. Forum
 
-
-"http://rubyforge.org/forum/?group_id=4344":http://rubyforge.org/forum/?group_id=4344
+"We have a Google Group for this code":http://groups.google.com/group/cardia4ruby
 
 h2. This is a work in progress
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: cardia
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-09-03 00:00:00 +02:00
+  version: 0.0.3
+date: 2007-09-04 00:00:00 +02:00
 summary: provides credit card payments through Cardia
 require_paths: 
 - lib