paypal-sdk-core 0.2.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2FlZTU2MWY0MmE1ZmVkOTc4YTU0YTBiYzMwYWI1ODdhN2Y5MGNlZQ==
+  data.tar.gz: !binary |-
+    YTVlMzA0MzY0OWU2ZGU0MDFmOTlmZDljNmY3YTE1ZTUzMjBkOWJmMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Mzk3ODAxOTEyZmMyNzdlMzVkMTUyNWRjM2VlMmZhMDk0OGRkYWYzMmRjNDlm
+    MGM1ZTdlYTA4Mzk5NzBkOGQzYmM3ZjgxMDU2NWJiMGY1NWVmOWJkNDZlNmYy
+    YTBmZWIxMDZkM2YxNGZmYjE1MmY3NWYwNzQzZjI2MTRlM2M0ZDc=
+  data.tar.gz: !binary |-
+    MTBmMThmZjZhZTRlN2E1N2RjMTIzNzVhNjg2ZDZlMDFkMWZiYmIwNmQyYWU0
+    MzVmYTZiZGNmN2QwMTcwZGU1ODVkYjhlNzAzMjRjNmUwNjNjOWUwZTkwMWVj
+    YjdjZWUyZTEzMmJiYmE4MTkxODIwMjE1NWExZmRjZjRjNWQyMzc=

data/CHANGELOG.txt

@@ -0,0 +1,16 @@
+Version 0.2.2 - Apr 25, 2013
+  - Validate token expiry duration on every REST API call
+  - Removed exception handling for Socket and Timeout errors
+  - Added configure and logger methods to PayPal::SDK module
+  - Added PayPal:SDK::OpenIDConnect module
+
+Version 0.2.1 - Mar 22, 2013
+  - Skip values for undefined members on initializer
+
+Version 0.1.5 - Jan 28, 2013
+  - Fix OrderedHash issue with ruby 1.8.7
+
+Version 0.1.4 - Jan 09, 2013
+
+  - Support ruby version 1.8.7
+  - Update IPN Endpoint

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

@@ -1,2 +1,2 @@
-PayPal::SDK::Core::Config.load("config/paypal.yml", Rails.env)
-PayPal::SDK::Core::Config.logger = Rails.logger
+PayPal::SDK.load("config/paypal.yml", Rails.env)
+PayPal::SDK.logger = Rails.logger

data/lib/generators/paypal/sdk/templates/paypal.yml

@@ -1,6 +1,6 @@
 test: &default
 
-  # Credentials for New APIs
+  # Credentials for REST APIs
   client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
   client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
 
@@ -8,10 +8,10 @@ test: &default
   mode: sandbox
 
   # Credentials for Classic APIs
+  app_id: APP-80W284485P519543T
   username: jb-us-seller_api1.paypal.com
   password: WX4WTU3S8MY44S7F
   signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
-  app_id: APP-80W284485P519543T
   # # With Certificate
   # cert_path: "config/cert_key.pem"
   sandbox_email_address: Platform.sdk.seller@gmail.com

data/lib/paypal-sdk-core.rb

@@ -8,39 +8,31 @@ module PayPal
       autoload :Logging,        "paypal-sdk/core/logging"
       autoload :Authentication, "paypal-sdk/core/authentication"
       autoload :Exceptions,     "paypal-sdk/core/exceptions"
+      autoload :OpenIDConnect,  "paypal-sdk/core/openid_connect"
+      autoload :API,            "paypal-sdk/core/api"
+      autoload :Util,           "paypal-sdk/core/util"
+      autoload :Credential,     "paypal-sdk/core/credential"
 
-      module API
-        autoload :Base,     "paypal-sdk/core/api/base"
-        autoload :Merchant, "paypal-sdk/core/api/merchant"
-        autoload :Platform, "paypal-sdk/core/api/platform"
-        autoload :REST,     "paypal-sdk/core/api/rest"
-        autoload :IPN,      "paypal-sdk/core/api/ipn"
+    end
 
-        module DataTypes
-          autoload :Base, "paypal-sdk/core/api/data_types/base"
-          autoload :Enum, "paypal-sdk/core/api/data_types/enum"
-          autoload :SimpleTypes,    "paypal-sdk/core/api/data_types/simple_types"
-          autoload :ArrayWithBlock, "paypal-sdk/core/api/data_types/array_with_block"
-        end
-      end
+    autoload :OpenIDConnect,    "paypal-sdk/core/openid_connect"
 
