geet 0.1.8 → 0.1.9

data/lib/geet/github/account.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Geet
+  module Github
+    class Account
+      def initialize(api_interface)
+        @api_interface = api_interface
+      end
+
+      def authenticated_user
+        api_path = '/user'
+
+        response = @api_interface.send_request(api_path)
+
+        response.fetch('login')
+      end
+    end
+  end
+end

data/lib/geet/{git_hub/api_helper.rb → github/api_interface.rb}

@@ -6,27 +6,17 @@ require 'json'
 require 'shellwords'
 
 module Geet
-  module GitHub
-    class ApiHelper
-      def initialize(api_token, user, repository_path, upstream)
+  module Github
+    class ApiInterface
+      API_AUTH_USER = '' # We don't need the login, as the API key uniquely identifies the user
+      API_BASE_URL = 'https://api.github.com'
+
+      def initialize(api_token, repository_path, upstream)
         @api_token = api_token
-        @user = user
         @repository_path = repository_path
         @upstream = upstream
       end
 
-      def api_base_link
-        'https://api.github.com'
-      end
-
-      def api_repo_link
-        "#{api_base_link}/repos/#{@repository_path}"
-      end
-
-      def repo_link
-        "https://github.com/#{@repository_path}"
-      end
-
       def upstream?
         @upstream
       end
@@ -36,14 +26,20 @@ module Geet
       # Returns the parsed response, or an Array, in case of multipage.
       #
       # params:
+      #   :api_path:    api path, will be appended to the API URL.
+      #                 for root path, prepend a `/`:
+      #                 - use `/gists` for `https://api.github.com/gists`
+      #                 when owner/project/repos is included, don't prepend `/`:
+      #                 - use `issues` for `https://api.github.com/myowner/myproject/repos/issues`
       #   :params:      (Hash)
       #   :data:        (Hash) if present, will generate a POST request, otherwise, a GET
-      #   :multipage:   set true for paged GitHub responses (eg. issues); it will make the method
+      #   :multipage:   set true for paged Github responses (eg. issues); it will make the method
       #                 return an array, with the concatenated (parsed) responses
       #   :http_method: :get, :patch, :post and :put are accepted, but only :patch/:put are meaningful,
       #                 since the others are automatically inferred by :data.
       #
-      def send_request(address, params: nil, data: nil, multipage: false, http_method: nil)
+      def send_request(api_path, params: nil, data: nil, multipage: false, http_method: nil)
+        address = api_url(api_path)
         # filled only on :multipage
         parsed_responses = []
 
@@ -69,6 +65,12 @@ module Geet
 
       private
 
+      def api_url(api_path)
+        url = API_BASE_URL
+        url += "/repos/#{@repository_path}/" if !api_path.start_with?('/')
+        url + api_path
+      end
+
       def send_http_request(address, params: nil, data: nil, http_method: nil)
         uri = encode_uri(address, params)
         http_class = find_http_class(http_method, data)
@@ -76,8 +78,8 @@ module Geet
         Net::HTTP.start(uri.host, use_ssl: true) do |http|
           request = http_class.new(uri)
 
+          request.basic_auth API_AUTH_USER, @api_token
           request.body = data.to_json if data
-          request.basic_auth @user, @api_token
           request['Accept'] = 'application/vnd.github.v3+json'
 
           http.request(request)

data/lib/geet/github/collaborator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Geet
+  module Github
+    class Collaborator
+      # Returns a flat list of names in string form.
+      def self.list(api_interface)
+        api_path = 'collaborators'
+        response = api_interface.send_request(api_path, multipage: true)
+
+        response.map { |user_entry| user_entry.fetch('login') }
+      end
+    end
+  end
+end

data/lib/geet/{git_hub → github}/gist.rb

@@ -3,14 +3,14 @@
 require_relative 'abstract_issue'
 
 module Geet
-  module GitHub
+  module Github
     class Gist
-      def self.create(filename, content, api_helper, description: nil, publik: false)
-        request_address = "#{api_helper.api_base_link}/gists"
+      def self.create(filename, content, api_interface, description: nil, publik: false)
+        api_path = "/gists"
 
         request_data = prepare_request_data(filename, content, description, publik)
 
-        response = api_helper.send_request(request_address, data: request_data)
+        response = api_interface.send_request(api_path, data: request_data)
 
         id = response.fetch('id')
 

data/lib/geet/{git_hub → github}/issue.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
 module Geet
-  module GitHub
+  module Github
     # See AbstractIssue for the circular dependency issue notes.
     autoload :AbstractIssue, File.expand_path('abstract_issue', __dir__)
 
-    class Issue < Geet::GitHub::AbstractIssue
-      def self.create(title, description, api_helper)
-        request_address = "#{api_helper.api_repo_link}/issues"
+    class Issue < Geet::Github::AbstractIssue
+      def self.create(title, description, api_interface)
+        api_path = 'issues'
         request_data = { title: title, body: description, base: 'master' }
 
-        response = api_helper.send_request(request_address, data: request_data)
+        response = api_interface.send_request(api_path, data: request_data)
 
         issue_number, title, link = response.fetch_values('number', 'title', 'html_url')
 
-        new(issue_number, api_helper, title, link)
+        new(issue_number, api_interface, title, link)
       end
 
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
-      def self.list(api_helper)
-        request_address = "#{api_helper.api_repo_link}/issues"
+      def self.list(api_interface)
+        api_path = 'issues'
 
-        response = api_helper.send_request(request_address, multipage: true)
+        response = api_interface.send_request(api_path, multipage: true)
 
         response.each_with_object([]) do |issue_data, result|
           if !issue_data.key?('pull_request')
@@ -30,7 +30,7 @@ module Geet
             title = issue_data.fetch('title')
             link = issue_data.fetch('html_url')
 
-            result << new(number, api_helper, title, link)
+            result << new(number, api_interface, title, link)
           end
         end
       end

data/lib/geet/github/label.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Geet
+  module Github
+    class Label
+      # Returns a flat list of names in string form.
+      def self.list(api_interface)
+        api_path = 'labels'
+        response = api_interface.send_request(api_path, multipage: true)
+
+        response.map { |label_entry| label_entry['name'] }
+      end
+    end
+  end
+end

data/lib/geet/{git_hub → github}/milestone.rb

@@ -3,45 +3,45 @@
 require 'date'
 
 module Geet
-  module GitHub
+  module Github
     class Milestone
       attr_reader :number, :title, :due_on
 
-      def initialize(number, title, due_on, api_helper)
+      def initialize(number, title, due_on, api_interface)
         @number = number
         @title = title
         @due_on = due_on
 
-        @api_helper = api_helper
+        @api_interface = api_interface
       end
 
       # See https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
       #
-      def self.find(number, api_helper)
-        request_address = "#{api_helper.api_repo_link}/milestones/#{number}"
+      def self.find(number, api_interface)
+        api_path = "milestones/#{number}"
 
-        response = api_helper.send_request(request_address)
+        response = api_interface.send_request(api_path)
 
         number = response.fetch('number')
         title = response.fetch('title')
         due_on = parse_due_on(response.fetch('due_on'))
 
-        new(number, title, due_on, api_helper)
+        new(number, title, due_on, api_interface)
       end
 
       # See https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
       #
-      def self.list(api_helper)
-        request_address = "#{api_helper.api_repo_link}/milestones"
+      def self.list(api_interface)
+        api_path = 'milestones'
 
-        response = api_helper.send_request(request_address, multipage: true)
+        response = api_interface.send_request(api_path, multipage: true)
 
         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'))
 
-          new(number, title, due_on, api_helper)
+          new(number, title, due_on, api_interface)
         end
       end
 

data/lib/geet/github/pr.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Geet
+  module Github
+    # See AbstractIssue for the circular dependency issue notes.
+    autoload :AbstractIssue, File.expand_path('abstract_issue', __dir__)
+
+    class PR < AbstractIssue
+      # See https://developer.github.com/v3/pulls/#create-a-pull-request
+      #
+      def self.create(title, description, head, api_interface)
+        api_path = 'pulls'
+
+        if api_interface.upstream?
+          account = Geet::Github::Account.new(api_interface)
+          head = "#{account.authenticated_user}:#{head}"
+        end
+
+        request_data = { title: title, body: description, head: head, base: 'master' }
+
+        response = api_interface.send_request(api_path, data: request_data)
+
+        number, title, link = response.fetch_values('number', 'title', 'html_url')
+
+        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
+
+        response = api_interface.send_request(api_path, params: request_params, multipage: true)
+
+        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
+      end
+
+      # See https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
+      #
+      def merge
+        api_path = "pulls/#{number}/merge"
+
+        @api_interface.send_request(api_path, http_method: :put)
+      end
+
+      def request_review(reviewers)
+        api_path = "pulls/#{number}/requested_reviewers"
+        request_data = { reviewers: reviewers }
+
+        @api_interface.send_request(api_path, data: request_data)
+      end
+    end
+  end
+end

data/lib/geet/services/create_gist.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../helpers/os_helper.rb'
-require_relative '../git/repository.rb'
 
 module Geet
   module Services
@@ -13,16 +12,17 @@ module Geet
       #   :publik:      defaults to false
       #   :no_browse    defaults to false
       #
-      def execute(repository, full_filename, description: nil, publik: false, no_browse: false)
+      def execute(repository, full_filename, description: nil, publik: false, no_browse: false, output: $stdout)
         content = IO.read(full_filename)
 
