bundler-alive 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd88b794101cf7f456811a805f287ec314d9ecf202294f5ec13e5e339db5834d
-  data.tar.gz: e0db2f2731c7dd50324900a5564365ff14abf82bc7169d30d9ad7444504dffec
+  metadata.gz: c3e48b8f0f5a030f9b537e4150f6b10e5bdf3ed709cde30162d2030b3292cbc6
+  data.tar.gz: dff1d8579c996eeb24c599e2a40ba48b778d2939af8e80f3da94ed133a4ac0b5
 SHA512:
-  metadata.gz: 89fec08047da08d6178bae7e2760f22139005dc33cd38201a6c7782a589ab173a7b5b72ee934bb301216fe4a5e1e5814dd69b773a9c937ab7ca2f7c7b61f0d3a
-  data.tar.gz: 0f1930be94cf0401d807ec1e63714dea3243c5bedbe226ff7cd4ff957e9d6d5f043d731f4903ca3dac35aa0403d1269cbc85e153a304894fad63848401ddec07
+  metadata.gz: 94d793718656beddd079aaa083fe501b2775a8b658d361b19d5c56906abba39551dd6f84628904c98235db7bc381028fb3ce261bb09178d00154ea3f682e2757
+  data.tar.gz: 4e4977e62794f2f9cd403187c4d60063788f8589ddef358beb2ba49827b65b7b3be6c64d563489b0c90938fe94f02b98af88fdf6bc93f29ea12bdc29ffc399a5

data/.bundler-alive.default.yml

@@ -27,4 +27,30 @@ gems:
   fog-sakuracloud:
     url: https://github.com/fog/fog-sakuracloud
   ovirt-engine-sdk:
-    url: https://github.com/oVirt/ovirt-engine-sdk-ruby
+    url: https://github.com/oVirt/ovirt-engine-sdk-ruby
+  declarative_policy:
+    url: https://gitlab.com/gitlab-org/ruby/gems/declarative-policy
+  spamcheck:
+    url: https://gitlab.com/gitlab-com/gl-security/engineering-and-research/automation-team/spam/spamcheck
+  tanuki_emoji:
+    url: https://gitlab.com/gitlab-org/ruby/gems/tanuki_emoji
+  cbor:
+    url: https://github.com/cabo/cbor-ruby
+  expression_parser:
+    url: https://github.com/nricciar/expression_parser
+  extended-markdown-filter:
+    url: https://github.com/gjtorikian/extended-markdown-filter
+  gettext:
+    url: https://github.com/ruby-gettext/gettext
+  png_quantizator:
+    url: https://github.com/rogercampos/png_quantizator
+  redis-actionpack:
+    url: https://github.com/redis-store/redis-actionpack
+  redis-rack:
+    url: https://github.com/redis-store/redis-rack
+  sixarm_ruby_unaccent:
+    url: https://github.com/SixArm/sixarm_ruby_unaccent
+  thrift:
+    url: https://github.com/szechyjs/thrift-gem
+  vmstat:
+    url: https://github.com/threez/ruby-vmstat

data/README.md

@@ -7,7 +7,7 @@
 
 `bunder-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
 
-Currently only GitHub is supported as a source code repository. If the source code repository is archived, then reports as not alive.
+Currently GitHub.com and GitLab.com are supported as a source code repository. If the source code repository is archived, then reports as not alive.
 
 ## Installation
 
@@ -41,6 +41,10 @@ Default `Gemfile.lock` location is in your current directory. You can specify it
 $ bundle-alive -G /path/to/Gemfile.lock
 ```
 
+## GitLab Access Token
+
+When gems are in GitLab.com repository, you MUST set environment variable `BUNDLER_ALIVE_GITLAB_TOKEN`. See the document [Personal access tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).
+
 ## Exceeding rate limit
 
 In some cases, the following error may be output.

data/gemspec.yml

@@ -19,6 +19,7 @@ dependencies:
   octokit:
   rake:
   thor:
+  gitlab:
 
 development_dependencies:
   rspec:

data/lib/bundler/alive/cli.rb

@@ -38,13 +38,20 @@ module Bundler
       private
 
       def check_by_doctor
-        doctor = begin
-          Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
-        rescue Bundler::GemfileLockNotFound
+        doctor = initialize_doctor
+
+        begin
+          doctor.diagnose
+        rescue Bundler::Alive::Client::GitlabApi::AccessTokenNotFoundError => e
+          say "\n#{e.message}", :yellow
           exit 1
         end
+      end
 
