Class: CodeInventory::GitHub::Source

Inherits:
Object
  • Object
show all
Defined in:
lib/codeinventory/github/source.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth, org, overrides: {}, exclude: []) ⇒ Source

Returns a new instance of Source.



10
11
12
13
14
15
16
 
# File 'lib/codeinventory/github/source.rb', line 10

def initialize(auth, org, overrides: {}, exclude: [])
  Octokit.auto_paginate = true
  @auth = auth
  @org = org
  @overrides = overrides
  @exclude = exclude
end

Instance Attribute Details

#exclude ⇒ Object

Returns the value of attribute exclude.



8
9
10
 
# File 'lib/codeinventory/github/source.rb', line 8

def exclude
  @exclude
end

#org ⇒ Object

Returns the value of attribute org.



8
9
10
 
# File 'lib/codeinventory/github/source.rb', line 8

def org
  @org
end

#overrides ⇒ Object

Returns the value of attribute overrides.



8
9
10
 
# File 'lib/codeinventory/github/source.rb', line 8

def overrides
  @overrides
end

Instance Method Details

#build_metadata(repo, inventory_file_metadata) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/codeinventory/github/source.rb', line 50

def build_metadata(repo, inventory_file_metadata)
  repo_metadata = {}
  repo_metadata["name"] = name(repo, inventory_file_metadata)
  repo_metadata["description"] = description(repo, inventory_file_metadata)
  usage_type = usage_type(repo, inventory_file_metadata)
  repo_metadata["permissions"] = {
    "licenses" => licenses(repo, inventory_file_metadata),
    "usageType" => usage_type,
    "exemptionText" => exemption_text(repo, inventory_file_metadata)
  }
  repo_metadata["tags"] = tags(repo, inventory_file_metadata)
  repo_metadata["contact"] = { "email" => contact_email(repo, inventory_file_metadata) }
  repo_metadata["repositoryURL"] = repository(repo, inventory_file_metadata)
  repo_metadata["laborHours"] = labor_hours(repo, inventory_file_metadata)
  organization = organization(repo, inventory_file_metadata)
  repo_metadata["organization"] = organization unless organization.nil?
  repo_metadata
end

#client ⇒ Object 



209
210
211
 
# File 'lib/codeinventory/github/source.rb', line 209

def client
  @client ||= Octokit::Client.new(@auth)
end

#contact_email(repo, inventory_file_metadata) ⇒ Object

Provides a value for the contact.email field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. GitHub organization email



169
170
171
172
173
174
 
# File 'lib/codeinventory/github/source.rb', line 169

def contact_email(repo, inventory_file_metadata)
  return @overrides[:contact][:email] if @overrides.dig(:contact, :email)
  return inventory_file_metadata["contact"]["email"] if inventory_file_metadata.dig("contact", "email")
  org = client.organization(@org)
  org[:email]
end

#description(repo, inventory_file_metadata) ⇒ Object

Provides a value for the description field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. GitHub repository description

  4. GitHub repository name



105
106
107
108
109
110
 
# File 'lib/codeinventory/github/source.rb', line 105

def description(repo, inventory_file_metadata)
  return @overrides[:description] if @overrides[:description]
  return inventory_file_metadata["description"] if inventory_file_metadata["description"]
  return repo[:description] if repo[:description]
  repo[:name]
end

#exemption_text(repo, inventory_file_metadata) ⇒ Object

Provides a value for the permissions.exemptionText field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. nil



145
146
147
148
149
 
# File 'lib/codeinventory/github/source.rb', line 145

def exemption_text(repo, inventory_file_metadata)
  return @overrides[:permissions][:exemptionText] if @overrides.dig(:permissions, :exemptionText)
  return inventory_file_metadata["permissions"]["exemptionText"] if inventory_file_metadata.dig("permissions", "exemptionText")
  nil
end

#inventory_file(repo) ⇒ Object

Checks if the repo has an inventory file. If so, loads its metadata.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/codeinventory/github/source.rb', line 70

def inventory_file(repo)
  metadata = {}
  return metadata if repo[:size] == 0 # Empty repo
  filenames = [ ".codeinventory.yml", "codeinventory.yml", ".codeinventory.json", "codeinventory.json"]
  repo_contents = client.contents(repo[:full_name], path: "/")
  inventory_file = repo_contents.select { |file| filenames.include? file[:name] }.first
  unless inventory_file.nil?
    file_content = client.contents(repo[:full_name], path: inventory_file[:path])
    raw_content = Base64.decode64(file_content[:content])
    # Remove UTF-8 BOM if there is one; it throws off JSON.parse
    raw_content.sub!("\xEF\xBB\xBF".force_encoding("ASCII-8BIT"), "")
    if inventory_file[:name].end_with? ".yml"
      metadata = YAML.load(raw_content).to_hash
    elsif inventory_file[:name].end_with? ".json"
      metadata = JSON.parse(raw_content)
    end
  end
  metadata
end

#labor_hours(repo, inventory_file_metadata) ⇒ Object

Provies a value for the laborHours field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. 0



192
193
194
195
196
 
# File 'lib/codeinventory/github/source.rb', line 192

def labor_hours(repo, inventory_file_metadata)
  return @overrides[:laborHours] if @overrides[:laborHours]
  return inventory_file_metadata["laborHours"] if inventory_file_metadata["laborHours"]
  0
end

#licenses(repo, inventory_file_metadata) ⇒ Object

Provides a value for the permissions.licenses field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. GitHub repository license

  4. nil



118
119
120
121
122
123
124
125
126
 
# File 'lib/codeinventory/github/source.rb', line 118

def licenses(repo, inventory_file_metadata)
  return @overrides[:permissions][:licenses] if @overrides.dig(:permissions, :licenses)
  return inventory_file_metadata["permissions"]["licenses"] if inventory_file_metadata.dig("permissions", "licenses")
  require 'pp'
  if repo[:license] && repo[:license][:url] && repo[:license][:spdx_id]
    return [ { "URL": repo[:license][:url], "name": repo[:license][:spdx_id] } ]
  end
  nil
end

#name(repo, inventory_file_metadata) ⇒ Object

Provides a value for the name field. Order of precedence:

  1. CodeInventory metadata file

  2. GitHub repository name



94
95
96
97
 
# File 'lib/codeinventory/github/source.rb', line 94

def name(repo, inventory_file_metadata)
  return inventory_file_metadata["name"] if inventory_file_metadata["name"]
  repo[:name]
end

#organization(repo, inventory_file_metadata) ⇒ Object

Provies a value for the organization field (optional). Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. No organization field



203
204
205
206
207
 
# File 'lib/codeinventory/github/source.rb', line 203

def organization(repo, inventory_file_metadata)
  return @overrides[:organization] if @overrides[:organization]
  return inventory_file_metadata["organization"] if inventory_file_metadata["organization"]
  nil
end

#project(repo_name) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/codeinventory/github/source.rb', line 18

def project(repo_name)
  # mercy = GitHub topics preview
  # drax = GitHub license preview
  headers = {
    accept: [ "application/vnd.github.mercy-preview+json", "application/vnd.github.drax-preview+json" ]
  }
  repo = client.repository(repo_name, headers)
  inventory_file_metadata = inventory_file(repo)
  unless inventory_file_metadata.dig("codeinventory", "exclude")
    build_metadata(repo, inventory_file_metadata)
  end
end

#projects ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/codeinventory/github/source.rb', line 31

def projects
  # mercy = GitHub topics preview
  # drax = GitHub license preview
  headers = {
    accept: [ "application/vnd.github.mercy-preview+json", "application/vnd.github.drax-preview+json" ]
  }
  repos = client.organization_repositories(@org, headers)
  repos.delete_if { |repo| exclude.include? repo[:name] }
  projects = []
  repos.each do |repo|
    inventory_file_metadata = inventory_file(repo)
    unless inventory_file_metadata.dig("codeinventory", "exclude")
      projects << build_metadata(repo, inventory_file_metadata)
      yield repo_metadata if block_given?
    end
  end
  projects
end

#repository(repo, inventory_file_metadata) ⇒ Object

Provies a value for the repositoryURL field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. If repo is public, GitHub repository URL, otherwise nil



181
182
183
184
185
 
# File 'lib/codeinventory/github/source.rb', line 181

def repository(repo, inventory_file_metadata)
  return @overrides[:repositoryURL] if @overrides[:repositoryURL]
  return inventory_file_metadata["repositoryURL"] if inventory_file_metadata["repositoryURL"]
  repo[:private] ? nil : repo[:html_url]
end

#tags(repo, inventory_file_metadata) ⇒ Object

Provides a value for the tags field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. GitHub topics

  4. A single tag consisting of the org name.



157
158
159
160
161
162
 
# File 'lib/codeinventory/github/source.rb', line 157

def tags(repo, inventory_file_metadata)
  return @overrides[:tags] if @overrides[:tags]
  return inventory_file_metadata["tags"] if inventory_file_metadata["tags"]
  return repo[:topics] unless (repo[:topics].nil? || repo[:topics].empty?)
  [repo[:owner][:login]]
end

#usage_type(repo, inventory_file_metadata) ⇒ Object

Provides a value for the permissions.usageType field. Order of precedence:

  1. List of overrides

  2. CodeInventory metadata file

  3. GitHub repository public/private status (public=openSource; private=governmentWideReuse) Note: exempt* values must be set either in overrides or the metadata file.



134
135
136
137
138
 
# File 'lib/codeinventory/github/source.rb', line 134

def usage_type(repo, inventory_file_metadata)
  return @overrides[:permissions][:usageType] if @overrides.dig(:permissions, :usageType)
  return inventory_file_metadata["permissions"]["usageType"] if inventory_file_metadata.dig("permissions", "usageType")
  repo[:private] ? "governmentWideReuse" : "openSource"
end