will_paypal 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+doc
+Manifest

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ree@nvp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    will_paypal (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.0)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  rspec (~> 2.6.0)
+  will_paypal!

data/README.rdoc

@@ -0,0 +1,56 @@
+= Paypal NVP
+
+Will Paypal allow to connect your Ruby on Rails application to the Paypal NVP API. It's based on the Paypal NVP Gem https://github.com/solisoft/paypal_nvp but completely rewritten.
+
+== Installation
+
+The recommended way is that you get the gem:
+
+  $ sudo gem install will_paypal
+
+Specify the API-Credentials within the constructor, add a logger. You can also use a 'settings.yml' to put everything there
+
+  # All those fields are mandatory
+
+  sandbox:
+    url:  "https://api-3t.sandbox.paypal.com/nvp" (default)
+    user: "o.bonn_1237393081_biz_api1.solisoft.net"
+    password: "1237393093"
+    signature:  "AU2Yv5COwWPCfeYLv34Z766F-gfNAzX6LaQE6VZkHMRq35Gmite-bMXu"
+    version: "72.0" (default)
+
+  live:
+    url:  "https://api-3t.paypal.com/nvp" (default)
+    user: "o.bonn_1237393081_biz_api1.solisoft.net"
+    password: "1237393093"
+    signature:  "AU2Yv5COwWPCfeYLv34Z766F-gfNAzX6LaQE6VZkHMRq35Gmite-bMXu"
+    version: "72.0" (default)
+
+== Example usage
+
+  p = WillPaypal.new(:user => Settings.payment.paypal.merchant, :password => Settings.payment.paypal.pass, :sandbox => Settings.payment.paypal.sandbox, :signature => Settings.payment.paypal.cert, :version => "72.0", :logger => logger)
+
+  data = {
+    :method => "MyPaypalMethod",
+    :amt => "55"
+    # other params needed
+  }
+  result = p.call_paypal(data) # will return a hash
+  puts result[:parsed_body]["ACK"] # Success
+
+  The Result-Hash looks like that:
+
+    :parsed_body=>{
+      "TIMESTAMP"=>"2011-05-19T00:25:19Z",
+      "BUILD"=>"1882144",
+      "VERSION"=>"72.0",
+      "CORRELATIONID"=>"correlationid",
+      "TOKEN"=>"mytoken",
+      "ACK"=>"Success"
+      },
+    :status=>"200",
+    :body=>"TOKEN=mytoken&TIMESTAMP=2011%2d05%2d19T00%3a25%3a19Z&CORRELATIONID=correlationid&ACK=Success&VERSION=72%2e0&BUILD=1882144"
+
+== PAYPAL API Documentation
+
+https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/howto_api_reference

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/will_paypal.rb

@@ -0,0 +1,69 @@
+require "logger"
+require "net/https"
+require "cgi"
+
+class WillPaypal
+
+  attr_accessor :config, :logger
+
+  DEFAULT_OPTIONS = {
+    :version => "72.0",
+    :sandbox => false,
+    :params => {}
+  }
+
+  def initialize(config={})
+    self.config = DEFAULT_OPTIONS.merge(config)
+    self.logger = config.delete(:logger) || Logger.new(STDOUT)
+    self.config[:url] ||= self.config[:sandbox] ? "https://api-3t.sandbox.paypal.com/nvp" : "https://api-3t.paypal.com/nvp"
+  end
+
+  def query_string_for(data)
+    data.merge!({
+     "USER"       => self.config[:user],
+     "PWD"        => self.config[:password],
+     "SIGNATURE"  => self.config[:signature],
+     "VERSION"    => self.config[:version]
+    })
+    data.merge!(self.config[:params])
+    query = []
+    data.each do |key, value|
+      query << "#{key.to_s.upcase}=#{URI.escape(value.to_s)}"
+    end
+    query.join("&")
+  end
+
+  def hash_from_query_string(query_string)
+    hash = {}
+    query_string.split("&").each do |element|
+      a = element.split("=")
+      hash[a[0]] = CGI.unescape(a[1]) if a.size == 2
+    end
+    hash
+  end
+
+  def call_paypal(data)
+    uri = URI.parse(self.config[:url])
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    rootCA = '/etc/ssl/certs'
+    if File.directory? rootCA
+      http.ca_path = rootCA
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_depth = 5
+    else
+      self.logger.warn "WARNING: no ssl certs found. Paypal communication will be insecure. DO NOT DEPLOY"
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    response = http.request_post(uri.path, self.query_string_for(data))
+    response_hash = { :status => response.code, :body => response.body, :parsed_body => {} }
+
+    if response.kind_of? Net::HTTPSuccess
+      response_hash[:parsed_body].merge! self.hash_from_query_string(response.body)
+    end
+    response_hash
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "will_paypal"
+require "rspec"
+require 'fakeweb'
+
+RSpec.configure do |config|
+end

