story_branch 0.5.2 → 0.6.0alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b3a60904386aff18987e5417ec525b85300d962
-  data.tar.gz: 23e79de42834af29be24fdaea8892c30eb184742
+SHA256:
+  metadata.gz: c9a02518d7bc7ed6989a8bac354b4586d52268211024e1253f33ca0345c4f08d
+  data.tar.gz: 38a6bdff3edc0038164d693964738d7a9eff743ddb9fade2c1a3a9c01cd70fd1
 SHA512:
-  metadata.gz: 7791b6bde96724dfac853a9f84e4e0772638af3867c2bfd5a1030cc514a2c0e98544bb23b1c4d92156ddd567452e8328bed1590e6e3b997f92ca61135ed08eee
-  data.tar.gz: 9b44e870c1e5d67c984d130ea30a900641b7f88f56580976fd28a91bbde5a7a8d93c91b019a1c9263d3a2bfe476e1c999b0845ac5267ca4acb2ef216d23dd4e7
+  metadata.gz: fdfc646432ce7e0b952659de39efdadc0fc2e09ede2e3e9651d00a3e5840719a14279ae92cec49552572638fa4fdc23eaffe365f65bceec8df97ee494189e84f
+  data.tar.gz: 2eebfaf7313adbb7d48c8f4d91f054db99d3fc1af63b20bb6996a7e260b104d68d23913224d4429e12b3d9d468e5430b99fcb63988700ddb6a0e49c0d00775ef

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 
 defaults: &defaults
   docker:
-    - image: circleci/ruby:2.4.1-node-browsers
+    - image: circleci/ruby:2.6.5-node
   working_directory: ~/repo
 
 workflows:
@@ -11,15 +11,18 @@ workflows:
     jobs:
       - test:
           filters:
-            branches:
+            tags:
+              # this enables circleci to trigger on tags
               only: /.*/
 
       - publish:
           requires:
             - test
           filters:
+            tags:
+              only: /^v[0-9]\.[0-9]\.[0-9].*/
             branches:
-              only: master
+              ignore: /.*/
 
 jobs:
   test:
@@ -89,13 +92,6 @@ jobs:
           name: Publish to Rubygems
           command: |
             CURRENT_VERSION=$(ruby -r "./lib/story_branch/version.rb" -e "puts StoryBranch::VERSION")
-            CURRENT_TAG=$(git tag --points-at HEAD)
-
-            if [[ "${CURRENT_TAG}" == "${CURRENT_VERSION}" ]]; then
-              gem build story_branch.gemspec
-              gem push "story_branch-${CURRENT_VERSION}.gem"
-            else
-              echo "Not tagged as a new version - skipping gem push"
-            fi
-
+            gem build story_branch.gemspec
+            gem push "story_branch-${CURRENT_VERSION}.gem"
             shred -u ~/.gem/credentials

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    story_branch (0.5.2)
+    story_branch (0.6.0alpha)
       blanket_wrapper (~> 3.0)
       damerau-levenshtein (~> 1.3)
+      jira-ruby (~> 1.7)
       thor (~> 0.20.0)
       tty-command (~> 0.8.2)
       tty-config (~> 0.2.0)
@@ -13,49 +14,75 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    atlassian-jwt (0.2.0)
+      jwt (~> 2.1.0)
     blanket_wrapper (3.0.2)
       httparty
       recursive-open-struct
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     damerau-levenshtein (1.3.1)
     diff-lcs (1.3)
-    equatable (0.6.0)
-    fakefs (0.18.0)
+    equatable (0.6.1)
+    fakefs (0.20.1)
     git (1.5.0)
