jira_issues 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0af8344be54c308755deaef573df770550958f08
+  data.tar.gz: ce0407b9febb0021dc0d0bbb3e26332ddb80f7ca
+SHA512:
+  metadata.gz: '079475baa0fba8868c81fc19b995b87af975d3563b3208c2c66c24f795ce46bacbc747d0119138a53c3cd6b50f0737f0614f9960ab9352e3eebd5697106c81d8'
+  data.tar.gz: bc6b091d7ec1e8d7e639dd9b7873c2b1b561cbee88e2561317d7764d5ecf6d424743f45bcaa18340ed5fcb3efce76704d2900e83c53bc93f61e068bbe5a528f5

data/lib/jira_issues.rb

@@ -0,0 +1,7 @@
+require 'jira_issues/jira_adapter'
+require 'jira_issues/jira_workflow'
+require 'jira_issues/jira_query'
+require 'jira_issues/jira_issues_stats'
+require 'jira_issues/jira_issues_navigator'
+require 'jira_issues/jira_issue_mapper'
+require 'jira_issues/jql_lib'

data/lib/jira_issues/jira_adapter.rb

@@ -0,0 +1,32 @@
+require 'jira-ruby'
+
+module JiraIssues
+  class JiraAdapter
+    def create_task(task)
+      issue = client.Issue.build
+      issue.save(task.print)
+    end
+
+    def available?
+      response = client.get('/')
+      response.code == '200'
+    end
+
+    def jql(jql_query, fields)
+      client.Issue.jql(jql_query, fields)
+    end
+
+    private
+
+    def client
+      @client = JIRA::Client.new(
+          username: ENV['JIRA_USERNAME'],
+          password: ENV['JIRA_PASSWORD'],
+          site: ENV['JIRA_URL'],
+          context_path: '',
+          auth_type: :basic,
+          read_timeout: 120
+      )
+    end
+  end
+end

data/lib/jira_issues/jira_issue_mapper.rb

@@ -0,0 +1,31 @@
+module JiraIssues
+  class JiraIssueMapper
+    # WIP
+    # ATM mapper serialises issue to JSON
+    # We might consider using objects
+
+    def call(issue)
+      status = decode_status(issue)
+      {
+          key: issue.key,
+          type: issue.issuetype.name,
+          priority: issue.priority.name,
+          status: status,
+          #description: i.description,
+          summary: issue.summary,
+          created_date: issue.created,
+          closed_date: issue.resolutiondate
+      }
+    end
+
+    private
+
+    def decode_status(issue)
+      JiraIssues::JiraWorkflow.issue_status_for_name(project_key(issue),issue.status.name)
+    end
+
+    def project_key(issue)
+      issue.key.split('-').first
+    end
+  end
+end

data/lib/jira_issues/jira_issues_navigator.rb

@@ -0,0 +1,50 @@
+module JiraIssues
+  class JiraIssuesNavigator
+    include JiraIssues::JiraIssueStats
+
+    def initialize(issues)
+      @issues = issues
+    end
+
+    def issues 
+      @issues
+    end 
+
+    def all
+      JiraIssuesNavigator.new @issues
+    end
+
+    def open
+      JiraIssuesNavigator.new @issues.select {|i| i[:status] == JiraWorkflow::OPEN}
+    end
+
+    def blocked
+      JiraIssuesNavigator.new @issues.select {|i| i[:status] == JiraWorkflow::BLOCKED}
+    end
+
+    def in_progress
+      JiraIssuesNavigator.new @issues.select {|i| i[:status] == JiraWorkflow::IN_PROGRESS}
+    end
+
+    def closed
+      JiraIssuesNavigator.new @issues.select {|i| i[:status] == JiraWorkflow::CLOSED}
+    end
+
+    def with_status(status: selected_status)
+      JiraIssuesNavigator.new @issues.select {|i| i[:status] == @issue_states[selected_status]}
+    end
+
+    #aliases
+    def todo
+      open
+    end
+
+    def done
+      closed
+    end 
+
+    def ip 
+      in_progress
+    end
+  end
+end

data/lib/jira_issues/jira_issues_stats.rb

@@ -0,0 +1,11 @@
+module JiraIssues
+    module JiraIssueStats 
+        def created_by_week
+            @issues.map { |i| { key: i[:key], week_created: Date.parse(i[:created_date]).beginning_of_week } }.group_by { |x| x[:week_created]  }.map { |k, v| [k, v.count] }.to_h.sort
+        end
+    
+        def closed_by_week
+            @issues.select { |i| !i[:closed_date].nil? }.map { |i| { key: i[:key], week_closed: Date.parse(i[:closed_date]).beginning_of_week } }.group_by { |x| x[:week_closed]}.map { |k, v| [k, v.count] }.to_h.sort
+        end
+    end
+end

data/lib/jira_issues/jira_query.rb

@@ -0,0 +1,27 @@
+# @author Filip Jakubowski
+module JiraIssues
+  class JiraQuery
+    # Creates new Query object 
+    # and sets the maximum number of issues returned by Query
+    # @param max_results [Integer] maximum number of issues returned by query
+    def initialize(max_results = 1000)
+      @query_max_results = max_results
+    end
+
+    # Handles a JQL Request and returns JiraIssueavigator for that query
+    # @param query [String] 
+    # @return [JiraIssueNavigator] with those requests
+    def jql_query(query)
+      result = adapter.jql(query, fields:[:description, :summary, :created, :status, :issuetype, :priority, :resolutiondate], max_results: @query_max_results)
+      JiraIssuesNavigator.new(result.map{|i| JiraIssueMapper.new.call(i) })
+    end
+
+    private
+    # Provides adapter that connects to JIRA
+    # @return [JiraAdapter] with those requests
+    def adapter
+      @adapter ||= JiraIssues::JiraAdapter.new
+    end
+  end
+end
+

data/lib/jira_issues/jira_workflow.rb

@@ -0,0 +1,32 @@
+#@author Filip Jakubowski
+module JiraIssues
+  class JiraWorkflow
+    OPEN        = 'Open'
+    IN_PROGRESS = 'InProgress'
+    BLOCKED     = 'Blocked'
+    CLOSED      = 'Closed'
+    # This is WIP
+    # This class should be able to map and unify:
+    #  - statuses
+    #  - workflows
+    #  - transitions
+    # ATM - we will work onlu on defailt issue names
+
+    def self.issue_status_for_name(project_key, status_name)
+      {
+        'Backlog'       => OPEN,
+        'Open'          => OPEN,
+        'To Do'         => OPEN,
+        'Blocked'       => BLOCKED,
+        'In Progress'   => IN_PROGRESS,
+        'Specification' => IN_PROGRESS,
+        'Done'          => CLOSED,
+        'Closed'        => CLOSED,
+        'Resolved'      => CLOSED,
+      }.fetch(status_name)
+    rescue KeyError => e
+      p "You have issue with custom - if you want mapping to be configurable please contact me #{Gem.loaded_specs["jira_issues"].metadata.fetch('source_code_uri')}"
+      raise e
+    end
+  end
+end

data/lib/jira_issues/jql_lib.rb

@@ -0,0 +1,11 @@
+module JiraIssues
+    class JqlLib
+        def self.my_issues
+            "assignee = currentUser()"
+        end
+
+        def self.issues_for_user(user)
+            "assignee = #{user}"
+        end
+    end
+end

data/spec/jira_issues_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe JiraIssues do 
+    it "filter issues" do
+        issue_nav = Object.new
+        allow(issue_nav).to receive(:jql_query) {
+            issues = [
+                {:key=>"PR-100", :type=>"Task", :priority=>"Major", :status=>"Open", :summary=>"Clean kitchen", :created_date=>"2017-12-28T13:30:30.000+0000", :closed_date=>"2017-12-28T13:30:30.000+0000"},
+                {:key=>"PR-101", :type=>"Task", :priority=>"Major", :status=>"InProgress", :summary=>"Walk a dog", :created_date=>"2017-12-07T15:46:22.000+0000", :closed_date=>nil},
+                {:key=>"PR-102", :type=>"Task", :priority=>"Critical", :status=>"Closed", :summary=>"Pack bagpack", :created_date=>"2017-12-21T11:15:38.000+0000", :closed_date=>"2017-12-27T13:45:06.000+0000"},
+                {:key=>"PR-102", :type=>"Task", :priority=>"Critical", :status=>"Closed", :summary=>"Pay bills", :created_date=>"2017-12-21T11:15:38.000+0000", :closed_date=>"2017-12-27T13:45:06.000+0000"}
+            ]
+            JiraIssues::JiraIssuesNavigator.new(issues)
+        }
+
+        jn = issue_nav.jql_query 'project = "Project" and ( created > -40d )'
+        expect(jn.done.issues.count).to eq(2)
+        expect(jn.open.issues.count).to eq(1)
+        expect(jn.in_progress.issues.count).to eq(1)
+        expect(jn.open.issues.first[:priority]).to eq("Major")
+
+        expect(jn.created_by_week.count).to eq(3)
+        expect(jn.closed_by_week.count).to eq(1)
+    end
+
+    it "translates workfow steps" do 
+        expect(JiraIssues::JiraWorkflow.issue_status_for_name('PR','Open')).to eq(JiraIssues::JiraWorkflow::OPEN)
+        expect(JiraIssues::JiraWorkflow.issue_status_for_name('PR','In Progress')).to eq(JiraIssues::JiraWorkflow::IN_PROGRESS)
+        expect(JiraIssues::JiraWorkflow.issue_status_for_name('PR','Done')).to eq(JiraIssues::JiraWorkflow::CLOSED)
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'jira_issues'
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: jira_issues
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Filip Jakubowski-Drzrwiecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-30 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Jira Issues gem that supports quering and filtering data for external
+  reporting and integrations.
+email:
+- don.o.phelippe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jira_issues.rb
+- lib/jira_issues/jira_adapter.rb
+- lib/jira_issues/jira_issue_mapper.rb
+- lib/jira_issues/jira_issues_navigator.rb
+- lib/jira_issues/jira_issues_stats.rb
+- lib/jira_issues/jira_query.rb
+- lib/jira_issues/jira_workflow.rb
+- lib/jira_issues/jql_lib.rb
+- spec/jira_issues_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/filipjakubowski
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/filipjakubowski/jira_issues
+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: jira_issues
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Jira Issues
+test_files: []