Recharge 1.0.0 → 1.0.1

data/examples/charge.rb

@@ -0,0 +1,113 @@
+# Examples for the Recharge API Gem
+# Charge 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"
+
+
+
+
+
+
+
+
+# Find an individual charge by the charge ID
+puts "", "Find Individual Charge"
+
+begin
+  # Records are fetched by their unique identifiers.
+  charge = Recharge::Charge.find('ch4f3af9b81df18')
+  
+  # attributes can be accessed individually like this
+  puts ">> charge id: #{charge.id}"
+  puts ">> payment plan: #{charge.price} charged every #{charge.intervalValue} #{charge.intervalUnit}", ''
+  
+  # or you may inspect the whole record and get a list of all keys/values like this
+  p charge
+rescue Exception => e
+  # If the record doesn't exist, a Response::NotFound exception will
+  # be raised.
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+
+
+# create a new charge for a customer
+puts "", "Create New Charge"
+
+begin
+  # charges can be created in one fell swoop
+  charge = Recharge::Charge.create(
+    :customer          => "cu4f3782bf374a7",
+    :payMethod         => "pm4f3b214680f5f",
+    :billingStartDate  => "5/21/2012",
+    :product           => "pr4f379194192df"
+  )
+  # after the charge is saved, all attributes are available for you individually or by inspecting
+  chargeID = charge.id
+  p charge
+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
+
+
+
+
+
+
+
+
+
+# Update an existing charge (change billing amount, card number, etc)
+puts "", "Update Charge"
+
+begin
+  # you must find the charge id first
+  charge = Recharge::Charge.find(chargeID)
+  # then call update on it
+  # you only need to pass the attributes you want to update
+  charge.update(
+    :product  => "pr4f3b29e2b5813"
+  )
+  # all updated information about the charge is now available
+  p charge
+rescue Exception => e
+  # errors here can be
+  # Response::NotFound if the charge ID does not exist
+  # Response::BadRequest if there was something wrong with the request
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+
+
+
+
+# deletes an existing charge
+#  deletes the charge, cancels all future transactions that were scheduled for this charge
+puts "", "Delete Charges"
+
+begin
+  # find the charge first
+  charge = Recharge::Charge.find(chargeID)
+  # call destroy on it to delete it
+  charge.destroy
+rescue Exception => e
+  puts ">> error #{e.message}"
+end

data/examples/customer.rb

@@ -0,0 +1,166 @@
+# Examples for the Recharge API Gem
+# Charge 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"
+
+
+
+
+
+
+
+
+# Get a list of all active customers
+puts "Find All Customers",''
+
+begin
+  # call find_all to get a list of all customers
+  Recharge::Customer.find_all.each do |customer|
+    
+    # attributes can be accessed individually like this
+    puts "id: #{customer.id}"
+    puts "name: #{customer.firstName} #{customer.lastName}"
+    puts "email: #{customer.email}"
+    
+    # or you may inspect the whole record and get a list of all keys/values like this
+    p customer
+    
+    customerID = customer.id
+    
+    # each customer record has many payMethods (stored card numbers or bank accounts), so make sure you loop through these
+    customer.payMethods.each do |paymethod|
+      puts ">> paymethod id: #{paymethod.id}"
+      puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
+    end
+    
+    # each customer record has many charges, same as payMethods
+    customer.charges.each do |charge|
+      puts ">> charge id: #{charge.id}"
+      puts ">> payment plan: #{charge.price} charged every #{charge.intervalValue} #{charge.intervalUnit}", ''
+    end
+  end
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+# Find an individual customer by the customer ID
+puts "", "Find Individual Customers"
+
+begin
+  # Records are fetched by their unique identifiers.
+  customer = Recharge::Customer.find(customerID)
+  
+  puts "id: #{customer.id}"
+  puts "name: #{customer.firstName} #{customer.lastName}"
+  puts "email: #{customer.email}"
+  
+  customer.payMethods.each do |paymethod|
+    puts ">> paymethod id: #{paymethod.id}"
+    puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
+  end
+  customer.charges.each do |charge|
+    puts ">> charge id: #{charge.id}"
+    puts ">> payment plan: #{charge.price} charged every #{charge.intervalValue} #{charge.intervalUnit}"
+  end
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+
+
+
+
+# create a new customer
+puts "", "Create New Customer"
+
+begin
+  # customers can be created in one fell swoop
+  customer = Recharge::Customer.create(
+    :firstName => "Eric",
+    :lastName=> "Cardin",
+    :email=> "email@rechargebilling.com"
+  )
+  
+  # after the customer is saved, all attributes are available for you individually or by inspecting
+  customerID = customer.id
+  p customer
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+# Update an existing customer (change email address, phone number, etc)
+puts "", "Update Customer"
+
+begin
+  # you must find the charge id first
+  customer = Recharge::Customer.find(customerID)
+  
+  # then call update on it
+  # you only need to pass the attributes you want to update
+  customer.update(
+    :refID=> Time.now.to_i
+  )
+  
+  # all updated information about the charge is now available
+  p customer
+rescue Exception => e
+  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
+  customer = Recharge::Customer.find(customerID)
+  customer.destroy
+rescue Exception => e
+  puts ">> error #{e.message}"
+end

