fastlane-plugin-bitrise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05dd7bdfddd3a2cbbabf155a18a970ea0803795b
+  data.tar.gz: 3b0bbad433cd453fc385f4027e439fca328cdf17
+SHA512:
+  metadata.gz: a21c4c18b846ce7b0b097e6ca57ca73d1dbeae80f7cce740cdd46e01c2aba4365ba039fa7b00cb5c792c459aef81c51a034350396f4f0a861f3390dd8ab17df9
+  data.tar.gz: 4e34c332ea4cf9f5dfc541fd3d8d1f46a486386fe1a49cd1f89e30029dc59b98964edcf5095c9b7488412c46772ef1faa8e108f2aa2c91cfebf24796877ac66c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robin AUTHIAT <authiatr@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,102 @@
+# bitrise plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bitrise)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bitrise`, add it to your project by running:
+
+```bash
+fastlane add_plugin bitrise
+```
+
+## About bitrise
+
+This plugin allow you to trigger a specific Bitrise workflow with some arguments with a HTTPS POST request on the Bitrise.io API.
+
+It also allow you to override some environments variables.
+
+It can help you to automatically trigger a build after a bump commit for instance without have to log into bitrise.io. 
+
+## Options
+
+| Option | Description | Type | Requirement | Environment Variable |
+| --- | --- | :---: | :---: | --- |
+| `app_slug` | Bitrise application slug, avalaible on bitrise.io > your app > code | String | **Mandatory** | `BITRISE_APP_SLUG` |
+| `trigger_token` | Bitrise build trigger token, avalaible on bitrise.io > your app > code | String | **Mandatory** | `BITRISE_TRIGGER_TOKEN` |
+| `workflow` | Bitrise workflow to trigger, if not specified, it'll trigger the default one | String | Optional | `BITRISE_WORKFLOW` |
+| `build_message` | Build message who'll appear on the Bitrise.io build | String | Optional | `BITRISE_BUILD_MESSAGE` |
+| `branch` | The git branch to build | String | Optional | `BITRISE_GIT_BRANCH` |
+| `commit` | The git commit hash to build | String | Optional | `BITRISE_GIT_COMMIT` |
+| `tag` | The git Tag to build | String | Optional | `BITRISE_GIT_TAG` |
+| `environments` | Bitrise environments to replace, it'll override the previous environment variables specified. The Hash key has to be the environment variable key (without the `$`), the Hash value has to be environment variable value | Hash | Optional | `BITRISE_ENVIRONMENTS` |
+
+## Return values
+
+The `bitrise` plugin return a Hash containing the bitrise build informations return by the API. 
+
+| Hash key | Description |
+| --- | --- |
+| `build_number` | Bitrise build number |
+| `build_url` | Bitrise build url |
+
+If an error is return by the bitrise.io API, the plugin will **throw an exception**. 
+
+## Examples
+
+To trigger the default workflow set on Bitrise.io on the default git branch execute:
+```
+bitrise(
+    "app_slug": "YOUR_APP_SLUG",
+    "trigger_token": "YOUR_TRIGGER_TOKEN"
+)
+```
+
+To trigger a build with a specific workflow, a specific git branch, display a build message and override some environments variables execute the following command:
+```
+bitrise(
+    "app_slug": "YOUR_APP_SLUG",
+    "trigger_token": "YOUR_TRIGGER_TOKEN",
+    "workflow": "Beta",
+    "build_message": "Deploy build version 1.3.2 build number 11 to Beta test",
+    "branch": "release/1.3.2",
+    "environments": {
+        "BUILD_CONFIGURATION" => "Production",        # Environment variable to override during Bitrise.io build
+        "ANOTHER_ENVIRONMENT_VARIABLE" => "123456"    # Environment variable to override during Bitrise.io build
+    }
+)
+```
+
+## 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).
+
+## Author
+Robin Authiat, [@authiat_robin](https://twitter.com/authiat_robin)
+
+I'm available for freelance work (Fastlane Continuous Delivery, Continuous Integration and iOS development). Feel free to contact me 🚀

data/lib/fastlane/plugin/bitrise.rb

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

data/lib/fastlane/plugin/bitrise/actions/bitrise_action.rb

@@ -0,0 +1,227 @@
+require 'fastlane/action'
+require_relative '../helper/bitrise_helper'
+
+module Fastlane
+  module Actions
+    class BitriseAction < Action
+      def self.run(params)
+        FastlaneCore::PrintTable.print_values(config: params.values(ask: false),
+                                              hide_keys: [],
+                                              title: "Bitrise options")
+
+        json = get_post_payload(params[:trigger_token],
+                                params[:workflow],
+                                params[:build_message],
+                                params[:branch],
+                                params[:commit],
+                                params[:tag],
+                                params[:environments])
+
+        trigger_bitrise_build(params[:app_slug], json)
+      end
+
+      # Get POST payload json
+      #
+      # Parameters:
+      # - trigger_token: Bitrise.io trigger token
+      # - workflow: Bitrise.io workflow to trigger (optional)
+      # - build_message: Build message on Bitrise.io (optional)
+      # - branch: Git branch to trigger (optional)
+      # - commit: Git commit to trigger (optional)
+      # - tag: Git tag to trigger (optional)
+      # - environments: Environments variables hash to replace (optional)
+      #
+      # Returns the JSON post payload
+      def self.get_post_payload(trigger_token, workflow, build_message, branch, commit, tag, environments)
+        UI.message("Payload creation...")
+        json_curl = {}
+        payload = {}
+
+        hook_info = {}
+        hook_info["type"] = "bitrise"
+        hook_info["build_trigger_token"] = trigger_token
+        payload["hook_info"] = hook_info
+
+        build_params = {}
+        unless workflow.nil?
+          build_params["workflow_id"] = workflow
+        end
+
+        unless build_message.nil? || build_message.empty?
+          build_params["commit_message"] = build_message
+        end
+
+        unless branch.nil?
+          build_params["branch"] = branch
+        end
+
+        unless commit.nil?
+          build_params["commit_hash"] = commit
+        end
+
+        unless tag.nil?
+          build_params["tag"] = tag
+        end
+
+        unless environments.nil?
+          build_params["environments"] = get_environments_from(environments)
+        end
+        payload["build_params"] = build_params
+        json_curl["payload"] = payload
+
+        json_curl.to_json
+      end
+
+      # Transform environments variable hash into dictionary objects
+      #
+      # Parameters:
+      # - params: Environments hash to transform
+      #
+      # Returns the environments objects array
+      def self.get_environments_from(params)
+        environments = []
+
+        params.each do |key, value|
+          environment = {}
+          environment["mapped_to"] = key
+          environment["value"] = value
+          environment["is_expand"] = true
+
+          environments.push(environment)
+        end
+
+        environments
+      end
+
+      # Call the Bitrise.io API with a POST HTTP request with the specified payload.
+      # It'll throw an exception if the API return an other HTTP status code than 201.
+      #
+      # Parameters:
+      # - app_slug: Application slug
+      # - json: request payload
+      def self.trigger_bitrise_build(app_slug, json)
+        UI.command(json)
+
+        UI.message("Requesting Bitrise.io API...")
+        uri = URI.parse("https://app.bitrise.io/app/#{app_slug}/build/start.json")
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Post.new(uri.path, { 'Content-Type' => 'application/json' })
+        request.body = json
+        response = https.request(request)
+        json_response = JSON.parse(response.body)
+        FastlaneCore::PrintTable.print_values(config: json_response,
+                                              hide_keys: [],
+                                              title: "Bitrise API response")
+
+        if response.code == "201"
+          UI.success("Build triggered successfully on Bitrise.io 🚀")
+        else
+          if response.code == "400"
+            error = json_response["message"]
+          else
+            error = json_response["error_msg"]
+          end
+          UI.user_error!("Couln't trigger the build on Bitrise.io. #{error}")
+        end
+
+        build_infos = {}
+        build_infos["build_number"] = json_response["build_number"]
+        build_infos["build_url"] = json_response["build_url"]
+
+        build_infos
+      end
+
+      def self.description
+        "Trigger a bitrise build"
+      end
+
+      def self.authors
+        ["Robin AUTHIAT"]
+      end
+
+      def self.return_value
+        "If the build could be triggered, it returns the build informations such as the bitrise build number and the bitrise build url in a Hash"
+      end
+
+      def self.details
+        "This plugin allow you to trigger a specific Bitrise workflow with some arguments with a HTTPS POST on the Bitrise API."
+      end
+
+      def self.available_options
+        [
+          # App specific parameters
+          FastlaneCore::ConfigItem.new(key: :app_slug,
+                                  env_name: "BITRISE_APP_SLUG",
+                               description: "Bitrise application slug, avalaible on bitrise.io > your app > code",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No Bitrise app slug given, pass it using `app_slug` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end),
+          FastlaneCore::ConfigItem.new(key: :trigger_token,
+                                  env_name: "BITRISE_TRIGGER_TOKEN",
+                               description: "Bitrise build trigger token, avalaible on bitrise.io > your app > code",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No Bitrise trigger token given, pass it using `trigger_token` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end),
+          # Bitrise.io specific parameters
+          FastlaneCore::ConfigItem.new(key: :workflow,
+                                  env_name: "BITRISE_WORKFLOW",
+                               description: "Bitrise workflow to trigger, if not specified, it'll trigger the default one",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Empty Bitrise workflow given, pass it using `workflow` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end),
+          FastlaneCore::ConfigItem.new(key: :build_message,
+                                  env_name: "BITRISE_BUILD_MESSAGE",
+                               description: "Build message who'll appear on Bitrise.io build",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :environments,
+                                  env_name: "BITRISE_ENVIRONMENTS",
+                               description: "Bitrise environments to replace, it'll override the previous environment variables specified. The Hash key has to be the environment variable key (without the $), the Hash value has to be environment variable value",
+                                  optional: true,
+                                      type: Hash,
+                              verify_block: proc do |value|
+                                              value.each do |key|
+                                                UI.user_error!("Please remove the '$' from the environment variable #{key}") if key.to_s.include?("$")
+                                              end
+                                            end),
+          # Git related parameters
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                  env_name: "BITRISE_GIT_BRANCH",
+                               description: "Git branch where to trigger bitrise workflow",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Empty Bitrise git branch given, pass it using `branch` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end),
+          FastlaneCore::ConfigItem.new(key: :commit,
+                                  env_name: "BITRISE_GIT_COMMIT",
+                               description: "Specific Git commit to trigger bitrise workflow",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Empty Bitrise git commit given, pass it using `commit` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end),
+          FastlaneCore::ConfigItem.new(key: :tag,
+                                  env_name: "BITRISE_GIT_TAG",
+                               description: "Specific Git tag to trigger bitrise workflow",
+                                  optional: true,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Empty Bitrise git tag given, pass it using `tag` parameter to the bitrise plugin.") unless value && !value.empty?
+                                            end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitrise/helper/bitrise_helper.rb

@@ -0,0 +1,10 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class BitriseHelper
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bitrise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin AUTHIAT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-31 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.112.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.112.0
+description: 
+email: authiatr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/bitrise.rb
+- lib/fastlane/plugin/bitrise/actions/bitrise_action.rb
+- lib/fastlane/plugin/bitrise/helper/bitrise_helper.rb
+- lib/fastlane/plugin/bitrise/version.rb
+homepage: https://github.com/authiatr/fastlane-plugin-bitrise
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Trigger a bitrise build
+test_files: []