geet 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b80e94214a854c8cf6407560d97051f4882cdd11b34f9c3031b2b288a9a2c6
-  data.tar.gz: b9eba4b14a9238c3ea09cb9d370ad91a6768ce8ca4d3ca5a4b7c93d29bc56bad
+  metadata.gz: bd623b15d744959be72ee1fd7438cbae8e8a8de8086f60c71ad6b269f457f975
+  data.tar.gz: fd84684c150029c3e0028703aa36d6834d9b0909f1872007abf82e6c75753ebf
 SHA512:
-  metadata.gz: 07c2b9f337bc0f3e3b991f4bd6e95d61f5827a2fcb00fafb265efe260ca73636e4c0fcf29ba688038ee670032cbca84a620ef65aaa4ddebb25f0cb337ba5a86e
-  data.tar.gz: 1f56fce624d2f9252d3b99ce9ddc0b71bf0674e8ff2e0339a219edf35fc0a4faa094c42030ff97f88798e0df724d38f72465dad2e0d7b6bd2a8d6fae4090e971
+  metadata.gz: 5f7ede545d5ba98c5ab018fe81644bf9e78c64eeecaae39c619c6407fce4ae4080e6c6be152425d4eb33d073b2514c4e6322d7be2a22403465d39c243839a016
+  data.tar.gz: 12543389e4ccbbbdd185c771acbc90669347b568f0a6d6a39bba8da4263cddd1da738d0397ef0d9991e9536052f10459ff5258752f5c03ad9ada3c36c3ed241b

data/README.md

