candy_check 0.0.5 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 414f845cc6a6fa6a27f814866675412925ed8a85
-  data.tar.gz: a2699ef81d97d170e964bf08bcbd5949284f00ac
+  metadata.gz: 45e40e19795d3d805ea61453fe6bea1d5e94ec3a
+  data.tar.gz: 9ba798923e9c36b324aa93c860f6ea75687e56bc
 SHA512:
-  metadata.gz: 9449d7d55b94fa560d8be6bdc2f1d082287e78561f6c935d4a2ca3836759ddd0ac3d6385052624436257c21f889e4e5bd087d48b57fe4b6736fd580b554d496d
-  data.tar.gz: 15579d8441886b67bcb4d28a9c9404cc836e553821e4d9c46e8dfec8090fb929b5d6ac1baa7fc5c58c396869a79840143400b1bb632d32f4c016b4cd00b1dfcc
+  metadata.gz: f6e4a4bd35ab65c5ad309052f8b27408b3bd570701a39674f9b6120900242ebe2199bf5814788a8fa9572774a8686cc3b57908eeda35223a5c7786b4e921181e
+  data.tar.gz: 8f3e4cd0adff6af8067667294fb439e05a840e69c9b24d73c0af0a607d348d4a8ffcbe3392e469fd2fab36e26155241739936ae91a8c1509f32595f7a1bf299d

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   Exclude:
     - 'spec/support/*'
-    - 'bin/*'
-    - 'vendor/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
 Style/Documentation:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.3.1

data/.travis.yml

@@ -2,6 +2,8 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
+  - '2.3.1'
+  - '2.3.0'
   - '2.2'
   - '2.1'
   - '2.0'

data/README.md

@@ -18,8 +18,7 @@ gem install candy_check
 
 ## Introduction
 
-This gem tries to simplify the process of server-side in-app purchase validation for Apple's AppStore and
-Google's PlayStore.
+This gem tries to simplify the process of server-side in-app purchase and subscription validation for Apple's AppStore and Google's PlayStore.
 
 ### AppStore
 
@@ -75,6 +74,15 @@ verifier.verify(your_receipt_data, your_secret)
 
 Please see the class documenations [`CandyCheck::AppStore::Receipt`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/AppStore/Receipt) and [`CandyCheck::AppStore::VerificationFailure`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/AppStore/VerificationFailure) for further details about the responses.
 
+For **subscription verification**, Apple also returns a list of the user's purchases. Essentially, this is a collection of receipts. To verify a subscription, do the following:
+
+```ruby
+# ... create your verifier as above
+verifier.verify_subscription(your_receipt_data, your_secret) # => ReceiptCollection or VerificationFailure
+```
+
+Please see the class documentation for [`CandyCheck::AppStore::ReceiptCollection`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/AppStore/ReceiptCollection) for further details.
+
 ### PlayStore
 
 First initialize and **boot** a verifier instance for your application. This loads the API discovery and
@@ -102,6 +110,14 @@ verifier.verify(package, product_id, token) # => Receipt or VerificationFailure
 
 Please see the class documenations [`CandyCheck::PlayStore::Receipt`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/PlayStore/Receipt) and [`CandyCheck::PlayStore::VerificationFailure`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/PlayStore/VerificationFailure) for further details about the responses.
 
+In order to **verify a subscription** from the Play Store, do the following:
+
+```ruby
+verifier.verify_subscription(package, subscription_id, token) # => Subscription or VerificationFailure
+```
+
+Please see documenation for [`CandyCheck::PlayStore::Subscription`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/PlayStore/Subscription) for further details.
+
 ## CLI
 
 This gem ships with an executable to verify in-app purchases directly from your terminal:

data/candy_check.gemspec

@@ -23,12 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google-api-client', '~> 0.8.6'
   spec.add_dependency 'thor',              '~> 0.19'
 
-  spec.add_development_dependency 'rubocop',         '~> 0.28'
+  spec.add_development_dependency 'rubocop',         '~> 0.39'
   spec.add_development_dependency 'inch',            '~> 0.5'
   spec.add_development_dependency 'bundler',         '~> 1.7'
-  spec.add_development_dependency 'rake',            '~> 10.0'
-  spec.add_development_dependency 'coveralls',       '~> 0.7'
-  spec.add_development_dependency 'minitest',        '~> 5.5'
+  spec.add_development_dependency 'rake',            '~> 11.1'
+  spec.add_development_dependency 'coveralls',       '~> 0.8'
+  spec.add_development_dependency 'minitest',        '~> 5.9'
   spec.add_development_dependency 'minitest-around', '~> 0.3'
-  spec.add_development_dependency 'webmock',         '~> 1.20'
+  spec.add_development_dependency 'webmock',         '~> 2.1'
 end

data/lib/candy_check/app_store.rb

@@ -1,7 +1,9 @@
 require 'candy_check/app_store/client'
 require 'candy_check/app_store/config'
 require 'candy_check/app_store/receipt'
+require 'candy_check/app_store/receipt_collection'
 require 'candy_check/app_store/verification'
+require 'candy_check/app_store/subscription_verification'
 require 'candy_check/app_store/verification_failure'
 require 'candy_check/app_store/verifier'
 

data/lib/candy_check/app_store/receipt.rb

@@ -84,6 +84,18 @@ module CandyCheck
       def cancellation_date
         read_datetime_from_string('cancellation_date')
       end
+
+      # The date of a subscription's expiration
+      # @return [DateTime]
+      def expires_date
+        read_datetime_from_string('expires_date')
+      end
+
+      # rubocop:disable PredicateName
+      def is_trial_period
+        # rubocop:enable PredicateName
+        read_bool('is_trial_period')
+      end
     end
   end
 end

data/lib/candy_check/app_store/receipt_collection.rb

@@ -0,0 +1,41 @@
+module CandyCheck
+  module AppStore
+    # Store multiple {Receipt}s in order to perform collective operation on them
+    class ReceiptCollection
+      # Multiple receipts as in verfication response
+      # @return [Array<Receipt>]
+      attr_reader :receipts
+
+      # Initializes a new instance which bases on a JSON result
+      # from Apple's verification server
+      # @param attributes [Array<Hash>]
+      def initialize(attributes)
+        @receipts = attributes.map { |r| Receipt.new(r) }
+      end
+
+      # Check if the latest expiration date is passed
+      # @return [bool]
+      def expired?
+        overdue_days > 0
+      end
+
+      # Check if in trial
+      # @return [bool]
+      def trial?
+        @receipts.last.is_trial_period
+      end
+
+      # Get latest expiration date
+      # @return [DateTime]
+      def expires_at
+        @receipts.last.expires_date
+      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
+    end
+  end
+end

data/lib/candy_check/app_store/subscription_verification.rb

@@ -0,0 +1,26 @@
+module CandyCheck
+  module AppStore
+    # Verifies a latest_receipt_info block against a verification server.
+    # The call return either an {ReceiptCollection} or a {VerificationFailure}
+    class SubscriptionVerification < CandyCheck::AppStore::Verification
+      # Performs the verification against the remote server
+      # @return [ReceiptCollection] if successful
+      # @return [VerificationFailure] otherwise
+      def call!
+        verify!
+        if valid?
+          ReceiptCollection.new(@response['latest_receipt_info'])
+        else
+          VerificationFailure.fetch(@response['status'])
+        end
+      end
+
+      private
+
+      def valid?
+        status_is_ok = @response['status'] == STATUS_OK
+        @response && status_is_ok && @response['latest_receipt_info']
+      end
+    end
+  end
+end

data/lib/candy_check/app_store/verifier.rb

@@ -30,6 +30,23 @@ module CandyCheck
       # @return [Receipt] if successful
       # @return [VerificationFailure] otherwise
       def verify(receipt_data, secret = nil)
+        @verifier = Verification
+        fetch_receipt_information(receipt_data, secret)
+      end
+
+      # Calls a subscription verification for the given input
+      # @param receipt_data [String] the raw data to be verified
+      # @param secret [string] the optional shared secret
+      # @return [ReceiptCollection] if successful
+      # @return [Verification] otherwise
+      def verify_subscription(receipt_data, secret = nil)
+        @verifier = SubscriptionVerification
+        fetch_receipt_information(receipt_data, secret)
+      end
+
+      private
+
+      def fetch_receipt_information(receipt_data, secret = nil)
         default_endpoint, opposite_endpoint = endpoints
         result = call_for(default_endpoint, receipt_data, secret)
         if should_retry?(result)
@@ -38,10 +55,8 @@ module CandyCheck
         result
       end
 
-      private
-
       def call_for(endpoint_url, receipt_data, secret)
-        Verification.new(endpoint_url, receipt_data, secret).call!
+        @verifier.new(endpoint_url, receipt_data, secret).call!
       end
 
       def should_retry?(result)

data/lib/candy_check/play_store.rb

@@ -4,7 +4,9 @@ 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'
 

data/lib/candy_check/play_store/client.rb

@@ -26,14 +26,14 @@ module CandyCheck
       # Initializes a client using a configuration.
       # @param config [ClientConfig]
       def initialize(config)
-        self.config = 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!
-        self.api_client = Google::APIClient.new(
+        @api_client = Google::APIClient.new(
           application_name:    config.application_name,
           application_version: config.application_version
         )
@@ -48,22 +48,46 @@ module CandyCheck
       # @param token [String] the purchase token
       # @return [Hash] result of the API call
       def verify(package, product_id, token)
-        api_client.execute(
-          api_method: rpc.purchases.products.get,
-          parameters: {
-            'packageName' => package,
-            'productId'   => product_id,
-            'token'       => token
-          }
-        ).data.to_hash
+        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_accessor :config, :api_client, :rpc
+      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!
-        self.rpc = load_discover_dump || request_discover
+        @rpc = load_discover_dump || request_discover
         validate_rpc!
         write_discover_dump
       end

data/lib/candy_check/play_store/subscription.rb

@@ -0,0 +1,138 @@
+module CandyCheck
+  module PlayStore
+    # Describes a succeful subscription validation
+    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 payd 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

@@ -0,0 +1,30 @@
+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

data/lib/candy_check/play_store/verifier.rb

@@ -19,7 +19,7 @@ module CandyCheck
 
       # Boot the module
       def boot!
-        boot_error('You\'re only allowed to boot the verifier once') if @client
+        boot_error('You\'re only allowed to boot the verifier once') if booted?
         @client = Client.new(config)
         @client.boot!
       end
@@ -36,10 +36,28 @@ module CandyCheck
         verification.call!
       end
 
+      # Contacts the Google API and requests the product state
+      # @param package [String] to query
+      # @param subscription_id [String] to query
+      # @param token [String] to use for authentication
+      # @return [Receipt] if successful
+      # @return [VerificationFailure] otherwise
+      def verify_subscription(package, subscription_id, token)
+        check_boot!
+        v = SubscriptionVerification.new(
+          @client, package, subscription_id, token
+        )
+        v.call!
+      end
+
       private
 
+      def booted?
+        instance_variable_defined?(:@client)
+      end
+
       def check_boot!
-        return if @client
+        return if booted?
         boot_error 'You need to boot the verifier service first: '\
                    'CandyCheck::PlayStore::Verifier#boot!'
       end

data/lib/candy_check/utils/attribute_reader.rb

@@ -18,6 +18,14 @@ module CandyCheck
         (val = read(field)) && val.to_i
       end
 
+      # @return [bool] if value is either 'true' or 'false'
+      # @return [nil] if value is not 'true'/'false'
+      def read_bool(field)
+        val = read(field).to_s
+        return nil unless %w(false true).include?(val)
+        val == 'true'
+      end
+
       def read_datetime_from_string(field)
         (val = read(field)) && DateTime.parse(val)
       end

data/lib/candy_check/version.rb

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

data/spec/app_store/receipt_collection_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe CandyCheck::AppStore::ReceiptCollection do
+  subject { CandyCheck::AppStore::ReceiptCollection.new(attributes) }
+
+  describe 'overdue subscription' do
+    let(:attributes) do
+      [{
+        'expires_date' => '2014-04-15 12:52:40 Etc/GMT',
+        'expires_date_pst' => '2014-04-15 05:52:40 America/Los_Angeles',
+        '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',
+        'is_trial_period' => 'false'
+      }]
+    end
+
+    it 'is expired' do
+      subject.expired?.must_be_true
+    end
+
+    it 'is not a trial' do
+      subject.trial?.must_be_false
+    end
+
+    it 'has positive overdue days' do
+      overdue = subject.overdue_days
+      overdue.must_be_instance_of Fixnum
+      assert overdue > 0
+    end
+
+    it 'has a last expires date' do
+      expected = DateTime.new(2015, 4, 15, 12, 52, 40)
+      subject.expires_at.must_equal expected
+    end
+  end
+
+  describe 'unexpired trial subscription' do
+    two_days_from_now = DateTime.now + 2
+
+    let(:attributes) do
+      [{
+        'expires_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'),
+        'is_trial_period' => 'true'
+      }]
+    end
+
+    it 'has not expired' do
+      subject.expired?.must_be_false
+    end
+
+    it 'it is a trial' do
+      subject.trial?.must_be_true
+    end
+
+    it 'expires in two days' do
+      subject.overdue_days.must_equal(-2)
+    end
+  end
+end

data/spec/app_store/receipt_spec.rb

@@ -23,7 +23,9 @@ describe CandyCheck::AppStore::Receipt do
       'purchase_date_pst'          => '2015-01-09 03:40:46' \
                                       ' America/Los_Angeles',
       'bid'                        => 'some.test.app',
-      'original_purchase_date_ms'  => '1420717246868'
+      'original_purchase_date_ms'  => '1420717246868',
+      'expires_date'               => '2016-06-09 13:59:40 Etc/GMT',
+      'is_trial_period'            => 'false'
     }
   end
 
@@ -77,6 +79,15 @@ describe CandyCheck::AppStore::Receipt do
     it 'returns raw attributes' do
       subject.attributes.must_be_same_as attributes
     end
+
+    it 'returns the subscription expiration date' do
+      expected = DateTime.new(2016, 6, 9, 13, 59, 40)
+      subject.expires_date.must_equal expected
+    end
+
+    it 'returns the trial status' do
+      subject.is_trial_period.must_be_false
+    end
   end
 
   describe 'valid transaction' do

data/spec/app_store/subscription_verification_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe CandyCheck::AppStore::SubscriptionVerification do
+  subject do
+    CandyCheck::AppStore::SubscriptionVerification.new(endpoint, data, secret)
+  end
+  let(:endpoint) { 'https://some.endpoint' }
+  let(:data)     { 'some_data'   }
+  let(:secret)   { 'some_secret' }
+
+  it 'returns a verification failure for status != 0' do
+    with_mocked_response('status' => 21_000) do |client, recorded|
+      result = subject.call!
+      client.receipt_data.must_equal data
+      client.secret.must_equal secret
+
+      recorded.first.must_equal [endpoint]
+
+      result.must_be_instance_of CandyCheck::AppStore::VerificationFailure
+      result.code.must_equal 21_000
+    end
+  end
+
+  it 'returns a verification failure when receipt is missing' do
+    with_mocked_response({}) do |client, recorded|
+      result = subject.call!
+      client.receipt_data.must_equal data
+      client.secret.must_equal secret
+
+      recorded.first.must_equal [endpoint]
+
+      result.must_be_instance_of CandyCheck::AppStore::VerificationFailure
+      result.code.must_equal(-1)
+    end
+  end
+
+  it 'returns a collection of receipt when status is 0 and receipts exists' do
+    response = {
+      'status' => 0,
+      'latest_receipt_info' => [
+        { 'item_id' => 'some_id' },
+        { 'item_id' => 'some_other_id' }
+      ]
+    }
+    with_mocked_response(response) do
+      result = subject.call!
+      result.must_be_instance_of CandyCheck::AppStore::ReceiptCollection
+      result.receipts.must_be_instance_of Array
+      last = result.receipts.last
+      last.must_be_instance_of CandyCheck::AppStore::Receipt
+      last.item_id.must_equal('some_other_id')
+    end
+  end
+
+  private
+
+  DummyClient = Struct.new(:response) do
+    attr_reader :receipt_data, :secret
+
+    def verify(receipt_data, secret)
+      @receipt_data = receipt_data
+      @secret = secret
+      response
+    end
+  end
+
+  def with_mocked_response(response)
+    recorded = []
+    dummy    = DummyClient.new(response)
+    stub     = proc do |*args|
+      recorded << args
+      dummy
+    end
+    CandyCheck::AppStore::Client.stub :new, stub do
+      yield dummy, recorded
+    end
+  end
+end

data/spec/app_store/verification_spec.rb

@@ -43,16 +43,6 @@ describe CandyCheck::AppStore::Verification do
 
   private
 
-  DummyClient = Struct.new(:response) do
-    attr_reader :receipt_data, :secret
-
-    def verify(receipt_data, secret)
-      @receipt_data = receipt_data
-      @secret = secret
-      response
-    end
-  end
-
   def with_mocked_response(response)
     recorded = []
     dummy    = DummyClient.new(response)