-        doctor.diagnose
+      def initialize_doctor
+        Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
+      rescue Bundler::GemfileLockNotFound
+        exit 1
       end
     end
   end

data/lib/bundler/alive/client/gems_api_client.rb

@@ -111,16 +111,23 @@ module Bundler
 
         def source_code_url(body:, gem_name:)
           url = body["source_code_uri"]
-          return url if SourceCodeRepositoryUrl.support_url?(url)
+          return url_via_redirect(url) if SourceCodeRepositoryUrl.support_url?(url)
 
           url = body["homepage_uri"]
-          return url if SourceCodeRepositoryUrl.support_url?(url)
+          return url_via_redirect(url) if SourceCodeRepositoryUrl.support_url?(url)
 
           message = "[#{gem_name}] Source code repository is not found in RubyGems.org,"\
                     " or not supported. URL: https://rubygems.org/gems/#{gem_name}"
           raise NotFound, message
         end
 
+        def url_via_redirect(url)
+          response = connection.head(url)
+          return response.headers["location"] if response.status == 301
+
+          url
+        end
+
         def get_repository_urls(gem_names)
           result = gem_names.map do |gem_name|
             $stdout.write "."

data/lib/bundler/alive/client/{git_hub_api.rb → github_api.rb}

@@ -11,7 +11,7 @@ module Bundler
       #
       # @see https://docs.github.com/en/rest/search#search-repositories
       #
-      module GitHubApi
+      module GithubApi
         # Environment variable name of GitHub Access Token
         ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITHUB_TOKEN"
 
@@ -44,6 +44,7 @@ module Bundler
           base.instance_eval do
             @rate_limit_exceeded = false
             @retries_on_too_many_requests = 0
+            @name_with_archived = {}
           end
         end
 
@@ -63,15 +64,12 @@ module Bundler
         #
         # @return [StatusResult]
         #
-        # rubocop:disable Metrics/MethodLength
         def query(urls:)
           collection = StatusCollection.new
-          name_with_archived = get_name_with_statuses(urls)
+          @name_with_archived = get_name_with_statuses(urls)
           urls.each do |url|
-            $stdout.write "."
-
             gem_name = url.gem_name
-            alive = !name_with_archived[gem_name]
+            alive = alive?(gem_name)
             status = Status.new(name: gem_name, repository_url: url, alive: alive, checked_at: Time.now)
             collection = collection.add(gem_name, status)
           end
@@ -79,10 +77,16 @@ module Bundler
           StatusResult.new(collection: collection, error_messages: @error_messages,
                            rate_limit_exceeded: @rate_limit_exceeded)
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 
+        def alive?(gem_name)
+          return false unless @name_with_archived.key?(gem_name)
+
+          value = @name_with_archived[gem_name]
+          value == Status::ALIVE_UNKNOWN ? Status::ALIVE_UNKNOWN : !value
+        end
+
         #
         # Search status of repositories
         #
@@ -93,23 +97,39 @@ module Bundler
         #
         # rubocop:disable Metrics/MethodLength
         def get_name_with_statuses(urls)
-          raise ArgumentError unless urls.instance_of?(Array)
-
           name_with_status = {}
           urls.each_slice(QUERY_MAX_OPERATORS_AT_ONCE) do |sliced_urls|
+            $stdout.print "." * sliced_urls.size
+
             q = search_query(sliced_urls)
             repositories = search_repositories_with_retry(q)
             next if repositories.nil?
 
-            repositories.each do |repository|
-              name = repository["name"]
-              name_with_status[name] = repository["archived"]
+            sliced_urls.each do |url|
+              repository = find_repository_from_repositories(url: url,
+                                                             repositories: repositories)
+              alive_status = if repository.nil?
+                               Status::ALIVE_UNKNOWN
+                             else
+                               repository["archived"]
+                             end
+              name_with_status[url.gem_name] = alive_status
             end
           end
           name_with_status
         end
         # rubocop:enable Metrics/MethodLength
 
+        # @param [SourceCodeRepositoryUrl] :url
+        # @param [Array<Sawyer::Resource>] :repositories
+        #
+        # @return [Sawyer::Resource|nil]
+        def find_repository_from_repositories(url:, repositories:)
+          repositories.find do |repository|
+            slug(url.url) == repository["full_name"]
+          end
+        end
+
         #
         # Search query of repositories
         #
@@ -172,7 +192,7 @@ module Bundler
         # @return [String]
         #
         def slug(repository_url)
