app_store_connect 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef752f09a7b3d400e0ece9a9cf89ec86b1957f794e9950b84608d0f2b6670b1a
-  data.tar.gz: 1fdb0410a3a9c51a93c02bb847879b2ce08d4cd495c59594220dbf98b5d64df7
+  metadata.gz: 5ef9f9632eeaad4a816afb0d83fcaa7ff57e794246d596a5c915336574bfa99c
+  data.tar.gz: 0b428bdd0afd39c066a49bf43fc5471710c70db5e24dd2f65b54d00235db6ef7
 SHA512:
-  metadata.gz: 42edf337f0421cf95315a8c90bca374af21838c704dd41023dd7facc7b437e3646250cb937d5849577791b79efa632764f285d24a648e883fc88a9f8563072aa
-  data.tar.gz: 483c6dd94e28128403f02921bda793550b578da97e8e2b8e3aa1a87029232f4e50dc38f9d774c25270efa184f75561c4258b65ba59055e4ca7437c4bd6f3deaf
+  metadata.gz: 9b47b98cc719f0a1b94ea6feecd68f714a4078f24059e9619bc2ae1bfc92f8e3bbf79432f101e4fbdbf2f3e024501e9c9d9b44ad635074f00426c18007b7b5b1
+  data.tar.gz: 6f23cbefcc7dee9f6ca0d7b2f6795c8111b0b9acfbbfdfbef75d4ff0d9ef6d90fa007d30ac4305881e6b1d102c9bb0ccfe3c835918af5e68d0e23cba9f00c6c8

data/.github/workflows/default.yml

@@ -143,7 +143,7 @@ jobs:
     - name: Upload Release Asset
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKENt  }}
+        GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN  }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: app_store_connect-${{ env.APP_STORE_CONNECT_VERSION }}.gem

data/README.md

