venice 0.5.0 → 0.6.0

data/lib/venice/client.rb

@@ -95,7 +95,11 @@ module Venice
         raise TimeoutError
       end
 
-      JSON.parse(response.body)
+      begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise InvalidResponseError
+      end
     end
   end
 
@@ -104,4 +108,10 @@ module Venice
       'The App Store timed out.'
     end
   end
+
+  class Client::InvalidResponseError < StandardError
+    def message
+      'The App Store returned invalid response'
+    end
+  end
 end

data/lib/venice/in_app_receipt.rb

@@ -5,6 +5,9 @@ module Venice
     # For detailed explanations on these keys/values, see
     # https://developer.apple.com/library/ios/releasenotes/General/ValidateAppStoreReceipt/Chapters/ReceiptFields.html#//apple_ref/doc/uid/TP40010573-CH106-SW12
 
+    # Original JSON data returned from Apple for an InAppReceipt object.
+    attr_reader :original_json_data
+
     # The number of items purchased. This value corresponds to the quantity property of
     # the SKPayment object stored in the transaction’s payment property.
     attr_reader :quantity
@@ -44,9 +47,18 @@ module Venice
     attr_reader :expires_at
 
     # For a transaction that was canceled by Apple customer support, the time and date of the cancellation.
+    # For an auto-renewable subscription plan that was upgraded, the time and date of the upgrade transaction.
     attr_reader :cancellation_at
 
+    # Only present for auto-renewable subscription receipts. Value is true if the customer’s subscription is
+    # currently in the free trial period, false if not, nil if key is not present on receipt.
+    attr_reader :is_trial_period
+    # Only present for auto-renewable subscription receipts. Value is true if the customer’s subscription is
+    # currently in an introductory price period, false if not, nil if key is not present on receipt.
+    attr_reader :is_in_intro_offer_period
+
     def initialize(attributes = {})
+      @original_json_data = attributes
       @quantity = Integer(attributes['quantity']) if attributes['quantity']
       @product_id = attributes['product_id']
       @transaction_id = attributes['transaction_id']
@@ -54,7 +66,8 @@ module Venice
       @purchased_at = DateTime.parse(attributes['purchase_date']) if attributes['purchase_date']
       @app_item_id = attributes['app_item_id']
       @version_external_identifier = attributes['version_external_identifier']
-      @is_trial_period = attributes['is_trial_period'].to_s == 'true'
+      @is_trial_period = attributes['is_trial_period'].to_s == 'true' if attributes['is_trial_period']
+      @is_in_intro_offer_period = attributes['is_in_intro_offer_period'] == 'true' if attributes['is_in_intro_offer_period']
 
       # expires_date is in ms since the Epoch, Time.at expects seconds
       if attributes['expires_date_ms']
@@ -88,6 +101,7 @@ module Venice
         app_item_id: @app_item_id,
         version_external_identifier: @version_external_identifier,
         is_trial_period: @is_trial_period,
+        is_in_intro_offer_period: @is_in_intro_offer_period,
         expires_at: (@expires_at.httpdate rescue nil),
         cancellation_at: (@cancellation_at.httpdate rescue nil)
       }

data/lib/venice/pending_renewal_info.rb

@@ -1,5 +1,8 @@
 module Venice
   class PendingRenewalInfo
+    # Original JSON data returned from Apple for a PendingRenewalInfo object.
+    attr_reader :original_json_data
+
     # For an expired subscription, the reason for the subscription expiration.
     # This key is only present for a receipt containing an expired auto-renewable subscription.
     attr_reader :expiration_intent
@@ -29,6 +32,7 @@ module Venice
     attr_reader :cancellation_reason
 
     def initialize(attributes)
+      @original_json_data = attributes
       @expiration_intent = Integer(attributes['expiration_intent']) if attributes['expiration_intent']
       @auto_renew_status = Integer(attributes['auto_renew_status']) if attributes['auto_renew_status']
       @auto_renew_product_id = attributes['auto_renew_product_id']

