paypal-sdk-rest 0.10.0 → 1.0.0

data/lib/paypal-sdk/rest/data_types.rb

@@ -464,6 +464,7 @@ module PayPal::SDK
           object_of :subtotal, String
           object_of :shipping, String
           object_of :tax, String
+          object_of :fee, String
           object_of :handling_fee, String
           object_of :shipping_discount, String
           object_of :insurance, String

data/lib/paypal-sdk/rest/version.rb

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module REST
-      VERSION = "0.10.0"
+      VERSION = "1.0.0"
     end
   end
 end

data/spec/config/paypal.yml

@@ -1,8 +1,35 @@
 test: &default
   client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
   client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+  username: jb-us-seller_api1.paypal.com
+  password: WX4WTU3S8MY44S7F
+  signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
+  app_id: APP-80W284485P519543T
+  http_timeout: 30
   mode: sandbox
+  sandbox_email_address: Platform.sdk.seller@gmail.com
 
 development:
   <<: *default
 
+with_authentication:
+  <<: *default
+  client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
+  client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+
+with_certificate:
+  <<: *default
+  username: platfo_1255170694_biz_api1.gmail.com
+  password: 2DPPKUPKB7DQLXNR
+  signature:
+  cert_path: <%= File.expand_path("../cert_key.pem", __FILE__) %>
+  app_id: APP-80W284485P519543T
+
+with_oauth_token:
+  <<: *default
+  token: 3rMSi3kCmK1Q3.BKxkH29I53R0TRLrSuCO..l8AMOAFM6cQhPTTrfQ
+  token_secret: RuE1j8RNRlSuL5T-PSSpVWLvOlI
+
+with_proxy:
+  <<: *default
+  http_proxy: <%= ENV['http_proxy'] %>

data/spec/config/sample_data.yml

@@ -0,0 +1,3 @@
+ipn:
+  valid_message: item_number=&residence_country=US&verify_sign=AFcWxV21C7fd0v3bYYYRCpSSRl31AXi5tzp0u2U-8QDyy.oC2A1Dhx04&address_country=United+States&address_city=San+Jose&address_status=unconfirmed&business=platfo_1255077030_biz%40gmail.com&payment_status=Pending&transaction_subject=&protection_eligibility=Ineligible&shipping=0.00&payer_id=934EKX9W68RRU&first_name=John&mc_fee=0.38&txn_id=5AL16697HX185734U&quantity=1&receiver_email=platfo_1255077030_biz%40gmail.com&notify_version=3.7&txn_type=web_accept&mc_gross=1.00&payer_status=unverified&mc_currency=USD&test_ipn=1&custom=&payment_date=01%3A48%3A31+Dec+04%2C+2012+PST&payment_fee=0.38&charset=windows-1252&address_country_code=US&payment_gross=1.00&address_zip=95131&ipn_track_id=af0f53159f21e&address_state=CA&receipt_id=4050-1771-4106-3070&pending_reason=paymentreview&tax=0.00&handling_amount=0.00&item_name=&address_name=John+Doe&last_name=Doe&payment_type=instant&receiver_id=HZH2W8NPXUE5W&address_street=1+Main+St
+  invalid_message: invalid=invalid

