fastlane-plugin-amazon_app_submission 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0973749b49a3b53f7cfde27b869f789befd6909ce53d7de52329b501d42ab3f
-  data.tar.gz: 9b6ca51c1f57dcfbebb2086bfe2a8780d78c710b107c75f55257b2ceed978057
+  metadata.gz: f52eed564ae7f2ef5d42738c00c3f45a71e0438cb63b6bcad67b53f0c646562b
+  data.tar.gz: 623727ff4a80c261d9ff34c28b012b2c2f067295eabdb3cf40ee2dbbc1f0e40c
 SHA512:
-  metadata.gz: f38478b00c63058c819306b62f9fdbe332f1d833ea45d9de4217e64e60b7d7210f855c3fa8c6c72382457f35ab077b7249c00598eb923e7ea4e68577056f5214
-  data.tar.gz: 4edba88cce969fd122755d5c9821fc90ad25147291b3ed54a2b0d6cd249e8406326de014ea2033b0d0d19d947029e953ab59592c04bdba154cec2ace9e4fb796
+  metadata.gz: c9e84b1862121a03660d78b7fdcd5c0a45290982f5e5e8fd1a5b76bdfc37dfa199c9f03c9c7262cf262e6fdb7a0ac6b3cf6633244f93e937acde4494d8ccdfa9
+  data.tar.gz: d345f6b63c462c4510edc2df6e9aa3957711abf93e83f58f022c8742117fe9bc6db8ebd920a94568dcbd3c9c7c461eb9e25a57ac3b5fa698cae8b5d2bf479140

data/README.md

@@ -1 +1,68 @@
-# 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>",
+    apk_path: "<APK_PATH>",
+    # Optional
+    changelogs_folder_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 | - | false | link where you storing the release apk 
+changelogs_folder_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,31 +11,45 @@ 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  
 
+        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  
        
+        UI.message("Get current apk id")
         current_apk_id = Helper::AmazonAppSubmissionHelper.get_current_apk_id(token, params[:app_id], current_edit_id)
 
+        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)
 
-        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("Replacing the apk with ETag #{current_apk_eTag}")
+        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])
 
+        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 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
+        UI.message("Amazon app submission finished successfully!")
       end
 
       def self.description
-        "test"
+        "fast-lane plugin for Amazon App Submissions"
       end
 
       def self.authors
@@ -48,7 +62,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        "test"
+        "fast-lane plugin for Amazon App Submissions"
       end
 
       def self.available_options
@@ -75,8 +89,29 @@ module Fastlane
                                     env_name: "AMAZON_APP_SUBMISSION_APK_PATH",
                                  description: "Amazon App Submission APK Path",
                                     optional: false,
-                                        type: String)
-  
+                                        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 skip 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,9 +22,8 @@ module Fastlane
 
         res = http.request(req)
         result_json = JSON.parse(res.body)
-
         auth_token = "Bearer #{result_json['access_token']}"
-
+        
         return auth_token
       end
 
@@ -69,17 +64,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 +82,20 @@ module Fastlane
         )
 
         res = http.request(req)
-        return res.header['ETag']
+        if !res.body.nil? 
+        apks = JSON.parse(res.body)
+        firstAPK = apks[0]
+        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,34 +105,40 @@ 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)
@@ -142,8 +146,6 @@ module Fastlane
         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
@@ -167,8 +169,8 @@ module Fastlane
         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,6 +182,86 @@ 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" 
@@ -197,10 +279,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.1.0"
+    VERSION = "0.3.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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - mohammedhemaid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-13 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: {}