geet 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b893cf44b85d8bfeedc77128b96c5bc921abb701
-  data.tar.gz: e50482a1691bedde73ef4c1c195693a57c60d9ce
+  metadata.gz: c59d2f426846e6efe8e86311fdaa40c2d492c551
+  data.tar.gz: ad031d1e06cb881481c6cd8e72581e3069b365e2
 SHA512:
-  metadata.gz: 2733412c618b5d39cdeeb3b900364c69fcc551fa9238c30e743d6deb1b6a9083fc3cbf279df09027692a685f9f47fddb2d8eecb6beda7f79f03617f3dce31814
-  data.tar.gz: 4cb03d50785c4645e0d206337340d84bd53f8569c667c20787a2507a4579264fc4d13be4c2bffa5109c1a46ac2c79d8011917c50d7e580f0de72e7d207a36611
+  metadata.gz: 44015551198b6a04525a17079b065b85a81f5086ae2a22febcc3466596700035201da645ed2b7cb5093ddc6e4585d4fff105cf7fd806227eeb64f089f3e4e853
+  data.tar.gz: 64e7d77b762b34d4444e443ac447b9c0a9ad201724daee2eb4f5745f83598853e8dd4d5674e48bc68815756d7132530103b5e7ee1ec3756a0837d38398f056da

data/README.md

@@ -8,13 +8,18 @@ This tool is very similar to [Hub](https://github.com/github/hub), but it suppor
 
 Please see the [development status](#development-status) section for informations about the current development.
 
+## Providers support
+
+Currently, there are many functionalities implemented for GitHub (see help), and only issues listing for GitLab.
+
 ## Samples
 
 ### Prerequisite(s)
 
-Geet requires the `GITHUB_API_TOKEN` environment variable to be set, eg:
+Geet requires the API token environment variable to be set, eg:
 
-    export GITHUB_API_TOKEN=0123456789abcdef0123456789abcdef
+    export GITHUB_API_TOKEN=0123456789abcdef0123456789abcdef    # for GitHub
+    export GITLAB_API_TOKEN=0123456789abcd-ef0-1                # for GitLab
 
 All the commands need to be run from the git repository.
 

data/bin/geet

@@ -14,10 +14,9 @@ class GeetLauncher
     commandline_configuration = Commandline::Configuration.new
 
     command, options = commandline_configuration.decode_argv || exit
-    api_token = commandline_configuration.api_token
 
     # `:upstream` is always false in the gist command case.
-    repository = Git::Repository.new(api_token, upstream: !!options[:upstream])
+    repository = Git::Repository.new(upstream: !!options[:upstream])
 
     case command
     when GIST_CREATE_COMMAND

data/geet.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.2.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2017-11-21'
+  s.date        = '2017-11-26'
   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/configuration.rb

@@ -80,10 +80,6 @@ module Geet
           },
         )
       end
-
-      def api_token
-        ENV['GITHUB_API_TOKEN'] || raise('Missing $GITHUB_API_TOKEN')
-      end
     end
   end
 end

data/lib/geet/git/repository.rb

@@ -19,58 +19,58 @@ module Geet
       ORIGIN_NAME   = 'origin'
       UPSTREAM_NAME = 'upstream'
 
-      def initialize(api_token, upstream: false, location: nil)
-        @api_token = api_token
+      def initialize(upstream: false, location: nil)
         @upstream = upstream
         @location = location
+        @api_token = extract_env_api_token
       end
 
       # REMOTE FUNCTIONALITIES (REPOSITORY)
 
       def collaborators
-        provider_module::Collaborator.list(api_interface)
+        attempt_provider_call(:Collaborator, :list, api_interface)
       end
 
       def labels
-        provider_module::Label.list(api_interface)
+        attempt_provider_call(:Label, :list, api_interface)
       end
 
       def create_gist(filename, content, description: nil, publik: false)
-        provider_module::Gist.create(filename, content, api_interface, description: description, publik: publik)
+        attempt_provider_call(:Gist, :create, filename, content, api_interface, description: description, publik: publik)
       end
 
       def create_issue(title, description)
-        provider_module::Issue.create(title, description, api_interface)
+        attempt_provider_call(:Issue, :create, title, description, api_interface)
       end
 
       def abstract_issues(milestone: nil)
-        provider_module::AbstractIssue.list(api_interface, milestone: milestone)
+        attempt_provider_call(:AbstractIssue, :list, api_interface, milestone: milestone)
       end
 
       def issues
-        provider_module::Issue.list(api_interface)
+        attempt_provider_call(:Issue, :list, api_interface)
       end
 
       def milestone(number)
-        provider_module::Milestone.find(number, api_interface)
+        attempt_provider_call(:Milestone, :find, number, api_interface)
       end
 
       def milestones