-    httparty (0.17.0)
+    httparty (0.17.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.2.2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jira-ruby (1.7.1)
+      activesupport
+      atlassian-jwt
+      multipart-post
+      oauth (~> 0.5, >= 0.5.0)
+    jwt (2.1.0)
+    method_source (0.9.2)
+    mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
+    mime-types-data (3.2019.0904)
+    minitest (5.12.2)
     multi_xml (0.6.0)
+    multipart-post (2.1.1)
     necromancer (0.5.0)
+    oauth (0.5.4)
     ostruct (0.1.0)
     pastel (0.7.3)
       equatable (~> 0.6)
       tty-color (~> 0.5)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     recursive-open-struct (1.1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    strings (0.1.5)
+    strings (0.1.6)
       strings-ansi (~> 0.1)
       unicode-display_width (~> 1.5)
       unicode_utils (~> 1.4)
     strings-ansi (0.1.0)
     thor (0.20.3)
+    thread_safe (0.3.6)
     tty-color (0.5.0)
     tty-command (0.8.2)
       pastel (~> 0.7.0)
@@ -75,9 +102,12 @@ GEM
       wisper (~> 2.0.0)
     tty-screen (0.7.0)
     tty-which (0.4.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     unicode_utils (1.4.0)
     wisper (2.0.0)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby
@@ -87,6 +117,7 @@ DEPENDENCIES
   fakefs (~> 0.14)
   git (~> 1.5)
   ostruct (~> 0.1)
+  pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3)
   rspec_junit_formatter (~> 0.4)

data/README.md

@@ -113,8 +113,8 @@ the full list.
 ## Configuring PivotalTracker
 
 When running the command `story_branch add` you'll be asked 3 things:
-1. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
-2. tracker - You should select Pivotal Tracker
+1. tracker - You should select Pivotal Tracker
+2. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
 3. api key - this is your personal api key. You can get that from [your profile page](https://www.pivotaltracker.com/profile)
 
 ## Configuring Github
@@ -125,6 +125,16 @@ When running the command `story_branch add` you'll be asked 3 things:
 3. api key - this is your personal api token. You can create one under your
 [developer profile tokens page](https://github.com/settings/tokens)
 
+## Configuring JIRA
+
+The configuration for JIRA is slightly more complex as the endpoint changes according
+to your project setup. You will need an API token, which you can create a new one in your [JIRA id management page](https://id.atlassian.com/manage/api-tokens)
+1. tracker - You should select JIRA
+2. JIRA's subdomain - you should type the JIRA's subdomain that you use to access in your browser. E.g I'd type perxtechnologies to access to https://perxtechnologies.atlassian.net
+3. JIRA's project key - this should match which project you want to fetch the issues from. E.g. PW is the key for my Project Whistler, so I'd type PW
+4. API key that you should have gotten in the first description step
+5. username used for login in the JIRA usually. If you use google email authentication, the username should be your email
+
 ## Migrating
 
 ### Old configuration

data/lib/story_branch/commands/add.rb

@@ -20,8 +20,8 @@ module StoryBranch
       end
 
       def execute(_input: $stdin, output: $stdout)
-        create_global_config
         create_local_config
+        create_global_config
         output.puts 'Configuration added successfully'
       end
 
@@ -30,24 +30,44 @@ module StoryBranch
       def create_local_config
         return if local_config_has_value?
 
+        puts "Setting #{tracker}"
+        @local_config.set(:tracker, value: tracker)
+
         puts "Appending #{project_id}"
         @local_config.append(project_id, to: :project_id)
 
-        puts "Setting #{tracker}"
-        @local_config.set(:tracker, value: tracker)
         @local_config.write(force: true)
       end
 
       def create_global_config
-        api_key = prompt.ask 'Please provide the api key:'
+        api_key = prompt.ask('Please provide the api key:', required: true)
         @config.set(project_id, :api_key, value: api_key)
         @config.write(force: true)
+
+        return unless tracker == 'jira'
+
+        # rubocop:disable Metrics/LineLength
+        username = prompt.ask('Please provide username (email most of the times) for this key:',
+                              required: true)
+        # rubocop:enable Metrics/LineLength
+        @config.set(project_id, :username, value: username)
+        @config.write(force: true)
       end
 
       def project_id
         return @project_id if @project_id
 
-        @project_id = prompt.ask "Please provide this project's id:"
+        if tracker == 'jira'
+          # rubocop:disable Metrics/LineLength
+          project_domain = prompt.ask("What is your JIRA's subdomain?", required: true)
+          project_key = prompt.ask("What is your JIRA's project key?", required: true)
+          # rubocop:enable Metrics/LineLength
+          @project_id = "#{project_domain}|#{project_key}"
+        else
+          # rubocop:disable Metrics/LineLength
+          @project_id = prompt.ask("Please provide this project's id:", required: true)
+          # rubocop:enable Metrics/LineLength
+        end
       end
 
       def tracker
@@ -55,7 +75,8 @@ module StoryBranch
 
         trackers = {
           'Pivotal Tracker' => 'pivotal-tracker',
-          'Github' => 'github'
+          'Github' => 'github',
+          'JIRA' => 'jira'
         }
         @tracker = prompt.select('Which tracker are you using?', trackers)
       end

data/lib/story_branch/jira/issue.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StoryBranch
+  module Jira
+    # Jira Issue representation
+    class Issue
+      attr_accessor :title, :id
+
+      # TODO: Add component and labels to the info of the issue
+      def initialize(jira_issue, project)
+        @project = project
+        @story = jira_issue
+        @title = jira_issue.summary
+        @id = jira_issue.key
+      end
+
+      def update_state
+        puts 'What to do in github for this?'
+      end
+
+      def to_s
+        "#{@id} - #{@title}"
+      end
+
+      def dashed_title
+        StoryBranch::StringUtils.normalised_branch_name @title
+      end
+    end
+  end
+end

data/lib/story_branch/jira/project.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative './issue'
+
+module StoryBranch
+  module Jira
+    # Jira Project representation
+    class Project
+      def initialize(jira_project)
+        @project = jira_project
+      end
+
+      # Returns an array of Jira issues (Issue Class)
+      # TODO: Support different options being passed.
+      # Probably will need a specific query builder per tracker
+      def stories(options = {})
+        stories = if options[:id]
+                    [@project.issues.find(options[:id])]
+                  else
+                    # rubocop:disable Metrics/LineLength
+                    @project.client.Issue.jql(
+                      "project=#{@project.key} AND status='To Do' AND assignee=currentUser()"
+                    )
+                    # rubocop:enable Metrics/LineLength
+                  end
+
+        stories.map { |s| Issue.new(s, @project) }
+      end
+    end
+  end
+end

data/lib/story_branch/jira/tracker.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# NOTE: The JIRA api is restful but I don't seem to be able to wrap it
+# with blanket, so I'm using a gem that has wrapped the whole api, but
+# my tracker and issues will still provide a similar api. This jira-ruby
+# is used to get the data.
+require 'jira-ruby'
+require_relative './project'
+
+module StoryBranch
+  module Jira
+    # JIRA API wrapper for story branch tracker
+    class Tracker
+      TYPE = 'jira'
+
+      attr_reader :type
+
+      def initialize(tracker_domain:, project_id:, api_key:, username:)
+        @tracker_url = "https://#{tracker_domain}.atlassian.net"
+        @project_id = project_id
+        @api_key = api_key
+        @username = username
+        @type = TYPE
+      end
+
+      def valid?
+        [@api_key, @project_id, @username, @tracker_url].none?(&:nil?)
+      end
+
+      # TODO: This should probably be renamed to something more meaningful
+      # in the sense that it should be workable stories/issues
+      # which depend on the tracker's workflow. PivotalTracker they need to
+      # be started and estimated, while for Github they just need to be open
+      def stories
+        project.stories
+      end
+
+      def get_story_by_id(story_id)
+        project.stories(id: story_id).first
+      end
+
+      private
+
+      def options
+        {
+          username: @username,
+          password: @api_key,
+          site: @tracker_url,
+          auth_type: :basic,
+          read_timeout: 120,
+          context_path: ''
+        }
+      end
+
+      def api
+        raise 'API key must be specified' unless @api_key
+
+        @api ||= JIRA::Client.new(options)
+      end
+
+      def project
+        return @project if @project
+        raise 'project key must be set' unless @project_id
+
+        jira_project = api.Project.find(@project_id)
+        @project = Project.new(jira_project)
+      end
+    end
+  end
+end

data/lib/story_branch/main.rb

@@ -2,6 +2,7 @@
 
 require_relative './pivotal/tracker'
 require_relative './github/tracker'
+require_relative './jira/tracker'
 require_relative './git_utils'
 require_relative './git_wrapper'
 require_relative './config_manager'
@@ -10,6 +11,7 @@ require 'tty-prompt'
 module StoryBranch
   # Main story branch class. It is resposnible for the main interaction between
   # the user and Pivotal Tracker. It is also responsible for config init.
+  # rubocop:disable Metrics/ClassLength
   class Main
     attr_accessor :tracker
 
@@ -43,7 +45,9 @@ module StoryBranch
       return if unstaged_changes?
       return if nothing_to_add?
 
+      # rubocop:disable Metrics/LineLength
       commit_message = "[#{finish_tag} ##{current_story[:id]}] #{current_story[:title]}"
+      # rubocop:enable Metrics/LineLength
       proceed = prompt.yes?("Commit with standard message? #{commit_message}")
       if proceed
         GitWrapper.commit commit_message
@@ -112,6 +116,8 @@ module StoryBranch
       true
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def update_status(current_status, next_status, action)
       stories = @tracker.stories_with_state(current_status)
       if stories.empty?
@@ -134,6 +140,8 @@ module StoryBranch
       prompt.ok("#{story.id} #{next_status}")
       story
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     def build_stories_structure(stories)
       options = {}
@@ -170,7 +178,9 @@ module StoryBranch
       return unless validate_branch_name(feature_branch_name, story.id)
 
       feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
+      # rubocop:disable Metrics/LineLength
       prompt.say("Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent")
+      # rubocop:enable Metrics/LineLength
       GitWrapper.create_branch feature_branch_name_with_story_id
     end
 
@@ -181,7 +191,9 @@ module StoryBranch
         return false
       end
       if GitUtils.existing_branch? name
+        # rubocop:disable Metrics/LineLength
         prompt.error('This name is very similar to an existing branch. Avoid confusion and use a more unique name.')
+        # rubocop:enable Metrics/LineLength
         return false
       end
       true
@@ -202,9 +214,15 @@ module StoryBranch
     end
 
     def api_key
-      @api_key || @api_key = @global_config.fetch(project_id, :api_key)
+      @api_key ||= @global_config.fetch(project_id, :api_key)
     end
 
+    def username
+      @username ||= @global_config.fetch(project_id, :username)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def initialize_tracker
       if project_id.nil?
         prompt.say 'Project ID not set'
@@ -214,9 +232,21 @@ module StoryBranch
       @tracker = case tracker_type
                  when 'github'
                    StoryBranch::Github::Tracker.new(project_id, api_key)
-                 else
+                 when 'pivotal-tracker'
                    StoryBranch::Pivotal::Tracker.new(project_id, api_key)
+                 when 'jira'
+                   tracker_domain, project_key = project_id.split('|')
+                   options = {
+                     tracker_domain: tracker_domain,
+                     project_id: project_key,
+                     api_key: api_key,
+                     username: username
+                   }
+                   StoryBranch::Jira::Tracker.new(options)
                  end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/story_branch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoryBranch
-  VERSION = '0.5.2'
+  VERSION = '0.6.0alpha'
 end

data/story_branch.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
     'gabe@neo.com'
   ]
 
-  spec.summary = 'Create git branches based on pivotal tracker stories'
+  spec.summary = 'Create git branches based on your preferred tracker tickets'
   spec.description = <<~DESCRIPTION
-    Simple gem that fetches the available stories in your PivotalTracker
-    project and allows you to create a git branch with the name based
-    on the selected story
+    This simple gem allows you to create a branch based on the existing issues
+    in your preferred tracker. It integrates with PivotalTracker, Github and
+    JIRA. Different workflows shall be supported in the next versions.
   DESCRIPTION
 
   spec.metadata = {
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
     'homepage_uri' => 'https://github.com/story-branch/story_branch',
     'source_code_uri' => 'https://github.com/story-branch/story_branch'
   }
-  spec.required_ruby_version = ['>= 2.3', '< 2.7']
+  spec.required_ruby_version = ['>= 2.4', '< 2.7']
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been
@@ -54,6 +54,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'blanket_wrapper', '~> 3.0'
   spec.add_runtime_dependency 'damerau-levenshtein', '~> 1.3'
+  spec.add_runtime_dependency 'jira-ruby', '~> 1.7'
   spec.add_runtime_dependency 'thor', '~> 0.20.0'
   spec.add_runtime_dependency 'tty-command', '~> 0.8.2'
   spec.add_runtime_dependency 'tty-config', '~> 0.2.0'
@@ -64,6 +65,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fakefs', '~> 0.14'
   spec.add_development_dependency 'git', '~> 1.5'
   spec.add_development_dependency 'ostruct', '~> 0.1'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0alpha
 platform: ruby
 authors:
 - Rui Baltazar
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -42,6 +42,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +182,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -211,9 +239,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 description: |
-  Simple gem that fetches the available stories in your PivotalTracker
-  project and allows you to create a git branch with the name based
-  on the selected story
+  This simple gem allows you to create a branch based on the existing issues
+  in your preferred tracker. It integrates with PivotalTracker, Github and
+  JIRA. Different workflows shall be supported in the next versions.
 email:
 - rui.p.baltazar@gmail.com
 - jasonm23@gmail.com
@@ -267,6 +295,9 @@ files:
 - lib/story_branch/github/milestone.rb
 - lib/story_branch/github/project.rb
 - lib/story_branch/github/tracker.rb
+- lib/story_branch/jira/issue.rb
+- lib/story_branch/jira/project.rb
+- lib/story_branch/jira/tracker.rb
 - lib/story_branch/main.rb
 - lib/story_branch/pivotal/project.rb
 - lib/story_branch/pivotal/story.rb
@@ -299,19 +330,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
   - - "<"
     - !ruby/object:Gem::Version
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Create git branches based on pivotal tracker stories
+summary: Create git branches based on your preferred tracker tickets
 test_files: []