app_store_connect 0.29.0 → 0.38.0

data/Gemfile.lock

@@ -0,0 +1,201 @@
+PATH
+  remote: .
+  specs:
+    app_store_connect (0.38.0)
+      activesupport (>= 6.0.0)
+      jwt (>= 1.4)
+      zeitwerk (>= 2.6.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    async (1.30.3)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.60.1)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.24.0)
+      protocol-http1 (~> 0.15.0)
+      protocol-http2 (~> 0.15.0)
+      traces (>= 0.8.0)
+    async-http-faraday (0.11.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.34.3)
+      async
+    async-pool (0.3.12)
+      async (>= 1.25)
+    cgi (0.3.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    console (1.16.2)
+      fiber-local
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erb (4.0.2)
+      cgi (>= 0.3.3)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.4.1)
+      faraday (>= 0.8)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    fiber-local (1.0.0)
+    formatador (1.1.0)
+    github_changelog_generator (1.16.4)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    jwt (2.7.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    multi_json (1.15.0)
+    nenv (0.3.0)
+    nio4r (2.5.8)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    parallel (1.23.0)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.24.0)
+    protocol-http1 (0.15.0)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.15.0)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    semantic (1.6.1)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    thor (1.2.1)
+    timecop (0.9.6)
+    timers (4.3.5)
+    traces (0.8.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  app_store_connect!
+  bundler
+  erb (~> 4.0.2)
+  factory_bot (~> 6.2.1)
+  github_changelog_generator (= 1.16.4)
+  guard-rspec (~> 4.7.3)
+  pry (~> 0.14.1)
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.50.1)
+  rubyzip
+  semantic (~> 1.6.1)
+  simplecov (~> 0.22.0)
+  timecop (~> 0.9.5)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.3.24

data/README.md

@@ -1,5 +1,14 @@
-# App Store Connect 
-[![Test](https://github.com/kyledecot/app_store_connect/workflows/Test/badge.svg)](https://github.com/kyledecot/app_store_connect/actions) [![Gem Version](https://badge.fury.io/rb/app_store_connect.svg)](https://badge.fury.io/rb/app_store_connect) [![Maintainability](https://api.codeclimate.com/v1/badges/eb09ffa68f84f8da0b6d/maintainability)](https://codeclimate.com/github/kyledecot/app_store_connect/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/eb09ffa68f84f8da0b6d/test_coverage)](https://codeclimate.com/github/kyledecot/app_store_connect/test_coverage)
+
+
+<div align="center">
+  <img src="assets/banner.png">
+
+  <h1>App Store Connect for Ruby</h1>
+
+[![CI/CD](https://github.com/kyledecot/app_store_connect/actions/workflows/default.yml/badge.svg)](https://github.com/kyledecot/app_store_connect/actions/workflows/default.yml)
+</div>
+
+
 
 A Ruby interface to the [App Store Connect API](https://developer.apple.com/app-store-connect/api/)
 
@@ -66,43 +75,124 @@ app_store_connect.sales_reports(
 
 ```ruby
 
-fetchAllDevices = app_store_connect.devices
-puts JSON.pretty_generate(fetchAllDevice)
+devices = app_store_connect.devices
+puts JSON.pretty_generate(devices)
 
 ```
 
 ### Register a New Device
 
 ```ruby
-result = app_store_connect.create_device(
+created_device = app_store_connect.create_device(
     name: 'name',
     platform: 'IOS',
     udid: 'udid'
   )
 
-puts JSON.pretty_generate(result)
+puts JSON.pretty_generate(created_device)
 ```
 
 ### Update an App Store Version
 
 ```ruby
-app_store_connect.update_app_store_version id: '<app-store-version-id>', version_string: '1.0'
+app_store_connect.update_app_store_version(
+  id: '<app-store-version-id>', 
+  version_string: '1.0'
+)
 ```
 
 ### Link a Build to an App Store Version
 
 ```ruby
-app_store_connect.update_app_store_version_build id: '<app-store-version-id>', build_id: '<build-id>'
+app_store_connect.update_app_store_version_build(
+  id: '<app-store-version-id>', 
+  build_id: '<build-id>'
+)
 ```
 
 ### Create a Review Submission Item
 
 ```ruby
-app_store_connect.create_review_submission_item relationships: {reviewSubmission: {data: {id: '<review-submission-id>', type: 'reviewSubmissions'}},
-                                                                appStoreVersion: {data: {id: '<app-store-version-id>', type: 'appStoreVersions'}}}
+app_store_connect.create_review_submission_item(
+  relationships: {
+    reviewSubmission: {
+      data: {
+        id: '<review-submission-id>', 
+        type: 'reviewSubmissions'
+      }
+    },
+    appStoreVersion: {
+      data: {
+        id: '<app-store-version-id>', 
+        type: 'appStoreVersions'
+      }
+    }
+  }
+)
+```
+
+### Create In-App Purchase Price Schedule
+
+```ruby
+app_store_connect.create_in_app_purchase_price_schedule(
+  relationships: {
+    manual_prices: {
+      data: [
+        {
+          type: 'inAppPurchasePrices',
+          id: '${price1}'
+        }
+      ]
+    },
+    in_app_purchase: {
+      data: {
+        type: 'inAppPurchases',
+        id: '<in-app-purchase-id>'
+      }
+    }
+  }, 
+  included: [
+    {
+      type: 'inAppPurchasePrices',
+      id: '${price1}',
+      attributes: {
+        startDate: nil
+      },
+      relationships: {
+        inAppPurchaseV2: {
+          data: {
+            type: 'inAppPurchases',
+            id: '<in-app-purchase-id>'
+          }
+        },
+        inAppPurchasePricePoint: {
+          data: {
+            type: 'inAppPurchasePricePoints',
+            id: '<price-point-id>'
+          }
+        }
+      }
+    }
+  ]
+)
 ```
 
-## Q&A
+### Add or remove access for a Beta Group to a Build
+
+```ruby
+app_store_connect.add_build_beta_groups(
+  id: '<build-id>', 
+  data: [{id: '<beta-group-id>'}]
+)
+
+app_store_connect.delete_build_beta_groups(
+  id: '<build-id>', 
+  data: [{id: '<beta-group-id>'}]
+)
+
+```
+
+## FAQ
 
 ### How to understand the `devices, sales_reports, create_bundle_id` keyword seen in the demo?
 
@@ -116,6 +206,18 @@ It's function key from `schema.json` file.
 
 `http_body_type` have a value type. Based on this value, we can find the definition of the relevant configuration in the source code of ruby.
 
+### How to include related resources?
+
+```ruby
+app_store_connect.in_app_purchase(id: 123, include: 'appStoreReviewScreenshot,pricePoints')
+```
+
+### How to filter fields?
+
+```ruby
+app_store_connect.in_app_purchase(id: 123, fields: 'name,productId')
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `rake console` for an interactive prompt that will allow you to experiment.

data/app_store_connect.gemspec

@@ -24,17 +24,21 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_runtime_dependency 'activesupport', '>= 6.0.0'
-  spec.add_runtime_dependency 'jwt', '>= 1.4', '<= 2.5.0'
+  spec.add_runtime_dependency 'jwt', '>= 1.4'
+  spec.add_runtime_dependency 'zeitwerk', '>= 2.6.7'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'erb', '~> 4.0.2'
   spec.add_development_dependency 'factory_bot', '~> 6.2.1'
+  spec.add_development_dependency 'github_changelog_generator', '1.16.4'
   spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
   spec.add_development_dependency 'pry', '~> 0.14.1'
   spec.add_development_dependency 'rake', '~> 13.0.6'
-  spec.add_development_dependency 'rspec', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop', '~> 1.36.0'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.50.1'
+  spec.add_development_dependency 'rubyzip'
   spec.add_development_dependency 'semantic', '~> 1.6.1'
-  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'timecop', '~> 0.9.5'
   spec.add_development_dependency 'webmock', '~> 3.18.1'
 end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'app_store_connect'
+require 'rake'
+
+load './lib/tasks/console.rake'
+
+Rake::Task['console'].execute

data/lib/app_store_connect/app_store_version_build_linkage_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionBuildLinkageRequest < CreateRequest
+  class AppStoreVersionBuildLinkageRequest < Request::Body
     data do
       id :build_id
       type 'builds'

data/lib/app_store_connect/app_store_version_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionCreateRequest < CreateRequest
+  class AppStoreVersionCreateRequest < Request::Body
     data do
       type 'appStoreVersions'
 

data/lib/app_store_connect/app_store_version_phased_release_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionPhasedReleaseCreateRequest < CreateRequest
+  class AppStoreVersionPhasedReleaseCreateRequest < Request::Body
     data do
       type 'appStoreVersionPhasedReleases'
 

data/lib/app_store_connect/app_store_version_phased_release_update_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionPhasedReleaseUpdateRequest < CreateRequest
+  class AppStoreVersionPhasedReleaseUpdateRequest < Request::Body
     data do
       id
       type 'appStoreVersionPhasedReleases'

data/lib/app_store_connect/app_store_version_release_request_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionReleaseRequestCreateRequest < CreateRequest
+  class AppStoreVersionReleaseRequestCreateRequest < Request::Body
     data do
       type 'appStoreVersionReleaseRequests'
     end

data/lib/app_store_connect/app_store_version_update_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class AppStoreVersionUpdateRequest < CreateRequest
+  class AppStoreVersionUpdateRequest < Request::Body
     data do
       id
       type 'appStoreVersions'

data/lib/app_store_connect/base.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module AppStoreConnect
+  class Base
+    def initialize(**kwargs)
+      @options = Client::Options.new(kwargs)
+      @authorization = Client::Authorization.new(@options.slice(*Client::Authorization::OPTIONS))
+      @registry = Client::Registry.new(@options.slice(*Client::Registry::OPTIONS))
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      web_service_endpoint_aliases.include?(method_name) || super
+    end
+
+    def method_missing(method_name, **kwargs)
+      super unless web_service_endpoint_aliases.include?(method_name)
+
+      web_service_endpoint = web_service_endpoint_by(method_name)
+
+      call(web_service_endpoint, **kwargs)
+    end
+
+    # :nocov:
+    def inspect
+      "#<#{self.class.name}:#{object_id}>"
+    end
+    # :nocov:
+
+    def web_service_endpoint_aliases
+      @registry.keys
+    end
+
+    private
+
+    def call(web_service_endpoint, **kwargs)
+      raise "invalid http method: #{web_service_endpoint.http_method}" unless %i[get delete post patch].include?(web_service_endpoint.http_method)
+
+      request = build_request(web_service_endpoint, **kwargs)
+
+      response = request.execute
+
+      Client::Utils.decode(response.body, response.content_type) if response.body
+    end
+
+    def build_uri(web_service_endpoint, **kwargs)
+      URI(web_service_endpoint
+        .url
+        .gsub(/(\{(\w+)\})/) { kwargs.fetch(Regexp.last_match(2).to_sym) })
+    end
+
+    def web_service_endpoint_by(alias_sym)
+      @registry[alias_sym]
+    end
+
+    def http_body(web_service_endpoint, **kwargs)
+      Client::Utils.encode("AppStoreConnect::#{web_service_endpoint.http_body_type}"
+        .constantize
+        .new(**kwargs)
+        .to_h)
+    end
+
+    def build_request(web_service_endpoint, **kwargs)
+      options = {
+        kwargs: kwargs,
+        web_service_endpoint: web_service_endpoint,
+        http_method: web_service_endpoint.http_method,
+        uri: build_uri(web_service_endpoint, **kwargs),
+        headers: headers
+      }
+
+      options[:http_body] = http_body(web_service_endpoint, **kwargs) if web_service_endpoint.http_body_type.present?
+
+      Request.new(**options)
+    end
+
+    def headers
+      {
+        'Authorization' => "Bearer #{@authorization.token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+  end
+end

data/lib/app_store_connect/beta_build_localization_create_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AppStoreConnect
+  class BetaBuildLocalizationCreateRequest < Request::Body
+    data do
+      type 'betaBuildLocalizations'
+
+      attributes do
+        property :locale, required: true
+        property :whats_new
+      end
+    end
+  end
+end

data/lib/app_store_connect/beta_build_localization_modify_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AppStoreConnect
+  class BetaBuildLocalizationModifyRequest < Request::Body
+    data do
+      id
+      type 'betaBuildLocalizations'
+
+      attributes do
+        property :whats_new
+      end
+    end
+  end
+end

data/lib/app_store_connect/build_update_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class BuildUpdateRequest < CreateRequest
+  class BuildUpdateRequest < Request::Body
     data do
       id
       type 'builds'

data/lib/app_store_connect/bundle_id_capability_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class BundleIdCapabilityCreateRequest < CreateRequest
+  class BundleIdCapabilityCreateRequest < Request::Body
     data do
       type 'bundleIdCapabilities'
 

data/lib/app_store_connect/bundle_id_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class BundleIdCreateRequest < CreateRequest
+  class BundleIdCreateRequest < Request::Body
     data do
       type 'bundleIds'
 

data/lib/app_store_connect/certificate_create_request.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'app_store_connect/create_request'
-
 module AppStoreConnect
-  class CertificateCreateRequest < CreateRequest
+  class CertificateCreateRequest < Request::Body
     data do
       type 'certificates'