candy_check 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce2db5208c39a8d9cda9eb6308fae0ae95b34460a053036b16cf2496c5fdffb
-  data.tar.gz: 1eba58dfa69e6c8732ae1f2e33553d2386e85653c5ba867603253d531c2e0891
+  metadata.gz: 417a8850353b9726251dcae68864b46f77d30de0e73db9488c68c52282a90e70
+  data.tar.gz: 5dbcba7f14f6c81d73a0baa7554c01f0e53cb7167e0ff22029a6ddd8deac6b23
 SHA512:
-  metadata.gz: 0f58665b4df59f402b0e43f6f9a09a74b40caf8ab7fd6511732b7ff742b35f8a1a32f53821a777a423effdc386757aaec88965aa1a63686ca463b9e98f7fc54d
-  data.tar.gz: 245dad3d70c0eccc33c992a5420f2ac2ddb8521a524a06b0361418516d35ee9471f71c12bff4771ce6a00390ba16858d12b836060e463524cd2c3b0310ab59d8
+  metadata.gz: 6777436feed72baacb24e07634fa921f9723c37f207f8c9ab373aa68b007f326236877ecff04a32001ee046c0c5200d033218939e59b5af429e2b65d3e15504c
+  data.tar.gz: bc28443c9277dbad870f04fcc85a4c92705c7ce72d4a88b9a4ab9c882a5e90e7281a3ef13a77e1f12866e0c77b3896d8ea6be542184041a16d3eb15d16758917

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.1

data/README.md

