poundpay 0.1.3 → 0.2.0

data/README.rdoc

@@ -1,25 +1,29 @@
 == Poundpay
 
-Poundpay is payments platform for marketplaces 
+Poundpay is a payments platform for marketplaces 
 
 
 == Adding Poundpay to Rails
 
 1. Add the following to your Gemfile
 
-    gem 'poundpay', '~> 0.1.2'
+    gem 'poundpay', '~> 0.2.0'
 
 2. At the command prompt, install the gem with bundler
 
     bundle install
 
-3. Add your Poundpay configuration to config/initializers/poundpay.rb
+3. Add your configuration to config/poundpay.yml in your Rails project
 
-    Poundpay.configure(
-      "DV0383d447360511e0bbac00264a09ff3c",  # developer_sid
-      "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a",  # auth_token
-      api_url = "https://api-sandbox.poundpay.com"  # Note: Leave out for production
-    )
+    development:
+      developer_sid: DV0383d447360511e0bbac00264a09ff3c
+      auth_token: c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a
+      www_url: https://www-sandbox.poundpay.com
+      api_url: https://api-sandbox.poundpay.com
+
+    production:
+      developer_sid: DV8dd93f0f3c6411e0863f00264a09ff3c
+      auth_token: d8c4ea1bafd3fcac8c1062a72c22bcdb09321deb1041df257165cd6449def0de
 
 4. Protect your callback controller
 
@@ -60,13 +64,14 @@ the repeat flow when they are not prompted to reenter their credit card informat
         payment_sid: <%= @payment.sid %>,
         success: handlePaymentSuccess,
         error: handlePaymentError,
-        cardholder_name: 'Fred Nietzsche', // note: optional
-        phone_number: '4085551234', // note: optional
-        server: 'https://www-sandbox.poundpay.com' // note: exclude this property when in production
+        cardholder_name: "Fred Nietzsche", // Optional
+        phone_number: "4085551234", // Optional
+        server: "#{Poundpay.www_url}"
       });
     </script>
 
 
 == Releasing a payment
 
+    payment = Payment.find(payment_sid)
     payment.release

data/lib/poundpay/rails.rb

@@ -0,0 +1,6 @@
+if defined? Rails and Rails.root.join("config", "poundpay.yml").exist?
+  module Poundpay
+    @rails_config = YAML::load_file(Rails.root.join("config", "poundpay.yml"))[Rails.env]
+    Poundpay.configure_from_hash(@rails_config)
+  end
+end

data/lib/poundpay/version.rb

@@ -1,3 +1,3 @@
 module Poundpay
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/poundpay.rb

@@ -1,19 +1,81 @@
 require 'poundpay/resource'
 require 'poundpay/elements'
 require 'poundpay/callback'
+require 'poundpay/rails'
+
 
 module Poundpay
+  WWW_URL = "https://www.poundpay.com"
   API_URL = "https://api.poundpay.com"
   API_VERSION = "silver"
 
-  def self.configure(developer_sid, auth_token, api_url=API_URL, version=API_VERSION)
-    unless developer_sid.start_with? "DV"
-      raise ArgumentError.new "developer_sid should start with 'DV'.  Make sure " \
-        "you're using the right developer_sid"
+  class << self
+    attr_writer :api_version
+
+    def configure(developer_sid, auth_token)
+      if not developer_sid
+        raise ArgumentError.new "developer_sid is required"
+      end
+
+      if not auth_token
+        raise ArgumentError.new "auth_token is required"
+      end
+
+      unless developer_sid.start_with? "DV"
+        raise ArgumentError.new "developer_sid should start with 'DV'.  Make sure " \
+          "you're using the right developer_sid"
+      end
+
+      yield self if block_given?
+        
+      api_url.sub! /(\/)$/, ""  # Remove trailing backslash
+      www_url.sub /(\/)$/, ""
+      Resource.site = "#{api_url}/#{api_version}/"
+      Resource.user = developer_sid
+      Resource.password = auth_token
+      @configured = true
+    end
+
+    def configure_from_hash(config)
+      configure(config["developer_sid"], config["auth_token"]) do |c|
+        c.www_url = config["www_url"] || WWW_URL
+        c.api_url = config["api_url"] || API_URL
+        c.api_version = config["api_version"] || API_VERSION
+      end
+    end
+
+    def clear_config!
+      @www_url = nil
+      @api_url = nil
+      @api_version = nil
+      Resource.site = nil
+      Resource.user = nil
+      Resource.password = nil
+      @configured = false
+    end
+
+    def configured?
+      @configured
+    end
+
+    def www_url
+      @www_url || WWW_URL
+    end
+
+    def www_url=(value)
+      @www_url = value.sub /(\/)$/, ""  # Remove trailing backslash
+    end
+
+    def api_url
+      @api_url || API_URL
+    end
+
+    def api_url=(value)
+      @api_url = value.sub /(\/)$/, ""  # Remove trailing backslash
+    end
+
+    def api_version
+      @api_version || API_VERSION
     end
-    api_url.sub! /(\/)$/, ""  # Remove trailing backslash
-    Resource.site = "#{api_url}/#{version}/"
-    Resource.user = developer_sid
-    Resource.password = auth_token
   end
 end

data/spec/fixtures/payments.rb

@@ -1,6 +1,6 @@
 module Poundpay
   module PaymentFixture
-    def created_payment_attributes
+    def staged_payment_attributes
       {
         "amount"                     => 20000,
         "payer_fee_amount"           => 0,
@@ -23,47 +23,15 @@ module Poundpay
     end
 
     def escrowed_payment_attributes
-      {
-        "amount"                     => 20000,
-        "payer_fee_amount"           => 0,
-        "payer_email_address"        => "goliath@example.com",
-        "recipient_fee_amount"       => 500,
-        "recipient_email_address"    => "david@example.com",
-        "description"                => "Beats by Dr. Dre",
-        "sid"                        => "PY1d82752a361211e0bce31231400042c7",
-        "status"                     => "ESCROWED",
-        "amount_to_credit_developer" => 550,
-        "updated_at"                 => "2011-02-11T19:07:05.332356Z",
-        "recipient_sid"              => nil,
-        "payer_sid"                  => "US552595ee364111e0b18800264a09ff3c",
-        "developer_sid"              => "DV8539761e250011e0a81d1231400042c7",
-        "poundpay_fee_amount"        => 450,
-        "created_at"                 => "2011-02-11T19:07:05.332356Z",
-        "amount_to_credit_recipient" => 19500,
-        "amount_to_charge_payer"     => 20000,
-      }
+      @attributes = staged_payment_attributes
+      @attributes["status"] = "ESCROWED"
+      @attributes
     end
 
     def released_payment_attributes
-      {
-        "amount"                     => 20000,
-        "payer_fee_amount"           => 0,
-        "payer_email_address"        => "goliath@example.com",
-        "recipient_fee_amount"       => 500,
-        "recipient_email_address"    => "david@example.com",
-        "description"                => "Beats by Dr. Dre",
-        "sid"                        => "PY1d82752a361211e0bce31231400042c7",
-        "status"                     => "RELEASED",
-        "amount_to_credit_developer" => 550,
-        "updated_at"                 => "2011-02-11T19:07:05.332356Z",
-        "recipient_sid"              => nil,
-        "payer_sid"                  => "US552595ee364111e0b18800264a09ff3c",
-        "developer_sid"              => "DV8539761e250011e0a81d1231400042c7",
-        "poundpay_fee_amount"        => 450,
-        "created_at"                 => "2011-02-11T19:07:05.332356Z",
-        "amount_to_credit_recipient" => 19500,
-        "amount_to_charge_payer"     => 20000,
-      }
+      @attributes = staged_payment_attributes
+      @attributes["status"] = "RELEASED"
+      @attributes
     end
   end
 end

data/spec/fixtures/poundpay.yml

@@ -0,0 +1,20 @@
+development:
+  developer_sid: DV0383d447360511e0bbac00264a09ff3c
+  auth_token: development_auth_token
+  www_url: https://www-sandbox.poundpay.com
+  api_url: https://api-sandbox.poundpay.com
+
+
+production:
+  developer_sid: DV8dd93f0f3c6411e0863f00264a09ff3c
+  auth_token: production_auth_token
+
+
+future:
+  developer_sid: DV8dd93f0f3c6411e0863f00264a09ff3c
+  auth_token: d8c4ea1bafd3fcac8c1062a72c22bcdb09321deb1041df257165cd6449def0de
+  api_version: gold
+
+invalid:
+  developer_sid: 
+  auth_token: 

data/spec/poundpay/callback_spec.rb

@@ -12,6 +12,10 @@ describe Poundpay do
       "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a")
   end
 
