fastlane-plugin-create_remote_config_release_package 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcbadde0a9b946ffc91fc55378e45c266febca3c9079961a465fbace14a48e08
+  data.tar.gz: 52530b73061ff59d5731e8a1c6a78eb8658af67af6f0efe3b8fac35a7cb8f7cd
+SHA512:
+  metadata.gz: 321def4abb217c95041fb3ec3ec2690d49639655479e87b036ffc7c172e4a7e8f6b9f975cf9dcf3ce99dea130b97274dc290773a4b82be63e2a246edb1e12353
+  data.tar.gz: 37caf5db2661b4886ab8f49e90cd46f557f4b0f6f59a8845df233b871bf82732d6de565302fe4c0e2f910ea88d1f58089791f5281eac859f9364535abebe2497

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 George Nyakundi <georgen@backbase.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# create_remote_config_release_package plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-create_remote_config_release_package)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-create_remote_config_release_package`, add it to your project by running:
+
+```bash
+fastlane add_plugin create_remote_config_release_package
+```
+
+## About create_remote_config_release_package
+
+Creates a Remote Config release package
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
+Add the gem in the Gemfile 
+```ruby 
+gem "fastlane-plugin-create_remote_config_release_package", git: "https://github.com/Backbase/fastlane-plugin-create_remote_config_release_package.git"
+```
+
+
+```ruby
+platform :ios do
+  lane :test do
+    projectName = "sample-app"
+    appTitle = "Sample Application"
+    bundleId = "com.sample.app1"
+    projectFile = "../path/to/project.xcodeproj"
+    campaignJSON = "../path/to/campaign.json"
+    parametersJSON = "../path/to/parameters.json"
+    targetName = "Target"
+
+    create_remote_config_release_package(
+      project_name: projectName,
+      app_title: appTitle,
+      bundle_id: bundleId,
+      project_file_path: projectFile,
+      campaign_json_path: campaignJSON,
+      parameters_json_path: parametersJSON,
+      target_name: targetName
+    )
+  end
+end
+
+```
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/create_remote_config_release_package/actions/create_remote_config_release_package_action.rb

@@ -0,0 +1,189 @@
+require 'fastlane/action'
+require 'xcodeproj'
+require_relative '../helper/create_remote_config_release_package_helper'
+
+module Fastlane
+  module Actions
+    class CreateRemoteConfigReleasePackageAction < Action
+      def self.description
+        "Creates a Remote Config release package"
+      end
+
+      def self.authors
+        ["George Nyakundi"]
+      end
+
+      def self.run(params)
+        projectName = params[:project_name]
+        appTitle = params[:app_title]
+        campaignJSON = params[:campaign_json_path]
+        parametersJSON = params[:parameters_json_path]
+        bundleId = params[:bundle_id]
+        projectFile = params[:project_file_path]
+        targetName = params[:target_name]
+
+        locale_regexp = /^[A-Za-z]{2,3}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$/
+
+        campaignJSONfilePath = File.expand_path(campaignJSON)
+        campaign_hash = begin
+          JSON.parse(File.read(campaignJSONfilePath))
+        rescue StandardError
+          nil
+        end
+
+        parameterJSONfilePath = File.expand_path(parametersJSON)
+        parameters_hash = begin
+          JSON.parse(File.read(parameterJSONfilePath))
+        rescue StandardError
+          nil
+        end
+
+        project = Xcodeproj::Project.open(projectFile)
+        locales = []
+        known_regions = project.root_object.known_regions
+        known_regions.each do |region|
+          if region =~ locale_regexp
+            locales.push(region)
+          end
+        end
+
+        if targetName.strip.empty?
+          marketingVersion = other_action.get_version_number(xcodeproj: projectFile)
+        else
+          marketingVersion = other_action.get_version_number(xcodeproj: projectFile, target: targetName)
+        end
+        versionNumber = marketingVersion.gsub(/[^0-9]/, '').ljust(7, '0')
+
+        project_hash = {
+          "name" => projectName,
+          "applications" => [
+            "name" => bundleId,
+            "title" => appTitle,
+            "releases" => [
+              "version" => marketingVersion,
+              "versionNumber" => versionNumber,
+              "parameters" => parameters_hash || {},
+              "campaignSlots" => campaign_hash || [],
+              "locales" => locales
+            ]
+          ]
+        }
+
+        File.write("../project.json", project_hash.to_json)
+        zip_name = "#{projectName}-project.zip"
+
+        Dir.chdir("..") do
+          sh("zip -FSr #{zip_name} project.json")
+        end
+
+        manifestHash = {
+          "name" => projectName,
+          "provisioningItems" => [
+            "name" => projectName,
+            itemType: "remote-config:/project",
+            location: "/#{zip_name}"
+          ]
+        }
+
+        File.write("../manifest.json", manifestHash.to_json)
+
+        # Create a folder to where the provisioning package should be saved
+        FileUtils.mkdir_p("releases") unless Dir.exist?("releases")
+
+        Dir.chdir("..") do
+          sh("zip -FSr provisioning_package.zip manifest.json #{zip_name}; rm #{zip_name}; rm manifest.json; rm project.json")
+        end
+        UI.success("provisioning_package.zip creation Completed")
+
+        FileUtils.mv('../provisioning_package.zip', './releases/provisioning_package.zip')
+
+        UI.success("provisioning_package.zip has been moved to releases folder successfully")
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "This action creates a zip file with metadata required for release registration in the Remote config service"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :project_name,
+            env_name: "RC_PROJECT_NAME",
+            description: "specifies the project name configured in your client apps. Only use alphanumerics and dashes",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No project_name given, pass using `project_name: 'project_name'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :app_title,
+            env_name: "RC_APP_TITLE",
+            description: "specifies the title displayed in the Remote Config App",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No app_title given, pass using `app_title: 'app_title'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :bundle_id,
+            env_name: "RC_BUNDLE_ID",
+            description: "specifies the bundle id of the project",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No App's bundle id given, pass using `bundle_id: 'bundle_id'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :campaign_json_path,
+            env_name: "RC_CAMPAIGN_JSON_PATH",
+            description: "specifies the path to the campaign json slots",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No campaign slots json file path given, pass using `campaign_json_path: 'campaign_json_path'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :parameters_json_path,
+            env_name: "RC_PARAMETERS_JSON_PATH",
+            description: "specifies the path to the parameter json file",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No parameter.json file path given, pass using `parameters_json_path: 'parameters_json_path'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :project_file_path,
+            env_name: "RC_PROJECT_FILE_PATH",
+            description: "specifies the path to the Xcode project",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("No Xcode project path given, pass using `project_file_path: 'project_file_path'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :target_name,
+            env_name: "RC_TARGET",
+            description: "specifies the target",
+            optional: true,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/create_remote_config_release_package/helper/create_remote_config_release_package_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class CreateRemoteConfigReleasePackageHelper
+      # class methods that you define here become available in your action
+      # as `Helper::CreateRemoteConfigReleasePackageHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the create_remote_config_release_package plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module CreateRemoteConfigReleasePackage
+    VERSION = "0.2.1"
+  end
+end

data/lib/fastlane/plugin/create_remote_config_release_package.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/create_remote_config_release_package/version'
+
+module Fastlane
+  module CreateRemoteConfigReleasePackage
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::CreateRemoteConfigReleasePackage.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-create_remote_config_release_package
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- George Nyakundi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.204.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.204.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: georgen@backbase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/create_remote_config_release_package.rb
+- lib/fastlane/plugin/create_remote_config_release_package/actions/create_remote_config_release_package_action.rb
+- lib/fastlane/plugin/create_remote_config_release_package/helper/create_remote_config_release_package_helper.rb
+- lib/fastlane/plugin/create_remote_config_release_package/version.rb
+homepage: https://github.com/Backbase/fastlane-plugin-create_remote_config_release_package
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.13
+signing_key:
+specification_version: 4
+summary: Creates a Remote Config release package
+test_files: []