adaptive_pay 0.1.0

data/lib/adaptive_pay/request.rb

@@ -0,0 +1,120 @@
+require "net/http"
+require "net/https"
+require 'bigdecimal/util'
+
+module AdaptivePay
+  class Request
+
+    def self.response_type
+      :other
+    end
+
+    class_inheritable_accessor :attributes
+    self.attributes = []
+
+    def self.attribute(name, options={})
+      top_level_name = name.to_s.split(".").last.underscore
+      define_method top_level_name do
+        read_attribute name
+      end
+
+      define_method "#{top_level_name}=" do |value|
+        write_attribute name, value
+      end
+
+      self.attributes << options.merge(:name => name)
+    end
+
+    def self.attribute_names
+      self.attributes.map { |a| a[:name] }
+    end
+
+
+    def initialize(&block)
+      @attributes = {}
+      self.class.attributes.each do |k|
+        write_attribute k[:name], k[:default] if k[:default]
+      end
+      yield self if block_given?
+    end
+
+    def read_attribute(name)
+      @attributes[name]
+    end
+
+    def format_attribute(name)
+      attrib = self.class.attributes.find { |a| a[:name] == name }
+      case
+      when attrib.nil?
+        nil
+      when attrib[:format] == :date
+        @attributes[name].strftime("%Y-%m-%d")
+      else
+        @attributes[name]
+      end
+    end
+
+    def write_attribute(name, value)
+      @attributes[name] = value
+    end
+
+
+    def perform(interface)
+      uri = construct_uri(interface)
+      request = Net::HTTP::Post.new uri.request_uri
+      request.body = serialize
+      request.initialize_http_header(headers(interface))
+      http_response = build_http(uri).request request
+      Response.new interface, self.class.response_type, http_response
+    end
+
+    def serialize
+      result = []
+      all_attributes.each do |k, v|
+        result << "#{k}=#{URI.escape(v.to_s)}"
+      end
+      result.join("&")
+    end
+
+    protected
+      def construct_uri(interface)
+        if interface.base_url.ends_with?("/")
+          URI.parse("#{interface.base_url}#{self.class.endpoint}")
+        else
+          URI.parse("#{interface.base_url}/#{self.class.endpoint}")
+        end
+      end
+
+      def build_http(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.port == 443)
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http
+      end
+
+      def headers(interface)
+        {
+          "X-PAYPAL-SECURITY-USERID" => interface.username.to_s,
+          "X-PAYPAL-SECURITY-PASSWORD" => interface.password.to_s,
+          "X-PAYPAL-SECURITY-SIGNATURE" => interface.signature.to_s,
+          "X-PAYPAL-APPLICATION-ID" => interface.application_id.to_s,
+          "X-PAYPAL-REQUEST-DATA-FORMAT" => "NV",
+          "X-PAYPAL-RESPONSE-DATA-FORMAT" => "NV"
+        }
+      end
+
+      def all_attributes
+        result = {}
+        self.class.attribute_names.each do |name|
+          value = read_attribute(name)
+          result[name] = format_attribute(name) unless value.nil?
+        end
+        result.merge(extra_attributes)
+      end
+
+      def extra_attributes
+        {}
+      end
+
+  end
+end

data/lib/adaptive_pay/response.rb

@@ -0,0 +1,70 @@
+module AdaptivePay
+  class Response
+
+    def initialize(interface, type, response)
+      @type = type
+      @base_page_url = interface.base_page_url
+      @attributes = {}
+      parse response
+    end
+
+    def success?
+      !!@success
+    end
+
+    def failure?
+      !@success
+    end
+
+
+    def created?
+      payment_exec_status == "CREATED"
+    end
+
+    def pending?
+      payment_exec_status == "PENDING"
+    end
+
+    def completed?
+      payment_exec_status == "COMPLETED"
+    end
+
+
+    def payment_page_url
+      case @type
+      when :preapproval
+        "#{@base_page_url}/webscr?cmd=_ap-preapproval&preapprovalkey=#{URI.escape(preapproval_key)}"
+      when :payment
+        "#{@base_page_url}/webscr?cmd=_ap-payment&paykey=#{URI.escape(pay_key)}"
+      end
+    end
+
+    def read_attribute(name)
+      @attributes[name]
+    end
+
+    def method_missing(name, *args)
+      if @attributes.has_key?(name.to_s.camelize(:lower))
+        @attributes[name.to_s.camelize(:lower)]
+      else
+        super
+      end
+    end
+
+    protected
+      def parse(response)
+        unless response.code.to_s == "200"
+          @success = false
+          return
+        end
+
+        response.body.to_s.split("&").each do |fragment|
+          k, v = fragment.split("=")
+          @attributes[k] = URI.unescape(v)
+        end
+
+        @success = %w{Success SuccessWithWarning}.include?(read_attribute("responseEnvelope.ack"))
+      end
+
+  end
+end