@@ -10,11 +10,7 @@ Please see the [development status](#development-status) section for information
 
 ## Development status
 
-Geet is not under active development anymore.
-
-Although I keep using it daily, and I have many ideas for making it very smooth and efficient (beside the fact that it's very easy to extend), it has no userbase, while [Hub](https://github.com/github/hub) has a very large one.
-
-Therefore, it's probably better to put effort in contributing Hub, rather than improving Geet.
+Geet is (again) under active development. The current focus is implementing Gitlab functionalities.
 
 ## Operation/providers support
 
@@ -33,6 +29,7 @@ The functionalities currently supported are:
 - Gitlab:
   - list issues
   - list labels
+  - list milestones
 
 ## Samples
 

data/geet.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2018-04-12'
+  s.date        = '2018-07-01'
   s.email       = ['saverio.pub2@gmail.com']
   s.homepage    = 'https://github.com/saveriomiroddi/geet'
   s.summary     = 'Commandline interface for performing SCM (eg. GitHub) operations (eg. PR creation).'

data/lib/geet/git/repository.rb

@@ -54,12 +54,8 @@ module Geet
         attempt_provider_call(:Branch, :delete, name, api_interface)
       end
 
-      def abstract_issues(milestone: nil)
-        attempt_provider_call(:AbstractIssue, :list, api_interface, milestone: milestone)
-      end
-
-      def issues(assignee: nil)
-        attempt_provider_call(:Issue, :list, api_interface, assignee: assignee)
+      def issues(assignee: nil, milestone: nil)
+        attempt_provider_call(:Issue, :list, api_interface, assignee: assignee, milestone: milestone)
       end
 
       def milestone(number)
@@ -77,8 +73,8 @@ module Geet
         attempt_provider_call(:PR, :create, title, description, head, api_interface, base: base)
       end
 
-      def prs(head: nil)
-        attempt_provider_call(:PR, :list, api_interface, head: head)
+      def prs(head: nil, milestone: nil)
+        attempt_provider_call(:PR, :list, api_interface, head: head, milestone: milestone)
       end
 
       # REMOTE FUNCTIONALITIES (ACCOUNT)
@@ -116,12 +112,12 @@ module Geet
           klass = Kernel.const_get(full_class_name)
 
           if !klass.respond_to?(meth)
-            raise "The functionality invoked (#{class_name} #{meth}) is not currently supported!"
+            raise "The functionality invoked (#{class_name}.#{meth}) is not currently supported!"
           end
 
           klass.send(meth, *args)
         else
-          raise "The functionality (#{class_name}) invoked is not currently supported!"
+          raise "The class referenced (#{full_class_name}) is not currently supported!"
         end
       end
 

data/lib/geet/github/abstract_issue.rb

@@ -22,12 +22,12 @@ module Geet
 
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
-      def self.list(api_interface, only_issues: false, milestone: nil, assignee: nil)
+      def self.list(api_interface, milestone: nil, assignee: nil, &type_filter)
         api_path = 'issues'
 
         request_params = {}
-        request_params[:milestone] = milestone if milestone
-        request_params[:assignee] = assignee if assignee
+        request_params[:milestone] = milestone.number if milestone
+        request_params[:assignee] = assignee.username if assignee
 
         response = api_interface.send_request(api_path, params: request_params, multipage: true)
 
@@ -36,11 +36,7 @@ module Geet
           title = issue_data.fetch('title')
           link = issue_data.fetch('html_url')
 
-          klazz = issue_data.key?('pull_request') ? PR : Issue
-
-          if !only_issues || klazz == Issue
-            klazz.new(number, api_interface, title, link)
-          end
+          new(number, api_interface, title, link) if type_filter.nil? || type_filter.call(issue_data)
         end
 
         abstract_issues_list.compact

data/lib/geet/github/issue.rb

@@ -17,10 +17,10 @@ module Geet
         new(issue_number, api_interface, title, link)
       end
 
-      # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
-      #
-      def self.list(api_interface, assignee: nil)
-        super(api_interface, only_issues: true, assignee: assignee)
+      def self.list(api_interface, assignee: nil, milestone: nil)
+        super do |issue_data|
+          !issue_data.key?('pull_request')
+        end
       end
     end
   end

data/lib/geet/github/milestone.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
-require 'date'
+require_relative '../helpers/json_helper'
 
 module Geet
   module Github
     class Milestone
       attr_reader :number, :title, :due_on
 
+      class << self
+        private
+
+        include Helpers::JsonHelper
+      end
+
       def initialize(number, title, due_on, api_interface)
         @number = number
         @title = title
@@ -24,7 +30,7 @@ module Geet
 
         number = response.fetch('number')
         title = response.fetch('title')
-        due_on = parse_due_on(response.fetch('due_on'))
+        due_on = parse_iso_8601_timestamp(raw_due_on)
 
         new(number, title, due_on, api_interface)
       end
@@ -39,19 +45,11 @@ module Geet
         response.map do |milestone_data|
           number = milestone_data.fetch('number')
           title = milestone_data.fetch('title')
-          due_on = parse_due_on(milestone_data.fetch('due_on'))
+          due_on = parse_iso_8601_timestamp(milestone_data.fetch('due_on'))
 
           new(number, title, due_on, api_interface)
         end
       end
-
-      class << self
-        private
-
-        def parse_due_on(raw_due_on)
-          Date.strptime(raw_due_on, '%FT%TZ') if raw_due_on
-        end
-      end
     end
   end
 end

data/lib/geet/github/pr.rb

@@ -26,20 +26,26 @@ module Geet
         new(number, api_interface, title, link)
       end
 
-      # See https://developer.github.com/v3/pulls/#list-pull-requests
-      #
-      def self.list(api_interface, head: nil)
-        api_path = 'pulls'
-        request_params = { head: head } if head
+      def self.list(api_interface, milestone: nil, assignee: nil, head: nil)
+        check_list_params!(milestone, assignee, head)
 
-        response = api_interface.send_request(api_path, params: request_params, multipage: true)
+        if head
+          api_path = 'pulls'
+          request_params = { head: head }
 
-        response.map do |issue_data|
-          number = issue_data.fetch('number')
-          title = issue_data.fetch('title')
-          link = issue_data.fetch('html_url')
+          response = api_interface.send_request(api_path, params: request_params, multipage: true)
 
-          new(number, api_interface, title, link)
+          response.map do |issue_data|
+            number = issue_data.fetch('number')
+            title = issue_data.fetch('title')
+            link = issue_data.fetch('html_url')
+
+            new(number, api_interface, title, link)
+          end
+        else
+          super(api_interface, milestone: milestone, assignee: assignee) do |issue_data|
+            issue_data.key?('pull_request')
+          end
         end
       end
 
@@ -57,6 +63,16 @@ module Geet
 
         @api_interface.send_request(api_path, data: request_data)
       end
+
+      class << self
+        private
+
+        def check_list_params!(milestone, assignee, head)
+          if (milestone || assignee) && head
+            raise "Head can't be specified with milestone or assignee!"
+          end
+        end
+      end
     end
   end
 end

data/lib/geet/gitlab/PR.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Geet
+  module Gitlab
+    class PR
+      attr_reader :number, :title, :link
+
+      def initialize(number, title, link)
+        @number = number
+        @title = title
+        @link = link
+      end
+
+      # See https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests
+      #
+      def self.list(api_interface, milestone: nil, assignee: nil, head: nil)
+        raise ":head parameter currently unsupported!" if head
+
+        api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/merge_requests"
+
+        request_params = {}
+        request_params[:assignee_id] = assignee.id if assignee
+        request_params[:milestone] = milestone.title if milestone
+
+        response = api_interface.send_request(api_path, params: request_params, multipage: true)
+
+        response.map do |issue_data, result|
+          number = issue_data.fetch('iid')
+          title = issue_data.fetch('title')
+          link = issue_data.fetch('web_url')
+
+          new(number, title, link)
+        end
+      end
+    end # PR
+  end # Gitlab
+end # Geet

data/lib/geet/gitlab/issue.rb

@@ -11,19 +11,23 @@ module Geet
         @link = link
       end
 
-      def self.list(api_interface, assignee: nil)
-        raise "Assignee filtering not currently supported!" if assignee
-
+      # See https://docs.gitlab.com/ee/api/issues.html#list-issues
+      #
+      def self.list(api_interface, assignee: nil, milestone: nil)
         api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/issues"
 
-        response = api_interface.send_request(api_path, multipage: true)
+        request_params = {}
+        request_params[:assignee_id] = assignee.id if assignee
+        request_params[:milestone] = milestone.title if milestone
+
+        response = api_interface.send_request(api_path, params: request_params, multipage: true)
 
-        response.each_with_object([]) do |issue_data, result|
+        response.map do |issue_data, result|
           number = issue_data.fetch('iid')
           title = issue_data.fetch('title')
           link = issue_data.fetch('web_url')
 
-          result << new(number, title, link)
+          new(number, title, link)
         end
       end
     end

data/lib/geet/gitlab/milestone.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Geet
+  module Gitlab
+    class Milestone
+      attr_reader :number, :title, :due_on
+
+      def initialize(number, title, due_on, api_interface)
+        @number = number
+        @title = title
+        @due_on = due_on
+
+        @api_interface = api_interface
+      end
+
+      # See https://docs.gitlab.com/ee/api/milestones.html#list-project-milestones
+      #
+      def self.list(api_interface)
+        api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/milestones"
+
+        response = api_interface.send_request(api_path, multipage: true)
+
+        response.map do |milestone_data|
+          number = milestone_data.fetch('iid')
+          title = milestone_data.fetch('title')
+          due_on = parse_due_date(milestone_data.fetch('due_date'))
+
+          new(number, title, due_on, api_interface)
+        end
+      end
+
+      class << self
+        private
+
+        def parse_due_date(raw_due_date)
+          Date.parse(raw_due_date) if raw_due_date
+        end
+      end
+    end # Milestone
+  end # Gitlab
+end # Geet

data/lib/geet/gitlab/user.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Geet
+  module Gitlab
+    class User
+      attr_reader :id, :username
+
+      def initialize(id, username, api_interface)
+        @id = id
+        @username = username
+        @api_interface = api_interface
+      end
+
+      # Returns an array of User instances
+      #
+      def self.list_collaborators(api_interface)
+        api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/members"
+
+        response = api_interface.send_request(api_path, multipage: true)
+
+        response.map do |user_entry|
+          id = user_entry.fetch('id')
+          username = user_entry.fetch('username')
+
+          new(id, username, api_interface)
+        end
+      end
+    end # User
+  end # Gitlab
+end # Geet

data/lib/geet/helpers/json_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Geet
+  module Helpers
+    module JsonHelper
+      # Most common Json time format.
+      #
+      # Returns nil if nil is passed.
+      #
+      def parse_iso_8601_timestamp(timestamp)
+        Time.iso8601(timestamp).to_date if timestamp
+      end
+    end # JsonHelper
+  end # Helpers
+end # Geet

data/lib/geet/services/list_issues.rb

@@ -27,9 +27,7 @@ module Geet
 
         selection_manager.add_attribute(:collaborators, 'assignee', assignee, :single, name_method: :username)
 
-        selected_assignee, _ = selection_manager.select_attributes
-
-        selected_assignee&.username
+        selection_manager.select_attributes[0]
       end
     end
   end

data/lib/geet/services/list_milestones.rb

@@ -10,19 +10,23 @@ module Geet
 
       def execute
         milestones = find_milestones
-        issues_by_milestone_number = find_milestone_issues(milestones)
+        all_milestone_entries = find_all_milestone_entries(milestones)
 
         @out.puts
 
-        milestones.each do |milestone|
+        all_milestone_entries.each do |milestone, milestone_entries|
           @out.puts milestone_description(milestone)
 
-          milestone_issues = issues_by_milestone_number[milestone.number]
-
-          milestone_issues.each do |issue|
+          milestone_entries.fetch(:issues).each do |issue|
             @out.puts "  #{issue.number}. #{issue.title} (#{issue.link})"
           end
+
+          milestone_entries.fetch(:prs).each do |pr|
+            @out.puts "  #{pr.number}. #{pr.title} (#{pr.link})"
+          end
         end
+
+        all_milestone_entries.keys
       end
 
       private
@@ -41,27 +45,39 @@ module Geet
         @repository.milestones
       end
 
-      def find_milestone_issues(milestones)
-        @out.puts 'Finding issues...'
+      # Returns the structure:
+      #
+      # { milestone => {issues: [...], prs: [...]}}
+      #
+      def find_all_milestone_entries(milestones)
+        @out.puts 'Finding issues and PRs...'
+
+        all_milestone_entries = {}
+        all_threads = []
 
-        # Interestingly, on MRI, concurrent hash access is not a problem without mutex,
-        # since due to the GIL, only one thread at a time will actually access it.
-        issues_by_milestone_number = {}
-        mutex = Mutex.new
+        milestones.each_with_object(Mutex.new) do |milestone, mutex|
+          all_milestone_entries[milestone] = {}
+
+          all_threads << Thread.new do
+            issues = @repository.issues(milestone: milestone)
+
+            mutex.synchronize do
+              all_milestone_entries[milestone][:issues] = issues
+            end
+          end
 
-        issue_threads = milestones.map do |milestone|
-          Thread.new do
-            issues = @repository.abstract_issues(milestone: milestone.number)
+          all_threads << Thread.new do
+            prs = @repository.prs(milestone: milestone)
 
             mutex.synchronize do
-              issues_by_milestone_number[milestone.number] = issues
+              all_milestone_entries[milestone][:prs] = prs
             end
           end
         end
 
-        issue_threads.map(&:join)
+        all_threads.map(&:join)
 
-        issues_by_milestone_number
+        all_milestone_entries
       end
     end
   end