venice 0.2.0 → 0.3.0

data/lib/venice.rb

@@ -1,3 +1,4 @@
 require 'venice/version'
 require 'venice/client'
+require 'venice/in_app_receipt'
 require 'venice/receipt'

data/lib/venice/client.rb

@@ -29,24 +29,32 @@ module Venice
     end
 
     def verify!(data, options = {})
+      @verification_url ||= ITUNES_DEVELOPMENT_RECEIPT_VERIFICATION_ENDPOINT
+      @shared_secret = options[:shared_secret] if options[:shared_secret]
+
       json = json_response_from_verifying_data(data)
       status, receipt_attributes = json['status'].to_i, json['receipt']
+      receipt_attributes['original_json_response'] = json if receipt_attributes
 
       case status
       when 0, 21006
         receipt = Receipt.new(receipt_attributes)
 
-        if latest_receipt_attributes = json['latest_receipt_info']
-          receipt.latest = Receipt.new(latest_receipt_attributes)
-        end
-
-        if latest_expired_receipt_attributes = json['latest_expired_receipt_info']
-          receipt.latest_expired = Receipt.new(latest_expired_receipt_attributes)
+        # From Apple docs:
+        # > Only returned for iOS 6 style transaction receipts for auto-renewable subscriptions.
+        # > The JSON representation of the receipt for the most recent renewal
+        if latest_receipt_info_attributes = json['latest_receipt_info']
+          # AppStore returns 'latest_receipt_info' even if we use over iOS 6. Besides, its format is an Array.
+          receipt.latest_receipt_info = []
+          latest_receipt_info_attributes.each do |latest_receipt_info_attribute|
+            # latest_receipt_info format is identical with in_app
+            receipt.latest_receipt_info << InAppReceipt.new(latest_receipt_info_attribute)
+          end
         end
 
         return receipt
       else
-        raise Receipt::VerificationError.new(status)
+        raise Receipt::VerificationError.new(status, receipt)
       end
     end
 