@@ -150,6 +150,34 @@ result = verifier.verify_subscription_purchase(
 
 Please see documenation for [`CandyCheck::PlayStore::SubscriptionPurchases::SubscriptionPurchase`](http://www.rubydoc.info/github/jnbt/candy_check/master/CandyCheck/PlayStore/SubscriptionPurchases/SubscriptionPurchase) for further details.
 
+
+##### Building an acknowledger
+
+With the `authorization` object in place, we can build an acknowledger:
+
+```ruby
+acknowledger = CandyCheck::PlayStore::Acknowledger.new(authorization: authorization)
+```
+
+> **Note:** If you need to acknowledge against multiple Google Service Accounts, just instantiate a new acknowledger with another authorization object that got build with a different `.json` key file.
+
+#### Acknowledging the purchase
+Google Play purchases if not acknowledged are automatically refunded. The acknowledgement can be done client-side or server-side. If server-side validation is being used we recommend to proceed with the acknowledgement afterwards, since it is the only save way to ensure the users received what they have paid for.
+
+```ruby
+result = acknowledger.acknowledge_product_purchase(
+  package_name: "my-package-name",
+  product_id: "my-subscription-id",
+  token: "my-token"
+)
+# => ProductAcknowledgements::Response
+```
+
+The acknowledger response has 2 methods:
+
+- `#acknowledged?` returns a boolean. It returns true only if it has been acknowledged at this moment (that's Google Play behaviour).
+- `#error` returns a hash with `status_code` and `body` keys.
+
 ## CLI
 
 This gem ships with an executable to verify in-app purchases directly from your terminal:

data/candy_check.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4")
 
-  spec.add_dependency "google-api-client", "~> 0.34.0"
+  spec.add_dependency "google-api-client", "~> 0.43.0"
   spec.add_dependency "multi_json", "~> 1.10"
   spec.add_dependency "thor", "~> 0.19"
 

data/lib/candy_check/play_store.rb

@@ -4,9 +4,12 @@ require "candy_check/play_store/android_publisher_service"
 require "candy_check/play_store/product_purchases/product_purchase"
 require "candy_check/play_store/subscription_purchases/subscription_purchase"
 require "candy_check/play_store/product_purchases/product_verification"
+require "candy_check/play_store/product_acknowledgements/acknowledgement"
+require "candy_check/play_store/product_acknowledgements/response"
 require "candy_check/play_store/subscription_purchases/subscription_verification"
 require "candy_check/play_store/verification_failure"
 require "candy_check/play_store/verifier"
+require "candy_check/play_store/acknowledger"
 
 module CandyCheck
   # Module to request and verify a AppStore receipt

data/lib/candy_check/play_store/acknowledger.rb

@@ -0,0 +1,19 @@
+module CandyCheck
+  module PlayStore
+    class Acknowledger
+      def initialize(authorization:)
+        @authorization = authorization
+      end
+
+      def acknowledge_product_purchase(package_name:, product_id:, token:)
+        acknowledger = CandyCheck::PlayStore::ProductAcknowledgements::Acknowledgement.new(
+          package_name: package_name,
+          product_id: product_id,
+          token: token,
+          authorization: @authorization,
+        )
+        acknowledger.call!
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/product_acknowledgements/acknowledgement.rb

@@ -0,0 +1,45 @@
+module CandyCheck
+  module PlayStore
+    module ProductAcknowledgements
+      # Verifies a purchase token against the PlayStore API
+
+      class Acknowledgement
+        # @return [String] the package_name which will be queried
+        attr_reader :package_name
+        # @return [String] the item id which will be queried
+        attr_reader :product_id
+        # @return [String] the token for authentication
+        attr_reader :token
+
+        # Initializes a new call to the API
+        # @param package_name [String]
+        # @param product_id [String]
+        # @param token [String]
+        def initialize(package_name:, product_id:, token:, authorization:)
+          @package_name = package_name
+          @product_id = product_id
+          @token = token
+          @authorization = authorization
+        end
+
+        def call!
+          acknowledge!
+
+          CandyCheck::PlayStore::ProductAcknowledgements::Response.new(
+            result: @response[:result], error_data: @response[:error_data])
+        end
+
+        private
+
+        def acknowledge!
+          service = CandyCheck::PlayStore::AndroidPublisherService.new
+
+          service.authorization = @authorization
+          service.acknowledge_purchase_product(package_name, product_id, token) do |result, error_data|
+            @response = { result: result, error_data: error_data }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/product_acknowledgements/response.rb

@@ -0,0 +1,24 @@
+module CandyCheck
+  module PlayStore
+    module ProductAcknowledgements
+      class Response
+        def initialize(result:, error_data:)
+          @result = result
+          @error_data = error_data
+        end
+
+        def acknowledged?
+          !!result
+        end
+
+        def error
+          return unless error_data
+
+          { status_code: error_data.status_code, body: error_data.body }
+        end
+
+        attr_reader :result, :error_data
+      end
+    end
+  end
+end

data/lib/candy_check/play_store/subscription_purchases/subscription_purchase.rb

@@ -124,6 +124,13 @@ module CandyCheck
           @subscription_purchase.expiry_time_millis
         end
 
+        # Get cancellation time for subscription in milliseconds since Epoch.
+        # Only present if cancelReason is 0.
+        # @return [Integer]
+        def user_cancellation_time_millis
+          @subscription_purchase.user_cancellation_time_millis if canceled_by_user?
+        end
+
         # Get start time in UTC
         # @return [DateTime]
         def starts_at
@@ -135,6 +142,12 @@ module CandyCheck
         def expires_at
           Time.at(expiry_time_millis / 1000).utc.to_datetime
         end
+
+        # Get cancellation time in UTC
+        # @return [DateTime]
+        def canceled_at
+          Time.at(user_cancellation_time_millis / 1000).utc.to_datetime if user_cancellation_time_millis
+        end
       end
     end
   end

data/lib/candy_check/version.rb

@@ -1,4 +1,4 @@
 module CandyCheck
   # The current gem's version
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/acknowledged.yml

@@ -0,0 +1,105 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.googleapis.com/oauth2/v4/token
+    body:
+      encoding: ASCII-8BIT
+      string: params
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Date:
+      - Mon, 22 Jun 2020 11:38:56 GMT
+      Server:
+      - scaffolding on HTTPServer2
+      Cache-Control:
+      - private
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"access_token","expires_in":3599,"token_type":"Bearer"}'
+  recorded_at: Mon, 22 Jun 2020 11:38:56 GMT
+- request:
+    method: post
+    uri: https://www.googleapis.com/androidpublisher/v3/applications/fake_package_name/purchases/products/fake_product_id/tokens/fake_token:acknowledge
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - unknown/0.0.0 google-api-ruby-client/0.34.1 Mac OS X/10.14.6 (gzip)
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 22 Jun 2020 11:38:56 GMT
+      X-Goog-Api-Client:
+      - gl-ruby/2.5.1 gdcl/0.34.1
+      Authorization:
+      - Bearer some_token
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Date:
+      - Mon, 22 Jun 2020 11:38:57 GMT
+      Server:
+      - ESF
+      Content-Length:
+      - '0'
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Mon, 22 Jun 2020 11:38:57 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/already_acknowledged.yml

@@ -0,0 +1,124 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.googleapis.com/oauth2/v4/token
+    body:
+      encoding: ASCII-8BIT
+      string: params
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Date:
+      - Mon, 22 Jun 2020 13:11:45 GMT
+      Server:
+      - scaffolding on HTTPServer2
+      Cache-Control:
+      - private
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"access_token","expires_in":3599,"token_type":"Bearer"}'
+  recorded_at: Mon, 22 Jun 2020 13:11:45 GMT
+- request:
+    method: post
+    uri: https://www.googleapis.com/androidpublisher/v3/applications/fake_package_name/purchases/products/fake_product_id/tokens/fake_token:acknowledge
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - unknown/0.0.0 google-api-ruby-client/0.34.1 Mac OS X/10.14.6 (gzip)
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 22 Jun 2020 13:11:45 GMT
+      X-Goog-Api-Client:
+      - gl-ruby/2.5.1 gdcl/0.34.1
+      Authorization:
+      - Bearer some_token
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Content-Encoding:
+      - gzip
+      Date:
+      - Mon, 22 Jun 2020 13:11:46 GMT
+      Server:
+      - ESF
+      Cache-Control:
+      - private
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "error": {
+            "code": 400,
+            "message": "The purchase is not in a valid state to perform the desired operation.",
+            "errors": [
+              {
+                "message": "The purchase is not in a valid state to perform the desired operation.",
+                "domain": "androidpublisher",
+                "reason": "invalidPurchaseState",
+                "location": "token",
+                "locationType": "parameter"
+              }
+            ]
+          }
+        }
+  recorded_at: Mon, 22 Jun 2020 13:11:46 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/refunded.yml

@@ -0,0 +1,122 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.googleapis.com/oauth2/v4/token
+    body:
+      encoding: ASCII-8BIT
+      string: params
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Date:
+      - Mon, 22 Jun 2020 14:37:46 GMT
+      Server:
+      - scaffolding on HTTPServer2
+      Cache-Control:
+      - private
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"access_token","expires_in":3599,"token_type":"Bearer"}'
+  recorded_at: Mon, 22 Jun 2020 14:37:46 GMT
+- request:
+    method: post
+    uri: https://www.googleapis.com/androidpublisher/v3/applications/fake_package_name/purchases/products/fake_product_id/tokens/fake_token:acknowledge
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - unknown/0.0.0 google-api-ruby-client/0.34.1 Mac OS X/10.14.6 (gzip)
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 22 Jun 2020 14:37:46 GMT
+      X-Goog-Api-Client:
+      - gl-ruby/2.5.1 gdcl/0.34.1
+      Authorization:
+      - Bearer some_token
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Vary:
+      - Origin
+      - Referer
+      - X-Origin
+      Content-Encoding:
+      - gzip
+      Date:
+      - Mon, 22 Jun 2020 14:37:47 GMT
+      Server:
+      - ESF
+      Cache-Control:
+      - private
+      X-Xss-Protection:
+      - '0'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      Alt-Svc:
+      - h3-28=":443"; ma=2592000,h3-27=":443"; ma=2592000,h3-25=":443"; ma=2592000,h3-T050=":443";
+        ma=2592000,h3-Q050=":443"; ma=2592000,h3-Q049=":443"; ma=2592000,h3-Q048=":443";
+        ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000,quic=":443";
+        ma=2592000; v="46,43"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "error": {
+            "code": 400,
+            "message": "The product purchase is not owned by the user.",
+            "errors": [
+              {
+                "message": "The product purchase is not owned by the user.",
+                "domain": "androidpublisher",
+                "reason": "productNotOwnedByUser"
+              }
+            ]
+          }
+        }
+  recorded_at: Mon, 22 Jun 2020 14:37:47 GMT
+recorded_with: VCR 6.0.0

