git_hub_bub 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99f20d88fb45334555be481192824a663b56834c77bdd8f66bb79172b129455
-  data.tar.gz: aa099a50aa5e657d2377c8d151d811e99720d41e4678097b9973b0d4a847d8c5
+  metadata.gz: 4a1fb065fefd4671e1af0e588b6cfb6ea5d19261d61af52196c3a6e78eb2640a
+  data.tar.gz: 6904fbfcd325633d8de9d6a332d8fe0700e58685b66d612598a007879526affc
 SHA512:
-  metadata.gz: ef2dbcabddf20e7cf6a9edef66d388203611afe876ff4fdc304e35de2af5a9e19189d773da365d4e9405a375353408accfd57038599c6df96421af48310f59fe
-  data.tar.gz: '0428e888f112051cab2d5d952305f39a747d662e43b2b4fe4ed43a7d5635f46aaad4b72a5b84f9f39c24969bacbc38c75f919f5936b10608b68f46f7ca7d0498'
+  metadata.gz: c8a89709d49289a988464527e23b88e8eaad3115d26714d50df2679078e06f0d735c08a5b06487f56b6619b15d90022c37031b345d91f83f8c69efe7d58d7ec8
+  data.tar.gz: 53fd2d767153a4ba3e38d7e8e8e5cbc747ddee4797247e3584771f5605c036a24a73e2e5c8721b88b548502729cf2aec9248b5d7ea2c2d81ee366e3acde2f9d3

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    # Avoid duplicate builds on PRs.
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Run StandardRB
+        run: bundle exec standardrb
+
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4', '4.0']
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.2

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec
+gemspec

data/README.md

@@ -1,6 +1,6 @@
 # GitHubBub
 
-[![Build Status](https://travis-ci.org/schneems/git_hub_bub.svg?branch=master)](https://travis-ci.org/schneems/git_hub_bub)
+[![CI](https://github.com/schneems/git_hub_bub/actions/workflows/ci.yml/badge.svg)](https://github.com/schneems/git_hub_bub/actions/workflows/ci.yml)
 [![Help Contribute to Open Source](https://www.codetriage.com/schneems/git_hub_bub/badges/users.svg)](https://www.codetriage.com/schneems/git_hub_bub)
 
 A low level GitHub client that makes the disgusting issue of header based url pagination simple.

data/Rakefile

@@ -1,15 +1,14 @@
-require 'bundler/gem_tasks'
-require 'git_hub_bub'
+require "bundler/gem_tasks"
+require "git_hub_bub"
 
-task :default => [:test]
+task default: [:test]
 
-require 'rake'
-require 'rake/testtask'
+require "rake"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
-

data/changelog.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## Master
+## Unreleased
+
+## 2.0.0
+
+- Changed: Minimum supported Ruby version updated to 3.2.
+- Fix: Responses that don't have a `last_url` in the link no longer error.
 
 ## 1.0.1
 

data/git_hub_bub.gemspec

@@ -1,32 +1,32 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'git_hub_bub/version'
+require "git_hub_bub/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = "git_hub_bub"
-  gem.version       = GitHubBub::VERSION
-  gem.authors       = ["Richard Schneeman"]
-  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
-  gem.description   = %q{git_hub_bub makes github requests}
-  gem.summary       = %q{git_hub_bub makes github requests}
-  gem.homepage      = "https://github.com/schneems/git_hub_bub"
-  gem.license       = "MIT"
+  gem.name = "git_hub_bub"
+  gem.version = GitHubBub::VERSION
+  gem.authors = ["Richard Schneeman"]
+  gem.email = ["richard.schneeman+rubygems@gmail.com"]
+  gem.description = "git_hub_bub makes github requests"
+  gem.summary = "git_hub_bub makes github requests"
+  gem.homepage = "https://github.com/schneems/git_hub_bub"
+  gem.license = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
   gem.add_dependency "rrrretry"
   gem.add_dependency "excon"
+  gem.add_dependency "base64"
   gem.add_development_dependency "timecop"
   gem.add_development_dependency "test-unit"
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "vcr",     '~> 2.5.0'
-  gem.add_development_dependency "webmock", '~> 1.11.0'
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
   gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "standard"
 
-  gem.required_ruby_version = '>= 2.2'
+  gem.required_ruby_version = ">= 3.2"
 end

data/lib/git_hub_bub/request.rb

@@ -4,22 +4,23 @@ module GitHubBub
   class RequestError < StandardError; end
 
   class Request
-    attr_accessor :url, :options, :token
-    BASE_URI       = 'https://api.github.com'
-    USER_AGENT     ||= SecureRandom.hex(16)
+    attr_accessor :url, :options
+    attr_writer :token
+    BASE_URI = "https://api.github.com"
+    USER_AGENT = defined?(USER_AGENT) ? USER_AGENT : SecureRandom.hex(16)
     GITHUB_VERSION = "vnd.github.3.raw+json"
-    EXTRA_HEADERS  ||= {}
-    BASE_HEADERS   = EXTRA_HEADERS.merge({'Accept' => "application/#{GITHUB_VERSION}", "User-Agent" => USER_AGENT})
-    BASE_OPTIONS   = { omit_default_port:  true }
-    RETRIES        = 1
-    RAISE_ON_FAIL  = ENV["GIT_HUB_BUB_RAISE_ON_FAIL"]
+    EXTRA_HEADERS = defined?(EXTRA_HEADERS) ? EXTRA_HEADERS : {}
+    BASE_HEADERS = EXTRA_HEADERS.merge({"Accept" => "application/#{GITHUB_VERSION}", "User-Agent" => USER_AGENT})
+    BASE_OPTIONS = {omit_default_port: true}
+    RETRIES = 1
+    RAISE_ON_FAIL = ENV["GIT_HUB_BUB_RAISE_ON_FAIL"]
 
     def initialize(url, query = {}, options = {})
-      self.url               = url =~ /^http(\w?)\:\/\// ? url : File.join(BASE_URI, url)
-      @skip_token            = options.delete(:skip_token)
-      self.options           = BASE_OPTIONS.merge(options || {})
-      self.options[:query]   = query if query && !query.empty?
-      self.options[:headers] = BASE_HEADERS.merge(options[:headers]|| {})
+      self.url = /^http(\w?):\/\//.match?(url) ? url : File.join(BASE_URI, url)
+      @skip_token = options.delete(:skip_token)
+      self.options = BASE_OPTIONS.merge(options || {})
+      self.options[:query] = query if query && !query.empty?
+      self.options[:headers] = BASE_HEADERS.merge(options[:headers] || {})
     end
 
     def skip_token?
@@ -27,7 +28,7 @@ module GitHubBub
     end
 
     def self.head(url, query = {}, options = {})
-      self.new(url, query, options).head
+      new(url, query, options).head
     end
 
     def head
@@ -37,19 +38,21 @@ module GitHubBub
     end
 
     def self.get(url, query = {}, options = {})
-      self.new(url, query, options).get
+      new(url, query, options).get
     end
 
     def get
       wrap_request do
         ex = Excon.get(url, options)
-        ex = Excon.get(@location, options) if @location = ex.headers["Location"]
+        if (@location = ex.headers["Location"])
+          ex = Excon.get(@location, options)
+        end
         ex
       end
     end
 
     def self.post(url, query = {}, options = {})
-      self.new(url, query, options).post
+      new(url, query, options).post
     end
 
     def post
@@ -59,7 +62,7 @@ module GitHubBub
     end
 
     def self.patch(url, query = {}, options = {})
-      self.new(url, query, options).patch
+      new(url, query, options).patch
     end
 
     def patch
@@ -69,7 +72,7 @@ module GitHubBub
     end
 
     def self.put(url, query = {}, options = {})
-      self.new(url, query, options).put
+      new(url, query, options).put
     end
 
     def put
@@ -79,7 +82,7 @@ module GitHubBub
     end
 
     def self.delete(url, query = {}, options = {})
-      self.new(url, query, options).delete
+      new(url, query, options).delete
     end
 
     def delete
@@ -97,9 +100,9 @@ module GitHubBub
       end
 
       if RAISE_ON_FAIL
-        raise RequestError, "message: '#{response.json_body['message']}', url: '#{url}', response: '#{response.inspect}'" unless response.success?
+        raise RequestError, "message: '#{response.json_body["message"]}', url: '#{url}', response: '#{response.inspect}'" unless response.success?
       end
-      return response
+      response
     end
 
     # do they take query params? do they take :body?
@@ -114,22 +117,22 @@ module GitHubBub
     end
 
     def token
-      @token ||= if options[:headers] && token_string = options[:headers]["Authorization"]
+      @token ||= if options[:headers] && (token_string = options[:headers]["Authorization"])
         token_string.split(/\s/).last
-      elsif options[:query] && token = options[:query].delete(:token)
-        token
+      elsif options[:query] && (query_token = options[:query].delete(:token))
+        query_token
       else
         skip_token?
       end
     end
-    alias :token? :token
+    alias_method :token?, :token
 
     def self.set_before_callback(&block)
       before_callbacks << block
     end
 
     def self.before_callbacks
-      @before_callbacks ||=[]
+      @before_callbacks ||= []
     end
 
     def self.clear_callbacks
@@ -138,7 +141,7 @@ module GitHubBub
 
     def before_callbacks!
       self.class.before_callbacks.each do |callback|
-        run_callback &callback
+        run_callback(&callback)
       end
     end
 

data/lib/git_hub_bub/response.rb

@@ -1,104 +1,106 @@
 # frozen_string_literal: true
 
-require 'date'
+require "date"
 
 module GitHubBub
   class Response < Excon::Response
-     def self.create(response)
-       self.new(response.data)
-     end
-
-     def rate_limit_remaining
-       limit_remaining = headers["X-RateLimit-Limit"]
-       Integer(limit_remaining)
-     end
-
-     def rate_limit_reset_time_left # in seconds
-       utc_epoch_seconds = headers["X-RateLimit-Reset"]
-       utc_epoch_seconds = Integer(utc_epoch_seconds)
-       return utc_epoch_seconds - Time.now.utc.to_i
-     end
-
-     # When no time is left we want to sleep until our limit is reset
-     # i.e. remaining is 1 so time/1 => time
-     #
-     # When we have plenty of requests left then we want to sleep for too long
-     # i.e. time / 1000 => smaller amount of time
-     def rate_limit_sleep!(bypass_sleep: false)
+    def self.create(response)
+      new(response.data)
+    end
+
+    def rate_limit_remaining
+      limit_remaining = headers["X-RateLimit-Limit"]
+      Integer(limit_remaining)
+    end
+
+    def rate_limit_reset_time_left # in seconds
+      utc_epoch_seconds = headers["X-RateLimit-Reset"]
+      utc_epoch_seconds = Integer(utc_epoch_seconds)
+      utc_epoch_seconds - Time.now.utc.to_i
+    end
+
+    # When no time is left we want to sleep until our limit is reset
+    # i.e. remaining is 1 so time/1 => time
+    #
+    # When we have plenty of requests left then we want to sleep for too long
+    # i.e. time / 1000 => smaller amount of time
+    def rate_limit_sleep!(bypass_sleep: false)
       remaining = rate_limit_remaining
       time_left = rate_limit_reset_time_left
       return 0 if time_left <= 0
       return 0 if remaining > 1000
 
-      if remaining > 0
-        val = time_left / remaining.to_f
+      val = if remaining > 0
+        time_left / remaining.to_f
       else
-        val = time_left
+        time_left
       end
       sleep(val) unless bypass_sleep
-      return val
-     end
+      val
+    end
 
-     def json_body
-      ::JSON.parse(self.body)
-     end
+    def json_body
+      ::JSON.parse(body)
+    end
 
-     def success?
+    def success?
       status.to_s =~ /^2.*/
-     end
+    end
 
-     def pagination
-       @pagination ||= parse_pagination
-     end
+    def pagination
+      @pagination ||= parse_pagination
+    end
 
-     def parsed_response
+    def parsed_response
       response.body.inspect
-     end
-
-     def next_url
-       pagination['next_url']
-     end
-
-     def prev_url
-       pagination['prev_url']
-     end
-     alias :previous_url :prev_url
-
-     def last_url
-       pagination['last_url']
-     end
-
-     def first_url
-       pagination['first_url']
-     end
-
-     def last_page?
-       return true if next_url.nil?
-       last_page_number = page_number_from_url(last_url)
-       next_page_number = page_number_from_url(next_url)
-       return next_page_number > last_page_number
-     end
-
-     def first_page?
-       return true if first_url.nil?
-       return false
-     end
-
-     def page_number_from_url(url)
-       query = ::URI.parse(url).query
-       ::CGI.parse(query)["page"].first.to_i
-     end
+    end
+
+    def next_url
+      pagination["next_url"]
+    end
+
+    def prev_url
+      pagination["prev_url"]
+    end
+    alias_method :previous_url, :prev_url
+
+    def last_url
+      pagination["last_url"]
+    end
+
+    def first_url
+      pagination["first_url"]
+    end
+
+    def last_page?
+      return true if next_url.nil?
+      return false if last_url.nil? # A next page exists, but no "last" page, keep going.
+      last_page_number = page_number_from_url(last_url)
+      next_page_number = page_number_from_url(next_url)
+      next_page_number > last_page_number
+    end
+
+    def first_page?
+      return true if first_url.nil?
+      false
+    end
+
+    def page_number_from_url(url)
+      query = ::URI.parse(url).query
+      params = ::URI.decode_www_form(query).to_h
+      params["page"].to_i
+    end
 
     def header_links
-       (headers['link'] || headers['Link'] || "").split(',')
-     end
-
-     def parse_pagination
-       header_links.each_with_object({}) do |element, hash|
-         key   = element[/rel=["'](.*)['"]/, 1]
-         value = element[/<(.*)>/, 1]
-         hash["#{key}_url"] = value
-       end
-     end
-   end
-end
+      (headers["link"] || headers["Link"] || "").split(",")
+    end
+
+    def parse_pagination
+      header_links.each_with_object({}) do |element, hash|
+        key = element[/rel=["'](.*)['"]/, 1]
+        value = element[/<(.*)>/, 1]
+        hash["#{key}_url"] = value
+      end
+    end
+  end
+end

data/lib/git_hub_bub/version.rb

@@ -1,3 +1,3 @@
 module GitHubBub
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/git_hub_bub.rb

@@ -1,26 +1,24 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-require 'json'
-require 'uri'
-require 'cgi'
+require "securerandom"
+require "json"
+require "uri"
 
-require 'excon'
-require 'rrrretry'
+require "excon"
+require "rrrretry"
 
-require 'git_hub_bub/request'
-require 'git_hub_bub/response'
+require "git_hub_bub/request"
+require "git_hub_bub/response"
 
 module GitHubBub
   class << self
-
     def valid_token?(token)
-      response = Request.get("https://#{ENV['GITHUB_APP_ID']}:#{ENV['GITHUB_APP_SECRET']}@api.github.com/applications/#{ENV['GITHUB_APP_ID']}/tokens/#{token}", {}, {skip_token: true})
+      response = Request.get("https://#{ENV["GITHUB_APP_ID"]}:#{ENV["GITHUB_APP_SECRET"]}@api.github.com/applications/#{ENV["GITHUB_APP_ID"]}/tokens/#{token}", {}, {skip_token: true})
       return response if response.success?
-      return false if response.status == 404
+      false if response.status == 404
     rescue GitHubBub::RequestError => e
       if Request::RAISE_ON_FAIL
-        return false
+        false
       else
         raise e
       end
@@ -50,4 +48,4 @@ module GitHubBub
       Request.delete(*args)
     end
   end
-end
+end