[AppStore, Subscription] Add verification returning both receipt and receipt collection

.rubocop.yml

@@ -5,10 +5,12 @@ AllCops:
     - 'vendor/**/*'
 Style/Documentation:
   Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/NumericPredicate:
-  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+   - 'spec/**/*'
+Metrics/LineLength:
+  Exclude:
+   - 'spec/**/*'
 Lint/UnifiedInteger:
   Enabled: false
 Style/PercentLiteralDelimiters:

.travis.yml

@@ -1,3 +1,4 @@
+
 language: ruby
 sudo: false
 cache: bundler

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in candy_check.gemspec

Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'

candy_check.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

lib/candy_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'candy_check/version'
 require 'candy_check/utils'
 require 'candy_check/app_store'

lib/candy_check/app_store.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 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/full_subscription_verification'
+require 'candy_check/app_store/subscription_receipt'
 require 'candy_check/app_store/verification_failure'
 require 'candy_check/app_store/verifier'
 

lib/candy_check/app_store/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'net/http'
 
@@ -7,7 +9,7 @@ module AppStore
     # servers (either sandbox or production).
     class Client
       # Mimetype for JSON objects
-      JSON_MIME_TYPE = 'application/json'.freeze
+      JSON_MIME_TYPE = 'application/json'
 
       # Initialize a new client bound to an endpoint
       # @param endpoint_url [String]

lib/candy_check/app_store/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Configure the verifier

lib/candy_check/app_store/full_subscription_verification.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CandyCheck
+  module AppStore
+    # Verifies a receipt and latest_receipt_info block
+    # The call return either a {SubscriptionReceipt} or a {VerificationFailure}
+    class FullSubscriptionVerification < CandyCheck::AppStore::Verification
+      # Performs the verification against the remote server
+      # @return [SubscriptionReceipt] if successful
+      # @return [VerificationFailure] otherwise
+      def call!
+        verify!
+        return VerificationFailure.fetch(@response['status']) unless valid?
+        subscription_receipt
+      end
+
+      private
+
+      def subscription_receipt
+        receipt = Receipt.new(@response['receipt'])
+        receipt_collection = ReceiptCollection.new(
+          @response['latest_receipt_info']
+        )
+
+        SubscriptionReceipt.new(receipt, receipt_collection)
+      end
+
+      def valid?
+        super && @response['latest_receipt_info']
+      end
+    end
+  end
+end

lib/candy_check/app_store/receipt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Describes a successful response from the AppStore verification server

lib/candy_check/app_store/receipt_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Store multiple {Receipt}s in order to perform collective operation on them

lib/candy_check/app_store/subscription_receipt.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CandyCheck
+  module AppStore
+    # Describes a successful response from the AppStore verification server
+    class SubscriptionReceipt
+      attr_reader :receipt, :receipt_collection
+
+      # Initializes a new instance
+      def initialize(receipt, receipt_collection)
+        @receipt = receipt
+        @receipt_collection = receipt_collection
+      end
+
+      def transactions
+        @receipt_collection.receipts
+      end
+
+      def valid?
+        @receipt.is_a?(CandyCheck::AppStore::Receipt) &&
+          @receipt_collection.is_a?(CandyCheck::AppStore::ReceiptCollection)
+      end
+    end
+  end
+end

lib/candy_check/app_store/subscription_verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Verifies a latest_receipt_info block against a verification server.

lib/candy_check/app_store/verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Verifies a receipt block against a verification server.
@@ -37,8 +39,12 @@ def call!
 
       private
 
+      def response_status_ok?
+        @response['status'] == STATUS_OK
+      end
+
       def valid?
-        @response && @response['status'] == STATUS_OK && @response['receipt']
+        @response && response_status_ok? && @response['receipt']
       end
 
       def verify!

lib/candy_check/app_store/verification_failure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Represents a failing call against the verification server
@@ -64,6 +66,8 @@ def freeze!
       add 21_008, 'This receipt is from the production environment, but it' \
                   ' was sent to the test environment for verification.' \
                   ' Send it to the production environment instead.'
+      add 21_009, 'There was a problem with the (internal) receipt validation' \
+                 ' process. Please try again.'
       freeze!
     end
   end

lib/candy_check/app_store/verifier.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module AppStore
     # Verifies receipts against the verification servers.
     # The call return either an {Receipt} or a {VerificationFailure}
     class Verifier
       # HTTPS endpoint for production receipts
