ruby-paypal-extended 0.5.1

data/README

@@ -0,0 +1,17 @@
+== PayPal Ruby SDK - Extended ==
+
+This is an extension of the Ruby SDK provided by PayPal.  The intention is to 
+make some of the function calls a little more object oriented, and a little
+less hash based.
+
+This will also be packaged as a gem instead of a Rails plugin (buried inside
+a Rails project...)
+
+== Testing ==
+There is minimal testing of the basic API functionality, because it came
+pre-written from PayPal, and I'm going to assume that PayPal put it together
+correctly.
+
+For new code (and refactoring) there are tests in the /test directory.  To run
+them, use rake:
+rake test

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end

data/lib/ruby-paypal-extended.rb

@@ -0,0 +1,41 @@
+require 'ruby-paypal-extended/paypal_exception'
+require 'ruby-paypal-extended/profile'
+require 'ruby-paypal-extended/transaction'
+require 'ruby-paypal-extended/caller'
+require 'ruby-paypal-extended/operations/operation'
+require 'ruby-paypal-extended/operations/mass_pay'
+require 'ruby-paypal-extended/ipn/notification'
+
+module PayPalSDK
+  
+  # Various configuration values
+  module Config
+    # The PayPal NVP API version that this client can talk to.
+    CLIENT_VERSION = "56.0"
+    
+    # The name of this client
+    CLIENT_SOURCE = "ruby-paypal-extended"
+    
+    # The hostname for the sandbox API target
+    SANDBOX_API_HOST = "api-3t.sandbox.paypal.com"
+    
+    # The path for the sandbox API target
+    SANDBOX_API_PATH = "/nvp"
+    
+    # The hostname for the production API target
+    PRODUCTION_API_HOST = "api-3t.paypal.com"
+    
+    # The path for the production API target
+    PRODUCTION_API_PATH = "/nvp"
+    
+    # The URL to the sandbox IPN endpoint
+    SANDBOX_IPN_URL = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+    
+    # The URL to the productino IPN endpoint
+    PRODUCTION_IPN_URL = 'https://www.paypal.com/cgi-bin/webscr'
+    
+    # The Hashes used by Profile
+    SANDBOX_API_ENDPOINT = {"SERVER" => SANDBOX_API_HOST, "SERVICE" => SANDBOX_API_PATH}
+    PRODUCTION_API_ENDPOINT = {"SERVER" => PRODUCTION_API_HOST, "SERVICE" => PRODUCTION_API_PATH}
+  end
+end

data/lib/ruby-paypal-extended/caller.rb

