spook_and_pay 0.2.6.alpha → 0.2.7.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b1ff796137c7a459d6b8757e56e8c9ea52b76e3
-  data.tar.gz: 8b3dc5f18685220533a8718177c945f0ba7eaa76
+  metadata.gz: 0bd84aa5f8a08e720cb7eb6140911be472d923ee
+  data.tar.gz: c9345a68d16c46d723812c9934f561c3ce5513ec
 SHA512:
-  metadata.gz: 168c68ae8c2a3fe771938fe39dc87d06134d83494ec9e863a0a2e0f91d795b2f6d3f15f57833c3277df9f2b1e7705a1182b7bf22b3858c94611def2482f33c8c
-  data.tar.gz: bdf338598dcc6f21327bad76f9c87b91e6b28dd9c7e288ae5ddaca8dfe8133580177935b0265b4fdf55b5d6abf34b0657142b748c681c5dcff6296b5774c4c46
+  metadata.gz: 045d465056dce7c1025c4c04b7dca6e4f504b2203c86f3ea52b86f40ede6b919db556c312fe25b5477e47304846eb48e294ee94c9e3edaecec46354ea0d48106
+  data.tar.gz: 7b9e0f4368ce879baf32b3a20f4b41ba1d1f3164ae3a44f69d83ffb7c0b6ab4a8835281da3aa67c9a80171a8f8a70dc7144a7d0473baf327c851b2286c3ac5c1

data/lib/spook_and_pay/credit_card.rb

@@ -6,6 +6,14 @@ module SpookAndPay
     # This module adds the ::attr_erroring_reader to this class
     extend SpookAndPay::ErroringReader
 
+    # An error raised when trying to perform an action on a card that has 
+    # invalid details or has expired.
+    class InvalidCardError < StandardError
+      def to_s
+        "The action cannot be performed, this card is invalid or expired."
+      end
+    end
+
     # The basic attributes of the credit card.
     attr_reader :provider, :id, :raw
 
@@ -60,12 +68,58 @@ module SpookAndPay
       end
     end
 
+    # Checks to see if funds can be credited to a card. Depends on the 
+    # gateway/provider supporting crediting and having a valid card.
+    #
+    # @return [true, false]
+    def can_credit?
+      provider.supports_credit? and valid? and !expired?
+    end
+
+    # Checks to see if this card can be authorized against the specified
+    # gateway.
+    #
+    # @return [true, false]
+    def can_authorize?
+      provider.supports_authorize? and valid? and !expired?
+    end
+
+    # Checks to see if this card can be used for a purchase against the 
+    # underlying gateway.
+    #
+    # @return [true, false]
+    def can_purchase?
+      provider.supports_purchase? and valid? and !expired?
+    end
+
+    # Checks to see if the provider/gateway supports the deletion of credit
+    # card details.
+    #
+    # @return [true, false]
+    def can_delete?
+      provider.supports_delete?
+    end
+
+    # Credits the specified amount to the card.
+    #
+    # @param [String, Numeric] amount
+    # @return SpookAndPay::Result
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
+    # @raises SpookAndPay::CreditCard::InvalidCardError
+    def credit!(amount)
+      verify_action
+      provider.credit_via_credit_card(self, amount)
+    end
+
     # Authorizes a payment of the specified amount. This generates a new
     # transaction that must be later settled.
     #
     # @param [String, Numeric] amount
     # @return SpookAndPay::Result
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
+    # @raises SpookAndPay::CreditCard::InvalidCardError
     def authorize!(amount)
+      verify_action
       provider.authorize_via_credit_card(self, amount)
     end
 
@@ -73,13 +127,17 @@ module SpookAndPay
     #
     # @param [String, Numeric] amount
     # @return SpookAndPay::Result
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
+    # @raises SpookAndPay::CreditCard::InvalidCardError
     def purchase!(amount)
+      verify_action
       provider.purchase_via_credit_card(self, amount)
     end
 
     # Deletes the credit card from the provider's vault.
     #
-    # @return [true, false]
+    # @return SpookAndPay::Result
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
     def delete!
       provider.delete_credit_card(self)
     end
@@ -98,5 +156,17 @@ module SpookAndPay
     def expired?
       expired
     end
+
+    private
+
+
+    # A helper method which validates any actions — authorize, credit etc. —
+    # and where the card is expired or has invalid details, raises an error.
+    #
+    # @return nil
+    # @raises SpookAndPay::CreditCard::InvalidCardError
+    def verify_action
+      raise InvalidCardError if expired? or !valid?
+    end
   end
 end

data/lib/spook_and_pay/providers/base.rb

@@ -118,7 +118,7 @@ module SpookAndPay
       # @param [SpookAndPay::Transaction, String] id
       # @return SpookAndPay::Result
       def capture_transaction(id)
-        raise NotImplementedError
+        check_support('capture')
       end
 
       # Refunds the amount of money captured in a transaction.
@@ -129,7 +129,16 @@ module SpookAndPay
       # @param [SpookAndPay::Transaction, String] id
       # @return SpookAndPay::Result
       def refund_transaction(id)
-        raise NotImplementedError
+        check_support('refund')
+      end
+
+      # Checks to see if purchasing is supported. This is dependent on the payment 
+      # provider. The default implementation simply returns true. Specific 
+      # implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_purchase?
+        true
       end
 
       # Checks to see if voiding is supported. This is dependent on the payment 
@@ -141,6 +150,51 @@ module SpookAndPay
         true
       end
 
+      # Checks to see if crediting is supported. This is dependent on the payment 
+      # provider. The default implementation simply returns true. Specific 
+      # implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_credit?
+        true
+      end
+
+      # Checks to see if refunding is supported. This is dependent on the payment 
+      # provider. The default implementation simply returns true. Specific 
+      # implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_refund?
+        true
+      end
+
+      # Checks to see if capturing is supported. This is dependent on the payment 
+      # provider. The default implementation simply returns true. Specific 
+      # implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_capture?
+        true
+      end
+
+      # Checks to see if authorizing is supported. This is dependent on the payment 
+      # provider. The default implementation simply returns true. Specific 
+      # implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_authorize?
+        true
+      end
+
+      # Checks to see if the deletion of payment details is supported. This is
+      # dependent on the payment provider. The default implementation simply 
+      # returns true. Specific implementations should over-ride this method.
+      # 
+      # @return [true, false]
+      def supports_delete?
+        true
+      end
+
       # Voids an authorization. 
       #
       # This should not be called directly. Instead, use the #void! method
@@ -151,7 +205,7 @@ module SpookAndPay
       # @api private
       # @abstract Subclass to implement
       def void_transaction(id)
-        raise NotImplementedError
+        check_support('void')
       end
 
       # Authorizes a payment against a credit card
@@ -165,7 +219,21 @@ module SpookAndPay
       # @api private
       # @abstract Subclass to implement
       def authorize_via_credit_card(id, amount)
-        raise NotImplementedError
+        check_support('authorize')
+      end
+
+      # Credits funds to a credit card
+      #
+      # This should not be called directly. Instead, use the #authorize! method
+      # provided by a CreditCard instance.
+      #
+      # @param [SpookAndPay::CreditCard, String] id
+      # @param [String, Numeric] amount in dollars
+      # @return SpookAndPay::Result
+      # @api private
+      # @abstract Subclass to implement
+      def credit_via_credit_card(id, amount)
+        check_support('credit')
       end
 
       # Creates a purchase against a credit card.
@@ -179,7 +247,7 @@ module SpookAndPay
       # @api private
       # @abstract Subclass to implement
       def purchase_via_credit_card(id, amount)
-        raise NotImplementedError
+        check_support('purchase')
       end
 
       # Removes payment details from the provider's vault.
@@ -192,11 +260,32 @@ module SpookAndPay
       # @api private
       # @abstract Subclass to implement
       def delete_credit_card(id)
-        raise NotImplementedError
+        check_support('delete')
       end
 
       private
 
+      # Checks to see if a particular action is defined as being supported and 
+      # raises the appropriate error.
+      #
+      # The basic semantics is this; if someone implementing a provider says an
+      # action is supported via a #supports_*? predicate, this method should 
+      # never be called, so we raise NotImplementedError. Otherwise they are
+      # saying it's not supported and the appropriate response is to raise a
+      # NotSupportedError.
+      #
+      # @param String action
+      # @return nil
+      # @raises NotSupportedError
+      # @raises NotImplementedError
+      def check_support(action)
+        if send(:"supports_#{action}?")
+          raise NotImplementedError
+        else
+          raise NotSupportedError
+        end
+      end
+
       # Extracts the credit card id from it's argument. This is is to help with
       # methods that accept either a card instance of an id.
       #

data/lib/spook_and_pay/providers/spreedly.rb

@@ -49,11 +49,17 @@ module SpookAndPay
       # @param Hash opts
       # @return Hash
       def prepare_payment_submission(redirect_url, opts = {})
