fastlane-plugin-codemagic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9b819c659bcf16f152f9c90d0b71ddbac1e120202e72c78e67dcd3e9044ea6c
+  data.tar.gz: d660c712ffb099c5e7fc84a2338e914836803b96ecd06c0f9f690344166d801c
+SHA512:
+  metadata.gz: 60d68646a122d16a90b7d059624f8fb3a6385c9d70108511ca11cc8039e0b2ae502272a11853117237614d6acf833f59c5ef9b6f9a5e505c15fd6c0ef2b3f442
+  data.tar.gz: 94a4ef6e78c9df6286b24aff137c120472cc691d0d591ffb7ce82bac595269f814d85ba2200c211f8ef04516c2f09f925ce80c056741733d6aa1fd2e8b179234

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mikhail Matsera <mmatsera@gmail.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,88 @@
+# codemagic plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-codemagic)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-codemagic`, add it to your project by running:
+
+```bash
+fastlane add_plugin codemagic
+```
+
+## About codemagic
+
+Fastlane plugin to trigger a Codemagic build with some options
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Options
+
+| Option | Description | Type | Requirement | Environment Variable |
+| --- | --- | :---: | :---: | --- |
+| `auth_token` | Codemagic API access token is available via UI in User settings > Integrations > Codemagic API > Show | String | **Required** | `CODEMAGIC_AUTH_TOKEN` |
+| `app_id` | Codemagic application identifier. | String | **Required** | `CODEMAGIC_APP_ID` |
+| `workflow_id` | Codemagic workflow identifier as specified in YAML file. | String | **Required** | `CODEMAGIC_WORKFLOW_ID` |
+| `branch` | Git branch name | String | **Required** | `CODEMAGIC_BRANCH` |
+| `download` | Artefacts downloading options | Object | Optional |  **none** |
+| `environment` | Codemagic specify environment variables and software versions to override values defined in workflow settings. | Object | Optional | **none** |
+
+## Return values
+
+If an error is return by the codemagic.io API, the plugin will **throw an exception**. 
+
+## Examples
+
+```
+codemagic(
+    workflow_id: "YOUR_WORKFLOW_ID",
+    app_id: "YOUR_APP_ID",
+    branch: "release/4.1.2",
+    auth_token: "82Kf0RHv8MWS7VctoFHxGtW-wIWEkPUI0-E8DkJ4HaY",
+    download: {
+        artefacts: ["ipa"],
+        build_path: "./build/"
+    },
+    environment: {
+        variables: {
+            "ENV": "production",
+            "YET_ANOTHER_ENVIRONMENT_VARIABLE" => "123456" 
+        },
+        softwareVersions: {
+            flutter: stable
+            xcode: latest
+            cocoapods: default
+        }
+    }
+)
+```
+**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/codemagic.rb

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

data/lib/fastlane/plugin/codemagic/actions/codemagic_action.rb