@@ -7,25 +7,29 @@ A Ruby interface to the [App Store Connect API](https://developer.apple.com/app-
 
 Add this line to your application's Gemfile:
 
-```ruby
+```Ruby
 gem 'app_store_connect'
 ```
 
 And then execute:
 
-    $ bundle
+```Bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install app_store_connect
+```Bash
+$ gem install app_store_connect
+```
 
 ## Usage
 
-```ruby 
+```ruby
 AppStoreConnect.config = {
-  issuer_id: issuer_id,
-  key_id: key_id,
-  private_key: private_key
+  issuer_id: 'issuer_id',
+  key_id: 'key_id',
+  private_key: File.read(File.new("/Path/AuthKey.p8"))
 }
 
 app_store_connect = AppStoreConnect::Client.new
@@ -58,6 +62,60 @@ app_store_connect.sales_reports(
 )
 ```
 
+### Fetch All Devices
+
+```ruby
+
+fetchAllDevices = app_store_connect.devices
+puts JSON.pretty_generate(fetchAllDevice)
+
+```
+
+### Register a New Device
+
+```ruby
+result = app_store_connect.create_device(
+    name: 'name',
+    platform: 'IOS',
+    udid: 'udid'
+  )
+
+puts JSON.pretty_generate(result)
+```
+
+### Update an App Store Version
+
+```ruby
+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>'
+```
+
+### 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'}}}
+```
+
+## Q&A
+
+### How to understand the `devices, sales_reports, create_bundle_id` keyword seen in the demo?
+
+It's function key from `schema.json` file.
+
+### How to understand `()` in the demo, and when should use it? eg: `create_bundle_id()`, `sales_reports()`
+
+`()` is mean: you have mapped to `http_body_type` in file `schema.json`
+
+### How to set this content in `()`
+
+`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.
+
 ## 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

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport', '>= 6.0.0'
   spec.add_runtime_dependency 'jwt', '>= 1.4', '<= 2.5.0'
-  spec.add_runtime_dependency 'mixpanel-ruby', '<= 2.2.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'factory_bot', '~> 6.2.1'

data/lib/app_store_connect/app_store_version_build_linkage_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class AppStoreVersionBuildLinkageRequest < CreateRequest
+    data do
+      id :build_id
+      type 'builds'
+    end
+  end
+end

data/lib/app_store_connect/app_store_version_create_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class AppStoreVersionCreateRequest < CreateRequest
+    data do
+      type 'appStoreVersions'
+
+      attributes do
+        property :copyright
+        property :earliest_release_date
+        property :platform, required: true
+        property :release_type
+        property :version_string, required: true
+      end
+    end
+  end
+end

data/lib/app_store_connect/app_store_version_phased_release_create_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class AppStoreVersionPhasedReleaseCreateRequest < CreateRequest
+    data do
+      type 'appStoreVersionPhasedReleases'
+
+      attributes do
+        property :phased_release_state
+      end
+    end
+  end
+end

data/lib/app_store_connect/app_store_version_phased_release_update_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class AppStoreVersionPhasedReleaseUpdateRequest < CreateRequest
+    data do
+      id
+      type 'appStoreVersionPhasedReleases'
+
+      attributes do
+        property :phased_release_state
+      end
+    end
+  end
+end

data/lib/app_store_connect/app_store_version_update_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class AppStoreVersionUpdateRequest < CreateRequest
+    data do
+      id
+      type 'appStoreVersions'
+
+      attributes do
+        property :copyright
+        property :earliest_release_date
+        property :release_type
+        property :version_string
+        property :downloadable
+      end
+    end
+  end
+end

data/lib/app_store_connect/build_update_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class BuildUpdateRequest < CreateRequest
+    data do
+      id
+      type 'builds'
+
+      attributes do
+        property :expired
+        property :uses_non_exempt_encryption
+      end
+    end
+  end
+end

data/lib/app_store_connect/client.rb

@@ -6,7 +6,6 @@ require 'app_store_connect/request'
 require 'app_store_connect/schema'
 require 'app_store_connect/client/authorization'
 require 'app_store_connect/client/options'
-require 'app_store_connect/client/usage'
 require 'app_store_connect/client/registry'
 require 'app_store_connect/client/utils'
 
@@ -14,7 +13,6 @@ module AppStoreConnect
   class Client
     def initialize(**kwargs)
       @options = Options.new(kwargs)
-      @usage = Usage.new(@options.slice(*Usage::OPTIONS))
       @authorization = Authorization.new(@options.slice(*Authorization::OPTIONS))
       @registry = Registry.new(@options.slice(*Registry::OPTIONS))
     end
@@ -44,11 +42,10 @@ module AppStoreConnect
     private
 
     def call(web_service_endpoint, **kwargs)
-      raise "invalid http method: #{web_service_endpoint.http_method}" unless %i[get delete post].include?(web_service_endpoint.http_method)
+      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)
 
-      @usage.track
       response = request.execute
 
       Utils.decode(response.body, response.content_type) if response.body
@@ -80,7 +77,7 @@ module AppStoreConnect
         headers: headers
       }
 
-      options[:http_body] = http_body(web_service_endpoint, **kwargs) if web_service_endpoint.http_method == :post
+      options[:http_body] = http_body(web_service_endpoint, **kwargs) if %i[post patch].include?(web_service_endpoint.http_method)
 
       Request.new(**options)
     end

data/lib/app_store_connect/object/data.rb

@@ -13,18 +13,22 @@ module AppStoreConnect
         klass = Class.new do |data|
           include Object::Attributes
           include Object::Type
+          include Object::Id
 
           data.send(:define_method, :initialize) do |**kwargs|
             instance_variable_set('@relationships', kwargs.delete(:relationships).to_h)
             instance_variable_set('@attributes', data::Attributes.new(**kwargs))
+            instance_variable_set('@id', kwargs[id_arg_name])
           end
 
           def to_h
-            {
+            props = {
               relationships: @relationships,
               attributes: attributes.to_h,
               type: type
             }
+            props[:id] = @id if id?
+            props.reject { |_k, v| v.blank? }
           end
         end
 

data/lib/app_store_connect/object/id.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module AppStoreConnect
+  module Object
+    module Id
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def id(arg_name = :id)
+          @include_id_in_body = true
+          @id_arg_name = arg_name
+        end
+      end
+
+      included do
+        def id?
+          self.class.instance_variable_get('@include_id_in_body')
+        end
+
+        def id_arg_name
+          self.class.instance_variable_get('@id_arg_name')
+        end
+      end
+    end
+  end
+end

data/lib/app_store_connect/review_submission_create_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class ReviewSubmissionCreateRequest < CreateRequest
+    data do
+      type 'reviewSubmissions'
+
+      attributes do
+        property :platform, required: true
+      end
+    end
+  end
+end

data/lib/app_store_connect/review_submission_item_create_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class ReviewSubmissionItemCreateRequest < CreateRequest
+    data do
+      type 'reviewSubmissionItems'
+    end
+  end
+end

data/lib/app_store_connect/review_submission_update_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'app_store_connect/create_request'
+
+module AppStoreConnect
+  class ReviewSubmissionUpdateRequest < CreateRequest
+    data do
+      id
+      type 'reviewSubmissions'
+
+      attributes do
+        property :canceled
+        property :submitted
+      end
+    end
+  end
+end

data/lib/app_store_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppStoreConnect
-  VERSION = '0.26.0'
+  VERSION = '0.28.0'
 end

data/lib/app_store_connect.rb

@@ -2,17 +2,27 @@
 
 require 'app_store_connect/client'
 require 'app_store_connect/object/type'
+require 'app_store_connect/object/id'
 require 'app_store_connect/object/attributes'
 require 'app_store_connect/object/properties'
 require 'app_store_connect/object/data'
 require 'app_store_connect/version'
 
-require 'app_store_connect/bundle_id_create_request'
+require 'app_store_connect/app_store_version_build_linkage_request'
+require 'app_store_connect/app_store_version_create_request'
+require 'app_store_connect/app_store_version_phased_release_create_request'
+require 'app_store_connect/app_store_version_phased_release_update_request'
+require 'app_store_connect/app_store_version_update_request'
+require 'app_store_connect/build_update_request'
 require 'app_store_connect/bundle_id_capability_create_request'
+require 'app_store_connect/bundle_id_create_request'
 require 'app_store_connect/certificate_create_request'
 require 'app_store_connect/device_create_request'
-require 'app_store_connect/user_invitation_create_request'
 require 'app_store_connect/profile_create_request'
+require 'app_store_connect/review_submission_create_request'
+require 'app_store_connect/review_submission_item_create_request'
+require 'app_store_connect/review_submission_update_request'
+require 'app_store_connect/user_invitation_create_request'
 
 module AppStoreConnect
   @config = {}