-        provider_module::Milestone.list(api_interface)
+        attempt_provider_call(:Milestone, :list, api_interface)
       end
 
       def create_pr(title, description, head)
-        provider_module::PR.create(title, description, head, api_interface)
+        attempt_provider_call(:PR, :create, title, description, head, api_interface)
       end
 
       def prs(head: nil)
-        provider_module::PR.list(api_interface, head: head)
+        attempt_provider_call(:PR, :list, api_interface, head: head)
       end
 
       # REMOTE FUNCTIONALITIES (ACCOUNT)
 
       def authenticated_user
-        provider_module::Account.new(api_interface).authenticated_user
+        attempt_provider_call(:Account, :new, api_interface).authenticated_user
       end
 
       # OTHER/CONVENIENCE FUNCTIONALITIES
@@ -105,6 +105,12 @@ module Geet
 
       # PROVIDER
 
+      def extract_env_api_token
+        env_variable_name = "#{provider_domain[/(.*)\.\w+/, 1].upcase}_API_TOKEN"
+
+        ENV[env_variable_name] || raise("#{env_variable_name} not set!")
+      end
+
       def provider_domain
         # We assume that it's not possible to have origin and upstream on different providers.
         #
@@ -117,12 +123,26 @@ module Geet
         domain
       end
 
-      def provider_module
+      # Attempt to find the provider class and send the specified method, returning a friendly
+      # error (functionality X [Y] is missing) when a class/method is missing.
+      def attempt_provider_call(class_name, meth, *args)
         module_name = provider_domain[/(.*)\.\w+/, 1].capitalize
 
         require_provider_modules
 
-        Kernel.const_get("Geet::#{module_name}")
+        full_class_name = "Geet::#{module_name}::#{class_name}"
+
+        if Kernel.const_defined?(full_class_name)
+          klass = Kernel.const_get(full_class_name)
+
+          if ! klass.respond_to?(meth)
+            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!"
+        end
       end
 
       def require_provider_modules
@@ -135,7 +155,7 @@ module Geet
       # OTHER HELPERS
 
       def api_interface
-        provider_module::ApiInterface.new(@api_token, path(upstream: @upstream), @upstream)
+        attempt_provider_call(:ApiInterface, :new, @api_token, path(upstream: @upstream), @upstream)
       end
 
       # Example: `donaldduck/geet`

data/lib/geet/github/api_interface.rb

@@ -93,7 +93,7 @@ module Geet
       end
 
       def error?(response)
-        !response['Status'].start_with?('2')
+        !response.code.start_with?('2')
       end
 
       def decode_and_format_error(parsed_response)

data/lib/geet/gitlab/api_interface.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'shellwords'
+
+module Geet
+  module Gitlab
+    class ApiInterface
+      API_BASE_URL = 'https://gitlab.com/api/v4'
+
+      def initialize(api_token, path_with_namespace, upstream)
+        @api_token = api_token
+        @path_with_namespace = path_with_namespace
+        @upstream = upstream
+      end
+
+      def upstream?
+        @upstream
+      end
+
+      def path_with_namespace(encoded: false)
+        encoded ? CGI.escape(@path_with_namespace) : @path_with_namespace
+      end
+
+      # Send a request.
+      #
+      # 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
+      #                 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(api_path, params: nil, data: nil, multipage: false, http_method: nil)
+        address = api_url(api_path)
+        # filled only on :multipage
+        parsed_responses = []
+
+        loop do
+          response = send_http_request(address, params: params, data: data, http_method: http_method)
+
+          parsed_response = JSON.parse(response.body)
+
+          if error?(response)
+            formatted_error = decode_and_format_error(parsed_response)
+            raise(formatted_error)
+          end
+
+          return parsed_response if !multipage
+
+          parsed_responses.concat(parsed_response)
+
+          address = link_next_page(response.to_hash)
+
+          return parsed_responses if address.nil?
+
+          # Gitlab's next link address already includes all the params, so we remove
+          # the passed ones (if there's any).
+          params = nil
+        end
+      end
+
+      private
+
+      def api_url(api_path)
+        "#{API_BASE_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)
+
+        Net::HTTP.start(uri.host, use_ssl: true) do |http|
+          request = http_class.new(uri)
+
+          request['Private-Token'] = @api_token
+          request.body = data.to_json if data
+
+          http.request(request)
+        end
+      end
+
+      def encode_uri(address, params)
+        address += '?' + URI.encode_www_form(params) if params
+
+        URI(address)
+      end
+
+      def error?(response)
+        !response.code.start_with?('2')
+      end
+
+      def decode_and_format_error(parsed_response)
+        parsed_response.fetch('error')
+      end
+
+      def link_next_page(response_headers)
+        # An array (or nil) is returned.
+        link_header = Array(response_headers['link'])
+
+        return nil if link_header.empty?
+
+        link_header[0][/<(\S+)>; rel="next"/, 1]
+      end
+
+      def find_http_class(http_method, data)
+        http_method ||= data ? :post : :get
+
+        case http_method
+        when :get
+          Net::HTTP::Get
+        when :patch
+          Net::HTTP::Patch
+        when :put
+          Net::HTTP::Put
+        when :post
+          Net::HTTP::Post
+        else
+          raise "Unsupported HTTP method: #{http_method.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/geet/gitlab/issue.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Geet
+  module Gitlab
+    class Issue
+      attr_reader :number, :title, :link
+
+      def initialize(number, title, link)
+        @number = number
+        @title = title
+        @link = link
+      end
+
+      def self.list(api_interface)
+        api_path = "projects/#{api_interface.path_with_namespace(encoded: true)}/issues"
+
+        response = api_interface.send_request(api_path, multipage: true)
+
+        response.each_with_object([]) 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)
+        end
+      end
+    end
+  end
+end

