ios-receipt 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f9cfdea0aef2a3e629ec8e5c7565e4dd4d5a719
+  data.tar.gz: b7e0d4e5a77ea79f2066773ef76b6d73f35559c4
+SHA512:
+  metadata.gz: 5ff3e79e6b1203c1051a88814b31789aad1c76de60005ab45323bd69140ec763ff2720e4a6e044247a8adcc4225a1770d6994849301b25d7a91f2f7fc50f2ebb
+  data.tar.gz: 6a41e5a316dd0646afa0e066af5c4a32697506c7bf159e907c3c3b798cb9f569632c72e924f45d7a3a4177583530ad1b7fa7b3df804f696658276a011e3cb67b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in IosReceipt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Sturgill
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# IosReceipt
+
+ios-receipt is a RubyGem to manage validating and parsing iOS purchase receipts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ios-receipt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ios-receipt
+
+## Usage
+
+result = Ios::Receipt.verify! encoded_receipt, mode, ENV['IOS_SHARED_SECRET']
+mode can be one of :sandbox, :production, or :mixed (try both)
+result.latest returns all receipts
+Each receipt object has fields: :quantity, :product_id, :original_transaction_id, :transaction_id, :original_purchase_date,
+    :purchase_date, :expires_date, :cancellation_date, :app_item_id, :version_external_identifier, 
+        :web_order_line_item_id, :is_trial_period
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ios-receipt.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ios/receipt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ios-receipt"
+  spec.version       = Ios::Receipt::VERSION
+  spec.authors       = ["DailyBurn"]
+  spec.email         = ["dev@dailyburn.com"]
+  spec.description   = %q{Verify iOS receipts server-side}
+  spec.summary       = %q{Verify iOS receipts server-side}
+  spec.homepage      = "https://github.com/DailyBurn/ios-receipt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'rest_client'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/ios/receipt/client.rb

@@ -0,0 +1,51 @@
+class Ios::Receipt::Client
+  ENDPOINTS = {
+    production: 'https://buy.itunes.apple.com/verifyReceipt',
+    sandbox: 'https://sandbox.itunes.apple.com/verifyReceipt'
+  }
+  
+  def initialize(method=nil, secret=nil, ssl_version='TLSv1')
+    method ||= :mixed
+    @method = method
+    @secret = secret
+    @ssl_version = ssl_version
+    
+    raise Ios::Receipt::Exceptions::InvalidConfiguration unless valid_method?
+  end
+  
+  def verify!(receipt)
+    data = { 'receipt-data' => receipt }
+    data['password'] = @secret unless @secret.nil?
+    data = data.to_json
+    
+    response = nil
+    response = post_to_endpoint(:production, data) if try_production?
+    response = post_to_endpoint(:sandbox, data) if response.nil? && try_sandbox?
+    
+    response
+  end
+  
+  protected
+  
+  def try_production?
+    [:mixed, :production].include? @method
+  end
+  
+  def try_sandbox?
+    [:mixed, :sandbox].include? @method
+  end
+  
+  def valid_method?
+    try_production? || try_sandbox?
+  end
+  
+  def post_to_endpoint(env, data)
+    begin
+      response = RestClient::Request.execute method: :post, url: ENDPOINTS[env], payload: data, ssl_version: @ssl_version
+      Ios::Receipt::Result.new JSON.parse(response), env
+    rescue Ios::Receipt::Exceptions::SandboxReceipt => e
+      raise Ios::Receipt::Exceptions::SandboxReceipt unless env == :production && try_sandbox?
+      nil
+    end
+  end
+end

data/lib/ios/receipt/exceptions.rb

@@ -0,0 +1,15 @@
+module Ios
+  module Receipt
+    module Exceptions
+      class Exception < Exception; end
+      class InvalidConfiguration < Ios::Receipt::Exceptions::Exception; end
+      class Json < Ios::Receipt::Exceptions::Exception; end
+      class ReceiptFormat < Ios::Receipt::Exceptions::Exception; end
+      class ReceiptAuthentication < Ios::Receipt::Exceptions::Exception; end
+      class SharedSecret < Ios::Receipt::Exceptions::Exception; end
+      class ServerOffline < Ios::Receipt::Exceptions::Exception; end
+      class SandboxReceipt < Ios::Receipt::Exceptions::Exception; end
+      class ProductionReceipt < Ios::Receipt::Exceptions::Exception; end
+    end
+  end
+end

data/lib/ios/receipt/receipt.rb

@@ -0,0 +1,57 @@
+class Ios::Receipt::Receipt
+  attr_reader :quantity, :product_id, :original_transaction_id, :transaction_id, :original_purchase_date,
+    :purchase_date, :expires_date, :cancellation_date, :app_item_id, :version_external_identifier, 
+    :web_order_line_item_id, :is_trial_period
+
+  def initialize(receipt_hash)
+    @quantity = receipt_hash['quantity']
+    @product_id = receipt_hash['product_id']
+    @original_transaction_id = receipt_hash['original_transaction_id']
+    @transaction_id = receipt_hash['transaction_id']
+    @original_purchase_date = parse_time receipt_hash['original_purchase_date']
+    @purchase_date = parse_time receipt_hash['purchase_date']
+    @expires_date = parse_time receipt_hash['expires_date']
+    @cancellation_date = parse_time receipt_hash['cancellation_date']
+    @app_item_id = receipt_hash['app_item_id']
+    @version_external_identifier = receipt_hash['version_external_identifier']
+    @web_order_line_item_id = receipt_hash['web_order_line_item_id']
+    @is_trial_period = receipt_hash['is_trial_period'] == 'true'
+  end
+
+  def once_off?
+    @expires_date.nil?
+  end
+
+  def recurring?
+    !once_off?
+  end
+
+  def active?
+    !cancelled? && !expired?
+  end
+
+  def expired?
+    return false unless recurring?
+    !!(@expires_date && @expires_date < Time.now)
+  end
+
+  def cancelled?
+    !@cancellation_date.nil?
+  end
+
+  def in_trial?
+    @is_trial_period
+  end
+
+  private
+
+  def parse_time(str)
+    return nil if str.nil? || str == ''
+
+    if !str.match(/^[0-9]+$/).nil? # It's in number format
+      Time.at(str.to_i / 1000)
+    else # They've sent it in string format
+      Time.parse(str.sub('Etc/GMT', 'GMT')) rescue nil
+    end
+  end
+end

data/lib/ios/receipt/result.rb

@@ -0,0 +1,82 @@
+class Ios::Receipt::Result
+  attr_reader :result, :environment, :bundle_id, :application_version, :original_application_version,
+              :in_app, :latest
+
+  def initialize(result, environment=nil)
+    @result = result
+    @status = result['status']
+    check_status!
+    
+    @environment = (result['environment'] || environment).try(:downcase).try(:to_sym)
+    raise Ios::Receipt::Exceptions::InvalidConfiguration if @environment.nil?
+
+    receipt = result['receipt']
+    @bundle_id = receipt['bid'] || receipt['bundle_id']
+    @application_version = receipt['application_version']
+    @original_application_version = receipt['original_application_version']
+
+    if receipt['original_transaction_id'] # ios6 style receipt
+      latest = result['latest_receipt_info'] || result['latest_expired_receipt_info']
+      @latest = if latest
+        [ Ios::Receipt::Receipt.new(latest) ]
+      elsif receipt['original_transaction_id']
+        [ Ios::Receipt::Receipt.new(receipt) ]
+      else
+        []
+      end
+    end
+
+    @in_app = [receipt['in_app'] || []].flatten.compact.collect { |r| Ios::Receipt::Receipt.new r }
+    @latest = [result['latest_receipt_info'] || []].flatten.compact.collect { |r| Ios::Receipt::Receipt.new r } unless @latest
+  end
+
+  def recurring_receipts
+    @recurring ||= @latest.select { |r| r.recurring? }
+  end
+
+  def once_off_receipts
+    @once_offs ||= @latest.select { |r| r.once_off? }
+  end
+  
+  def expired?
+    @status == 21006
+  end
+  
+  def sandbox?
+    @environment == :sandbox
+  end
+  
+  def production?
+    @environment == :production
+  end
+
+  def active_recurring_receipts
+    @active_recurring_receipts ||= recurring_receipts.select { |r| r.active? }
+  end
+
+  def next_recurring_receipt
+    @next_recurring_receipt ||= active_recurring_receipts.sort_by { |r| r.expires_date }.first
+  end
+
+  def in_trial_receipts
+    @in_trial_receipts ||= active_recurring_receipts.select { |r| r.in_trial? }
+  end
+
+  def transaction_ids
+    (@in_app.collect { |r| r.transaction_id } + @latest.collect { |r| r.transaction_id }).flatten.compact.uniq
+  end
+  
+  protected
+  
+  def check_status!
+    case @status
+    when 21000 then raise Ios::Receipt::Exceptions::Json
+    when 21002 then raise Ios::Receipt::Exceptions::ReceiptFormat
+    when 21003 then raise Ios::Receipt::Exceptions::ReceiptAuthentication
+    when 21004 then raise Ios::Receipt::Exceptions::SharedSecret
+    when 21005 then raise Ios::Receipt::Exceptions::ServerOffline
+    when 21007 then raise Ios::Receipt::Exceptions::SandboxReceipt
+    when 21008 then raise Ios::Receipt::Exceptions::ProductionReceipt
+    end
+  end
+end

data/lib/ios/receipt/version.rb

@@ -0,0 +1,5 @@
+module Ios
+  module Receipt
+    VERSION = "0.1.2"
+  end
+end

data/lib/ios/receipt.rb

@@ -0,0 +1,15 @@
+require 'rest_client'
+require 'ios/receipt/version'
+require 'ios/receipt/exceptions'
+require 'ios/receipt/client'
+require 'ios/receipt/result'
+require 'ios/receipt/receipt'
+
+module Ios
+  module Receipt
+    def self.verify!(receipt, method=nil, secret=nil)
+      client = Ios::Receipt::Client.new method, secret
+      client.verify! receipt
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ios-receipt
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- DailyBurn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Verify iOS receipts server-side
+email:
+- dev@dailyburn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ios-receipt.gemspec
+- lib/ios/receipt.rb
+- lib/ios/receipt/client.rb
+- lib/ios/receipt/exceptions.rb
+- lib/ios/receipt/receipt.rb
+- lib/ios/receipt/result.rb
+- lib/ios/receipt/version.rb
+homepage: https://github.com/DailyBurn/ios-receipt
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Verify iOS receipts server-side
+test_files: []