-          Octokit::Repository.from_url(repository_url).slug
+          Octokit::Repository.from_url(repository_url).slug.gsub(/\.git/, "")
         end
       end
     end

data/lib/bundler/alive/client/gitlab_api.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "gitlab"
+require "json"
+
+module Bundler
+  module Alive
+    module Client
+      #
+      # API Client for GitLab API
+      #
+      # @see https://docs.gitlab.com/ee/api/projects.html#get-single-project
+      #
+      module GitlabApi
+        #
+        # Access token isn't set error
+        #
+        # @see https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
+        #
+        class AccessTokenNotFoundError < StandardError
+          def initialize(_message = nil)
+            message = "Environment variable #{ACCESS_TOKEN_ENV_NAME} is not set."\
+                      " Need to set GitLab Personal Access Token to be authenticated at gitlab.com API."\
+                      " See: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html"
+            super(message)
+          end
+        end
+
+        # Environment variable name of GitLab Access Token
+        #
+        # @see https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
+        #
+        ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITLAB_TOKEN"
+
+        # Endpoint of GitLab API
+        ENDPOINT = "https://gitlab.com/api/v4"
+
+        def self.extended(base)
+          base.instance_eval do
+            @rate_limit_exceeded = false
+            @retries_on_too_many_requests = 0
+          end
+        end
+
+        #
+        # Creates a GitLab client
+        #
+        # @return [Octokit::Client]
+        #
+        def create_client
+          access_token = ENV.fetch(ACCESS_TOKEN_ENV_NAME, nil)
+          raise AccessTokenNotFoundError if access_token.nil?
+
+          Gitlab.client(
+            endpoint: ENDPOINT,
+            private_token: access_token
+          )
+        end
+
+        #
+        # Query repository statuses
+        #
+        # @param [Array<RepositoryUrl>] :urls
+        #
+        # @return [StatusResult]
+        #
+        def query(urls:)
+          collection = StatusCollection.new
+          name_with_archived = get_name_with_statuses(urls)
+          urls.each do |url|
+            gem_name = url.gem_name
+            alive = name_with_archived.key?(gem_name) && !name_with_archived[gem_name]
+            status = Status.new(name: gem_name, repository_url: url, alive: alive, checked_at: Time.now)
+            collection = collection.add(gem_name, status)
+          end
+
+          StatusResult.new(collection: collection, error_messages: @error_messages,
+                           rate_limit_exceeded: @rate_limit_exceeded)
+        end
+
+        private
+
+        #
+        # Search status of repositories
+        #
+        # @param [Array<RepositoryUrl>] urls
+        #
+        # @return [Hash<String, Boolean>]
+        #   gem name with archived or not
+        #
+        def get_name_with_statuses(urls)
+          name_with_status = {}
+          urls.each do |url|
+            $stdout.write "."
+            project = search_repositories_with_retry(url)
+            next if project.nil? || project.empty?
+
+            name = url.gem_name
+            name_with_status[name] = project["archived"]
+          end
+          name_with_status
+        end
+
+        def project_path_from_url(url)
+          uri = URI.parse(url.url)
+          uri.path.split("/")[1..].join("/")
+        end
+
+        def search_repositories_with_retry(url)
+          project_path = project_path_from_url(url)
+
+          # Must be converted to hash due to warnings
+          @client.project(project_path).to_h
+        rescue StandardError => e
+          @error_messages << e.message
+          []
+        end
+      end
+    end
+  end
+end

data/lib/bundler/alive/client/source_code_client.rb

@@ -16,7 +16,8 @@ module Bundler
         end
 
         SERVICE_WITH_STRATEGIES = {
-          SourceCodeRepository::Service::GITHUB => GitHubApi
+          SourceCodeRepository::Service::GITHUB => GithubApi,
+          SourceCodeRepository::Service::GITLAB => GitlabApi
         }.freeze
 
         private_constant :SERVICE_WITH_STRATEGIES

data/lib/bundler/alive/reportable.rb

@@ -21,8 +21,11 @@ module Bundler
           error_messages = report.error_messages
           print_error(error_messages)
 
-          gems = result.archived_gems
-          print_archived_gems(gems) if gems.size.positive?
+          unknown_gems = result.unknown_gems
+          print_archived_gems(unknown_gems, header: "Unknown gems:") if unknown_gems.size.positive?
+
+          archived_gems = result.archived_gems
+          print_archived_gems(archived_gems, header: "Archived gems:") if archived_gems.size.positive?
 
           print_summary(result)
           print_message(result, report.rate_limit_exceeded)
