paypal-express 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,9 +1,19 @@
 = paypal-express
 
-Description goes here.
+Handle PayPal Express Checkout.
+Both instance payment and recurring payment are supported.
+
+== Installation
+
+  gem install paypal-express
+
+== Usage
+
+See Wiki on Github
+https://github.com/nov/paypal-express/wiki
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/paypal.rb

@@ -12,6 +12,14 @@ module Paypal
     :sandbox => 'https://www.sandbox.paypal.com/cgi-bin/webscr'
   }
 
+  def self.endpoint
+    if sandbox?
+      Paypal::ENDPOINT[:sandbox]
+    else
+      Paypal::ENDPOINT[:production]
+    end
+  end
+
   def self.log(message, mode = :info)
     self.logger.send mode, message
   end
@@ -40,6 +48,7 @@ end
 require 'paypal/util'
 require 'paypal/exceptions'
 require 'paypal/base'
+require 'paypal/ipn'
 require 'paypal/nvp/request'
 require 'paypal/nvp/response'
 require 'paypal/express/request'

data/lib/paypal/express/response.rb

@@ -2,12 +2,7 @@ module Paypal
   module Express
     class Response < NVP::Response
       def redirect_uri
-        endpoint = if Paypal.sandbox?
-          Paypal::ENDPOINT[:sandbox]
-        else
-          Paypal::ENDPOINT[:production]
-        end
-        endpoint = URI.parse endpoint
+        endpoint = URI.parse Paypal.endpoint
         endpoint.query = {
           :cmd => '_express-checkout',
           :token => self.token

data/lib/paypal/ipn.rb

@@ -0,0 +1,23 @@
+module Paypal
+  module IPN
+    def self.endpoint
+      _endpoint_ = URI.parse Paypal.endpoint
+      _endpoint_.query = {
+        :cmd => '_notify-validate'
+      }.to_query
+      _endpoint_.to_s
+    end
+
+    def self.verify!(raw_post)
+      response = RestClient.post(
+        endpoint, raw_post
+      )
+      case response.body
+      when 'VERIFIED'
+        true
+      else
+        raise APIError.new(response.body)
+      end
+    end
+  end
+end

data/lib/paypal/nvp/request.rb

@@ -2,20 +2,23 @@ module Paypal
   module NVP
     class Request < Base
       attr_required :username, :password, :signature
-      attr_accessor :version, :endpoint
+      attr_accessor :version
 
       ENDPOINT = {
         :production => 'https://api-3t.paypal.com/nvp',
         :sandbox => 'https://api-3t.sandbox.paypal.com/nvp'
       }
 
-      def initialize(attributes = {})
-        @version = API_VERSION
-        @endpoint = if Paypal.sandbox?
+      def self.endpoint
+        if Paypal.sandbox?
           ENDPOINT[:sandbox]
         else
           ENDPOINT[:production]
         end
+      end
+
+      def initialize(attributes = {})
+        @version = API_VERSION
         super
       end
 
@@ -37,7 +40,7 @@ module Paypal
       private
 
       def post(method, params)
-        RestClient.post(self.endpoint, common_params.merge(params).merge(:METHOD => method))
+        RestClient.post(self.class.endpoint, common_params.merge(params).merge(:METHOD => method))
       end
 
       def handle_response

data/spec/fake_response/IPN/invalid.txt

@@ -0,0 +1 @@
+INVALID

data/spec/fake_response/IPN/valid.txt

@@ -0,0 +1 @@
+VERIFIED

data/spec/helpers/fake_response_helper.rb

@@ -2,16 +2,22 @@ require 'fakeweb'
 
 module FakeResponseHelper
 
-  def fake_response(file_path, options = {})
-    Paypal::NVP::Request::ENDPOINT.each do |env, endpoint|
-      FakeWeb.register_uri(
-        :post,
-        endpoint,
-        options.merge(
-          :body => File.read(File.join(File.dirname(__FILE__), '../fake_response', "#{file_path}.txt"))
-        )
-      )
+  def fake_response(file_path, api = :NVP, options = {})
+    endpoint = case api
+    when :NVP
+      Paypal::NVP::Request.endpoint
+    when :IPN
+      Paypal::IPN.endpoint
+    else
+      raise "Non-supported API: #{api}"
     end
+    FakeWeb.register_uri(
+      :post,
+      endpoint,
+      options.merge(
+        :body => File.read(File.join(File.dirname(__FILE__), '../fake_response', "#{file_path}.txt"))
+      )
+    )
   end
 
   def request_to(endpoint, method = :get)

data/spec/paypal/express/request_spec.rb

@@ -53,7 +53,7 @@ describe Paypal::Express::Request do
 
   describe '.new' do
     context 'when any required parameters are missing' do
-      it 'should raise AttrMissing exception' do
+      it 'should raise AttrRequired::AttrMissing' do
         attributes.keys.each do |missing_key|
           insufficient_attributes = attributes.reject do |key, value|
             key == missing_key

data/spec/paypal/express/response_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper.rb'
 
 describe Paypal::Express::Response do
-  before do
-    fake_response 'SetExpressCheckout/success'
-  end
-
   let :instance do
     request = Paypal::Express::Request.new(
       :username => 'nov',
@@ -21,11 +17,13 @@ describe Paypal::Express::Response do
 
   describe '#redirect_uri' do
     it 'should return express-checkout redirect endpoint with token' do
+      fake_response 'SetExpressCheckout/success'
       instance.redirect_uri.should == 'https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-5YJ90598G69065317'
     end
 
     it 'should support sandbox mode' do
       sandbox_mode do
+        fake_response 'SetExpressCheckout/success'
         instance.redirect_uri.should == 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-5YJ90598G69065317'
       end
     end

data/spec/paypal/ipn_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Paypal::IPN do
+  describe '.verify!' do
+    context 'when valid' do
+      before do
+        fake_response 'IPN/valid', :IPN
+      end
+
+      it 'should return true' do
+        Paypal::IPN.verify!("raw-post-body").should be_true
+      end
+    end
+
+    context 'when invalid' do
+      before do
+        fake_response 'IPN/invalid', :IPN
+      end
+
+      it 'should raise Paypal::APIError' do
+        lambda do
+          Paypal::IPN.verify!("raw-post-body")
+        end.should raise_error(Paypal::APIError)
+      end
+    end
+  end
+end

data/spec/paypal/nvp/request_spec.rb

@@ -15,7 +15,7 @@ describe Paypal::NVP::Request do
 
   describe '.new' do
     context 'when any required parameters are missing' do
-      it 'should raise AttrMissing exception' do
+      it 'should raise AttrRequired::AttrMissing' do
         attributes.keys.each do |missing_key|
           insufficient_attributes = attributes.reject do |key, value|
             key == missing_key
@@ -37,13 +37,13 @@ describe Paypal::NVP::Request do
       it 'should setup endpoint and version' do
         client = Paypal::NVP::Request.new attributes
         client.version.should == Paypal::API_VERSION
-        client.endpoint.should == Paypal::NVP::Request::ENDPOINT[:production]
+        client.class.endpoint.should == Paypal::NVP::Request::ENDPOINT[:production]
       end
 
       it 'should support sandbox mode' do
         sandbox_mode do
           client = Paypal::NVP::Request.new attributes
-          client.endpoint.should == Paypal::NVP::Request::ENDPOINT[:sandbox]
+          client.class.endpoint.should == Paypal::NVP::Request::ENDPOINT[:sandbox]
         end
       end
     end

data/spec/paypal/nvp/response_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper.rb'
+
+describe Paypal::NVP::Response do
+  let :request do
+    Paypal::Express::Request.new(
+      :username => 'nov',
+      :password => 'password',
+      :signature => 'sig',
+      :return_url => 'http://example.com/success',
+      :cancel_url => 'http://example.com/cancel'
+    )
+  end
+
+  let :payment_request do
+    Paypal::Payment::Request.new(
+      :amount => 1000,
+      :description => 'Instant Payment Request'
+    )
+  end
+
+  let :recurring_profile do
+    Paypal::Payment::Recurring.new(
+      :start_date => Time.utc(2011, 2, 8, 9, 0, 0),
+      :description => 'Recurring Profile',
+      :billing => {
+        :period => :Month,
+        :frequency => 1,
+        :amount => 1000
+      }
+    )
+  end
+
+  describe '.new' do
+    context 'when non-supported attributes are given' do
+      it 'should ignore them and warn' do
+        Paypal.logger.should_receive(:warn).with(
+          "Ignored Parameter (Paypal::NVP::Response): ignored=Ignore me!"
+        )
+        Paypal::NVP::Response.new(
+          :ignored => 'Ignore me!'
+        )
+      end
+    end
+
+    context 'when SetExpressCheckout response given' do
+      before do
+        fake_response 'SetExpressCheckout/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = request.setup payment_request
+        response.token.should == 'EC-5YJ90598G69065317'
+      end
+    end
+
+    context 'when GetExpressCheckoutDetails response given' do
+      before do
+        fake_response 'GetExpressCheckoutDetails/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = request.details 'token'
+        response.payer.identifier.should == 'PRT3TZ6MCBCNC'
+        response.payment_responses.size.should == 1
+        response.payment_info.size.should == 0
+        response.payment_responses.first.should be_instance_of(Paypal::Payment::Response)
+      end
+    end
+
+    context 'when DoExpressCheckoutPayment response given' do
+      before do
+        fake_response 'DoExpressCheckoutPayment/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = request.checkout! 'token', 'payer_id', payment_request
+        response.payment_responses.size.should == 0
+        response.payment_info.size.should == 1
+        response.payment_info.first.should be_instance_of(Paypal::Payment::Response::Info)
+      end
+    end
+
+    context 'when CreateRecurringPaymentsProfile response given' do
+      before do
+        fake_response 'CreateRecurringPaymentsProfile/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = request.subscribe! 'token', recurring_profile
+        response.recurring.identifier.should == 'I-L8N58XFUCET3'
+      end
+    end
+
+    context 'when GetRecurringPaymentsProfileDetails response given' do
+      before do
+        fake_response 'GetRecurringPaymentsProfileDetails/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = request.subscription 'profile_id'
+        response.recurring.billing.amount.total.should == 1000
+        response.recurring.regular_billing.paid.should == 1000
+        response.recurring.summary.next_billing_date.should == '2011-03-04T10:00:00Z'
+      end
+    end
+
+    context 'when ManageRecurringPaymentsProfileStatus response given' do
+      before do
+        fake_response 'ManageRecurringPaymentsProfileStatus/success'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        request.renew! 'profile_id', :Cancel
+      end
+    end
+  end
+end

data/spec/paypal/payment/recurring/activation_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Paypal::Payment::Recurring::Activation do
+  let :instance do
+    Paypal::Payment::Recurring::Activation.new(
+      :initial_amount => 100,
+      :failed_action => 'ContinueOnFailure'
+    )
+  end
+
+  describe '#to_params' do
+    it 'should handle Recurring Profile activation parameters' do
+      instance.to_params.should == {
+        :INITAMT => '100.00',
+        :FAILEDINITAMTACTION => 'ContinueOnFailure'
+      }
+    end
+  end
+end

data/spec/paypal/payment/response_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Response do
+  describe '.new' do
+    context 'when non-supported attributes are given' do
+      it 'should ignore them and warn' do
+        Paypal.logger.should_receive(:warn).with(
+          "Ignored Parameter (Paypal::Payment::Response): ignored=Ignore me!"
+        )
+        response = Paypal::Payment::Response.new(
+          :ignored => 'Ignore me!'
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paypal-express
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
+  hash: 27
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - nov matake
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 +09:00
+date: 2011-02-09 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -163,6 +163,7 @@ files:
 - lib/paypal/express.rb
 - lib/paypal/express/request.rb
 - lib/paypal/express/response.rb
+- lib/paypal/ipn.rb
 - lib/paypal/nvp/request.rb
 - lib/paypal/nvp/response.rb
 - lib/paypal/payment/recurring.rb
@@ -186,6 +187,8 @@ files:
 - spec/fake_response/GetExpressCheckoutDetails/success.txt
 - spec/fake_response/GetRecurringPaymentsProfileDetails/failure.txt
 - spec/fake_response/GetRecurringPaymentsProfileDetails/success.txt
+- spec/fake_response/IPN/invalid.txt
+- spec/fake_response/IPN/valid.txt
 - spec/fake_response/ManageRecurringPaymentsProfileStatus/failure.txt
 - spec/fake_response/ManageRecurringPaymentsProfileStatus/success.txt
 - spec/fake_response/SetExpressCheckout/failure.txt
@@ -194,13 +197,17 @@ files:
 - spec/paypal/exception_spec.rb
 - spec/paypal/express/request_spec.rb
 - spec/paypal/express/response_spec.rb
+- spec/paypal/ipn_spec.rb
 - spec/paypal/nvp/request_spec.rb
+- spec/paypal/nvp/response_spec.rb
+- spec/paypal/payment/recurring/activation_spec.rb
 - spec/paypal/payment/recurring_spec.rb
 - spec/paypal/payment/request_spec.rb
 - spec/paypal/payment/response/amount_spec.rb
 - spec/paypal/payment/response/info_spec.rb
 - spec/paypal/payment/response/payer_spec.rb
 - spec/paypal/payment/response/ship_to_spec.rb
+- spec/paypal/payment/response_spec.rb
 - spec/paypal/util_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -235,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: PayPal Express Checkout API Client Supporting Both Instant and Recurring Payment
@@ -248,6 +255,8 @@ test_files:
 - spec/fake_response/GetExpressCheckoutDetails/success.txt
 - spec/fake_response/GetRecurringPaymentsProfileDetails/failure.txt
 - spec/fake_response/GetRecurringPaymentsProfileDetails/success.txt
+- spec/fake_response/IPN/invalid.txt
+- spec/fake_response/IPN/valid.txt
 - spec/fake_response/ManageRecurringPaymentsProfileStatus/failure.txt
 - spec/fake_response/ManageRecurringPaymentsProfileStatus/success.txt
 - spec/fake_response/SetExpressCheckout/failure.txt
@@ -256,12 +265,16 @@ test_files:
 - spec/paypal/exception_spec.rb
 - spec/paypal/express/request_spec.rb
 - spec/paypal/express/response_spec.rb
+- spec/paypal/ipn_spec.rb
 - spec/paypal/nvp/request_spec.rb
+- spec/paypal/nvp/response_spec.rb
+- spec/paypal/payment/recurring/activation_spec.rb
 - spec/paypal/payment/recurring_spec.rb
 - spec/paypal/payment/request_spec.rb
 - spec/paypal/payment/response/amount_spec.rb
 - spec/paypal/payment/response/info_spec.rb
 - spec/paypal/payment/response/payer_spec.rb
 - spec/paypal/payment/response/ship_to_spec.rb
+- spec/paypal/payment/response_spec.rb
 - spec/paypal/util_spec.rb
 - spec/spec_helper.rb