payment_recipes 1.0.1 → 1.1.0

data/lib/payment_recipes/paypal/soap/action/execute_express_checkout_payment.rb

@@ -0,0 +1,131 @@
+"""
+NOTES: Response Structure (action.response)
+
+PayPal::SDK::Merchant::DataTypes::DoExpressCheckoutPaymentResponseType
+   ├── Ack: Success
+   ├── Build: ***
+   ├── CorrelationID: ***
+   ├── DoExpressCheckoutPaymentResponseDetails: PayPal::SDK::Merchant::DataTypes::DoExpressCheckoutPaymentResponseDetailsType
+   │   ├── CoupledPaymentInfo: PayPal::SDK::Core::API::DataTypes::ArrayWithBlock
+   │   │   └── 0: #<PayPal::SDK::Merchant::DataTypes::CoupledPaymentInfoType:0x007fba1a527138>
+   │   │
+   │   ├── PaymentInfo: PayPal::SDK::Core::API::DataTypes::ArrayWithBlock
+   │   │   └── 0: PayPal::SDK::Merchant::DataTypes::PaymentInfoType
+   │   │       ├── ExchangeRate: nil
+   │   │       ├── FeeAmount: PayPal::SDK::Merchant::DataTypes::BasicAmountType
+   │   │       │   ├── currencyID: USD
+   │   │       │   └── value: 0.36
+   │   │       │
+   │   │       ├── GrossAmount: PayPal::SDK::Merchant::DataTypes::BasicAmountType
+   │   │       │   ├── currencyID: USD
+   │   │       │   └── value: 2.00
+   │   │       │
+   │   │       ├── ParentTransactionID: nil
+   │   │       ├── PaymentDate: 2017-02-05T17:34:13+00:00
+   │   │       ├── PaymentStatus: Completed
+   │   │       ├── PaymentType: instant
+   │   │       ├── PendingReason: none
+   │   │       ├── ProtectionEligibility: Eligible
+   │   │       ├── ProtectionEligibilityType: ItemNotReceivedEligible,UnauthorizedPaymentEligible
+   │   │       ├── ReasonCode: none
+   │   │       ├── ReceiptID: nil
+   │   │       ├── SellerDetails: PayPal::SDK::Merchant::DataTypes::SellerDetailsType
+   │   │       │   └── SecureMerchantAccountID: ***
+   │   │       │
+   │   │       ├── TaxAmount: PayPal::SDK::Merchant::DataTypes::BasicAmountType
+   │   │       │   ├── currencyID: USD
+   │   │       │   └── value: 0.00
+   │   │       │
+   │   │       ├── TransactionID: ***
+   │   │       └── TransactionType: express-checkout
+   │   │    
+   │   ├── SuccessPageRedirectRequested: false
+   │   └── Token: ***
+   │
+   ├── Timestamp: ***
+   └── Version: ***
+"""
+
+module PaymentRecipes
+  module PayPal
+    module SOAP
+      module Action
+        class ExecuteExpressCheckout < PaymentRecipes::Utils::Action
+          variable :token, "String"
+          variable :payer_id, "String"
+          variable :details, "Hash"
+          variable :intent, "Symbol"
+
+          def perform
+            prepare_soap_api
+            modify_details
+            do_express_checkout
+
+            if response.success?
+              load_transaction
+            end
+
+            response
+          end
+          
+          def prepare_soap_api
+            store(:api) do
+              ::PaymentRecipes::PayPal::SOAP::Settings.api
+            end
+          end
+
+          def modify_details
+            unless [:sale, :authorize].include?(intent)
+              raise Exception, "Allowed values for intent: :sale, :authorize"
+            end
+
+            store(:express_checkout_details) do
+              payment_action = if intent == :sale
+                                 'Sale'
+                               elsif intent == :authorize
+                                 'Authorization'
+                               end
+
+              {
+                :DoExpressCheckoutPaymentRequestDetails => {
+                  :PaymentAction => payment_action,
+                  :Token => token,
+                  :PayerID => payer_id,
+                  :PaymentDetails => [details] 
+                } 
+              }
+            end
+          end
+
+          def response
+            do_express_checkout_response
+          end
+
+          def do_express_checkout
+            do_express_checkout_payment = api.build_do_express_checkout_payment(express_checkout_details)
+
+            store(:do_express_checkout_response) do
+              response = api.do_express_checkout_payment(do_express_checkout_payment)
+
+              unless response.success?
+                @error = response.errors
+
+                response = nil
+              end
+
+              response
+            end
+          end
+
+          def load_transaction
+            store(:transaction) do
+              transaction_id = response.do_express_checkout_payment_response_details.payment_info.first.transaction_id
+              
+              ::PaymentRecipes::PayPal::SOAP::Transaction.find(transaction_id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/payment_recipes/paypal/soap/action/perform_direct_payment.rb

@@ -0,0 +1,62 @@
+module PaymentRecipes
+  module PayPal
+    module SOAP
+      module Action
+        class PerformDirectPayment < PaymentRecipes::Utils::Action
+          variable :details, "Hash"
+          variable :intent, "Symbol"
+
+          def perform
+            prepare_soap_api
+            modify_details
+            perform_request
+
+            if response.success?
+              load_transaction
+            end
+
+            response
+          end
+
+          def prepare_soap_api
+            store(:api) do
+              ::PaymentRecipes::PayPal::SOAP::Settings.api
+            end
+          end
+
+          def modify_details
+            unless [:sale, :authorize].include?(intent)
+              raise Exception, "Allowed values for intent: :sale, :authorize"
+            end
+
+            store(:direct_payment_details) do
+              payment_action = if intent == :sale
+                                 'Sale'
+                               elsif intent == :authorize
+                                 'Authorization'
+                               end
+
+              details[:DoDirectPaymentRequestDetails][:PaymentAction] = payment_action
+
+              details
+            end
+          end
+
+          def perform_request
+            do_direct_payment = api.build_do_direct_payment(direct_payment_details)
+
+            store(:response) do
+              api.do_direct_payment(do_direct_payment)
+            end
+          end
+
+          def load_transaction
+            store(:transaction) do
+              ::PaymentRecipes::PayPal::SOAP::Transaction.find(response.transaction_id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/payment_recipes/paypal/soap/settings.rb

@@ -0,0 +1,22 @@
+module PaymentRecipes
+  module PayPal
+    module SOAP
+      class Settings
+      	def self.configure(live: false, app_id:, username:, password:, signature:)
+          mode = live ? "live" : "sandbox"
+
+          ::PayPal::SDK.configure(
+            :mode      => mode,
+            :app_id    => app_id,
+            :username  => username,
+            :password  => password,
+            :signature => signature )
+        end
+
+        def self.api
+          ::PayPal::SDK::Merchant.new
+        end
+      end
+    end
+  end
+end

data/lib/payment_recipes/paypal/soap/transaction.rb

@@ -0,0 +1,116 @@
+module PaymentRecipes
+  module PayPal
+    module SOAP
+      class Transaction
+        attr_reader :raw_transaction
+
+        attr_reader :id
+        attr_reader :correlation_id
+        attr_reader :timestamp
+        attr_reader :transaction_type
+
+        attr_reader :gross_amount
+        attr_reader :fee_amount
+        attr_reader :tax_amount
+        attr_reader :payment_item_amount
+
+        attr_reader :payment_date
+        attr_reader :payment_type
+        attr_reader :payment_status
+        attr_reader :pending_reason
+
+        attr_reader :parent_transaction_id
+
+        include ::PaymentRecipes::Utils::Converters
+        include ::PaymentRecipes::Utils::Equality
+
+        def initialize(paypal_transaction, id: nil)
+          unless paypal_transaction.is_a?(::PayPal::SDK::Merchant::DataTypes::GetTransactionDetailsResponseType)
+            raise Exception, "#{ self.class.name } must be initialized with a PayPal Transaction" 
+          end
+
+          extract_and_store(paypal_transaction)
+        end
+
+        def extract_and_store(paypal_transaction)
+          @raw_transaction = paypal_transaction
+
+          @id = id || paypal_transaction.payment_transaction_details.payment_info.transaction_id
+          @correlation_id = paypal_transaction.correlation_id
+          @timestamp = paypal_transaction.timestamp.to_time
+
+          @transaction_type = paypal_transaction.payment_transaction_details.payment_info.transaction_type.to_s
+          @payment_type = paypal_transaction.payment_transaction_details.payment_info.payment_type.to_s
+          @payment_status = paypal_transaction.payment_transaction_details.payment_info.payment_status.to_s
+          @pending_reason = paypal_transaction.payment_transaction_details.payment_info.pending_reason.to_s
+          @parent_transaction_id = paypal_transaction.payment_transaction_details.payment_info.parent_transaction_id.to_s
+          @payment_date = paypal_transaction.payment_transaction_details.payment_info.payment_date.to_time
+
+          paypal_gross_amount = paypal_transaction.payment_transaction_details.payment_info.gross_amount
+          @gross_amount = convert_to_money(amount: paypal_gross_amount.value, currency: paypal_gross_amount.currencyID)
+
+          paypal_fee_amount = paypal_transaction.payment_transaction_details.payment_info.fee_amount
+          @fee_amount = convert_to_money(amount: paypal_fee_amount.value, currency: paypal_fee_amount.currencyID)
+
+          paypal_tax_amount = paypal_transaction.payment_transaction_details.payment_info.tax_amount
+          @tax_amount = convert_to_money(amount: paypal_tax_amount.value, currency: paypal_tax_amount.currencyID)
+
+          payment_item_amount = paypal_transaction.payment_transaction_details.payment_item_info.payment_item.first.amount
+          @payment_item_amount = convert_to_money(amount: payment_item_amount.value, currency: payment_item_amount.currencyID)
+        end
+
+        def pending?
+          @payment_status == "Pending"
+        end
+
+        def complete?
+          @payment_status == "Completed"
+        end
+
+        def inspect
+          to_str
+        end
+
+        def to_s
+          to_str
+        end
+
+        def to_str
+          if pending?
+            "<#{ self.class.name } type=#{ @transaction_type } payment_type=#{ @payment_type } payment_status=#{ @payment_status } [#{ @pending_reason }] id=#{ @id }>"
+          else
+            "<#{ self.class.name } type=#{ @transaction_type } payment_type=#{ @payment_type } payment_status=#{ @payment_status } id=#{ @id }>"
+          end
+        end
+        
+        class << self
+          def find(id)
+            paypal_transaction = find_raw(id)
+
+            if paypal_transaction
+              new(paypal_transaction, id: id)
+            else
+              nil
+            end
+          end
+
+          def find_raw(id)
+            api = ::PaymentRecipes::PayPal::SOAP::Settings.api
+
+            begin
+              get_transaction_details = api.build_get_transaction_details({
+                :TransactionID => id })
+
+              response = api.get_transaction_details(get_transaction_details)
+
+              response
+
+            rescue Exception
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/payment_recipes/utils/action.rb

@@ -1,3 +1,18 @@
+"""
+class SamplePaymentAction < PaymentRecipes::Utils::Action
+  variable :x, 'Integer'
+
+  def perform
+    if x
+      puts x + 1
+    end
+  end
+end
+
+action = SamplePaymentAction.prepare(x: nil)
+action.execute
+"""
+
 module PaymentRecipes
   module Utils
     class Action
@@ -12,28 +27,150 @@ module PaymentRecipes
         end
 
         def rules
-          @rules
+          @rules || []
         end
 
-        def prepare(parameters)
-          @rules.each do |key, klass|
-            unless parameters[key].is_a?(klass)
-              raise Exception, "#{ key } should be a #{ klass }"
+        def prepare(parameters = {})
+          rules.each do |key, klass|
+            # unless parameters[key].is_a?(klass.constantize)# || parameters[key].is_a?(NilClass)
+            allowed_class_strings = parameters[key].class.ancestors.map(&:to_s)
+            unless allowed_class_strings.include?(klass) || allowed_class_strings.include?("NilClass")
+              raise TypeError, "#{ key } should be a #{ klass }"
             end
           end
 
-          new(parameters)
+          output = new(parameters)
+          output.instance_variable_set(:@_action_state, :prepared)
+
+          output
+        end
+
+        def debug
+          study rules
         end
       end
 
-      def initialize(parameters)
-        raise Exception, "Action params should be a Hash" unless parameters.is_a?(Hash)
+      def initialize(parameters = {})
+        raise TypeError, "Action params should be a Hash" unless parameters.is_a?(Hash)
 
         @params = parameters
         @params.each do |param, value|
           instance_variable_set("@#{ param }".to_sym, value)
         end
       end
+
+      def success?
+        @success
+      end
+
+      def failure?
+        not success?
+      end
+
+      def execute
+        @success = nil
+        @error = nil
+
+        unless @_action_state
+          raise Exception, "Use #{ self.class.name }.prepare to initialize this action"
+        end
+
+        unless @_action_state == :executed
+          @_action_output = perform
+
+          if @error
+            @success = false
+          else
+            @success = true
+          end
+
+          make_instance_variables_available
+
+          @_action_state = :executed
+        end
+
+        @_action_output
+      end
+
+      def stored_variables
+        output = {}
+
+        instance_variables.each do |instance_variable|
+          instance_variable_sym = instance_variable.to_s.gsub("@", "").to_sym
+
+          begin
+            output[instance_variable_sym] = send(instance_variable_sym)
+          rescue Exception => e
+            # NOTE: do nothing
+          end
+        end
+
+        output
+      end
+
+      def make_instance_variables_available
+        instance_variables.each do |instance_variable|
+          define_singleton_method(instance_variable.to_s.gsub("@", "")) do
+            instance_variable_get(instance_variable)
+          end
+        end
+      end
+
+      def ensure_presence(variable, default: nil)
+        if variable.present?
+          yield if block_given?
+        else
+          default
+        end
+      end
+
+      """
+      memoize(:x) do
+        puts 'executed'
+        42
+      end
+      """
+      def store(label)
+        label_sym = "@#{label}".to_sym
+
+        if stored_value = instance_variable_get(label_sym)
+          stored_value
+        else
+          if block_given?
+            computed_value = yield
+
+            instance_variable_set(label_sym, computed_value)
+
+            define_singleton_method(label_sym.to_s.gsub("@", "")) do
+              instance_variable_get(label_sym)
+            end
+          end
+        end
+
+        instance_variable_get(label_sym)
+      end
+
+      def set(label, value)
+        label_sym = "@#{label}".to_sym
+
+        instance_variable_set(label_sym, value)
+
+        define_singleton_method(label_sym.to_s.gsub("@", "")) do
+          instance_variable_get(label_sym)
+        end
+
+        value
+      end
+
+      def get(label)
+        label_sym = "@#{label}".to_sym
+
+        instance_variable_get(label_sym)
+      end
+
+      def debug
+        study @params
+      end
     end
   end
 end

data/lib/payment_recipes/version.rb

@@ -1,3 +1,3 @@
 module PaymentRecipes
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/payment_recipes.rb

@@ -8,20 +8,29 @@ require 'payment_recipes/utils/action'
 require 'payment_recipes/utils/converters'
 require 'payment_recipes/utils/equality'
 
-require 'payment_recipes/paypal/settings'
-require 'payment_recipes/paypal/authorization'
-require 'payment_recipes/paypal/capture'
-require 'payment_recipes/paypal/payer'
-require 'payment_recipes/paypal/payment'
-require 'payment_recipes/paypal/refund'
-require 'payment_recipes/paypal/sale'
-require 'payment_recipes/paypal/transaction'
+require 'payment_recipes/paypal/rest/settings'
+require 'payment_recipes/paypal/rest/authorization'
+require 'payment_recipes/paypal/rest/capture'
+require 'payment_recipes/paypal/rest/payer'
+require 'payment_recipes/paypal/rest/payment'
+require 'payment_recipes/paypal/rest/refund'
+require 'payment_recipes/paypal/rest/sale'
+require 'payment_recipes/paypal/rest/transaction'
 
-require 'payment_recipes/paypal/action/capture_authorization'
-require 'payment_recipes/paypal/action/create_payment'
-require 'payment_recipes/paypal/action/execute_payment'
-require 'payment_recipes/paypal/action/refund_capture'
-require 'payment_recipes/paypal/action/refund_sale'
-require 'payment_recipes/paypal/action/void_authorization'
+require 'payment_recipes/paypal/rest/action/capture_authorization'
+require 'payment_recipes/paypal/rest/action/create_payment'
+require 'payment_recipes/paypal/rest/action/execute_payment'
+require 'payment_recipes/paypal/rest/action/refund_capture'
+require 'payment_recipes/paypal/rest/action/refund_sale'
+require 'payment_recipes/paypal/rest/action/void_authorization'
 
-I18n.config.available_locales = :en
+I18n.config.available_locales = :en
+
+require 'paypal-sdk-merchant'
+
+require 'payment_recipes/paypal/soap/settings'
+require 'payment_recipes/paypal/soap/transaction'
+require 'payment_recipes/paypal/soap/action/perform_direct_payment'
+require 'payment_recipes/paypal/soap/action/capture_authorization'
+require 'payment_recipes/paypal/soap/action/create_express_checkout_payment'
+require 'payment_recipes/paypal/soap/action/execute_express_checkout_payment'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payment_recipes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Joshua Arvin Lat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: paypal-sdk-merchant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.106.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.106.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,20 +88,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/payment_recipes.rb
-- lib/payment_recipes/paypal/action/capture_authorization.rb
-- lib/payment_recipes/paypal/action/create_payment.rb
-- lib/payment_recipes/paypal/action/execute_payment.rb
-- lib/payment_recipes/paypal/action/refund_capture.rb
-- lib/payment_recipes/paypal/action/refund_sale.rb
-- lib/payment_recipes/paypal/action/void_authorization.rb
-- lib/payment_recipes/paypal/authorization.rb
-- lib/payment_recipes/paypal/capture.rb
-- lib/payment_recipes/paypal/payer.rb
-- lib/payment_recipes/paypal/payment.rb
-- lib/payment_recipes/paypal/refund.rb
-- lib/payment_recipes/paypal/sale.rb
-- lib/payment_recipes/paypal/settings.rb
-- lib/payment_recipes/paypal/transaction.rb
+- lib/payment_recipes/paypal/rest/action/capture_authorization.rb
+- lib/payment_recipes/paypal/rest/action/create_payment.rb
+- lib/payment_recipes/paypal/rest/action/execute_payment.rb
+- lib/payment_recipes/paypal/rest/action/refund_capture.rb
+- lib/payment_recipes/paypal/rest/action/refund_sale.rb
+- lib/payment_recipes/paypal/rest/action/void_authorization.rb
+- lib/payment_recipes/paypal/rest/authorization.rb
+- lib/payment_recipes/paypal/rest/capture.rb
+- lib/payment_recipes/paypal/rest/payer.rb
+- lib/payment_recipes/paypal/rest/payment.rb
+- lib/payment_recipes/paypal/rest/refund.rb
+- lib/payment_recipes/paypal/rest/sale.rb
+- lib/payment_recipes/paypal/rest/settings.rb
+- lib/payment_recipes/paypal/rest/transaction.rb
+- lib/payment_recipes/paypal/soap/action/capture_authorization.rb
+- lib/payment_recipes/paypal/soap/action/create_express_checkout_payment.rb
+- lib/payment_recipes/paypal/soap/action/execute_express_checkout_payment.rb
+- lib/payment_recipes/paypal/soap/action/perform_direct_payment.rb
+- lib/payment_recipes/paypal/soap/settings.rb
+- lib/payment_recipes/paypal/soap/transaction.rb
 - lib/payment_recipes/utils/action.rb
 - lib/payment_recipes/utils/converters.rb
 - lib/payment_recipes/utils/equality.rb
@@ -112,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wrapper classes and utilities to speed up payment gateway integration

data/lib/payment_recipes/paypal/action/capture_authorization.rb

@@ -1,25 +0,0 @@
-module PaymentRecipes
-  module PayPal
-    module Action
-      class CaptureAuthorization < PaymentRecipes::Utils::Action
-        variable :authorization, ::PaymentRecipes::PayPal::Authorization
-
-        def perform
-          if @authorization.can_be_captured?
-            currency = @authorization.currency
-            total = @authorization.total.to_s
-
-            @authorization.raw_authorization.capture({:amount => { :currency => currency, :total => total } })
-
-            @authorization.reload!
-            @authorization.reload_payment!
-          else
-            raise Exception, "Authorization can't be captured"
-          end
-
-          @authorization
-        end
-      end
-    end
-  end
-end