data/lib/geet/version.rb

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

data/spec/integration/create_gist_spec.rb

@@ -5,7 +5,7 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/create_gist'
 
 describe Geet::Services::CreateGist do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
+  let(:repository) { Geet::Git::Repository.new }
   let(:tempfile) { Tempfile.open('geet_gist') { |file| file << "testcontent" } }
 
   it 'should create a public gist' do

data/spec/integration/create_issue_spec.rb

@@ -4,8 +4,8 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/create_issue'
 
 describe Geet::Services::CreateIssue do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
-  let(:upstream_repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN'), upstream: true) }
+  let(:repository) { Geet::Git::Repository.new }
+  let(:upstream_repository) { Geet::Git::Repository.new(upstream: true) }
 
   context 'with labels, assignees and milestones' do
     it 'should create an issue' do

data/spec/integration/create_pr_spec.rb

@@ -4,8 +4,8 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/create_pr'
 
 describe Geet::Services::CreatePr do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
-  let(:upstream_repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN'), upstream: true) }
+  let(:repository) { Geet::Git::Repository.new() }
+  let(:upstream_repository) { Geet::Git::Repository.new(upstream: true) }
 
   context 'with labels, reviewers and milestones' do
     it 'should create a PR' do

data/spec/integration/list_issues_spec.rb

@@ -4,8 +4,8 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/list_issues'
 
 describe Geet::Services::ListIssues do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
-  let(:upstream_repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN'), upstream: true) }
+  let(:repository) { Geet::Git::Repository.new() }
+  let(:upstream_repository) { Geet::Git::Repository.new(upstream: true) }
 
   it 'should list the issues' do
     allow(repository).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')

data/spec/integration/list_labels_spec.rb

@@ -4,7 +4,7 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/list_labels'
 
 describe Geet::Services::ListLabels do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
+  let(:repository) { Geet::Git::Repository.new() }
 
   it 'should list the labels' do
     allow(repository).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/geet')

data/spec/integration/list_milestones_spec.rb

@@ -4,7 +4,7 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/list_milestones'
 
 describe Geet::Services::ListMilestones do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
+  let(:repository) { Geet::Git::Repository.new() }
 
   it 'should list the milestones' do
     allow(repository).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/geet')

data/spec/integration/list_prs_spec.rb

@@ -4,8 +4,8 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/list_prs'
 
 describe Geet::Services::ListPrs do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
-  let(:upstream_repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN'), upstream: true) }
+  let(:repository) { Geet::Git::Repository.new() }
+  let(:upstream_repository) { Geet::Git::Repository.new(upstream: true) }
 
   it 'should list the PRs' do
     allow(repository).to receive(:remote).with('origin').and_return('git@github.com:donaldduck/testrepo')

data/spec/integration/merge_pr_spec.rb

@@ -4,7 +4,7 @@ require_relative '../../lib/geet/git/repository'
 require_relative '../../lib/geet/services/merge_pr'
 
 describe Geet::Services::MergePr do
-  let(:repository) { Geet::Git::Repository.new(ENV.fetch('GITHUB_API_TOKEN')) }
+  let(:repository) { Geet::Git::Repository.new() }
 
   it 'should merge the PR for the current branch' do
     allow(repository).to receive(:current_branch).and_return('mybranch1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geet
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_scripting
@@ -55,6 +55,8 @@ files:
 - lib/geet/github/label.rb
 - lib/geet/github/milestone.rb
 - lib/geet/github/pr.rb
+- lib/geet/gitlab/api_interface.rb
+- lib/geet/gitlab/issue.rb
 - lib/geet/helpers/os_helper.rb
 - lib/geet/services/create_gist.rb
 - lib/geet/services/create_issue.rb
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Commandline interface for performing SCM (eg. GitHub) operations (eg. PR