data/spec/core/api/data_type_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe PayPal::SDK::Core::API::DataTypes::Base do
+
+  DataType = PayPal::SDK::Core::API::DataTypes::Base
+
+  class TestCurrency < DataType
+
+    # Members
+    object_of :amount, String
+    object_of :desciption, String, :namespace => "ns"
+    # Attributes
+    add_attribute :currencyID, :namespace => "cc"
+  end
+
+  class TestType < DataType
+    object_of :fromCurrency, TestCurrency
+    array_of  :toCurrency,   TestCurrency
+    object_of :firstname,    String, :name => "first-name"
+  end
+
+  class TestSimpleType < DataType
+    include PayPal::SDK::Core::API::DataTypes::SimpleTypes
+    object_of :created_on, Date
+    object_of :created_at, DateTime
+  end
+
+  class Message < DataType
+    object_of :value, String
+  end
+
+  it "should allow content key" do
+    message = Message.new("Testing message")
+    message.value.should eql "Testing message"
+
+    message = Message.new(:value => "Testing message")
+    message.value.should eql "Testing message"
+  end
+
+  it "should create member object automatically" do
+    test_type = TestType.new
+    test_type.fromCurrency.should   be_a TestCurrency
+    test_type.toCurrency.should     be_a Array
+    test_type.toCurrency[0].should  be_a TestCurrency
+    test_type.toCurrency[1].should  be_a TestCurrency
+    test_type.toCurrency[0].amount.should eql nil
+    test_type.fromCurrency.amount.should  eql nil
+    test_type.fromCurrency.desciption.should    eql nil
+    test_type.fromCurrency.currencyID.should    eql nil
+  end
+
+  it "should convert the given data to configured type" do
+    test_type = TestType.new( :fromCurrency => { :currencyID => "USD", :amount => "50.0"})
+    test_type.fromCurrency.should be_a TestCurrency
+    test_type.fromCurrency.currencyID.should    eql "USD"
+    test_type.fromCurrency.amount.should  eql "50.0"
+  end
+
+  it "should allow block with initializer" do
+    test_type = TestType.new do
+      fromCurrency do
+        self.currencyID = "USD"
+        self.amount = "50.0"
+      end
+    end
+    test_type.fromCurrency.currencyID.should    eql "USD"
+    test_type.fromCurrency.amount.should  eql "50.0"
+  end
+
+  it "should allow block with member" do
+    test_type = TestType.new
+    test_type.fromCurrency do
+      self.currencyID = "USD"
+      self.amount = "50.0"
+    end
+    test_type.fromCurrency.currencyID.should    eql "USD"
+    test_type.fromCurrency.amount.should  eql "50.0"
+  end
+
+  it "should assign value to attribute" do
+    test_currency = TestCurrency.new( :@currencyID => "USD", :amount => "50" )
+    test_currency.currencyID.should eql "USD"
+  end
+
+  it "should allow configured Class object" do
+    test_currency = TestCurrency.new( :currencyID => "USD", :amount => "50" )
+    test_type = TestType.new( :fromCurrency => test_currency )
+    test_type.fromCurrency.should eql test_currency
+  end
+
+  it "should allow snakecase" do
+    test_type = TestType.new( :from_currency => {} )
+    test_type.from_currency.should be_a TestCurrency
+    test_type.from_currency.should eql test_type.fromCurrency
+  end
+
+  it "should allow array" do
+    test_type = TestType.new( :toCurrency => [{ :currencyID => "USD", :amount => "50.0" }] )
+    test_type.toCurrency.should be_a Array
+    test_type.toCurrency.first.should be_a TestCurrency
+    test_type.toCurrency.first.currencyID.should eql "USD"
+  end
+
+  it "should skip undefind members on initializer" do
+    test_type = TestType.new( :notExist => "testing")
+    lambda do
+      test_type.notExist
+    end.should raise_error NoMethodError
+    lambda do
+      test_type.notExist = "Value"
+    end.should raise_error NoMethodError
+  end
+
+  it "should not convert empty hash" do
+    test_type = TestType.new( :fromCurrency => {} )
+    test_type.to_hash.should eql({})
+  end
+
+  it "should not convert empty array" do
+    test_type = TestType.new( :toCurrency => [] )
+    test_type.to_hash.should eql({})
+  end
+
+  it "should not convert array of empty hash" do
+    test_type = TestType.new( :toCurrency => [ {} ] )
+    test_type.to_hash.should eql({})
+  end
+
+  it "should return empty hash" do
+    test_type = TestType.new
+    test_type.to_hash.should eql({})
+  end
+
+  it "should convert to hash" do
+    test_currency = TestCurrency.new(:amount => "500")
+    test_currency.to_hash.should eql("amount" => "500")
+  end
+
+  it "should convert to hash with key as symbol" do
+    test_currency = TestCurrency.new(:amount => "500")
+    test_currency.to_hash(:symbol => true).should eql(:amount => "500")
+  end
+
+  it "should convert attribute key with @" do
+    test_currency = TestCurrency.new( :currencyID => "USD", :amount => "50" )
+    test_currency.to_hash["@currencyID"].should eql "USD"
+  end
+
+  it "should convert attribute key without @" do
+    test_currency = TestCurrency.new( :currencyID => "USD", :amount => "50" )
+    test_currency.to_hash(:attribute => false)["currencyID"].should eql "USD"
+  end
+
+  it "should convert to hash with namespace" do
+    test_currency = TestCurrency.new(:currencyID => "USD", :amount => "500", :desciption => "Testing" )
+    hash = test_currency.to_hash
+    hash["amount"].should eql "500"
+    hash["ns:desciption"].should eql "Testing"
+    hash["@currencyID"].should eql "USD"
+    hash = test_currency.to_hash(:namespace => false)
+    hash["amount"].should eql "500"
+    hash["desciption"].should eql "Testing"
+    hash["@currencyID"].should eql "USD"
+  end
+
+  it "should allow namespace" do
+    test_currency = TestCurrency.new(:amount => "500", :"ns:desciption" => "Testing" )
+    test_currency.desciption.should eql "Testing"
+  end
+
+  it "should use name option in members" do
+    test_type = TestType.new( :firstname => "FirstName")
+    test_type.to_hash.should eql({"first-name" => "FirstName" })
+  end
+
+  it "should allow date" do
+    date_time = "2010-10-10T10:10:10"
+    test_simple_type = TestSimpleType.new( :created_on => date_time, :created_at => date_time )
+    test_simple_type.created_on.should be_a Date
+    test_simple_type.created_at.should be_a DateTime
+  end
+
+  it "should allow date with value 0" do
+    test_simple_type = TestSimpleType.new( :created_at => "0" )
+    test_simple_type.created_at.should be_a DateTime
+  end
+
+end
+

data/spec/core/api/rest_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe PayPal::SDK::Core::API::REST do
+
+  module PayPalRest
+    class API < PayPal::SDK::Core::API::REST
+    end
+  end
+
+  def create_api(*args)
+    api = PayPalRest::API.new(*args)
+    @log_file ||= File.open("spec/log/rest_http.log", "w")
+    api.http.set_debug_output(@log_file)
+    api
+  end
+
+  before :all do
+    @api = create_api("v1/payments/", :with_authentication)
+    @vault_api = create_api("v1/vault/", :with_authentication)
+  end
+
+  describe "Configuration" do
+    it "create api with prefix" do
+      api = create_api("v1/payments")
+      api.uri.path.should eql "/v1/payments"
+    end
+
+    it "service endpoint for sandbox" do
+      api = create_api
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://api.sandbox.paypal.com"
+      api = create_api( :mode => "sandbox" )
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://api.sandbox.paypal.com"
+      api = create_api( :mode => :sandbox )
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://api.sandbox.paypal.com"
+      api = create_api( :mode => "invalid" )
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://api.sandbox.paypal.com"
+      api = create_api( :mode => nil )
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://api.sandbox.paypal.com"
+    end
+
+    it "service endpoint for live" do
+      api = create_api( :mode => "live" )
+      api.service_endpoint.should eql "https://api.paypal.com"
+      api.token_endpoint.should   eql "https://api.paypal.com"
+      api = create_api( :mode => :live )
+      api.service_endpoint.should eql "https://api.paypal.com"
+      api.token_endpoint.should   eql "https://api.paypal.com"
+    end
+
+    it "override service endpoint" do
+      api = create_api( :rest_endpoint => "https://testing.api.paypal.com" )
+      api.service_endpoint.should eql "https://testing.api.paypal.com"
+      api.token_endpoint.should   eql "https://testing.api.paypal.com"
+      api = create_api( :endpoint => "https://testing.api.paypal.com" )
+      api.service_endpoint.should eql "https://testing.api.paypal.com"
+      api.token_endpoint.should   eql "https://testing.api.paypal.com"
+    end
+
+    it "override token endpoint" do
+      api = create_api( :rest_token_endpoint => "https://testing.api.paypal.com" )
+      api.service_endpoint.should eql "https://api.sandbox.paypal.com"
+      api.token_endpoint.should   eql "https://testing.api.paypal.com"
+    end
+  end
+
+  describe "Validation" do
+    it "Invalid client_id and client_secret" do
+      api = create_api(:with_authentication, :client_id => "XYZ", :client_secret => "ABC")
+      lambda {
+        api.token
+      }.should raise_error PayPal::SDK::Core::Exceptions::UnauthorizedAccess
+    end
+
+    it "Should handle expired token" do
+      old_token = @api.token
+      @api.token_hash[:expires_in] = 0
+      @api.token.should_not eql old_token
+    end
+
+    it "Get token" do
+      @api.token.should_not be_nil
+    end
+  end
+
+  describe "Success request" do
+
+    it "Create Payment" do
+      response = @api.post("payment", {
+        "intent" => "sale",
+        "payer" => {
+          "payment_method" => "credit_card",
+          "funding_instruments" => [{
+            "credit_card" => {
+              "type" => "visa",
+              "number" => "4417119669820331",
+              "expire_month" => "11", "expire_year" => "2018",
+              "first_name" => "Joe", "last_name" => "Shopper" }}]},
+        "transactions" => [{
+          "amount" => {
+            "total" => "7.47",
+            "currency" => "USD" }}]})
+      response["error"].should be_nil
+    end
+
+    it "List Payments" do
+      response = @api.get("payment", { "count" => 10 })
+      response["error"].should be_nil
+      response["count"].should_not be_nil
+    end
+
+    it "Execute Payment"
+
+    it "Create FundingInstrument" do
+      new_funding_instrument = @vault_api.post("credit-card", {
+        "type" =>  "visa",
+        "number" =>  "4111111111111111",
+        "expire_month" =>  "11", "expire_year" =>  "2018",
+        "cvv2" =>  "874",
+        "first_name" =>  "Joe", "last_name" =>  "Shopper" })
+      new_funding_instrument["error"].should  be_nil
+      new_funding_instrument["id"].should_not be_nil
+
+      funding_instrument = @vault_api.get("credit-card/#{new_funding_instrument["id"]}")
+      funding_instrument["error"].should be_nil
+      funding_instrument["id"].should eql new_funding_instrument["id"]
+    end
+
+  end
+
+  describe "Failure request" do
+    it "Invalid Resource ID" do
+      lambda {
+        response = @api.get("payment/PAY-1234")
+      }.should raise_error PayPal::SDK::Core::Exceptions::ResourceNotFound
+    end
+
+    it "Invalid parameters" do
+      response = @api.post("payment")
+      response["error"]["name"].should eql "VALIDATION_ERROR"
+    end
+  end
+end

data/spec/core/config_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe PayPal::SDK::Core::Config do
+
+  Config = PayPal::SDK::Core::Config
+
+  it "load configuration file and default environment" do
+    lambda {
+      Config.load("spec/config/paypal.yml", "test")
+      Config.default_environment.should eql "test"
+    }.should_not raise_error
+  end
+
+  it "Set default environment" do
+    begin
+      backup_default_environment = Config.default_environment
+      Config.default_environment = "new_env"
+      Config.default_environment.should eql "new_env"
+    ensure
+      Config.default_environment = backup_default_environment
+    end
+  end
+
+  it "Set configurations" do
+    begin
+      backup_configurations = Config.configurations
+      Config.configurations = { Config.default_environment => { :username => "direct", :password => "direct" } }
+      Config.config.username.should eql "direct"
+      Config.config.password.should eql "direct"
+      Config.config.signature.should be_nil
+    ensure
+      Config.configurations = backup_configurations
+    end
+  end
+
+  it "Configure with parameters" do
+    begin
+      backup_configurations = Config.configurations
+      Config.configurations = nil
+      Config.configure( :username => "Testing" )
+      Config.config.username.should eql "Testing"
+      Config.config.app_id.should be_nil
+    ensure
+      Config.configurations = backup_configurations
+    end
+  end
+
+  it "Configure with block" do
+    begin
+      backup_configurations = Config.configurations
+      Config.configurations = nil
+      Config.configure do |config|
+        config.username = "Testing"
+      end
+      Config.config.username.should eql "Testing"
+      Config.config.app_id.should be_nil
+    ensure
+      Config.configurations = backup_configurations
+    end
+  end
+
+  it "Configure with default values" do
+    begin
+      backup_configurations = Config.configurations
+      default_config = Config.config
+      Config.configure do |config|
+        config.username = "Testing"
+      end
+      Config.config.username.should eql "Testing"
+      Config.config.app_id.should_not be_nil
+      Config.config.app_id.should eql default_config.app_id
+    ensure
+      Config.configurations = backup_configurations
+    end
+  end
+
+  it "validate configuration" do
+    config = Config.new( :username => "XYZ")
+    lambda {
+      config.required!(:username)
+    }.should_not raise_error
+    lambda {
+      config.required!(:password)
+    }.should raise_error "Required configuration(password)"
+    lambda {
+      config.required!(:username, :password)
+    }.should raise_error "Required configuration(password)"
+    lambda {
+      config.required!(:password, :signature)
+    }.should raise_error "Required configuration(password, signature)"
+  end
+
+  it "return default environment configuration" do
+    Config.config.should be_a Config
+  end
+
+  it "return configuration based on environment" do
+    Config.config(:development).should be_a Config
+  end
+
+  it "override default configuration" do
+    override_configuration = { :username => "test.example.com", :app_id => "test"}
+    config = Config.config(override_configuration)
+
+    config.username.should eql(override_configuration[:username])
+    config.app_id.should eql(override_configuration[:app_id])
+  end
+
+  it "get cached config" do
+    Config.config(:test).should eql Config.config(:test)
+    Config.config(:test).should_not eql Config.config(:development)
+  end
+
+  it "should raise error on invalid environment" do
+    lambda {
+      Config.config(:invalid_env)
+    }.should raise_error "Configuration[invalid_env] NotFound"
+  end
+
+  it "set logger" do
+    require 'logger'
+    my_logger = Logger.new(STDERR)
+    Config.logger = my_logger
+    Config.logger.should eql my_logger
+  end
+
+  it "Access PayPal::SDK methods" do
+    PayPal::SDK.configure.should eql PayPal::SDK::Core::Config.config
+    PayPal::SDK.logger.should eql PayPal::SDK::Core::Config.logger
+    PayPal::SDK.logger = PayPal::SDK.logger
+    PayPal::SDK.logger.should eql PayPal::SDK::Core::Config.logger
+  end
+
+  describe "include Configuration" do
+    class TestConfig
+      include PayPal::SDK::Core::Configuration
+    end
+
+    it "Get default configuration" do
+      test_object = TestConfig.new
+      test_object.config.should be_a Config
+    end
+
+    it "Change environment" do
+      test_object = TestConfig.new
+      test_object.set_config("test")
+      test_object.config.should eql Config.config("test")
+      test_object.config.should_not eql Config.config("development")
+    end
+
+    it "Override environment configuration" do
+      test_object = TestConfig.new
+      test_object.set_config("test", :username => "test")
+      test_object.config.should_not eql Config.config("test")
+    end
+
+    it "Override default/current configuration" do
+      test_object = TestConfig.new
+      test_object.set_config( :username => "test")
+      test_object.config.username.should eql "test"
+      test_object.set_config( :password => "test")
+      test_object.config.password.should eql "test"
+      test_object.config.username.should eql "test"
+    end
+
+    it "Append ssl_options" do
+      test_object = TestConfig.new
+      test_object.set_config( :ssl_options => { :ca_file => "test_path" } )
+      test_object.config.ssl_options[:ca_file].should eql "test_path"
+      test_object.set_config( :ssl_options => { :verify_mode => 1 } )
+      test_object.config.ssl_options[:verify_mode].should eql 1
+      test_object.config.ssl_options[:ca_file].should eql "test_path"
+    end
+
+    it "Set configuration without loading configuration File" do
+      backup_configurations = Config.configurations
+      begin
+        Config.configurations = nil
+        test_object = TestConfig.new
+        lambda {
+          test_object.config
+        }.should raise_error
+        test_object.set_config( :username => "test" )
+        test_object.config.should be_a Config
+      ensure
+        Config.configurations = backup_configurations
+      end
+    end
+
+  end
+
+end