@@ -0,0 +1,82 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'cgi'
+# The module has a class and a wrapper method wrapping NET:HTTP methods to simplify calling PayPal APIs.
+
+module PayPalSDK   
+  class Caller
+    attr_reader :ssl_strict
+    
+    # Headers for ?
+    @@headers = {'Content-Type' => 'html/text'}
+    
+    # Creates a new Caller object.
+    #
+    # <tt>profile</tt> - A PayPalSDK::Profile object.
+    def initialize(profile, ssl_verify_mode=false)
+      @ssl_strict = ssl_verify_mode  
+        
+      @profile = profile
+      
+      # Some short names for readability
+      @pi = @profile.proxy_info
+      @cre = @profile.credentials
+      @ci = @profile.client_info
+      @ep = @profile.endpoints
+    end   
+    
+   
+    # This method uses HTTP::Net library to talk to PayPal WebServices. This is the method what merchants should mostly care about.
+    # It expects an hash arugment which has the method name and paramter values of a particular PayPal API.
+    # It assumes and uses the credentials of the merchant which is the attribute value of credentials of profile class in PayPalSDKProfiles module.
+    # It assumes and uses the client information which is the attribute value of client_info of profile class of PayPalSDKProfiles module.
+    # It will also work behind a proxy server. If the calls need be to made via a proxy sever, set USE_PROXY flag to true and specify proxy server and port information in the profile class. 
+    def call(request_hash)
+      req_data = request_post_data(request_hash)
+      
+     if (@profile.use_proxy?)
+        if( @pi["USER"].nil? || @pi["PASSWORD"].nil? )
+          http = Net::HTTP::Proxy(@pi["ADDRESS"],@pi["PORT"]).new(@ep["SERVER"], 443)
+        else 
+          http = Net::HTTP::Proxy(@pi["ADDRESS"],@pi["PORT"],@pi["USER"], @pi["PASSWORD"]).new(@ep["SERVER"], 443)
+        end        
+      else 
+        http = Net::HTTP.new(@ep["SERVER"], 443)                       
+      end       
+      http.verify_mode    = OpenSSL::SSL::VERIFY_NONE #unless ssl_strict
+      http.use_ssl = true;        
+    
+      contents, unparseddata = http.post2(@ep["SERVICE"], req_data, @headers)    
+      data = CGI::parse(unparseddata)          
+      transaction = Transaction.new(data)         
+    end
+    
+    # Builds the post data for sending a request to PayPal, converting
+    # hash values to CGI request (NVP) format.
+    # It expects an hash arugment which has the method name and paramter values of a particular PayPal API.
+    def request_post_data(request_hash)
+      "#{hash2cgiString(request_hash)}&#{hash2cgiString(@cre)}&#{hash2cgiString(@ci)}"
+    end
+    
+    protected
+    
+    # Method to convert a hash to a string of name and values delimited by '&' as name1=value1&name2=value2...&namen=valuen.
+    def hash2cgiString(h)
+      # Order the keys alphabetically. It's not strictly necessary but makes
+      # output easier to determine (helps testing)
+      # This requires that the keys be strings, since symbols aren't sortable
+      h2 = {}
+      h.each {|key, value| h2[key.to_s] = value}
+      alpha_keys = h2.keys.sort
+      
+      # Escape all the values first
+      alpha_keys.each {|key| h2[key] = CGI::escape(h2[key].to_s) if (h2[key])}
+      
+      # Create the string
+      alpha_keys.collect {|key| "#{key}=#{h2[key]}"}.join('&')
+    end
+    
+  end
+end  
+

data/lib/ruby-paypal-extended/ipn/notification.rb

@@ -0,0 +1,194 @@
+#--
+# Copyright (c) 2005 Tobias Luetke
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'net/http'
+require 'net/https'
+require 'cgi'
+
+module PayPalSDK
+  module IPN
+    
+    # Top-level exceptin class for any IPN related exceptions.
+    class IPNException < PayPalException
+      
+    end
+    
+    # Parser and handler for incoming instant payment notifications from Paypal.
+    # The example shows a typical handler in a Rails application. Note that this
+    # is an example, please read the Paypal API documentation for all the details
+    # on creating a safe payment controller.
+    #
+    # Example
+    #  
+    #   class BackendController < ApplicationController
+    #     def paypal_ipn
+    #       notify = Paypal::Notification.new(request.raw_post, false)
+    #       order = Order.find(notify.item_id)
+    #       
+    #       # Verify this IPN with Paypal.
+    #       if notify.acknowledge
+    #         # Paypal said this IPN is legit.
+    #         begin
+    #           if notify.complete? && order.total == notify.amount
+    #             begin
+    #               order.status = 'success'
+    #               shop.ship(order)
+    #               order.save!
+    #             rescue => e
+    #               order.status = 'failed'
+    #               order.save!
+    #               raise
+    #             end
+    #           else
+    #             logger.error("We received a payment notification, but the " <<
+    #                          "payment doesn't seem to be complete. Please " <<
+    #                          "investigate. Transaction ID #{notify.transaction_id}.")
+    #           end
+    #       else
+    #         # Paypal said this IPN is not correct.
+    #         # ... log possible hacking attempt here ...
+    #       end
+    #       
+    #       render :nothing => true
+    #     end
+    #   end
+    class Notification
+      # The IPN URL to connect to.  Defaults to production
+      attr_accessor :ipn_url
+      
+      # The parsed Paypal IPN data parameters.
+      attr_accessor :params
+      
+      # The raw Paypal IPN data that was received.
+      attr_accessor :raw
+  
+      # Creates a new Paypal::Notification object. As the first argument,
+      # pass the raw POST data that you've received from Paypal.
+      #
+      # In a Rails application this looks something like this:
+      # 
+      #   def paypal_ipn
+      #     paypal = Paypal::Notification.new(request.raw_post)
+      #     ...
+      #   end
+      def initialize(post, use_production = false)
+        @ipn_url = use_production ? PayPalSDK::Config::PRODUCTION_IPN_URL : PayPalSDK::Config::SANDBOX_IPN_URL
+        empty!
+        parse(post)
+      end
+      
+      # Returns the status of this transaction.
+      def status
+        params['payment_status']
+      end
+      
+      # When was this payment received by the client. 
+      # sometimes it can happen that we get the notification much later. 
+      # One possible scenario is that our web application was down. In this case paypal tries several 
+      # times an hour to inform us about the notification
+      def payment_date
+        Time.parse(params['payment_date'])
+      end
+  
+      # Id of this transaction (paypal number)
+      def transaction_id
+        params['txn_id']
+      end
+  
+      # What type of transaction are we dealing with? 
+      def type
+        params['txn_type']
+      end
+      
+      # This is the invocie which you passed to paypal 
+      def test?
+        params['test_ipn'] == '1'
+      end
+      
+      # reset the notification. 
+      def empty!
+        @params  = {}
+        @raw     = ""      
+      end
+  
+      # Acknowledge the transaction to paypal. This method has to be called after a new 
+      # IPN arrives. Paypal will verify that all the information we received are
+      # correct and will return a ok or a fail. 
+      # 
+      # Example:
+      # 
+      #   def paypal_ipn
+      #     notify = PaypalNotification.new(request.raw_post)
+      #
+      #     if notify.acknowledge 
+      #       ... process order ... if notify.complete?
+      #     else
+      #       ... log possible hacking attempt ...
+      #     end
+      #   end
+      def acknowledge      
+        payload = raw
+        
+        uri = URI.parse(self.ipn_url)
+        request_path = "#{uri.path}?cmd=_notify-validate"
+        
+        request = Net::HTTP::Post.new(request_path)
+        request['Content-Length'] = "#{payload.size}"
+        request['User-Agent']     = "ruby-paypal-extended -- http://github.com/MicahWedemeyer/ruby-paypal-extended"
+  
+        http = Net::HTTP.new(uri.host, uri.port)
+  
+        if uri.scheme == "https"
+          http.use_ssl = true
+          # http://www.ruby-lang.org/en/news/2007/10/04/net-https-vulnerability/
+          if http.respond_to?(:enable_post_connection_check)
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            http.enable_post_connection_check = true
+            store = OpenSSL::X509::Store.new
+            store.set_default_paths
+            http.cert_store = store
+          else
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+        end
+  
+        request = http.request(request, payload)
+        
+        raise IPNException.new("Faulty paypal result: #{request.body}") unless ["VERIFIED", "INVALID"].include?(request.body)
+        
+        request.body == "VERIFIED"
+      end
+  
+      private
+      
+      # Take the posted data and move the relevant data into a hash
+      def parse(post)
+        @raw = post
+        for line in post.split('&')    
+          key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+          @params[key] = CGI.unescape(value)
+        end
+      end
+    end
+  end
+end

data/lib/ruby-paypal-extended/operations/mass_pay.rb

@@ -0,0 +1,89 @@
+module PayPalSDK
+  module Operations
+    
+    # Represents an arity mismatch where the number of receipients does
+    # not match all the other arguments
+    class MassPayArityException < PayPalException
+    end
+    
+    # Represents the MassPay operation
+    class MassPay < Operation
+      attr_accessor :receiver_identifiers
+      attr_accessor :amounts
+      attr_accessor :receivertype
+      attr_accessor :currency_code
+      attr_accessor :email_subject
+      attr_accessor :unique_ids
+      attr_accessor :notes
+      
+      # Creates a new MassPay operation.
+      #
+      # <tt>receiver_identifiers</tt> - An array of identifiers for the receivers, either
+      #  email addresses or paypal IDs.  As specified in the docs, they must all be
+      #  one or the other.
+      # <tt>amounts</tt> - An array of numeric values representing the amounts to send to each recipient.
+      # <tt>receivertype</tt> - Must be either "UserID" or "EmailAddress".  Defaults to EmailAddress
+      # <tt>currency_code</tt> - The 3 letter currency code
+      # <tt>email_subect</tt> - Subject of the email that will be sent to everyone
+      # <tt>unique_ids</tt> - An array of unique identifiers to attach to each transaction.  Optional
+      # <tt>notes</tt> - An array of notes to attach to each transaction. Optional
+      def initialize(opts)
+        opts = {
+          :receivertype => "EmailAddress",
+          :currency_code => "USD"
+        }.merge(opts)
+      
+        @receiver_identifiers = opts[:receiver_identifiers]
+        @amounts = opts[:amounts]
+        @receivertype = opts[:receivertype]
+        @currency_code = opts[:currency_code]
+        @email_subject = opts[:email_subject]
+        @unique_ids = opts[:unique_ids]
+        @notes = opts[:notes]
+        
+        @n_recip = @receiver_identifiers.size
+        check_arity
+      end
+      
+      protected
+      
+      def call_hash
+        # Double-check the arity before making the hash
+        check_arity
+        
+        h = {
+          :method => "MassPay",
+          :receivertype => @receivertype,
+          :currency_code => @currency_code,
+          :email_subject => @email_subject
+        }
+        
+        id_key = @receivertype == "UserID" ? "l_receiverid" : "l_email"
+        
+        @receiver_identifiers.each_index do |i|
+          h["#{id_key}#{i}".to_sym] = @receiver_identifiers[i]
+          h["l_amt#{i}".to_sym] = @amounts[i]
+          h["l_uniqueid#{i}".to_sym] = @unique_ids[i] if @unique_ids
+          h["l_note#{i}".to_sym] = @notes[i] if @notes
+        end
+        
+        h
+      end
+      
+      def check_arity
+        # Sloppy...
+        bad_sizes = []
+        bad_sizes << "amounts has #{@amounts.size} values" if @amounts.size != @n_recip
+        bad_sizes << "unique_ids has #{@unique_ids.size} values" if !@unique_ids.nil? && (@unique_ids.size != @n_recip)
+        bad_sizes << "notes has #{@notes.size} values" if !@notes.nil? && (@notes.size != @n_recip)
+        
+        unless bad_sizes.empty?
+          msg = "Arity mismatch: #{@n_recip} user identifiers, but "
+          msg += bad_sizes.join(" and")
+          raise MassPayArityException.new(msg)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ruby-paypal-extended/operations/operation.rb

@@ -0,0 +1,26 @@
+module PayPalSDK
+  module Operations
+    # Represents a base class method that is not yet implemented.
+    class NotImplementedException < PayPalException
+    end
+    
+    # Abstract base class for all the operations
+    class Operation
+      
+      # Executes the operation and returns the response wrapped in
+      # a Transaction
+      def call(caller)
+        caller.call(call_hash)
+      end
+      
+      protected
+      
+      # Translates this Operation into the Hash expected by Caller
+      # Every Operation Class must implement this method
+      def call_hash
+        raise NotImplementedException.new("Must implement call_hash")
+      end
+      
+    end
+  end
+end

data/lib/ruby-paypal-extended/paypal_exception.rb

@@ -0,0 +1,6 @@
+module PayPalSDK
+  # Base Exception class for all execeptions generated by this library
+  class PayPalException < Exception
+    
+  end
+end

data/lib/ruby-paypal-extended/profile.rb

@@ -0,0 +1,35 @@
+module PayPalSDK
+  
+  # This class holds a merchant's API crednetials and PayPal endpoint information
+  class Profile
+    
+    attr_accessor :credentials
+    attr_accessor :endpoints
+    attr_accessor :client_info
+    attr_accessor :proxy_info
+    
+    # Proxy information of the client environment.
+    DEFAULT_PROXY_INFO = {"USE_PROXY" => false, "ADDRESS" => nil, "PORT" => nil, "USER" => nil, "PASSWORD" => nil }
+     
+    # Creates a new Profile, setting it with the options provided
+    # Options are:
+    # <tt>credentials</tt> - A hash of user credentials with keys of "USER", "PWD", and "SIGNATURE"
+    # <tt>use_production</tt> - Set to true to interact with the production server. Defaults to false
+    # <tt>proxy_info</tt> - A hash of proxy server info with keys of "USE_PROXY", "ADDRESS", "PORT", "USER", "PASSWORD"
+    def initialize(credentials, use_production = false, proxy_info = nil)
+      @credentials = credentials
+      @proxy_info = proxy_info || DEFAULT_PROXY_INFO
+      
+      @endpoints = use_production ? PayPalSDK::Config::PRODUCTION_API_ENDPOINT : PayPalSDK::Config::SANDBOX_API_ENDPOINT
+      
+      @client_info = {
+        "VERSION" => PayPalSDK::Config::CLIENT_VERSION,
+        "SOURCE" => PayPalSDK::Config::CLIENT_SOURCE
+      }
+    end
+    
+    def use_proxy?
+      @proxy_info["USE_PROXY"]
+    end
+  end
+end

data/lib/ruby-paypal-extended/transaction.rb

@@ -0,0 +1,17 @@
+module PayPalSDK
+  # Wrapper class to wrap response hash from PayPal as an object and to provide nice helper methods
+  class Transaction       
+    def initialize(data)
+     @success = data["ACK"].to_s != "Failure"
+     @response = data    
+    end
+    
+    def success?
+      @success
+    end
+    
+    def response
+      @response
+    end
+  end
+end

data/licenses/LICENSE.txt

@@ -0,0 +1,44 @@
+PAYPAL, INC.
+
+SDK LICENSE
+
+NOTICE TO USER:  PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement.  Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
+
+As used in this Agreement, "PayPal" means PayPal, Inc.  "Software" means the software code accompanying this agreement.   "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.   
+
+1.  LICENSE GRANT Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, publicly perform, distribute and sublicense the Software for any purpose, provided the copyright notice below appears in a conspicuous location within the source code of the distributed Software and this license is distributed in the supporting documentation of the Software you distribute. Furthermore, you must comply with all third party licenses in order to use the third party software contained in the Software.
+
+Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation for any purpose.  You may not modify the Documentation.
+
+No title to the intellectual property in the Software or Documentation is transferred to you under the terms of this Agreement.  You do not acquire any rights to the Software or the Documentation except as expressly set forth in this Agreement.
+
+If you choose to distribute the Software in a commercial product, you do so with the understanding that you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and costs arising from the claims, lawsuits or other legal actions arising out of such distribution.  You may distribute the Software in object code form under your own license, provided that your license agreement:
+
+(a) 	complies with the terms and conditions of this license agreement; 
+
+(b) 	effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
+
+(c) 	effectively excludes all liability for damages on behalf of PayPal;
+
+(d) 	states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
+
+(e) 	states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.  
+
+2.  DISCLAIMER OF WARRANTY
+PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY ON AN "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  PAYPAL MAKES NO WARRANTY THAT THE SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE.  Each user of the Software or Documentation is solely responsible for determining the appropriateness of using and distributing the Software and Documentation and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, and unavailability or interruption of operations.  Use of the Software and Documentation is made with the understanding that PayPal will not provide you with any technical or customer support or maintenance.  Some states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you.  To the extent permissible, any implied warranties are limited to ninety (90) days.
+
+
+3.  LIMITATION OF LIABILITY
+PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION.  IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION. 
+
+4.  TRADEMARK USAGE
+PayPal is a trademark PayPal, Inc. in the United States and other countries.  Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.  
+
+5.  TERM
+Your rights under this Agreement shall terminate if you fail to comply with any of the material  terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance.  If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable. 
+
+6. GOVERNING LAW AND JURISDICTION. This Agreement is governed by the statutes and laws of the State of California, without regard to the conflicts of law principles thereof.  If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms.  Any dispute arising out of or related to this Agreement shall be brought in the courts of Santa Clara County, California, USA. 
+
+7.  GENERAL
+You acknowledge that you have read this Agreement, understand it, and that it is the complete and exclusive statement of your agreement with PayPal which supersedes any prior agreement, oral or written, between PayPal and you with respect to the licensing to you of the Software and Documentation. No variation of the terms of this Agreement will be enforceable against PayPal unless PayPal gives its express consent in writing signed by an authorized signatory of PayPal.
+

data/test/caller_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class CallerTest < Test::Unit::TestCase
+  include PayPalSDK
+  
+  def setup
+    @p = Profile.new(creds)
+    @c = Caller.new(@p)
+  end
+  
+  def test_request_post_data
+    post_data = @c.request_post_data(req_hash)
+    assert post_data.is_a?(String)
+    
+    expected = "currencycode=USD&emailsubject=You+have+received+a+payment&l_amt0=5.00&l_receiverid0=12345&method=MassPay&receivertype=UserID&PWD=QFZCWN5HZM8VBG7Q&SIGNATURE=A.d9eRKfd1yVkRrtmMfCFLTqa6M9AyodL0SJkhYztxUi8W9pCXF6.4NI&USER=sdk-three_api1.sdk.com&SOURCE=ruby-paypal-extended&VERSION=56.0"
+    assert_equal expected, post_data
+  end
+  
+  protected
+  
+  def creds(opts = {})
+    {
+      "USER" => "sdk-three_api1.sdk.com",
+      "PWD" => "QFZCWN5HZM8VBG7Q",
+      "SIGNATURE" => "A.d9eRKfd1yVkRrtmMfCFLTqa6M9AyodL0SJkhYztxUi8W9pCXF6.4NI"
+     }.merge(opts)
+  end
+ 
+  def req_hash(opts = {})
+    {
+      :method => "MassPay",
+      :emailsubject => "You have received a payment",
+      :currencycode => "USD",
+      :receivertype => "UserID",
+      :l_receiverid0 => "12345",
+      :l_amt0 => "5.00"
+    }.merge(opts)
+  end
+end

data/test/mass_pay_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class MassPayTest < Test::Unit::TestCase
+  include PayPalSDK
+  include PayPalSDK::Operations
+  
+  def setup
+    @mp = MassPay.new(mass_pay_opts)
+  end
+  
+  def test_constructor_wrong_arity
+    assert_raise MassPayArityException do
+      opts = mass_pay_opts(:unique_ids => ["a","b"]) # Missing a unique identifier
+      MassPay.new(opts)
+    end
+  end
+  
+  def test_call_hash
+    h = @mp.send(:call_hash)
+    assert_equal "MassPay", h[:method]
+    
+    assert_equal "USD", h[:currency_code]
+    assert_equal "UserID", h[:receivertype]
+    
+    assert_equal "1", h[:l_receiverid0]
+    assert_equal 1.00, h[:l_amt0]
+    assert_equal "a", h[:l_uniqueid0]
+    
+    assert_equal "3", h[:l_receiverid2]
+    assert_equal 10.00, h[:l_amt2]
+    assert_equal "c", h[:l_uniqueid2]
+    
+    assert_nil h[:l_email0]
+  end
+  
+  def test_call_hash_email
+    opts = mass_pay_opts(
+      :receiver_identifiers => ["a@b.com", "a@c.com", "a@d.com"],
+      :receivertype => "EmailAddress"
+    )
+    mp = MassPay.new(opts)
+    
+    h = mp.send(:call_hash)
+    
+    assert_equal "EmailAddress", h[:receivertype]
+    assert_equal "a@b.com", h[:l_email0]
+    assert_equal "a@d.com", h[:l_email2]
+    
+    assert_nil h[:l_receiverid0]
+  end
+  
+  protected
+  
+  def mass_pay_opts(opts = {})
+    {
+      :receiver_identifiers => ["1", "2", "3"],
+      :receivertype => "UserID",
+      :amounts => [1.00, 5.00, 10.00],
+      :currency_code => "USD",
+      :unique_ids => ["a", "b", "c"]
+    }.merge(opts)
+  end
+  
+end

data/test/operation_test.rb

@@ -0,0 +1,29 @@
+class OperationTest < Test::Unit::TestCase
+  include PayPalSDK::Operations
+  
+  def setup
+    @mock_caller = flexmock(:caller)
+    
+    # We'll use the MassPay operation
+    @op = MassPay.new(mass_pay_opts)
+  end
+  
+  def test_call
+    vals = @op.send(:call_hash)
+    @mock_caller.should_receive(:call).with(vals).once.and_return(true)
+    
+    @op.call(@mock_caller)
+  end
+  
+  protected
+  
+  def mass_pay_opts(opts = {})
+    {
+      :receiver_identifiers => ["1", "2", "3"],
+      :receiver_type => "UserID",
+      :amounts => [1.00, 5.00, 10.00],
+      :currency_code => "USD",
+      :unique_ids => ["a", "b", "c"]
+    }.merge(opts)
+  end
+end

data/test/profile_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class ProfileTest < Test::Unit::TestCase
+  include PayPalSDK
+  
+  def setup
+    @p = Profile.new(creds)
+  end
+  
+  def test_constructor
+    @p = Profile.new(
+      creds,
+      true,
+      {"USE_PROXY" => true, "ADDRESS" => "foo", "PORT" => 99, "USER" => nil, "PASSWORD" => nil }
+    )
+    
+    assert @p.use_proxy?
+    assert_equal 99, @p.proxy_info["PORT"]
+    assert_equal "api-3t.paypal.com", @p.endpoints["SERVER"]
+  end
+  
+  protected
+  
+  def creds(opts = {})
+    {
+      "USER" => "sdk-three_api1.sdk.com",
+      "PWD" => "QFZCWN5HZM8VBG7Q",
+      "SIGNATURE" => "A.d9eRKfd1yVkRrtmMfCFLTqa6M9AyodL0SJkhYztxUi8W9pCXF6.4NI"
+     }.merge(opts)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require 'flexmock/test_unit'
+require 'ruby-paypal-extended'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-paypal-extended
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Micah Wedemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-10 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ruby-paypal-extended is a Ruby library for interacting with PayPal via the NVP (Name Value Pair) REST interface.
+email: micah@aisleten.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ruby-paypal-extended/caller.rb
+- lib/ruby-paypal-extended/ipn/notification.rb
+- lib/ruby-paypal-extended/operations/mass_pay.rb
+- lib/ruby-paypal-extended/operations/operation.rb
+- lib/ruby-paypal-extended/paypal_exception.rb
+- lib/ruby-paypal-extended/profile.rb
+- lib/ruby-paypal-extended/transaction.rb
+- lib/ruby-paypal-extended.rb
+- licenses/LICENSE.txt
+- Rakefile
+- README
+- test/caller_test.rb
+- test/mass_pay_test.rb
+- test/operation_test.rb
+- test/profile_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/MicahWedemeyer/ruby-paypal-extended
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A library for interfacing with PayPal.
+test_files: []
+