data/spec/will_paypal_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe "WillPaypal" do
+
+  describe "initialize" do
+
+    context "overwriting defaults" do
+      subject { WillPaypal.new(:version => "1").config[:version] }
+      it { should == "1" }
+    end
+
+    context "with defaults" do
+      subject { WillPaypal.new }
+
+      its(:config) do
+        should eql({
+          :version => "72.0",
+          :sandbox => false,
+          :url => "https://api-3t.paypal.com/nvp",
+          :params => {}
+        })
+      end
+
+    end
+  end
+
+  describe "Request to Paypal" do
+
+    describe "Query String" do
+
+      let(:paypal) { WillPaypal.new }
+
+      it "should create a valid querystring from request params" do
+        %w{FOO=bar BAR=foo USER= PWD= SIGNATURE=}.each do |a|
+          paypal.query_string_for({ :foo => "bar", :bar => "foo" }).should include (a)
+        end
+      end
+
+      %w{user pwd signature}.each do |param|
+        it "should include #{param} by default" do
+          paypal.query_string_for({}).should include("#{param.to_s.upcase}=#{URI.escape(paypal.config[param.to_sym].to_s)}")
+        end
+      end
+
+    end
+
+  end
+
+  describe "Paypal response" do
+
+    let(:paypal) { WillPaypal.new }
+
+    it "should convert a query string like" do
+      paypal.hash_from_query_string("FOO=bar&BAR=foo&SIGNATURE=123456").should eql({
+        "FOO" => "bar", "BAR" => "foo", "SIGNATURE" => "123456"
+      })
+    end
+
+    it "should remove blank attributes" do
+      paypal.hash_from_query_string("FOO=bar&BAR=foo&USER=&PWD=&SIGNATURE=123456&VERSION=72.0").should eql({
+        "FOO" => "bar", "BAR" => "foo", "SIGNATURE" => "123456", "VERSION" => "72.0"
+      })
+    end
+
+  end
+
+  describe "Paypal Call" do
+
+    context "success" do
+      let(:paypal) { WillPaypal.new(:user => "team_1220115929_biz_api1.example.com", :pass => "1240413944", :cert => "acert4qi4-AdHZBSIbxJNpN30UcsogreatcertP", :version => "72.0") }
+
+      it "should return the successful response" do
+        response_data = "TIMESTAMP=2011%2d05%2d18T17%3a51%3a55Z&CORRELATIONID=f45a2a3867a2b&ACK=Success&VERSION=72%2e0&BUILD=1882144&L_ERRORCODE0=10002&L_SHORTMESSAGE0=Authentication%2fAuthorization%20Failed&L_LONGMESSAGE0=You%20do%20not%20have%20permissions%20to%20make%20this%20API%20call&L_SEVERITYCODE0=Error"
+        FakeWeb.register_uri(:post, %r|https://api-3t.paypal.com/nvp|, :body => response_data, :times => 1)
+        paypal.call_paypal({}).should eql({:status => "200", :body => response_data, :parsed_body => {"L_SEVERITYCODE0"=>"Error", "TIMESTAMP"=>"2011-05-18T17:51:55Z", "L_ERRORCODE0"=>"10002", "BUILD"=>"1882144", "L_LONGMESSAGE0"=>"You do not have permissions to make this API call", "VERSION"=>"72.0", "L_SHORTMESSAGE0"=>"Authentication/Authorization Failed", "CORRELATIONID"=>"f45a2a3867a2b", "ACK"=>"Success"}})
+      end
+    end
+
+    context "ssl" do
+      let(:paypal) { WillPaypal.new(:user => "team_1220115929_biz_api1.example.com", :pass => "1240413944", :cert => "acert4qi4-AdHZBSIbxJNpN30UcsogreatcertP", :version => "72.0") }
+
+      it "should do an ssl call" do
+        response_data = "TIMESTAMP=2011%2d05%2d18T17%3a51%3a55Z&CORRELATIONID=f45a2a3867a2b&ACK=Failure&VERSION=72%2e0&BUILD=1882144&L_ERRORCODE0=10002&L_SHORTMESSAGE0=Authentication%2fAuthorization%20Failed&L_LONGMESSAGE0=You%20do%20not%20have%20permissions%20to%20make%20this%20API%20call&L_SEVERITYCODE0=Error"
+        FakeWeb.register_uri(:post, %r|https://api-3t.paypal.com/nvp|, :body => response_data, :times => 1)
+        File.should_receive(:directory?).with('/etc/ssl/certs').and_return(true)
+        http = double("Net::HTTP")
+        Net::HTTP.stub(:new).and_return(http)
+        http_response = double("response")
+        http_response.should_receive(:code)
+        http_response.should_receive(:body)
+        http.should_receive(:request_post).with("/nvp", "USER=team_1220115929_biz_api1.example.com&SIGNATURE=&VERSION=72.0&PWD=").and_return(http_response)
+        http.should_receive(:use_ssl=).with(true)
+        http.should_receive(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
+        http.should_receive(:ca_path=).with('/etc/ssl/certs')
+        http.should_receive(:verify_depth=).with(5)
+        paypal.call_paypal({})
+      end
+
+    end
+
+    context "without ssl" do
+      let(:paypal) { WillPaypal.new(:user => "team_1220115929_biz_api1.example.com", :pass => "1240413944", :cert => "acert4qi4-AdHZBSIbxJNpN30UcsogreatcertP", :version => "72.0") }
+
+      it "should do an ssl call" do
+        response_data = "TIMESTAMP=2011%2d05%2d18T17%3a51%3a55Z&CORRELATIONID=f45a2a3867a2b&ACK=Failure&VERSION=72%2e0&BUILD=1882144&L_ERRORCODE0=10002&L_SHORTMESSAGE0=Authentication%2fAuthorization%20Failed&L_LONGMESSAGE0=You%20do%20not%20have%20permissions%20to%20make%20this%20API%20call&L_SEVERITYCODE0=Error"
+        FakeWeb.register_uri(:post, %r|https://api-3t.paypal.com/nvp|, :body => response_data, :times => 1)
+        File.should_receive(:directory?).with('/etc/ssl/certs').and_return(false)
+        http = double("Net::HTTP")
+        Net::HTTP.stub(:new).and_return(http)
+        http_response = double("response")
+        http_response.should_receive(:code)
+        http_response.should_receive(:body)
+        http.should_receive(:use_ssl=).with(true)
+        http.should_receive(:request_post).with("/nvp", "USER=team_1220115929_biz_api1.example.com&SIGNATURE=&VERSION=72.0&PWD=").and_return(http_response)
+        http.should_receive(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+        paypal.call_paypal({})
+      end
+    end
+
+  end
+
+end

data/will_paypal.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{will_paypal}
+  s.version = "0.1.1"
+  s.platform    = Gem::Platform::RUBY
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Bumann - Railslove", "Jan Kus - Railslove"]
+  s.description = %q{Paypal NVP API Class.}
+  s.email = ["michael@railslove.com", "jan@railslove.com"]
+  s.extra_rdoc_files = ["lib/will_paypal.rb", "README.rdoc"]
+  s.files = ["init.rb", "lib/will_paypal.rb", "Manifest", "Rakefile", "README.rdoc", "will_paypal.gemspec"]
+  s.homepage = %q{https://github.com/railslove/Will-Paypal}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Will_Paypal", "--main", "README.rdoc"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{will_paypal}
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Paypal NVP API Class.}
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "fakeweb"
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: will_paypal
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Michael Bumann - Railslove
+- Jan Kus - Railslove
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Paypal NVP API Class.
+email: 
+- michael@railslove.com
+- jan@railslove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/will_paypal.rb
+- README.rdoc
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/will_paypal.rb
+- spec/spec_helper.rb
+- spec/will_paypal_spec.rb
+- will_paypal-0.1.0.gem
+- will_paypal.gemspec
+has_rdoc: true
+homepage: https://github.com/railslove/Will-Paypal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Will_Paypal
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: will_paypal
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Paypal NVP API Class.
+test_files: 
+- spec/spec_helper.rb
+- spec/will_paypal_spec.rb