fastlane-plugin-jira_versions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33da91cd26f04c07ab486ee97746da815a11069c
+  data.tar.gz: 41d7079efec23a1dbc669045b5c8a253c92a07fc
+SHA512:
+  metadata.gz: ae25ab47a6a5cd5e730361b7b2d2af91495c567bc0b9192f90afb72dcf37a88226633ad39bd1d498fb0ea62086be2268efe4eea9301360a0b25c3d8f5a8ab064
+  data.tar.gz: 9913ead2679d7c52670cb6f7f033b9cfc3d695d696ef43f9e3959aa490c9c5c196e420c00068dc2495ab38f32710a2521a049d761119e0c9b9df1bf39b4f9640

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sandy Chapman <sandychapman@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,54 @@
+# jira_versions plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_versions)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_versions`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_versions
+```
+
+## About jira_versions
+
+Manage your JIRA project's releases/versions with this plugin.
+
+Currently, jira_versions comes with two actions, `create_jira_version` and `release_jira_version`. The first will create a new version in your JIRA project and the second will release a version.
+
+## Create Version 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`, modifying the placeholder variables in the Fastfile lane and running `bundle exec fastlane create_version`. 
+
+## Release Version 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`, modifying the placeholder variables in the Fastfile lane and running `bundle exec fastlane release_version`. 
+
+## 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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/jira_versions.rb

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

data/lib/fastlane/plugin/jira_versions/actions/create_jira_version.rb

