geet 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9069b26e04387727f7ae73ba34dbf83375f3c65
-  data.tar.gz: 8647d63bb9fa5e471e07dfd04c4da24ce60aa4e1
+  metadata.gz: 8b30416607b1d594f4f4d38dc61668a8bb4d2b33
+  data.tar.gz: c76019c10cc053dc38d7fdc257dbfa0f07e76f48
 SHA512:
-  metadata.gz: 852bc60cf052d3bde605a7851a32054bc60e7aabaff31a793f5ba3d4f2ad1aadb44a3dc00a406b015a095d6bc4103ad04f6030b19439292d62fa3e5df08c8af5
-  data.tar.gz: 76fd3f5cd74b34fed1a527c65827f093d9c75ba2e2c6c7f8012bad4d851858ec48408f2887d03a6edcb1082ce067a5ce7c31b88f5058918f49bb2cda57fe1c1b
+  metadata.gz: 8be0ea5f9f1be8f4307cced46bb846b84b5f74ecfd42f93d89266c57f4cb466913f07d9b849dece1ff4ff4214714d8663fb7316032fd47e10762c5669a528aca
+  data.tar.gz: a57c1f035b94aa97a7393da8e818f176683fd682542a2a80d5cf39203442cceefe13eb2ffef872e07d8f315e2e461511d4ef8104531dc9bb6f7dcc95bebbaa87

data/bin/geet

@@ -2,13 +2,13 @@
 # frozen_string_literal: true
 
 require 'simple_scripting/configuration'
-require_relative '../lib/geet/commandline/configuration.rb'
-require_relative '../lib/geet/commandline/commands.rb'
-require_relative '../lib/geet/commandline/editor.rb'
-require_relative '../lib/geet/git/repository.rb'
-require_relative '../lib/geet/helpers/summary_helper.rb'
-require_relative '../lib/geet/shared/constants.rb'
-require_relative '../lib/geet/utils/git_client.rb'
+require_relative '../lib/geet/commandline/configuration'
+require_relative '../lib/geet/commandline/commands'
+require_relative '../lib/geet/commandline/editor'
+require_relative '../lib/geet/git/repository'
+require_relative '../lib/geet/helpers/summary_helper'
+require_relative '../lib/geet/shared/selection'
+require_relative '../lib/geet/utils/git_client'
 Dir[File.join(__dir__, '../lib/geet/services/*.rb')].each { |filename| require filename }
 
 class GeetLauncher
@@ -84,7 +84,7 @@ class GeetLauncher
 
   def default_to_manual_selection(options, *params)
     params.each do |param|
-      options[param] ||= Shared::Constants::MANUAL_LIST_SELECTION_FLAG
+      options[param] ||= Shared::Selection::MANUAL_LIST_SELECTION_FLAG
     end
 
     options

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-02-03'
+  s.date        = '2018-02-05'
   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/commandline/editor.rb

@@ -2,7 +2,7 @@
 
 require 'tempfile'
 
-require_relative '../helpers/os_helper.rb'
+require_relative '../helpers/os_helper'
 
 module Geet
   module Commandline

data/lib/geet/github/api_interface.rb

@@ -3,6 +3,7 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require_relative '../shared/http_error'
 
 module Geet
   module Github
@@ -53,8 +54,8 @@ module Geet
           parsed_response = JSON.parse(response.body) if response.body
 
           if error?(response)
-            formatted_error = decode_and_format_error(parsed_response)
-            raise(formatted_error)
+            error_message = decode_and_format_error(parsed_response)
+            raise Geet::Shared::HttpError.new(error_message, response.code)
           end
 
           return parsed_response if !multipage

data/lib/geet/github/user.rb

@@ -1,12 +1,46 @@
 # frozen_string_literal: true
 
+require_relative '../shared/repo_permissions'
+require_relative '../shared/http_error'
+
 module Geet
   module Github
     class User
+      include Geet::Shared::RepoPermissions
+
       attr_reader :username
 
-      def initialize(username)
+      def initialize(username, api_interface)
         @username = username
+        @api_interface = api_interface
+      end
+
+      # See #repo_permission.
+      #
+      def has_permission?(permission)
+        user_permission = self.class.repo_permission(@api_interface)
+
+        permission_greater_or_equal_to?(user_permission, permission)
+      end
+
+      # See https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
+      #
+      def is_collaborator?
+        api_path = "collaborators/#{@username}"
+
+        begin
+          @api_interface.send_request(api_path)
+
+          # 204: user is a collaborator.
+          true
+        rescue Geet::Shared::HttpError => error
+          # 404: not a collaborator.
+          # Although the documentation mentions only 404, 403 is a valid response as well; it seems
+          # that 404 is given on private repositories, while 403 on public ones ("Must have push
+          # access to view repository collaborators.").
+          #
+          (error.code == 404 || error.code == 403) ? false : raise
+        end
       end
 
       # See https://developer.github.com/v3/users/#get-the-authenticated-user
@@ -16,7 +50,7 @@ module Geet
 
         response = api_interface.send_request(api_path)
 
-        new(response.fetch('login'))
+        new(response.fetch('login'), api_interface)
       end
 
       # Returns an array of User instances
@@ -25,7 +59,32 @@ module Geet
         api_path = 'collaborators'
         response = api_interface.send_request(api_path, multipage: true)
 
-        response.map { |user_entry| new(user_entry.fetch('login')) }
+        response.map { |user_entry| new(user_entry.fetch('login'), api_interface) }
+      end
+
+      # See https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level
+      #
+      def self.repo_permission(api_interface)
+        username = authenticated(api_interface).username
+        api_path = "collaborators/#{username}/permission"
+
+        response = api_interface.send_request(api_path)
+
+        permission = response.fetch('permission')
+
+        check_permission!(permission)
+
+        permission
+      end
+
+      class << self
+        private
+
+        # Future-proofing.
+        #
+        def check_permission!(permission)
+          raise "Unexpected permission #{permission.inspect}!" if !self::ALL_PERMISSIONS.include?(permission)
+        end
       end
     end
   end

data/lib/geet/services/create_gist.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../helpers/os_helper.rb'
-require_relative '../github/api_interface.rb'
-require_relative '../github/gist.rb'
+require_relative '../helpers/os_helper'
+require_relative '../github/api_interface'
+require_relative '../github/gist'
 
 module Geet
   module Services

data/lib/geet/services/create_issue.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'abstract_create_issue'
+require_relative '../shared/repo_permissions'
 
 module Geet
   module Services
     class CreateIssue < AbstractCreateIssue
+      include Geet::Shared::RepoPermissions
+
       # options:
       #   :labels
       #   :milestone:     number or description pattern.
@@ -16,11 +19,23 @@ module Geet
           labels: nil, milestone: nil, assignees: nil, no_open_issue: nil,
           **
       )
-        selected_labels, selected_milestone, selected_assignees = find_and_select_attributes(labels, milestone, assignees)
+        # Inefficient (in worst case, triples the pre issue creation waiting time: #is_collaborator?,
+        # #has_permissions?, and the attributes batch), but not trivial to speed up. Not difficult
+        # either, but currently not worth spending time.
+        #
+        # Theoretically, #is_collaborator? could be skipped, but this is cleaner.
+        user_has_write_permissions = @repository.authenticated_user.is_collaborator? &&
+                                     @repository.authenticated_user.has_permission?(PERMISSION_WRITE)
+
+        if user_has_write_permissions
+          selected_labels, selected_milestone, selected_assignees = find_and_select_attributes(labels, milestone, assignees)
+        end
 
         issue = create_issue(title, description)
 
-        edit_issue(issue, selected_labels, selected_milestone, selected_assignees)
+        if user_has_write_permissions
+          edit_issue(issue, selected_labels, selected_milestone, selected_assignees)
+        end
 
         if no_open_issue
           @out.puts "Issue address: #{issue.link}"

data/lib/geet/services/create_pr.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'abstract_create_issue'
+require_relative '../shared/repo_permissions'
 
 module Geet
   module Services
     class CreatePr < AbstractCreateIssue
+      include Geet::Shared::RepoPermissions
+
       DEFAULT_GIT_CLIENT = Geet::Utils::GitClient.new
 
       def initialize(repository, out: $stdout, git_client: DEFAULT_GIT_CLIENT)
@@ -24,13 +27,21 @@ module Geet
       )
         ensure_clean_tree if automated_mode
 
-        selected_labels, selected_milestone, selected_reviewers = find_and_select_attributes(labels, milestone, reviewers)
+        # See CreateIssue#execute for notes about performance.
+        user_has_write_permissions = @repository.authenticated_user.is_collaborator? &&
+                                     @repository.authenticated_user.has_permission?(PERMISSION_WRITE)
+
+        if user_has_write_permissions
+          selected_labels, selected_milestone, selected_reviewers = find_and_select_attributes(labels, milestone, reviewers)
+        end
 
         sync_with_upstream_branch if automated_mode
 
         pr = create_pr(title, description)
 
-        edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
+        if user_has_write_permissions
+          edit_pr(pr, selected_labels, selected_milestone, selected_reviewers)
+        end
 
         if no_open_pr
           @out.puts "PR address: #{pr.link}"

data/lib/geet/services/list_milestones.rb

@@ -3,7 +3,7 @@
 module Geet
   module Services
     class ListMilestones
-      def initialize(repository, out: $output)
+      def initialize(repository, out: $stdout)
         @repository = repository
         @out = out
       end

data/lib/geet/shared/http_error.rb

@@ -0,0 +1,13 @@
+module Geet
+  module Shared
+    class HttpError < RuntimeError
+      # Integer.
+      attr_reader :code
+
+      def initialize(message, code)
+        super(message)
+        @code = code.to_i
+      end
+    end
+  end
+end

data/lib/geet/shared/repo_permissions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Geet
+  module Shared
+    module RepoPermissions
+      PERMISSION_ADMIN = 'admin'
+      PERMISSION_WRITE = 'write'
+      PERMISSION_READ = 'read'
+      PERMISSION_NONE = 'none'
+
+      ALL_PERMISSIONS = [
+        PERMISSION_ADMIN,
+        PERMISSION_WRITE,
+        PERMISSION_READ,
+        PERMISSION_NONE,
+      ]
+
+      # Not worth creating a Permission class at this stage.
+      #
+      def permission_greater_or_equal_to?(subject_permission, object_permission)
+        ALL_PERMISSIONS.index(subject_permission) <= ALL_PERMISSIONS.index(object_permission)
+      end
+    end
+  end
+end

data/lib/geet/shared/{constants.rb → selection.rb}

@@ -2,7 +2,7 @@
 
 module Geet
   module Shared
-    module Constants
+    module Selection
       MANUAL_LIST_SELECTION_FLAG = '-'.freeze
     end
   end

data/lib/geet/utils/attributes_selection_manager.rb

@@ -2,7 +2,7 @@
 
 require_relative 'manual_list_selection'
 require_relative 'string_matching_selection'
-require_relative '../shared/constants'
+require_relative '../shared/selection'
 
 module Geet
   module Utils
@@ -14,7 +14,7 @@ module Geet
     # multiple attributes are required (typically, three).
     #
     class AttributesSelectionManager
-      include Geet::Shared::Constants
+      include Geet::Shared::Selection
 
       # Workaround for VCR not supporting multithreading; see https://github.com/vcr/vcr/issues/200.
       #

data/lib/geet/utils/git_client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'shellwords'
-require_relative '../helpers/os_helper.rb'
+require_relative '../helpers/os_helper'
 
 module Geet
   module Utils
@@ -153,7 +153,7 @@ module Geet
       private
 
       def gitdir_option
-        "--git-dir #{@location.shellescape}/.git" if @location
+        "-C #{@location.shellescape}" if @location
       end
     end
   end

data/lib/geet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geet
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/integration/create_issue_spec.rb

@@ -7,12 +7,12 @@ require_relative '../../lib/geet/services/create_issue'
 
 describe Geet::Services::CreateIssue do
   let(:git_client) { Geet::Utils::GitClient.new }
-  let(:repository) { Geet::Git::Repository.new(git_client: git_client) }
+  let(:repository) { Geet::Git::Repository.new(warnings: false, git_client: git_client) }
   let(:upstream_repository) { Geet::Git::Repository.new(upstream: true, git_client: git_client) }
 
   context 'with labels, assignees and milestones' do
     it 'should create an issue' do
-      allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
+      allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo_f')
 
       expected_output = <<~STR
         Finding labels...
@@ -21,8 +21,8 @@ describe Geet::Services::CreateIssue do
         Creating the issue...
         Adding labels bug, invalid...
         Setting milestone 0.0.1...
-        Assigning users donald-ts, donald-fr...
-        Issue address: https://github.com/donaldduck/testrepo/issues/1
+        Assigning users donaldduck, donald-fr...
+        Issue address: https://github.com/donaldduck/testrepo_f/issues/2
       STR
 
       actual_output = StringIO.new
@@ -30,40 +30,44 @@ describe Geet::Services::CreateIssue do
       actual_created_issue = VCR.use_cassette('create_issue') do
         described_class.new(repository, out: actual_output).execute(
           'Title', 'Description',
-          labels: 'bug,invalid', milestone: '0.0.1', assignees: 'donald-ts,donald-fr',
+          labels: 'bug,invalid', milestone: '0.0.1', assignees: 'donaldduck,donald-fr',
           no_open_issue: true
         )
       end
 
       expect(actual_output.string).to eql(expected_output)
 
-      expect(actual_created_issue.number).to eql(1)
+      expect(actual_created_issue.number).to eql(2)
       expect(actual_created_issue.title).to eql('Title')
-      expect(actual_created_issue.link).to eql('https://github.com/donaldduck/testrepo/issues/1')
+      expect(actual_created_issue.link).to eql('https://github.com/donaldduck/testrepo_f/issues/2')
     end
   end
 
-  it 'should create an upstream issue' do
-    allow(git_client).to receive(:current_branch).and_return('mybranch')
-    allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
-    allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:donald-fr/testrepo_u')
+  context 'without write permissions' do
+    context 'without labels, assignees and milestones' do
+      it 'should create an upstream issue' do
+        allow(git_client).to receive(:current_branch).and_return('mybranch')
+        allow(git_client).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')
+        allow(git_client).to receive(:remote).with('upstream').and_return('git@github.com:momcorp/therepo')
 
-    expected_output = <<~STR
-      Creating the issue...
-      Issue address: https://github.com/donald-fr/testrepo_u/issues/7
-    STR
+        expected_output = <<~STR
+          Creating the issue...
+          Issue address: https://github.com/momcorp/therepo/issues/42
+        STR
 
-    actual_output = StringIO.new
+        actual_output = StringIO.new
 
-    actual_created_issue = VCR.use_cassette('create_issue_upstream') do
-      create_options = { no_open_issue: true, out: actual_output }
-      described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', create_options)
-    end
+        actual_created_issue = VCR.use_cassette('create_issue_upstream') do
+          create_options = { no_open_issue: true, out: actual_output }
+          described_class.new(upstream_repository, out: actual_output).execute('Title', 'Description', create_options)
+        end
 
-    expect(actual_output.string).to eql(expected_output)
+        expect(actual_output.string).to eql(expected_output)
 
-    expect(actual_created_issue.number).to eql(7)
-    expect(actual_created_issue.title).to eql('Title')
-    expect(actual_created_issue.link).to eql('https://github.com/donald-fr/testrepo_u/issues/7')
+        expect(actual_created_issue.number).to eql(42)
+        expect(actual_created_issue.title).to eql('Title')
+        expect(actual_created_issue.link).to eql('https://github.com/momcorp/therepo/issues/42')
+      end
+    end
   end
 end