data/lib/adaptive_pay/sender.rb

@@ -0,0 +1,13 @@
+module AdaptivePay
+  class Sender
+
+    attr_accessor :email, :client_ip
+
+    def initialize(options={})
+      options.each do |k, v|
+        send "#{k}=", v
+      end
+    end
+
+  end
+end

data/lib/adaptive_pay.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/interface')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/abstract_payment_request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/preapproval_request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/payment_request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/refund_request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/cancel_preapproval_request')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/response')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/sender')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/recipient')
+require File.expand_path(File.dirname(__FILE__) + '/adaptive_pay/callback')

data/spec/adaptive_pay/abstract_payment_request_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::AbstractPaymentRequest do
+
+  before :each do
+    @payment_request = AdaptivePay::AbstractPaymentRequest.new
+  end
+
+  describe "sender" do
+
+    it "should save sender object" do
+      @payment_request.sender = AdaptivePay::Sender.new :email => "test@paypal.com", :client_ip => "12.23.34.45"
+      @payment_request.sender.should be_a(AdaptivePay::Sender)
+      @payment_request.sender.email.should == "test@paypal.com"
+      @payment_request.sender.client_ip.should == "12.23.34.45"
+    end
+
+    it "should save sender hash" do
+      @payment_request.sender = { :email => "test@paypal.com", :client_ip => "12.23.34.45" }
+      @payment_request.sender.should be_a(AdaptivePay::Sender)
+      @payment_request.sender.email.should == "test@paypal.com"
+      @payment_request.sender.client_ip.should == "12.23.34.45"
+    end
+
+  end
+
+  describe "serialize" do
+
+    it "should include sender details in serialization" do
+      request = AdaptivePay::AbstractPaymentRequest.new
+      request.sender = { :client_ip => "11.22.33.44", :email => "sender@paypal.com" }
+      decompose(request.serialize).should == {
+        "clientDetails.ipAddress" => "11.22.33.44",
+        "senderEmail" => "sender@paypal.com",
+        "requestEnvelope.errorLanguage" => "en_US"
+      }
+    end
+
+  end
+
+end

data/spec/adaptive_pay/callback_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::Callback do
+
+  it "should parse params" do
+    callback = AdaptivePay::Callback.new "txn_id" => "3XC103945N720211C", "invoice" => "923204115", "payment_status" => "Completed"
+    callback.txn_id.should == "3XC103945N720211C"
+    callback.invoice.should == "923204115"
+    callback.payment_status.should == "Completed"
+  end
+
+  it "should identify Completed callback" do
+    callback = AdaptivePay::Callback.new "payment_status" => "Completed"
+    callback.should be_completed
+  end
+
+end

data/spec/adaptive_pay/cancel_preapproval_request_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::CancelPreapprovalRequest do
+
+  before :each do
+    @refund_request = AdaptivePay::CancelPreapprovalRequest.new
+  end
+
+  describe "serialize" do
+
+    it "should include recipient details in serialization" do
+      request = AdaptivePay::CancelPreapprovalRequest.new
+      request.preapproval_key = "PA-12345"
+      decompose(request.serialize).should == {
+        "preapprovalKey" => "PA-12345",
+        "requestEnvelope.errorLanguage" => "en_US"
+      }
+    end
+
+  end
+
+end

data/spec/adaptive_pay/interface_spec.rb

@@ -0,0 +1,184 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::Interface do
+
+  before :each do
+    AdaptivePay::Interface.requests.clear
+    @interface = AdaptivePay::Interface.new false
+    @interface.base_url = "https://paypal.yumshare.com/"
+  end
+
+  describe "initialize" do
+
+    it "should load configuration from adaptive_pay.yml according to" do
+      Rails.stub!(:root).and_return(File.expand_path(File.dirname(__FILE__) + '/../fixtures'))
+      Rails.stub!(:env).and_return("development")
+      interface = AdaptivePay::Interface.new
+      interface.environment.should == :sandbox
+      interface.base_url.should == "https://svcs.sandbox.paypal.com/AdaptivePayments/"
+      interface.username.should == "my_username"
+      interface.password.should == "my_password"
+      interface.signature.should == "my_signature"
+      interface.application_id.should == "my_application_id"
+      interface.should_not be_retain_requests_for_test
+    end
+
+    it "should allow setting environment as a parameter" do
+      Rails.stub!(:root).and_return(File.expand_path(File.dirname(__FILE__) + '/../fixtures'))
+      Rails.stub!(:env).and_return("development")
+      interface = AdaptivePay::Interface.new :production
+      interface.environment.should == :production
+      interface.base_url.should == "https://svcs.paypal.com/AdaptivePayments/"
+      interface.username.should == "my_production_username"
+      interface.password.should == "my_production_password"
+      interface.signature.should == "my_production_signature"
+      interface.should_not be_retain_requests_for_test
+    end
+
+    it "should allow preventing the configuration loading" do
+      interface = AdaptivePay::Interface.new false
+      interface.environment.should be_blank
+      interface.base_url.should be_blank
+      interface.username.should be_blank
+      interface.password.should be_blank
+      interface.signature.should be_blank
+    end
+
+  end
+
+  describe "set_environment" do
+
+    it "should set production environment" do
+      @interface.set_environment :production
+      @interface.environment.should == :production
+      @interface.base_url.should == "https://svcs.paypal.com/AdaptivePayments/"
+      @interface.base_page_url.should == "https://www.paypal.com"
+    end
+
+    it "should set sandbox environment" do
+      @interface.set_environment :sandbox
+      @interface.environment.should == :sandbox
+      @interface.base_url.should == "https://svcs.sandbox.paypal.com/AdaptivePayments/"
+      @interface.base_page_url.should == "https://www.sandbox.paypal.com"
+    end
+
+    it "should set beta_sandbox environment" do
+      @interface.set_environment :beta_sandbox
+      @interface.environment.should == :beta_sandbox
+      @interface.base_url.should == "https://svcs.beta-sandbox.paypal.com/AdaptivePayments/"
+      @interface.base_page_url.should == "https://www.beta-sandbox.paypal.com"
+    end
+
+  end
+
+  describe "request_preapproval" do
+
+    before :each do
+      @interface.retain_requests_for_test = true
+    end
+
+    it "should enqueue request if retain_requests_for_test is set" do
+      request = nil
+      @interface.request_preapproval do |r|
+        request = r
+      end
+      AdaptivePay::Interface.requests.size.should == 1
+      AdaptivePay::Interface.requests.first.should == request
+    end
+
+    it "should allow providing pre canned responses" do
+      response = mock(:response)
+      AdaptivePay::Interface.test_response = response
+      @interface.request_preapproval { |r|  }.should == response
+    end
+
+    it "should use passed block to build request" do
+      called = false
+      @interface.request_preapproval do |p|
+        called = true
+        p.should be_a(AdaptivePay::PreapprovalRequest)
+      end
+      called.should be_true
+    end
+
+  end
+
+  describe "request_payment" do
+
+    before :each do
+      @interface.retain_requests_for_test = true
+    end
+
+    it "should enqueue request if retain_requests_for_test is set" do
+      request = nil
+      @interface.request_payment do |r|
+        request = r
+      end
+      AdaptivePay::Interface.requests.size.should == 1
+      AdaptivePay::Interface.requests.first.should == request
+    end
+
+    it "should allow providing pre canned responses" do
+      response = mock(:response)
+      AdaptivePay::Interface.test_response = response
+      @interface.request_payment { |r|  }.should == response
+    end
+
+    it "should use passed block to build request" do
+      called = false
+      @interface.request_payment do |p|
+        called = true
+        p.should be_a(AdaptivePay::PaymentRequest)
+      end
+      called.should be_true
+    end
+
+  end
+
+  describe "request_refund" do
+
+    before :each do
+      @interface.retain_requests_for_test = true
+    end
+
+    it "should enqueue request if retain_requests_for_test is set" do
+      request = nil
+      @interface.request_refund do |r|
+        request = r
+      end
+      AdaptivePay::Interface.requests.size.should == 1
+      AdaptivePay::Interface.requests.first.should == request
+    end
+
+    it "should allow providing pre canned responses" do
+      response = mock(:response)
+      AdaptivePay::Interface.test_response = response
+      @interface.request_refund { |r|  }.should == response
+    end
+
+    it "should use passed block to build request" do
+      called = false
+      @interface.request_refund do |p|
+        called = true
+        p.should be_a(AdaptivePay::RefundRequest)
+      end
+      called.should be_true
+    end
+
+  end
+
+  describe "perform" do
+
+    before :each do
+      @interface.retain_requests_for_test = true
+    end
+
+    it "should allow providing pre canned responses" do
+      response = mock(:response)
+      AdaptivePay::Interface.test_response = response
+      @interface.perform(AdaptivePay::PreapprovalRequest.new).should == response
+    end
+
+  end
+
+end

