folked-venice 0.5.0.1

data/lib/venice/pending_renewal_info.rb

@@ -0,0 +1,68 @@
+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
+
+    # The current renewal status for the auto-renewable subscription.
+    # This key is only present for auto-renewable subscription receipts, for active or expired subscriptions
+    attr_reader :auto_renew_status
+
+    # The current renewal preference for the auto-renewable subscription.
+    # The value for this key corresponds to the productIdentifier property of the product that the customer’s subscription renews.
+    attr_reader :auto_renew_product_id
+
+    # For an expired subscription, whether or not Apple is still attempting to automatically renew the subscription.
+    # If the customer’s subscription failed to renew because the App Store was unable to complete the transaction, this value will reflect whether or not the App Store is still trying to renew the subscription.
+    attr_reader :is_in_billing_retry_period
+
+    # The product identifier of the item that was purchased.
+    # This value corresponds to the productIdentifier property of the SKPayment object stored in the transaction’s payment property.
+    attr_reader :product_id
+
+    # The current price consent status for a subscription price increase
+    # This key is only present for auto-renewable subscription receipts if the subscription price was increased without keeping the existing price for active subscribers
+    attr_reader :price_consent_status
+
+    # For a transaction that was cancelled, the reason for cancellation.
+    # Use this value along with the cancellation date to identify possible issues in your app that may lead customers to contact Apple customer support.
+    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']
+
+      if attributes['is_in_billing_retry_period']
+        @is_in_billing_retry_period = (attributes['is_in_billing_retry_period'] == '1')
+      end
+
+      @product_id = attributes['product_id']
+
+      @price_consent_status = Integer(attributes['price_consent_status']) if attributes['price_consent_status']
+      @cancellation_reason = Integer(attributes['cancellation_reason']) if attributes['cancellation_reason']
+    end
+
+    def to_hash
+      {
+        expiration_intent: @expiration_intent,
+        auto_renew_status: @auto_renew_status,
+        auto_renew_product_id: @auto_renew_product_id,
+        is_in_billing_retry_period: @is_in_billing_retry_period,
+        product_id: @product_id,
+        price_consent_status: @price_consent_status,
+        cancellation_reason: @cancellation_reason
+      }
+    end
+
+    alias_method :to_h, :to_hash
+
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/venice/receipt.rb

@@ -0,0 +1,186 @@
+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
+
+    # The app’s bundle identifier.
+    attr_reader :bundle_id
+
+    # The app’s version number.
+    attr_reader :application_version
+
+    # The receipt for an in-app purchase.
+    attr_reader :in_app
+
+    # The version of the app that was originally purchased.
+    attr_reader :original_application_version
+
+    # The original purchase date
+    attr_reader :original_purchase_date
+
+    # The date that the app receipt expires.
+    attr_reader :expires_at
+
+    # Non-Documented receipt keys/values
+    attr_reader :receipt_type
+    attr_reader :adam_id
+    attr_reader :download_id
+    attr_reader :requested_at
+    attr_reader :receipt_created_at
+
+    # Original json response from AppStore
+    attr_reader :original_json_response
+
+    attr_accessor :latest_receipt_info
+
+    # Information about the status of the customer's auto-renewable subscriptions
+    attr_reader :pending_renewal_info
+
+    def initialize(attributes = {})
+      @original_json_response = attributes['original_json_response']
+
+      @bundle_id = attributes['bundle_id']
+      @application_version = attributes['application_version']
+      @original_application_version = attributes['original_application_version']
+      if attributes['original_purchase_date']
+        @original_purchase_date = DateTime.parse(attributes['original_purchase_date'])
+      end
+      if attributes['expiration_date']
+        @expires_at = Time.at(attributes['expiration_date'].to_i / 1000).to_datetime
+      end
+
+      @receipt_type = attributes['receipt_type']
+      @adam_id = attributes['adam_id']
+      @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']
+
+      @in_app = []
+      if attributes['in_app']
+        attributes['in_app'].each do |in_app_purchase_attributes|
+          @in_app << InAppReceipt.new(in_app_purchase_attributes)
+        end
+      end
+
+      @pending_renewal_info = []
+      if original_json_response && original_json_response['pending_renewal_info']
+        original_json_response['pending_renewal_info'].each do |pending_renewal_attributes|
+          @pending_renewal_info << PendingRenewalInfo.new(pending_renewal_attributes)
+        end
+      end
+    end
+
+    def to_hash
+      {
+        bundle_id: @bundle_id,
+        application_version: @application_version,
+        original_application_version: @original_application_version,
+        original_purchase_date: (@original_purchase_date.httpdate rescue nil),
+        expires_at: (@expires_at.httpdate rescue nil),
+        receipt_type: @receipt_type,
+        adam_id: @adam_id,
+        download_id: @download_id,
+        requested_at: (@requested_at.httpdate rescue nil),
+        receipt_created_at: (@receipt_created_at.httpdate rescue nil),
+        in_app: @in_app.map(&:to_h),
+        pending_renewal_info: @pending_renewal_info.map(&:to_h),
+        latest_receipt_info: @latest_receipt_info
+      }
+    end
+    alias_method :to_h, :to_hash
+
+    def to_json
+      to_hash.to_json
+    end
+
+    class << self
+      def verify(data, options = {})
+        verify!(data, options)
+      rescue VerificationError, Client::TimeoutError
+        false
+      end
+
+      def verify!(data, options = {})
+        client = Client.production
+
+        retry_count = 0
+        begin
+          client.verify!(data, options)
+        rescue VerificationError => error
+          case error.code
+          when 21007
+            client = Client.development
+            retry
+          when 21008
+            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
+
+      alias :validate :verify
+      alias :validate! :verify!
+    end
+
+    class VerificationError < StandardError
+      attr_accessor :json
+
+      def initialize(json)
+        @json = json
+      end
+
+      def code
+        Integer(json['status'])
+      end
+
+      def retryable?
+        json['is_retryable']
+      end
+
+      def message
+        case code
+        when 21000
+          'The App Store could not read the JSON object you provided.'
+        when 21002
+          'The data in the receipt-data property was malformed.'
+        when 21003
+          'The receipt could not be authenticated.'
+        when 21004
+          'The shared secret you provided does not match the shared secret on file for your account.'
+        when 21005
+          'The receipt server is not currently available.'
+        when 21006
+          'This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response.'
+        when 21007
+          'This receipt is a sandbox receipt, but it was sent to the production service for verification.'
+        when 21008
+          'This receipt is a production receipt, but it was sent to the sandbox service for verification.'
+        when 21010
+          'This receipt could not be authorized. Treat this the same as if a purchase was never made.'
+        when 21100..21199
+          'Internal data access error.'
+        else
+          "Unknown Error: #{code}"
+        end
+      end
+    end
+  end
+end

data/lib/venice/version.rb

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

data/spec/client_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe Venice::Client do
+  let(:receipt_data) { 'asdfzxcvjklqwer' }
+  let(:client) { subject }
+
+  describe '#verify!' do
+    context 'with a receipt response' do
+      before do
+        client.stub(:json_response_from_verifying_data).and_return(response)
+      end
+
+      let(:response) do
+        {
+          'status' => 0,
+          'receipt' => {}
+        }
+      end
+
+      it 'does not generate a self-referencing Hash' do
+        receipt = client.verify! 'asdf'
+        expect(receipt.original_json_response['receipt']).not_to have_key('original_json_response')
+      end
+    end
+
+    context 'no shared_secret' do
+      before do
+        client.shared_secret = nil
+        Venice::Receipt.stub :new
+      end
+
+      it 'should only include the receipt_data' do
+        Net::HTTP.any_instance.should_receive(:request) do |post|
+          post.body.should eq({ 'receipt-data' => receipt_data }.to_json)
+          post
+        end
+        client.verify! receipt_data
+      end
+    end
+
+    context 'with a shared secret' do
+      let(:secret) { 'shhhhhh' }
+
+      before do
+        Venice::Receipt.stub :new
+      end
+
+      context 'set secret manually' do
+        before do
+          client.shared_secret = secret
+        end
+
+        it 'should include the secret in the post' do
+          Net::HTTP.any_instance.should_receive(:request) do |post|
+            post.body.should eq({ 'receipt-data' => receipt_data, 'password' => secret }.to_json)
+            post
+          end
+          client.verify! receipt_data
+        end
+      end
+
+      context 'set secret when verification' do
+        let(:options) { { shared_secret: secret } }
+
+        it 'should include the secret in the post' do
+          Net::HTTP.any_instance.should_receive(:request) do |post|
+            post.body.should eq({ 'receipt-data' => receipt_data, 'password' => secret }.to_json)
+            post
+          end
+          client.verify! receipt_data, options
+        end
+      end
+    end
+
+    context 'with a latest receipt info attribute' do
+      let(:response) do
+        {
+          'status' => 0,
+          'receipt' => {},
+          'latest_receipt' => '<encoded string>',
+          'latest_receipt_info' =>  [
+            {
+              'original_purchase_date_pst' => '2012-12-30 09:39:24 America/Los_Angeles',
+              'unique_identifier' => '0000b01147b8',
+              'original_transaction_id' => '1000000061051565',
+              'expires_date' => '1365114731000',
+              'transaction_id' => '1000000070104252',
+              'quantity' => '1',
+              'product_id' => 'com.ficklebits.nsscreencast.monthly_sub',
+              'original_purchase_date_ms' => '1356889164000',
+              'bid' => 'com.ficklebits.nsscreencast',
+              'web_order_line_item_id' => '1000000026812043',
+              'bvrs' => '0.1',
+              'expires_date_formatted' => '2013-04-04 22:32:11 Etc/GMT',
+              'purchase_date' => '2013-04-04 22:27:11 Etc/GMT',
+              'purchase_date_ms' => '1365114431000',
+              'expires_date_formatted_pst' => '2013-04-04 15:32:11 America/Los_Angeles',
+              'purchase_date_pst' => '2013-04-04 15:27:11 America/Los_Angeles',
+              'original_purchase_date' => '2012-12-30 17:39:24 Etc/GMT',
+              'item_id' => '590265423'
+            }
+          ]
+        }
+      end
+
+      it 'should create a latest receipt' do
+        client.stub(:json_response_from_verifying_data).and_return(response)
+        receipt = client.verify! 'asdf'
+        receipt.latest_receipt_info.should_not be_nil
+        receipt.latest_receipt_info.first.product_id.should eq 'com.ficklebits.nsscreencast.monthly_sub'
+      end
+
+      context 'when latest_receipt_info is a hash instead of an array' do
+        it 'should still create a latest receipt' do
+          response['latest_receipt_info'] = response['latest_receipt_info'].first
+          client.stub(:json_response_from_verifying_data).and_return(response)
+          receipt = client.verify! 'asdf'
+          receipt.latest_receipt_info.should_not be_nil
+          receipt.latest_receipt_info.first.product_id.should eq 'com.ficklebits.nsscreencast.monthly_sub'
+        end
+      end
+    end
+
+    context 'with an error response' do
+      before do
+        client.stub(:json_response_from_verifying_data).and_return(response)
+      end
+
+      let(:response) do
+        {
+          'status' => 21000,
+          'receipt' => {}
+        }
+      end
+
+      it 'raises a VerificationError' do
+        expect do
+          client.verify!('asdf')
+        end.to raise_error(Venice::Receipt::VerificationError) do |error|
+          expect(error.json).to eq(response)
+          expect(error.code).to eq(21000)
+          expect(error).not_to be_retryable
+        end
+      end
+    end
+
+    context 'with a retryable error response' do
+      before do
+        client.stub(:json_response_from_verifying_data).and_return(response)
+      end
+
+      let(:response) do
+        {
+          'status' => 21000,
+          'receipt' => {},
+          'is_retryable' => true
+        }
+      end
+
+      it 'raises a VerificationError' do
+        expect do
+          client.verify!('asdf')
+        end.to raise_error(Venice::Receipt::VerificationError) do |error|
+          expect(error).to be_retryable
+        end
+      end
+    end
+  end
+end

data/spec/in_app_receipt_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper.rb'
+
+describe Venice::InAppReceipt do
+  describe '.new' do
+    let :attributes do
+      {
+        'quantity' => 1,
+        'product_id' => 'com.foo.product1',
+        'transaction_id' => '1000000070107235',
+        '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_transaction_id' => '140xxx867509',
+        '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',
+        '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',
+        'expires_date_ms' => '1403941673000'
+      }
+    end
+
+    subject(:in_app_receipt) do
+      Venice::InAppReceipt.new attributes
+    end
+
+    its(:quantity) { 1 }
+    its(:product_id) { 'com.foo.product1' }
+    its(:transaction_id) { '1000000070107235' }
+    its(:web_order_line_item_id) { '1000000026812043' }
+    its(:purchased_at) { should be_instance_of DateTime }
+    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
+      subject.original.transaction_id.should == '140xxx867509'
+      subject.original.purchased_at.should be_instance_of DateTime
+    end
+
+    it 'should parse expires_date when expires_date_ms is missing and expires_date is the ms epoch' do
+      attributes.delete('expires_date_ms')
+      attributes['expires_date'] = '1403941685000'
+      in_app_receipt.expires_at.should eq Time.at(1403941685000 / 1000)
+    end
+
+    it 'should output a hash with attributes' do
+      in_app_receipt.to_h.should include(quantity: 1,
+                                         product_id: 'com.foo.product1',
+                                         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
+  end
+end