paypal-ipn 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 David Wilkie
+
+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

@@ -0,0 +1,113 @@
+# paypal
+A simple ruby wrapper for paypal.
+
+## Features
+Currently paypal supports the following:
+
+* Verifying Paypal IPN's
+* MassPay Requests
+
+## Configuration
+    Paypal.setup do |config|
+      config.environment = "sandbox" # replace with "live" in production
+      config.api_username = "Replace me with your api username"
+      config.api_password = "Replace me with your api password"
+      config.api_signature = "Replace me with your api signature"
+    end
+
+## Usage
+### IPN Modules
+#### Paypal::Ipn
+    class PaypalIpn
+      include Paypal::Ipn
+      attr_accessor :params
+    end
+Note: Your class must respond to `params` and return a hash of paypal ipn parameters
+
+##### Public methods
+* `payment_completed?`
+* `payment_status`
+* `txn_id`
+
+##### Private methods
+* `verify` Verifies the IPN with paypal and returns true or false
+* `receiver_email`
+* `self.txn_type(params)`
+* `self.masspay_transaction?(params)`
+
+#### Paypal::Ipn::Buyer
+    class BuyerPaypalIpn
+      include Paypal::Ipn::Buyer
+      attr_accessor :params
+    end
+
+##### Public methods
+* `customer_address` Convienence method. e.g.
+John Smith,
+5 Some Street,
+Some City,
+Some State,
+Australia 1234
+* `customer_address_name`
+* `customer_address_street`
+* `customer_address_city`
+* `customer_address_state`
+* `customer_address_zip`
+* `customer_address_country`
+
+#### Paypal::Ipn::Item
+    class ItemPaypalIpn
+      include Paypal::Ipn::Item
+      attr_accessor :params
+    end
+
+##### Public methods
+* `item_name(index = nil)` If index is supplied it will return item_name#index otherwise simply item_name
+* `item_number(index = nil)`
+* `item_quantity(index = nil)`
+* `number_of_cart_items`
+
+#### Paypal::Ipn::Masspay
+    class MasspayPaypalIpn
+      include Paypal::Ipn::Masspay
+      attr_accessor :params
+    end
+Note: Currently Masspay IPN's only support a single transaction
+
+##### Public methods
+* `payment_status` Returns the payment status for the 1st transaction
+* `txn_id` Returns the transaction id for the 1st transaction
+* `payment_unclaimed?` Returns whether the payment status for the 1st transaction was unclaimed or not
+
+##### Private methods
+* `unique_id` Returns the unique_id for the 1st transaction
+
+### Masspay
+    class Masspay
+      include Paypal::Masspay
+      attr_accessor :payment_response
+    end
+Note: Your class must respond to `payment_response` and return the payment response as a hash
+
+##### Public methods
+* `successful_payment?` Returns whether the masspay request was successful or not. Note: This only tells you if the request was successful or not. You should wait for an IPN to verify the receiver has been paid.
+
+##### Private methods
+* `masspay(payer_email, receiver_email, amount, currency, note, unique_id)` Sends a mass pay request from *payer_email* to *receiver_email* for *amount* in *currency*. The *note* will appear on the receivers paypal account and the *unique_id* will be passed back in the Paypal IPN. Returns the response from paypal.
+
+* `payment_error_type` Returns *:unauthorized* or *:insufficient_funds* for these types of errors otherwise returns *:unknown*
+
+* `payment_error_message` Returns the paypal long error message
+
+Note: Currently Masspay payments only support a single recipient
+
+## Rails
+    `rails g paypal:initializer`
+Generates a stub initializer under config/initializers
+
+## Installation
+
+    gem install paypal
+
+Copyright (c) 2010 David Wilkie, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the Paypal plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.libs << 'features'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "paypal-ipn"
+    gemspec.summary = "Another ruby wrapper for Paypal"
+    gemspec.email = "dwilkie@gmail.com"
+    gemspec.homepage = "http://github.com/dwilkie/paypal"
+    gemspec.authors = ["David Wilkie"]
+    gemspec.add_runtime_dependency "httparty", ">=0.6.1"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc 'Generate documentation for the Paypal plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Paypal'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/generators/paypal/initializer/USAGE

@@ -0,0 +1,6 @@
+Description:
+  Creates an initializer under config/initializers
+
+Example:
+  rails g paypal:initializer
+

data/lib/generators/paypal/initializer/initializer_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+module Paypal
+  class InitializerGenerator < Rails::Generators::Base
+
+    def self.source_root
+       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def copy_conversation_file
+      copy_file "paypal.rb", "config/initializers/paypal.rb"
+    end
+  end
+end
+

data/lib/generators/paypal/initializer/templates/paypal.rb

@@ -0,0 +1,7 @@
+Paypal.setup do |config|
+  config.environment = Rails.env.production? ? "live" : "sandbox"
+  config.api_username = "Replace me with your api username"
+  config.api_password = "Replace me with your api password"
+  config.api_signature = "Replace me with your api signature"
+end
+

data/lib/paypal/ipn/ipn.rb

@@ -0,0 +1,61 @@
+module Paypal
+  module Ipn
+    include HTTParty
+
+    LIVE_POSTBACK_URI = "https://www.paypal.com/cgi-bin/webscr"
+    SANDBOX_POSTBACK_URI = "https://www.sandbox.paypal.com/cgi-bin/webscr"
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def self.postback_uri
+      Paypal.environment == "live" ?
+      LIVE_POSTBACK_URI :
+      SANDBOX_POSTBACK_URI
+    end
+
+    def self.verify(params)
+      request_uri = URI.parse(postback_uri)
+      request_uri.scheme = "https" # force https
+      self.post(
+        request_uri.to_s,
+        :body => params.merge("cmd"=>"_notify-validate")
+      ).body == "VERIFIED"
+    end
+
+    def payment_status
+      params["payment_status"] if params
+    end
+
+    def payment_completed?
+      payment_status == "Completed"
+    end
+
+    def txn_id
+      params["txn_id"] if params
+    end
+    alias_method :transaction_id, :txn_id
+
+    private
+      def verify
+        Paypal::Ipn.verify(params)
+      end
+
+      def receiver_email
+        params["receiver_email"]
+      end
+
+    module ClassMethods
+      private
+        def txn_type(params)
+          params["txn_type"]
+        end
+
+        def masspay_transaction?(params)
+          txn_type(params) == "masspay"
+        end
+    end
+  end
+end
+

data/lib/paypal/ipn/types/masspay.rb

@@ -0,0 +1,24 @@
+module Paypal
+  module Ipn
+    module Masspay
+      def payment_status
+        params["status_1"] if params
+      end
+
+      def payment_unclaimed?
+        payment_status == "Unclaimed"
+      end
+
+      def txn_id
+        params["masspay_txn_id_1"] if params
+      end
+      alias_method :transaction_id, :txn_id
+
+      private
+        def unique_id
+          params["unique_id_1"]
+        end
+    end
+  end
+end
+

data/lib/paypal/ipn/variables/buyer.rb

@@ -0,0 +1,40 @@
+module Paypal
+  module Ipn
+    module Buyer
+      def customer_address(delimeter = ",\n")
+        [
+          customer_address_name,
+          customer_address_street,
+          customer_address_city,
+          customer_address_state,
+          customer_address_country + " " + customer_address_zip,
+        ].join(delimeter)
+      end
+
+      def customer_address_name
+        self.params["address_name"].to_s
+      end
+
+      def customer_address_street
+        self.params["address_street"].to_s
+      end
+
+      def customer_address_city
+        self.params["address_city"].to_s
+      end
+
+      def customer_address_state
+        self.params["address_state"].to_s
+      end
+
+      def customer_address_zip
+        self.params["address_zip"].to_s
+      end
+
+      def customer_address_country
+        self.params["address_country"].to_s
+      end
+    end
+  end
+end
+

data/lib/paypal/ipn/variables/item.rb

@@ -0,0 +1,31 @@
+module Paypal
+  module Ipn
+    module Item
+      def item_name(index = nil)
+        item_attribute_value("item_name", index)
+      end
+
+      def item_quantity(index = nil)
+        item_attribute_value("quantity", index).to_i
+      end
+
+      def item_number(index = nil)
+        item_attribute_value("item_number", index).to_s
+      end
+
+      def number_of_cart_items
+        num_cart_items = params["num_cart_items"] || 1
+        num_cart_items.to_i
+      end
+
+      private
+        def item_attribute_value(key, index = nil)
+          non_indexed_value = params[key]
+          index && params["num_cart_items"] ?
+            params["#{key}#{index + 1}"]
+          : non_indexed_value
+        end
+    end
+  end
+end
+

data/lib/paypal/masspay.rb

@@ -0,0 +1,58 @@
+module Paypal
+  module Masspay
+    include HTTParty
+
+    def self.masspay(payer_email, receiver_email, amount, currency, note, unique_id)
+      request_uri = URI.parse(Paypal.nvp_uri)
+      request_uri.scheme = "https" # force https
+
+      body = {
+        "METHOD" => "MassPay",
+        "VERSION" => "2.3",
+        "CURRENCYCODE" => currency,
+        "SUBJECT" => payer_email,
+        "USER" => Paypal.api_username,
+        "PWD" => Paypal.api_password,
+        "SIGNATURE" => Paypal.api_signature,
+        "RECEIVERTYPE" => "EmailAddress",
+        "L_EMAIL0" => receiver_email,
+        "L_AMT0" => amount,
+        "L_UNIQUEID0" => unique_id,
+        "L_NOTE0" => note
+      }
+      self.post(request_uri.to_s, :body => body).body
+    end
+
+    def successful_payment?
+      payment_response["ACK"] == "Success"
+    end
+
+    private
+      def masspay(payer_email, receiver_email, amount, currency, note, unique_id)
+        Paypal::Masspay.masspay(
+          payer_email,
+          receiver_email,
+          amount,
+          currency,
+          note,
+          unique_id
+        )
+      end
+
+      def payment_error_type
+        case payment_response["L_ERRORCODE0"]
+          when "10002" || "10007"
+            :unauthorized
+          when "10321"
+            :insufficient_funds
+          else
+            :unknown
+        end
+      end
+
+      def payment_error_message
+        payment_response["L_LONGMESSAGE0"]
+      end
+  end
+end
+

data/lib/paypal.rb

@@ -0,0 +1,29 @@
+require 'paypal/ipn/ipn'
+require 'paypal/ipn/types/masspay'
+require 'paypal/ipn/variables/buyer'
+require 'paypal/ipn/variables/item'
+require 'paypal/masspay'
+
+module Paypal
+
+  LIVE_NVP_URI = "https://api-3t.paypal.com/nvp"
+  SANDBOX_NVP_URI = "https://api-3t.sandbox.paypal.com/nvp"
+
+  mattr_accessor :environment,
+                 :api_username,
+                 :api_password,
+                 :api_signature
+
+  # Default way to setup Paypal. Run rails generate paypal_install to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+
+  def self.nvp_uri
+    environment == "live" ?
+      LIVE_NVP_URI :
+      SANDBOX_NVP_URI
+  end
+end
+

data/paypal.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paypal}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Wilkie"]
+  s.date = %q{2010-09-24}
+  s.email = %q{dwilkie@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/paypal/initializer/USAGE",
+     "lib/generators/paypal/initializer/initializer_generator.rb",
+     "lib/generators/paypal/initializer/templates/paypal.rb",
+     "lib/paypal.rb",
+     "lib/paypal/ipn/ipn.rb",
+     "lib/paypal/ipn/types/masspay.rb",
+     "lib/paypal/ipn/variables/buyer.rb",
+     "lib/paypal/ipn/variables/item.rb",
+     "lib/paypal/masspay.rb",
+     "paypal.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dwilkie/paypal}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Another ruby wrapper for Paypal}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: paypal-ipn
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Wilkie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: dwilkie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/generators/paypal/initializer/USAGE
+- lib/generators/paypal/initializer/initializer_generator.rb
+- lib/generators/paypal/initializer/templates/paypal.rb
+- lib/paypal.rb
+- lib/paypal/ipn/ipn.rb
+- lib/paypal/ipn/types/masspay.rb
+- lib/paypal/ipn/variables/buyer.rb
+- lib/paypal/ipn/variables/item.rb
+- lib/paypal/masspay.rb
+- paypal.gemspec
+has_rdoc: true
+homepage: http://github.com/dwilkie/paypal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Another ruby wrapper for Paypal
+test_files: []
+