data/spec/play_store/acknowledger_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe CandyCheck::PlayStore::Acknowledger do
+  let(:json_key_file) { File.expand_path("../fixtures/play_store/random_dummy_key.json", __dir__) }
+  subject { CandyCheck::PlayStore::Acknowledger.new(authorization: authorization) }
+
+  let(:package_name) { "fake_package_name" }
+  let(:product_id)   { "fake_product_id" }
+  let(:token)        { "fake_token" }
+
+  let(:authorization) { CandyCheck::PlayStore.authorization(json_key_file) }
+
+  describe "#acknowledge_product_purchase" do
+    it "when acknowledgement succeeds" do
+      VCR.use_cassette("play_store/product_acknowledgements/acknowledged") do
+        result = subject.acknowledge_product_purchase(package_name: package_name, product_id: product_id, token: token)
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_true
+        result.error.must_be_nil
+      end
+    end
+    it "when already acknowledged" do
+      error_body = "{\n  \"error\": {\n    \"code\": 400,\n    \"message\": \"The purchase is not in a valid state to perform the desired operation.\",\n    \"errors\": [\n      {\n        \"message\": \"The purchase is not in a valid state to perform the desired operation.\",\n        \"domain\": \"androidpublisher\",\n        \"reason\": \"invalidPurchaseState\",\n        \"location\": \"token\",\n        \"locationType\": \"parameter\"\n      }\n    ]\n  }\n}\n"
+
+      VCR.use_cassette("play_store/product_acknowledgements/already_acknowledged") do
+        result = subject.acknowledge_product_purchase(package_name: package_name, product_id: product_id, token: token)
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_false
+        result.error[:body].must_equal(error_body)
+        result.error[:status_code].must_equal(400)
+      end
+    end
+    it "when it has been refunded" do
+      error_body = "{\n  \"error\": {\n    \"code\": 400,\n    \"message\": \"The product purchase is not owned by the user.\",\n    \"errors\": [\n      {\n        \"message\": \"The product purchase is not owned by the user.\",\n        \"domain\": \"androidpublisher\",\n        \"reason\": \"productNotOwnedByUser\"\n      }\n    ]\n  }\n}\n"
+
+      VCR.use_cassette("play_store/product_acknowledgements/refunded") do
+        result = subject.acknowledge_product_purchase(package_name: package_name, product_id: product_id, token: token)
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_false
+        result.error[:body].must_equal(error_body)
+        result.error[:status_code].must_equal(400)
+      end
+    end
+  end
+end

data/spec/play_store/product_acknowledgements/acknowledgement_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe CandyCheck::PlayStore::ProductAcknowledgements::Acknowledgement do
+  subject do
+    CandyCheck::PlayStore::ProductAcknowledgements::Acknowledgement.new(
+      package_name: package_name,
+      product_id: product_id,
+      token: token,
+      authorization: authorization,
+    )
+  end
+
+  let(:package_name)  { "fake_package_name" }
+  let(:product_id)    { "fake_product_id" }
+  let(:token)         { "fake_token" }
+  let(:json_key_file) { File.expand_path("../../fixtures/play_store/random_dummy_key.json", __dir__) }
+  let(:authorization) { CandyCheck::PlayStore.authorization(json_key_file) }
+
+  describe "#call!" do
+    it "when acknowledgement succeeds" do
+      VCR.use_cassette("play_store/product_acknowledgements/acknowledged") do
+        result = subject.call!
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_true
+        result.error.must_be_nil
+      end
+    end
+    it "when already acknowledged" do
+      error_body = "{\n  \"error\": {\n    \"code\": 400,\n    \"message\": \"The purchase is not in a valid state to perform the desired operation.\",\n    \"errors\": [\n      {\n        \"message\": \"The purchase is not in a valid state to perform the desired operation.\",\n        \"domain\": \"androidpublisher\",\n        \"reason\": \"invalidPurchaseState\",\n        \"location\": \"token\",\n        \"locationType\": \"parameter\"\n      }\n    ]\n  }\n}\n"
+
+      VCR.use_cassette("play_store/product_acknowledgements/already_acknowledged") do
+        result = subject.call!
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_false
+        result.error[:body].must_equal(error_body)
+        result.error[:status_code].must_equal(400)
+      end
+    end
+    it "when it has been refunded" do
+      error_body = "{\n  \"error\": {\n    \"code\": 400,\n    \"message\": \"The product purchase is not owned by the user.\",\n    \"errors\": [\n      {\n        \"message\": \"The product purchase is not owned by the user.\",\n        \"domain\": \"androidpublisher\",\n        \"reason\": \"productNotOwnedByUser\"\n      }\n    ]\n  }\n}\n"
+
+      VCR.use_cassette("play_store/product_acknowledgements/refunded") do
+        result = subject.call!
+
+        result.must_be_instance_of CandyCheck::PlayStore::ProductAcknowledgements::Response
+        result.acknowledged?.must_be_false
+        result.error[:body].must_equal(error_body)
+        result.error[:status_code].must_equal(400)
+      end
+    end
+  end
+end