data/spec/adaptive_pay/payment_request_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::PaymentRequest do
+
+  before :each do
+    @payment_request = AdaptivePay::PaymentRequest.new
+  end
+
+  describe "serialize" do
+
+    it "should include recipient details in serialization" do
+      request = AdaptivePay::PaymentRequest.new
+      request.add_recipient :email => "acc@paypal.com", :amount => 100
+      request.add_recipient :email => "primary@paypal.com", :amount => 10, :primary => true
+      decompose(request.serialize).should == {
+        "receiverList.receiver(0).email" => "acc@paypal.com",
+        "receiverList.receiver(0).amount" => "100.00",
+        "receiverList.receiver(0).primary" => "false",
+        "receiverList.receiver(1).email" => "primary@paypal.com",
+        "receiverList.receiver(1).amount" => "10.00",
+        "receiverList.receiver(1).primary" => "true",
+        "actionType" => "PAY",
+        "requestEnvelope.errorLanguage" => "en_US"
+      }
+    end
+
+  end
+
+  describe "add_recipient" do
+
+    it "should add a Recipient to recipients from Recipient" do
+      recipient = AdaptivePay::Recipient.new :email => "recipient@paypal.com",
+                                             :amount => BigDecimal.new("10.00"),
+                                             :primary => false
+      @payment_request.add_recipient recipient
+      @payment_request.recipients.size.should == 1
+      @payment_request.recipients.first.should == recipient
+    end
+
+    it "should add a Recipient to recipients from hash" do
+      @payment_request.add_recipient :email => "recipient@paypal.com",
+                                     :amount => BigDecimal.new("10.00"),
+                                     :primary => false
+      @payment_request.recipients.size.should == 1
+      @payment_request.recipients.first.email.should == "recipient@paypal.com"
+      @payment_request.recipients.first.amount.should == BigDecimal.new("10.00")
+      @payment_request.recipients.first.primary.should == false
+    end
+
+  end
+
+end

data/spec/adaptive_pay/preapproval_request_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::PreapprovalRequest do
+
+  before :each do
+    @request = AdaptivePay::ApprovalRequest.new
+  end
+
+end

data/spec/adaptive_pay/recipient_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::Recipient do
+
+  before :each do
+    @recipient = AdaptivePay::Recipient.new
+  end
+
+  describe "attributes" do
+
+    %w{email amount primary}.each do |attribute|
+      it "should have #{attribute} attribute" do
+        @recipient.send("#{attribute}=", "test")
+        @recipient.send(attribute).should == "test"
+      end
+    end
+
+  end
+
+end

data/spec/adaptive_pay/refund_request_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AdaptivePay::RefundRequest do
+
+  before :each do
+    @refund_request = AdaptivePay::RefundRequest.new
+  end
+
+  describe "serialize" do
+
+    it "should include recipient details in serialization" do
+      request = AdaptivePay::RefundRequest.new
+      request.add_recipient :email => "acc@paypal.com", :amount => 100
+      request.add_recipient :email => "primary@paypal.com", :amount => 10, :primary => true
+      decompose(request.serialize).should == {
+        "receiverList.receiver(0).email" => "acc@paypal.com",
+        "receiverList.receiver(0).amount" => "100.00",
+        "receiverList.receiver(0).primary" => "false",
+        "receiverList.receiver(1).email" => "primary@paypal.com",
+        "receiverList.receiver(1).amount" => "10.00",
+        "receiverList.receiver(1).primary" => "true",
+        "requestEnvelope.errorLanguage" => "en_US"
+      }
+    end
+
+  end
+
+  describe "add_recipient" do
+
+    it "should add a Recipient to recipients from Recipient" do
+      recipient = AdaptivePay::Recipient.new :email => "recipient@paypal.com",
+                                             :amount => BigDecimal.new("10.00"),
+                                             :primary => false
+      @refund_request.add_recipient recipient
+      @refund_request.recipients.size.should == 1
+      @refund_request.recipients.first.should == recipient
+    end
+
+    it "should add a Recipient to recipients from hash" do
+      @refund_request.add_recipient :email => "recipient@paypal.com",
+                                    :amount => BigDecimal.new("10.00"),
+                                    :primary => false
+      @refund_request.recipients.size.should == 1
+      @refund_request.recipients.first.email.should == "recipient@paypal.com"
+      @refund_request.recipients.first.amount.should == BigDecimal.new("10.00")
+      @refund_request.recipients.first.primary.should == false
+    end
+
+  end
+
+end