candy_check 0.1.1 → 0.4.0

data/lib/candy_check/play_store/client.rb

@@ -1,126 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # A client which uses the official Google API SDK to authenticate
-    # and request product information from Google's API.
-    #
-    # @example Usage
-    #   config = ClientConfig.new({...})
-    #   client = Client.new(config)
-    #   client.boot! # a single time
-    #   client.verify('my.bundle', 'product_1', 'a-very-long-secure-token')
-    #   # ... multiple calls from now on
-    #   client.verify('my.bundle', 'product_1', 'another-long-token')
-    class Client
-      # Error thrown if the discovery of the API wasn't successful
-      class DiscoveryError < RuntimeError; end
-
-      # API endpoint
-      API_URL      = 'https://accounts.google.com/o/oauth2/token'.freeze
-      # API scope for Android services
-      API_SCOPE    = 'https://www.googleapis.com/auth/androidpublisher'.freeze
-      # API discovery namespace
-      API_DISCOVER = 'androidpublisher'.freeze
-      # API version
-      API_VERSION  = 'v2'.freeze
-
-      # Initializes a client using a configuration.
-      # @param config [ClientConfig]
-      def initialize(config)
-        @config = config
-      end
-
-      # Boots a client by discovering the API's services and then authorizes
-      # by fetching an access token.
-      # If the config has a cache_file the client tries to load discovery
-      def boot!
-        @api_client = Google::APIClient.new(
-          application_name:    config.application_name,
-          application_version: config.application_version
-        )
-        discover!
-        authorize!
-      end
-
-      # Calls the remote API to load the product information for a specific
-      # combination of parameter which should be loaded from the client.
-      # @param package [String] the app's package name
-      # @param product_id [String] the app's item id
-      # @param token [String] the purchase token
-      # @return [Hash] result of the API call
-      def verify(package, product_id, token)
-        parameters = {
-          'packageName' => package,
-          'productId'   => product_id,
-          'token'       => token
-        }
-        execute(parameters, rpc.purchases.products.get)
-      end
-
-      # Calls the remote API to load the product information for a specific
-      # combination of parameter which should be loaded from the client.
-      # @param package [String] the app's package name
-      # @param subscription_id [String] the app's item id
-      # @param token [String] the purchase token
-      # @return [Hash] result of the API call
-      def verify_subscription(package, subscription_id, token)
-        parameters = {
-          'packageName'    => package,
-          'subscriptionId' => subscription_id,
-          'token'          => token
-        }
-        execute(parameters, rpc.purchases.subscriptions.get)
-      end
-
-      private
-
-      attr_reader :config, :api_client, :rpc
-
-      # Execute api call through the API Client's HTTP command class
-      # @param parameters [hash] the parameters to send to the command
-      # @param api_method [Method] which api method to call
-      # @return [hash] the data response, as a hash
-      def execute(parameters, api_method)
-        api_client.execute(
-          api_method: api_method,
-          parameters: parameters
-        ).data.to_hash
-      end
-
-      def discover!
-        @rpc = load_discover_dump || request_discover
-        validate_rpc!
-        write_discover_dump
-      end
-
-      def request_discover
-        api_client.discovered_api(API_DISCOVER, API_VERSION)
-      end
-
-      def authorize!
-        api_client.authorization = Signet::OAuth2::Client.new(
-          token_credential_uri: API_URL,
-          audience:             API_URL,
-          scope:                API_SCOPE,
-          issuer:               config.issuer,
-          signing_key:          config.api_key
-        )
-        api_client.authorization.fetch_access_token!
-      end
-
-      def validate_rpc!
-        return if rpc.purchases.products.get
-        raise DiscoveryError, 'Unable to get the API discovery'
-      rescue NoMethodError
-        raise DiscoveryError, 'Unable to get the API discovery'
-      end
-
-      def load_discover_dump
-        DiscoveryRepository.new(config.cache_file).load
-      end
-
-      def write_discover_dump
-        DiscoveryRepository.new(config.cache_file).save(rpc)
-      end
-    end
-  end
-end

data/lib/candy_check/play_store/config.rb

@@ -1,51 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # Configure the usage of the official Google API SDK client
-    class Config < Utils::Config
-      # @return [String] your application name
-      attr_reader :application_name
-      # @return [String] your application's version
-      attr_reader :application_version
-      # @return [String] an optional file to cache the discovery API result
-      attr_reader :cache_file
-      # @return [String] your issuer's service account e-mail
-      attr_reader :issuer
-      # @return [String] the path to your local *.p12 certificate file
-      attr_reader :key_file
-      # @return [String] the secret to load your certificate file
-      attr_reader :key_secret
-
-      # Initializes a new configuration from a hash
-      # @param attributes [Hash]
-      # @example Initialize with a discovery cache file
-      #   ClientConfig.new(
-      #     application_name: 'YourApplication',
-      #     application_version: '1.0',
-      #     cache_file: 'tmp/google_api_cache',
-      #     issuer: 'abcdefg@developer.gserviceaccount.com',
-      #     key_file: 'local/google.p12',
-      #     key_secret: 'notasecret'
-      #   )
-      def initialize(attributes)
-        super
-      end
-
-      # @return [String] the decrypted API key from Google
-      def api_key
-        @api_key ||= begin
-          Google::APIClient::KeyUtils.load_from_pkcs12(key_file, key_secret)
-        end
-      end
-
-      private
-
-      def validate!
-        validates_presence(:application_name)
-        validates_presence(:application_version)
-        validates_presence(:issuer)
-        validates_presence(:key_file)
-        validates_presence(:key_secret)
-      end
-    end
-  end
-end

data/lib/candy_check/play_store/discovery_repository.rb

@@ -1,33 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # A file-based repository to cache a local copy of the Google API
-    # discovery as suggested by Google.
-    # @see https://github.com/google/google-api-ruby-client
-    class DiscoveryRepository
-      # Create a new instance bound to a single file path
-      # @param file_path [String] to save and load the cached copy
-      def initialize(file_path)
-        @file_path = file_path
-      end
-
-      # Tries to load a cached copy of the discovery API. Me be nil if
-      # no cached version is available
-      # @return [Google::APIClient::API]
-      def load
-        return unless @file_path && File.exist?(@file_path)
-        File.open(@file_path, 'rb') do |file|
-          return Marshal.load(file)
-        end
-      end
-
-      # Tries to save a local copy of the discovery API.
-      # @param discovery [Google::APIClient::API]
-      def save(discovery)
-        return unless @file_path && discovery
-        File.open(@file_path, 'wb') do |file|
-          Marshal.dump(discovery, file)
-        end
-      end
-    end
-  end
-end

data/lib/candy_check/play_store/receipt.rb

@@ -1,81 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # Describes a successful response from the Google verification server
-    class Receipt
-      include Utils::AttributeReader
-
-      # @return [Hash] the raw attributes returned from the server
-      attr_reader :attributes
-
-      # 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 Google API servers
-      # @param attributes [Hash]
-      def initialize(attributes)
-        @attributes = attributes
-      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 purchase state of the order. Possible values are:
-      #   * 0: Purchased
-      #   * 1: Cancelled
-      # @return [Fixnum]
-      def purchase_state
-        read_integer('purchaseState')
-      end
-
-      # The consumption state of the inapp product. Possible values are:
-      #   * 0: Yet to be consumed
-      #   * 1: Consumed
-      # @return [Fixnum]
-      def consumption_state
-        read_integer('consumptionState')
-      end
-
-      # The developer payload which was used when buying the product
-      # @return [String]
-      def developer_payload
-        read('developerPayload')
-      end
-
-      # This kind represents an inappPurchase object in the androidpublisher
-      # service.
-      # @return [String]
-      def kind
-        read('kind')
-      end
-
-      # The time the product was purchased, in milliseconds since the
-      # epoch (Jan 1, 1970)
-      # @return [Fixnum]
-      def purchase_time_millis
-        read_integer('purchaseTimeMillis')
-      end
-
-      # The date and time the product was purchased
-      # @return [DateTime]
-      def purchased_at
-        read_datetime_from_millis('purchaseTimeMillis')
-      end
-    end
-  end
-end

data/lib/candy_check/play_store/subscription.rb

@@ -1,139 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # Describes a successfully validated subscription
-    class Subscription
-      include Utils::AttributeReader
-
-      # @return [Hash] the raw attributes returned from the server
-      attr_reader :attributes
-
-      # 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 attributes [Hash]
-      def initialize(attributes)
-        @attributes = attributes
-      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?
-        read_bool('autoRenewing')
-      end
-
-      # Get the payment state as given by Google
-      # @return [Integer]
-      def payment_state
-        read_integer('paymentState')
-      end
-
-      # Get the price amount for the subscription in micros in the payed
-      # currency
-      # @return [Integer]
-      def price_amount_micros
-        read_integer('priceAmountMicros')
-      end
-
-      # Get the cancel reason, as given by Google
-      # @return [Integer]
-      def cancel_reason
-        read_integer('cancelReason')
-      end
-
-      # Get the kind of subscription as stored in the android publisher service
-      # @return [String]
-      def kind
-        read('kind')
-      end
-
-      # Get developer-specified supplemental information about the order
-      # @return [String]
-      def developer_payload
-        read('developerPayload')
-      end
-
-      # Get the currency code in ISO 4217 format, e.g. "GBP" for British pounds
-      # @return [String]
-      def price_currency_code
-        read('priceCurrencyCode')
-      end
-
-      # Get start time for subscription in milliseconds since Epoch
-      # @return [Integer]
-      def start_time_millis
-        read_integer('startTimeMillis')
-      end
-
-      # Get expiry time for subscription in milliseconds since Epoch
-      # @return [Integer]
-      def expiry_time_millis
-        read_integer('expiryTimeMillis')
-      end
-
-      # Get start time in UTC
-      # @return [DateTime]
-      def starts_at
-        read_datetime_from_millis('startTimeMillis')
-      end
-
-      # Get expiration time in UTC
-      # @return [DateTime]
-      def expires_at
-        read_datetime_from_millis('expiryTimeMillis')
-      end
-    end
-  end
-end

data/lib/candy_check/play_store/subscription_verification.rb

@@ -1,30 +0,0 @@
-module CandyCheck
-  module PlayStore
-    # Verifies a purchase token against the Google API
-    # The call return either an {Receipt} or an {VerificationFailure}
-    class SubscriptionVerification < Verification
-      # Performs the verification against the remote server
-      # @return [Subscription] if successful
-      # @return [VerificationFailure] otherwise
-      def call!
-        verify!
-        if valid?
-          Subscription.new(@response)
-        else
-          VerificationFailure.new(@response['error'])
-        end
-      end
-
-      private
-
-      def valid?
-        ok_kind = @response['kind'] == 'androidpublisher#subscriptionPurchase'
-        @response && @response['expiryTimeMillis'] && ok_kind
-      end
-
-      def verify!
-        @response = @client.verify_subscription(package, product_id, token)
-      end
-    end
-  end
-end