itunes-receipt-mock 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7adc738d9fac2d63cf39275cc7dfe88e9fc793a6
+  data.tar.gz: 778c95fc0e66fe9964a69bdf618056d74d5501fc
+SHA512:
+  metadata.gz: 34cca824abfcfadc5b7f6be8bda9d654381c7f909857c4bcddd5ca2320b1d5f5f05045385c431ae73c8ffe0cfb7a43b3e2d3a5f1f2d288990e820ea722d56f0b
+  data.tar.gz: 15b52051edcd807605abb864d6af519769346feaaf0dcd0b8e70e30e13e8503e47c6853796c8a5b6c090c8b8097717b60a32638a4c94a3c48b8b01ca9d45a615

data/lib/itunes_receipt_mock.rb

@@ -0,0 +1,29 @@
+require 'base64'
+require 'itunes_receipt_mock/mixins'
+require 'itunes_receipt_mock/validation'
+require 'itunes_receipt_mock/receipt'
+require 'itunes_receipt_mock/purchase'
+require 'itunes_receipt_mock/subscription'
+
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  class MissingArgumentError < StandardError; end
+
+  @transaction_id = 1_000_000_000
+
+  ##
+  # Creates a new iTunes receipt
+  #
+  # Returns: rdoc-ref:ItunesReceiptMock::Validation
+  #
+  # Params:
+  # +options+:: rdoc-ref:ItunesReceiptMock
+  def self.new(options = {})
+    Validation.new(options)
+  end
+
+  def self.next_transaction_id
+    @transaction_id += 1
+  end
+end

data/lib/itunes_receipt_mock/mixins.rb

@@ -0,0 +1,18 @@
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  ##
+  # ItunesReceiptMock::Mixins
+  module Mixins
+    private
+
+    def date_attrs(prefix, date)
+      {
+        "#{prefix}_date" => date.utc.strftime('%F %T') + ' Etc/GMT',
+        "#{prefix}_date_ms" => date.utc.strftime('%s%L').to_i,
+        "#{prefix}_date_pst" => date.getlocal('-08:00').strftime('%F %T') +
+          ' America/Los_Angeles'
+      }
+    end
+  end
+end

data/lib/itunes_receipt_mock/purchase.rb

@@ -0,0 +1,39 @@
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  ##
+  # ItunesReceiptMock::Purchase
+  class Purchase
+    include ItunesReceiptMock::Mixins
+
+    attr_accessor :quantity, :product_id, :transaction_id,
+                  :original_transaction_id, :purchase_date,
+                  :original_purchase_date
+
+    def initialize(options = {})
+      @product_id = options.fetch :product_id, nil
+      fail ItunesReceiptMock::MissingArgumentError,
+           'product_id is required' unless @product_id
+      @quantity = options.fetch :quantity, 1
+      @transaction_id =
+        options.fetch :transaction_id,
+                      ItunesReceiptMock.next_transaction_id.to_s
+      @original_transaction_id =
+        options.fetch :original_transaction_id, @transaction_id
+      @purchase_date = options.fetch :purchase_date, Time.now
+      @original_purchase_date =
+        options.fetch :original_purchase_date, @purchase_date
+    end
+
+    def result(_options = {})
+      {
+        'quantity' => quantity,
+        'product_id' => product_id,
+        'transaction_id' => transaction_id,
+        'original_transaction_id' => original_transaction_id
+      }
+        .merge(date_attrs('purchase', purchase_date))
+        .merge(date_attrs('original_purchase', original_purchase_date))
+    end
+  end
+end

data/lib/itunes_receipt_mock/receipt.rb

@@ -0,0 +1,67 @@
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  ##
+  # ItunesReceiptMock::Receipt
+  class Receipt
+    include ItunesReceiptMock::Mixins
+
+    attr_reader :in_app
+    attr_accessor :environment, :adam_id, :app_item_id, :bundle_id,
+                  :application_version, :download_id,
+                  :version_external_identifier, :original_purchase_date,
+                  :original_application_version
+
+    def initialize(options = {})
+      @in_app = {}
+      @bundle_id = options.fetch :bundle_id, nil
+      @environment = options.fetch :environment, 'Production'
+      @adam_id = options.fetch :adam_id, 0
+      @app_item_id = options.fetch :app_item_id, 0
+      @application_version = options.fetch :application_version, '1'
+      @download_id = options.fetch :download_id, 0
+      @version_external_identifier =
+        options.fetch :version_external_identifier, 0
+      @original_purchase_date = options.fetch :original_purchase_date, Time.now
+      @original_application_version =
+        options.fetch :original_application_version, 0
+
+      fail MissingArgumentError, 'bundle_id is required' unless @bundle_id
+    end
+
+    def result(options = {})
+      request_date = options[:request_date] = Time.now
+      {
+        'receipt_type' => environment,
+        'adam_id' => adam_id,
+        'app_item_id' => app_item_id,
+        'bundle_id' => bundle_id,
+        'application_version' => application_version,
+        'download_id' => download_id,
+        'version_external_identifier' => version_external_identifier,
+        'original_application_version' => original_application_version,
+        'in_app' => in_app_result(options)
+      }
+        .merge(date_attrs('request', request_date))
+        .merge(date_attrs('original_purchase', original_purchase_date))
+    end
+
+    def add_purchase(options = {})
+      purchase = Purchase.new(options)
+      @in_app[purchase.transaction_id] = purchase
+      purchase
+    end
+
+    def add_subscription(options = {})
+      purchase = Subscription.new(options)
+      @in_app[purchase.transaction_id] = purchase
+      purchase
+    end
+
+    private
+
+    def in_app_result(options)
+      in_app.map { |_, v| v.result(options) }
+    end
+  end
+end

data/lib/itunes_receipt_mock/subscription.rb

@@ -0,0 +1,27 @@
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  ##
+  # ItunesReceiptMock::Subscription
+  class Subscription < Purchase
+    attr_accessor :expires_date, :web_order_line_item_id, :is_trial_period
+
+    def initialize(options = {})
+      super
+      @expires_date = options.fetch :expires_date, nil
+      @web_order_line_item_id =
+        options.fetch :web_order_line_item_id,
+                      rand(1_000_000_000..9_999_999_999).to_s
+      @is_trial_period = options.fetch :is_trial_period, false
+
+      fail MissingArgumentError, 'expires_date is required' unless @expires_date
+    end
+
+    def result(_options = {})
+      super.merge(
+        'web_order_line_item_id' => web_order_line_item_id,
+        'is_trial_period' => is_trial_period
+      ).merge(date_attrs('expires_date', expires_date))
+    end
+  end
+end

data/lib/itunes_receipt_mock/validation.rb

@@ -0,0 +1,70 @@
+##
+# ItunesReceiptMock
+module ItunesReceiptMock
+  ##
+  # ItunesReceiptMock::Validation
+  class Validation
+    include ItunesReceiptMock::Mixins
+
+    STATUS_CODES = [0, 21_000] + (21_002..21_008).to_a
+
+    attr_reader :receipt, :latest_receipt_info
+
+    def initialize(options = {})
+      @latest_receipt_info = {}
+      @receipt = Receipt.new(options)
+    end
+
+    def result(options = {})
+      status = options.fetch(:status, 0)
+      result = { 'status' => status }
+      if status == 0
+        result.merge!(
+          'status' => status,
+          'environment' => receipt.environment,
+          'receipt' => receipt.result(options),
+          'latest_receipt_info' => latest_receipt_info_result(options)
+        )
+        result.merge!(
+          'latest_receipt' => Base64.strict_encode64(result.to_json)
+        )
+      end
+      result
+    end
+
+    def add_purchase(options = {})
+      purchase = receipt.add_purchase(options)
+      @latest_receipt_info[purchase.transaction_id] = purchase
+      purchase
+    end
+
+    def add_subscription(options = {})
+      purchase = receipt.add_subscription(options)
+      @latest_receipt_info[purchase.transaction_id] = purchase
+      purchase
+    end
+
+    def renew_subscription(purchase, options = {})
+      expires_date = options.fetch(:expires_date, nil)
+      fail MissingArgumentError, 'expires_date is required' unless expires_date
+
+      attrs = {
+        quantity: purchase.quantity,
+        product_id: purchase.product_id,
+        original_transaction_id: purchase.original_transaction_id,
+        original_purchase_date: purchase.original_purchase_date,
+        web_order_line_item_id: purchase.web_order_line_item_id,
+        is_trial_period: purchase.is_trial_period
+      }.merge(expires_date: expires_date).merge(options)
+
+      receipt.in_app.delete(purchase.original_transaction_id)
+      add_subscription(attrs)
+    end
+
+    private
+
+    def latest_receipt_info_result(options)
+      latest_receipt_info.map { |_, v| v.result(options) }
+    end
+  end
+end

