candy_check 0.1.0.pre → 0.3.0

data/lib/candy_check/play_store/product_purchases/product_verification.rb

@@ -0,0 +1,53 @@
+module CandyCheck
+  module PlayStore
+    module ProductPurchases
+      # Verifies a purchase token against the PlayStore API
+      # The call return either a {ProductPurchase} or a {VerificationFailure}
+      class ProductVerification
+        # @return [String] the package_name which will be queried
+        attr_reader :package_name
+        # @return [String] the item id which will be queried
+        attr_reader :product_id
+        # @return [String] the token for authentication
+        attr_reader :token
+
+        # Initializes a new call to the API
+        # @param package_name [String]
+        # @param product_id [String]
+        # @param token [String]
+        def initialize(package_name:, product_id:, token:, authorization:)
+          @package_name = package_name
+          @product_id = product_id
+          @token = token
+          @authorization = authorization
+        end
+
+        # Performs the verification against the remote server
+        # @return [ProductPurchase] if successful
+        # @return [VerificationFailure] otherwise
+        def call!
+          verify!
+          if valid?
+            CandyCheck::PlayStore::ProductPurchases::ProductPurchase.new(@response[:result])
+          else
+            CandyCheck::PlayStore::VerificationFailure.new(@response[:error])
+          end
+        end
+
+        private
+
+        def valid?
+          @response[:result] && @response[:result].purchase_state && @response[:result].consumption_state
+        end
+
+        def verify!
+          service = CandyCheck::PlayStore::AndroidPublisherService.new
+          service.authorization = @authorization
+          service.get_purchase_product(package_name, product_id, token) do |result, error|
+            @response = { result: result, error: error }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/subscription_purchases/subscription_purchase.rb

@@ -0,0 +1,154 @@
+module CandyCheck
+  module PlayStore
+    module SubscriptionPurchases
+      # Describes a successfully validated subscription
+      class SubscriptionPurchase
+        include Utils::AttributeReader
+
+        # @return [Google::Apis::AndroidpublisherV3::SubscriptionPurchase] the raw subscription purchase from google-api-client
+        attr_reader :subscription_purchase
+
+        # The payment of the subscription is pending (paymentState)
+        PAYMENT_PENDING = 0
+        # The payment of the subscript is received (paymentState)
+        PAYMENT_RECEIVED = 1
+        # The subscription was canceled by the user (cancelReason)
+        PAYMENT_CANCELED = 0
+        # The payment failed during processing (cancelReason)
+        PAYMENT_FAILED = 1
+
+        # Initializes a new instance which bases on a JSON result
+        # from Google's servers
+        # @param subscription_purchase [Google::Apis::AndroidpublisherV3::SubscriptionPurchase]
+        def initialize(subscription_purchase)
+          @subscription_purchase = subscription_purchase
+        end
+
+        # Check if the expiration date is passed
+        # @return [bool]
+        def expired?
+          overdue_days > 0
+        end
+
+        # Check if in trial. This is actually not given by Google, but we assume
+        # that it is a trial going on if the paid amount is 0 and
+        # renewal is activated.
+        # @return [bool]
+        def trial?
+          price_is_zero = price_amount_micros == 0
+          price_is_zero && payment_received?
+        end
+
+        # see if payment is ok
+        # @return [bool]
+        def payment_received?
+          payment_state == PAYMENT_RECEIVED
+        end
+
+        # see if payment is pending
+        # @return [bool]
+        def payment_pending?
+          payment_state == PAYMENT_PENDING
+        end
+
+        # see if payment has failed according to Google
+        # @return [bool]
+        def payment_failed?
+          cancel_reason == PAYMENT_FAILED
+        end
+
+        # see if this the user has canceled its subscription
+        # @return [bool]
+        def canceled_by_user?
+          cancel_reason == PAYMENT_CANCELED
+        end
+
+        # Get number of overdue days. If this is negative, it is not overdue.
+        # @return [Integer]
+        def overdue_days
+          (Time.now.utc.to_date - expires_at.to_date).to_i
+        end
+
+        # Get the auto renewal status as given by Google
+        # @return [bool] true if renewing automatically, false otherwise
+        def auto_renewing?
+          @subscription_purchase.auto_renewing
+        end
+
+        # Get the payment state as given by Google
+        # @return [Integer]
+        def payment_state
+          @subscription_purchase.payment_state
+        end
+
+        # Get the price amount for the subscription in micros in the payed
+        # currency
+        # @return [Integer]
+        def price_amount_micros
+          @subscription_purchase.price_amount_micros
+        end
+
+        # Get the cancel reason, as given by Google
+        # @return [Integer]
+        def cancel_reason
+          @subscription_purchase.cancel_reason
+        end
+
+        # Get the kind of subscription as stored in the android publisher service
+        # @return [String]
+        def kind
+          @subscription_purchase.kind
+        end
+
+        # Get developer-specified supplemental information about the order
+        # @return [String]
+        def developer_payload
+          @subscription_purchase.developer_payload
+        end
+
+        # Get the currency code in ISO 4217 format, e.g. "GBP" for British pounds
+        # @return [String]
+        def price_currency_code
+          @subscription_purchase.price_currency_code
+        end
+
+        # Get start time for subscription in milliseconds since Epoch
+        # @return [Integer]
+        def start_time_millis
+          @subscription_purchase.start_time_millis
+        end
+
+        # Get expiry time for subscription in milliseconds since Epoch
+        # @return [Integer]
+        def expiry_time_millis
+          @subscription_purchase.expiry_time_millis
+        end
+
+        # Get cancellation time for subscription in milliseconds since Epoch.
+        # Only present if cancelReason is 0.
+        # @return [Integer]
+        def user_cancellation_time_millis
+          @subscription_purchase.user_cancellation_time_millis if canceled_by_user?
+        end
+
+        # Get start time in UTC
+        # @return [DateTime]
+        def starts_at
+          Time.at(start_time_millis / 1000).utc.to_datetime
+        end
+
+        # Get expiration time in UTC
+        # @return [DateTime]
+        def expires_at
+          Time.at(expiry_time_millis / 1000).utc.to_datetime
+        end
+
+        # Get cancellation time in UTC
+        # @return [DateTime]
+        def canceled_at
+          Time.at(user_cancellation_time_millis / 1000).utc.to_datetime if user_cancellation_time_millis
+        end
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/subscription_purchases/subscription_verification.rb

@@ -0,0 +1,55 @@
+module CandyCheck
+  module PlayStore
+    module SubscriptionPurchases
+      # Verifies a purchase token against the Google API
+      # The call return either an {SubscriptionPurchase} or an {VerificationFailure}
+      class SubscriptionVerification
+        # @return [String] the package which will be queried
+        attr_reader :package_name
+        # @return [String] the item id which will be queried
+        attr_reader :subscription_id
+        # @return [String] the token for authentication
+        attr_reader :token
+
+        # Initializes a new call to the API
+        # @param package_name [String]
+        # @param subscription_id [String]
+        # @param token [String]
+        def initialize(package_name:, subscription_id:, token:, authorization:)
+          @package_name = package_name
+          @subscription_id = subscription_id
+          @token = token
+          @authorization = authorization
+        end
+
+        # Performs the verification against the remote server
+        # @return [SubscriptionPurchase] if successful
+        # @return [VerificationFailure] otherwise
+        def call!
+          verify!
+          if valid?
+            CandyCheck::PlayStore::SubscriptionPurchases::SubscriptionPurchase.new(@response[:result])
+          else
+            CandyCheck::PlayStore::VerificationFailure.new(@response[:error])
+          end
+        end
+
+        private
+
+        def valid?
+          return false unless @response[:result]
+          ok_kind = @response[:result].kind == "androidpublisher#subscriptionPurchase"
+          @response && @response[:result].expiry_time_millis && ok_kind
+        end
+
+        def verify!
+          service = CandyCheck::PlayStore::AndroidPublisherService.new
+          service.authorization = @authorization
+          service.get_purchase_subscription(package_name, subscription_id, token) do |result, error|
+            @response = { result: result, error: error }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/verification_failure.rb

@@ -5,25 +5,27 @@ module CandyCheck
       include Utils::AttributeReader
 
       # @return [Hash] the raw attributes returned from the server
-      attr_reader :attributes
+      attr_reader :error
 
       # Initializes a new instance which bases on a JSON result
       # from Google API servers
-      # @param attributes [Hash]
-      def initialize(attributes)
-        @attributes = attributes || {}
+      # @param error [Hash]
+      def initialize(error)
+        @error = error
       end
 
       # The code of the failure
       # @return [Fixnum]
       def code
-        read('code') || -1
+        Integer(error.status_code)
+      rescue
+        -1
       end
 
       # The message of the failure
       # @return [String]
       def message
-        read('message') || 'Unknown error'
+        error.message || "Unknown error"
       end
     end
   end

data/lib/candy_check/play_store/verifier.rb

@@ -1,69 +1,44 @@
 module CandyCheck
   module PlayStore
     # Verifies purchase tokens against the Google API.
-    # The call return either an {Receipt} or a {VerificationFailure}
+    # The call return either a {SubscriptionPurchases::SubscriptionPurchase} or a {VerificationFailure}
     class Verifier
-      # Error thrown when the verifier isn't booted before the first
-      # verification check or on double invocation
-      class BootRequiredError < RuntimeError; end
-
-      # @return [Config] the current configuration
-      attr_reader :config
-
-      # Initializes a new verifier for the application which is bound
-      # to a configuration
-      # @param config [Config]
-      def initialize(config)
-        @config = config
-      end
-
-      # Boot the module
-      def boot!
-        boot_error('You\'re only allowed to boot the verifier once') if booted?
-        @client = Client.new(config)
-        @client.boot!
+      # Initializes a new verifier which is bound to an authorization
+      # @param authorization [Google::Auth::ServiceAccountCredentials] to use against the PlayStore API
+      def initialize(authorization:)
+        @authorization = authorization
       end
 
       # Contacts the Google API and requests the product state
-      # @param package [String] to query
+      # @param package_name [String] to query
       # @param product_id [String] to query
       # @param token [String] to use for authentication
-      # @return [Receipt] if successful
+      # @return [ProductPurchases::ProductPurchase] if successful
       # @return [VerificationFailure] otherwise
-      def verify(package, product_id, token)
-        check_boot!
-        verification = Verification.new(@client, package, product_id, token)
-        verification.call!
+      def verify_product_purchase(package_name:, product_id:, token:)
+        verifier = CandyCheck::PlayStore::ProductPurchases::ProductVerification.new(
+          package_name: package_name,
+          product_id: product_id,
+          token: token,
+          authorization: @authorization,
+        )
+        verifier.call!
       end
 
       # Contacts the Google API and requests the product state
-      # @param package [String] to query
+      # @param package_name [String] to query
       # @param subscription_id [String] to query
       # @param token [String] to use for authentication
-      # @return [Receipt] if successful
+      # @return [SubscriptionPurchases::SubscriptionPurchase] if successful
       # @return [VerificationFailure] otherwise
-      def verify_subscription(package, subscription_id, token)
-        check_boot!
-        v = SubscriptionVerification.new(
-          @client, package, subscription_id, token
+      def verify_subscription_purchase(package_name:, subscription_id:, token:)
+        verifier = CandyCheck::PlayStore::SubscriptionPurchases::SubscriptionVerification.new(
+          package_name: package_name,
+          subscription_id: subscription_id,
+          token: token,
+          authorization: @authorization,
         )
-        v.call!
-      end
-
-      private
-
-      def booted?
-        instance_variable_defined?(:@client)
-      end
-
-      def check_boot!
-        return if booted?
-        boot_error 'You need to boot the verifier service first: '\
-                   'CandyCheck::PlayStore::Verifier#boot!'
-      end
-
-      def boot_error(message)
-        raise BootRequiredError, message
+        verifier.call!
       end
     end
   end

data/lib/candy_check/utils/config.rb

@@ -5,9 +5,11 @@ module CandyCheck
       # Initializes a new configuration from a hash
       # @param attributes [Hash]
       def initialize(attributes)
-        attributes.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end if attributes.is_a? Hash
+        if attributes.is_a?(Hash)
+          attributes.each do |k, v|
+            instance_variable_set "@#{k}", v
+          end
+        end
         validate!
       end
 

data/lib/candy_check/version.rb

@@ -1,4 +1,4 @@
 module CandyCheck
   # The current gem's version
-  VERSION = '0.1.0.pre'.freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/app_store/receipt_collection_spec.rb

@@ -8,10 +8,12 @@ describe CandyCheck::AppStore::ReceiptCollection do
       [{
         'expires_date' => '2014-04-15 12:52:40 Etc/GMT',
         'expires_date_pst' => '2014-04-15 05:52:40 America/Los_Angeles',
+        'purchase_date' => '2014-04-14 12:52:40 Etc/GMT',
         'is_trial_period' => 'false'
       }, {
         'expires_date' => '2015-04-15 12:52:40 Etc/GMT',
         'expires_date_pst' => '2015-04-15 05:52:40 America/Los_Angeles',
+        'purchase_date' => '2015-04-14 12:52:40 Etc/GMT',
         'is_trial_period' => 'false'
       }]
     end
@@ -34,6 +36,34 @@ describe CandyCheck::AppStore::ReceiptCollection do
       expected = DateTime.new(2015, 4, 15, 12, 52, 40)
       subject.expires_at.must_equal expected
     end
+
+    it 'is expired? at same pointin time' do
+      Timecop.freeze(Time.utc(2015, 4, 15, 12, 52, 40)) do
+        subject.expired?.must_be_true
+      end
+    end
+  end
+
+  describe 'unordered receipts' do
+    let(:attributes) do
+      [{
+           'expires_date' => '2015-04-15 12:52:40 Etc/GMT',
+           'expires_date_pst' => '2015-04-15 05:52:40 America/Los_Angeles',
+           'purchase_date' => '2015-04-14 12:52:40 Etc/GMT',
+           'is_trial_period' => 'false'
+       }, {
+           'expires_date' => '2014-04-15 12:52:40 Etc/GMT',
+           'expires_date_pst' => '2014-04-15 05:52:40 America/Los_Angeles',
+           'purchase_date' => '2014-04-14 12:52:40 Etc/GMT',
+           'is_trial_period' => 'false'
+       }]
+    end
+
+    it 'the expires date is the latest one in time' do
+      expected = DateTime.new(2015, 4, 15, 12, 52, 40)
+      subject.expires_at.must_equal expected
+    end
+
   end
 
   describe 'unexpired trial subscription' do
@@ -42,10 +72,12 @@ describe CandyCheck::AppStore::ReceiptCollection do
     let(:attributes) do
       [{
         'expires_date' => '2016-04-15 12:52:40 Etc/GMT',
+        'purchase_date' => '2016-04-15 12:52:40 Etc/GMT',
         'is_trial_period' => 'true'
       }, {
         'expires_date' =>
           two_days_from_now.strftime('%Y-%m-%d %H:%M:%S Etc/GMT'),
+        'purchase_date' => '2016-04-15 12:52:40 Etc/GMT',
         'is_trial_period' => 'true'
       }]
     end
@@ -62,4 +94,5 @@ describe CandyCheck::AppStore::ReceiptCollection do
       subject.overdue_days.must_equal(-2)
     end
   end
+
 end