-      module Util
-        autoload :OauthSignature, "paypal-sdk/core/util/oauth_signature"
-        autoload :OrderedHash,    "paypal-sdk/core/util/ordered_hash"
-        autoload :HTTPHelper,     "paypal-sdk/core/util/http_helper"
+    class << self
+      def configure(options = {}, &block)
+        Core::Config.configure(options, &block)
       end
 
-      module Credential
-        autoload :Base,         "paypal-sdk/core/credential/base"
-        autoload :Certificate,  "paypal-sdk/core/credential/certificate"
-        autoload :Signature,    "paypal-sdk/core/credential/signature"
+      def load(*args)
+        Core::Config.load(*args)
+      end
 
-        module ThirdParty
-          autoload :Token,    "paypal-sdk/core/credential/third_party/token"
-          autoload :Subject,  "paypal-sdk/core/credential/third_party/subject"
-        end
+      def logger
+        Core::Config.logger
       end
 
+      def logger=(log)
+        Core::Config.logger = log
+      end
     end
   end
 end

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

@@ -0,0 +1,20 @@
+module PayPal
+  module SDK
+    module Core
+      module API
+        autoload :Base,     "paypal-sdk/core/api/base"
+        autoload :Merchant, "paypal-sdk/core/api/merchant"
+        autoload :Platform, "paypal-sdk/core/api/platform"
+        autoload :REST,     "paypal-sdk/core/api/rest"
+        autoload :IPN,      "paypal-sdk/core/api/ipn"
+
+        module DataTypes
+          autoload :Base, "paypal-sdk/core/api/data_types/base"
+          autoload :Enum, "paypal-sdk/core/api/data_types/enum"
+          autoload :SimpleTypes,    "paypal-sdk/core/api/data_types/simple_types"
+          autoload :ArrayWithBlock, "paypal-sdk/core/api/data_types/array_with_block"
+        end
+      end
+    end
+  end
+end

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

@@ -84,8 +84,6 @@ module PayPal::SDK::Core
         payload[:response] = http_call(payload)
         format_response(payload)
         payload[:data]
-      rescue Net::HTTPBadGateway, Errno::ECONNRESET, Errno::ECONNABORTED, SocketError => error
-        format_error(error, error.message)
       end
 
       # Generate HTTP request for given action and parameters

data/lib/paypal-sdk/core/api/rest.rb

@@ -30,7 +30,7 @@ module PayPal::SDK::Core
       # Clear cached values.
       def set_config(*args)
         @token_uri = nil
-        @token = nil
+        @token_hash = nil
         super
       end
 
@@ -45,19 +45,41 @@ module PayPal::SDK::Core
       end
 
       # Generate Oauth token or Get cached
-      def token
-        @token ||=
+      def token_hash
+        validate_token_hash
+        @token_hash ||=
           begin
+            @token_request_at = Time.now
             basic_auth = ["#{config.client_id}:#{config.client_secret}"].pack('m').delete("\r\n")
             token_headers = default_http_header.merge( "Authorization" => "Basic #{basic_auth}" )
             response = http_call( :method => :post, :uri => token_uri, :body => TOKEN_REQUEST_PARAMS, :header => token_headers )
-            MultiJson.load(response.body)["access_token"]
+            MultiJson.load(response.body, :symbolize_keys => true)
           end
       end
+      attr_writer :token_hash
+
+      # Get access token
+      def token
+        token_hash[:access_token]
+      end
+
+      # Get access token type
+      def token_type
+        token_hash[:token_type] || "Bearer"
+      end
 
       # token setter
       def token=(new_token)
-        @token = new_token
+        @token_hash = { :access_token => new_token, :token_type => "Bearer" }
+      end
+
+      # Check token expired or not
+      def validate_token_hash
+        if @token_request_at and
+            @token_hash and @token_hash[:expires_in] and
+            (Time.now - @token_request_at) > @token_hash[:expires_in].to_i
+          @token_hash = nil
+        end
       end
 
       # Override the API call to handle Token Expire
@@ -66,9 +88,9 @@ module PayPal::SDK::Core
         begin
           response = super(payload)
         rescue UnauthorizedAccess => error
-          if @token and config.client_id
+          if @token_hash and config.client_id
             # Reset cached token and Retry api request
-            @token = nil
+            @token_hash = nil
             response = super(backup_payload)
           else
             raise error
@@ -96,7 +118,7 @@ module PayPal::SDK::Core
         # HTTP Header
         credential_properties = credential(payload[:uri].to_s).properties
         header = map_header_value(NVP_AUTH_HEADER, credential_properties)
-        payload[:header]  = header.merge("Authorization" => "Bearer #{token}").
+        payload[:header]  = header.merge("Authorization" => "#{token_type} #{token}").
           merge(DEFAULT_HTTP_HEADER).merge(payload[:header])
         # Post Data
         payload[:body]    = MultiJson.dump(payload[:params])
@@ -121,11 +143,6 @@ module PayPal::SDK::Core
         payload
       end
 
-      # Formate Exception object
-      def format_error(exception, message)
-        { "error" => { "name" => "ERROR", "message" => message, "developer_msg" => exception } }
-      end
-
       # Log PayPal-Request-Id header
       def log_http_call(payload)
         if payload[:header] and payload[:header]["PayPal-Request-Id"]

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

@@ -73,7 +73,8 @@ module PayPal::SDK::Core
         :http_timeout, :http_proxy,
         :device_ipaddress, :sandbox_email_address,
         :mode, :endpoint, :merchant_endpoint, :platform_endpoint, :ipn_endpoint,
-        :rest_endpoint, :rest_token_endpoint, :client_id, :client_secret
+        :rest_endpoint, :rest_token_endpoint, :client_id, :client_secret,
+        :openid_endpoint, :openid_redirect_uri, :openid_client_id, :openid_client_secret
 
     alias_method :end_point=, :endpoint=
     alias_method :end_point, :endpoint
@@ -163,7 +164,7 @@ module PayPal::SDK::Core
 
       # Get default environment name
       def default_environment
