fastlane-plugin-amazon_app_submission 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d110e787d9b378a8ee45632bc6437a3527c373be5e20a3af723fed43e71737
-  data.tar.gz: eb8965c6f69a51b561dd42bcda3775f531597118bcd978ecb1832a67bc9402b4
+  metadata.gz: e0e6f5db2e79b36447f13ff25a3e8f8573cbdd273578ed7ede2f645f4a534b33
+  data.tar.gz: c76ce77ad9e439cf5d68a8b672c8e714488f5606f2cd27ff2958ba551a2d4e2a
 SHA512:
-  metadata.gz: d38c40afad80cde84cd62c6a2a25b166f4ff56963072325638ca1bf720f417a0ad2d397f3c8d8384986f9cc9aa075e05948a45f2585f5157dc569582342aeebe
-  data.tar.gz: bc499eda4df532380def700a045bbb186a80cf7a5c6a91232698301ac2671ad29d68ad9e05b8ccec4d264351488af704fe765796e51d27f98c053a0e3ae7a213
+  metadata.gz: 3996ee47b85cb300b2d5ea07216960aa7fce672ff0dab042216018d83895b127f50b04bff9dcac283a2766a3ae3b17bd4ce475b21ba23a687d88f30313c06211
+  data.tar.gz: a9ebb48964cade0bfa36a415a888629ee51710575b99baf731bffffaab9e580ddf5f0ea6107c34803c1283473f6a1e6ceff15f940aabc90215df3f5201998bbf

data/README.md

@@ -1 +1,70 @@
-# amazon-app-store-submission
+# fastlane-plugin-amazon-app-submission
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `amazon_app_submission`, add it to your project by running:
+
+```bash
+fastlane add_plugin amazon_app_submission
+```
+
+## About amazon_app_submission
+
+* Project link on rubygems [fastlane-plugin-amazon_app_submission](https://rubygems.org/gems/fastlane-plugin-amazon_app_submission)
+* Upload the apk to the Amazon Appstore using the [App Submission API](https://developer.amazon.com/docs/app-submission-api/overview.html).
+* App Submission API Reference is [App Submission RESTFUL API](https://developer.amazon.com/docs/app-submission-api/appsub-api-ref.html).
+
+## Usage
+
+Following the [guide](https://developer.amazon.com/docs/app-submission-api/auth.html), you will need to generate `client_id` and `client_secret` to access the console in advance.
+
+For `app_id` you can get it from Amazon app dashboard
+Please set the apk path to `apk_path` field
+
+Call `amazon_app_submission` in your Fastfile.
+
+```ruby
+  amazon_app_submission(
+    client_id: "<CLIENT_ID>",
+    client_secret: "<CLIENT_SECRET>",
+    app_id: "<APP_ID>",
+    # Optional
+    apk_path: "<APK_PATH>",
+    upload_apk: true,
+    changelogs_path:  "<CHANGELOG_PATH>",
+    upload_changelogs: false,
+    submit_for_review: false
+  )
+```
+
+| param | default value | optional | description
+|:----------|:-----------:|:-----------:|:-----------:|
+client_id | - | false | getting client id from Amazon developer console dashboard
+client_secret | - | false | getting client secret from Amazon developer console dashboard
+app_id | - | false | getting app id from Amazon developer console dashboard
+apk_path | - | true | link where you storing the release apk
+upload_apk  | true  | true  | set this to false to not upload an apk. can be used to only upload changelogs
+changelogs_path | "" | true | setting the folder path where you have the change logs with different file for each language, if language file not found it will use default.txt
+upload_changelogs | false | true | updating the change logs for the upcoming version
+submit_for_review | false | true | submit the uploaded APK to the store  
+
+* changelogs folder files name should be:
+
+| Language | File name
+|:----------|:-----------:|
+English-US | en-US.txt
+English-British | en-GB.txt
+English-Australia | en-AU.txt
+English-India | en-IN.txt
+Italian |it-IT.txt
+French | fr-FR.txt
+Spanish | es-ES.txt
+Spanish-Mexican | es-MX.txt
+Other | default.txt  
+
+## Testing
+
+For testing the plugin locally you have to get `client_id`, `client_secret`, `app_id` and `apk_path` in fastlane/Fastfile
+please check Usage step to see how you can get them.
+
+Then call `bundle exec fastlane test` in your terminal

data/lib/fastlane/plugin/amazon_app_submission/actions/amazon_app_submission_action.rb

@@ -1,4 +1,4 @@
-  require 'fastlane/action'
+require 'fastlane/action'
 require_relative '../helper/amazon_app_submission_helper'
 
 module Fastlane
@@ -11,35 +11,58 @@ module Fastlane
 
         if token.nil?
           UI.message("Cannot retrieve token, please check your client ID and client secret")
-        else
-          UI.message("the token is #{token}")
-        end  
+        end
 
+        UI.message("Getting current edit")
         current_edit_id, edit_eTag = Helper::AmazonAppSubmissionHelper.open_edit(token, params[:app_id])
-        
+
         if current_edit_id.nil?
+        UI.message("Current edit not found, creating a new edit")
         Helper::AmazonAppSubmissionHelper.create_new_edit(token, params[:app_id])
         current_edit_id, edit_eTag = Helper::AmazonAppSubmissionHelper.open_edit(token, params[:app_id])
         end  
-       
-        current_apk_id = Helper::AmazonAppSubmissionHelper.get_current_apk_id(token, params[:app_id], current_edit_id)
 
-        current_apk_eTag = Helper::AmazonAppSubmissionHelper.get_current_apk_etag(token, params[:app_id], current_edit_id, current_apk_id)
+        if current_edit_id.nil?
+        UI.error("Creating new edit failed!")
+        return
+        end
+
+        if params[:upload_apk]
+          UI.message("Get current apk id")
+          current_apk_id = Helper::AmazonAppSubmissionHelper.get_current_apk_id(token, params[:app_id], current_edit_id)
 
-        replace_apk_response_code =  Helper::AmazonAppSubmissionHelper.replaceExistingApk(token, params[:app_id], current_edit_id, current_apk_id, current_apk_eTag,  params[:apk_path])
-        
-       if replace_apk_response_code === 200
-        Helper::AmazonAppSubmissionHelper.commit_edit(token, params[:app_id], current_edit_id, edit_eTag)
-       end 
+          UI.message("Get current apk ETag")
+          current_apk_eTag = Helper::AmazonAppSubmissionHelper.get_current_apk_etag(token, params[:app_id], current_edit_id, current_apk_id)
 
+          UI.message("Replacing the apk with apk from #{params[:apk_path]}")
+          replace_apk_response_code, replace_apk_response =  Helper::AmazonAppSubmissionHelper.replaceExistingApk(token, params[:app_id], current_edit_id, current_apk_id, current_apk_eTag, params[:apk_path])
+        end
+
+        if params[:upload_changelogs]
+          UI.message("Updating the changelogs")
+          Helper::AmazonAppSubmissionHelper.update_listings( token, params[:app_id],current_edit_id, params[:changelogs_path], params[:changelogs_path])
+        end
+
+        if params[:upload_apk]
+          if replace_apk_response_code == '200'
+            if params[:submit_for_review]
+               UI.message("Submitting to Amazon app store")
+               Helper::AmazonAppSubmissionHelper.commit_edit(token, params[:app_id], current_edit_id, edit_eTag)
+            end
+          else
+            UI.message("Amazon app submission failed at replacing the apk error code #{replace_apk_response_code} and error respones #{replace_apk_response}")
+            return
+          end
+        end
+        UI.message("Amazon app submission finished successfully!")
       end
 
       def self.description
-        "test"
+        "Fastlane plugin for Amazon App Submissions"
       end
 
       def self.authors
-        ["mohammedhemaid"]
+        ["mohammedhemaid", "saschagraeff"]
       end
 
       def self.return_value
@@ -48,7 +71,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        "test"
+        "Fastlane plugin for Amazon App Submissions"
       end
 
       def self.available_options
@@ -58,7 +81,7 @@ module Fastlane
                                  description: "Amazon App Submission Client ID",
                                     optional: false,
                                         type: String),
-  
+
             FastlaneCore::ConfigItem.new(key: :client_secret,
                                     env_name: "AMAZON_APP_SUBMISSION_CLIENT_SECRET",
                                  description: "Amazon App Submission Client Secret",
@@ -71,12 +94,41 @@ module Fastlane
                                     optional: false,
                                         type: String),
 
+            FastlaneCore::ConfigItem.new(key: :upload_apk,
+                                    env_name: "AMAZON_APP_SUBMISSION_UPLOAD_APK",
+                                 description: "Amazon App Submission upload apk file",
+                               default_value: true,
+                                    optional: true,
+                                        type: Boolean),
+
             FastlaneCore::ConfigItem.new(key: :apk_path,
                                     env_name: "AMAZON_APP_SUBMISSION_APK_PATH",
                                  description: "Amazon App Submission APK Path",
-                                    optional: false,
-                                        type: String)
-  
+                               default_value: "",
+                                    optional: true,
+                                        type: String),
+
+            FastlaneCore::ConfigItem.new(key: :changelogs_path,
+                                    env_name: "AMAZON_APP_SUBMISSION_CHANGELOGS_PATH",
+                                 description: "Amazon App Submission changelogs path",
+                               default_value: "",
+                                    optional: true,
+                                        type: String),
+
+            FastlaneCore::ConfigItem.new(key: :upload_changelogs,
+                                    env_name: "AMAZON_APP_SUBMISSION_SKIP_UPLOAD_CHANGELOGS",
+                                 description: "Amazon App Submission upload changelogs",
+                               default_value: false,
+                                    optional: true,
+                                        type: Boolean),
+
+            FastlaneCore::ConfigItem.new(key: :submit_for_review,
+                                    env_name: "AMAZON_APP_SUBMISSION_SUBMIT_FOR_REVIEW",
+                                 description: "Amazon App Submission submit for review",
+                               default_value: false,
+                                    optional: true,
+                                        type: Boolean)
+
           # FastlaneCore::ConfigItem.new(key: :your_option,
           #                         env_name: "AMAZON_APP_SUBMISSION_YOUR_OPTION",
           #                      description: "A description of your option",

data/lib/fastlane/plugin/amazon_app_submission/helper/amazon_app_submission_helper.rb

@@ -13,10 +13,6 @@ module Fastlane
 
       def self.get_token(client_id, client_secret)
         UI.important("Fetching app access token")
-
-        UI.important("client_id #{client_id}")
-        UI.important("client_secret #{client_secret}")
-
         uri = URI('https://api.amazon.com/auth/o2/token')
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
@@ -26,14 +22,17 @@ module Fastlane
 
         res = http.request(req)
         result_json = JSON.parse(res.body)
-
         auth_token = "Bearer #{result_json['access_token']}"
 
+        if result_json['error'] == 'invalid_scope'
+          UI.message("It seems that the provided security profile is not attached to the App Submission API")
+        end
+
         return auth_token
       end
 
       def self.create_new_edit(token, app_id)
-        
+
         create_edit_path = "/v1/applications/#{app_id}/edits"
         create_edit_url = BASE_URL + create_edit_path
 
@@ -48,12 +47,12 @@ module Fastlane
 
         res = http.request(req)
         current_edit = JSON.parse(res.body)
-
+        
         return current_edit['id']
       end
-      
+
       def self.open_edit(token, app_id)
-        
+
         get_edit_path = "/v1/applications/#{app_id}/edits"
         get_edit_url = BASE_URL + get_edit_path
 
@@ -69,17 +68,15 @@ module Fastlane
         res = http.request(req)
         current_edit = JSON.parse(res.body)
 
-        UI.message("eTag #{res.header['ETag']}")
-
         return current_edit['id'], res.header['ETag']
       end
 
-      def self.get_current_apk_etag(token, app_id, edit_id, apk_id)
+      def self.get_current_apk_id(token, app_id, edit_id)
 
-        get_apks_etag = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/#{apk_id}"
-        get_apks_etag_url = BASE_URL + get_apks_etag
+        get_apks_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks"
+        get_apks_url = BASE_URL + get_apks_path
 
-        uri = URI(get_apks_etag_url)
+        uri = URI(get_apks_url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         req = Net::HTTP::Get.new(
@@ -89,15 +86,20 @@ module Fastlane
         )
 
         res = http.request(req)
-        return res.header['ETag']
+        if !res.body.nil?
+          apks = JSON.parse(res.body)
+          firstAPK = apks.kind_of?(Array) ? apks[0] : apks
+          apk_id = firstAPK['id']
+          return apk_id
+        end
       end
 
-      def self.get_current_apk_id(token, app_id, edit_id)
+      def self.get_current_apk_etag(token, app_id, edit_id, apk_id)
 
-        get_apks_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks"
-        get_apks_url = BASE_URL + get_apks_path
+        get_apks_etag = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/#{apk_id}"
+        get_apks_etag_url = BASE_URL + get_apks_etag
 
-        uri = URI(get_apks_url)
+        uri = URI(get_apks_etag_url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         req = Net::HTTP::Get.new(
@@ -107,43 +109,47 @@ module Fastlane
         )
 
         res = http.request(req)
-        if !res.body.nil? 
-        apks = JSON.parse(res.body)
-        firstAPK = apks[0]
-        apk_id = firstAPK['id']
-        return apk_id
-        end
+        return res.header['ETag']
       end
 
-      def self.replaceExistingApk(token, app_id, edit_id, apk_id, eTag, apk_path)
+      def self.replaceExistingApk(token, app_id, edit_id, apk_id, eTag, apk_path, should_retry = true)
 
         replace_apk_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/#{apk_id}/replace"
         local_apk = File.open(apk_path, "r").read
-              
+
+        apk_uri = URI.parse(apk_path)
+        apk_name = apk_uri.path.split('/').last
+
         replace_apk_url = BASE_URL + replace_apk_path
         uri = URI(replace_apk_url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
-        http.write_timeout = 10000
+        http.write_timeout = 1000
         req = Net::HTTP::Put.new(
             uri.path,
             'Authorization' => token,
             'Content-Type' => 'application/vnd.android.package-archive',
+            'fileName' => apk_name,
             'If-Match' => eTag
             )
 
         req.body = local_apk
         res = http.request(req)
-        return res.code
+        replace_apk_response = JSON.parse(res.body)
+        # Retry again if replace failed
+        if res.code == '412' && should_retry
+          UI.message("replacing the apk failed, retrying uploading it again...")
+          replaceExistingApk(token, app_id, edit_id, apk_id, eTag, apk_path, false)
+          return
+        end
+        return res.code, replace_apk_response
       end
 
       def self.delete_apk(token, app_id, edit_id, apk_id, eTag)
 
-        delete_apk_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/#{apk_id}" 
+        delete_apk_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/#{apk_id}"
         delete_apk_url = BASE_URL + delete_apk_path
 
-        UI.message("delete_apk_url #{delete_apk_url}")
-
         uri = URI(delete_apk_url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
@@ -160,15 +166,15 @@ module Fastlane
 
       def self.uploadNewApk(token, app_id, edit_id, apk_path)
 
-        add_apk_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/upload" 
+        add_apk_path = "/v1/applications/#{app_id}/edits/#{edit_id}/apks/upload"
         add_apk_url = BASE_URL + add_apk_path
         local_apk = File.open(apk_path, 'r').read
 
         uri = URI(add_apk_url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
-        http.write_timeout = 10000
-        http.read_timeout = 10000
+        http.write_timeout = 1000
+        http.read_timeout = 1000
         req = Net::HTTP::Post.new(
             uri.path,
             'Authorization' => token,
@@ -180,9 +186,89 @@ module Fastlane
         result_json = JSON.parse(res.body)
       end
 
+      def self.update_listings(token, app_id, edit_id, changelogs_path, upload_changelogs)
+
+        listings_path = "/v1/applications/#{app_id}/edits/#{edit_id}/listings"
+        listings_url = BASE_URL + listings_path
+
+        uri = URI(listings_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Get.new(
+            uri.path,
+            'Authorization' => token,
+            'Content-Type' => 'application/json'
+        )
+
+        res = http.request(req)
+        listings_response = JSON.parse(res.body)
+
+        # Iterating over the languages for getting the ETag.
+        listings_response['listings'].each do |lang, listing|
+        lang_path = "/v1/applications/#{app_id}/edits/#{edit_id}/listings/#{lang}"
+        lang_url = BASE_URL + lang_path
+
+        uri = URI(lang_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Get.new(
+              uri.path,
+              'Authorization' => token,
+              'Content-Type' => 'application/json'
+          )
+        etag_response = http.request(req)
+        etag = etag_response.header['Etag']
+
+        recent_changes = find_changelog(
+          changelogs_path,
+          lang,
+          upload_changelogs,
+        )
+
+        listing[:recentChanges] = recent_changes
+
+        update_listings_path = "/v1/applications/#{app_id}/edits/#{edit_id}/listings/#{lang}"
+        update_listings_url = BASE_URL + update_listings_path
+
+        uri = URI(update_listings_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Put.new(
+            uri.path,
+            'Authorization' => token,
+            'Content-Type' => 'application/json',
+            'If-Match' => etag
+        )
+
+        req.body = listing.to_json
+        res = http.request(req)
+        listings_response = JSON.parse(res.body)
+        end
+      end
+
+      def self.find_changelog(changelogs_path, language, upload_changelogs)
+        # The Amazon appstore requires you to enter changelogs before reviewing.
+        # Therefore, if there is no metadata, hyphen text is returned.
+        changelog_text = '-'
+        return changelog_text if !upload_changelogs
+
+        path = File.join(changelogs_path, "#{language}.txt")
+        if File.exist?(path) && !File.zero?(path)
+          changelog_text = File.read(path, encoding: 'UTF-8')
+        else
+          defalut_changelog_path = File.join(changelogs_path, 'default.txt')
+          if File.exist?(defalut_changelog_path) && !File.zero?(defalut_changelog_path)
+            changelog_text = File.read(defalut_changelog_path, encoding: 'UTF-8')
+          else
+            UI.message("Could not find changelog for language '#{language}' at path #{path}...")
+          end
+        end
+        changelog_text
+      end
+
       def self.commit_edit(token, app_id, edit_id, eTag)
 
-        commit_edit_path = "/v1/applications/#{app_id}/edits/#{edit_id}/commit" 
+        commit_edit_path = "/v1/applications/#{app_id}/edits/#{edit_id}/commit"
         commit_edit_url = BASE_URL + commit_edit_path
 
         uri = URI(commit_edit_url)
@@ -197,10 +283,6 @@ module Fastlane
         res = http.request(req)
         result_json = JSON.parse(res.body)
       end
-
-      def self.show_message
-        UI.message("Hello from the amazon_app_submission plugin helper!")
-      end
     end
   end
 end

data/lib/fastlane/plugin/amazon_app_submission/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module AmazonAppSubmission
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-amazon_app_submission
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - mohammedhemaid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,7 @@ files:
 - lib/fastlane/plugin/amazon_app_submission/actions/amazon_app_submission_action.rb
 - lib/fastlane/plugin/amazon_app_submission/helper/amazon_app_submission_helper.rb
 - lib/fastlane/plugin/amazon_app_submission/version.rb
-homepage: 
+homepage: https://github.com/ugroupmedia/fastlane-plugin-amazon-app-store-submission
 licenses:
 - MIT
 metadata: {}