pay_simple 0.0.1

data/lib/ps/exceptions.rb

@@ -0,0 +1,5 @@
+module PS
+  class RequestError < Exception; end
+  class ConnectionError < Exception; end
+  class CreditCardError < Exception; end
+end

data/lib/ps/object.rb

@@ -0,0 +1,48 @@
+module PS
+  class Object < Base
+    attr_accessor :ps_reference_id
+
+    def initialize(params = {})
+      set_attributes(params)
+    end
+
+    def attributes
+      attributes_hash = {}
+      self.instance_variables.each do |v|
+        attributes_hash[v[1..-1].to_sym] = self.send(v[1..-1])
+      end
+      attributes_hash
+    end
+
+    def set_attributes(params={})
+      params.each do |k, v|
+        next unless self.class.method_defined?(k)
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    def to_s
+      attrs = self.attributes.to_a.map { |k_v| 
+        case k_v[1]
+          when Fixnum
+            "#{k_v[0]}: #{k_v[1]}" 
+          when String || Time
+            "#{k_v[0]}: '#{k_v[1]}'" unless k_v[1].empty?
+        end
+
+      }.delete_if(&:nil?).join(", ")
+      "#<#{self.class} #{attrs}>"
+    end
+
+    private
+      #this block will fail if more than one PS::Object is returned.
+      def update_self
+        Proc.new { |response|  set_attributes(response.ps_object) }
+      end
+
+      def self.instantiate_object
+        Proc.new { |response| PS::Util.instantiate_ps_objects(response.ps_object) }
+      end
+
+  end
+end

data/lib/ps/objects/ach_account.rb

@@ -0,0 +1,34 @@
+module PS
+  class AchAccount < CustomerAccount
+    attr_accessor :is_checking_account, :routing_number, :account_number, :bank_name 
+
+    def self.create(params={})
+      aa = self.new(params)
+      aa.save
+      return aa
+    end
+
+    def save
+      begin
+        save!()
+        true
+      rescue Exception
+        false
+      end
+    end
+
+    def save!
+      request("addcustomerachaccount", { :customerAccount => attributes }, &update_self)
+    end
+
+    def update
+      request("updatecustomerachaccount", { :customerAccount => attributes })
+      true
+    end
+
+    def delete
+      request("deletecustomerachaccount", { :accountId => self.ps_reference_id })
+      true
+    end
+  end
+end

data/lib/ps/objects/credit_card_account.rb

@@ -0,0 +1,38 @@
+module PS
+  class CreditCardAccount < CustomerAccount
+    attr_accessor :c_c_expiry, :c_c_type, :account_number
+
+    def save
+      begin
+        save!()
+        true
+      rescue Exception
+        false
+      end
+    end
+
+    def save!
+      request("addcustomercreditcardaccount", { :customerAccount => attributes }, &update_self)
+    end
+
+    def update
+      request("updatecustomercreditcardaccount", { :customerAccount => attributes() })
+      true
+    end
+
+    def delete
+      request("deletecustomercreditcardaccount", { :accountId => self.ps_reference_id })
+      true
+    end
+
+    def self.default_for_customer_id(customer_id)
+      request("getdefaultcreditcardaccount", { :customerId => customer_id }, &instantiate_object)
+    end
+
+    def self.create(params={})
+      cc = self.new(params)
+      cc.save()
+      return cc
+    end
+  end
+end

data/lib/ps/objects/customer.rb

@@ -0,0 +1,79 @@
+module PS
+  class Customer < Object
+    attr_accessor :first_name,:middle_name,:last_name,:email,:alt_email,:phone,:alt_phone,:fax,:web_site,:billing_address1,:billing_address2,:billing_city,:billing_state,:billing_postal_code,:billing_country_code,:shipping_same_as_billing,:shipping_address1,:shipping_address2,:shipping_city,:shipping_state,:shipping_postal_code,:shipping_country_code,:company_name,:notes,:last_modified,:created_on
+
+    def save
+      begin
+        save!()
+        true
+      rescue Exception
+        false
+      end
+    end
+
+    def save!
+      request("addcustomer", { :customer => attributes }, &update_self)
+    end
+
+    def destroy
+      if self.ps_reference_id then
+        request("deletecustomer", { :id => self.ps_reference_id } ) 
+        true
+      else
+        false
+      end
+    end
+
+    def payments
+      Payment.find(self.ps_reference_id)
+    end
+
+    def set_default_customer_account(account_id)
+      CustomerAccount.find(account_id).make_default
+    end
+
+    def default_customer_account
+      CustomerAccount.default(self.ps_reference_id)
+    end
+
+    def default_credit_card_account
+      CreditCardAccount.default_for_customer_id(self.ps_reference_id)
+    end
+
+    class << self
+      #returns [ PS::Customer, PS::CustomerAccount, PS::Payment ]
+      def create_and_make_cc_payment(customer={}, account={}, amount=0.0, cid="")
+        request("addcustomerandmakeccpayment", {
+          :customer => customer, 
+          #account must have a customer_id of 0
+          :customerAccount => account, 
+          :amount => amount, 
+          :cid => cid
+        }, &instantiate_object)
+      end
+
+      def create_and_make_ach_payment(customer={}, account={}, amount=0.0, cid="")
+        request("addcustomerandmakeachpayment", {
+          :customer => customer, 
+          :customerAccount => account, 
+          :amount => amount, 
+          :cid => cid
+        }, &instantiate_object)
+      end
+
+      def get_customer_and_default_accounts(customer_id)
+        request("GetCustomerAndDefaultAccounts", { :customerId => customer_id }, &instantiate_object)
+      end
+
+      def find(id)
+        request("getcustomer", { :id => id }, &instantiate_object)
+      end
+
+      def create(options={})
+        customer = self.new(options)
+        customer.save()
+        return customer
+      end
+    end
+  end
+end

data/lib/ps/objects/customer_account.rb

@@ -0,0 +1,25 @@
+module PS
+  class CustomerAccount < Object
+    attr_accessor :customer_id
+
+    def make_default
+      request("SetDefaultCustomerAccount", 
+        { 
+          :customerId => self.customer_id, 
+          :customerAccountId => self.ps_reference_id 
+        }
+      )
+    end
+
+    class << self 
+      def find(account_id, customer_id)
+        #The name of this method in Paysimple is sooo misleading...
+        request("GetCustomerAccountByAccountId", { :accountId => account_id, :customerId => customer_id }, &instantiate_object)
+      end
+
+      def default(customer_id)
+        request("GetDefaultCustomerAccount", { :customerId => customer_id }, &instantiate_object)
+      end
+    end
+  end
+end

data/lib/ps/objects/payment.rb