data/spec/play_store/product_acknowledgements/response_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe CandyCheck::PlayStore::ProductAcknowledgements::Response do
+  subject do
+    CandyCheck::PlayStore::ProductAcknowledgements::Response.new(result: result, error_data: error_data)
+  end
+
+  describe '#acknowledged?' do
+    context 'when result present' do
+      let(:result) { '' }
+      let(:error_data)  { nil }
+
+      it 'returns true' do
+        result = subject.acknowledged?
+
+        result.must_be_true
+      end
+    end
+
+    context 'when result is not present' do
+      let(:result) { nil }
+      let(:error_data)  { nil }
+
+      it 'returns false' do
+        result = subject.acknowledged?
+
+        result.must_be_false
+      end
+    end
+  end
+
+  describe '#error' do
+    context 'when error present' do
+      let(:result) { nil }
+      let(:error_data) do
+        Module.new do
+          def status_code
+            400
+          end
+          def body
+            'A String describing the issue'
+          end
+          module_function :status_code, :body
+        end
+      end
+
+      it 'returns the expected data' do
+        result = subject.error
+
+        result[:status_code].must_equal(400)
+        result[:body].must_equal('A String describing the issue')
+      end
+    end
+
+    context 'when error is not present' do
+      let(:result) { '' }
+      let(:error_data)  { nil }
+
+      it 'returns false' do
+        result = subject.error
+
+        result.must_be_nil
+      end
+    end
+  end
+end

data/spec/play_store/subscription_purchases/subscription_purchase_spec.rb

@@ -109,6 +109,61 @@ describe CandyCheck::PlayStore::SubscriptionPurchases::SubscriptionPurchase do
     end
   end
 
