fastlane-plugin-bitbucket_cloud 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05898f2847f189f3c984ea0b7c457c0604565c303a4e993b8a8f0f0cc775123
-  data.tar.gz: 7be76bdb1c69f2c4a8a19cd5fc2c3f89a1b910c0e81f8eac09bd094ec5a24352
+  metadata.gz: 2d25959af32deea019cda65a40a426fbe4a1f2855e72836c0751e0a825687376
+  data.tar.gz: e113acd322253daa69edfbd97f9c8bce0a33200f739cf3d080ad3cfde4119a40
 SHA512:
-  metadata.gz: 7837c51e7f78bf656f00a9cea4b13c047818dd99f62a018a54b09cb733215f47425d1679042344fa7930c8f914d8db8cd7bfb240ddee51dbd55e3624a819b04a
-  data.tar.gz: 0f394e3395f81189067d762c5504684fae33b3809d7f544a0380698bbcde0c2e67e3b4b890118a0924ff45038ff48680f99ad98e78c9d8851c7cb3036218282a
+  metadata.gz: 1c2406fcf6ca1f2b36c3bf8be2e08c50e4ea82993245543524e6af3b3634139d80beb5f0d60f0ddeaff4ce16eccf8f3f068ed21bc28d8870f339fb2fc2bf403e
+  data.tar.gz: ea793b4bfc9c11a11448c575d50c7c225244c46165995c8af951b6e5673e512828cfe5e199e630c72965412152746de9e6c84584a048d3713d407887b5983b57

data/README.md

@@ -16,14 +16,15 @@ 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:
+For now we suppor the following apis:
 
 - [Create pull request](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/#api-repositories-workspace-repo-slug-pullrequests-post)
-
+- [List default reviewers](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/#api-repositories-workspace-repo-slug-default-reviewers-get)
 
 For each supported api there is a plugin action available:
 
 - bitbucket_create_pull_request
+- bitbucket_list_default_reviewers
 
 ## Example
 

data/lib/fastlane/plugin/bitbucket_cloud/actions/bitbucket_create_pull_request.rb

@@ -12,17 +12,13 @@ module Fastlane
       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 = Helper::BitbucketCloudHelper.url(company_host_name: options[:company_host_name], repository_name: options[:repository_name], api: "pullrequests")
 
-        api_url = "https://api.bitbucket.org/2.0/repositories/#{company_host_name}/#{repository_name}/pullrequests"
-
-        headers = { "Content-Type": "application/json", Authorization: "Basic #{api_token}" }
+        headers = Helper::BitbucketCloudHelper.headers(username: options[:username], password: options[:password])
 
         payload = {
           title: options[:title],
@@ -55,8 +51,7 @@ module Fastlane
         unless reviewers.instance_of?(NilClass)
           reviewers_obj = reviewers.map do |reviewer|
             {
-              username: reviewer
-
+              uuid: reviewer
             }
           end
           payload[:reviewers] = reviewers_obj
@@ -68,12 +63,12 @@ module Fastlane
 
         response = Excon.post(api_url, headers: headers, body: payload)
 
-        result = self.formatted_result(response)
+        result = Helper::BitbucketCloudHelper.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)
+        Actions.lane_context[SharedValues::BITBUCKET_CREATE_PULL_REQUEST_RESULT] = Helper::BitbucketCloudHelper.formatted_context_result(response)
 
         if result[:status] != 201
           error_message = "Plugin Bitbucket finished with error code #{result[:status]} #{result[:reason_phrase]}"
@@ -84,27 +79,6 @@ module Fastlane
         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
@@ -167,7 +141,7 @@ module Fastlane
                                        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",
+                                       description: "List of reviewer's uuids for the pull request. If no reviewers are passed, fails back to default ones",
                                        type: Array,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :source_branch,

data/lib/fastlane/plugin/bitbucket_cloud/actions/bitbucket_list_defaults_reviewers.rb

@@ -0,0 +1,118 @@
+require 'fastlane/action'
+require 'fastlane_core'
+require_relative '../helper/bitbucket_cloud_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      BITBUCKET_LIST_DEFAULT_REVIEWERS_RESULT = :BITBUCKET_LIST_DEFAULT_REVIEWERS_RESULT
+    end
+
+    class BitbucketListDefaultReviewersAction < Action
+      def self.run(options)
+        require 'excon'
+
+        api_url = Helper::BitbucketCloudHelper.url(company_host_name: options[:company_host_name], repository_name: options[:repository_name], api: "default-reviewers")
+
+        headers = Helper::BitbucketCloudHelper.headers(username: options[:username], password: options[:password])
+
+        UI.important("Plugin Bitbucket will list all defaults reviewers")
+
+        response = Excon.get(api_url, headers: headers)
+
+        result = Helper::BitbucketCloudHelper.formatted_result(response)
+
+        UI.important("Plugin Bitbucket finished with result")
+        UI.important(result.to_s)
+
+        Actions.lane_context[SharedValues::BITBUCKET_LIST_DEFAULT_REVIEWERS_RESULT] = Helper::BitbucketCloudHelper.formatted_context_result(response)
+
+        if result[:status] != 200
+          error_message = "Plugin Bitbucket finished with error code #{result[:status]} #{result[:reason_phrase]}"
+          raise StandardError, error_message
+        end
+
+        UI.success("Successfully list all default reviewers!")
+        return result
+      end
+
+      def self.description
+        "List of all defaults reviewers of pull requests"
+      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)
+        ]
+      end
+
+      def self.output
+        [
+          ['BITBUCKET_LIST_DEFAULT_REVIEWERS_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_list_default_reviewers(
+              username: "YOUR_USERNAME_HERE",
+              password: "YOUR_PASSWORD_HERE",
+              company_host_name: "YOUR_COMPANY_HOST_HERE",
+              repository_name: "YOUR_REPOSITORY_NAME_HERE"
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -8,8 +8,39 @@ module Fastlane
       # 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!")
+      def self.url(options)
+        company_host_name = options[:company_host_name]
+        repository_name = options[:repository_name]
+        api = options[:api]
+
+        "https://api.bitbucket.org/2.0/repositories/#{company_host_name}/#{repository_name}/#{api}"
+      end
+
+      def self.headers(options)
+        api_token = Base64.strict_encode64("#{options[:username]}:#{options[:password]}")
+
+        { "Content-Type": "application/json", Authorization: "Basic #{api_token}" }
+      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
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module BitbucketCloud
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bitbucket_cloud
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Luca Tagliabue
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email: lu.tagliabue@reply.it
@@ -20,6 +20,7 @@ files:
 - README.md
 - lib/fastlane/plugin/bitbucket_cloud.rb
 - lib/fastlane/plugin/bitbucket_cloud/actions/bitbucket_create_pull_request.rb
+- lib/fastlane/plugin/bitbucket_cloud/actions/bitbucket_list_defaults_reviewers.rb
 - lib/fastlane/plugin/bitbucket_cloud/helper/bitbucket_cloud_helper.rb
 - lib/fastlane/plugin/bitbucket_cloud/version.rb
 homepage: https://github.com/lukluca/fastlane-plugin-bitbucket-cloud