Module: ModuleSync::GitService

Defined in:
lib/modulesync/git_service.rb,
lib/modulesync/git_service/base.rb,
lib/modulesync/git_service/github.rb,
lib/modulesync/git_service/gitlab.rb,
lib/modulesync/git_service/factory.rb

Overview

Namespace for Git service classes (ie. GitHub, GitLab)

Defined Under Namespace

Modules: Factory Classes: Base, GitHub, GitLab, MissingCredentialsError, UnguessableTypeError

Class Method Summary collapse

Class Method Details

.configuration_for(sourcecode:) ⇒ Object 



10
11
12
13
14
15
16
17
18
 
# File 'lib/modulesync/git_service.rb', line 10

def self.configuration_for(sourcecode:)
  type = type_for(sourcecode: sourcecode)

  {
    type: type,
    endpoint: endpoint_for(sourcecode: sourcecode, type: type),
    token: token_for(sourcecode: sourcecode, type: type),
  }
end

.endpoint_for(sourcecode:, type:) ⇒ Object

This method attempts to find git service’s endpoint based on sourcecode and type It process in this order

1. use module specific configuration (ie. `base_url`)
2. use environment variable dependending on type (e.g. GITLAB_BASE_URL)
3. guess using the git remote url
4. fail

Raises:

  • (NotImplementedError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/modulesync/git_service.rb', line 58

def self.endpoint_for(sourcecode:, type:)
  endpoint = sourcecode.options.dig(type, :base_url)

  endpoint ||= case type
               when :github
                 ENV['GITHUB_BASE_URL']
               when :gitlab
                 ENV['GITLAB_BASE_URL']
               end

  endpoint ||= GitService::Factory.klass(type: type).guess_endpoint_from(remote: sourcecode.repository_remote)

  raise NotImplementedError, <<~MESSAGE if endpoint.nil?
    Unable to guess endpoint for remote: '#{sourcecode.repository_remote}'
    Please provide `base_url` option in configuration file
  MESSAGE

  endpoint
end

.token_for(sourcecode:, type:) ⇒ Object

This method attempts to find the token associated to provided sourcecode and type It process in this order:

1. use module specific configuration (ie. `token`)
2. use environment variable depending on type (e.g. GITLAB_TOKEN)
3. fail



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/modulesync/git_service.rb', line 83

def self.token_for(sourcecode:, type:)
  token = sourcecode.options.dig(type, :token)

  token ||= case type
            when :github
              ENV['GITHUB_TOKEN']
            when :gitlab
              ENV['GITLAB_TOKEN']
            end

  token
end

.type_for(sourcecode:) ⇒ Object

This method attempts to guess git service’s type (ie. gitlab or github) It process in this order

1. use module specific configuration entry (ie. a specific entry named `gitlab` or `github`)
2. guess using remote url (ie. looking for `github` or `gitlab` string)
3. use environment variables (ie. check if GITHUB_TOKEN or GITLAB_TOKEN is set)
4. fail

Raises:

  • (NotImplementedError) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/modulesync/git_service.rb', line 26

def self.type_for(sourcecode:)
  return :github unless sourcecode.options[:github].nil?
  return :gitlab unless sourcecode.options[:gitlab].nil?
  return :github if sourcecode.repository_remote.include? 'github'
  return :gitlab if sourcecode.repository_remote.include? 'gitlab'

  if ENV['GITLAB_TOKEN'].nil? && ENV['GITHUB_TOKEN'].nil?
    raise UnguessableTypeError, <<~MESSAGE
      Unable to guess Git service type without GITLAB_TOKEN or GITHUB_TOKEN sets.
    MESSAGE
  end

  unless ENV['GITLAB_TOKEN'].nil? || ENV['GITHUB_TOKEN'].nil?
    raise UnguessableTypeError, <<~MESSAGE
      Unable to guess Git service type with both GITLAB_TOKEN and GITHUB_TOKEN sets.

      Please set the wanted one in configuration (ie. add `gitlab:` or `github:` key)
    MESSAGE
  end

  return :github unless ENV['GITHUB_TOKEN'].nil?
  return :gitlab unless ENV['GITLAB_TOKEN'].nil?

  raise NotImplementedError
end