+  describe "subscription cancelation by user" do
+    describe "when subscription is not canceled" do
+      let(:fake_subscription_purchase) do
+        FakeSubscriptionPurchase.new(
+          kind: "androidpublisher#subscriptionPurchase",
+          start_time_millis: 1459540113244,
+          expiry_time_millis: 1462132088610,
+          auto_renewing: true,
+          developer_payload: "payload that gets stored and returned",
+          payment_state: 1,
+        )
+      end
+
+      it "is not canceled?" do
+        subject.canceled_by_user?.must_be_false
+      end
+
+      it "returns nil user_cancellation_time_millis" do
+        subject.user_cancellation_time_millis.must_be_nil
+      end
+
+      it "returns nil canceled_at" do
+        subject.canceled_at.must_be_nil
+      end
+    end
+
+    describe "when subscription is canceled" do
+      let(:fake_subscription_purchase) do
+        FakeSubscriptionPurchase.new(
+          kind: "androidpublisher#subscriptionPurchase",
+          start_time_millis: 1459540113244,
+          expiry_time_millis: 1462132088610,
+          user_cancellation_time_millis: 1461872888000,
+          auto_renewing: true,
+          developer_payload: "payload that gets stored and returned",
+          cancel_reason: 0,
+          payment_state: 1,
+        )
+      end
+
+      it "is canceled?" do
+        subject.canceled_by_user?.must_be_true
+      end
+
+      it "returns the user_cancellation_time_millis" do
+        subject.user_cancellation_time_millis.must_equal 1_461_872_888_000
+      end
+
+      it "returns the starts_at" do
+        expected = DateTime.new(2016, 4, 28, 19, 48, 8)
+        subject.canceled_at.must_equal expected
+      end
+    end
+  end
+
   describe "expired with pending payment" do
     let(:fake_subscription_purchase) do
       FakeSubscriptionPurchase.new(
@@ -162,6 +217,7 @@ describe CandyCheck::PlayStore::SubscriptionPurchases::SubscriptionPurchase do
       :kind,
       :start_time_millis,
       :expiry_time_millis,
+      :user_cancellation_time_millis,
       :auto_renewing,
       :developer_payload,
       :cancel_reason,

data/spec/spec_helper.rb

@@ -25,6 +25,13 @@ require_relative "support/with_command"
 
 ENV["DEBUG"] && Google::APIClient.logger.level = Logger::DEBUG
 
+class MiniTest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+
 module MiniTest
   module Assertions
     # The first parameter must be ```true```, not coercible to true.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: candy_check
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonas Thiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.43.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.43.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -302,7 +302,10 @@ files:
 - lib/candy_check/cli/commands/version.rb
 - lib/candy_check/cli/out.rb
 - lib/candy_check/play_store.rb
+- lib/candy_check/play_store/acknowledger.rb
 - lib/candy_check/play_store/android_publisher_service.rb
+- lib/candy_check/play_store/product_acknowledgements/acknowledgement.rb
+- lib/candy_check/play_store/product_acknowledgements/response.rb
 - lib/candy_check/play_store/product_purchases/product_purchase.rb
 - lib/candy_check/play_store/product_purchases/product_verification.rb
 - lib/candy_check/play_store/subscription_purchases/subscription_purchase.rb
@@ -328,11 +331,17 @@ files:
 - spec/cli/commands/version_spec.rb
 - spec/cli/out_spec.rb
 - spec/fixtures/play_store/random_dummy_key.json
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/acknowledged.yml
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/already_acknowledged.yml
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/refunded.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/permission_denied.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/response_with_empty_body.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/valid_but_not_consumed.yml
 - spec/fixtures/vcr_cassettes/play_store/subscription_purchases/permission_denied.yml
 - spec/fixtures/vcr_cassettes/play_store/subscription_purchases/valid_but_expired.yml
+- spec/play_store/acknowledger_spec.rb
+- spec/play_store/product_acknowledgements/acknowledgement_spec.rb
+- spec/play_store/product_acknowledgements/response_spec.rb
 - spec/play_store/product_purchases/product_purchase_spec.rb
 - spec/play_store/product_purchases/product_verification_spec.rb
 - spec/play_store/subscription_purchases/subscription_purchase_spec.rb
@@ -362,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Check and verify in-app receipts
@@ -382,11 +391,17 @@ test_files:
 - spec/cli/commands/version_spec.rb
 - spec/cli/out_spec.rb
 - spec/fixtures/play_store/random_dummy_key.json
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/acknowledged.yml
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/already_acknowledged.yml
+- spec/fixtures/vcr_cassettes/play_store/product_acknowledgements/refunded.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/permission_denied.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/response_with_empty_body.yml
 - spec/fixtures/vcr_cassettes/play_store/product_purchases/valid_but_not_consumed.yml
 - spec/fixtures/vcr_cassettes/play_store/subscription_purchases/permission_denied.yml
 - spec/fixtures/vcr_cassettes/play_store/subscription_purchases/valid_but_expired.yml
+- spec/play_store/acknowledger_spec.rb
+- spec/play_store/product_acknowledgements/acknowledgement_spec.rb
+- spec/play_store/product_acknowledgements/response_spec.rb
 - spec/play_store/product_purchases/product_purchase_spec.rb
 - spec/play_store/product_purchases/product_verification_spec.rb
 - spec/play_store/subscription_purchases/subscription_purchase_spec.rb