fastlane-plugin-rustore_publish 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78e12cd03800029213198db6dc3653ce95c8ea4dd6471d5e067c9ff79b562e1
-  data.tar.gz: 512f9299d5414564a7c59eeb219fbdedda933d2057941de7d042dc5d013f9183
+  metadata.gz: 203b7b3c7f50c633d3c0f66b8cd2816db90124d0119cd38c76dac7ab944a8688
+  data.tar.gz: 5e19d93495542d749147529642d383c1b02fcff532c81fe280e1c7bf6a3eafbf
 SHA512:
-  metadata.gz: 60b304a1d22e6d5c7edf6ad72fea7c7095c611866c4554f06728eb661f5f53f5bbf6d2b09e70a5b71a77cd8554453d9cd423a55cc1594be8064c7368b5ac4366
-  data.tar.gz: 9be1cb11bce6018d2254478dd0a3d9b39cb35bc4c90365c828fb73a0cc8ffbdfbde4b38307fa30db399e2a97137ca5a264f6562b9ba03ab89f9a9b78cdc7a89f
+  metadata.gz: fce936df0c5381b6ab1f30f0874968e049dc5dd766633d74f070cf2ef15c96e975e1a4425cef5847ac2af74cead7d07d1001c7f0170e9f95c3674e344131def5
+  data.tar.gz: f359c5be965c76108185e8e8d1bc0258b24087b3cc46381f8b97e08e0ae84f98f84dfc6c4d7ccb97abf37daa872fd7f7182ed82b50e4eecee712514641e6ce8f

data/README.md

@@ -1,10 +1,44 @@
 # RuStore fastlane plugin — publish Android apps to RuStore from CI
 
+[![Gem Version](https://img.shields.io/gem/v/fastlane-plugin-rustore_publish)](https://rubygems.org/gems/fastlane-plugin-rustore_publish)
+[![Downloads](https://img.shields.io/gem/dt/fastlane-plugin-rustore_publish)](https://rubygems.org/gems/fastlane-plugin-rustore_publish)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-rustore_publish)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 ![RuStore × fastlane — automated Android publishing](docs/assets/cover.jpg)
 
 Fastlane plugin for publishing Android applications to [RuStore](https://rustore.ru) — the Russian app store — via the [RuStore Public API](https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app). Uses the new `public-api-m.rustore.ru` domain with the Russian Trusted Root CA bundled, so nothing has to be installed on the runner.
 
-Gem: `fastlane-plugin-rustore_publish` · Action: `rustore_upload`
+Gem: `fastlane-plugin-rustore_publish` · Actions: `rustore_upload`, `rustore_check`
+
+## Quick start
+
+```sh
+fastlane add_plugin rustore_publish
+```
+
+```ruby
+# fastlane/Fastfile
+lane :deploy_rustore do
+  rustore_upload(
+    package_name: "com.example.app",
+    key_id:       ENV["RUSTORE_KEY_ID"],
+    private_key:  ENV["RUSTORE_PRIVATE_KEY"],
+    aab_path:     "app/build/outputs/bundle/release/app-release.aab",
+    whats_new:    "Bug fixes and improvements"
+  )
+end
+```
+
+The key comes from RuStore Console → Company → API RuStore, see [Setup](#setup-rustore-api-credentials).
+
+## По-русски
+
+Плагин fastlane для публикации Android-приложений в RuStore из CI: создаёт черновик, загружает AAB и HMS APK, отправляет на модерацию. Работает через новый домен `public-api-m.rustore.ru`, на который RuStore переводит Public API; корневой сертификат Минцифры уже внутри плагина, ставить его на раннер не нужно. В логах CI видно, сколько шла отправка файла и сколько RuStore его проверял, а ошибки (таймаут, TLS, 504, новые чувствительные разрешения) приходят с подсказкой, что делать.
+
+Для пробного прогона без выкладки есть `rustore_check`: получает токен и показывает последние версии приложения, ничего не загружая; 404 на списке версий считается успехом (ключ рабочий, версий через API пока нет).
+
+Установка — `fastlane add_plugin rustore_publish`, пример — в [Quick start](#quick-start) выше. Вопросы и баги — в [Issues](https://github.com/gorban-dev/rustore-fastlane-plugin/issues), можно на русском.
 
 ## Features
 
@@ -218,6 +252,39 @@ end
 
 ---
 
+## Check access (`rustore_check`)
+
+A dry run for CI: gets a token, reads the first page of the app's versions and logs up to 5 latest of them. Creates, deletes and uploads nothing, and does not touch drafts. Use it to verify that the key in CI works and covers the package before a real release.
+
+```ruby
+lane :check_rustore do
+  rustore_check(
+    package_name: "com.example.app",
+    key_id:       ENV["RUSTORE_KEY_ID"],
+    private_key:  ENV["RUSTORE_PRIVATE_KEY"]  # or private_key_path:
+  )
+end
+```
+
+```
+[RuStore] ✓ JWE token obtained
+[RuStore] versionId=1234 versionName=2.4.0 versionCode=240 versionStatus=ACTIVE
+[RuStore] versionId=1201 versionName=2.3.1 versionCode=231 versionStatus=PREVIOUS_ACTIVE
+[RuStore] ✓ RuStore OK — ключ рабочий, версий: 2
+```
+
+| Result | Behaviour |
+|---|---|
+| Versions found | Logs up to 5 latest, returns the Array of version Hashes |
+| Empty list | Success, returns `[]` |
+| HTTP 404 on the version list | Success: the key is valid and covers the package, but RuStore opens the versions API only after the first publication from RuStore Console. Returns `[]` |
+| `private_key` and `private_key_path` both missing or blank | Fails before any request: `RuStore: private_key или private_key_path не задан` |
+| Auth error, 401/403, 5xx, network | Fails with a hint, like `rustore_upload` |
+
+The 404 case is detected by HTTP status, not by message text.
+
+---
+
 ## CI/CD integration
 
 ### GitLab CI
@@ -268,6 +335,28 @@ lane :deploy_rustore do
 end
 ```
 
+**Checking the key without a release.** A manual job that runs `rustore_check`, e.g. after rotating the key:
+
+```yaml
+check_rustore:
+  stage: deploy
+  script:
+    - bundle exec fastlane check_rustore
+  rules:
+    - when: manual
+```
+
+```ruby
+# fastlane/Fastfile
+lane :check_rustore do
+  rustore_check(
+    package_name:     "com.example.app",
+    key_id:           ENV["RUSTORE_KEY_ID"],
+    private_key_path: ENV["RUSTORE_PRIVATE_KEY"]
+  )
+end
+```
+
 **Storing the private key in GitLab:**
 
 - Go to **Settings → CI/CD → Variables**

data/lib/fastlane/plugin/rustore_publish/actions/rustore_check.rb

@@ -0,0 +1,113 @@
+require "fastlane/action"
+require_relative "../helper/rustore_auth"
+require_relative "../helper/rustore_client"
+require_relative "../helper/rustore_logger"
+require_relative "../helper/rustore_options"
+
+module Fastlane
+  module Actions
+    # Dry run for CI: checks that the RuStore API key works and covers the
+    # package. Reads the version list only; never creates, deletes or uploads.
+    class RustoreCheckAction < Action
+      TOTAL_STEPS         = 2
+      SHOWN_VERSION_COUNT = 5
+
+      def self.run(params)
+        private_key  = RustorePublish::RustoreOptions.private_key!(params)
+        package_name = params[:package_name]
+        logger       = RustorePublish::RustoreLogger.new(total_steps: TOTAL_STEPS)
+
+        # ── Step 1: Authentication ─────────────────────────────────────────────
+        logger.step(1, "Authentication")
+        auth = RustorePublish::RustoreAuth.new(
+          key_id:      params[:key_id],
+          private_key: private_key,
+          logger:      logger
+        )
+        auth.refresh!
+        logger.success("JWE token obtained")
+
+        # ── Step 2: Versions ───────────────────────────────────────────────────
+        logger.step(2, "Versions")
+        client = RustorePublish::RustoreClient.new(auth: auth, logger: logger)
+
+        begin
+          versions = client.list_versions(package_name: package_name)
+        rescue RustorePublish::RustoreClient::NotFoundError
+          logger.success(
+            "RuStore OK — авторизация прошла, ключ покрывает #{package_name}; активных версий нет, " \
+            "API версий откроется после первой публикации в консоли"
+          )
+          logger.finalize
+          return []
+        end
+
+        if versions.empty?
+          logger.success("RuStore OK — авторизация прошла, версий у #{package_name} нет")
+        else
+          latest = versions.sort_by { |v| -v["versionId"].to_i }.first(SHOWN_VERSION_COUNT)
+          latest.each { |v| logger.info(format_version(v)) }
+          logger.success("RuStore OK — ключ рабочий, версий: #{versions.size}")
+        end
+
+        logger.finalize
+        versions
+      end
+
+      def self.format_version(version)
+        %w[versionId versionName versionCode versionStatus]
+          .map { |field| "#{field}=#{version[field]}" }
+          .join(" ")
+      end
+
+      # ── Parameter definitions ────────────────────────────────────────────────
+
+      def self.available_options
+        RustorePublish::RustoreOptions.credentials
+      end
+
+      def self.description
+        "Check that the RuStore API key works for a package, without uploading anything"
+      end
+
+      def self.details
+        <<~DETAILS
+          Gets a token and reads the first page of the app's versions from the
+          RuStore Public API, then logs up to 5 latest of them.
+
+          HTTP 404 on the version list counts as success: the key is valid and
+          covers the package, but RuStore opens the versions API only after the
+          first publication from RuStore Console.
+
+          Does not create, delete or upload anything and does not touch drafts.
+        DETAILS
+      end
+
+      def self.return_value
+        "Array of version hashes as returned by RuStore ([] when the app has no versions)"
+      end
+
+      def self.authors
+        ["Sergey Gorban"]
+      end
+
+      def self.example_code
+        [
+          'rustore_check(
+            package_name: "com.example.app",
+            key_id:       ENV["RUSTORE_KEY_ID"],
+            private_key:  ENV["RUSTORE_PRIVATE_KEY"]
+          )'
+        ]
+      end
+
+      def self.category
+        :production
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/rustore_publish/actions/rustore_upload.rb

@@ -2,6 +2,7 @@ require "fastlane/action"
 require_relative "../helper/rustore_auth"
 require_relative "../helper/rustore_client"
 require_relative "../helper/rustore_logger"
+require_relative "../helper/rustore_options"
 
 module Fastlane
   module Actions
@@ -173,41 +174,7 @@ module Fastlane
       # ── Parameter definitions ────────────────────────────────────────────────
 
       def self.available_options
-        [
-          # ── Authentication ─────────────────────────────────────────────────
-          FastlaneCore::ConfigItem.new(
-            key:         :key_id,
-            env_name:    "RUSTORE_KEY_ID",
-            description: "API key ID from RuStore Console → Company → API RuStore",
-            type:        String,
-            optional:    false
-          ),
-          FastlaneCore::ConfigItem.new(
-            key:         :private_key_path,
-            env_name:    "RUSTORE_PRIVATE_KEY_PATH",
-            description: "Path to RSA private key PEM file (mutually exclusive with private_key)",
-            type:        String,
-            optional:    true,
-            verify_block: proc { |v| UI.user_error!("private_key_path file not found: #{v}") unless File.exist?(v) }
-          ),
-          FastlaneCore::ConfigItem.new(
-            key:         :private_key,
-            env_name:    "RUSTORE_PRIVATE_KEY",
-            description: "RSA private key PEM content (mutually exclusive with private_key_path)",
-            type:        String,
-            optional:    true,
-            sensitive:   true
-          ),
-
-          # ── App identity ───────────────────────────────────────────────────
-          FastlaneCore::ConfigItem.new(
-            key:         :package_name,
-            env_name:    "RUSTORE_PACKAGE_NAME",
-            description: "Application package name (e.g. com.example.app)",
-            type:        String,
-            optional:    false
-          ),
-
+        RustorePublish::RustoreOptions.credentials + [
           # ── Build files ────────────────────────────────────────────────────
           FastlaneCore::ConfigItem.new(
             key:         :aab_path,

data/lib/fastlane/plugin/rustore_publish/helper/rustore_client.rb

@@ -25,6 +25,17 @@ module Fastlane
       SERVICES_TYPE_UNKNOWN = "Unknown"
       SERVICES_TYPE_HMS     = "HMS"
 
+      # Raised by #list_versions when RuStore answers 404. The caller decides
+      # whether that is a failure; the check is by HTTP status, not by text.
+      class NotFoundError < StandardError
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+          super("RuStore returned 404 for #{path}")
+        end
+      end
+
       def initialize(auth:, logger: nil, upload_timeout: DEFAULT_UPLOAD_TIMEOUT, wait_log_interval: WAIT_LOG_INTERVAL)
         @auth              = auth
         @logger            = logger || RustoreLogger.new
@@ -67,6 +78,17 @@ module Fastlane
         versions.find { |v| v["versionStatus"] == "DRAFT" }
       end
 
+      # GET /application/{package}/version?page=0&size={page_size}
+      # Reads the first page of the app's versions.
+      #
+      # @return [Array<Hash>] versions as RuStore returns them, [] if there are none
+      # @raise [NotFoundError] on HTTP 404
+      def list_versions(package_name:, page_size: 20)
+        resp = get("application/#{package_name}/version?page=0&size=#{page_size}", raise_not_found: true)
+        versions = resp.dig("body", "content")
+        versions.is_a?(Array) ? versions : []
+      end
+
       # DELETE /application/{package}/version/{versionId}
       def delete_draft(package_name:, version_id:)
         delete("application/#{package_name}/version/#{version_id}")
@@ -122,10 +144,12 @@ module Fastlane
 
       # ── HTTP Helpers ─────────────────────────────────────────────────────────
 
-      def get(path)
+      def get(path, raise_not_found: false)
         resp = with_network_errors(path) do
           @conn.get(path) { |r| r.headers["Public-Token"] = @auth.token }
         end
+        raise NotFoundError, path if raise_not_found && resp.status == 404
+
         handle_response(resp, path)
       end
 

data/lib/fastlane/plugin/rustore_publish/helper/rustore_options.rb

@@ -0,0 +1,53 @@
+require "fastlane_core"
+
+module Fastlane
+  module RustorePublish
+    # Options shared by all RuStore actions: API key and package name.
+    module RustoreOptions
+      def self.credentials
+        [
+          FastlaneCore::ConfigItem.new(
+            key:         :key_id,
+            env_name:    "RUSTORE_KEY_ID",
+            description: "API key ID from RuStore Console → Company → API RuStore",
+            type:        String,
+            optional:    false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :private_key_path,
+            env_name:    "RUSTORE_PRIVATE_KEY_PATH",
+            description: "Path to RSA private key PEM file (mutually exclusive with private_key)",
+            type:        String,
+            optional:    true,
+            verify_block: proc { |v| UI.user_error!("private_key_path file not found: #{v}") unless File.exist?(v) }
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :private_key,
+            env_name:    "RUSTORE_PRIVATE_KEY",
+            description: "RSA private key PEM content (mutually exclusive with private_key_path)",
+            type:        String,
+            optional:    true,
+            sensitive:   true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key:         :package_name,
+            env_name:    "RUSTORE_PACKAGE_NAME",
+            description: "Application package name (e.g. com.example.app)",
+            type:        String,
+            optional:    false
+          )
+        ]
+      end
+
+      # Returns the PEM from private_key or private_key_path. Fails before any
+      # request when neither is set or the key is blank, so an empty CI
+      # variable does not end up as an OpenSSL error.
+      def self.private_key!(params)
+        key = params[:private_key].to_s
+        key = File.read(params[:private_key_path]) if key.strip.empty? && params[:private_key_path]
+        UI.user_error!("RuStore: private_key или private_key_path не задан") if key.to_s.strip.empty?
+        key
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module RustorePublish
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-rustore_publish
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Sergey Gorban
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-30 00:00:00.000000000 Z
+date: 2026-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane
@@ -108,12 +108,14 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/rustore_publish.rb
+- lib/fastlane/plugin/rustore_publish/actions/rustore_check.rb
 - lib/fastlane/plugin/rustore_publish/actions/rustore_upload.rb
 - lib/fastlane/plugin/rustore_publish/certs/russian_trusted_root_ca.crt
 - lib/fastlane/plugin/rustore_publish/helper/rustore_auth.rb
 - lib/fastlane/plugin/rustore_publish/helper/rustore_client.rb
 - lib/fastlane/plugin/rustore_publish/helper/rustore_endpoint.rb
 - lib/fastlane/plugin/rustore_publish/helper/rustore_logger.rb
+- lib/fastlane/plugin/rustore_publish/helper/rustore_options.rb
 - lib/fastlane/plugin/rustore_publish/version.rb
 homepage: https://github.com/gorban-dev/rustore-fastlane-plugin
 licenses: