amazon-iap 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,8 @@
 # Amazon::Iap
 
-Verify Amazon in app purchases.
+This gem is a simple implementation of the Amazon receipt verfication service outlined
+[here](https://developer.amazon.com/sdk/in-app-purchasing/documentation/rvs.html).
+
 
 ## Installation
 
@@ -18,12 +20,68 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+**NOTE:** Amazon does not deploy a sandbox environment for testing purposes.  Rather,
+they give you access to a deployable WAR file.  You can use this WAR file to easily deploy your
+own sandbox environment on Heroku.  See [here](https://devcenter.heroku.com/articles/war-deployment#command-line)
+for more details.
+
+Initialize a client, passing in the developer secret and (optionally) the host.  If a host is not
+passed, it will use Amazon's production endpoint.
+
+    client = Amazon::Iap::Client.new 'my_developer_secret', 'http://iap-staging.domain.com'
+
+From there, you can call either `verify` or `renew` on the client and pass in the user id and purchase token:
+
+    result = client.verify 'some-user-id', 'some-purchase-token'
+    result = client.renew 'some-user-id', 'some-purchase-token'
+
+By default, the `verify` method will automatically try to renew expired tokens, and will recall `verify`
+against the new token returned.  If you do not want this behavior, simply pass in `false` as the third
+attribute to the `verify` method:
+
+    result = client.verify 'some-user-id', 'some-purchase-token', false
+
+## Returned Values
+
+An instance of Amazon::Iap::Result is returned from both methods, the attributes being the underscored versions
+of the hash keys returned in the JSON object.  For convenience, we also add `start_time` and `end_time` attributes
+which are `Time` representations of the milliseconds returned in `start_date` and `end_date` respectively.  E.g.,
+
+    result = client.verify 'some-user-id', 'some-purchase-token'
+    
+    result.class.name     # "Amazon::Iap::Result"
+    result.item_type      # "SUBSCRIPTION"
+    result.sku            # "some-sku"
+    result.start_date     # 1378751554943
+    result.start_time     # 2013-09-09 14:32:34 -0400 
+    result.end_date       # nil
+    result.end_time       # nil
+    result.purchase_token # "some-purchase-token"
+
+<!-- -->
+ 
+    result = client.renew 'some-user-id', 'some-purchase-token'
+    
+    result.class.name     # "Amazon::Iap::Result"
+    result.purchase_token # "some-new-purchase-token"
+
+## Exception Handling
+
+Any non-200 status code will raise an exception.  For convenience in internal controls, each status code raises
+a distinct exception.  Take a look at the [Amazon::Iap::Result class](lib/amazon/iap/result.rb) for specifics.
+
+Example exception handling:
+
+    begin
+      result = client.verify 'some-user-id', 'some-purchase-token'
+    rescue Amazon::Iap::Exceptions::InternalError => e
+      # enqueue to try again later
+    end
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b some-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin some-new-feature`)
 5. Create new Pull Request

data/lib/amazon/iap/result.rb

@@ -5,8 +5,13 @@ class Amazon::Iap::Result
     case response.code.to_i
     when 200
       parsed = JSON.parse(response.body)
-      parsed['startTime'] = parsed['startDate'].nil? ? nil : Time.at(parsed['startDate'] / 1000)
-      parsed['endTime'] = parsed['endDate'].nil? ? nil : Time.at(parsed['endDate'] / 1000)
+      
+      if parsed.has_key? 'startDate'
+        parsed['startTime'] = parsed['startDate'].nil? ? nil : Time.at(parsed['startDate'] / 1000)
+      end
+      if parsed.has_key? 'endDate'
+        parsed['endTime'] = parsed['endDate'].nil? ? nil : Time.at(parsed['endDate'] / 1000)
+      end
       
       parsed.each do |key, value|
         underscore = key.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').tr('-', '_').downcase

data/lib/amazon/iap/version.rb

@@ -1,5 +1,5 @@
 module Amazon
   module Iap
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazon-iap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler