candy_check 0.1.2 → 0.2.0

data/lib/candy_check/cli/commands/play_store.rb

@@ -4,17 +4,13 @@ module CandyCheck
       # Command to verify an PlayStore purchase
       class PlayStore < Base
         # Prepare a verification run from the terminal
-        # @param package [String]
+        # @param package_name [String]
         # @param product_id [String]
         # @param token [String]
         # @param options [Hash]
-        # @option options [String] :issuer to use for API access
-        # @option options [String] :key_file to use for API access
-        # @option options [String] :key_secret to decrypt the key file
-        # @option options [String] :application_name for the API call
-        # @option options [String] :application_version for the API call
-        def initialize(package, product_id, token, options)
-          @package = package
+        # @option options [String] :json_key_file to use for API access
+        def initialize(package_name, product_id, token, options)
+          @package = package_name
           @product_id = product_id
           @token = token
           super(options)
@@ -22,17 +18,20 @@ module CandyCheck
 
         # Print the result of the verification to the terminal
         def run
-          verifier = CandyCheck::PlayStore::Verifier.new(config)
-          verifier.boot!
-          result = verifier.verify(@package, @product_id, @token)
+          verifier = CandyCheck::PlayStore::Verifier.new(authorization: authorization)
+          result = verifier.verify_product_purchase(
+            package_name: @package,
+            product_id: @product_id,
+            token: @token,
+          )
           out.print "#{result.class}:"
           out.pretty result
         end
 
         private
 
-        def config
-          CandyCheck::PlayStore::Config.new(options)
+        def authorization
+          CandyCheck::PlayStore.authorization(options["json_key_file"])
         end
       end
     end

data/lib/candy_check/play_store.rb

@@ -1,17 +1,24 @@
-require 'google/api_client'
+require "google/apis/androidpublisher_v3"
 
-require 'candy_check/play_store/discovery_repository'
-require 'candy_check/play_store/client'
-require 'candy_check/play_store/config'
-require 'candy_check/play_store/receipt'
-require 'candy_check/play_store/subscription'
-require 'candy_check/play_store/verification'
-require 'candy_check/play_store/subscription_verification'
-require 'candy_check/play_store/verification_failure'
-require 'candy_check/play_store/verifier'
+require "candy_check/play_store/android_publisher_service"
+require "candy_check/play_store/product_purchases/product_purchase"
+require "candy_check/play_store/subscription_purchases/subscription_purchase"
+require "candy_check/play_store/product_purchases/product_verification"
+require "candy_check/play_store/subscription_purchases/subscription_verification"
+require "candy_check/play_store/verification_failure"
+require "candy_check/play_store/verifier"
 
 module CandyCheck
   # Module to request and verify a AppStore receipt
   module PlayStore
+    # Build an authorization object
+    # @param json_key_file [String]
+    # @return [Google::Auth::ServiceAccountCredentials]
+    def self.authorization(json_key_file)
+      Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: File.open(json_key_file),
+        scope: "https://www.googleapis.com/auth/androidpublisher",
+      )
+    end
   end
 end

data/lib/candy_check/play_store/android_publisher_service.rb

@@ -0,0 +1,6 @@
+module CandyCheck
+  module PlayStore
+    class AndroidPublisherService < Google::Apis::AndroidpublisherV3::AndroidPublisherService
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+module CandyCheck
+  module PlayStore
+    module ProductPurchases
+      # Describes a successful response from the PlayStore verification server
+      class ProductPurchase
+        include Utils::AttributeReader
+
+        # Returns the raw ProductPurchase from google-api-client gem
+        # @return [Google::Apis::AndroidpublisherV3::ProductPurchase]
+        attr_reader :product_purchase
+
+        # Purchased product (0 is purchased, don't ask me why)
+        # @see https://developers.google.com/android-publisher/api-ref/purchases/products
+        PURCHASE_STATE_PURCHASED = 0
+
+        # A consumed product
+        CONSUMPTION_STATE_CONSUMED = 1
+
+        # Initializes a new instance which bases on a JSON result
+        # from PlayStore API servers
+        # @param product_purchase [Google::Apis::AndroidpublisherV3::ProductPurchase]
+        def initialize(product_purchase)
+          @product_purchase = product_purchase
+        end
+
+        # The purchase state of the order. Possible values are:
+        #   * 0: Purchased
+        #   * 1: Cancelled
+        # @return [Fixnum]
+        def purchase_state
+          @product_purchase.purchase_state
+        end
+
+        # The consumption state of the inapp product. Possible values are:
+        #   * 0: Yet to be consumed
+        #   * 1: Consumed
+        # @return [Fixnum]
+        def consumption_state
+          @product_purchase.consumption_state
+        end
+
+        # The developer payload which was used when buying the product
+        # @return [String]
+        def developer_payload
+          @product_purchase.developer_payload
+        end
+
+        # This kind represents an inappPurchase object in the androidpublisher
+        # service.
+        # @return [String]
+        def kind
+          @product_purchase.kind
+        end
+
+        # The order id
+        # @return [String]
+        def order_id
+          @product_purchase.order_id
+        end
+
+        # The time the product was purchased, in milliseconds since the
+        # epoch (Jan 1, 1970)
+        # @return [Fixnum]
+        def purchase_time_millis
+          @product_purchase.purchase_time_millis
+        end
+
+        # A product may be purchased or canceled. Ensure a receipt
+        # is valid before granting some candy
+        # @return [Boolean]
+        def valid?
+          purchase_state == PURCHASE_STATE_PURCHASED
+        end
+
+        # A purchased product may already be consumed. In this case you
+        # should grant candy even if it's valid.
+        # @return [Boolean]
+        def consumed?
+          consumption_state == CONSUMPTION_STATE_CONSUMED
+        end
+
+        # The date and time the product was purchased
+        # @return [DateTime]
+        def purchased_at
+          Time.at(purchase_time_millis / 1000).utc.to_datetime
+        end
+      end
+    end
+  end
+end

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,141 @@
+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
+          (Date.today - 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 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
+      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