+  after (:all) do
+    Poundpay.clear_config!
+  end
+
   describe ".calculate_signature" do
     it "should calculate the correct signature using HMAC-SHA1" do
       signature = Poundpay.calculate_signature(valid_callback[:url], valid_callback[:params])

data/spec/poundpay/elements_spec.rb

@@ -14,6 +14,10 @@ describe Developer do
       "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a")
   end
 
+  after (:all) do
+    Poundpay.clear_config!
+  end
+
   describe "#me" do
     it "should return the developer's information" do
       Developer.should_receive(:find).with(Developer.user).and_return(Developer.new developer_attributes)
@@ -31,10 +35,14 @@ describe Payment do
       "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a")
   end
 
+  after (:all) do
+    Poundpay.clear_config!
+  end
+
   describe "#release" do
     it "should not be able to release a STAGED payment" do
-      @created_payment = Payment.new created_payment_attributes
-      expect {@created_payment.release}.to raise_error(PaymentReleaseException)
+      @staged_payment = Payment.new staged_payment_attributes
+      expect {@staged_payment.release}.to raise_error(PaymentReleaseException)
     end
 
     it "should release an ESCROWED payment" do

data/spec/poundpay/rails_spec.rb

@@ -0,0 +1,46 @@
+require 'poundpay'
+
+describe Poundpay do
+  after (:each) do
+    Poundpay.clear_config!
+  end
+
+  it "should automatically load config if exists" do
+    module Rails
+      class << self
+        def root
+          Pathname(File.expand_path("../../fixtures", __FILE__))
+        end
+
+        def env
+          "development"
+        end
+      end
+    end
+    
+    Poundpay.configured?.should be_false
+    load File.expand_path("../../../lib/poundpay/rails.rb", __FILE__)
+    Poundpay.configured?.should be_true
+    Poundpay::Resource.password.should == "development_auth_token"
+  end
+
+  it "should not do anything if config does not exist" do
+    module Rails
+      class << self
+        def root
+          Pathname(File.expand_path("wrong_directory", __FILE__))
+        end
+
+        def env
+          "development"
+        end
+      end
+    end
+    
+    Poundpay.configured?.should be_false
+    load File.expand_path("../../../lib/poundpay/rails.rb", __FILE__)
+    Poundpay.configured?.should be_false
+    Poundpay::Resource.password.should == nil
+  end
+
+end

data/spec/poundpay_spec.rb

@@ -1,39 +1,125 @@
 require 'poundpay'
 