-        puts 'Creating the gist...'
+        gist_access = publik ? 'public' : 'private'
+        output.puts "Creating a #{gist_access} gist..."
 
         filename = File.basename(full_filename)
         gist = repository.create_gist(filename, content, description: description, publik: publik)
 
         if no_browse
-          puts "Gist address: #{gist.link}"
+          output.puts "Gist address: #{gist.link}"
         else
           os_open(gist.link)
         end

data/lib/geet/services/create_issue.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../helpers/os_helper.rb'
-require_relative '../git/repository.rb'
 
 module Geet
   module Services
@@ -14,26 +13,30 @@ module Geet
       #   :assignee_patterns
       #   :no_open_issue
       #
-      def execute(repository, title, description, label_patterns: nil, milestone_pattern: nil, assignee_patterns: nil, no_open_issue: nil, **)
-        labels_thread = select_labels(repository, label_patterns) if label_patterns
-        milestone_thread = find_milestone(repository, milestone_pattern) if milestone_pattern
-        assignees_thread = select_assignees(repository, assignee_patterns) if assignee_patterns
+      def execute(
+          repository, title, description,
+          label_patterns: nil, milestone_pattern: nil, assignee_patterns: nil, no_open_issue: nil,
+          output: $stdout, **
+      )
+        labels_thread = select_labels(repository, label_patterns, output) if label_patterns
+        milestone_thread = find_milestone(repository, milestone_pattern, output) if milestone_pattern
+        assignees_thread = select_assignees(repository, assignee_patterns, output) if assignee_patterns
 
         selected_labels = labels_thread&.join&.value
         assignees = assignees_thread&.join&.value
         milestone = milestone_thread&.join&.value
 
-        puts 'Creating the issue...'
+        output.puts 'Creating the issue...'
 
         issue = repository.create_issue(title, description)
 
-        add_labels_thread = add_labels(issue, selected_labels) if selected_labels
-        set_milestone_thread = set_milestone(issue, milestone) if milestone
+        add_labels_thread = add_labels(issue, selected_labels, output) if selected_labels
+        set_milestone_thread = set_milestone(issue, milestone, output) if milestone
 
         if assignees
-          assign_users_thread = assign_users(issue, assignees)
+          assign_users_thread = assign_users(issue, assignees, output)
         else
-          assign_users_thread = assign_authenticated_user(repository, issue)
+          assign_users_thread = assign_authenticated_user(repository, issue, output)
         end
 
         add_labels_thread&.join
@@ -41,18 +44,20 @@ module Geet
         assign_users_thread.join
 
         if no_open_issue
-          puts "Issue address: #{issue.link}"
+          output.puts "Issue address: #{issue.link}"
         else
           os_open(issue.link)
         end
+
+        issue
       end
 
       private
 
       # Internal actions
 
-      def select_labels(repository, label_patterns)
-        puts 'Finding labels...'
+      def select_labels(repository, label_patterns, output)
+        output.puts 'Finding labels...'
 
         Thread.new do
           all_labels = repository.labels
@@ -61,8 +66,8 @@ module Geet
         end
       end
 
-      def find_milestone(repository, milestone_pattern)
-        puts 'Finding milestone...'
+      def find_milestone(repository, milestone_pattern, output)
+        output.puts 'Finding milestone...'
 
         Thread.new do
           if milestone_pattern =~ /\A\d+\Z/
@@ -75,8 +80,8 @@ module Geet
         end
       end
 
-      def select_assignees(repository, assignee_patterns)
-        puts 'Finding collaborators...'
+      def select_assignees(repository, assignee_patterns, output)
+        output.puts 'Finding collaborators...'
 
         Thread.new do
           all_collaborators = repository.collaborators
@@ -85,32 +90,32 @@ module Geet
         end
       end
 
-      def add_labels(issue, selected_labels)
-        puts "Adding labels #{selected_labels.join(', ')}..."
+      def add_labels(issue, selected_labels, output)
+        output.puts "Adding labels #{selected_labels.join(', ')}..."
 
         Thread.new do
           issue.add_labels(selected_labels)
         end
       end
 
-      def set_milestone(issue, milestone)
-        puts "Setting milestone #{milestone.title}..."
+      def set_milestone(issue, milestone, output)
+        output.puts "Setting milestone #{milestone.title}..."
 
         Thread.new do
           issue.edit(milestone: milestone.number)
         end
       end
 
-      def assign_users(issue, users)
-        puts "Assigning users #{users.join(', ')}..."
+      def assign_users(issue, users, output)
+        output.puts "Assigning users #{users.join(', ')}..."
 
         Thread.new do
           issue.assign_users(users)
         end
       end
 
-      def assign_authenticated_user(repository, issue)
-        puts 'Assigning authenticated user...'
+      def assign_authenticated_user(repository, issue, output)
+        output.puts 'Assigning authenticated user...'
 
         Thread.new do
           issue.assign_users(repository.authenticated_user)