@@ -31,15 +34,15 @@ module Bundler
         private
 
         # soo messy
-        def print_archived_gems(gems)
+        def print_archived_gems(gems, header:)
           $stdout.puts
-          $stdout.puts "Archived gems:"
-          archived_gems = gems.map do |_name, gem|
+          $stdout.puts header
+          gems_to_report = gems.map do |_name, gem|
             gem.report.split("\n").each_with_object([]) do |line, gem_str|
               gem_str << "    #{line}"
             end.join("\n")
           end
-          $stdout.puts archived_gems.join("\n\n")
+          $stdout.puts gems_to_report.join("\n\n")
         end
 
         def print_error(error_messages)
@@ -56,7 +59,7 @@ module Bundler
         def print_summary(result)
           $stdout.puts <<~RESULT
 
-            Total: #{result.total_size} (Archived: #{result.archived_size}, Alive: #{result.alive_size}, Unknown: #{result.unknown_size})
+            Total: #{result.total_size} (Archived: #{result.archived_size}, Unknown: #{result.unknown_size}, Alive: #{result.alive_size})
           RESULT
         end
 

data/lib/bundler/alive/source_code_repository.rb

@@ -6,6 +6,7 @@ module Bundler
     class SourceCodeRepository
       module Service
         GITHUB = :github
+        GITLAB = :gitlab
       end
 
       #

data/lib/bundler/alive/source_code_repository_url.rb

@@ -7,7 +7,8 @@ module Bundler
       # service domain with service
       DOMAIN_WITH_SERVICES = {
         "github.com" => SourceCodeRepository::Service::GITHUB,
-        "www.github.com" => SourceCodeRepository::Service::GITHUB
+        "www.github.com" => SourceCodeRepository::Service::GITHUB,
+        "gitlab.com" => SourceCodeRepository::Service::GITLAB
       }.freeze
 
       private_constant :DOMAIN_WITH_SERVICES

data/lib/bundler/alive/status_collection.rb

@@ -89,6 +89,10 @@ module Bundler
         collection.find_all { |_name, gem| !!!gem.alive }
       end
 
+      def unknown_gems
+        collection.find_all { |_name, gem| gem.unknown? }
+      end
+
       #
       # All of statuses are alive nor not
       #

data/lib/bundler/alive/status_result.rb

@@ -17,7 +17,7 @@ module Bundler
       #
       # @return [StatusResult]
       #
-      def initialize(collection: nil, error_messages: nil, rate_limit_exceeded: nil)
+      def initialize(collection: StatusCollection.new, error_messages: [], rate_limit_exceeded: false)
         @collection = collection
         @error_messages = error_messages
         @rate_limit_exceeded = rate_limit_exceeded
@@ -33,9 +33,12 @@ module Bundler
       # @return [StatusResult]
       #
       def merge(result)
-        self.class.new(collection: result.collection,
-                       error_messages: result.error_messages,
-                       rate_limit_exceeded: result.rate_limit_exceeded)
+        merged_collection = collection.merge(result.collection)
+        merged_error_messages = error_messages + result.error_messages
+        merged_rate_limit_exceeded = rate_limit_exceeded || result.rate_limit_exceeded
+        self.class.new(collection: merged_collection,
+                       error_messages: merged_error_messages,
+                       rate_limit_exceeded: merged_rate_limit_exceeded)
       end
     end
   end

data/lib/bundler/alive/version.rb

@@ -2,6 +2,6 @@
 
 module Bundler
   module Alive
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/bundler/alive.rb

@@ -10,6 +10,7 @@ require_relative "alive/status_collection"
 require_relative "alive/report"
 require_relative "alive/client/gems_api_client"
 require_relative "alive/client/gems_api_response"
-require_relative "alive/client/git_hub_api"
+require_relative "alive/client/github_api"
+require_relative "alive/client/gitlab_api"
 require_relative "alive/client/source_code_client"
 require_relative "alive/reportable"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Katsuhiko YOSHIDA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +208,8 @@ files:
 - lib/bundler/alive/cli.rb
 - lib/bundler/alive/client/gems_api_client.rb
 - lib/bundler/alive/client/gems_api_response.rb
-- lib/bundler/alive/client/git_hub_api.rb
+- lib/bundler/alive/client/github_api.rb
+- lib/bundler/alive/client/gitlab_api.rb
 - lib/bundler/alive/client/source_code_client.rb
 - lib/bundler/alive/doctor.rb
 - lib/bundler/alive/report.rb