data/lib/itunes_receipt_mock/version.rb

@@ -0,0 +1,5 @@
+##
+# ItunesReceiptMock::VERSION
+module ItunesReceiptMock
+  VERSION = '0.0.4'
+end

data/spec/module_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe ItunesReceiptMock do
+  describe '.new' do
+    subject { described_class.new(options) }
+
+    context 'with minimal options' do
+      let(:options) { { bundle_id: 'foobar' } }
+
+      it 'creates an instance of Validation' do
+        expect(subject).to be_a(described_class::Validation)
+      end
+    end
+
+    context 'when bundle_id is not present' do
+      let(:options) { {} }
+
+      it 'raises an MissingArgumentError' do
+        expect { subject }.to raise_error(
+          described_class::MissingArgumentError,
+          'bundle_id is required'
+        )
+      end
+    end
+  end
+
+  describe 'full integration' do
+    let(:validation) { described_class.new(bundle_id: 'com.example') }
+    let!(:purchase) { validation.add_purchase(product_id: 'foobar') }
+    let!(:subscription) do
+      validation.add_subscription product_id: 'premium',
+                                  purchase_date: 1.month.ago,
+                                  expires_date: Time.now
+    end
+
+    subject { validation.result }
+
+    it 'contains the purchases in the receipt.in_app object' do
+      expect(validation.receipt.in_app.length).to eq(2)
+    end
+
+    it 'contains the purchases in the latest_receipt_info object' do
+      expect(validation.latest_receipt_info.length).to eq(2)
+    end
+
+    context 'renewing the subscription' do
+      let!(:renewal) do
+        validation.renew_subscription subscription,
+                                      expires_date: 1.month.from_now
+      end
+
+      it 'contains two subscription transactions in latest_receipt_info' do
+        expect(validation.latest_receipt_info.length).to eq(3)
+      end
+    end
+  end
+end

data/spec/receipt_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe ItunesReceiptMock::Receipt do
+  before do
+    Timecop.freeze
+  end
+
+  after do
+    Timecop.return
+  end
+
+  describe '.new' do
+    subject { described_class.new(options) }
+
+    context 'with minimal options' do
+      let(:options) { { bundle_id: 'foobar' } }
+
+      it 'sets "bundle_id" to the option value' do
+        expect(subject.bundle_id).to eq(options[:bundle_id])
+      end
+
+      it 'defaults everything else' do
+        expect(subject.environment).to eq('Production')
+        expect(subject.adam_id).to eq(0)
+        expect(subject.app_item_id).to eq(0)
+        expect(subject.application_version).to eq('1')
+        expect(subject.download_id).to eq(0)
+        expect(subject.version_external_identifier).to eq(0)
+        expect(subject.original_purchase_date).to eq(Time.now)
+      end
+    end
+
+    context 'when options are complete' do
+      let(:options) do
+        {
+          bundle_id: 'foobar',
+          environment: 'Sandbox',
+          adam_id: rand(1..5),
+          app_item_id: rand(1..5),
+          application_version: rand(1..5).to_s,
+          download_id: rand(1..5),
+          version_external_identifier: rand(1..5),
+          original_purchase_date: Time.new(2015, 06, 20, 8, 16, 32)
+        }
+      end
+
+      it 'sets all the things' do
+        expect(subject.environment).to eq(options[:environment])
+        expect(subject.adam_id).to eq(options[:adam_id])
+        expect(subject.app_item_id).to eq(options[:app_item_id])
+        expect(subject.application_version).to eq(options[:application_version])
+        expect(subject.download_id).to eq(options[:download_id])
+        expect(subject.version_external_identifier).to eq(
+          options[:version_external_identifier]
+        )
+        expect(subject.original_purchase_date).to eq(
+          options[:original_purchase_date]
+        )
+      end
+    end
+  end
+
+  describe '#add_purchase' do
+    let(:receipt) { described_class.new(bundle_id: 'foobar') }
+
+    subject { receipt.add_purchase(options) }
+
+    context 'with minimal options' do
+      let(:options) { { product_id: 'whatever' } }
+
+      it 'creates an instance of Purchase' do
+        expect(subject).to be_a(ItunesReceiptMock::Purchase)
+      end
+
+      it 'adds the purchase to the #in_app object' do
+        expect(receipt.in_app[subject.transaction_id]).to eq(subject)
+      end
+    end
+
+    context 'when product_id is not present' do
+      let(:options) { {} }
+
+      it 'raises an MissingArgumentError' do
+        expect { subject }.to raise_error(
+          ItunesReceiptMock::MissingArgumentError,
+          'product_id is required'
+        )
+      end
+    end
+  end
+
+  describe '#add_subscription' do
+    let(:receipt) { described_class.new(bundle_id: 'foobar') }
+
+    subject { receipt.add_subscription(options) }
+
+    context 'with minimal options' do
+      let(:options) do
+        {
+          product_id: 'whatever',
+          expires_date: 1.month.from_now
+        }
+      end
+
+      it 'creates an instance of Subscription' do
+        expect(subject).to be_a(ItunesReceiptMock::Subscription)
+      end
+
+      it 'adds the subscription to the #in_app object' do
+        expect(receipt.in_app[subject.transaction_id]).to eq(subject)
+      end
+    end
+
+    context 'when expires_date is not present' do
+      let(:options) { { product_id: 'whatever' } }
+
+      it 'raises an MissingArgumentError' do
+        expect { subject }.to raise_error(
+          ItunesReceiptMock::MissingArgumentError,
+          'expires_date is required'
+        )
+      end
+    end
+  end
+
+  describe '#result' do
+    let(:receipt) { described_class.new(bundle_id: 'foobar') }
+    let(:options) { {} }
+
+    subject { receipt.result(options) }
+
+    it 'returns everything' do
+      expect(subject['receipt_type']).to eq(receipt.environment)
+      expect(subject['adam_id']).to eq(receipt.adam_id)
+      expect(subject['app_item_id']).to eq(receipt.app_item_id)
+      expect(subject['bundle_id']).to eq(receipt.bundle_id)
+      expect(subject['application_version']).to eq(receipt.application_version)
+      expect(subject['download_id']).to eq(receipt.download_id)
+      expect(subject['version_external_identifier']).to eq(
+        receipt.version_external_identifier
+      )
+      expect(subject['original_application_version']).to eq(
+        receipt.original_application_version
+      )
+      expect(subject['in_app']).to be_a(Array)
+      expect(subject['request_date']).to eq(
+        Time.now.utc.strftime('%F %T') + ' Etc/GMT'
+      )
+      expect(subject['original_purchase_date']).to eq(
+        receipt.original_purchase_date.utc.strftime('%F %T') + ' Etc/GMT'
+      )
+    end
+
+    context 'when "request_date" is in options' do
+      let(:options) { { request_date: rand(1..5).hours.ago } }
+
+      it 'returns the request_date as specified' do
+        expect(subject['request_date']).to eq(
+          options[:request_date].utc.strftime('%F %T') + ' Etc/GMT'
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'active_support/all'
+require 'timecop'
+require 'itunes_receipt_mock'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/validation_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe ItunesReceiptMock::Validation do
+  describe '.new' do
+    let(:options) { { bundle_id: 'foobar' } }
+
+    subject { described_class.new(options) }
+
+    it 'creates an instance of Receipt' do
+      expect(subject.receipt).to be_a(ItunesReceiptMock::Receipt)
+    end
+  end
+
+  describe '#result' do
+    let(:validation) { described_class.new(bundle_id: 'foobar') }
+
+    subject { validation.result(options) }
+
+    context 'when status is 0' do
+      let(:options) { { status: 0 } }
+
+      it 'returns everything' do
+        expect(subject['status']).to eq(0)
+        expect(subject['environment']).to_not be_nil
+        expect(subject['receipt']).to_not be_nil
+      end
+    end
+
+    context 'when status is not 0' do
+      let(:options) { { status: 1 } }
+
+      it 'returns just the status' do
+        expect(subject).to eq('status' => options[:status])
+      end
+    end
+  end
+
+  describe '#add_purchase' do
+    let(:validation) { described_class.new(bundle_id: 'foobar') }
+
+    subject { validation.add_purchase(product_id: 'foobar') }
+
+    it 'adds the purchase to the #latest_receipt_info object' do
+      expect(validation.latest_receipt_info[subject.transaction_id])
+        .to eq(subject)
+    end
+  end
+
+  describe '#add_subscription' do
+    let(:validation) { described_class.new(bundle_id: 'foobar') }
+
+    subject do
+      validation.add_subscription product_id: 'foobar',
+                                  expires_date: 1.month.from_now
+    end
+
+    it 'adds the subscription to the #latest_receipt_info object' do
+      expect(validation.latest_receipt_info[subject.transaction_id])
+        .to eq(subject)
+    end
+  end
+
+  describe '#renew_subscription' do
+    let(:validation) { described_class.new(bundle_id: 'foobar') }
+    let(:subscription) do
+      validation.add_subscription product_id: 'foobar',
+                                  purchase_date: 1.month.ago,
+                                  expires_date: Time.now
+    end
+
+    subject do
+      validation.renew_subscription subscription,
+                                    expires_date: 1.month.from_now
+    end
+
+    it 'removes the old transaction from #receipt#in_app' do
+      expect(validation.receipt.in_app[subscription.transaction_id])
+        .to eq(subscription)
+      subject
+      expect(validation.receipt.in_app[subscription.transaction_id])
+        .to be_nil
+    end
+
+    it 'adds the new transaction to #receipt#in_app' do
+      expect(validation.receipt.in_app[subject.transaction_id]).to eq(subject)
+    end
+
+    it 'adds the new tranaction to #latest_receipt_info' do
+      expect(validation.latest_receipt_info[subject.transaction_id])
+        .to eq(subject)
+    end
+
+    it 'preserves both transactions in #latest_receipt_info' do
+      subject
+      expect(validation.latest_receipt_info.values)
+        .to match_array([subscription, subject])
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: itunes-receipt-mock
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- mbaasy.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+description: Mock iTunes receipt validation responses for testing
+email: hello@mbaasy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itunes_receipt_mock.rb
+- lib/itunes_receipt_mock/mixins.rb
+- lib/itunes_receipt_mock/purchase.rb
+- lib/itunes_receipt_mock/receipt.rb
+- lib/itunes_receipt_mock/subscription.rb
+- lib/itunes_receipt_mock/validation.rb
+- lib/itunes_receipt_mock/version.rb
+- spec/module_spec.rb
+- spec/receipt_spec.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb
+homepage: https://github.com/mbaasy/itunes-receipt-mock-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Mock iTunes Connect receipts
+test_files: []
+has_rdoc: