fastlane-plugin-appcircle_enterprise_store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 075ced39b68b62e2bf04be9b21a0eaf7e71f25e49f3a970bebd6f66502c22b9a
+  data.tar.gz: cef7596b841fad895e934718a2bb12ad5d3d98dc388161167d9624e40802b3fe
+SHA512:
+  metadata.gz: 6c3ca01ebc8f46a7ec418cf436e28acbd416107815b8975e10fedfd7cd5abfd9c6bb88901d7ef4a77cdeff6d51709b3657bd95ae58046979bb9c02d8e0c17d7f
+  data.tar.gz: 4462a8d0a2d5bdbee30cd9bea98b70deb6e658e20b398a7e4ae0bc600696b223a953beb1e7dd355d534046c9cfeede0becab6ec75f0050fff93644b51e2baa39

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Guven Karanfil <guven.karanfil@smartface.io>
+
+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,83 @@
+## Appcircle Enterprise App Store
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-appcircle_enterprise_store)
+
+Appcircle Enterprise Mobile App Store is your own mobile app store for providing access to in-house apps with a customizable mobile storefront.
+
+- **Customizable Storefront:** Distribute your in-house apps with a fully customizable mobile storefront.
+- **Secure Distribution:** Everything you need for secure, streamlined distribution of your in-house apps.
+- **No MDM Required:** Allows distribution of B2B and B2E applications without the need for an MDM solution and enrollment.
+
+Learn more about [Appcircle Enterprise App Store](https://appcircle.io/enterprise-app-store).
+
+## What Sets Apart Appcircle Enterprise Mobile App Store
+
+1. **Direct File Sharing:**
+   - **Skip Traditional Stores:** Share .IPA, APK, or AAB files directly, avoiding the need to wait for Apple App Store or Google Play approvals.
+2. **Flexible Sharing Options:**
+   - **Beta and Live Modes:** Share your app in ‘beta’ mode for testing new features or identifying bugs, or in ‘live’ mode for stable versions. This flexibility helps maintain the development lifecycle without interruptions.
+3. **Enhanced Security:**
+   - **Secure Authentication:** Access the Enterprise Mobile App Store with extra secure authentication using Enterprise Authentication Methods.
+   - **Controlled Access:** Ensure that only authorized users can access the app store and its contents.
+4. **Customizable Mobile Storefront:**
+   - **Tailored Experience:** Provide a customizable mobile storefront for your in-house apps, ensuring a tailored experience that aligns with your brand and user needs.
+5. **No MDM Requirement:**
+   - **Simplified Distribution:** Distribute B2B and B2E applications without the need for a Mobile Device Management (MDM) solution or enrollment, reducing complexity and costs.
+6. **Streamlined Workflow:**
+   - **Seamless Integration:** Integrates smoothly with your existing workflow, making it easy to manage and distribute apps within your organization.
+   - **Efficient Management:** Track and manage applications, versions, testers, and teams effectively, ensuring a smooth distribution process.
+
+These features make the Appcircle Enterprise Mobile App Store a powerful tool for securely and efficiently distributing in-house applications, offering flexibility, enhanced security, and a streamlined workflow.
+
+![Enterprise App Store Dashboard](images/ent_app_store.png)
+
+### Generating/Managing the Personal API Tokens
+
+To generate a Personal API Token:
+
+1. Go to the My Organization screen (second option at the bottom left).
+2. Find the Personal API Token section in the top right corner.
+3. Press the "Generate Token" button to generate your first token.
+
+![Token Generation](images/PAT.png)
+
+### Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `appcircle_enterprise_store`, add it to your project by running:
+
+```bash
+fastlane add_plugin appcircle_enterprise_store
+```
+
+After adding the plugin to your project, configure your Fastfile as follows:
+
+```yml
+  lane :distribute_app_store do
+    appcircle_enterprise_store(
+      accessToken: "$(AC_ACCESS_TOKEN)",
+      entProfileId: "$(ENTERPRISE_PROFILE_ID)",
+      appPath: "$(APP_PATH)",
+      summary: "$(SUMMARY)",
+      releaseNotes: "$(RELEASE_NOTE)",
+      publishType: "$(PUBLISH_TYPE)" # Assign the appropriate number based on the status: None (0), Beta (1), Live (2)
+    )
+  end
+```
+
+### Leveraging Environment Variables
+
+Utilize environment variables seamlessly by substituting the parameters with $(VARIABLE_NAME) in your task inputs. The extension automatically retrieves values from the specified environment variables within your pipeline.
+
+If you would like to learn more about this extension and how to utilize it in your projects, please [contact us](https://appcircle.io/contact)
+
+## 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.
+
+### Reference
+
+For more detailed instructions and support, visit the [Appcircle Enterprise App Store documentation](https://appcircle.io/enterprise-app-store).

data/lib/fastlane/plugin/appcircle_enterprise_store/actions/appcircle_enterprise_store_action.rb

@@ -0,0 +1,183 @@
+require 'fastlane/action'
+require 'net/http'
+require 'uri'
+require 'json'
+require_relative '../helper/appcircle_enterprise_store_helper'
+
+module Fastlane
+  module Actions
+    class AppcircleEnterpriseStoreAction < Action
+      def self.run(params)
+        accessToken = params[:accessToken]
+        entProfileId = params[:entProfileId]
+        appPath = params[:appPath]
+        summary = params[:summary]
+        releaseNotes = params[:releaseNotes]
+        publishType = params[:publishType]
+
+        self.ac_login(accessToken)
+        self.uploadToProfile(entProfileId, appPath, summary, releaseNotes, publishType)
+        self.get_version_list(entProfileId)
+      end
+
+      def self.ac_login(accessToken)
+        ac_login = `appcircle login --pat #{accessToken}`
+        if $?.success?
+          UI.success("Logged in to Appcircle successfully.")
+        else
+          raise "Error executing command of logging to Appcircle. Please make sure you have installed Appcircle CLI and provided a valid access token. For more information, please visit https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens #{ac_login}"
+        end
+      end
+
+
+      def self.checkTaskStatus(taskId)
+        uri = URI.parse("https://api.appcircle.io/task/v1/tasks/#{taskId}")
+        timeout = 1
+        jwtToken = `appcircle config get AC_ACCESS_TOKEN -o json`
+        apiAccessToken = JSON.parse(jwtToken)
+        
+        response = self.send_request(uri, apiAccessToken["AC_ACCESS_TOKEN"])
+        if response.is_a?(Net::HTTPSuccess)
+          stateValue = JSON.parse(response.body)["stateValue"]
+          
+          if stateValue == 1
+            return checkTaskStatus(taskId)
+          else 
+            return true
+          end
+        else
+          UI.error("Request failed with response code #{response.code} and message #{response.message}")
+          raise "Request failed"
+        end
+        return false
+      end
+
+
+      def self.uploadToProfile(entProfileId, appPath, summary, releaseNotes, publishType)
+        # `appcircle enterprise-app-store version upload-for-profile --entProfileId ${profileId} --app ${app}`;
+        ac_upload_profile = `appcircle enterprise-app-store version upload-for-profile --entProfileId #{entProfileId} --app #{appPath} -o json`
+        taskId = JSON.parse(ac_upload_profile)["taskId"]
+        apiAccessTokenString = `appcircle config get AC_ACCESS_TOKEN -o json`
+        apiAccessToken = JSON.parse(apiAccessTokenString)
+        
+        if $?.success?
+          result = self.checkTaskStatus(taskId)
+          if result
+            appVersionId = self.get_version_list(entProfileId)
+            self.publishToStore(entProfileId, appVersionId, summary, releaseNotes, publishType)
+          end
+        else
+          raise "Error executing command of uploading the application to the Appcircle Enterprise Store. Please make sure you have provided a valid profile ID and application path.#{ac_upload_profile}"
+        end
+      end
+
+      def self.publishToStore(entProfileId, entVersionId, summary, releaseNote, publishType)
+        # `appcircle enterprise-app-store version publish --entProfileId ${entProfileId} --entVersionId ${entVersionId} --summary "${summary}" --releaseNotes "${releaseNote}" --publishType ${publishType}`;
+        publish_command = `appcircle enterprise-app-store version publish --entProfileId #{entProfileId} --entVersionId #{entVersionId} --summary "#{summary}" --releaseNotes "#{releaseNote}" --publishType #{publishType}`
+        if $?.success?
+          UI.success("Published the application to the Appcircle Enterprise Store successfully\n#{publish_command}")
+        else
+          raise "Error executing command of publishing the application to the Appcircle Enterprise Store. Please make sure you have provided a valid profile ID, version ID, summary, release notes, and publish type. #{publish_command}"
+        end
+      end
+
+      def self.send_request(uri, access_token)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == "https")
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request["Authorization"] = "Bearer #{access_token}"
+        http.request(request)
+      end
+
+      def self.get_version_list(entProfileId)
+        store_version_list = `appcircle enterprise-app-store version list --entProfileId #{entProfileId}  -o json`;
+        appVersionId = self.getVersionId(store_version_list)
+        UI.message("Uploaded App ID: #{appVersionId}")
+        return appVersionId
+      end
+      
+      def self.getVersionId(versions)
+        begin
+          versionList = JSON.parse(versions)
+      
+          if versionList.is_a?(Array) && !versionList.empty?
+            return versionList[0]["id"]
+          else
+            return nil
+          end
+        rescue JSON::ParserError => e
+          puts "Failed to parse JSON: #{e.message}"
+          nil
+        rescue => e
+          puts "An error occurred: #{e.message}"
+          nil
+        end
+      end
+
+      def self.description
+        "Efficiently publish your apps to Appcircle Enterprise Store"
+      end
+
+      def self.authors
+        ["Guven Karanfil"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Appcircle Enterprise Mobile App Store is your own mobile app store for providing access to in-house apps with a customizable mobile storefront"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :accessToken,
+                                  env_name: "AC_ACCESS_TOKEN",
+                               description: "Provide the Appcircle access token to authenticate connections to Appcircle services. This token allows your Azure DevOps pipeline to interact with Appcircle for distributing applications",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :entProfileId,
+                                  env_name: "AC_ENT_PROFILE_ID",
+                               description: "Provide the Appcircle Enterprise App Store Mobile Profile ID to specify the profile to be used for the publishment. This ID can be found in the Enterprise App Store Mobile module dashboard",
+                                  optional: false,
+                                      type: String),                                      
+
+          FastlaneCore::ConfigItem.new(key: :appPath,
+                                  env_name: "AC_APP_PATH",
+                               description: "Specify the path to your application file. For iOS, this can be a .ipa or .xcarchive file path. For Android, specify the .apk or .appbundle file path",
+                                  optional: false,
+                                      type: String),                            
+
+          FastlaneCore::ConfigItem.new(key: :summary,
+                                  env_name: "AC_SUMMARY",
+                               description: "Provide a summary for the application to be published. This summary will be displayed in the Appcircle Enterprise App Store",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :releaseNotes,
+                                  env_name: "AC_RELEASE_NOTES",
+                               description: "Provide release notes for the application to be published. These notes will be displayed in the Appcircle Enterprise App Store",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :publishType,
+                                  env_name: "AC_PUBLISH_TYPE",
+                               description: "Specify the publish type for the application. This can be 0: None, 1: Beta, 2: Live. Default is 0: None. For more information, provide the number of the publish type",
+                                  optional: false,
+                                      type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/appcircle_enterprise_store/helper/appcircle_enterprise_store_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module AppcircleEnterpriseStore
+    VERSION = "0.0.1"
+  end
+end

data/lib/fastlane/plugin/appcircle_enterprise_store.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/appcircle_enterprise_store/version'
+
+module Fastlane
+  module AppcircleEnterpriseStore
+    # 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::AppcircleEnterpriseStore.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-appcircle_enterprise_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- appcircleio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-11 00:00:00.000000000 Z
+dependencies: []
+description:
+email: cloud@appcircle.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- images/PAT.png
+- images/ent_app_store.png
+- images/extension-icon.png
+- lib/fastlane/plugin/appcircle_enterprise_store.rb
+- lib/fastlane/plugin/appcircle_enterprise_store/actions/appcircle_enterprise_store_action.rb
+- lib/fastlane/plugin/appcircle_enterprise_store/helper/appcircle_enterprise_store_helper.rb
+- lib/fastlane/plugin/appcircle_enterprise_store/version.rb
+homepage: https://github.com/appcircleio/fastlane-plugin-appcircle_enterprise_store
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Efficiently publish your apps to Appcircle Enterprise Store
+test_files: []