@@ -0,0 +1,73 @@
+module PS
+  class Payment < Object
+    attr_accessor :ref_payment_id,:customer_id,:customer_account_id,:amount,:status,:payment_date,:invoice_id,:recurring_schedule_id,:is_debit,:payment_type,:payment_sub_type,:provider_auth_code,:trace_number,:estimate_settled_date,:actual_settled_date,:can_void_until,:invoice_number,:purchase_order_number,:order_id,:description 
+
+    def cancel
+      request("cancelpayment", { :paymentId => self.ps_reference_id }, &update_by_find)
+    end
+
+    def reverse
+      request("reversepayment", { :paymentId => self.ps_reference_id }, &update_by_find)
+    end
+
+    class << self 
+      def list(customer_id, criteria=nil)
+        request("listpayments", { :customerId => customer_id, :criteria => criteria }, &instantiate_object)
+      end
+      
+      def reverse_by_id(payment_id)
+        request("reversepayment", { :paymentId => payment_id })
+        true
+      end
+
+      def cancel_by_id(payment_id)
+        request("cancelpayment", { :paymentId =>  payment_id })
+        true
+      end
+
+      def make(customer_id, amount, account_id=nil, cid="", order_details=nil)
+        request("makepayment", 
+          {
+            :customerId => customer_id,
+            :customerAccountId => account_id,
+            :amount => amount,
+            :cid => cid,
+            :detail => order_details 
+          }, &instantiate_object)
+      end
+    end
+
+    private
+      def update_by_find
+        Proc.new do
+          i = 0
+          loop do
+            payments = self.class
+            .list(self.customer_id, { :page => i, :items_per_page => 200 })
+            case payments
+            when []
+              break
+            when Array
+              updated = false
+              payments.each do |payment|
+                if payment.ps_reference_id == self.ps_reference_id then
+                  set_attributes(payment.attributes) 
+                  updated = true
+                  break
+                end
+              end
+              break if updated
+            when PS::Payment
+              if payments.ps_reference_id == self.ps_reference_id then
+                set_attributes(payments.attributes) 
+              end
+              # break here because if only one payment is returned, then it's
+              # only one that exists or it is the last one...
+              break
+            end
+            i += 1
+          end
+        end
+      end
+  end
+end

data/lib/ps/objects/payment_status_filter.rb

@@ -0,0 +1,6 @@
+module PS
+  class PaymentStatusFilter < Object
+    attr_accessor :all, :pending, :posted, :settled, :failed, :resubmitted, :voided, :reversed, :saved, :scheduled, :reverse_posted, :charge_back, :close_charge_back, :authorized, :returned, :reverse_charge_back, :reverse_NSF, :reverse_return, :refund_settled
+    
+  end
+end

data/lib/ps/objects/recurring_payment.rb

@@ -0,0 +1,60 @@
+module PS
+  class RecurringPayment < Object
+    attr_accessor :customer_id, :customer_account_id, :schedule_type, :start_date, :has_end_date, :end_date, :billing_frequency_type, :billing_frequency_param, :payment_amount, :first_payment_done, :first_payment_amount, :first_payment_date, :total_due_amount, :total_number_of_payments, :balance_remaining, :number_of_payments_remaining, :invoice_no, :order_id, :description, :schedule_status, :number_of_payment_made, :total_amount_paid, :date_of_last_payment_made, :pause_until_date
+
+    def save
+      begin 
+        save!()
+        true
+      rescue Exception
+        false
+      end
+    end
+
+    def save!
+      request("addrecurringpayment", { :recurringPayment => attributes }, &update_self)
+    end
+
+    def update
+      request("modifyrecurringpaymentschedule", { :paymentSchedule => attributes })
+      true
+    end
+
+    def suspend
+      request("suspendrecurringpaymentschedule", { :scheduleId => self.ps_reference_id }, &update_self)
+      true
+    end
+
+    def resume
+      request("resumerecurringpaymentschedule", { :scheduleId => self.ps_reference_id }, &update_self)
+      true
+    end
+
+    def destroy
+      request("deleterecurringschedule", { :scheduleId => self.ps_reference_id })
+      true
+    end	
+
+    def self.create(params={})
+      recurring_payment = new(params)
+      recurring_payment.save()
+      return recurring_payment
+    end
+
+    def self.list(start_date, end_date, customer_id, criteria=nil, filter={}) 
+      criteria ||= { :Page => 1, :items_per_page => 12 }
+      request("listrecurringpayments", 
+              {
+                :startDate => start_date,
+                :endDate => end_date,
+                :customerId => customer_id,
+                :filter => filter,
+                :criteria => criteria
+              }, &instantiate_object)
+    end
+
+    def self.find(schedule_id)
+      request("GetRecurringPaymentSchedule", { :scheduleId => schedule_id }, &instantiate_object)
+    end
+  end
+end

data/lib/ps/objects/recurring_payment_filter.rb

@@ -0,0 +1,26 @@
+module PS
+	class RecurringPaymentFilter < PsObject
+		attr_accessor :active, :disabled, :paused, :expired, :suspended
+    
+    def active?
+      self.active
+    end
+
+    def disabled?
+      self.disabled
+    end
+
+    def paused?
+      self.paused
+    end
+
+    def expired?
+      self.expired
+    end
+
+    def suspended?
+      self.suspended
+    end
+    
+	end
+end

data/lib/ps/objects/user.rb

@@ -0,0 +1,10 @@
+module PS
+  class User < Object
+    attr_accessor :ps_reference_id, :first_name, :last_name, :company, :email, :phone
+    
+    #NOTE: This doesn't work in paysimple... 
+    def self.get
+      request("getuserinfo", &instantiate_object)
+    end
+  end
+end

data/lib/ps/response.rb

@@ -0,0 +1,83 @@
+module PS 
+  class Response < Base
+    attr_accessor :is_success,:error_message,:sub_type,:ps_object,:total_items,:items_per_page,:current_page,:error_type,:exception_detail
+
+    #### Some Basic fields returned by Paysimple
+    # {
+    ## '__type' => String,
+    ## 'CurrentPage => Int,
+    ## 'ErrorMessage => String
+    ## 'ErrorType' => Int,
+    ## 'IsSuccess' => boolean,
+    ## 'itemsPerPage' => Int,
+    ## 'PsObject' => [
+    ### { ... },
+    ### ...
+    ## ],
+    ## 'SubType' => String, 
+    ## 'TotalItems' => Int
+    # }
+
+    ## God this is terribly worded...
+    # After the format classes; JSON, XML, SOAP, etc; get a response from 
+    # Paysimple, the response should be parsed from the respective format into
+    # a ruby hash. That hash is then passed here, and the response is setup. 
+    # example: 
+    #   post_response = HTTParty.post("https://api.paysimple.com/3.00/paysimpleapi", options_hash(params))
+    #   parsed_response = post_response.parsed_response['d'] #the 'd' key is specific to the json format
+    #   Response.new(parsed_response) 
+    def initialize(params={})
+      params.each { |k,v| instance_variable_set("@#{k.to_snake_case}", v) }
+      successful_request?()
+      @ps_object ||= [] 
+      parse_ps_object()
+      self
+    end
+
+    private 
+      ##
+      # Checks for errors in the PsResponse.
+      def successful_request?
+        raise RequestError, @exception_detail["InnerException"]["Message"] if @exception_detail
+        raise RequestError, @error_message.join("; ") unless @is_success == true
+      end
+
+      def parse_ps_object()
+        snake_case_ps_object_keys()
+        parse_object_dates()
+        if @ps_object.length == 1 then
+          @ps_object = @ps_object.first
+        end
+      end
+
+      ##
+      # Paysimple returns the attribute names in CamelCase, but the attributes use
+      # snake_case within the code base. The method bellow converts the attribute 
+      # names into snake_case so that they can be more easily dynamically assigned
+      # to the appropriate class.
+      def snake_case_ps_object_keys
+        # this line might seem a bit odd, but it is necessary because there
+        # are two paysimple methods that, depending on the context, will 
+        # return @ps_object where one of the elements is an instance of 
+        # NilClass.
+        @ps_object.delete_if(&:nil?)
+        @ps_object.map!(&:snake_case_keys)
+      end
+
+      ##
+      # parses date fields into a rubyesque format.
+      def parse_object_dates
+        @ps_object.each_with_index do |object, i|
+          object.each do |key, value|
+            # here we are asking the format class if the value is a date in its
+            # format. For Example, the json format class returns dates in the 
+            # following format: "/Date(1248908403000-0600)/"
+            if date?(value) then
+              # if so, then we now ask the format class how to parse that date.
+              @ps_object[i][key] = parse_date(value)
+            end
+          end
+        end
+      end
+  end
+end