data/examples/paymethod.rb

@@ -0,0 +1,30 @@
+require '../lib/recharge'
+
+Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
+
+puts "", "Create New PayMethod"
+
+begin
+  paymethod = Recharge::PayMethod.create(
+    :customer => "cu4f3782bf374a7",
+    :nameOnCard => "test jones",
+    :cardNumber => "4242424242424242",
+    :expDate => "1212"
+  )
+  paymethodID = paymethod.id
+  puts ">> paymethod id: #{paymethod.id}"
+  puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
+  p paymethod
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+puts "", "Delete PayMethod"
+
+begin
+  Recharge::PayMethod.destroy(paymethodID)
+rescue Exception => e
+  puts ">> error #{e.message}"
+end

data/examples/product.rb

@@ -0,0 +1,74 @@
+require '../lib/recharge'
+
+Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
+
+productID = ""
+
+puts "Find All Products",''
+
+begin
+  Recharge::Product.find_all.each do |product|
+    puts "id: #{product.id}"
+    puts "name: #{product.name}"
+    puts "price: #{product.price}"
+    
+    productID = product.id
+  end
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+puts "", "Find Individual Products"
+
+begin
+  product = Recharge::Product.find(productID)
+  
+  puts "id: #{product.id}"
+  puts "name: #{product.name}"
+  puts "price: #{product.price}"
+
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+puts "", "Create New Product"
+
+begin
+  product = Recharge::Product.create(
+    :name => "HeyHey",
+    :price => "100",
+    :intervalValue => 1,
+    :intervalUnit => 'm'
+  )
+  productID = product.id
+  p product
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+puts "", "Update Product"
+
+begin
+  product = Recharge::Product.find(productID)
+  product.update(
+    :price=> "101"
+  )
+  p product
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+puts "", "Delete Product"
+
+begin
+  product = Recharge::Product.find(productID)
+  product.destroy
+rescue Exception => e
+  puts ">> error #{e.message}"
+end

data/examples/transaction.rb

@@ -0,0 +1,76 @@
+require '../lib/recharge'
+
+Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
+
+puts "", "Credit Card Purchase"
+
+begin
+  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
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+puts "", "Credit Card Refund (with card number)"
+
+begin
+  transaction = Recharge::Transaction.refund(
+    :Amount => "#{rand(100)}.#{rand(100)}",
+    :AcctNum => "4111111111111111",
+    :ExpDate => "1212"
+  )
+puts transaction.responseDescription, transaction.amount, transaction.approvalCode
+p transaction
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+puts "", "Credit Card Refund (without card number)"
+
+begin
+  transaction = Recharge::Transaction.refund(
+    :TransactionID => transactionID,
+    :Amount => "0.#{rand(100)}"
+  )
+puts transaction.responseDescription, transaction.amount, transaction.approvalCode
+p transaction
+
+transactionID = transaction.transactionID
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+
+
+
+
+
+
+puts "", "Credit Card Void"
+
+begin
+  transaction = Recharge::Transaction.void(
+    :TransactionID => transactionID
+  )
+puts transaction.responseDescription, transaction.amount, transaction.approvalCode
+p transaction
+rescue Exception => e
+  puts ">> error #{e.message}"
+end
+

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Recharge
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Recharge
@@ -14,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-15 00:00:00 -08:00
-default_executable: 
+date: 2012-02-15 00:00:00 Z
 dependencies: []
 
 description: An API client library for Recharge http://rechargebilling.com
@@ -41,8 +41,11 @@ files:
 - lib/recharge/response.rb
 - lib/recharge/transaction.rb
 - lib/recharge.rb
-- lib/test.rb
-has_rdoc: true
+- examples/charge.rb
+- examples/customer.rb
+- examples/paymethod.rb
+- examples/product.rb
+- examples/transaction.rb
 homepage: http://rechargebilling.com/api
 licenses: []
 
@@ -52,23 +55,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Recharge API Client

data/lib/test.rb

