paypal-sdk-core 0.1.0

data/lib/paypal-sdk/core/credential/base.rb

@@ -0,0 +1,27 @@
+module PayPal::SDK::Core
+  module Credential
+
+    # Base credential Class for authentication
+    class Base
+      attr_accessor :username, :password, :app_id, :device_ipaddress, :sandbox_email_address
+
+      # Initialize authentication configurations
+      # === Arguments
+      #  * <tt>config</tt> -- Configuration object
+      def initialize(config)
+        self.username = config.username
+        self.password = config.password
+        self.app_id   = config.app_id
+        self.device_ipaddress = config.device_ipaddress
+        self.sandbox_email_address = config.sandbox_email_address
+      end
+
+      # Return credential properties
+      def properties
+        { :username => username, :password => password, :app_id => app_id,
+          :device_ipaddress => device_ipaddress, :sandbox_email_address => sandbox_email_address }
+      end
+
+    end
+  end
+end

data/lib/paypal-sdk/core/credential/certificate.rb

@@ -0,0 +1,32 @@
+module PayPal::SDK::Core
+  module Credential
+
+    # Certificate class for SSL Certificate authentication
+    class Certificate < Base
+
+      attr_reader :cert_path
+
+      def initialize(config)
+        super
+        @cert_path = config.cert_path
+      end
+
+      # Return SSL certificate
+      def cert
+        @cert ||= OpenSSL::X509::Certificate.new(cert_content)
+      end
+
+      # Return SSL certificate key
+      def key
+        @key  = OpenSSL::PKey::RSA.new(cert_content)
+      end
+
+      private
+      # Return certificate content from the configured file.
+      def cert_content
+        @cert_content ||= File.read(cert_path)
+      end
+
+    end
+  end
+end

data/lib/paypal-sdk/core/credential/signature.rb

@@ -0,0 +1,22 @@
+module PayPal::SDK::Core
+  module Credential
+    class Signature < Base
+
+      attr_accessor :signature
+
+      # Initialize configuration
+      # === Argument
+      # * <tt>config</tt> -- Configuration object
+      def initialize(config)
+        super
+        self.signature = config.signature
+      end
+
+      # Return properties for authentication
+      def properties
+        super.merge({ :signature => signature })
+      end
+
+    end
+  end
+end

data/lib/paypal-sdk/core/credential/third_party/subject.rb

@@ -0,0 +1,25 @@
+module PayPal::SDK::Core
+  module Credential
+    module ThirdParty
+      class Subject
+
+        attr_accessor :subject, :credential
+
+        # Initialize configuration
+        # === Arguments
+        # * <tt>credential</tt> -- Credential object
+        # * <tt>config</tt> -- Configuration object
+        def initialize(credential, config)
+          @credential   = credential
+          @subject      = config.subject
+        end
+
+        # Return properties for authentication.
+        def properties
+          credential.properties.merge( :subject => subject )
+        end
+
+      end
+    end
+  end
+end

data/lib/paypal-sdk/core/credential/third_party/token.rb

@@ -0,0 +1,39 @@
+module PayPal::SDK::Core
+  module Credential
+    module ThirdParty
+      class Token
+
+        attr_accessor :token, :token_secret, :credential, :url
+
+        # Initialize Token credentials
+        # === Arguments
+        # * <tt>credential</tt> -- Credential Object
+        # * <tt>config</tt> -- Configuration object
+        # * <tt>url</tt> -- Request url
+        def initialize(credential, config, url)
+          @credential   = credential
+          @token        = config.token
+          @token_secret = config.token_secret
+          @url          = url
+        end
+
+        RemoveProperties = [ :username, :password, :signature ]
+
+        # Return credential properties for authentication.
+        def properties
+          certificate_properties = {}
+          certificate_properties.delete_if{|k,v| RemoveProperties.include? k }
+          certificate_properties.merge( :authorization => oauth_authentication )
+        end
+
+        private
+        # Return OAuth authentication string.
+        def oauth_authentication
+          Util::OauthSignature.new(credential.username, credential.password, token, token_secret, url).
+            authorization_string
+        end
+
+      end
+    end
+  end
+end

data/lib/paypal-sdk/core/logging.rb

@@ -0,0 +1,43 @@
+require 'logger'
+
+module PayPal::SDK::Core
+  # Include Logging module to provide logger functionality.
+  # == Configure logger
+  #   Logging.logger = Logger.new(STDERR)
+  #
+  # == Example
+  #   include Logger
+  #   logger.info "Debug message"
+  module Logging
+
+    # Get logger object
+    def logger
+      @logger ||= Logging.logger
+    end
+
+    def log_event(message, start_time, end_time = Time.now)
+      duration = sprintf("%.3f", end_time - start_time)
+      logger.info "[#{duration}] #{message}"
+    end
+
+    class << self
+
+      # Get or Create configured logger based on the default environment configuration
+      def logger
+        @logger ||= Logger.new(Config.config.logfile || STDERR)
+      end
+
+      # Set logger directly and clear the loggers cache.
+      # === Attributes
+      # * <tt>logger</tt> -- Logger object
+      # === Example
+      #   Logging.logger = Logger.new(STDERR)
+      def logger=(logger)
+        @logger  = logger
+      end
+
+    end
+  end
+
+end
+

data/lib/paypal-sdk/core/util/oauth_signature.rb

@@ -0,0 +1,64 @@
+require 'uri'
+require 'cgi'
+require 'openssl'
+require 'base64'
+
+module PayPal::SDK::Core
+  module Util
+    class OauthSignature
+      attr_accessor :username, :password, :token, :token_secret, :url, :timestamp
+
+      def initialize(username, password, token, token_secret, url, timestamp = nil)
+        @username = username
+        @password = password
+        @token = token
+        @token_secret = token_secret
+        @url = url
+        @timestamp = timestamp || Time.now.to_i.to_s
+      end
+
+      def authorization_string
+        signature = oauth_signature
+        "token=#{token},signature=#{signature},timestamp=#{timestamp}"
+      end
+
+      def oauth_signature
+        key = [
+          paypal_encode(password),
+          paypal_encode(token_secret),
+        ].join("&")
+
+        digest = OpenSSL::HMAC.digest('sha1', key, base_string)
+        Base64.encode64(digest).chomp
+      end
+
+      def base_string
+        params = {
+          "oauth_consumer_key" => username,
+          "oauth_version" => "1.0",
+          "oauth_signature_method" => "HMAC-SHA1",
+          "oauth_token" => token,
+          "oauth_timestamp" => timestamp,
+        }
+        sorted_query_string = params.sort.map{|v| v.join("=") }.join("&")
+
+        base = [
+          "POST",
+          paypal_encode(url),
+          paypal_encode(sorted_query_string)
+        ].join("&")
+        base = base.gsub(/%[0-9A-F][0-9A-F]/, &:downcase )
+      end
+
+      # The PayPalURLEncoder java class percent encodes everything other than 'a-zA-Z0-9 _'.
+      # Then it converts ' ' to '+'.
+      # Ruby's CGI.encode takes care of the ' ' and '*' to satisfy PayPal
+      # (but beware, URI.encode percent encodes spaces, and does nothing with '*').
+      # Finally, CGI.encode does not encode '.-', which we need to do here.
+      def paypal_encode str
+        CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,7 @@
+module PayPal
+  module SDK
+    module Core
+      VERSION     = "0.1.0"
+    end
+  end
+end

data/spec/config/cert_key.pem

@@ -0,0 +1,33 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQCx/rJhKDRYhs9WZj66FA+HidsrKwvep3g+YNbm1fXmjcg2rEmC
+kq71+Ftw9rx0Uz7vmg6vcsASUgOyeNG7mVB1SsXc6j+JAzZsmpzxHI0QKm+nBNTS
+OAp5NWn6NZQfu3BNAJ/Mok/iL3am2DWXV6dU74J66rBpwIJfzs9kmw8ZGwIDAQAB
+AoGAa/V1sCQ4i7FItLjTNv3P5X+h5W74hhXBguQttFj2Ct7YHwEknQPnBt2aaMve
+xhdvxtgELDpHcVU5VNifLU/yUg3+DSr/YkpBWOcNTCt1seW/z5s+jr2fQERQKbyf
+SXWMTqwrQ19iQoCPYaj7Drf68JhksQCaYN650g7+B/QmSBECQQDp6r75fzDtEWrr
+O4Sl9plK6CRLqQQ3LveAw4JV31N2UAqgAYtzRqD6K+SviAVtX9xxuv983qQxsfX4
+ozE9sGXPAkEAwsxwR1s2Acuy10h3Xj6VtnFB3PpUrkSI9c9ZxF4CMf/+AS/b2UEe
+QhH60WHY8ccgKT/DoPWBcEu2o0f9nPw29QJBAI480zHNeMe/Hp+5iliM0fvtmxxy
+wwB3S8L9n4RuD0dTNpLDPbO0D/DvvdhKwtoWP2rcxbx9eaRKTYKKYUfcupsCQAkP
+SQmIjHJ47tBkZmjTsFLT4aRNYDLarSQBiMNBPAjnRwD3INpx1N5tx6SFUHmuMSi5
+9nc9888tNklRx9HNSSECQHgs9ExBpA6WbRVcgiizOKH7fmNxAB5f6TQ2W1QHMUb+
+UhZpwuDelOIfzJAQUZGTZk8a8uVmyXU5hTf3ZDbrnJ8=
+-----END RSA PRIVATE KEY-----
+
+-----BEGIN CERTIFICATE-----
+MIICpjCCAg+gAwIBAgIDD96nMA0GCSqGSIb3DQEBBQUAMIGfMQswCQYDVQQGEwJV
+UzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNV
+BAoTDFBheVBhbCwgSW5jLjEWMBQGA1UECxQNc2FuZGJveF9jZXJ0czEbMBkGA1UE
+AxQSc2FuZGJveF9jYW1lcmNoYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwu
+Y29tMB4XDTA5MTAxNTA2Mzg1N1oXDTE5MTAxMzA2Mzg1N1owgYAxLTArBgNVBAMU
+JHBsYXRmb18xMjU1MTcwNjk0X2Jpel9hcGkxLmdtYWlsLmNvbTEiMCAGA1UEChMZ
+cGxhdGZvcm0gc2RrJ3MgVGVzdCBTdG9yZTERMA8GA1UEBxMIU2FuIEpvc2UxCzAJ
+BgNVBAgTAkNBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkC
+gYEAsf6yYSg0WIbPVmY+uhQPh4nbKysL3qd4PmDW5tX15o3INqxJgpKu9fhbcPa8
+dFM+75oOr3LAElIDsnjRu5lQdUrF3Oo/iQM2bJqc8RyNECpvpwTU0jgKeTVp+jWU
+H7twTQCfzKJP4i92ptg1l1enVO+CeuqwacCCX87PZJsPGRsCAwEAAaMNMAswCQYD
+VR0TBAIwADANBgkqhkiG9w0BAQUFAAOBgQCgH3kwXMJtcAaCBQLKz5TGFogJp/C3
+06MvjYzdbDrx9Rjf/252UhD8dMPUP5FhU1KXduL+KIEYawPbDQ9+lV58JgM12R0p
+EhCODDI/lDvzbfxUnYgkJ5cnFhTZpcAqVzWuinUnG8jAL9XKiEyu/C73ePMPWPbt
+otoWi+Tk828Qlw==
+-----END CERTIFICATE-----

data/spec/config/paypal.yml

@@ -0,0 +1,29 @@
+test: &default
+  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
+  logfile: spec/log/test.log
+
+development:
+  <<: *default
+
+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: ESTy2hio5WJQo1iixkH29I53RJxaS0Gvno1A6.YQXZgktxbY4I2Tdg
+  token_secret: ZKPhUYuwJwYsfWdzorozWO2U9pI
+
+with_proxy:
+  <<: *default
+  http_proxy: <%= ENV['http_proxy'] %>

data/spec/core/api/data_type_spec.rb

@@ -0,0 +1,164 @@
+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 :type,   String, :namespace => "ns"
+    # Attributes
+    add_attribute :code
+  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
+
+  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.type.should    eql nil
+  end
+
+  it "should convert the given data to configured type" do
+    test_type = TestType.new( :fromCurrency => { :code => "USD", :amount => "50.0"})
+    test_type.fromCurrency.should be_a TestCurrency
+    test_type.fromCurrency.code.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.code   = "USD"
+        self.amount = "50.0"
+      end
+    end
+    test_type.fromCurrency.code.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.code = "USD"
+      self.amount = "50.0"
+    end
+    test_type.fromCurrency.code.should    eql "USD"
+    test_type.fromCurrency.amount.should  eql "50.0"
+  end
+
+  it "should assign value to attribute" do
+    test_currency = TestCurrency.new( :@code => "USD", :amount => "50" )
+    test_currency.code.should eql "USD"
+  end
+
+  it "should allow configured Class object" do
+    test_currency = TestCurrency.new( :code => "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 => [{ :code => "USD", :amount => "50.0" }] )
+    test_type.toCurrency.should be_a Array
+    test_type.toCurrency.first.should be_a TestCurrency
+  end
+
+  it "should allow only configured fields" do
+    lambda do
+      TestType.new( :notExist => "testing")
+    end.should raise_error
+  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 string" do
+    test_currency = TestCurrency.new(:amount => "500")
+    test_currency.to_hash(:symbol => false).should eql("amount" => "500")
+  end
+
+  it "should convert attribute key with @" do
+    test_currency = TestCurrency.new( :code => "USD", :amount => "50" )
+    test_currency.to_hash[:@code].should eql "USD"
+  end
+
+  it "should convert attribute key without @" do
+    test_currency = TestCurrency.new( :code => "USD", :amount => "50" )
+    test_currency.to_hash(:attribute => false)[:code].should eql "USD"
+  end
+
+  it "should convert to hash with namespace" do
+    test_currency = TestCurrency.new(:amount => "500", :type => "USD" )
+    hash = test_currency.to_hash
+    hash[:amount].should eql "500"
+    hash[:"ns:type"].should eql "USD"
+    hash = test_currency.to_hash(:namespace => false)
+    hash[:amount].should eql "500"
+    hash[:type].should eql "USD"
+  end
+
+  it "should allow namespace" do
+    test_currency = TestCurrency.new(:amount => "500", :"ns:type" => "USD" )
+    test_currency.type.should eql "USD"
+  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
+
+end
+