data/spec/app_store/verifier_spec.rb

@@ -9,6 +9,7 @@ describe CandyCheck::AppStore::Verifier do
   let(:data)     { 'some_data'   }
   let(:secret)   { 'some_secret' }
   let(:receipt)  { CandyCheck::AppStore::Receipt.new({}) }
+  let(:receipt_collection) { CandyCheck::AppStore::ReceiptCollection.new({}) }
   let(:production_endpoint) do
     'https://buy.itunes.apple.com/verifyReceipt'
   end
@@ -80,6 +81,38 @@ describe CandyCheck::AppStore::Verifier do
     end
   end
 
+  describe 'subscription' do
+    let(:environment) { :production }
+
+    it 'uses production endpoint without retry on success' do
+      with_mocked_verifier(receipt_collection) do
+        subject.verify_subscription(
+          data, secret
+        ).must_be_same_as receipt_collection
+        assert_recorded([production_endpoint, data, secret])
+      end
+    end
+
+    it 'only uses production endpoint for normal failures' do
+      failure = get_failure(21_000)
+      with_mocked_verifier(failure) do
+        subject.verify_subscription(data, secret).must_be_same_as failure
+        assert_recorded([production_endpoint, data, secret])
+      end
+    end
+
+    it 'retries production endpoint for redirect error' do
+      failure = get_failure(21_007)
+      with_mocked_verifier(failure, receipt) do
+        subject.verify_subscription(data, secret).must_be_same_as receipt
+        assert_recorded(
+          [production_endpoint, data, secret],
+          [sandbox_endpoint, data, secret]
+        )
+      end
+    end
+  end
+
   private
 
   def with_mocked_verifier(*results)

data/spec/play_store/client_spec.rb

@@ -64,6 +64,20 @@ describe CandyCheck::PlayStore::Client do
     result['error']['errors'].size.must_equal 1
   end
 
+  it 'returns the products call result\'s data even if it is a failure' \
+    ' when verifying subscription' do
+    bootup!
+
+    mock_subscriptions_request!('products_failure.txt')
+    result = subject.verify_subscription('the_package', 'the_id', 'the_token')
+    result.must_be_instance_of Hash
+
+    result['error']['code'].must_equal 401
+    result['error']['message'].must_equal 'The current user has insufficient' \
+      ' permissions to perform the requested operation.'
+    result['error']['errors'].size.must_equal 1
+  end
+
   it 'returns the products call result\'s data for a successful call' do
     bootup!
     mock_request!('products_success.txt')
@@ -101,4 +115,11 @@ describe CandyCheck::PlayStore::Client do
       'applications/the_package/purchases/products/the_id/tokens/the_token')
       .to_return(fixture_content('play_store', file))
   end
+
+  def mock_subscriptions_request!(file)
+    stub_request(:get, 'https://www.googleapis.com/androidpublisher/v2/' \
+      'applications/the_package/purchases/subscriptions/' \
+      'the_id/tokens/the_token')
+      .to_return(fixture_content('play_store', file))
+  end
 end

data/spec/play_store/subscription_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe CandyCheck::PlayStore::Subscription do
+  subject { CandyCheck::PlayStore::Subscription.new(attributes) }
+
+  describe 'expired and canceled subscription' do
+    let(:attributes) do
+      {
+        'kind' => 'androidpublisher#subscriptionPurchase',
+        'startTimeMillis' => '1459540113244',
+        'expiryTimeMillis' => '1462132088610',
+        'autoRenewing' => false,
+        'developerPayload' => 'payload that gets stored and returned',
+        'cancelReason' => 0,
+        'paymentState' => '1'
+      }
+    end
+
+    it 'is expired?' do
+      subject.expired?.must_be_true
+    end
+
+    it 'is canceled by user' do
+      subject.canceled_by_user?.must_be_true
+    end
+
+    it 'returns the payment_state' do
+      subject.payment_state.must_equal 1
+    end
+
+    it 'considers a payment as valid' do
+      subject.payment_received?.must_be_true
+    end
+
+    it 'checks that auto renewal status is false' do
+      subject.auto_renewing?.must_be_false
+    end
+
+    it 'returns the developer_payload' do
+      subject.developer_payload.must_equal \
+        'payload that gets stored and returned'
+    end
+
+    it 'returns the kind' do
+      subject.kind.must_equal 'androidpublisher#subscriptionPurchase'
+    end
+
+    it 'returns the start_time_millis' do
+      subject.start_time_millis.must_equal 145_954_011_324_4
+    end
+
+    it 'returns the expiry_time_millis' do
+      subject.expiry_time_millis.must_equal 146_213_208_861_0
+    end
+
+    it 'returns the starts_at' do
+      expected = DateTime.new(2016, 4, 1, 19, 48, 33)
+      subject.starts_at.must_equal expected
+    end
+
+    it 'returns the expires_at' do
+      expected = DateTime.new(2016, 5, 1, 19, 48, 8)
+      subject.expires_at.must_equal expected
+    end
+  end
+
+  describe 'unexpired and renewing subscription' do
+    two_days_from_now = DateTime.now + 2
+    let(:attributes) do
+      {
+        'expiryTimeMillis' => (two_days_from_now.to_time.to_i * 1000).to_s,
+        'autoRenewing' => true
+      }
+    end
+
+    it 'is expired?' do
+      subject.expired?.must_be_false
+    end
+
+    it 'is two days left until it is overdue' do
+      subject.overdue_days.must_equal(-2)
+    end
+  end
+
+  describe 'expired due to payment failure' do
+    let(:attributes) do
+      {
+        'expiryTimeMillis' => '1462132088610',
+        'autoRenewing' => true,
+        'cancelReason' => 1
+      }
+    end
+
+    it 'is expired?' do
+      subject.expired?.must_be_true
+    end
+
+    it 'is payment_failed?' do
+      subject.payment_failed?.must_be_true
+    end
+  end
+
+  describe 'expired with pending payment' do
+    let(:attributes) do
+      {
+        'expiryTimeMillis' => '1462132088610',
+        'autoRenewing' => true,
+        'paymentState' => 0
+      }
+    end
+
+    it 'is expired?' do
+      subject.expired?.must_be_true
+    end
+
+    it 'is payment_pending?' do
+      subject.payment_pending?.must_be_true
+    end
+  end
+
+  describe 'trial' do
+    let(:attributes) do
+      {
+        'paymentState' => 1,
+        'priceCurrencyCode' => 'SOMECODE',
+        'priceAmountMicros' => '0'
+      }
+    end
+
+    it 'is trual?' do
+      subject.trial?.must_be_true
+    end
+
+    it 'returns the price_currency_code' do
+      subject.price_currency_code.must_equal 'SOMECODE'
+    end
+  end
+end

data/spec/play_store/subscription_verification_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe CandyCheck::PlayStore::SubscriptionVerification do
+  subject do
+    CandyCheck::PlayStore::SubscriptionVerification.new(
+      client, package, product_id, token
+    )
+  end
+  let(:client)     { DummyGoogleSubsClient.new(response) }
+  let(:package)    { 'the_package' }
+  let(:product_id) { 'the_product' }
+  let(:token)      { 'the_token' }
+
+  describe 'valid' do
+    let(:response) do
+      {
+        'kind' => 'androidpublisher#subscriptionPurchase',
+        'startTimeMillis' => '1459540113244',
+        'expiryTimeMillis' => '1462132088610',
+        'autoRenewing' => false,
+        'developerPayload' => 'payload that gets stored and returned',
+        'cancelReason' => 0,
+        'paymentState' => '1'
+      }
+    end
+
+    it 'calls the client with the correct paramters' do
+      subject.call!
+      client.package.must_equal package
+      client.product_id.must_equal product_id
+      client.token.must_equal token
+    end
+
+    it 'returns a subscription' do
+      result = subject.call!
+      result.must_be_instance_of CandyCheck::PlayStore::Subscription
+      result.expired?.must_be_true
+    end
+  end
+
+  describe 'failure' do
+    let(:response) do
+      {
+        'error' => {
+          'code'    => 401,
+          'message' => 'The current user has insufficient permissions'
+        }
+      }
+    end
+
+    it 'returns a verification failure' do
+      result = subject.call!
+      result.must_be_instance_of CandyCheck::PlayStore::VerificationFailure
+      result.code.must_equal 401
+    end
+  end
+
+  describe 'empty' do
+    let(:response) do
+      {}
+    end
+
+    it 'returns a verification failure' do
+      result = subject.call!
+      result.must_be_instance_of CandyCheck::PlayStore::VerificationFailure
+      result.code.must_equal(-1)
+    end
+  end
+
+  describe 'invalid response kind' do
+    let(:response) do
+      {
+        'kind' => 'something weird'
+      }
+    end
+
+    it 'returns a verification failure' do
+      result = subject.call!
+      result.must_be_instance_of CandyCheck::PlayStore::VerificationFailure
+    end
+  end
+
+  private
+
+  DummyGoogleSubsClient = Struct.new(:response) do
+    attr_reader :package, :product_id, :token
+
+    def boot!
+    end
+
+    def verify_subscription(package, product_id, token)
+      @package = package
+      @product_id = product_id
+      @token = token
+      response
+    end
+  end
+end