-        {
+        config = {
           :url            => spreedly.transparent_redirect_form_action,
           :field_names    => self.class::FORM_FIELD_NAMES,
           :hidden_fields  => {:redirect_url => redirect_url, :environment_key => spreedly.key}
         }
+
+        if opts[:token]
+          config[:hidden_fields][:payment_method_token] = opts[:token]
+        end
+
+        config
       end
 
       # Confirms the submission of payment details to Spreedly Core.
@@ -115,10 +121,30 @@ module SpookAndPay
       # spreedly gem, check it.
       ::Spreedly::Gateway.send(:field, :characteristics)
 
+      def supports_purchase?
+        check_support_for('supports_purchase')
+      end
+
       def supports_void?
-        gateway = spreedly.find_gateway(gateway_token)
-        node = Nokogiri::XML::DocumentFragment.parse(gateway.characteristics)
-        node.xpath(".//supports_void").inner_html.strip == 'true'
+        check_support_for('supports_void')
+      end
+
+      def supports_credit?
+        false
+      end
+
+      def supports_capture?
+        check_support_for('supports_capture')
+      end
+
+      def supports_authorize?
+        check_support_for('supports_authorize')
+      end
+
+      def supports_delete?
+        # This does not check the gateway, since the redaction is specific to
+        # Spreedly's store, not the gateway.
+        true
       end
 
       def authorize_via_credit_card(id, amount)
@@ -138,6 +164,18 @@ module SpookAndPay
 
       private
 
+      # Retrieves the gateway from Spreedly and then inspects the response to 
+      # see what features it supports. This is a helper for the #supports_*?
+      # predicates.
+      #
+      # @param String path
+      # @return [true, false]
+      def check_support_for(path)
+        gateway = spreedly.find_gateway(gateway_token)
+        node = Nokogiri::XML::DocumentFragment.parse(gateway.characteristics)
+        node.xpath(".//#{path}").inner_html.strip == 'true'
+      end
+
       # Takes the result of running a transaction against a Spreedly gateway
       # and coerces it into a SpookAndPay::Result
       #

data/lib/spook_and_pay/transaction.rb

@@ -96,7 +96,7 @@ module SpookAndPay
     #
     # @return [true, false]
     def can_refund?
-      status == :settled
+      settled? and provider.supports_refund?
     end
 
     # A predicate for checking if a transaction can be captured. Only true if
@@ -104,7 +104,7 @@ module SpookAndPay
     #
     # @return [true, false]
     def can_capture?
-      status == :authorized
+      authorized? and provider.supports_capture?
     end
 
     # A predicate for checking if a transaction can be voided. Only true if
@@ -112,7 +112,7 @@ module SpookAndPay
     #
     # @return [true, false]
     def can_void?
-      (status == :authorized or status == :settling) and provider.supports_void?
+      (authorized? or settling?) and provider.supports_void?
     end
 
     # Refunds the transaction. The related credit card will be credited for
@@ -120,9 +120,10 @@ module SpookAndPay
     # authorizations.
     #
     # @return SpookAndPay::Result
-    # @raises InvalidActionError
+    # @raises SpookAndPay::Transaction::InvalidActionError
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
     def refund!
-      raise InvalidActionError.new(id, :refund, status) unless can_refund?
+      raise InvalidActionError.new(id, :refund, status) unless settled?
       provider.refund_transaction(self)
     end
 
@@ -130,9 +131,10 @@ module SpookAndPay
     # authorized and will fail if the transaction is already captured.
     #
     # @return SpookAndPay::Result
-    # @raises InvalidActionError
+    # @raises SpookAndPay::Transaction::InvalidActionError
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
     def capture!
-      raise InvalidActionError.new(id, :capture, status) unless can_capture?
+      raise InvalidActionError.new(id, :capture, status) unless authorized?
       provider.capture_transaction(self)
     end
 
@@ -140,9 +142,10 @@ module SpookAndPay
     # authorized status. Otherwise it must be refunded.
     #
     # @return SpookAndPay::Result
-    # @raises InvalidActionError
+    # @raises SpookAndPay::Transaction::InvalidActionError
+    # @raises SpookAndPay::Providers::Base::NotSupportedError
     def void!
-      raise InvalidActionError.new(id, :void, status) unless can_void?
+      raise InvalidActionError.new(id, :void, status) unless authorized? or settling?
       provider.void_transaction(self)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spook_and_pay
 version: !ruby/object:Gem::Version
-  version: 0.2.6.alpha
+  version: 0.2.7.alpha
 platform: ruby
 authors:
 - Luke Sutton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: braintree