@@ -1,520 +0,0 @@
-module Recharge
-  require 'happymapper'
-  
-  class << self
-    def api_key
-      defined? @api_key and @api_key
-    end
-    attr_writer :api_key
-  end
-  
-  class PayMethod
-    include HappyMapper
-    
-    tag 'payMethod'
-    
-    element :id, String
-    element :alias, String
-    element :cardType, String
-    element :last4, String
-    element :expDate, String
-    element :nameOnCard, String
-  end
-  
-  class Customer
-    include HappyMapper
-    
-    tag 'customer'
-
-    element :id, String
-    element :refID, String
-    element :firstName, String
-    element :lastName, String
-    element :email, String
-    element :company, String
-    element :phone, String
-    element :billingAddress1, String
-    element :billingAddress2, String
-    element :billingCity, String
-    element :billingState, String
-    element :billingZIP, String
-    element :shippingAddress1, String
-    element :shippingAddress2, String
-    element :shippingCity, String
-    element :shippingState, String
-    element :shippingZIP, String
-    element :emailOption, String
-    element :signupDate, String
-    
-    has_many :payMethods, PayMethod
-    
-    def initialize(id='')
-      @id = id
-    end
-    def self.find_all
-      responseXML = get('customers')
-      parse(responseXML.to_s)
-    end
-    def self.find (id)
-      responseXML = get('customers/'+id)
-      parse(responseXML.to_s)
-    end
-    def self.create (attributes = {})
-      responseXML = post('customers', attributes)
-      parse(responseXML.to_s)
-    end
-    def update (attributes = {})
-      responseXML = post('customers/'+self.id, attributes)
-      Customer.parse(responseXML.to_s)
-    end
-    def destroy (attributes = {})
-      responseXML = delete('customers/'+self.id)
-    end
-  end
-  
-  class Product
-    include HappyMapper
-    
-    tag 'product'
-
-    element :id, String
-    element :name, String
-    element :setupFee, String
-    element :price, String
-    element :intervalValue, String
-    element :intervalUnit, String
-    
-    def initialize(id='')
-      @id = id
-    end
-    def self.find_all
-      responseXML = get('products')
-      parse(responseXML.to_s)
-    end
-    def self.find (id)
-      responseXML = get('products/'+id)
-      parse(responseXML.to_s)
-    end
-    def self.create (attributes = {})
-      responseXML = post('products', attributes)
-      parse(responseXML.to_s)
-    end
-    def update (attributes = {})
-      responseXML = post('products/'+self.id, attributes)
-      Product.parse(responseXML.to_s)
-    end
-    def destroy (attributes = {})
-      responseXML = delete('products/'+self.id)
-    end
-  end
-  
-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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-class Client
-  
-  def baseURL
-    "https://www.rechargebilling.com/API/v2/"
-  end
-  
-  def request(method, uri, data=nil)
-    response = sendRequest(method, uri, data)
-    response.assertValidResponse
-    if response.code.to_i == 200
-      if method != "DELETE"
-        returnImportantXML(response.body)
-      else
-        returnStatusXML(response.body)
-      end
-    else 
-      returnErrorXML(response.body)
-    end
-    
-  end
-  
-  def sendRequest(method, uri, data=nil)
-    require "net/https"
-    require "uri"
-    
-    if !Recharge.api_key
-      puts "no api key"
-      return
-    end
-    
-    uri = baseURL+uri
-    uri = URI.parse(uri)
-    
-    if method == "GET"
-      request = Net::HTTP::Get.new(uri.request_uri)
-    end
-    
-    if method == "POST"
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.set_form_data(data)
-    end
-    
-    if method == "DELETE"
-      request = Net::HTTP::Delete.new(uri.request_uri)
-    end
-    
-    request.basic_auth(Recharge.api_key, "")
-    
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    
-    response = http.request(request)
-    
-    return Response.new(response.code, response.body)
-
-  end
-end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-class Response
-  def initialize(code, body)
-    @code = code
-    @body = body
-  end
-  def code
-    @code
-  end
-  def body
-    @body
-  end
-  
-  class NotFound < StandardError
-  end 
-  
-  class BadRequest < StandardError
-  end  
-
-  def assertValidResponse
-    case @code.to_i
-    when 200
-        return
-    when 400
-        raise NotFound, returnErrorXML(@body)
-    when 404
-        raise NotFound, returnErrorXML(@body)
-    end
-  end
-end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Recharge.api_key = "92ec3e4d8b623dd9baaaf1575b7c557cd113e3e8"
-
-customerID = ""
-
-puts "Find All Customers"
-
-begin
-  Recharge::Customer.find_all.each do |customer|
-    puts "id: #{customer.id}"
-    puts "name: #{customer.firstName} #{customer.lastName}"
-    puts "email: #{customer.email}"
-    
-    customerID = customer.id
-    
-    customer.payMethods.each do |paymethod|
-      puts ">> paymethod id: #{paymethod.id}"
-      puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
-    end
-  end
-rescue Exception => e
-  puts ">> error #{e.message}"
-end
-
-
-
-puts "", "Find Individual Customers"
-
-begin
-  customer = Recharge::Customer.find(customerID)
-  
-  puts "id: #{customer.id}"
-  puts "name: #{customer.firstName} #{customer.lastName}"
-  puts "email: #{customer.email}"
-  
-  customer.payMethods.each do |paymethod|
-    puts ">> paymethod id: #{paymethod.id}"
-    puts ">> card number: #{paymethod.cardType} ****#{paymethod.last4}"
-  end
-rescue Exception => e
-  puts ">> error #{e.message}"
-end
-
-
-
-puts "", "Create New Customer"
-
-begin
-  customer = Recharge::Customer.create(
-    :firstName => "Eric",
-    :lastName=> "Cardin",
-    :email=> "email@rechargebilling.com",
-    :bad=> "bad"
-  )
-  customerID = customer.id
-  p customer
-rescue Exception => e
-  puts ">> error #{e.message}"
-end
-
-
-
-puts "", "Update Customer"
-
-begin
-  customer = Recharge::Customer.find(customerID)
-  customer.update(
-    :refID=> Time.now.to_i
-  )
-  p customer
-rescue Exception => e
-  puts ">> error #{e.message}"
-end
-
-
-
-puts "", "Delete Customer"
-
-begin
-  customer = Recharge::Customer.find(customerID)
-  customer.destroy
-rescue Exception => e
-  puts ">> error #{e.message}"
-end