data/lib/venice/receipt.rb

@@ -2,6 +2,8 @@ require 'time'
 
 module Venice
   class Receipt
+    MAX_RE_VERIFY_COUNT = 3
+
     # For detailed explanations on these keys/values, see
     # https://developer.apple.com/library/ios/releasenotes/General/ValidateAppStoreReceipt/Chapters/ReceiptFields.html#//apple_ref/doc/uid/TP40010573-CH106-SW1
 
@@ -29,6 +31,7 @@ module Venice
     attr_reader :download_id
     attr_reader :requested_at
     attr_reader :receipt_created_at
+    attr_reader :expiration_intent
 
     # Original json response from AppStore
     attr_reader :original_json_response
@@ -56,6 +59,7 @@ module Venice
       @download_id = attributes['download_id']
       @requested_at = DateTime.parse(attributes['request_date']) if attributes['request_date']
       @receipt_created_at = DateTime.parse(attributes['receipt_creation_date']) if attributes['receipt_creation_date']
+      @expiration_intent = Integer(original_json_response['expiration_intent']) if original_json_response['expiration_intent']
 
       @in_app = []
       if attributes['in_app']
@@ -105,6 +109,7 @@ module Venice
       def verify!(data, options = {})
         client = Client.production
 
+        retry_count = 0
         begin
           client.verify!(data, options)
         rescue VerificationError => error
@@ -116,8 +121,20 @@ module Venice
             client = Client.production
             retry
           else
+            retry_count += 1
+            if error.retryable? && retry_count <= MAX_RE_VERIFY_COUNT
+              retry
+            end
+
             raise error
           end
+        rescue Net::ReadTimeout, Timeout::Error, OpenSSL::SSL::SSLError,
+               Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE
+          # verifyReceipt is idempotent so we can retry it.
+          # Net::Http has retry logic for some idempotent http methods but it verifyReceipt is POST.
+          retry_count += 1
+          retry if retry_count <= MAX_RE_VERIFY_COUNT
+          raise
         end
       end
 

data/lib/venice/version.rb

@@ -1,3 +1,3 @@
 module Venice
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/fixtures/receipt_expired_cancelled.json

@@ -0,0 +1,56 @@
+{
+  "auto_renew_status": 0,
+  "latest_expired_receipt_info": {
+    "original_purchase_date_pst": "2019-02-09 22:49:48 America/Los_Angeles",
+    "quantity": "1",
+    "unique_vendor_identifier": "88DE8B5A-0B5C-48F6-A014-CBA8A07858BC",
+    "bvrs": "13",
+    "expires_date_formatted": "2019-02-17 06:49:48 Etc/GMT",
+    "is_in_intro_offer_period": "false",
+    "purchase_date_ms": "1549781388000",
+    "expires_date_formatted_pst": "2019-02-16 22:49:48 America/Los_Angeles",
+    "is_trial_period": "true",
+    "item_id": "1450637621",
+    "unique_identifier": "00008020-001624500AF2002E",
+    "original_transaction_id": "140000527258824",
+    "expires_date": "1550386188000",
+    "app_item_id": "1387514950",
+    "transaction_id": "140000527258824",
+    "web_order_line_item_id": "140000151774411",
+    "bid": "com.foo.bar",
+    "product_id": "com.foo.product1",
+    "purchase_date": "2019-02-10 06:49:48 Etc/GMT",
+    "original_purchase_date": "2019-02-10 06:49:48 Etc/GMT",
+    "purchase_date_pst": "2019-02-09 22:49:48 America/Los_Angeles",
+    "original_purchase_date_ms": "1549781388000"
+  },
+  "status": 21006,
+  "auto_renew_product_id": "com.foo.product1",
+  "receipt": {
+    "original_purchase_date_pst": "2019-02-09 22:49:48 America/Los_Angeles",
+    "quantity": "1",
+    "unique_vendor_identifier": "88DE8B5A-0B5C-48F6-A014-CBA8A07858BC",
+    "bvrs": "68",
+    "expires_date_formatted": "2019-02-17 06:49:48 Etc/GMT",
+    "is_in_intro_offer_period": "false",
+    "purchase_date_ms": "1549781388000",
+    "expires_date_formatted_pst": "2019-02-16 22:49:48 America/Los_Angeles",
+    "is_trial_period": "true",
+    "item_id": "1450637621",
+    "unique_identifier": "00008020-001624500AF2002E",
+    "original_transaction_id": "140000527258824",
+    "expires_date": "1550386188000",
+    "app_item_id": "1387514950",
+    "transaction_id": "140000527258824",
+    "web_order_line_item_id": "140000151774411",
+    "version_external_identifier": "827235835",
+    "product_id": "com.foo.product1",
+    "purchase_date": "2019-02-10 06:49:48 Etc/GMT",
+    "original_purchase_date": "2019-02-10 06:49:48 Etc/GMT",
+    "purchase_date_pst": "2019-02-09 22:49:48 America/Los_Angeles",
+    "bid": "com.foo.bar",
+    "original_purchase_date_ms": "1549781388000"
+  },
+  "expiration_intent": "1",
+  "is_in_billing_retry_period": "0"
+}

data/spec/fixtures/receipt_not_expired_cancelled.json

@@ -0,0 +1,51 @@
+{
+  "status": 0,
+  "environment": "Production",
+  "receipt": {
+    "receipt_type": "Production",
+    "adam_id": 7654321,
+    "bundle_id": "com.foo.bar",
+    "application_version": "2",
+    "download_id": 1234567,
+    "receipt_creation_date": "2014-06-04 23:20:47 Etc/GMT",
+    "receipt_creation_date_ms": "1401924047883",
+    "receipt_creation_date_pst": "2014-06-04 16:20:47 America/Los_Angeles",
+    "request_date": "2014-06-04 23:20:47 Etc/GMT",
+    "request_date_ms": "1401924047883",
+    "request_date_pst": "2014-06-04 16:20:47 America/Los_Angeles",
+    "original_purchase_date": "2014-05-17 02:09:45 Etc/GMT",
+    "original_purchase_date_ms": "1400292585000",
+    "original_purchase_date_pst": "2014-05-16 19:09:45 America/Los_Angeles",
+    "original_application_version": "1",
+    "expiration_date": "1401924047883",
+    "in_app": [
+      {
+        "quantity": "1",
+        "product_id": "com.foo.product1",
+        "transaction_id": "1000000070107111",
+        "original_transaction_id": "1000000061051111",
+        "web_order_line_item_id": "1000000026812043",
+        "purchase_date": "2014-05-28 14:47:53 Etc/GMT",
+        "purchase_date_ms": "1401288473000",
+        "purchase_date_pst": "2014-05-28 07:47:53 America/Los_Angeles",
+        "original_purchase_date": "2014-05-28 14:47:53 Etc/GMT",
+        "original_purchase_date_ms": "1401288473000",
+        "original_purchase_date_pst": "2014-05-28 07:47:53 America/Los_Angeles",
+        "expires_date": "2014-06-28 14:47:53 Etc/GMT",
+        "is_trial_period": "false"
+      }
+    ],
+    "original_json_response": {
+      "pending_renewal_info": [
+        {
+          "auto_renew_product_id": "com.foo.product1",
+          "original_transaction_id": "37xxxxxxxxx89",
+          "product_id": "com.foo.product1",
+          "auto_renew_status": "0",
+          "is_in_billing_retry_period": "0",
+          "expiration_intent": "1"
+        }
+      ]
+    }
+  }
+}

data/spec/in_app_receipt_spec.rb

@@ -16,6 +16,7 @@ describe Venice::InAppReceipt do
         'original_purchase_date_ms' => '1401288473000',
         'original_purchase_date_pst' => '2014-05-28 07:47:53 America/Los_Angeles',
         'is_trial_period' => 'false',
+        'is_in_intro_offer_period' => 'true',
         'version_external_identifier' => '123',
         'app_item_id' => 'com.foo.app1',
         'expires_date' => '2014-06-28 07:47:53 America/Los_Angeles',
@@ -35,8 +36,10 @@ describe Venice::InAppReceipt do
     its(:app_item_id) { 'com.foo.app1' }
     its(:version_external_identifier) { '123' }
     its(:is_trial_period) { false }
+    its(:is_in_intro_offer_period) { true }
     its(:original) { should be_instance_of Venice::InAppReceipt }
     its(:expires_at) { should be_instance_of Time }
+    its(:original_json_data) { attributes }
 
     it "should parse the 'original' attributes" do
       subject.original.should be_instance_of Venice::InAppReceipt
@@ -56,6 +59,7 @@ describe Venice::InAppReceipt do
                                          transaction_id: '1000000070107235',
                                          web_order_line_item_id: '1000000026812043',
                                          is_trial_period: false,
+                                         is_in_intro_offer_period: true,
                                          purchase_date: 'Wed, 28 May 2014 14:47:53 GMT',
                                          original_purchase_date: 'Wed, 28 May 2014 14:47:53 GMT')
     end

data/spec/pending_renewal_info_spec.rb

@@ -23,6 +23,7 @@ describe Venice::PendingRenewalInfo do
       expect(subject.auto_renew_product_id).to eql('com.foo.product1')
       expect(subject.is_in_billing_retry_period).to eql(false)
       expect(subject.product_id).to eql('com.foo.product1')
+      expect(subject.original_json_data).to eql(attributes)
     end
 
     it 'outputs attributes in hash' do

data/spec/receipt_spec.rb

@@ -2,59 +2,7 @@ require 'spec_helper'
 
 describe Venice::Receipt do
   describe 'parsing the response' do
-    let(:response) do
-      {
-        'status' => 0,
-        'environment' => 'Production',
-        'receipt' => {
-          'receipt_type' => 'Production',
-          'adam_id' => 7654321,
-          'bundle_id' => 'com.foo.bar',
-          'application_version' => '2',
-          'download_id' => 1234567,
-          'receipt_creation_date' => '2014-06-04 23:20:47 Etc/GMT',
-          'receipt_creation_date_ms' => '1401924047883',
-          'receipt_creation_date_pst' => '2014-06-04 16:20:47 America/Los_Angeles',
-          'request_date' => '2014-06-04 23:20:47 Etc/GMT',
-          'request_date_ms' => '1401924047883',
-          'request_date_pst' => '2014-06-04 16:20:47 America/Los_Angeles',
-          'original_purchase_date' => '2014-05-17 02:09:45 Etc/GMT',
-          'original_purchase_date_ms' => '1400292585000',
-          'original_purchase_date_pst' => '2014-05-16 19:09:45 America/Los_Angeles',
-          'original_application_version' => '1',
-          'expiration_date' => '1401924047883',
-          'in_app' => [
-            {
-              'quantity' => '1',
-              'product_id' => 'com.foo.product1',
-              'transaction_id' => '1000000070107111',
-              'original_transaction_id' => '1000000061051111',
-              'web_order_line_item_id' => '1000000026812043',
-              'purchase_date' => '2014-05-28 14:47:53 Etc/GMT',
-              'purchase_date_ms' => '1401288473000',
-              'purchase_date_pst' => '2014-05-28 07:47:53 America/Los_Angeles',
-              'original_purchase_date' => '2014-05-28 14:47:53 Etc/GMT',
-              'original_purchase_date_ms' => '1401288473000',
-              'original_purchase_date_pst' => '2014-05-28 07:47:53 America/Los_Angeles',
-              'expires_date' => '2014-06-28 14:47:53 Etc/GMT',
-              'is_trial_period' => 'false'
-            }
-          ],
-          'original_json_response' => {
-            'pending_renewal_info' => [
-              {
-                'auto_renew_product_id' => 'com.foo.product1',
-                'original_transaction_id' => '37xxxxxxxxx89',
-                'product_id' => 'com.foo.product1',
-                'auto_renew_status' => '0',
-                'is_in_billing_retry_period' => '0',
-                'expiration_intent' => '1'
-              }
-            ]
-          }
-        }
-      }
-    end
+    let(:response) { JSON.parse(File.read('./spec/fixtures/receipt_not_expired_cancelled.json')) }
 
     subject { Venice::Receipt.new(response['receipt']) }
 
@@ -69,16 +17,119 @@ describe Venice::Receipt do
     its(:adam_id) { 7654321 }
     its(:download_id) { 1234567 }
     its(:requested_at) { should be_instance_of DateTime }
+    its(:expiration_intent) { nil }
+
+    context 'response is for expired cancelled receipt' do
+      let(:response) { JSON.parse(File.read('./spec/fixtures/receipt_expired_cancelled.json')) }
+
+      its(:expiration_intent) { 1 }
+    end
+
+    describe '.verify!' do
+      subject { described_class.verify!('asdf') }
 
-    describe '#verify!' do
       before do
         Venice::Client.any_instance.stub(:json_response_from_verifying_data).and_return(response)
       end
 
-      let(:receipt) { Venice::Receipt.verify('asdf') }
+      it 'creates the receipt' do
+        expect(subject).to be_an_instance_of(Venice::Receipt)
+      end
+
+      describe 'retrying VerificationError' do
+        let(:retryable_error_response) do
+          {
+            'status' => 21000,
+            'receipt' => {},
+            'is_retryable' => true
+          }
+        end
+
+        let(:error_response) do
+          {
+            'status' => 21000,
+            'receipt' => {},
+            'is_retryable' => false
+          }
+        end
+
+        context 'with a retryable error response' do
+          before do
+            Venice::Client.any_instance.stub(:json_response_from_verifying_data).and_return(retryable_error_response, response)
+          end
+
+          it 'creates the receipt' do
+            expect(subject).to be_an_instance_of(Venice::Receipt)
+          end
+        end
+
+        context 'with 4 retryable error responses' do
+          before do
+            Venice::Client.any_instance.stub(:json_response_from_verifying_data).and_return(
+              retryable_error_response,
+              retryable_error_response,
+              retryable_error_response,
+              retryable_error_response,
+              response
+            )
+          end
+
+          it { expect { subject }.to raise_error(Venice::Receipt::VerificationError) }
+        end
+
+        context 'with a not retryable error response' do
+          before do
+            Venice::Client.any_instance.stub(:json_response_from_verifying_data).and_return(error_response, response)
+          end
+
+          it { expect { subject }.to raise_error(Venice::Receipt::VerificationError) }
+        end
+      end
+
+      describe 'retrying http error' do
+        def stub_json_response_from_verifying_data(returns)
+          counter = 0
+          Venice::Client.any_instance.stub(:json_response_from_verifying_data) do
+            begin
+              returns[counter].call
+            ensure
+              counter += 1
+            end
+          end
+        end
+
+        context 'given 3 http errors' do
+          before do
+            returns = [
+              -> { raise(Net::ReadTimeout) },
+              -> { raise(OpenSSL::SSL::SSLError) },
+              -> { raise(Errno::ECONNRESET) },
+              -> { response }
+            ]
+            stub_json_response_from_verifying_data(returns)
+          end
+
+          it 'creates the receipt' do
+            expect(subject).to be_an_instance_of(Venice::Receipt)
+          end
+        end
+
+        context 'given 4 Net::ReadTimeout' do
+          before do
+            returns = [
+              -> { raise(Net::ReadTimeout) },
+              -> { raise(Net::ReadTimeout) },
+              -> { raise(Net::ReadTimeout) },
+              -> { raise(Net::ReadTimeout) },
+              -> { response }
+            ]
+            stub_json_response_from_verifying_data(returns)
+          end
 
-      it 'should create the receipt' do
-        receipt.should_not be_nil
+          it 'raises http error' do
+            expect { subject }.to raise_error(Net::ReadTimeout)
+          end
+        end
       end
     end