@@ -0,0 +1,266 @@
+module Fastlane
+  module Actions
+    class CodemagicAction < Action
+      def self.run(params)
+        UI.message("The codemagic plugin is working!")
+
+        FastlaneCore::PrintTable.print_values(config: params.values(ask: false),
+                                              hide_keys: [],
+                                              title: "Codemagic options")
+
+        json = get_post_payload(params[:app_id],
+                                params[:workflow_id],
+                                params[:branch],
+                                params[:environment])
+
+        params[:download] ||= {}
+        params[:download][:artefacts] ||= []
+        params[:download][:build_path] ||= nil
+
+        build_path = params[:download][:build_path]
+        download_artefacts = params[:download][:artefacts]
+
+        trigger_codemagic_build(params[:auth_token], json)
+
+        last_build_id = get_last_build_id(params[:auth_token], params[:app_id])
+
+        build = check_building_status(params[:auth_token], last_build_id)
+
+        if build_path != nil
+          download_artefacts(download_artefacts, build, build_path)
+        end
+      end
+
+      def self.get_post_payload(app_id, workflow_id, branch, environment)
+        UI.message("Payload creation...")
+        payload = {}
+
+        unless app_id.nil?
+          payload["appId"] = app_id
+        end
+
+        unless workflow_id.nil?
+          payload["workflowId"] = workflow_id
+        end
+
+        unless branch.nil?
+          payload["branch"] = branch
+        end
+
+        unless environment.nil?
+          payload["environment"] = environment
+        end
+
+        payload.to_json
+      end
+
+      def self.trigger_codemagic_build(auth_token, json)
+        UI.message("Requesting codemagic.io API...")
+        uri = URI.parse("https://api.codemagic.io/builds")
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Post.new(uri.path)
+
+        request["X-Auth-Token"] = auth_token
+        request["Content-Type"] = "application/json"
+
+        request.body = json
+        response = https.request(request)
+
+        json_response = JSON.parse(response.body)
+
+        if response.code == "200"
+          UI.success("Build triggered successfully on Codemagic.io 🚀 [#{json_response}]")
+        else
+          UI.user_error!("Couln't trigger the build on Codemagic.io.")
+          FastlaneCore::PrintTable.print_values(config: json_response,
+                                                hide_keys: [],
+                                                title: "Codemagic API response")
+        end
+
+      end
+
+      def self.get_last_build_id(auth_token, app_id)
+        UI.message("Requesting codemagic.io API...")
+        uri = URI.parse("https://api.codemagic.io/apps/#{app_id}")
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Get.new(uri.path)
+
+        request["X-Auth-Token"] = auth_token
+        request["Content-Type"] = "application/json"
+
+        response = https.request(request)
+        json_response = JSON.parse(response.body)
+
+        if response.code == "200"
+          last_build_id = json_response["application"]["lastBuildId"]
+          UI.success("Get last build ID on Codemagic.io 🚀 [#{last_build_id}]")
+          last_build_id
+        else
+          UI.user_error!("Couln't trigger the build on Codemagic.io.")
+          FastlaneCore::PrintTable.print_values(config: json_response,
+                                                hide_keys: [],
+                                                title: "Codemagic API response")
+        end
+
+      end
+
+      def self.check_building_status(auth_token, build_id)
+        while true do
+          build = get_build(auth_token, build_id)
+          build_status = build["status"]
+
+          case build_status
+          when "failed"
+            UI.abort_with_message!(build["message"])
+          when "success"
+          when "finished"
+            UI.success("Success")
+          else
+            UI.message(build_status)
+            sleep 10
+            next
+          end
+          build
+          break
+        end
+      end
+
+      def self.get_build(auth_token, build_id)
+        UI.message("Requesting codemagic.io API...")
+        uri = URI.parse("https://api.codemagic.io/builds/#{build_id}")
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Get.new(uri.path)
+
+        request["X-Auth-Token"] = auth_token
+        request["Content-Type"] = "application/json"
+
+        response = https.request(request)
+
+        json_response = JSON.parse(response.body)
+
+        if response.code == "200"
+
+          UI.success("Build triggered successfully on Codemagic.io 🚀")
+          FastlaneCore::PrintTable.print_values(config: json_response["build"],
+                                                hide_keys: [],
+                                                title: "Build")
+          json_response["build"]
+        else
+          UI.user_error!("Couln't trigger the build on Codemagic.io.")
+          FastlaneCore::PrintTable.print_values(config: json_response,
+                                                hide_keys: [],
+                                                title: "Codemagic API response")
+        end
+      end
+
+      def self.download_artefacts(download_artefacts, build, build_path)
+        UI.message("Download artefacts codemagic.io API...")
+        artefacts = build["artefacts"]
+
+        Dir.chdir("#{Dir.pwd}/fastlane")
+
+        real_build_dir = File.expand_path("#{build_path}")
+
+        if Dir.exist?(real_build_dir)
+
+          artefacts.map do |artefact|
+
+            if download_artefacts.include?(artefact["type"])
+
+              FastlaneCore::PrintTable.print_values(config: artefact,
+                                                    hide_keys: [])
+
+              real_build_path = File.expand_path("#{build_path}#{artefact["name"]}")
+
+              open(real_build_path, 'wb') do |file|
+                file << open(artefact["url"]).read
+              end
+
+            end
+          end
+        else
+          UI.build_failure!("Directory not exists [#{real_build_dir}]")
+        end
+      end
+
+      def self.description
+        "Fastlane plugin to trigger a Codemagic build with some options"
+      end
+
+      def self.authors
+        ["Mikhail Matsera"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+            FastlaneCore::ConfigItem.new(key: :app_id,
+                                    env_name: "CODEMAGIC_APP_ID",
+                                 description: "Codemagic application identifier",
+                                    optional: false,
+                                        type: String,
+                                verify_block: proc do |value|
+                                  UI.user_error!("No Codemagic application ID given, pass it using `app_id` parameter to the Codemagic plugin.") unless value && !value.empty?
+                                end),
+
+            FastlaneCore::ConfigItem.new(key: :workflow_id,
+                                    env_name: "CODEMAGIC_WORKFLOW_ID",
+                                 description: "Codemagic workflow identifier as specified in YAML file",
+                                    optional: false,
+                                        type: String,
+                                verify_block: proc do |value|
+                                  UI.user_error!("No Codemagic workflow ID given, pass it using `workflow_id` parameter to the Codemagic plugin.") unless value && !value.empty?
+                                end),
+
+            FastlaneCore::ConfigItem.new(key: :auth_token,
+                                    env_name: "CODEMAGIC_AUTH_TOKEN",
+                                 description: "Codemagic Auth Token",
+                                    optional: false,
+                                        type: String,
+                                verify_block: proc do |value|
+                                  UI.user_error!("No Codemagic auth token given, pass it using `auth_token` parameter to the Codemagic plugin.") unless value && !value.empty?
+                                end),
+
+            FastlaneCore::ConfigItem.new(key: :branch,
+                                    env_name: "CODEMAGIC_BRANCH",
+                                 description: "Codemagic branch name",
+                                    optional: false,
+                                        type: String,
+                                verify_block: proc do |value|
+                                  UI.user_error!("No Codemagic branch given, pass it using `branch` parameter to the Codemagic plugin.") unless value && !value.empty?
+                                end),
+
+            FastlaneCore::ConfigItem.new(key: :download,
+                                         description: "Download Codemagic artefacts",
+                                         optional: true,
+                                         type: Object),
+
+            FastlaneCore::ConfigItem.new(key: :environment,
+                                         description: "Codemagic Specify environment variables and software versions to override values defined in workflow settings",
+                                         optional: true,
+                                         type: Object)
+        ]
+      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/codemagic/helper/codemagic_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Codemagic
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-codemagic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikhail Matsera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-17 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.154.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.154.0
+description: 
+email: mmatsera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/codemagic.rb
+- lib/fastlane/plugin/codemagic/actions/codemagic_action.rb
+- lib/fastlane/plugin/codemagic/helper/codemagic_helper.rb
+- lib/fastlane/plugin/codemagic/version.rb
+homepage: https://github.com/jetcore/fastlane-plugin-codemagic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Fastlane plugin to trigger a Codemagic build with some options
+test_files: []