ProMotion-iap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7e41cfc55cf06853a59e0f826b7161765189039
-  data.tar.gz: a2eba57b0b4f0d42ddd1fde6dd0f38c27c4f1bb6
+  metadata.gz: a58cbbb9a1bfea9bed76bf23bcf61cb8c538bc17
+  data.tar.gz: 2dd27741089d27722aa8a4e7e4fa2fb1153cf75c
 SHA512:
-  metadata.gz: ea6ebbe840ca8d1718d22a7f48706084917b62f1d8473d5e21550bdebdc53073bb76049def4d3f3fff77a613e0e0d410a21d66902c704f92abd61d5437bac9f1
-  data.tar.gz: 391efff17e8eb4ee1d5d9cd92f34469d59c6de8d8b9eb24fd8899437e2de2579cddf29e710a002f1fdb9a7d72436ad0f1192dd2fcb94dc3c04caed2c66bc8ce2
+  metadata.gz: a15d8be62ab306ff6fb4fa1ac41736a62f92db1c66e27a1c7a330ec510293c8549c020e459575372c6cd1deaded3cc7709e57e0193c51756524afb727e49140c
+  data.tar.gz: c681697056432c9dee095f61392f4dd7b60bb10a4d9da50f13c081364cda6b26ac89444bcbf375757c3b609d98dc14cd06f78914367ec9be51e44716750a0a46

data/README.md

@@ -1,7 +1,10 @@
 # ProMotion-iap
 
