bundler-alive 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e48b8f0f5a030f9b537e4150f6b10e5bdf3ed709cde30162d2030b3292cbc6
-  data.tar.gz: dff1d8579c996eeb24c599e2a40ba48b778d2939af8e80f3da94ed133a4ac0b5
+  metadata.gz: 4fb0738fac56612f49d0fcc2dadf41f00caa5c34b8e49923185326f3cc6ab744
+  data.tar.gz: e89352dbbdec31b5e82e4f42135113d1c464441bcc0d4443709e24437fffb87f
 SHA512:
-  metadata.gz: 94d793718656beddd079aaa083fe501b2775a8b658d361b19d5c56906abba39551dd6f84628904c98235db7bc381028fb3ce261bb09178d00154ea3f682e2757
-  data.tar.gz: 4e4977e62794f2f9cd403187c4d60063788f8589ddef358beb2ba49827b65b7b3be6c64d563489b0c90938fe94f02b98af88fdf6bc93f29ea12bdc29ffc399a5
+  metadata.gz: 6692e5114833643c5038b41a8bbff0282837b4e70c05449f76cc810e499751a3f7f8585f5360f31b503376662e6a91f6617a335e59686a9841af65a2917b0d2f
+  data.tar.gz: 393f54894aabd833bd0249a54cfab165bbcacb6a9d10cae9ab446b6e81a92c9de83f5e0fc25d38327999b7c2e06fa902a730bbec5eb04b37a476af0067b882c4

data/.bundler-alive.default.yml

@@ -53,4 +53,18 @@ gems:
   thrift:
     url: https://github.com/szechyjs/thrift-gem
   vmstat:
-    url: https://github.com/threez/ruby-vmstat
+    url: https://github.com/threez/ruby-vmstat
+  mongoid-rspec:
+    url: https://github.com/mongoid/mongoid-rspec
+  rack-test:
+    url: https://github.com/rack/rack-test
+  jmespath:
+    url: https://github.com/jmespath/jmespath.rb
+  slack-notifier:
+    url: https://github.com/slack-notifier/slack-notifier
+  ipaddress:
+    url: https://github.com/ipaddress-gem/ipaddress
+  fog-powerdns:
+    url: https://github.com/fog/fog-powerdns
+  html_tokenizer:
+    url: https://github.com/EiNSTeiN-/html_tokenizer

data/.rspec

@@ -1,5 +1,4 @@
 --format documentation
 --color
---warnings
 --require spec_helper
 --backtrace

data/README.md

