itunes_receipt_decoder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3af07c85acedd565c74e51d29053205b49134fd4
-  data.tar.gz: 5da51cb846cacc7a182f4938147835744ce2149d
+  metadata.gz: de043b4c77b3fbaac346b799f365f057b321c3fb
+  data.tar.gz: 1d15e3c79f6d797db3ff2fdf3b1c95d1599b5e67
 SHA512:
-  metadata.gz: bc3acb82230669e4633a443ecec9c4c6115879c205f3c790d282360fa7734a31606730d5d0241b29be8a017f68fa9b46efed58d56af001c726cd35ba16b410cd
-  data.tar.gz: 665a657a448c447a1c22e03a8a9a1049ca9cffc55db5f2dccaf32e67a130863d60bb7adee2334dbf2e42a850102e914bc05e63dda6a7584dc6198a818fc0d7bf
+  metadata.gz: 5acfe178ab3c36e0697ed3cf466551c94eb726413ccc2806cd7b40ec3177a9b394895eb0f4850051f3735c7a419d83338a082f16f3ca4aaeedc778f10bb87456
+  data.tar.gz: 8a534a10ce32f203b7c450b02c7d60747880632abebc2765d064bc0fe85014c1a243dde361b9e74c497fc4aff2ec3718e472286050895c35798b54fcef668eca

data/lib/itunes_receipt_decoder.rb

@@ -1,3 +1,4 @@
+require 'time'
 require 'base64'
 require 'openssl'
 require 'cfpropertylist'
@@ -10,12 +11,19 @@ require 'itunes_receipt_decoder/decode/unified_receipt'
 ##
 # ItunesReceiptDecoder
 module ItunesReceiptDecoder
-  def self.new(receipt_data)
+  ##
+  # Initializes either ItunesReceiptDecoder::Decode::Transaction or
+  # ItunesReceiptDecoder::Decode::Unified with the base64 encoded receipt
+  # ==== Arguments
+  #
+  # * +receipt_data+ - the base64 encoded receipt
+  # * +options+ - optional arguments
+  def self.new(receipt_data, options = {})
     raw_receipt = Base64.strict_decode64(receipt_data)
     if /^\{*+\}$/ =~ raw_receipt
-      Decode::TransactionReceipt.new(raw_receipt)
+      Decode::TransactionReceipt.new(raw_receipt, options)
     else
-      Decode::UnifiedReceipt.new(raw_receipt)
+      Decode::UnifiedReceipt.new(raw_receipt, options)
     end
   end
 end

data/lib/itunes_receipt_decoder/config.rb

@@ -5,15 +5,21 @@ module ItunesReceiptDecoder
   # ItunesReceiptDecoder::Config
   class Config
     class << self
+      ##
+      # Set this to the path of the AppleIncRootCertificate.cer file
       attr_accessor :certificate_path
     end
 
+    ##
+    # Returns the OpenSSL X509 Store for the certificate
     def self.certificate_store
       return @certificate_store if @certificate_store
       @certificate_store = OpenSSL::X509::Store.new
       @certificate_store.add_cert(certificate)
     end
 
+    ##
+    # returns the OpenSSL X509 Certificate
     def self.certificate
       @certificate ||= OpenSSL::X509::Certificate.new(
         File.read(certificate_path)

data/lib/itunes_receipt_decoder/decode/base.rb

@@ -7,20 +7,35 @@ module ItunesReceiptDecoder
     ##
     # ItunesReceiptDecoder::Decode::Base
     class Base
-      attr_reader :raw_receipt
+      ##
+      # The raw receipt, i.e. not base64 encoded
+      attr_reader :raw_receipt, :options
 
-      def initialize(raw_receipt)
+      ##
+      # Initializes with a raw (base64 decoded receipt)
+      #
+      # ==== Arguments
+      #
+      # * +raw_receipt+ - the raw receipt, i.e. not base64 encoded
+      def initialize(raw_receipt, options = {})
         @raw_receipt = raw_receipt
+        @options = options
       end
 
+      ##
+      # Returns the receipt receipt properties
       def receipt
         decode && @receipt
       end
 
+      ##
+      # Returns true if the receipt is created in the Production environment
       def production?
         environment == 'Production'
       end
 
+      ##
+      # Returns true if the receipt is +not+ created in Production
       def sandbox?
         !production?
       end

data/lib/itunes_receipt_decoder/decode/transaction_receipt.rb

@@ -7,15 +7,21 @@ module ItunesReceiptDecoder
     ##
     # ItunesReceiptDecoder::Decode::TransactionReceipt
     class TransactionReceipt < Base
+      ##
+      # Decodes the receipt
       def decode
         @receipt ||= purchase_info
         self
       end
 
+      ##
+      # Just returns :transaction
       def style
         :transaction
       end
 
+      ##
+      # Gets the environment from the payload
       def environment
         payload['environment']
       end

data/lib/itunes_receipt_decoder/decode/unified_receipt.rb

@@ -7,6 +7,10 @@ module ItunesReceiptDecoder
     ##
     # ItunesReceiptDecoder::Decode::UnifiedReceipt
     class UnifiedReceipt < Base
+      ##
+      # ASN.1 Field types
+      #
+      # See https://developer.apple.com/library/ios/releasenotes/General/ValidateAppStoreReceipt/Chapters/ReceiptFields.html#//apple_ref/doc/uid/TP40010573-CH106-SW1
       RECEIPT_FIELDS = {
         0 => :environment,
         2 => :bundle_id,
@@ -26,15 +30,25 @@ module ItunesReceiptDecoder
         1711 => :web_order_line_item_id
       }
 
+      TIMESTAMP_FIELDS = %i(creation_date expiration_date purchase_date
+                            original_purchase_date expires_date
+                            cancellation_date)
+
+      ##
+      # Decodes the receipt
       def decode
         @receipt ||= parse_app_receipt_fields(payload.value)
         self
       end
 
+      ##
+      # Just returns :unified
       def style
         :unified
       end
 
+      ##
+      # Gets the environment from the receipt
       def environment
         decode.receipt[:environment]
       end
@@ -56,11 +70,27 @@ module ItunesReceiptDecoder
         case field
         when :in_app
           (result[field] ||= []).push(parse_app_receipt_fields(value))
+        when *timestamp_fields
+          result.merge! expand_timestamp(field, value) unless value.empty?
         else
           result[field] = value.class == OpenSSL::BN ? value.to_i : value.to_s
         end
       end
 
+      def timestamp_fields
+        options[:expand_timestamps] && TIMESTAMP_FIELDS
+      end
+
+      def expand_timestamp(field, value)
+        time = Time.parse(value).utc
+        {
+          field => time.strftime('%F %T') + ' Etc/GMT',
+          "#{field}_ms".to_sym => (time.to_i * 1000).to_s,
+          "#{field}_pst".to_sym => (time + Time.zone_offset('PST'))
+            .strftime('%F %T') + ' America/Los_Angeles'
+        }
+      end
+
       def payload
         verify && OpenSSL::ASN1.decode(pkcs7.data)
       end

data/lib/itunes_receipt_decoder/version.rb

@@ -1,5 +1,7 @@
 ##
 # ItunesReceiptDecoder
 module ItunesReceiptDecoder
-  VERSION = '0.1.0'
+  ##
+  # Gem version
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itunes_receipt_decoder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mbaasy.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="