Recharge 1.0.1 → 1.0.2

data/examples/charge.rb

@@ -11,11 +11,6 @@ Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
 
 
 
-
-
-
-
-
 # Find an individual charge by the charge ID
 puts "", "Find Individual Charge"
 
@@ -37,11 +32,6 @@ end
 
 
 
-
-
-
-
-
 # create a new charge for a customer
 puts "", "Create New Charge"
 
@@ -64,17 +54,11 @@ end
 
 
 
-
-
-
-
-
-
 # Update an existing charge (change billing amount, card number, etc)
 puts "", "Update Charge"
 
 begin
-  # you must find the charge id first
+  # you must find the charge first
   charge = Recharge::Charge.find(chargeID)
   # then call update on it
   # you only need to pass the attributes you want to update
@@ -92,13 +76,6 @@ end
 
 
 
-
-
-
-
-
-
-
 # deletes an existing charge
 #  deletes the charge, cancels all future transactions that were scheduled for this charge
 puts "", "Delete Charges"

data/examples/customer.rb

@@ -1,5 +1,5 @@
 # Examples for the Recharge API Gem
-# Charge Resource
+# Customer Resource
 
 # Only 2 lines are required to get started:
 # Require the recharge.rb file
@@ -11,11 +11,6 @@ Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
 
 
 
-
-
-
-
-
 # Get a list of all active customers
 puts "Find All Customers",''
 
@@ -51,16 +46,6 @@ end
 
 
 
-
-
-
-
-
-
-
-
-
-
 # Find an individual customer by the customer ID
 puts "", "Find Individual Customers"
 
@@ -86,13 +71,6 @@ end
 
 
 
-
-
-
-
-
-
-
 # create a new customer
 puts "", "Create New Customer"
 
@@ -113,21 +91,11 @@ end
 
 
 
-
-
-
-
-
-
-
-
-
-
 # Update an existing customer (change email address, phone number, etc)
 puts "", "Update Customer"
 
 begin
-  # you must find the charge id first
+  # you must find the charge first
   customer = Recharge::Customer.find(customerID)
   
   # then call update on it
@@ -136,30 +104,25 @@ begin
     :refID=> Time.now.to_i
   )
   
-  # all updated information about the charge is now available
+  # all updated information about the customer is now available
   p customer
 rescue Exception => e
+  # errors here can be
+  # Response::NotFound if the customer ID does not exist
+  # Response::BadRequest if there was something wrong with the request
   puts ">> error #{e.message}"
 end
 
 
 
-
-
-
-
-
-
-
-
-
-
 # deletes an existing customer
 #  deletes the customer, payment methods, cancels all future transactions that were scheduled for this charge
 puts "", "Delete Customer"
 
 begin
+  # find the customer first
   customer = Recharge::Customer.find(customerID)
+  # call destroy on it to delete it
   customer.destroy
 rescue Exception => e
   puts ">> error #{e.message}"

data/examples/paymethod.rb

@@ -1,30 +1,50 @@
+# Examples for the Recharge API Gem
+# Payment Method Resource
+
+# Only 2 lines are required to get started:
+# Require the recharge.rb file
 require '../lib/recharge'
 
+# Set your API key here, found in Recharge Settings > API Settings > API Private Key
+# If incorrect or blank, any calls will raise a Response::NotAuthorized
 Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
 
+
+
+# Create a new payment method (and securely store the card number) for a customer
 puts "", "Create New PayMethod"
 
 begin
+  # paymethods can be created in one fell swoop
   paymethod = Recharge::PayMethod.create(
     :customer => "cu4f3782bf374a7",
     :nameOnCard => "test jones",
     :cardNumber => "4242424242424242",
     :expDate => "1212"
   )
+  # after the charge is saved, all attributes are available for you individually or by inspecting
   paymethodID = paymethod.id
   puts ">> paymethod id: #{paymethod.id}"
   puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
   p paymethod
 rescue Exception => e
+  # if a required field is missing or invalid, a Response::BadRequest error will be raised
+  # e.message will give more info why the record creation failed
   puts ">> error #{e.message}"
 end
 
 
 
+# deletes an existing paymethod and permanently deletes the stored credit card information
+# paymethods cannot be deleted if they are currently being used by any recurring charges
+#  as doing so will cause the charge to fail
 puts "", "Delete PayMethod"
 
 begin
+  # just call destroy and pass the Paymethod ID to delete it
   Recharge::PayMethod.destroy(paymethodID)
 rescue Exception => e
+  # will raise Response::BadRequest if Paymethod can't be deleted
+  # otherwise, delete was successful
   puts ">> error #{e.message}"
 end

data/examples/product.rb

@@ -1,26 +1,44 @@
+# Examples for the Recharge API Gem
+# Product Resource
+
+# Only 2 lines are required to get started:
+# Require the recharge.rb file
 require '../lib/recharge'
 
+# Set your API key here, found in Recharge Settings > API Settings > API Private Key
+# If incorrect or blank, any calls will raise a Response::NotAuthorized
 Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
 
-productID = ""
 
+
+# Get a list of all products
 puts "Find All Products",''
 
 begin
+  # call find_all to get a list of all products
   Recharge::Product.find_all.each do |product|
+    
+    # attributes can be accessed individually like this
     puts "id: #{product.id}"
     puts "name: #{product.name}"
     puts "price: #{product.price}"
     
+    # or you may inspect the whole record and get a list of all keys/values like this
+    p product
+    
     productID = product.id
   end
 rescue Exception => e
   puts ">> error #{e.message}"
 end
 
+
+
+# Find an individual product by the product ID
 puts "", "Find Individual Products"
 
 begin
+  # Records are fetched by their unique identifiers.
   product = Recharge::Product.find(productID)
   
   puts "id: #{product.id}"
@@ -33,15 +51,19 @@ end
 
 
 
+# create a new product
 puts "", "Create New Product"
 
 begin
+  # products can be created in one fell swoop
   product = Recharge::Product.create(
     :name => "HeyHey",
     :price => "100",
     :intervalValue => 1,
     :intervalUnit => 'm'
   )
+  
+  # after the product is saved, all attributes are available for you individually or by inspecting
   productID = product.id
   p product
 rescue Exception => e
@@ -50,24 +72,37 @@ end
 
 
 
+# Update an existing product (change price, product name, etc)
 puts "", "Update Product"
 
 begin
+  # you must find the product first
   product = Recharge::Product.find(productID)
+  
+  # then call update on it
+  # you only need to pass the attributes you want to update
   product.update(
     :price=> "101"
   )
+  
+  # all updated information about the product is now available
   p product
 rescue Exception => e
+  # errors here can be
+  # Response::NotFound if the customer ID does not exist
+  # Response::BadRequest if there was something wrong with the request
   puts ">> error #{e.message}"
 end
 
 
 
+# deletes an existing product
 puts "", "Delete Product"
 
 begin
+  # find the product first
   product = Recharge::Product.find(productID)
+  # call destroy on it to delete it
   product.destroy
 rescue Exception => e
   puts ">> error #{e.message}"

data/examples/transaction.rb

@@ -1,19 +1,38 @@
+# Examples for the Recharge API Gem
+# Transaction Resource
+# Lets you easily perform one-time credit card charges
+
+# Only 2 lines are required to get started:
+# Require the recharge.rb file
 require '../lib/recharge'
 
+# Set your API key here, found in Recharge Settings > API Settings > API Private Key
+# If incorrect or blank, any calls will raise a Response::NotAuthorized
 Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
 
+
+
+# charges a credit card
 puts "", "Credit Card Purchase"
 
 begin
+  # only :Amount, :AcctNum and :ExpDate are required
+  # other values are allowed such as CVV2 and ZIP code
+  # check API docs for more info
+  # https://www.rechargebilling.com/api
   transaction = Recharge::Transaction.purchase(
     :Amount => "#{rand(100)}.#{rand(100)}",
     :AcctNum => "4242424242424242",
     :ExpDate => "1212"
   )
-puts transaction.responseDescription, transaction.amount, transaction.approvalCode
-p transaction
-
-transactionID = transaction.transactionID
+  
+  # after transaction is processed attributes are available individually
+  puts transaction.responseDescription, transaction.amount, transaction.approvalCode
+  
+  # ...or by inspecting
+  p transaction
+  
+  transactionID = transaction.transactionID
 rescue Exception => e
   puts ">> error #{e.message}"
 end
@@ -22,7 +41,7 @@ end
 
 
 
-
+# refunds money back to a credit card using the card number and expiration date
 puts "", "Credit Card Refund (with card number)"
 
 begin
@@ -41,10 +60,12 @@ end
 
 
 
-
+# refunds money back to a credit card using the original transactionID
 puts "", "Credit Card Refund (without card number)"
 
 begin
+  # amount is required
+  #  amounts above the original purchase price for the transactionID given are sometimes rejected by the payment gateway
   transaction = Recharge::Transaction.refund(
     :TransactionID => transactionID,
     :Amount => "0.#{rand(100)}"
@@ -61,7 +82,10 @@ end
 
 
 
-
+# voids a previously processed sale or refund
+#  it is only possible to void transactions in the current batch...once the batch settles, the money will be taken off the card
+#   and put into your bank account. You will need to process a refund.
+#  batches usually settle once a day around 2AM PST
 puts "", "Credit Card Void"
 
 begin

data/lib/recharge.rb

@@ -16,44 +16,4 @@ module Recharge
     end
     attr_writer :api_key
   end
-  
-  def get(uri)
-    client = Client.new()
-    return client.request('GET', uri)
-  end
-  
-  def post(uri, data=nil)
-    client = Client.new()
-    return client.request('POST', uri, data)
-  end
-  
-  def delete(uri)
-    client = Client.new()
-    return client.request('DELETE', uri)
-  end
-  
-  def returnImportantXML(data)
-    require "rexml/document"
-    doc = REXML::Document.new(data)
-    
-    if doc.elements[1].elements[3].length == 1
-      return doc.elements[1].elements[3].elements[1]
-    else 
-      return doc.elements[1].elements[3]
-    end
-  end
-  
-  def returnErrorXML(data)
-    require "rexml/document"
-    doc = REXML::Document.new(data)
-    
-    doc.elements["/response/result/resultDescription"].text
-  end
-  
-  def returnStatusXML(data)
-    require "rexml/document"
-    doc = REXML::Document.new(data)
-    
-    doc.elements["/response/result/resultDescription"]
-  end 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Recharge
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Recharge