@@ -5,14 +5,14 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/maintainability)](https://codeclimate.com/github/kyoshidajp/bundler-alive/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/test_coverage)](https://codeclimate.com/github/kyoshidajp/bundler-alive/test_coverage)
 
-`bunder-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
+`bundler-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
 
-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.
+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
 
 ```
-$ gem install bunlder-alive
+$ gem install bundler-alive
 ```
 
 ## Usage
@@ -41,26 +41,29 @@ Default `Gemfile.lock` location is in your current directory. You can specify it
 $ bundle-alive -G /path/to/Gemfile.lock
 ```
 
-## GitLab Access Token
+## 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).
+You MUST set environment variables to access source code repository services.
 
-## Exceeding rate limit
+| Repository service | ENV variable |
+| ------- |---- |
+| GitHub | [`BUNDLER_ALIVE_GITHUB_TOKEN`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) |
+| GitLab | [`BUNDLER_ALIVE_GITLAB_TOKEN`](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) |
 
-In some cases, the following error may be output.
+## Ignore gems
+
+You can ignore certain gems.
 
 ```
-Too many requested! Retry later.
+$ bundle-alive -i journey rubocop-junit-formatter
 ```
 
-In this case, setting [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) as `BUNDLER_ALIVE_GITHUB_TOKEN` environment variable may alleviate the error.
+## Following redirect on RubyGems.org
 
-## Ignore gems
-
-You can ignore certain gems.
+The URL for some gems in RubyGems.org may have changed. You can follow the URL (default: doesn't follow).
 
 ```
-$ bundle-alive -i journey rubocop-junit-formatter
+$ bundle-alive --follow_redirect
 ```
 
 ## Specifying repository URL

data/gemspec.yml

@@ -8,7 +8,7 @@ homepage: https://github.com/kyoshidajp/bundler-alive
 metadata:
   homepage_uri: https://github.com/kyoshidajp/bundler-alive
   source_code_uri: https://github.com/kyoshidajp/bundler-alive
-  changelog_uri: https://github.com/kyoshidajp/bundler-alive
+  changelog_uri: https://github.com/kyoshidajp/bundler-alive/commits/main
 
 required_ruby_version: ">= 2.6.0"
 bindir: bin
@@ -16,7 +16,7 @@ require_paths: lib
 
 dependencies:
   faraday:
-  octokit:
+  graphql-client:
   rake:
   thor:
   gitlab:

data/lib/bundler/alive/cli.rb

@@ -17,6 +17,7 @@ module Bundler
 
       desc "check [DIR]", "Checks the Gemfile.lock"
       method_option :ignore, type: :array, aliases: "-i", default: []
+      method_option :follow_redirect, type: :boolean, aliases: "-r"
       method_option :gemfile_lock, type: :string, aliases: "-G",
                                    default: "Gemfile.lock"
       method_option :config, type: :string, aliases: "-c", default: ".bundler-alive.yml"
@@ -49,7 +50,10 @@ module Bundler
       end
 
       def initialize_doctor
-        Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
+        Doctor.new(lock_file: options[:gemfile_lock],
+                   config_file: options[:config],
+                   ignore_gems: options[:ignore],
+                   follow_redirect: options[:follow_redirect])
       rescue Bundler::GemfileLockNotFound
         exit 1
       end

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

@@ -21,13 +21,16 @@ module Bundler
         #
         # A new instance of `GemApiClient`
         #
-        # @param [String] config_path
+        # @param [String] :config_path
+        # @param [Boolean] :follow_redirect
+        #   Follow redirect URL in gems
         #
         # @return [GemApiClient]
         #
-        def initialize(config_path = nil)
+        def initialize(config_path: nil, follow_redirect: false)
           @error_messages = []
           @config_gems = get_config_gems(config_path)
+          @follow_redirect = follow_redirect
 
           freeze
         end
@@ -53,7 +56,7 @@ module Bundler
 
         private
 
-        attr_accessor :error_messages, :config_gems
+        attr_accessor :error_messages, :config_gems, :follow_redirect
 
         def api_url(gem_name)
           "https://rubygems.org/api/v1/gems/#{gem_name}.json"
@@ -122,6 +125,8 @@ module Bundler
         end
 
         def url_via_redirect(url)
+          return url unless follow_redirect
+
           response = connection.head(url)
           return response.headers["location"] if response.status == 301
 

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

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require "octokit"
 require "json"
 
 module Bundler
   module Alive
     module Client
       #
-      # API Client for GitHub API
+      # API Client for GitHub GraphQL API
       #
-      # @see https://docs.github.com/en/rest/search#search-repositories
+      # @see https://docs.github.com/en/graphql
       #
       module GithubApi
         # Environment variable name of GitHub Access Token
@@ -17,27 +16,10 @@ module Bundler
 
         # Separator of query condition
         QUERY_CONDITION_SEPARATOR = " "
+        private_constant :QUERY_CONDITION_SEPARATOR
 
-        # Number of attempts to request after too many requests
-        RETRIES_ON_TOO_MANY_REQUESTS = 3
-
-        #
-        # Interval second when retrying request
-        #
-        # @note
-        #   This is an empirical value and should
-        #   refer to response of Rate Limit API
-        #
-        # @see
-        #   https://docs.github.com/en/rest/overview/resources-in-the-rest-api#checking-your-rate-limit-status
-        RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS = 120
-
-        #
         # Max number of conditional operator at once
-        #
-        # @see https://docs.github.com/en/rest/search#limitations-on-query-length
-        QUERY_MAX_OPERATORS_AT_ONCE = 6
-
+        QUERY_MAX_OPERATORS_AT_ONCE = 50
         private_constant :QUERY_MAX_OPERATORS_AT_ONCE
 
         def self.extended(base)
@@ -49,12 +31,15 @@ module Bundler
         end
 
         #
-        # Creates a GitHub client
+        # Creates a GraphQL client
         #
-        # @return [Octokit::Client]
+        # @return [GraphQL::Client]
         #
         def create_client
-          Octokit::Client.new(access_token: ENV.fetch(ACCESS_TOKEN_ENV_NAME, nil))
+          require_relative "github_graphql"
+          extend GithubGraphql
+
+          GithubGraphql::CLIENT
         end
 
         #
@@ -111,7 +96,7 @@ module Bundler
               alive_status = if repository.nil?
                                Status::ALIVE_UNKNOWN
                              else
-                               repository["archived"]
+                               repository["isArchived"]
                              end
               name_with_status[url.gem_name] = alive_status
             end
@@ -126,21 +111,24 @@ module Bundler
         # @return [Sawyer::Resource|nil]
         def find_repository_from_repositories(url:, repositories:)
           repositories.find do |repository|
-            slug(url.url) == repository["full_name"]
+            # e.g.) tod's URL is https://github.com/JackC/tod
+            # but, the `nameWithOwner` is `jacks/tod`
+            slug(url.url).downcase == repository["nameWithOwner"].downcase
           end
         end
 
         #
-        # Search query of repositories
+        # Search query of repositories (includes forked)
         #
         # @param [Array<RepositoryUrl>] urls
         #
         # @return [String]
         #
         def search_query(urls)
-          urls.map do |url|
+          repository_query = urls.map do |url|
             "repo:#{slug(url.url)}"
           end.join(QUERY_CONDITION_SEPARATOR)
+          "#{repository_query} fork:true"
         end
 
         #
@@ -148,18 +136,12 @@ module Bundler
         #
         # @param [String] query
         #
-        # @raise [Octokit::TooManyRequests]
-        #   when too many requested to GitHub.com
-        # @raise [SourceCodeClient::SearchRepositoryError]
-        #   when Error without `Octokit::TooManyRequests`
-        #
         # @return [Array<Sawyer::Resource>|nil]
         #
         def search_repositories(query)
-          result = @client.search_repositories(query)
-          result[:items]
-        rescue Octokit::TooManyRequests => e
-          raise e
+          result = @client.query(GithubGraphql::Query,
+                                 variables: { var_query: query, var_first: QUERY_MAX_OPERATORS_AT_ONCE })
+          result.data.search.nodes.map(&:to_h)
         rescue StandardError => e
           @error_messages << e.message
           []
@@ -167,21 +149,6 @@ module Bundler
 
         def search_repositories_with_retry(query)
           search_repositories(query)
-        rescue Octokit::TooManyRequests
-          if @retries_on_too_many_requests < RETRIES_ON_TOO_MANY_REQUESTS
-            @retries_on_too_many_requests += 1
-            sleep_with_message
-            retry
-          end
-
-          @rate_limit_exceeded = true
-          []
-        end
-
-        def sleep_with_message
-          puts "Too many requested to GitHub. Sleep #{RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS} sec."
-          sleep RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS
-          puts "Retry request (#{@retries_on_too_many_requests}/#{RETRIES_ON_TOO_MANY_REQUESTS})"
         end
 
         #
@@ -192,7 +159,13 @@ module Bundler
         # @return [String]
         #
         def slug(repository_url)
-          Octokit::Repository.from_url(repository_url).slug.gsub(/\.git/, "")
+          # from https://github.com/octokit/octokit.rb/blob/v4.22.0/lib/octokit/repository.rb#L12-L17
+          github_slug = URI.parse(repository_url).path[1..]
+                           .gsub(%r{^repos/}, "")
+                           .split("/", 3)[0..1]
+                           .join("/")
+
+          github_slug.gsub(/\.git/, "")
         end
       end
     end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "graphql/client"
+require "graphql/client/http"
+
+module Bundler
+  module Alive
+    module Client
+      # GitHub GraphQL Module
+      module GithubGraphql
+        #
+        # Access token isn't set error
+        #
+        # @see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
+        #
+        class AccessTokenNotFoundError < StandardError
+          def initialize(_message = nil)
+            message = "Environment variable #{ACCESS_TOKEN_ENV_NAME} is not set."\
+                      " Need to set GitHub Personal Access Token to be authenticated at GitHub GraphQL API."\
+                      " See: https://docs.github.com/en/graphql/guides/forming-calls-with-graphql#the-graphql-endpoint"
+            super(message)
+          end
+        end
+
+        # Environment variable name of GitHub Access Token
+        ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITHUB_TOKEN"
+
+        # GraphQL API endpoint
+        # @see https://docs.github.com/en/graphql/guides/forming-calls-with-graphql#the-graphql-endpoint
+        ENDPOINT = "https://api.github.com/graphql"
+        private_constant :ENDPOINT
+
+        QUERY = <<~QUERY
+          query($var_query: String!, $var_first: Int!) {
+            search(
+              query: $var_query
+              type: REPOSITORY
+              first: $var_first
+            ) {
+              repositoryCount
+              nodes {
+                ... on Repository {
+                  isArchived
+                  nameWithOwner
+                  isMirror
+                }
+              }
+            }
+          }
+        QUERY
+        private_constant :QUERY
+
+        HTTP = GraphQL::Client::HTTP.new(ENDPOINT) do
+          def headers(_context)
+            token = ENV.fetch(ACCESS_TOKEN_ENV_NAME, nil)
+            raise AccessTokenNotFoundError if token.nil?
+
+            {
+              "Authorization" => "Bearer #{token}"
+            }
+          end
+        end
+        private_constant :HTTP
+
+        if File.exist?(SCHEMA_PATH)
+          SCHEMA = GraphQL::Client.load_schema(SCHEMA_PATH)
+        else
+          SCHEMA = GraphQL::Client.load_schema(HTTP)
+          Dir.mkdir(USER_PATH) unless Dir.exist?(USER_PATH)
+          GraphQL::Client.dump_schema(SCHEMA, SCHEMA_PATH)
+        end
+        private_constant :SCHEMA
+
+        # GraphQL client
+        CLIENT = GraphQL::Client.new(schema: SCHEMA, execute: HTTP)
+
+        # query
+        Query = CLIENT.parse(QUERY)
+      end
+    end
+  end
+end

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

@@ -45,7 +45,7 @@ module Bundler
         #
         # Creates a GitLab client
         #
-        # @return [Octokit::Client]
+        # @return [Gitlab::Client]
         #
         def create_client
           access_token = ENV.fetch(ACCESS_TOKEN_ENV_NAME, nil)

data/lib/bundler/alive/doctor.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "bundler"
-require "octokit"
 
 module Bundler
   module Alive
@@ -12,13 +11,14 @@ module Bundler
       #
       # A new instance of Doctor
       #
-      # @param [String] lock_file lock file of gem
-      # @param [String] config_file config file
-      # @param [Array<String>] ignore_gems ignore gems
+      # @param [String] :lock_file # lock file of gem
+      # @param [String] :config_file # config file
+      # @param [Array<String>] :ignore_gems ignore gems
+      # @param [Boolean] :follow_redirect Follow redirect URL in gems
       #
-      def initialize(lock_file, config_file, ignore_gems)
+      def initialize(lock_file:, config_file:, ignore_gems:, follow_redirect: false)
         @lock_file = lock_file
-        @gem_client = Client::GemsApiClient.new(config_file)
+        @gem_client = Client::GemsApiClient.new(config_path: config_file, follow_redirect: follow_redirect)
         @ignore_gems = ignore_gems
         @result = nil
         @rate_limit_exceeded = false

data/lib/bundler/alive/version.rb

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

data/lib/bundler/alive.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+module Bundler
+  module Alive
+    USER_PATH = File.expand_path(File.join(Gem.user_home, ".local", "share", "bundler-alive"))
+    SCHEMA_PATH = File.join(USER_PATH, "schema.json")
+  end
+end
+
 require_relative "alive/version"
 require_relative "alive/doctor"
 require_relative "alive/source_code_repository"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Katsuhiko YOSHIDA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
+date: 2022-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: graphql-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -209,6 +209,7 @@ files:
 - lib/bundler/alive/client/gems_api_client.rb
 - lib/bundler/alive/client/gems_api_response.rb
 - lib/bundler/alive/client/github_api.rb
+- lib/bundler/alive/client/github_graphql.rb
 - lib/bundler/alive/client/gitlab_api.rb
 - lib/bundler/alive/client/source_code_client.rb
 - lib/bundler/alive/doctor.rb
@@ -225,7 +226,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/kyoshidajp/bundler-alive
   source_code_uri: https://github.com/kyoshidajp/bundler-alive
-  changelog_uri: https://github.com/kyoshidajp/bundler-alive
+  changelog_uri: https://github.com/kyoshidajp/bundler-alive/commits/main
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []