paypal_api 0.3.0 → 0.3.4

data/.gitignore

@@ -3,4 +3,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-*~
+*~
+spec/tmp/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Matt Handler
+
+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.

data/README.markdown

@@ -20,8 +20,8 @@ request.amt = 10.00
 
 # Add a list type field
 request.item.push {
-	:l_email => "bro@dudeman.com",
-	:l_amt => 23.0
+	:email => "bro@dudeman.com",
+	:amt => 23.0
 }
 
 response = request.make
@@ -56,14 +56,55 @@ test:
   username: "user_api1.something.com"
   password: "some_password_they_gave_you"
   signature: "some_signature"
+  application_id: "APP-80W284485P519543T" # only necessary for adaptive payments api
 
 production:
   environment: "production"
   username: <%= ENV["PAYPAL_USERNAME"] %>
   password: <%= ENV["PAYPAL_PASSWORD"] %>
   signature: <%= ENV["PAYPAL_SIGNATURE"] %>
+  application_id <%= ENV["PAYPAL_APP_ID"] %>
 ```
 
+## Ipn Messages
+
+there is an ipn message model generator: `rails generate paypal:ipn_message`, it will create
+a migration and the IpnMessage model.
+
+you must edit the route and add a handler like so:
+
+```ruby
+# config/routes
+MyApp::Application.routes.draw do
+
+  match '/ipn_message', to: 'handlers#handle_ipn', as: 'ipn_message'
+
+end
+
+# app/controllers/handlers_controller.rb
+class HandlersController < ApplicationController
+
+  def handle_ipn
+    @ipn_message = IpnMessage.create_from_message(params) # provided by generator
+
+    @ipn_message.success?
+    @ipn_message.correlation_id
+    @ipn_message.transaction_id # not always provided
+    @ipn_message.message # raw text of the message
+  end
+
+end
+```
+
+## Testing
+
+i'm an rspec kinda guy. note that i have test for actual requests against the paypal
+sandbox server, but they are off by default. remove the line about `:slow_paypal` in
+`spec/spec_helper.rb` to turn these back on.
+
+also note that, for the Adaptive Payments api, an application id is required, for testing,
+you can use this: "APP-80W284485P519543T" ([https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_APGettingStarted](https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_APGettingStarted))
+
 # Current Status
 
 alpha
@@ -92,6 +133,11 @@ like to contribute, i've made it pretty easy to add compatibility for a new api
 
 ## Payments Pro
 
+note that paypal has a strict policy about who they approve for
+payments pro. you can sign up for it, and start testing it, but as soon as your first
+real charge goes through, they will vet your website and many people have gotten burned
+by this (including me, sad sad me...).
+
 * do_direct_payment - &#10003;
 
 * do_reference_transaction - &#10003;
@@ -152,6 +198,11 @@ note that you need to request that paypal enable mass pay for your account befor
 
 ## Adaptive Payments
 
+this api is very different from the others... getting it to work with the way i built things already
+required some ugly stuff, but it helps keep the gem consistent from the outside.
+
+* pay - &#10003;
+
 ## Adaptive Accounts
 
 ## Invoicing

data/lib/generators/paypal/ipn_message_generator.rb

@@ -0,0 +1,32 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Paypal
+	module Generators
+		class IpnMessageGenerator < Rails::Generators::Base
+			# include Rails::Generators::ResourceHelpers
+			include Rails::Generators::Migration
+
+			source_root File.expand_path("../../templates", __FILE__)
+
+			desc "creates a migration to store ipn messages, adds some model helpers, adds a route"
+
+			def create_ipn_message_migration
+				migration_template "migration.rb", "db/migrate/add_ipn_messages.rb"
+			end
+
+			def self.next_migration_number(path)
+			    Time.now.utc.strftime("%Y%m%d%H%M%S")
+			end
+
+			def add_to_ipn_message_handling_model
+				copy_file "ipn_message.rb", "app/models/ipn_message.rb"
+			end
+
+			def add_route
+				route %Q{match "ipn_message", :to => "callback_controller#handle_ipn", :as => :ipn_message} if FileTest.exists?("config/routes.rb")
+			end
+
+		end
+	end
+end

data/lib/generators/templates/ipn_message.rb

@@ -0,0 +1,28 @@
+class IpnMessage < ActiveRecord::Base
+
+	alias_method :success?, :success
+
+	def self.create_from_message(hash)
+		ipn_message = IpnMessage.new
+
+		ipn_message.body = hash.to_yaml
+		ipn_message.success = hash["ACK"] == "Success"
+		ipn_message.correlation_id = hash["correlation_id"]
+		ipn_message.transaction_id = hash["transaction_id"]
+
+		ipn_message.save
+		return ipn_message
+	end
+
+	# returns hash of unique_id:string => status:bool
+	def unique_ids
+		hash = YAML.load(self.body)
+
+		return hash.inject({}){|acc, (k,v)|
+			k.to_s =~ /unique_id_(\d+)/
+			acc[v] = hash["status_#{$1}"] == "Completed" if $1
+			acc
+		}
+	end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateIpnMessages < ActiveRecord::Migration
+	def change
+		create_table :ipn_messages do |t|
+			t.text :message
+			t.string :correlation_id
+			t.string :transaction_id
+			t.string :tracking_id
+			t.boolean :success
+
+			t.timestamps
+		end
+	end
+end

data/lib/paypal_api/apis/adaptive_accounts.rb

@@ -0,0 +1,4 @@
+module Paypal
+	class AdaptiveAccounts < Paypal::Api
+	end
+end

data/lib/paypal_api/apis/adaptive_payments.rb

@@ -0,0 +1,183 @@
+# note: things got a little weird here because the paypal apis
+# 	are so different, but i tried to make it work smoothly... at least
+# 	it is from outside interaction... wahhh
+
+module Paypal
+
+	class AdaptivePaymentsResponse < Response
+		def initialize(stringio)
+			@raw_response = stringio.class == StringIO ? stringio.read : stringio
+			@parsed_response = CGI.parse(@raw_response)
+
+			@success = @parsed_response["responseEnvelope.ack"] == ["Success"]
+
+			unless @success
+				# "responseEnvelope.timestamp"=>["2012-02-29T13:35:28.528-08:00"],
+				# "responseEnvelope.ack"=>["Failure"],
+				# "responseEnvelope.correlationId"=>["ca0befbd1fe0b"],
+				# "responseEnvelope.build"=>["2486531"],
+				# "error(0).errorId"=>["560022"],
+				# "error(0).domain"=>["PLATFORM"],
+				# "error(0).subdomain"=>["Application"],
+				# "error(0).severity"=>["Error"],
+				# "error(0).category"=>["Application"],
+				# "error(0).message"=>["The X-PAYPAL-APPLICATION-ID header contains an invalid value"],
+				# "error(0).parameter(0)"=>["X-PAYPAL-APPLICATION-ID"]
+
+				@error_message = @parsed_response["error(0).message"][0]
+				@error_code = @parsed_response["error(0).errorId"][0]
+				@paypal_error_field = @parsed_response["error(0).parameter(0)"][0]
+			end
+		end
+
+		protected
+
+			def symbol_to_key(symbol)
+				case symbol
+				when :correlation_id
+					return "responseEnvelope.correlationId"
+				else
+					return Paypal::Api.symbol_to_lower_camel(symbol)
+				end
+			end
+	end
+
+	class AdaptivePaymentsRequest < Request
+		# customize validation here
+		attr_accessor :ip_address
+
+		def self.api_endpoint
+			"https://svcs.paypal.com/AdaptivePayments/#{api_method.capitalize}"
+		end
+
+		def self.api_sandbox_endpoint
+			"https://svcs.sandbox.paypal.com/AdaptivePayments/#{api_method.capitalize}"
+		end
+
+		def headers
+			{
+				"X-PAYPAL-SECURITY-USERID" => user,
+				"X-PAYPAL-SECURITY-PASSWORD" => password,
+				"X-PAYPAL-SECURITY-SIGNATURE" => signature,
+				"X-PAYPAL-DEVICE-IPADDRESS" => @ip_address,
+				"X-PAYPAL-REQUEST-DATA-FORMAT" => "NV",
+				"X-PAYPAL-RESPONSE-DATA-FORMAT" => "NV",
+				"X-PAYPAL-APPLICATION-ID" => application_id
+			}
+		end
+
+		def process_response(response)
+			return AdaptivePaymentsResponse.new(response)
+		end
+
+		def make_request
+			if @ip_address.nil?
+				throw Paypal::InvalidRequest, "need an ip address"
+			else
+				super
+			end
+		end
+
+		def to_key(symbol)
+			if symbol.is_a?(String)
+				return symbol
+			else
+				case symbol
+				when :request_envelope_error_language then
+					return "requestEnvelope.errorLanguage"
+				# when :reverse_all_parallel_payments_on_error then
+				# 	return "reverseAllParallelPaymentsonError" # may just be a typo in docs, need to test
+				when :request_envelope_detail_level then
+					return "requestEnvelope.detailLevel"
+				when :sender_use_credentials
+					return "sender.useCredentials"
+				when :method
+					return "METHOD"
+				else
+					#camelcaps but first letter is lowercase
+					return Paypal::Api.symbol_to_lower_camel(symbol)
+				end
+			end
+		end
+	end
+
+	class AdaptivePayments < Paypal::Api
+
+		set_request_signature :pay, {
+			# standard params
+			:action_type => Enum.new({:pay => "PAY", :create => "CREATE", :pay_primary => "PAY_PRIMARY"}),
+			:receiver => Sequential.new({
+					:email => String,
+					:amount => Float,
+					:primary => Optional.new(bool_class),
+					:invoice_id => Optional.new(String), # max 127 char
+					:payment_type => Optional.new(Enum.new({
+						:goods => "GOODS",
+						:service => "SERVICE",
+						:personal => "PERSONAL",
+						:cash_advance => "CASHADVANCE",
+						:digital_goods => "DIGITALGOODS"
+					})),
+					:payment_sub_type => Optional.new(String),
+					:phone => Optional.new({
+						:country_code => String,
+						:phone_number => String,
+						:extension => Optional.new(String)
+					})
+				}, 6, lambda {|key, i| "receiverList.receiver(#{i}).#{Paypal::AdaptivePaymentsRequest.new.to_key(key)}" }),
+			:currency_code => Default.new("USD", String),
+			:cancel_url => String,
+			:return_url => String,
+
+			# parallel payments
+			# 	request is considered parallel if more than one receiver is added
+			:reverse_all_parallel_payments_on_error => Optional.new(bool_class),
+
+			# chained payments
+			# 	choose one of your receivers to be primary = true and the rest false to initiate a chained payment
+
+			# implicit payments
+			# 	if you are the api caller and you put in your own email address here, it is automatically approved
+			:sender_email => Optional.new(String),
+
+			# preapproval payments
+			# 	if you provide the following, and it is accurate, the payment will automatically be approved
+			:preapproval_key => Optional.new(String),
+			:pin => Optional.new(String),
+
+
+			:client_details => Optional.new({
+				:application_id => String,
+				:customer_id => String,
+				:customer_type => String,
+				:device_id => String,
+				:geo_location => String,
+				:ip_address => String,
+				:model => String,
+				:partner_name => String
+			}),
+			:fees_payer => Optional.new(Enum.new({
+				:sender => "SENDER",
+				:primary_receiver => "PRIMARYRECEIVER",
+				:each_receiver => "EACHRECEIVER",
+				:secondary_only => "SECONDARYONLY"
+			})),
+			# note: FundingConstraint is unavailable to API callers with standard permission levels; for more information, refer to the section Adaptive Payments Permission Levels.
+			# maybe collapse into a sequential w proc
+			:funding_constraint => Sequential.new({
+				:funding_type => Enum.new({:e_check => "ECHECK", :balance => "BALANCE", :credit_card => "CREDITCARD"})
+			}, nil, lambda {|key, i| "fundingConstraint.allowedFundingType(#{i}).fundingTypeInfo.#{Paypal::PaymentsPro.to_key(key)}"}),
+			:ipn_notification_url => Optional.new(String),
+			:memo => Optional.new(String), # max 1000 char
+
+			:request_envelope_error_language => "en_US",
+			:request_envelope_detail_level => Default.new("ReturnAll", Optional.new(String)),
+
+			:sender_user_credentials => Optional.new(bool_class),
+
+			:tracking_id => Optional.new(String)
+
+		}
+
+	end
+end

data/lib/paypal_api/apis/api.rb

@@ -4,10 +4,6 @@ module Paypal
 			string = string.to_s
 			return URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
 		end
-
-		def to_key(symbol)
-			return symbol.to_s.gsub(/[^a-z0-9]/i, "").upcase
-		end
 	end
 
 	class Api
@@ -102,11 +98,33 @@ module Paypal
 				return symbol.to_s.downcase.split("_").map(&:capitalize).join
 			end
 
+			def self.symbol_to_lower_camel(symbol)
+				cameled = symbol_to_camel(symbol)
+				return cameled[0].downcase + cameled.split(/./, 2).join
+			end
+
 			def self.set_request_signature(name, hash)
+
+				# create Request subclass if not already created
+				subname = self.to_s.split("::")[1]
+				if !Paypal.const_defined?("#{subname}Request")
+					Paypal.class_eval <<-EOS
+						class #{subname}Request < Request
+							def self.parent_api
+								return #{self}
+							end
+						end
+					EOS
+				end
+
 				# create request object
 				class_name = "#{self.symbol_to_camel name}Request"
-				self.class.class_eval <<-EOS
-				  class Paypal::#{class_name} < Request; end
+				Paypal.class_eval <<-EOS
+				  class #{class_name} < #{subname}Request
+				  	def self.api_method
+				  		return "#{name}"
+				  	end
+				  end
 				EOS
 				klass = Kernel.const_get("Paypal").const_get(class_name)
 
@@ -138,6 +156,11 @@ module Paypal
 				EOS
 			end
 
+			# hack for no Bool class :'(
+			def self.bool_class
+				return Enum.new("true", "false")
+			end
+
 			# TODO: make this useful :'(
 			# def set_response_signature(hash)
 			# 	hash.each do |k,v|

data/lib/paypal_api/apis/button_manager.rb

@@ -0,0 +1,5 @@
+module Paypal
+	class ButtonManager < Paypal::Api
+
+	end
+end

data/lib/paypal_api/apis/express_checkout.rb

@@ -0,0 +1,5 @@
+module Paypal
+	class ExpressCheckout < Paypal::Api
+
+	end
+end

data/lib/paypal_api/apis/invoicing.rb

@@ -0,0 +1,5 @@
+module Paypal
+	class Invoicing < Paypal::Api
+
+	end
+end

data/lib/paypal_api/apis/mass_pay.rb

@@ -1,5 +1,16 @@
 module Paypal
-	class MassPay < Paypal::Api
+	class MassPayApiRequest < Request
+
+		protected
+			def validate!
+				if @payee.length == 0
+					raise Paypal::InvalidRequest, "you pust provide at least one payee"
+				end
+			end
+	end
+
+	# named with api because of method overlap
+	class MassPayApi < Paypal::Api
 		set_request_signature :mass_pay, {
 			:method => "MassPay",
 			:email_subject => Optional.new(String), # max 255 char
@@ -12,14 +23,4 @@ module Paypal
 			}, 250, lambda {|key, i| "L_#{key.to_s.gsub("_","").upcase}#{i}"})
 		}
 	end
-
-	class MassPayRequest
-
-		protected
-			def validate!
-				if @payee.length == 0
-					raise Paypal::InvalidRequest, "you pust provide at least one payee"
-				end
-			end
-	end
 end

data/lib/paypal_api/apis/payments_pro.rb

@@ -151,5 +151,81 @@ module Paypal
 			:profile_id => String # max 19 char
 		}
 
+		set_request_signature :address_verify, {
+
+		}
+
+		set_request_signature :bill_outstanding_amount, {
+
+		}
+
+		set_request_signature :callback, {
+
+		}
+
+		set_request_signature :create_recurring_payments_profile, {
+
+		}
+
+		set_request_signature :do_authorization, {
+
+		}
+
+		set_request_signature :do_express_checkout_payment, {
+
+		}
+
+		set_request_signature :do_nonreferenced_credit, {
+
+		}
+
+		set_request_signature :do_reauthorization, {
+
+		}
+
+		set_request_signature :get_balance, {
+
+		}
+
+		set_request_signature :get_billing_agreement_customer_details, {
+
+		}
+
+		set_request_signature :get_express_checkout_details, {
+
+		}
+
+		set_request_signature :get_transaction_details, {
+
+		}
+
+		set_request_signature :manage_pending_transaction_status, {
+
+		}
+
+		set_request_signature :manage_recurring_payments_profile_status, {
+
+		}
+
+		set_request_signature :refund_transaction, {
+
+		}
+
+		set_request_signature :set_customer_billing_agreement, {
+
+		}
+
+		set_request_signature :set_express_checkout, {
+
+		}
+
+		set_request_signature :transaction_search, {
+
+		}
+
+		set_request_signature :update_recurring_payments_profile, {
+
+		}
+
 	end
 end

data/lib/paypal_api/apis/permissions.rb

@@ -0,0 +1,5 @@
+module Paypal
+	class Permissions < Paypal::Api
+
+	end
+end

data/lib/paypal_api/support/request.rb

@@ -1,7 +1,7 @@
 module Paypal
 	class Request
 
-		cattr_accessor :environment, :user, :pwd, :signature, :version
+		cattr_accessor :environment, :user, :pwd, :signature, :version, :application_id
 
 		PAYPAL_VERSION = "84.0"
 		@@paypal_info = nil
@@ -12,7 +12,7 @@ module Paypal
 		@required = []
 		@sequential = []
 
-		attr_accessor :payload, :error_message
+		attr_accessor :payload, :error_message, :test_request
 
 		def initialize(payload = {})
 			config
@@ -42,17 +42,25 @@ module Paypal
 			@sequential
 		end
 
+		def request_host
+			URI.parse(@@paypal_endpoint).host
+		end
+
 		def paypal_endpoint_with_defaults
-			return "#{@@paypal_endpoint}?PWD=#{@@paypal_info["password"] || self.class.pwd}" +
-				"&USER=#{@@paypal_info["username"] || self.class.user}" +
-				"&SIGNATURE=#{@@paypal_info["signature"] || self.class.signature}" +
-				"&VERSION=#{self.class.version || PAYPAL_VERSION}"
+			return "#{@@paypal_endpoint}?PWD=#{password}" +
+				"&USER=#{user}" +
+				"&SIGNATURE=#{signature}" +
+				"&VERSION=#{version}"
 		end
 
 		def sequentials_string
 			self.class.sequential_keys.map{|k| self.send(k).to_query_string }.join
 		end
 
+		def to_key(symbol)
+			return symbol.to_s.gsub(/[^a-z0-9]/i, "").upcase
+		end
+
 		def request_string
 			(@payload.keys | self.class.required_keys).inject(paypal_endpoint_with_defaults + sequentials_string) do |acc, key|
 				# if key signature is hash or optional...
@@ -62,32 +70,66 @@ module Paypal
 
 		# separated out so as not to stub Kernel.open in tests
 		def make_request
-			response = open(request_string)
-			return Paypal::Response.new(response)
+			response = nil
+			if self.respond_to? :headers
+				uri = URI.parse(request_string)
+
+				http = Net::HTTP.new(uri.host, uri.port)
+				http.set_debug_output $stderr if @test_request
+				http.use_ssl = true
+				http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+				request = Net::HTTP::Get.new(uri.request_uri)
+				headers.each do |k,v|
+					request[k] = v
+				end
+
+				response = http.request(request).body
+			else
+				$stderr.puts(request_string) if @test_request
+
+				response = open(request_string)
+			end
+
+			return process_response(response)
+		end
+
+		def process_response(response)
+			Paypal::Response.new(response)
 		end
 
 		def make(&block)
 			params_fulfilled?
 			validate!
 
-			begin
-				response = make_request
+			response = make_request
 
-				if block
-					yield response
-				else
-					return response
+			if block
+				yield response
+			else
+				return response
+			end
+
+			do_request = lambda {
+
+			}
+
+			if @test_request
+				do_request.call
+			else
+				begin
+					do_request.call
+				rescue OpenURI::HTTPError => error
+					# status_code = error.io.status[0]
+					# Rails.logger.info "[ERROR][Paypal] #{error.message } : #{error.backtrace} " if @@rails
+					raise $!
+				# rescue Timeout::Error => time_out_error
+				# 	Rails.logger.info "[ERROR][Timeout Error] #{time_out_error.message} : #{time_out_error.backtrace}" if @@rails
+				# 	raise $!
+				rescue => err
+					# Rails.logger.info "[ERROR][Something went wrong] #{err.message} : #{err.backtrace}" if @@rails
+					raise $!
 				end
-			rescue OpenURI::HTTPError => error
-				status_code = error.io.status[0]
-				# Rails.logger.info "[ERROR][Paypal] #{error.message } : #{error.backtrace} " if @@rails
-				raise $!
-			# rescue Timeout::Error => time_out_error
-			# 	Rails.logger.info "[ERROR][Timeout Error] #{time_out_error.message} : #{time_out_error.backtrace}" if @@rails
-			# 	raise $!
-			rescue => err
-				# Rails.logger.info "[ERROR][Something went wrong] #{err.message} : #{err.backtrace}" if @@rails
-				raise $!
 			end
 		end
 
@@ -95,18 +137,55 @@ module Paypal
 
 			include Paypal::Formatters
 
+			def user
+				@@paypal_info["username"] || self.class.user
+			end
+
+			def signature
+				@@paypal_info["signature"] || self.class.signature
+			end
+
+			def password
+				@@paypal_info["password"] || self.class.pwd
+			end
+
+			def application_id
+				@@paypal_info["application_id"] || self.class.application_id
+			end
+
+			def version
+				self.class.version || PAYPAL_VERSION
+			end
+
 			# override for custom request validation
 			def validate!
 				return true
 			end
 
+			# for completeness
+			def self.parent_api
+				return nil
+			end
+
+			def self.api_method
+				""
+			end
+
+			def self.api_endpoint
+				"https://api-3t.paypal.com/nvp"
+			end
+
+			def self.api_sandbox_endpoint
+				"https://api-3t.sandbox.paypal.com/nvp"
+			end
+
 			def config
 
 				@@paypal_info = {}
 
-				@@paypal_info = get_info if Module.const_defined?("Rails")
+				@@paypal_info = get_info if Module.const_defined?("Rails") && (Module.const_get("Rails").respond_to?(:root) && !Module.const_get("Rails").root.nil?)
 
-				@@paypal_endpoint = (@@paypal_info["environment"] == "production" || Paypal::Request.environment == "production") ? "https://api-3t.paypal.com/nvp" : "https://api-3t.sandbox.paypal.com/nvp"
+				@@paypal_endpoint = (@@paypal_info["environment"] == "production" || Paypal::Request.environment == "production") ? self.class.api_endpoint : self.class.api_sandbox_endpoint
 
 			end
 

data/lib/paypal_api/support/response.rb

@@ -1,7 +1,7 @@
 module Paypal
 	class Response
 
-		attr_accessor :raw_response, :parsed_response, :error_code
+		attr_accessor :raw_response, :parsed_response, :error_code, :paypal_error_field
 
 		def initialize(stringio)
 			@raw_response = stringio.class == StringIO ? stringio.read : stringio
@@ -36,14 +36,14 @@ module Paypal
 		end
 
 		def error_field
-			@@error_codes[@error_code] ? @@human_readable[@@error_codes[@error_code]] : nil
+			@paypal_error_field || (@@error_codes[@error_code] ? @@human_readable[@@error_codes[@error_code]] : nil)
 		end
 
 		def error_message
 			@error_message + "[#{@error_code}]"
 		end
 
-		private
+		protected
 
 			def symbol_to_key(symbol)
 				return symbol.to_s.gsub(/[^0-9a-z]/i, "").upcase

data/lib/paypal_api/version.rb

@@ -1,3 +1,3 @@
 module Paypal
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

data/lib/paypal_api.rb

@@ -1,6 +1,7 @@
 require "cgi"
 require "open-uri"
 require 'active_support/core_ext/class/attribute_accessors'
+require "net/http"
 
 module Paypal
 	class InvalidRequest < StandardError; end
@@ -14,8 +15,18 @@ $:.push File.expand_path("../../lib", __FILE__)
 
 require "paypal_api/version"
 require "paypal_api/apis/api"
+
 require "paypal_api/support/parameter"
 require "paypal_api/support/response"
 require "paypal_api/support/request"
+
+require "generators/paypal/ipn_message_generator"
+
 require "paypal_api/apis/payments_pro"
-require "paypal_api/apis/mass_pay"
+require "paypal_api/apis/express_checkout"
+require "paypal_api/apis/adaptive_payments"
+require "paypal_api/apis/adaptive_accounts"
+require "paypal_api/apis/invoicing"
+require "paypal_api/apis/mass_pay"
+require "paypal_api/apis/button_manager"
+require "paypal_api/apis/permissions"

data/paypal_api.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "activesupport", "3.2.1"
+  # s.add_dependency "activesupport", "~> 3.1"
+  s.add_dependency "rails", "~> 3.1"
 
-  s.add_development_dependency "rspec", "~> 2.6"
-  s.add_development_dependency "rspec-mocks", "~> 2.6"
-  s.add_development_dependency "rake", "0.8.7"
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "rspec-rails", "~> 2.6"
+  s.add_development_dependency "generator_spec", "0.8.5"
+  # s.add_development_dependency "rake", "0.8.7"
 end

data/spec/generators/ipn_message_generator_spec.rb

@@ -0,0 +1,43 @@
+require "rails/all"
+require "spec_helper"
+require "generator_spec/test_case"
+
+describe Paypal::Generators::IpnMessageGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "should add model file" do
+    assert_file "app/models/ipn_message.rb"
+  end
+
+  specify do
+    destination_root.should have_structure {
+      no_file "test.rb"
+      directory "app" do
+        directory "models" do
+          file "ipn_message.rb" do
+            contains "def self.create_from_message"
+            contains "def unique_ids"
+          end
+        end
+      end
+      directory "db" do
+        directory "migrate" do
+          migration "add_ipn_messages" do
+            contains "class CreateIpnMessages"
+            contains ":message"
+            contains ":correlation_id"
+            contains ":transaction_id"
+            contains ":tracking_id"
+            contains ":success"
+          end
+        end
+      end
+    }
+  end
+end

data/spec/support/parameter_spec.rb

@@ -1,3 +1,4 @@
+require "rails/all"
 require "spec_helper"
 
 describe Paypal::Api::Parameter do
@@ -67,13 +68,13 @@ describe Paypal::Api::Parameter do
 
 	describe Paypal::Api::Sequential do
 		before do
-			class Test < @api
+			class Testical < @api
 				set_request_signature :tester, {
 					:sequential => @api::Sequential.new({:l_string => String, :l_fixnum => Fixnum, :l_set_category => Optional.new(String)})
 				}
 			end
 
-			@request = Test.tester
+			@request = Testical.tester
 			@request.sequential.push({:l_string => "sasdf", :l_fixnum => 23, :l_set_category => "asdfasdf"})
 
 

data/spec/support/request_spec.rb

@@ -44,6 +44,7 @@ describe Paypal::Request do
 		describe "for production" do
 			before do
 				Module.should_receive(:const_defined?).and_return(true)
+				Module.should_receive(:const_get).twice.and_return(stub(:root => true))
 
 				Paypal::Request.any_instance.should_receive(:get_info).and_return({"environment" => "production" })
 			end
@@ -72,7 +73,7 @@ describe Paypal::Request do
 		before do
 			@api = Paypal::Api
 
-			class Test < @api
+			class Testical < @api
 				set_request_signature :tester, {
 					:test_field => "something",
 					:optional => @api::Optional.new(String),
@@ -84,7 +85,7 @@ describe Paypal::Request do
 				}
 			end
 
-			@request = Test.tester({
+			@request = Testical.tester({
 				:string => "adsafasdf",
 				:fixnum => 23,
 				:enum => :one

data/spec/unit/adaptive_payments_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe Paypal::AdaptivePayments do
+
+	before :all do
+		Paypal::Request.application_id = "APP-80W284485P519543T"
+	end
+
+	describe :to_key do
+		it "should camel but not first letter" do
+			string = Paypal::AdaptivePaymentsRequest.new.to_key(:som_symbole_here)
+			string.should eq("somSymboleHere")
+		end
+	end
+
+	describe :pay do
+		before(:each) do
+			@request = Paypal::AdaptivePayments.pay
+		end
+
+		it "should be a PayRequest" do
+			@request.should be_a(Paypal::PayRequest)
+		end
+
+		it "should be invalid without a lot of stuff" do
+			@request.valid?.should be_false
+			@request.error_message.should_not be_nil
+		end
+
+		context "with some information filled in" do
+			before(:each) do
+				@request.receiver.push({
+					:email => "test@dude.com",
+					:amount => 10.22
+				})
+				@request.cancel_url = "http://www.test.com/cancel"
+				@request.return_url = "http://www.test.com/return"
+				@request.ip_address = "168.212.226.204"
+			end
+
+			shared_examples_for "a good pay request" do
+				it "should look like a successful request" do
+					@request.request_string.should include("&receiverList.receiver(0).email=test%40dude.com&receiverList.receiver(0).amount=10.22&actionType=")
+					@request.request_string.should include("&currencyCode=USD&cancelUrl=http%3A%2F%2Fwww.test.com%2Fcancel&returnUrl=http%3A%2F%2Fwww.test.com%2Freturn&requestEnvelope.errorLanguage=en_US&requestEnvelope.detailLevel=ReturnAll")
+				end
+
+				it "should not raise exception, response should be success" do
+					Paypal::PayRequest.any_instance.stub(:make_request).and_return("")
+					expect {
+						response = @request.make
+					}.to_not raise_exception(Paypal::InvalidRequest)
+				end
+
+				it "should get a response from paypal", :slow_paypal => true do
+					# @request.test_request = true
+					response = @request.make
+					response.success?.should be_true
+				end
+
+				describe "with stubbed response" do
+					before(:each) do
+						Paypal::PayRequest.any_instance.stub(:make_request).and_return(Paypal::AdaptivePaymentsResponse.new("responseEnvelope.timestamp=2012-02-29T13%3A40%3A17.074-08%3A00&responseEnvelope.ack=Success&responseEnvelope.correlationId=722689b427b7c&responseEnvelope.build=2486531&payKey=AP-1W763567RM6393227&paymentExecStatus=CREATED"))
+						@response = @request.make
+					end
+
+					it "should be an adative payments response" do
+						@response.should be_a(Paypal::AdaptivePaymentsResponse)
+					end
+
+					it "should have a correlation_id" do
+						@response[:correlation_id].should eq("722689b427b7c")
+					end
+
+					it "should have a pay key and exec status" do
+						@response[:pay_key].should eq("AP-1W763567RM6393227")
+						@response[:payment_exec_status].should eq("CREATED")
+					end
+				end
+
+				describe "with stubbed failure" do
+					before(:each) do
+						Paypal::PayRequest.any_instance.stub(:make_request).and_return(Paypal::AdaptivePaymentsResponse.new("responseEnvelope.timestamp=2012-02-29T13%3A35%3A28.528-08%3A00&responseEnvelope.ack=Failure&responseEnvelope.correlationId=ca0befbd1fe0b&responseEnvelope.build=2486531&error(0).errorId=560022&error(0).domain=PLATFORM&error(0).subdomain=Application&error(0).severity=Error&error(0).category=Application&error(0).message=The+X-PAYPAL-APPLICATION-ID+header+contains+an+invalid+value&error(0).parameter(0)=X-PAYPAL-APPLICATION-ID"))
+						@response = @request.make
+					end
+
+					it "should have a correlation id" do
+						@response[:correlation_id].should eq("ca0befbd1fe0b")
+					end
+
+					it "should have an error message" do
+						@response.error_message.should_not be_nil
+					end
+
+					it "should not be success" do
+						@response.success?.should be_false
+					end
+
+					it "should have an error field and code" do
+						@response.error_code.should eq("560022")
+						@response.error_field.should eq("X-PAYPAL-APPLICATION-ID")
+					end
+				end
+			end
+
+			describe "when creating" do
+				before(:each) do
+					@request.action_type = :create
+				end
+
+				it_behaves_like "a good pay request"
+			end
+
+			describe "when paying" do
+				before(:each) do
+					@request.action_type = :pay
+				end
+
+				it_behaves_like "a good pay request"
+			end
+		end
+	end
+end

data/spec/unit/api_spec.rb

@@ -8,7 +8,7 @@ describe Paypal::Api do
 	describe :set_request_signature do
 		it "should be callable from a class body definition" do
 			expect {
-				class Test < @api
+				class Testical < @api
 					set_request_signature :test, {}
 				end
 			}.to_not raise_exception
@@ -16,7 +16,7 @@ describe Paypal::Api do
 
 		context "with field descriptions" do
 			before do
-				class Test < @api
+				class Testical < @api
 					set_request_signature :tester, {
 						:test_field => "something",
 						:optional => @api::Optional.new(String),
@@ -30,27 +30,27 @@ describe Paypal::Api do
 			end
 
 			it "should add getters for all keys" do
-				Test.tester.payload.each do |k,v|
-					Test.tester.respond_to?(k).should be_true
+				Testical.tester.payload.each do |k,v|
+					Testical.tester.respond_to?(k).should be_true
 				end
 			end
 
 			it "should return a dynamic request object" do
-				Test.tester.class.should eq(Paypal::TesterRequest)
+				Testical.tester.class.should eq(Paypal::TesterRequest)
 			end
 
 			it "should make the class respond to class method" do
-				Test.respond_to?(:tester).should be_true
+				Testical.respond_to?(:tester).should be_true
 			end
 
 			it "should add constant getters and not setters for value types" do
-				Test.tester.respond_to?(:test_field).should be_true
-				Test.tester.send(:test_field).should eq("something")
-				Test.tester.respond_to?(:test_field=).should be_false
+				Testical.tester.respond_to?(:test_field).should be_true
+				Testical.tester.send(:test_field).should eq("something")
+				Testical.tester.respond_to?(:test_field=).should be_false
 			end
 
 			it "should add setters for all non-constant types" do
-				request = Test.tester
+				request = Testical.tester
 				request.payload.each do |k,v|
 					if [String, Fixnum, Float].include?(v.class)
 						request.respond_to?(k).should be_false
@@ -61,7 +61,7 @@ describe Paypal::Api do
 			end
 
 			it "should raise an InvalidRequest error when missing required fields" do
-				request = Test.tester
+				request = Testical.tester
 				expect {
 					request.make
 				}.to raise_exception(Paypal::InvalidRequest)
@@ -69,7 +69,7 @@ describe Paypal::Api do
 
 			describe "setters" do
 				before do
-					@request = Test.tester
+					@request = Testical.tester
 				end
 
 				it "should handle sequential types" do

data/spec/unit/mass_pay_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe Paypal::MassPay do
+describe Paypal::MassPayApi do
 
 	describe :mass_pay do
 		before(:each) do
-			@request = Paypal::MassPay.mass_pay
+			@request = Paypal::MassPayApi.mass_pay
 		end
 
 		it "should be invalid without a payee" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000Z
+date: 2012-03-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70128187644320 !ruby/object:Gem::Requirement
+  name: rails
+  requirement: &70244225979560 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70128187644320
+  version_requirements: *70244225979560
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70128187643520 !ruby/object:Gem::Requirement
+  name: ruby-debug19
+  requirement: &70244225978140 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128187643520
+  version_requirements: *70244225978140
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: &70128187642680 !ruby/object:Gem::Requirement
+  name: rspec-rails
+  requirement: &70244225976180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,18 +43,18 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70128187642680
+  version_requirements: *70244225976180
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70128187642120 !ruby/object:Gem::Requirement
+  name: generator_spec
+  requirement: &70244225974780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.5
   type: :development
   prerelease: false
-  version_requirements: *70128187642120
+  version_requirements: *70244225974780
 description: alpha - currently covers part of payments pro and all of mass pay
 email:
 - matt.handler@gmail.com
@@ -65,22 +65,34 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- MIT-LICENSE
 - README.markdown
 - Rakefile
 - init.rb
+- lib/generators/paypal/ipn_message_generator.rb
+- lib/generators/templates/ipn_message.rb
+- lib/generators/templates/migration.rb
 - lib/paypal_api.rb
+- lib/paypal_api/apis/adaptive_accounts.rb
+- lib/paypal_api/apis/adaptive_payments.rb
 - lib/paypal_api/apis/api.rb
+- lib/paypal_api/apis/button_manager.rb
+- lib/paypal_api/apis/express_checkout.rb
+- lib/paypal_api/apis/invoicing.rb
 - lib/paypal_api/apis/mass_pay.rb
 - lib/paypal_api/apis/payments_pro.rb
+- lib/paypal_api/apis/permissions.rb
 - lib/paypal_api/support/parameter.rb
 - lib/paypal_api/support/request.rb
 - lib/paypal_api/support/response.rb
 - lib/paypal_api/version.rb
 - paypal_api.gemspec
+- spec/generators/ipn_message_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/parameter_spec.rb
 - spec/support/request_spec.rb
 - spec/support/response_spec.rb
+- spec/unit/adaptive_payments_spec.rb
 - spec/unit/api_spec.rb
 - spec/unit/mass_pay_spec.rb
 - spec/unit/payments_pro_spec.rb
@@ -109,10 +121,12 @@ signing_key:
 specification_version: 3
 summary: an interface to paypals api
 test_files:
+- spec/generators/ipn_message_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/parameter_spec.rb
 - spec/support/request_spec.rb
 - spec/support/response_spec.rb
+- spec/unit/adaptive_payments_spec.rb
 - spec/unit/api_spec.rb
 - spec/unit/mass_pay_spec.rb
 - spec/unit/payments_pro_spec.rb