app_store_server_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07df57effd89ae7c0c29815f4fbf1c0dc8e6aaefb9fd861b58a9f95fdde949b8
+  data.tar.gz: ca9299f9e20ab8de49433bde8973c940c06807640b87bb90f927627a01569960
+SHA512:
+  metadata.gz: ba81d99883c98491d86a8d9f5d0b454de5abb8eaffc43b089c7fe8885665ab6bac6014e9a40bfaba420279892505d6cf6e3c87700f653b244d7303e08abb9f5c
+  data.tar.gz: 5a68dc8f2b3e1ef14b1da24457eb0682696750b393df0dc35de1b4b97089119d0fe48eb5a0e0e7e26438993679877fd1accf60431125bc79cf0267c750618aa5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at csrutil@protonmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 tsaokoming
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# app-store-server-api
+A Ruby client for the [App Store Server API](https://developer.apple.com/documentation/appstoreserverapi).
+
+## Features
+
+- Transaction history, subscription status
+- Notification test and history endpoints
+- Manages authentication tokens for you
+- Helpers to decode JWS items
+- Performs certificate validation against Apple's CA.
+
+## Requirements
+
+**Ruby 3.x**
+
+## Installation
+```bash
+gem install app_store_server_api
+```
+
+## Usage
+
+### Prerequisites
+To get started, you must obtain the following:
+- An [API key](https://developer.apple.com/documentation/appstoreserverapi/creating_api_keys_to_use_with_the_app_store_server_api)
+- The ID of the key
+- Your [issuer ID](https://developer.apple.com/documentation/appstoreserverapi/generating_tokens_for_api_requests)
+
+### Configure
+
+**In your Rails application, create a client configure**
+
+```ruby
+# my_app/config/app_store_server.yml
+default: &default
+  private_key: |
+    -----BEGIN PRIVATE KEY-----
+  key_id: S4AZ693A4A
+  issuer_id: fd02853a-1290-4854-875e-918c86459b3e
+  bundle_id: com.myapp.app
+  environment: sandbox
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default
+```
+
+**Load the configure**
+
+```ruby
+# my_app/config/application.rb
+
+config.app_store_server = config_for :app_store_server
+```
+
+**Create a global client**
+
+```ruby
+# my_app/config/initializers/app_store_server_api.rb
+
+AppStoreServerApiClient = AppStoreServerApi::Client.new(**Rails.configuration.app_store_server)
+```
+
+### API
+
+**Get Transaction History**
+
+```ruby
+data = client.get_transaction_history(transaction_id,
+  params: {
+    sort: "DESCENDING"
+  })
+
+transactions = AppStoreServerApi::Utils::Decoder.decode_transactions signed_transactions: data["signedTransactions"]
+```
+
+**Get Transaction Info**
+
+```ruby
+client.get_transaction_info transaction_id
+```
+
+**Get All Subscription Statuses**
+```ruby
+response = client.get_all_subscription_statuses transaction_id
+
+signed = response["data"].first["lastTransactions"].first["signedTransactionInfo"]
+
+transaction = AppStoreServerApi::Utils::Decoder.decode_transaction signed_transaction: signed
+```
+
+**Request a Test Notification**
+
+```ruby
+client.request_a_test_notification
+```
+
+
+**Utils**
+
+- AppStoreServerApi::Utils::Decoder.decode_transaction
+- AppStoreServerApi::Utils::Decoder.decode_jws!
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AppStoreServerApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mnyify/app_store_server_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/app_store_server_api/client.rb

@@ -0,0 +1,144 @@
+require "jwt"
+
+require "net/http"
+require "uri"
+require "json"
+require "openssl"
+
+module AppStoreServerApi
+  class Client
+    def initialize(
+      private_key:, # p8 key
+      key_id:,      # Your private key ID from App Store Connect (Ex: 2X9R4HXF34)
+      issuer_id:,   # Your issuer ID from the Keys page in App Store Connect
+      bundle_id:,   # Your app’s bundle ID (Ex: “com.example.testbundleid”)
+      environment: :production
+    )
+
+      @private_key = private_key
+      @key_id = key_id
+      @issuer_id = issuer_id
+      @bundle_id = bundle_id
+      @base_url = app_store_base_url environment
+    end
+
+    def get_transaction_history(transaction_id, params: nil)
+      request_uri("#{@base_url}/inApps/v1/history/#{transaction_id}", params: params)
+    end
+
+    def get_transaction_info(transaction_id, params: nil)
+      request_uri("#{@base_url}/inApps/v1/transactions/#{transaction_id}", params: params)
+    end
+
+    # status
+    #
+    # 1, The auto-renewable subscription is active.
+    # 2, The auto-renewable subscription is expired.
+    # 3, The auto-renewable subscription is in a billing retry period.
+    # 4, The auto-renewable subscription is in a Billing Grace Period.
+    # 5, The auto-renewable subscription is revoked. The App Store refunded the transaction or revoked it from Family Sharing
+    def get_all_subscription_statuses(transaction_id, params: nil)
+      request_uri("#{@base_url}/inApps/v1/subscriptions/#{transaction_id}", params: params)
+    end
+
+    def request_a_test_notification
+      request_uri "#{@base_url}/inApps/v1/notifications/test", http_method: :post
+    end
+
+    private
+
+    def request_uri(uri, http_method: :get, headers: nil, params: nil, timeout: 5)
+      uri = URI(uri)
+      uri.query = URI.encode_www_form(params) if params && http_method == :get
+
+      # Create a new Net::HTTP object and set timeout
+      http = Net::HTTP.new(uri.host, 443)
+
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      # Make the HTTP request
+      begin
+        request = (http_method == :get) ? Net::HTTP::Get.new(uri.request_uri) : Net::HTTP::Post.new(uri.request_uri)
+
+        request.initialize_http_header headers || request_headers
+
+        if http_method == :post
+          request.body = params.to_json
+        end
+
+        response = http.request request
+
+        # Raise an error if the response is not successful
+        response.value
+
+        # Parse response body to JSON
+        JSON.parse response.body
+      rescue Net::OpenTimeout
+        raise "Timeout while opening the connection"
+      rescue Net::ReadTimeout
+        raise "Timeout while reading data"
+      rescue => e
+        raise "Error: #{e.message}"
+      end
+    end
+
+    def bearer_token
+      if @bearer_token
+        begin
+          JWT.decode @bearer_token, OpenSSL::PKey::EC.new(@private_key), true, {algorithm: "ES256"}
+          return @bearer_token
+        rescue JWT::ExpiredSignature
+        end
+      end
+
+      @bearer_token = generate_bearer_token(
+        key_id: @key_id,
+        issuer_id: @issuer_id,
+        private_key: @private_key,
+        bundle_id: @bundle_id
+      )
+    end
+
+    def request_headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{bearer_token}"
+      }
+    end
+
+    def generate_bearer_token(
+      key_id:,
+      issuer_id:,
+      bundle_id:,
+      private_key:,
+      audience: "appstoreconnect-v1", # appstoreconnect-v1,
+      issued_at: Time.now.to_i, # The time at which you issue the token, in UNIX time, in seconds (Ex: 1623085200)
+      expired_in: 3600,
+      alg: "ES256",
+      typ: "JWT"
+    )
+
+      payload = {
+        iss: issuer_id,
+        iat: issued_at,
+        exp: expired_in + issued_at,
+        aud: audience,
+        bid: bundle_id
+      }
+
+      JWT.encode payload, OpenSSL::PKey::EC.new(private_key), alg, {typ: typ, kid: key_id}
+    end
+
+    def app_store_base_url environment
+      if environment == :production
+        "https://api.storekit.itunes.apple.com"
+      else
+        "https://api.storekit-sandbox.itunes.apple.com"
+      end
+    end
+  end
+end

data/lib/app_store_server_api/utils/decoder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "jwt"
+
+module AppStoreServerApi
+  module Utils
+    module Decoder
+      module_function
+
+      def decode_jws! jws
+        payload, = JWT.decode(jws, nil, true, algorithm: "ES256") do |header|
+          certs = header["x5c"].map { |c| OpenSSL::X509::Certificate.new Base64.urlsafe_decode64(c) }
+          apple_root_cas.include? certs.last or raise JWT::DecodeError, "Missing root certificate"
+          certs.each_cons(2).all? { |a, b| a.verify(b.public_key) } or raise JWT::DecodeError, "Broken trust chain"
+          certs[0].public_key
+        end
+        payload
+      end
+
+      def decode_transaction(signed_transaction:)
+        decode_jws! signed_transaction
+      end
+
+      def decode_transactions(signed_transactions:)
+        signed_transactions.map do |signed_transaction|
+          decode_transaction signed_transaction: signed_transaction
+        end
+      end
+
+      def apple_root_cas
+        Dir.glob(File.join(__dir__, "certs", "*.cer")).map do |filename|
+          OpenSSL::X509::Certificate.new File.read(filename)
+        end
+      end
+    end
+  end
+end

data/lib/app_store_server_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AppStoreServerApi
+  VERSION = "0.1.0"
+end

data/lib/app_store_server_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "app_store_server_api/utils/decoder"
+require_relative "app_store_server_api/client"
+require_relative "app_store_server_api/version"
+
+module AppStoreServerApi
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/app_store_server_api.rbs

@@ -0,0 +1,4 @@
+module AppStoreServerApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: app_store_server_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tsaokoming
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Manage your customers' App Store transactions from your server.
+email:
+- tsaokoming@mnyify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/app_store_server_api.rb
+- lib/app_store_server_api/client.rb
+- lib/app_store_server_api/utils/certs/AppleRootCA-G3.cer
+- lib/app_store_server_api/utils/certs/AppleWWDRCAG6.cer
+- lib/app_store_server_api/utils/decoder.rb
+- lib/app_store_server_api/version.rb
+- sig/app_store_server_api.rbs
+homepage: https://github.com/mnyify/app_store_server_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mnyify/app_store_server_api
+  source_code_uri: https://github.com/mnyify/app_store_server_api
+  changelog_uri: https://github.com/mnyify/app_store_server_api/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: App Store Server API
+test_files: []