-describe Poundpay, ".configure" do
-  it "should require developer_sid to start with 'DV'" do
-    expect {
-      # Pass developer_sid and auth_token in wrong order
-      Poundpay.configure(
-        "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a",
-        "DV0383d447360511e0bbac00264a09ff3c")
-    }.to raise_error(ArgumentError, /DV/)
-  end
+describe Poundpay do
+  describe ".configure" do
+    after (:each) do
+      Poundpay.clear_config!
+    end
+
+    it "should require developer_sid and auth_token" do
+      expect { Poundpay.configure(nil, nil) }.to raise_error(ArgumentError, /required/)
+      expect { Poundpay.configure("DV0383d447360511e0bbac00264a09ff3c", nil) }.to raise_error(ArgumentError, /required/)
+      expect { Poundpay.configure(nil, "auth_token") }.to raise_error(ArgumentError, /required/)
+    end
+
+    it "should require developer_sid to start with 'DV'" do
+      expect {
+        # Pass developer_sid and auth_token in wrong order
+        Poundpay.configure(
+          "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a",
+          "DV0383d447360511e0bbac00264a09ff3c")
+      }.to raise_error(ArgumentError, /DV/)
+    end
 
-  it "should be configured with default api_url and version" do
-    developer_sid = "DV0383d447360511e0bbac00264a09ff3c"
-    auth_token = "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a"
-    Poundpay.configure(developer_sid, auth_token)
-    Poundpay::Resource.user.should == developer_sid
-    Poundpay::Resource.password.should == auth_token
-    Poundpay::Resource.site.to_s.should == "https://api.poundpay.com/silver/"
+    it "should be configured with default api_url and api_version" do
+      developer_sid = "DV0383d447360511e0bbac00264a09ff3c"
+      auth_token = "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a"
+      Poundpay.configure(developer_sid, auth_token)
+      Poundpay::Resource.user.should == developer_sid
+      Poundpay::Resource.password.should == auth_token
+      Poundpay::Resource.site.to_s.should == "https://api.poundpay.com/silver/"
+      Poundpay.www_url.should == "https://www.poundpay.com"
+      Poundpay.api_url.should == "https://api.poundpay.com"
+      Poundpay.api_version.should == "silver"
+    end
+
+    it "should accept optional api_url and api_version via block" do
+      Poundpay.configure("DV0383d447360511e0bbac00264a09ff3c", "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a") do |c|
+        c.www_url = "https://www-sandbox.poundpay.com"
+        c.api_url = "https://api-sandbox.poundpay.com"
+        c.api_version = "gold"
+      end
+      Poundpay::Resource.site.to_s.should == "https://api-sandbox.poundpay.com/gold/"
+      Poundpay.www_url.should == "https://www-sandbox.poundpay.com"
+      Poundpay.api_url.should == "https://api-sandbox.poundpay.com"
+      Poundpay.api_version.should == "gold"
+    end
+
+    it "should allow api_url to have a trailing backslash" do
+      Poundpay.configure("DV0383d447360511e0bbac00264a09ff3c", "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a") do |c|
+        c.www_url = "https://www-sandbox.poundpay.com/"
+        c.api_url = "https://api-sandbox.poundpay.com/"
+        c.api_version = "gold"
+      end
+      Poundpay::Resource.site.to_s.should == "https://api-sandbox.poundpay.com/gold/"
+      Poundpay.www_url.should == "https://www-sandbox.poundpay.com"
+      Poundpay.api_url.should == "https://api-sandbox.poundpay.com"
+      Poundpay.api_version.should == "gold"
+    end
   end
 