@@ -0,0 +1,173 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      CREATE_JIRA_VERSION_VERSION_ID = :CREATE_JIRA_VERSION_VERSION_ID
+    end
+
+    class CreateJiraVersionAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        site         = params[:url]
+        context_path = ""
+        auth_type    = :basic
+        username     = params[:username]
+        password     = params[:password]
+        project_name = params[:project_name]
+        project_id   = params[:project_id]
+        name         = params[:name]
+        description  = params[:description]
+        archived     = params[:archived]
+        released     = params[:released]
+        start_date   = params[:start_date]
+
+        options = {
+          username:     username,
+          password:     password,
+          site:         site,
+          context_path: context_path,
+          auth_type:    auth_type,
+          read_timeout: 120
+        }
+
+        client = JIRA::Client.new(options)
+
+        unless project_name.nil?
+          project = client.Project.find(project_name)
+          project_id = project.id
+        end
+
+        if start_date.nil?
+          start_date = Date.today.to_s
+        end
+
+        version = client.Version.build
+        version.save!({
+          "description" => description,
+          "name" => name,
+          "archived" => archived,
+          "released" => released,
+          "startDate" => start_date,
+          "projectId" => project_id
+        })
+        version.fetch
+        Actions.lane_context[SharedValues::CREATE_JIRA_VERSION_VERSION_ID] = version.id
+        version.id
+      rescue
+        UI.user_error!("Failed to create new JIRA version: #{$!.response.body}")
+        false
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Creates a new version in your JIRA project"
+      end
+
+      def self.details
+        "Use this action to create a new version in JIRA"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                      env_name: "FL_CREATE_JIRA_VERSION_SITE",
+                                      description: "URL for Jira instance",
+                                      type: String,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("No url for Jira given, pass using `url: 'url'`") unless value and !value.empty?
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_CREATE_JIRA_VERSION_USERNAME",
+                                       description: "Username for JIRA instance",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username given, pass using `username: 'jira_user'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_CREATE_JIRA_VERSION_PASSWORD",
+                                       description: "Password for Jira",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password given, pass using `password: 'T0PS3CR3T'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_name,
+                                       env_name: "FL_CREATE_JIRA_VERSION_PROJECT_NAME",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_id],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_name' and '#{project_id}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "FL_CREATE_JIRA_VERSION_PROJECT_ID",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_name],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_id' and '#{project_name}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "FL_CREATE_JIRA_VERSION_NAME",
+                                       description: "The name of the version. E.g. 1.0.0",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No version name given, pass using `name: '1.0.0'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :description,
+                                       env_name: "FL_CREATE_JIRA_VERSION_DESCRIPTION",
+                                       description: "The description of the JIRA project version",
+                                       type: String,
+                                       optional: true,
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :archived,
+                                       env_name: "FL_CREATE_JIRA_VERSION_ARCHIVED",
+                                       description: "Whether the version should be archived",
+                                       optional: true,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :released,
+                                       env_name: "FL_CREATE_JIRA_VERSION_CREATED",
+                                       description: "Whether the version should be released",
+                                       optional: true,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :start_date,
+                                       env_name: "FL_CREATE_JIRA_VERSION_START_DATE",
+                                       description: "The date this version will start on",
+                                       type: String,
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: Date.today.to_s)
+        ]
+      end
+
+      def self.output
+        [
+          ['CREATE_JIRA_VERSION_VERSION_ID', 'The versionId for the newly created JIRA project version']
+        ]
+      end
+
+      def self.return_value
+        'The versionId for the newly create JIRA project version'
+      end
+
+      def self.authors
+        ["https://github.com/SandyChapman"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_versions/actions/release_jira_version.rb

@@ -0,0 +1,155 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      RELEASE_JIRA_VERSION_VERSION_ID = :RELEASE_JIRA_VERSION_VERSION_ID
+    end
+
+    class ReleaseJiraVersionAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        site         = params[:url]
+        context_path = ""
+        auth_type    = :basic
+        username     = params[:username]
+        password     = params[:password]
+        project_name = params[:project_name]
+        project_id   = params[:project_id]
+        name         = params[:name]
+        release_date = params[:release_date]
+        released     = true
+
+        options = {
+          username:     username,
+          password:     password,
+          site:         site,
+          context_path: context_path,
+          auth_type:    auth_type,
+          read_timeout: 120
+        }
+
+        client = JIRA::Client.new(options)
+
+        unless project_name.nil?
+          project = client.Project.find(project_name)
+          project_id = project.id
+        end
+
+        version = project.versions.find { |version| version.name == name }
+        if version.nil?
+          raise "Version '#{name}' not found."
+          return false
+        end
+        version.save!({
+          "released" => released,
+          "releaseDate" => release_date,
+          "projectId" => project_id
+        })
+        version.fetch
+        Actions.lane_context[SharedValues::RELEASE_JIRA_VERSION_VERSION_ID] = version.id
+        version.id
+      rescue RuntimeError
+        UI.user_error!("#{$!}")
+        false
+      rescue JIRA::HTTPError
+        UI.user_error!("Failed to release new JIRA version: #{$!.response.body}")
+        false
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Releases a version in your JIRA project"
+      end
+
+      def self.details
+        "Use this action to release a version in JIRA"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                      env_name: "FL_RELEASE_JIRA_VERSION_SITE",
+                                      description: "URL for Jira instance",
+                                      type: String,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("No url for Jira given, pass using `url: 'url'`") unless value and !value.empty?
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_RELEASE_JIRA_VERSION_USERNAME",
+                                       description: "Username for JIRA instance",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username given, pass using `username: 'jira_user'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_RELEASE_JIRA_VERSION_PASSWORD",
+                                       description: "Password for Jira",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password given, pass using `password: 'T0PS3CR3T'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_name,
+                                       env_name: "FL_RELEASE_JIRA_VERSION_PROJECT_NAME",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_id],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_name' and '#{project_id}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "FL_RELEASE_JIRA_VERSION_PROJECT_ID",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_name],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_id' and '#{project_name}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "FL_RELEASE_JIRA_VERSION_NAME",
+                                       description: "The name of the version. E.g. 1.0.0",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No version name given, pass using `name: '1.0.0'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :release_date,
+                                       env_name: "FL_CREATE_JIRA_VERSION_RELEASE_DATE",
+                                       description: "The date this version ended on",
+                                       type: String,
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: Date.today.to_s)
+        ]
+      end
+
+      def self.output
+        [
+          ['RELEASE_JIRA_VERSION_VERSION_ID', 'The versionId for the newly released JIRA project version']
+        ]
+      end
+
+      def self.return_value
+        'The versionId for the newly release JIRA project version'
+      end
+
+      def self.authors
+        ["https://github.com/SandyChapman"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_versions/helper/jira_versions_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class JiraVersionsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JiraVersionsHelper.your_method`
+      #
+      # def self.show_message
+      #   UI.message("Hello from the jira_versions plugin helper!")
+      # end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_versions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sandy Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !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: 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'
+  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: 1.102.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.102.0
+description: 
+email: sandychapman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_versions.rb
+- lib/fastlane/plugin/jira_versions/actions/create_jira_version.rb
+- lib/fastlane/plugin/jira_versions/actions/release_jira_version.rb
+- lib/fastlane/plugin/jira_versions/helper/jira_versions_helper.rb
+- lib/fastlane/plugin/jira_versions/version.rb
+homepage: https://github.com/SandyChapman/fastlane-plugin-jira_versions
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Manage your JIRA project's releases/versions with this plugin.
+test_files: []