Module: Repology Private

Defined in:
utils/repology.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Repology API client.

Constant Summary collapse

HOMEBREW_CORE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

"homebrew"
HOMEBREW_CASK =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

"homebrew_casks"

Class Method Summary collapse

Class Method Details

.latest_version(repositories) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'utils/repology.rb', line 77

def latest_version(repositories)
  # The status is "unique" when the package is present only in Homebrew, so
  # Repology has no way of knowing if the package is up-to-date.
  is_unique = repositories.find do |repo|
    repo["status"] == "unique"
  end.present?

  return "present only in Homebrew" if is_unique

  latest_version = repositories.find do |repo|
    repo["status"] == "newest"
  end

  # Repology cannot identify "newest" versions for packages without a version
  # scheme
  return "no latest version" if latest_version.blank?

  latest_version["version"]
end

.parse_api_response(limit = nil, repository:) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'utils/repology.rb', line 44

def parse_api_response(limit = nil, repository:)
  package_term = case repository
  when HOMEBREW_CORE
    "formula"
  when HOMEBREW_CASK
    "cask"
  else
    "package"
  end

  ohai "Querying outdated #{package_term.pluralize} from Repology"

  page_no = 1
  outdated_packages = {}
  last_package = ""

  while page_no <= MAX_PAGINATION
    odebug "Paginating Repology API page: #{page_no}"

    response = query_api(last_package, repository: repository)
    outdated_packages.merge!(response)
    last_package = response.keys.last

    page_no += 1
    break if limit && outdated_packages.size >= limit || response.size <= 1
  end

  puts "#{outdated_packages.size} outdated #{package_term.pluralize(outdated_packages.size)} found"
  puts

  outdated_packages
end

.query_api(_last_package_in_response = "", repository:) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



18
19
20
21
22
23
24
25
26
27
# File 'utils/repology.rb', line 18

def query_api(_last_package_in_response = "", repository:)
  {}
  # TODO: uncomment (and remove lines above) when we have a fix for Repology
  # `curl` issues
  # last_package_in_response += "/" if last_package_in_response.present?
  # url = "https://repology.org/api/v1/projects/#{last_package_in_response}?inrepo=#{repository}&outdated=1"

  # output, _errors, _status = curl_output(url.to_s)
  # JSON.parse(output)
end

.single_package_query(name, repository:) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'utils/repology.rb', line 29

def single_package_query(name, repository:)
  # TODO: uncomment when we have a fix for Repology `curl` issues
  # url = "https://repology.org/tools/project-by?repo=#{repository}&" \
  #       "name_type=srcname&target_page=api_v1_project&name=#{name}"

  # output, _errors, _status = curl_output("--location", url.to_s)

  # begin
  #   data = JSON.parse(output)
  #   { name => data }
  # rescue
  #   nil
  # end
end