-        @@default_environment ||= ENV['PAYPAL_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['ENV'] || "development"
+        @@default_environment ||= ENV['PAYPAL_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development"
       end
 
       # Set default environment
@@ -171,6 +172,17 @@ module PayPal::SDK::Core
         @@default_environment = env.to_s
       end
 
+      def configure(options = {}, &block)
+        begin
+          self.config.merge!(options)
+        rescue Errno::ENOENT
+          self.configurations = { default_environment => options }
+        end
+        block.call(self.config) if block
+        self.config
+      end
+      alias_method :set_config, :configure
+
       # Create or Load Config object based on given environment and configurations.
       # === Attributes
       # * <tt>env</tt> (Optional) -- Environment name
@@ -184,12 +196,19 @@ module PayPal::SDK::Core
           override_configuration = env
           env = default_environment
         end
-        env = (env || default_environment).to_s
-        raise "Configuration[#{env}] NotFound" unless configurations[env]
         if override_configuration.nil? or override_configuration.empty?
-          @@config_cache[env] ||= new configurations[env]
+          default_config(env)
+        else
+          default_config(env).dup.merge!(override_configuration)
+        end
+      end
+
+      def default_config(env = nil)
+        env = (env || default_environment).to_s
+        if configurations[env]
+          @@config_cache[env] ||= new(configurations[env])
         else
-          new(configurations[env]).merge!(override_configuration)
+          raise Exceptions::MissingConfig.new("Configuration[#{env}] NotFound")
         end
       end
 

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

@@ -0,0 +1,16 @@
+module PayPal
+  module SDK
+    module Core
+      module Credential
+        autoload :Base,         "paypal-sdk/core/credential/base"
+        autoload :Certificate,  "paypal-sdk/core/credential/certificate"
+        autoload :Signature,    "paypal-sdk/core/credential/signature"
+
+        module ThirdParty
+          autoload :Token,    "paypal-sdk/core/credential/third_party/token"
+          autoload :Subject,  "paypal-sdk/core/credential/third_party/subject"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+
+module PayPal::SDK
+  module Core
+    module OpenIDConnect
+      autoload :API,             "paypal-sdk/core/openid_connect/api"
+      autoload :SetAPI,          "paypal-sdk/core/openid_connect/set_api"
+      autoload :GetAPI,          "paypal-sdk/core/openid_connect/get_api"
+      autoload :RequestDataType, "paypal-sdk/core/openid_connect/request_data_type"
+      autoload :DataTypes,       "paypal-sdk/core/openid_connect/data_types"
+
+      include DataTypes
+
+      class << self
+        def api
+          RequestDataType.api
+        end
+
+        def set_config(*args)
+          RequestDataType.set_config(*args)
+        end
+        alias_method :config=, :set_config
+
+        AUTHORIZATION_URL  = "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize"
+        ENDSESSION_URL     = "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/endsession"
+        DEFAULT_SCOPE      = "openid"
+
+        def authorize_url(params = {})
+          uri = URI(AUTHORIZATION_URL)
+          uri.query = api.encode_www_form({
+            :response_type => "code",
+            :scope => DEFAULT_SCOPE,
+            :client_id => RequestDataType.client_id,
+            :redirect_uri => api.config.openid_redirect_uri
+          }.merge(params))
+          uri.to_s
+        end
+
+        def logout_url(params = {})
+          uri = URI(ENDSESSION_URL)
+          uri.query = api.encode_www_form({
+            :logout   => "true",
+            :redirect_uri => api.config.openid_redirect_uri
+          }.merge(params))
+          uri.to_s
+        end
+      end
+
+      module DataTypes
+        class Tokeninfo < Base
+          include RequestDataType
+          PATH = "v1/identity/openidconnect/tokenservice"
+
+          class << self
+            def create_from_authorization_code(options, http_header = {})
+              options = { :code => options } if options.is_a? String
+              options = options.merge( :grant_type => "authorization_code" )
+              Tokeninfo.new(api.post(PATH, with_credentials(options), http_header))
+            end
+            alias_method :create, :create_from_authorization_code
+
+            def create_from_refresh_token(options, http_header = {})
+              options = { :refresh_token => options } if options.is_a? String
+              options = options.merge( :grant_type => "refresh_token" )
+              Tokeninfo.new(api.post(PATH, with_credentials(options), http_header))
+            end
+            alias_method :refresh, :create_from_refresh_token
+
+            def with_credentials(options = {})
+              options = options.dup
+              [ :client_id, :client_secret ].each do |key|
+                options[key] = self.send(key) unless options[key] or options[key.to_s]
+              end
+              options
+            end
+
+            def authorize_url(options = {})
+              OpenIDConnect.authorize_url(options)
+            end
+          end
+
+          def refresh(options = {})
+            tokeninfo = self.class.refresh({
+              :refresh_token => self.refresh_token}.merge(options))
+            self.merge!(tokeninfo.to_hash)
+          end
+
+          def userinfo(options = {})
+            Userinfo.get({ :access_token => self.access_token }.merge(options))
+          end
+
+          def logout_url(options = {})
+            OpenIDConnect.logout_url({ :id_token => self.id_token }.merge(options))
+          end
+
+        end
+
+        class Userinfo < Base
+          include RequestDataType
+          PATH = "v1/identity/openidconnect/userinfo"
+
+          class << self
+            def get_userinfo(options = {}, http_header = {})
+              options = { :access_token => options } if options.is_a? String
+              options = options.merge( :schema => "openid" ) unless options[:schema] or options["schema"]
+              Userinfo.new(api.post(PATH, options, http_header))
+            end
+            alias_method :get, :get_userinfo
+          end
+        end
+      end
+    end
+  end
+
+  # Alias for the Core::OpenIDConnect constant
+  OpenIDConnect = Core::OpenIDConnect
+end

data/lib/paypal-sdk/core/openid_connect/api.rb

@@ -0,0 +1,41 @@
+require 'multi_json'
+
+module PayPal::SDK
+  module Core
+    module OpenIDConnect
+      class API < Core::API::Base
+
+        DEFAULT_OPENID_ENDPOINT ="https://api.paypal.com"
+
+        def initialize(environment = nil, options = {})
+          super("", environment, options)
+        end
+
+        def service_endpoint
+          self.config.openid_endpoint || DEFAULT_OPENID_ENDPOINT
+        end
+
+        def format_request(payload)
+          payload[:uri].path = url_join(payload[:uri].path, payload[:action])
+          payload[:body]    = encode_www_form(payload[:params]) if payload[:params]
+          payload[:header]  = {"Content-Type" => "application/x-www-form-urlencoded" }.merge(payload[:header])
+          payload
+        end
+
+        def format_response(payload)
+          payload[:data] =
+            if payload[:response].code >= "200" and payload[:response].code <= "299"
+              MultiJson.load(payload[:response].body)
+            elsif payload[:response].content_type == "application/json"
+              { "error" => MultiJson.load(payload[:response].body) }
+            else
+              { "error" => { "name" => payload[:response].code, "message" => payload[:response].message,
+                "developer_msg" => payload[:response] } }
+            end
+          payload
+        end
+
+      end
+    end
+  end
+end