fastlane-plugin-bitbucket_cloud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c67a44a51b40e1eca66f0e0d478dd94bc57dc765d1373b838e8b0d74f67a346b
+  data.tar.gz: e8bf1dd71648b723852afcc1aaf41200064c05d186af4aae94b6f80b2faabf77
+SHA512:
+  metadata.gz: f51e2ed8c96c7bbeed313dc8fd8ce8ed5a04e308121448183666ae2b050b31ad040664742736b97615650f3f987a833c742d56a2a97c339c842d4f52f2c444e3
+  data.tar.gz: '094eba38fe354d5782f7205c409f0cc721674513e10ec6ccbfa7bfc37132c7fe850c72c6821a1dbad023593b334e77d8cc9f7066f87f3d3d4f1d47007d9e3c3f'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Luca Tagliabue <lu.tagliabue@reply.it>
+
+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,59 @@
+# bitbucket-cloud plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bitbucket-cloud)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bitbucket`, add it to your project by running:
+
+```bash
+fastlane add_plugin bitbucket-cloud
+```
+
+## About bitbucket-cloud
+
+Wrapper of Bitbucket Cloud rest apis. 
+
+The aim of this plugin is to wrap the api listed in this [wiki](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication). 
+
+For now we suppor only one api:
+
+- [Create pull request](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/#api-repositories-workspace-repo-slug-pullrequests-post)
+
+
+For each supported api there is a plugin action available:
+
+- bitbucket_create_pull_request
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test_create_pull_request`.
+
+## 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/bitbucket_cloud/actions/bitbucket_create_pull_request.rb

@@ -0,0 +1,217 @@
+require 'fastlane/action'
+require 'fastlane_core'
+require_relative '../helper/bitbucket_cloud_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      BITBUCKET_CREATE_PULL_REQUEST_RESULT = :BITBUCKET_CREATE_PULL_REQUEST_RESULT
+    end
+
+    class BitbucketCreatePullRequestAction < Action
+      def self.run(options)
+        require 'excon'
+
+        company_host_name = options[:company_host_name]
+        repository_name = options[:repository_name]
+        destination_branch = options[:destination_branch]
+        description = options[:description]
+        reviewers = options[:reviewers]
+
+        api_token = Base64.strict_encode64("#{options[:username]}:#{options[:password]}")
+
+        api_url = "https://api.bitbucket.org/2.0/repositories/#{company_host_name}/#{repository_name}/pullrequests"
+
+        headers = { "Content-Type": "application/json", Authorization: "Basic #{api_token}" }
+
+        payload = {
+          title: options[:title],
+          source: {
+              branch: {
+                  name: options[:source_branch]
+              }
+          }
+        }
+
+        if destination_branch.instance_of?(NilClass)
+          destination_log = ""
+        else
+          destination_obj = {
+            branch: {
+                name: destination_branch
+            }
+          }
+          payload[:destination] = destination_obj
+          destination_log = " to '#{destination_branch}'"
+        end
+
+        if description.instance_of?(NilClass)
+          description_log = ""
+        else
+          payload[:description] = description
+          description_log = " and description '#{description}'"
+        end
+
+        unless reviewers.instance_of?(NilClass)
+          reviewers_obj = reviewers.map do |reviewer|
+            {
+              username: reviewer
+
+            }
+          end
+          payload[:reviewers] = reviewers_obj
+        end
+
+        payload = payload.to_json
+
+        UI.important("Plugin Bitbucket will create a new pull request from '#{options[:source_branch]}'#{destination_log} with title '#{options[:title]}'#{description_log}")
+
+        response = Excon.post(api_url, headers: headers, body: payload)
+
+        result = self.formatted_result(response)
+
+        UI.important("Plugin Bitbucket finished with result")
+        UI.important(result.to_s)
+
+        Actions.lane_context[SharedValues::BITBUCKET_CREATE_PULL_REQUEST_RESULT] = formatted_context_result(response)
+
+        if result[:status] != 201
+          error_message = "Plugin Bitbucket finished with error code #{result[:status]} #{result[:reason_phrase]}"
+          raise StandardError, error_message
+        end
+
+        UI.success("Successfully create a new Bitbucket pull request!")
+        return result
+      end
+
+      def self.formatted_result(response)
+        {
+          status: response[:status],
+          reason_phrase: response[:reason_phrase],
+          body: response.body || "",
+          json: self.parse_json(response.body) || {}
+        }
+      end
+
+      def self.formatted_context_result(response)
+        "Status code: #{response[:status]}, reason: #{response[:reason_phrase]}"
+      end
+
+      def self.parse_json(value)
+        require 'json'
+
+        JSON.parse(value)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def self.description
+        "Create a new pull request inside your Bitbucket project"
+      end
+
+      def self.details
+        "Wrapper of Bitbucket cloud rest apis in order to make easy integration of Bitbucket CI inside fastlane workflow"
+      end
+
+      def self.authors
+        ["Luca Tagliabue"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_USERNAME",
+                                       description: "Bitbucket username",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV.fetch("BITBUCKET_USERNAME", nil),
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_PASSWORD",
+                                       description: "Bitbucket password",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV.fetch("BITBUCKET_PASSWORD", nil),
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :company_host_name,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_COMPANY_HOST_NAME",
+                                       description: "Bitbucket company host name",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV.fetch("BITBUCKET_COMPANY_HOST_NAME", nil),
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :repository_name,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_REPOSITORY_NAME",
+                                       description: "Bitbucket repository name",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV.fetch("BITBUCKET_REPOSITORY_NAME", nil),
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :title,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_TITLE",
+                                       description: "Title of the pull request",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :description,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_DESCRIPTION",
+                                       description: "Description of the pull request",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :reviewers,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_REVIEWERS",
+                                       description: "List of reviewer's usernames for the pull request. If no reviewers are passed, fails back to default ones",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :source_branch,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_SOURCE_BRANCH",
+                                       description: "Name of the source branch",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :destination_branch,
+                                       env_name: "FL_POST_BITBUCKET_PULL_REQUEST_DESTINATION_BRANCH",
+                                       description: "Name of the destination branch",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['BITBUCKET_CREATE_PULL_REQUEST_RESULT', 'The result of the bitbucket rest cloud api']
+        ]
+      end
+
+      def self.return_value
+        'The result of the bitbucket rest cloud api'
+      end
+
+      def self.example_code
+        [
+          'bitbucket_create_pull_request(
+              username: "YOUR_USERNAME_HERE",
+              password: "YOUR_PASSWORD_HERE",
+              company_host_name: "YOUR_COMPANY_HOST_HERE",
+              repository_name: "YOUR_REPOSITORY_NAME_HERE",
+              title: "PULL_REQUEST_TITLE_HERE",
+              description: "PULL_REQUEST_DESCRIPTION_HERE",
+              reviewers: ["FIRST_REVIEWER", "SECOND_REVIEWER"],
+              source_branch: "YOUR_SOURCE_BRANCH_HERE",
+              destination_branch: "YOUR_DESTINATION_BRANCH_HERE"
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bitbucket_cloud/helper/bitbucket_cloud_helper.rb

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

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

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

data/lib/fastlane/plugin/bitbucket_cloud.rb

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

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bitbucket_cloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luca Tagliabue
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email: lu.tagliabue@reply.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/bitbucket_cloud.rb
+- lib/fastlane/plugin/bitbucket_cloud/actions/bitbucket_create_pull_request.rb
+- lib/fastlane/plugin/bitbucket_cloud/helper/bitbucket_cloud_helper.rb
+- lib/fastlane/plugin/bitbucket_cloud/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.5.5
+signing_key:
+specification_version: 4
+summary: Wrapper of Bitbucket cloud rest apis
+test_files: []