data/spec/play_store/verifier_spec.rb

@@ -52,6 +52,22 @@ describe CandyCheck::PlayStore::Verifier do
     end
   end
 
+  it 'uses a subscription verifier when booted' do
+    result = :stubbed
+    with_mocked_client do
+      subject.boot!
+    end
+    with_mocked_verifier(result) do
+      subject.verify_subscription(
+        package, product_id, token
+      ).must_be_same_as result
+
+      assert_recorded(
+        [@client, package, product_id, token]
+      )
+    end
+  end
+
   private
 
   def with_mocked_verifier(*results)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candy_check
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Jonas Thiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.39'
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: minitest-around
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '2.1'
 description: 
 email:
 - jonas@thiel.io
@@ -187,6 +187,8 @@ files:
 - lib/candy_check/app_store/client.rb
 - lib/candy_check/app_store/config.rb
 - lib/candy_check/app_store/receipt.rb
+- lib/candy_check/app_store/receipt_collection.rb
+- lib/candy_check/app_store/subscription_verification.rb
 - lib/candy_check/app_store/verification.rb
 - lib/candy_check/app_store/verification_failure.rb
 - lib/candy_check/app_store/verifier.rb
@@ -203,6 +205,8 @@ files:
 - lib/candy_check/play_store/config.rb
 - lib/candy_check/play_store/discovery_repository.rb
 - lib/candy_check/play_store/receipt.rb
+- lib/candy_check/play_store/subscription.rb
+- lib/candy_check/play_store/subscription_verification.rb
 - lib/candy_check/play_store/verification.rb
 - lib/candy_check/play_store/verification_failure.rb
 - lib/candy_check/play_store/verifier.rb
@@ -212,7 +216,9 @@ files:
 - lib/candy_check/version.rb
 - spec/app_store/client_spec.rb
 - spec/app_store/config_spec.rb
+- spec/app_store/receipt_collection_spec.rb
 - spec/app_store/receipt_spec.rb
+- spec/app_store/subscription_verification_spec.rb
 - spec/app_store/verifcation_failure_spec.rb
 - spec/app_store/verification_spec.rb
 - spec/app_store/verifier_spec.rb
@@ -235,6 +241,8 @@ files:
 - spec/play_store/config_spec.rb
 - spec/play_store/discovery_respository_spec.rb
 - spec/play_store/receipt_spec.rb
+- spec/play_store/subscription_spec.rb
+- spec/play_store/subscription_verification_spec.rb
 - spec/play_store/verification_failure_spec.rb
 - spec/play_store/verification_spec.rb
 - spec/play_store/verifier_spec.rb
@@ -257,19 +265,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Check and verify in-app receipts
 test_files:
 - spec/app_store/client_spec.rb
 - spec/app_store/config_spec.rb
+- spec/app_store/receipt_collection_spec.rb
 - spec/app_store/receipt_spec.rb
+- spec/app_store/subscription_verification_spec.rb
 - spec/app_store/verifcation_failure_spec.rb
 - spec/app_store/verification_spec.rb
 - spec/app_store/verifier_spec.rb
@@ -292,6 +302,8 @@ test_files:
 - spec/play_store/config_spec.rb
 - spec/play_store/discovery_respository_spec.rb
 - spec/play_store/receipt_spec.rb
+- spec/play_store/subscription_spec.rb
+- spec/play_store/subscription_verification_spec.rb
 - spec/play_store/verification_failure_spec.rb
 - spec/play_store/verification_spec.rb
 - spec/play_store/verifier_spec.rb