-  it "should accept optional api_url and version" do
-    Poundpay.configure(
-      "DV0383d447360511e0bbac00264a09ff3c",
-      "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a",
-      api_url="https://api-sandbox.poundpay.com",
-      version="gold")
-    Poundpay::Resource.site.to_s.should == "https://api-sandbox.poundpay.com/gold/"
+  describe ".configure_from_hash" do
+    before (:all) do
+      path = File.expand_path("../fixtures/poundpay.yml", __FILE__)
+      @config = YAML::load_file(path)
+    end
+
+    after (:each) do
+      Poundpay.clear_config!
+    end
+
+    it "should accept valid development configuration" do
+      config = @config["development"]
+      Poundpay.configure_from_hash config
+      Poundpay::Resource.user.should == config["developer_sid"]
+      Poundpay::Resource.password.should == config["auth_token"]
+      Poundpay::Resource.site.to_s.should == "https://api-sandbox.poundpay.com/silver/"
+      Poundpay.www_url.should == "https://www-sandbox.poundpay.com"
+      Poundpay.api_url.should == "https://api-sandbox.poundpay.com"
+      Poundpay.api_version.should == "silver"
+    end
+
+    it "should accept valid production configuration" do
+      config = @config["production"]
+      Poundpay.configure_from_hash config
+      Poundpay::Resource.user.should == config["developer_sid"]
+      Poundpay::Resource.password.should == config["auth_token"]
+      Poundpay::Resource.site.to_s.should == "https://api.poundpay.com/silver/"
+      Poundpay.www_url.should == "https://www.poundpay.com"
+      Poundpay.api_url.should == "https://api.poundpay.com"
+      Poundpay.api_version.should == "silver"
+    end
+
+    it "should accept valid future configuration" do
+      config = @config["future"]
+      Poundpay.configure_from_hash config
+      Poundpay::Resource.user.should == config["developer_sid"]
+      Poundpay::Resource.password.should == config["auth_token"]
+      Poundpay::Resource.site.to_s.should == "https://api.poundpay.com/gold/"
+      Poundpay.www_url.should == "https://www.poundpay.com"
+      Poundpay.api_url.should == "https://api.poundpay.com"
+      Poundpay.api_version.should == "gold"
+    end
+
+    it "should not accept an invalid configuration" do
+      expect { Poundpay.configure_from_hash @config["invalid"] }.to raise_error(ArgumentError)
+    end
   end
 
-  it "should allow api_url to have a trailing backslash" do
-    Poundpay.configure(
-      "DV0383d447360511e0bbac00264a09ff3c",
-      "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a",
-      api_url="https://api-sandbox.poundpay.com/",
-      version="gold")
-    Poundpay::Resource.site.to_s.should == "https://api-sandbox.poundpay.com/gold/"
+  describe ".clear_config!" do
+    it "should clear all Poundpay configs" do
+      Poundpay.configured?.should be_false
+      Poundpay.configure("DV0383d447360511e0bbac00264a09ff3c", "c31155b9f944d7aed204bdb2a253fef13b4fdcc6ae1540200449cc4526b2381a")
+      Poundpay.configured?.should be_true
+
+      Poundpay.clear_config!
+      Poundpay.configured?.should be_false
+      Poundpay.www_url.should == Poundpay::WWW_URL
+      Poundpay.api_url.should == Poundpay::API_URL
+      Poundpay.api_version.should == Poundpay::API_VERSION
+      Poundpay::Resource.site.should == nil
+      Poundpay::Resource.user.should == nil
+      Poundpay::Resource.password.should == nil
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matin Tamizi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-18 00:00:00 -08:00
+date: 2011-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,15 +85,18 @@ files:
 - lib/poundpay/callback.rb
 - lib/poundpay/elements.rb
 - lib/poundpay/formats.rb
+- lib/poundpay/rails.rb
 - lib/poundpay/resource.rb
 - lib/poundpay/version.rb
 - poundpay.gemspec
 - spec/fixtures/callback.rb
 - spec/fixtures/developers.rb
 - spec/fixtures/payments.rb
+- spec/fixtures/poundpay.yml
 - spec/poundpay/callback_spec.rb
 - spec/poundpay/elements_spec.rb
 - spec/poundpay/formats_spec.rb
+- spec/poundpay/rails_spec.rb
 - spec/poundpay/resource_spec.rb
 - spec/poundpay_spec.rb
 has_rdoc: true
@@ -132,8 +135,10 @@ test_files:
 - spec/fixtures/callback.rb
 - spec/fixtures/developers.rb
 - spec/fixtures/payments.rb
+- spec/fixtures/poundpay.yml
 - spec/poundpay/callback_spec.rb
 - spec/poundpay/elements_spec.rb
 - spec/poundpay/formats_spec.rb
+- spec/poundpay/rails_spec.rb
 - spec/poundpay/resource_spec.rb
 - spec/poundpay_spec.rb