-      PRODUCTION_ENDPOINT = 'https://buy.itunes.apple.com/verifyReceipt'.freeze
+      PRODUCTION_ENDPOINT = 'https://buy.itunes.apple.com/verifyReceipt'
       # HTTPS endpoint for sandbox receipts
-      SANDBOX_ENDPOINT = 'https://sandbox.itunes.apple.com/verifyReceipt'.freeze
+      SANDBOX_ENDPOINT = 'https://sandbox.itunes.apple.com/verifyReceipt'
       # Status code from production endpoint when receiving a sandbox
       # receipt which occurs during the app's review process
       REDIRECT_TO_SANDBOX_CODE = 21_007
@@ -44,6 +46,16 @@ def verify_subscription(receipt_data, secret = nil)
         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 [SubscriptionReceipt] if successful
+      # @return [VerificationFailure] otherwise
+      def verify_subscription_with_full_response(receipt_data, secret = nil)
+        @verifier = FullSubscriptionVerification
+        fetch_receipt_information(receipt_data, secret)
+      end
+
       private
 
       def fetch_receipt_information(receipt_data, secret = nil)

lib/candy_check/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'candy_check/cli/app'
 require 'candy_check/cli/commands'
 require 'candy_check/cli/out'

lib/candy_check/cli/app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module CandyCheck

lib/candy_check/cli/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'candy_check/cli/commands/base'
 require 'candy_check/cli/commands/app_store'
 require 'candy_check/cli/commands/play_store'

lib/candy_check/cli/commands/app_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module CLI
     module Commands

lib/candy_check/cli/commands/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module CLI
     module Commands

lib/candy_check/cli/commands/play_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module CLI
     module Commands

lib/candy_check/cli/commands/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module CLI
     module Commands

lib/candy_check/cli/out.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pp'
 
 module CandyCheck

lib/candy_check/play_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'google/api_client'
 
 require 'candy_check/play_store/discovery_repository'

lib/candy_check/play_store/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # A client which uses the official Google API SDK to authenticate
@@ -15,13 +17,13 @@ class Client
       class DiscoveryError < RuntimeError; end
 
       # API endpoint
-      API_URL      = 'https://accounts.google.com/o/oauth2/token'.freeze
+      API_URL      = 'https://accounts.google.com/o/oauth2/token'
       # API scope for Android services
-      API_SCOPE    = 'https://www.googleapis.com/auth/androidpublisher'.freeze
+      API_SCOPE    = 'https://www.googleapis.com/auth/androidpublisher'
       # API discovery namespace
-      API_DISCOVER = 'androidpublisher'.freeze
+      API_DISCOVER = 'androidpublisher'
       # API version
-      API_VERSION  = 'v2'.freeze
+      API_VERSION  = 'v2'
 
       # Initializes a client using a configuration.
       # @param config [ClientConfig]

lib/candy_check/play_store/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Configure the usage of the official Google API SDK client

lib/candy_check/play_store/discovery_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # A file-based repository to cache a local copy of the Google API

lib/candy_check/play_store/receipt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Describes a successful response from the Google verification server

lib/candy_check/play_store/subscription.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Describes a successfully validated subscription
@@ -25,17 +27,18 @@ def initialize(attributes)
 
       # Check if the expiration date is passed
       # @return [bool]
+      # rubocop:disable Style/NumericPredicate
       def expired?
         overdue_days > 0
       end
+      # rubocop:enable Style/NumericPredicate
 
       # 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?
+        price_amount_micros.zero? && payment_received?
       end
 
       # see if payment is ok

lib/candy_check/play_store/subscription_verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Verifies a purchase token against the Google API

lib/candy_check/play_store/verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Verifies a purchase token against the Google API

lib/candy_check/play_store/verification_failure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Represents a failing call against the Google API server

lib/candy_check/play_store/verifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module PlayStore
     # Verifies purchase tokens against the Google API.

lib/candy_check/utils.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'candy_check/utils/attribute_reader'
 require 'candy_check/utils/config'

lib/candy_check/utils/attribute_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module CandyCheck

lib/candy_check/utils/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CandyCheck
   module Utils
     # Very basic base implementation to store and validate a configuration

lib/candy_check/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module CandyCheck
   # The current gem's version
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'
 end