@@ -62,7 +70,7 @@ module Venice
       uri = URI(@verification_url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
 
       request = Net::HTTP::Post.new(uri.request_uri)
       request['Accept'] = "application/json"

data/lib/venice/in_app_receipt.rb

@@ -0,0 +1,92 @@
+require 'time'
+
+module Venice
+  class InAppReceipt
+    # 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
+
+    # 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
+
+    # 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 transaction identifier of the item that was purchased. This value corresponds
+    # to the transaction’s transactionIdentifier property.
+    attr_reader :transaction_id
+
+    # The date and time this transaction occurred. This value corresponds to the
+    # transaction’s transactionDate property.
+    attr_reader :purchased_at
+
+    # A string that the App Store uses to uniquely identify the application that created
+    # the payment transaction. If your server supports multiple applications, you can use
+    # this value to differentiate between them. Applications that are executing in the
+    # sandbox do not yet have an app-item-id assigned to them, so this key is missing from
+    # receipts created by the sandbox.
+    attr_reader :app_item_id
+
+    # An arbitrary number that uniquely identifies a revision of your application. This key
+    # is missing in receipts created by the sandbox.
+    attr_reader :version_external_identifier
+
+    # For a transaction that restores a previous transaction, this is the original receipt
+    attr_accessor :original
+
+    # For auto-renewable subscriptions, returns the date the subscription will expire
+    attr_reader :expires_at
+
+    # For a transaction that was canceled by Apple customer support, the time and date of the cancellation.
+    attr_reader :cancellation_at
+
+
+    def initialize(attributes = {})
+      @quantity = Integer(attributes['quantity']) if attributes['quantity']
+      @product_id = attributes['product_id']
+      @transaction_id = attributes['transaction_id']
+      @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']
+
+      # expires_date is in ms since the Epoch, Time.at expects seconds
+      @expires_at = Time.at(attributes['expires_date_ms'].to_i / 1000) if attributes['expires_date_ms']
+
+      # cancellation_date is in ms since the Epoch, Time.at expects seconds
+      @cancellation_date = Time.at(attributes['cancellation_date'].to_i / 1000) if attributes['cancellation_date']
+
+      if attributes['original_transaction_id'] || attributes['original_purchase_date']
+        original_attributes = {
+          'transaction_id' => attributes['original_transaction_id'],
+          'purchase_date' => attributes['original_purchase_date']
+        }
+
+        self.original = InAppReceipt.new(original_attributes)
+      end
+
+    end
+
+    def to_hash
+      {
+        :quantity => @quantity,
+        :product_id => @product_id,
+        :transaction_id => @transaction_id,
+        :purchase_date => (@purchased_at.httpdate rescue nil),
+        :original_transaction_id => (@original.transaction_id rescue nil),
+        :original_purchase_date => (@original.purchased_at.httpdate rescue nil),
+        :app_item_id => @app_item_id,
+        :version_external_identifier => @version_external_identifier,
+        :expires_at => (@expires_at.httpdate rescue nil),
+        :cancellation_at => (@cancellation_at.httpdate rescue nil)
+      }
+    end
+    alias_method :to_h, :to_hash
+
+    def to_json
+      self.to_hash.to_json
+    end
+
+  end
+end

data/lib/venice/receipt.rb

@@ -2,83 +2,85 @@ require 'time'
 
 module Venice
   class Receipt
-    # 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
+    # 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 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 app’s bundle identifier.
+    attr_reader :bundle_id
 
-    # The transaction identifier of the item that was purchased. This value corresponds to the transaction’s transactionIdentifier property.
-    attr_reader :transaction_id
+    # The app’s version number.
+    attr_reader :application_version
 
-    # The date and time this transaction occurred. This value corresponds to the transaction’s transactionDate property.
-    attr_reader :purchase_date
+    # The receipt for an in-app purchase.
+    attr_reader :in_app
 
-    # A string that the App Store uses to uniquely identify the application that created the payment transaction. If your server supports multiple applications, you can use this value to differentiate between them. Applications that are executing in the sandbox do not yet have an app-item-id assigned to them, so this key is missing from receipts created by the sandbox.
-    attr_reader :app_item_id
+    # The version of the app that was originally purchased.
+    attr_reader :original_application_version
 
-    # An arbitrary number that uniquely identifies a revision of your application. This key is missing in receipts created by the sandbox.
-    attr_reader :version_external_identifier
+    # The original purchase date
+    attr_reader :original_purchase_date
 
-    # The bundle identifier for the application.
-    attr_reader :bid
-
-    # A version number for the application.
-    attr_reader :bvrs
+    # The date that the app receipt expires.
+    attr_reader :expires_at
 
-    # For a transaction that restores a previous transaction, this is the original receipt
-    attr_accessor :original
+    # Non-Documented receipt keys/values
+    attr_reader :receipt_type
+    attr_reader :adam_id
+    attr_reader :download_id
+    attr_reader :requested_at
 
-    # For an active subscription was renewed with transaction that took place after the receipt your server sent to the App Store, this is the latest receipt.
-    attr_accessor :latest
+    # Original json response from AppStore
+    attr_reader :original_json_response
 
-    # For an expired auto-renewable subscription, this contains the receipt details for the latest expired receipt
-    attr_accessor :latest_expired
 
-    # For auto-renewable subscriptions, returns the date the subscription will expire
-    attr_reader :expires_at
+    attr_accessor :latest_receipt_info
 
     def initialize(attributes = {})
-      @quantity = Integer(attributes['quantity']) if attributes['quantity']
-      @product_id = attributes['product_id']
-      @transaction_id = attributes['transaction_id']
-      @purchase_date = DateTime.parse(attributes['purchase_date']) if attributes['purchase_date']
-      @app_item_id = attributes['app_item_id']
-      @version_external_identifier = attributes['version_external_identifier']
-      @bid = attributes['bid']
-      @bvrs = attributes['bvrs']
-
-      # expires_date is in ms since the Epoch, Time.at expects seconds
-      @expires_at = Time.at(attributes['expires_date'].to_i / 1000) if attributes['expires_date']
-
-      if attributes['original_transaction_id'] || attributes['original_purchase_date']
-        original_attributes = {
-          'transaction_id' => attributes['original_transaction_id'],
-          'purchase_date' => attributes['original_purchase_date']
-        }
-
-        self.original = Receipt.new(original_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']
+
+      @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
+
     end
 
-    def to_h
+    def to_hash
       {
-        :quantity => @quantity,
-        :product_id => @product_id,
-        :transaction_id => @transaction_id,
-        :purchase_date => (@purchase_date.httpdate rescue nil),
-        :original_transaction_id => (@original.transaction_id rescue nil),
-        :original_purchase_date => (@original.purchase_date.httpdate rescue nil),
-        :app_item_id => @app_item_id,
-        :version_external_identifier => @version_external_identifier,
-        :bid => @bid,
-        :bvrs => @bvrs,
-        :expires_at => (@expires_at.httpdate rescue nil)
+        :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),
+        :in_app => @in_app.map{|iap| iap.to_h },
+        :latest_receipt_info => @latest_receipt_info
       }
     end
+    alias_method :to_h, :to_hash
 
     def to_json
-      self.to_h.to_json
+      self.to_hash.to_json
     end
 
     class << self
@@ -111,9 +113,11 @@ module Venice
 
     class VerificationError < StandardError
       attr_accessor :code
+      attr_accessor :receipt
 
-      def initialize(code)
+      def initialize(code, receipt)
         @code = Integer(code)
+        @receipt = receipt
       end
 
       def message

data/lib/venice/version.rb

@@ -1,3 +1,3 @@
 module Venice
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/client_spec.rb

@@ -8,10 +8,14 @@ describe Venice::Client do
     context "no shared_secret" do
       before do
         client.shared_secret = nil
+        Venice::Receipt.stub :new
       end
 
       it "should only include the receipt_data" do
-        client.should_receive(:perform_post).with('receipt-data' => receipt_data)
+        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
@@ -20,14 +24,77 @@ describe Venice::Client do
       let(:secret) { "shhhhhh" }
 
       before do
-        client.shared_secret = secret
+        Venice::Receipt.stub :new
       end
 
-      it "should include the secret in the post" do
-        client.should_receive(:perform_post).with('receipt-data' => receipt_data, 'password' => secret)
-        client.verify! receipt_data
+      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
+      before do
+        client.stub(:json_response_from_verifying_data).and_return(response)
+      end
+
+      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
+        receipt = client.verify! 'asdf'
+        receipt.latest_receipt_info.should_not be_nil
       end
     end
+
   end
 end
-

data/spec/in_app_receipt_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper.rb'
+
+describe Venice::InAppReceipt do
+
+  describe ".new" do
+
+    let :attributes do
+      {
+        "quantity" => 1,
+        "product_id" => "com.foo.product1",
+        "transaction_id" => "1000000070107235",
+        "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,
+        "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(:purchased_at) { should be_instance_of DateTime }
+    its(:app_item_id) { 'com.foo.app1' }
+    its(:version_external_identifier) { "123" }
+    its(:original) { should be_instance_of Venice::InAppReceipt }
+    its(:expires_at) { should be_instance_of Time }
+
+    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 output a hash with attributes" do
+      in_app_receipt.to_h.should include(:quantity => 1,
+                                          :product_id => "com.foo.product1",
+                                          :transaction_id => "1000000070107235",
+                                          :purchase_date => "Wed, 28 May 2014 14:47:53 GMT",
+                                          :original_purchase_date => "Wed, 28 May 2014 14:47:53 GMT"
+                                        )
+    end
+
+
+  end
+
+end