+[![Gem Version](https://badge.fury.io/rb/ProMotion-iap.svg)](http://badge.fury.io/rb/ProMotion-iap)
+[![Build Status](https://travis-ci.org/clearsightstudio/ProMotion-iap.svg)](https://travis-ci.org/clearsightstudio/ProMotion-iap) 
+
 ProMotion-iap is in-app purchase notification support for the
-popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion).
+ popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion).
 
 ## Installation
 
@@ -11,7 +14,79 @@ gem 'ProMotion-iap'
 
 ## Usage
 
-### AppDelegate
+### PM::IAP::Product Class
+
+The `Product` class is an abstraction layer that provides a simpler interface when working with a single IAP product.
+ If you are dealing with multiple products you will want to use the IAP Module directly (documented below).
+
+```ruby
+class PurchaseScreen < PM::Screen
+
+  def on_load
+
+    product = PM::IAP::Product.new("productid")
+
+    product.retrieve do |product, error|
+      # product looks something like the following
+      {
+        product_id:               "productid1",
+        title:                    "title",
+        description:              "description",
+        price:                    <BigDecimal 0.99>,
+        formatted_price:          "$0.99",
+        price_locale:             <NSLocale>,
+        downloadable:             false,
+        download_content_lengths: <?>, # TODO: ?
+        download_content_version: <?>, # TODO: ?
+        product:                  <SKProduct>
+      }
+    end
+
+    product.purchase do |status, transaction|
+      case status
+      when :in_progress
+        # Usually do nothing, maybe a spinner
+      when :deferred
+        # Waiting on a prompt to the user
+      when :purchased
+        # Notify the user, update any affected UI elements
+      when :canceled
+        # They just canceled, no big deal.
+      when :error
+        # Failed to purchase
+        transaction.error.localizedDescription # => error message
+      end
+    end
+
+    product.restore do |status, product|
+      if status == :restored
+        # Update your UI, notify the user
+      end
+    end
+
+  end
+end
+
+```
+
+#### Product.new(product_id)
+
+Stores the product_id for use in the instance methods.
+
+#### retrieve(&callback)
+
+Retrieves the product.
+
+#### purchase(&callback)
+
+Begins a purchase of the product.
+
+#### restore(&callback)
+
+Begins a restoration of the previously purchased product.
+
+
+### IAP Module
 
 Include `PM::IAP` to add some in-app purchase methods to a screen, app delegate, or other class.
 
@@ -22,7 +97,7 @@ class PurchaseScreen < PM::Screen
 
   def on_load
 
-    retrieve_iaps([ "productid1", "productid2" ]) do |products, error|
+    retrieve_iaps [ "productid1", "productid2" ] do |products, error|
       # products looks something like the following
       [{
         product_id:               "productid1",
@@ -54,7 +129,7 @@ class PurchaseScreen < PM::Screen
       end
     end
 
-    restore_iaps do |status, products|
+    restore_iaps "productid" do |status, products|
       if status == :restored
         # Update your UI, notify the user
       end
@@ -65,19 +140,42 @@ class PurchaseScreen < PM::Screen
 end
 ```
 
-#### purchase_iap(*product_ids, &callback)
+#### retrieve_iaps(`*`product_ids, &callback)
+
+Retrieves in-app purchase products in an array of mapped hashes. The callback method should accept `products` and `error`.
+
+
+#### purchase_iaps(`*`product_ids, &callback)
+
+Prompts the user to login to their Apple ID and complete the purchase. The callback method should accept `status` and `transaction`.
+ The callback method will be called several times with the various statuses in the process. If more than one `product_id` is provided
+ the callback method will be called several times per product with the applicable transaction.
+
+
+#### restore_iaps(`*`product_ids, &callback)
+
+Restores a previously purchased IAP to the user (for example if they have upgraded their device). This relies on the Apple ID the user
+ enters at the prompt. Unfortunately, if there is no purchase to restore for the signed-in account, no error message is generated and 
+ will fail silently.
+
 
-TODO
 
-```ruby
 
-```
 
 Find the Product ID here:
 
 ![product id](http://clrsight.co/jh/2015-02-11-d8xw6.png?+)
 
 
+## Authors
+| Contributor | Twitter |
+| Jamon Holmgren | [@jamonholmgren](http://twitter.com/jamonholmgren) |
+| Kevin VanGelder | [@kevinvangelder](http://twitter.com/kevin_vangelder) |
+
+## Inspired By
+- [Helu](https://github.com/ivanacostarubio/helu)
+- [Mark Rickert's Code Example](https://github.com/OTGApps/TheShowCloser/blob/master/app/helpers/iap_helper.rb)
+
 
 ## Contributing
 

data/lib/ProMotion-iap.rb

@@ -7,5 +7,6 @@ end
 Motion::Project::App.setup do |app|
   lib_dir_path = File.dirname(File.expand_path(__FILE__))
   app.files << File.join(lib_dir_path, "ProMotion/iap.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/product.rb")
   app.frameworks << "StoreKit"
 end

data/lib/ProMotion/iap.rb

@@ -2,9 +2,9 @@ module ProMotion
   module IAP
     attr_accessor :completion_handlers
 
-    def purchase_iap(product_id, &callback)
+    def purchase_iaps(*product_ids, &callback)
       iap_setup
-      retrieve_iaps product_id do |products|
+      retrieve_iaps product_ids do |products|
         products.each do |product|
           self.completion_handlers["purchase-#{product[:product_id]}"] = callback
           payment = SKPayment.paymentWithProduct(product[:product])
@@ -12,16 +12,18 @@ module ProMotion
         end
       end
     end
+    alias purchase_iap purchase_iaps
 
-    def restore_iaps(product_id, &callback)
+    def restore_iaps(*product_ids, &callback)
       iap_setup
-      retrieve_iaps product_id do |products|
+      retrieve_iaps product_ids do |products|
         products.each do |product|
           self.completion_handlers["restore-#{product[:product_id]}"] = callback
           SKPaymentQueue.defaultQueue.restoreCompletedTransactions
         end
       end
     end
+    alias restore_iap restore_iaps
 
     def retrieve_iaps(*product_ids, &callback)
       iap_setup
@@ -76,13 +78,28 @@ module ProMotion
       num_formatter.stringFromNumber price
     end
 
+    def iap_callback(status, transaction, finish=false)
+      product_id = transaction.payment.productIdentifier
+      if self.completion_handlers["purchase-#{product_id}"]
+        self.completion_handlers["purchase-#{product_id}"].call status, transaction
+        self.completion_handlers["purchase-#{product_id}"] = nil if finish
+      end
+      if self.completion_handlers["restore-#{product_id}"]
+        self.completion_handlers["restore-#{product_id}"].call status, transaction
+        self.completion_handlers["restore-#{product_id}"] = nil if finish
+      end
+      SKPaymentQueue.defaultQueue.finishTransaction(transaction) if finish
+    end
+
     public
 
     # SKProductsRequestDelegate methods
 
     def productsRequest(_, didReceiveResponse:response)
       unless response.invalidProductIdentifiers.empty?
-        PM.logger.error "PM::IAP Error - invalid product identifier(s) '#{response.invalidProductIdentifiers.join("', '")}' for application identifier #{NSBundle.mainBundle.infoDictionary['CFBundleIdentifier'].inspect}"
+        red = "\e[0;31m"
+        color_off = "\e[0m"
+        puts "#{red}PM::IAP Error - invalid product identifier(s) '#{response.invalidProductIdentifiers.join("', '")}' for application identifier #{NSBundle.mainBundle.infoDictionary['CFBundleIdentifier'].inspect}#{color_off}"
       end
       retrieved_iaps_handler(response.products, &self.completion_handlers["retrieve_iaps"]) if self.completion_handlers["retrieve_iaps"]
       @products_request = nil
@@ -115,18 +132,6 @@ module ProMotion
       end
     end
 
-    def iap_callback(status, transaction, finish=false)
-      product_id = transaction.payment.productIdentifier
-      if self.completion_handlers["purchase-#{product_id}"]
-        self.completion_handlers["purchase-#{product_id}"].call status, transaction
-        self.completion_handlers["purchase-#{product_id}"] = nil if finish
-      end
-      if self.completion_handlers["restore-#{product_id}"]
-        self.completion_handlers["restore-#{product_id}"].call status, transaction
-        self.completion_handlers["restore-#{product_id}"] = nil if finish
-      end
-      SKPaymentQueue.defaultQueue.finishTransaction(transaction) if finish
-    end
-
   end
 end
+::PM = ProMotion unless defined?(::PM)

data/lib/ProMotion/product.rb

@@ -0,0 +1,27 @@
+module ProMotion
+  class IAP::Product
+    include PM::IAP
+
+    attr_reader :product_id
+
+    def initialize(product_id)
+      @product_id = product_id
+    end
+
+    def retrieve(&callback)
+      retrieve_iaps(product_id) do |products, error|
+        callback.call products.first, error
+      end
+    end
+
+    def purchase(&callback)
+      purchase_iaps(product_id, &callback)
+    end
+
+    def restore(&callback)
+      restore_iaps(product_id) do |status, products|
+        callback.call status, products.find{|p| p[:product_id] == product_id }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-iap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jamon Holmgren
@@ -11,20 +11,6 @@ bindir: bin
 cert_chain: []
 date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ProMotion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: motion-stump
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +64,7 @@ files:
 - README.md
 - lib/ProMotion-iap.rb
 - lib/ProMotion/iap.rb
+- lib/ProMotion/product.rb
 homepage: https://github.com/clearsightstudio/ProMotion-iap
 licenses:
 - MIT