rubygems-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cac2baf6384455802bac61aa1bcda1ab07d45add8c41d9814dee581011d391f
+  data.tar.gz: 0d85eceda3cf70d32c4099f9fef502563157b7056d0bad4d79f0fb1a5e3fcc7c
+SHA512:
+  metadata.gz: 31e5be4a4657773cb62dc2c7083e69c84b30babe9f126c35e04962e86daec4f391121f0130ea4c60c557fb7c773e5fe46a0f7d5fffb5b591be698fe6579b7a3b
+  data.tar.gz: 1822844fbb9df2b333a5eb3d309a19a2bd6ae3cfbe015691ec00808cdb1489c54c94654274e17abe468e317cb5b0a57f9214160ca7f17f342a6738a0a94c5621

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2026-02-10
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/rubygems/commands/api_command.rb
+lib/rubygems_plugin.rb
+test/rubygems/test_api.rb

data/README.rdoc

@@ -0,0 +1,55 @@
+= rubygems-api
+
+home :: https://github.com/seattlerb/rubygems-api
+rdoc :: https://docs.seattlerb.org/rubygems-api
+
+== DESCRIPTION:
+
+Send requests to rubygems' API and print the output. You can also
+query the output with jq (assuming json output) for that endpoint.
+
+== FEATURES/PROBLEMS:
+
+* Prints results from rubygems API.
+* Can use jq queries to filter and format results.
+* Currently only handles GET endpoints. See -h for a full list.
+* Uses ~/.gem/credentials for a higher query rate.
+
+== SYNOPSIS:
+
+  $ gem api "/api/v1/gems.json" -j "sort_by(.name).[].name"
+
+== REQUIREMENTS:
+
+* ruby
+* rubygems
+* open-uri
+
+== INSTALL:
+
+* gem install rubygems-api
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, seattle.rb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require "hoe"
+
+Hoe.plugin :isolate
+Hoe.plugin :seattlerb
+Hoe.plugin :rdoc
+Hoe.plugin :cov
+
+Hoe.spec "rubygems-api" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
+
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/lib/rubygems/commands/api_command.rb

@@ -0,0 +1,104 @@
+require "rubygems/command"
+require "open-uri"
+require "yaml"
+require "shellwords"
+
+# module Rubygems; end
+
+class Gem::Commands::ApiCommand < Gem::Command
+  VERSION = "1.0.0"
+
+  attr_accessor :creds
+
+  def initialize
+    defaults = { query: nil }
+
+    super("api", "Send requests to rubygems' API.", defaults)
+
+    add_option("-j", "--jq QUERY", "Pass results through jq with QUERY.") do |v, o|
+      options[:query] = v
+    end
+  end
+
+  def arguments # :nodoc:
+    "URL           API endpoint to hit, with params"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} URL [-j jq-query]"
+  end
+
+  def description
+    <<~EOF.lines.grep_v(/DELETE|POST|PATCH/).join # TODO: handle more?
+
+      `gem api` lets you hit rubygems API endpoints on the commandline.
+
+      It uses the credentials located at ~/.gem/credentials.
+
+      Here's the current full API:
+
+         GET    /api/v1/activity/latest
+         GET    /api/v1/activity/just_updated
+         GET    /api/v1/api_key.(json|yaml)
+         GET    /api/v1/dependencies?gems=$GEM1,$GEM2,...
+         GET    /api/v1/downloads.(json|yaml)
+         GET    /api/v1/downloads/$NAME-$VERSION.(json|yaml)
+         POST   /api/v1/gems
+         GET    /api/v1/gems.(json|yaml)
+         GET    /api/v1/gems/$NAME.(json|yaml)
+         GET    /api/v1/gems/$NAME/reverse_dependencies.json
+         GET    /api/v1/gems/$NAME/owners.(json|yaml)
+         POST   /api/v1/gems/$NAME/owners
+         DELETE /api/v1/gems/$NAME/owners
+         PATCH  /api/v1/gems/$NAME/owners
+         DELETE /api/v1/gems/yank
+         POST   /api/v1/oidc/trusted_publisher/exchange_token
+         GET    /api/v1/owners/$username_or_id/gems.(json|yaml)
+         GET    /api/v1/profile/me.(json|yaml)
+         GET    /api/v1/profiles/$username_or_id.(json|yaml)
+         GET    /api/v1/search.(json|yaml)?query=$query[&page=$N]
+         GET    /api/v1/timeframe_versions.json
+         GET    /api/v1/versions/$NAME.(json|yaml)
+         GET    /api/v1/versions/$NAME/latest.json
+         GET    /api/v1/web_hooks.(json|yaml)
+         POST   /api/v1/web_hooks
+         DELETE /api/v1/web_hooks/remove
+         POST   /api/v1/web_hooks/fire
+         GET    /api/v2/rubygems/$NAME/versions/$VERSION.(json|yaml)
+
+      Currently, only the GET endpoints are currently supported, but
+      most of the others are supported through other gem commands (eg
+      `gem owner`).
+    EOF
+  end
+
+  def read_url url
+    URI.parse(url)
+      .read("User-Agent"    => "rubygems-api/#{VERSION}",
+            "Authorization" => creds)
+  end
+
+  def execute
+    url = options[:args].shift
+
+    base = "https://rubygems.org" # HACK: should look at sources
+
+    url = base + url
+
+    prefs = YAML.load File.read File.expand_path "~/.gem/credentials"
+    self.creds = prefs[:rubygems_api_key]
+
+    body = read_url url
+
+    query = options[:query]
+    if query then
+      IO.popen ["jq", query].shelljoin, "r+" do |pipe|
+        pipe.puts body
+        pipe.close_write
+        say pipe.read
+      end
+    else
+      say body
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,3 @@
+require "rubygems/command_manager"
+
+Gem::CommandManager.instance.register_command :api

data/test/rubygems/test_api.rb

@@ -0,0 +1,63 @@
+require "minitest/autorun"
+require "rubygems/commands/api_command"
+require "json"
+
+module TestRubygems; end
+
+# sabotage open-uri
+class URI::HTTP
+  def read(_) = raise "no"
+end
+
+class TestRubygems::TestApi < Minitest::Test
+  attr_accessor :cmd, :inn, :out, :err
+
+  def setup
+    self.cmd = Gem::Commands::ApiCommand.new
+    self.inn = StringIO.new
+    self.out = StringIO.new
+    self.err = StringIO.new
+  end
+
+  def test_sanity
+    def cmd.read_url(_) = "[3,2,1]"
+
+    out = "[\n  1,\n  2,\n  3\n]\n"
+    assert_api out, "", %w[ /api/woot -j sort|. ]
+  end
+
+  def test_execute__vanilla
+    def cmd.read_url(_) = "[3,2,1]"
+
+    out = "[3,2,1]\n"
+    assert_api out, "", %w[ /api/woot ]
+  end
+
+  def test_cmd__help
+    assert_gem_output(/gem api URL/, "") do
+      cmd.show_help
+    end
+  end
+
+  def assert_api out, err, *args
+    cmd.handle_options args.flatten
+
+    assert_gem_output out, err do
+      cmd.execute
+    end
+  end
+
+  def assert_gem_output exp_out, exp_err
+    ui = Gem::StreamUI.new inn, out, err
+
+    Gem::DefaultUserInteraction.use_ui ui do
+      yield
+    end
+
+    o_type = Regexp === exp_out ? :match : :equal
+    e_type = Regexp === exp_err ? :match : :equal
+
+    send "assert_#{o_type}", exp_out, out.string
+    send "assert_#{e_type}", exp_err, err.string
+  end
+end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+�O��rMӒb�1��q�/���Ӝ�PT����u�E:ld���^��a"I@�R��&<��!Jv��l�0.[�e�)n#lE�qo�L#��Iu�^j�r�*^v�`�p�3��@�.�P�zF�h��,H��#
+���ii���z=����X.\�_�hSt0���l��D!��>�3"@� u�y�k��>�w*,��	k�jrF�I��`���nl��c[��ꤾaA,��:a�؂qr0�a����M�)���3�]5㤘�s�

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Davis
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBCjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTI2MDEwNzAxMDkxNFoXDTI3MDEwNzAxMDkxNFowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
+  AQA/X8/PKTTc/IkYQEUL6XWtfK8fAfbuLJzmLcz6f2ZWrtBvPsYvqRuwI1bWUtil
+  2ibJEfIuSIHX6BsUTX18+hlaIussf6EWq/YkE7e2BKmgQE42vSOZMce0kCEAPbx0
+  rQtqonfWTHQ8UbQ7GqCL3gDQ0QDD2B+HUlb4uaCZ2icxqa/eOtxMvHC2tj+h0xKY
+  xL84ipM5kr0bHGf9/MRZJWcw51urueNycBXu1Xh+pEN8qBmYsFRR4SIODLClybAO
+  6cbm2PyPQgKNiqE4H+IQrDVHd9bJs1XgLElk3qoaJBWXc/5fy0J1imYb25UqmiHG
+  snGe1hrppvBRdcyEzvhfIPjI
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+description: |-
+  Send requests to rubygems' API and print the output. You can also
+  query the output with jq (assuming json output) for that endpoint.
+
+  == Features/Problems:
+
+  * Prints results from rubygems API.
+  * Can use jq queries to filter and format results.
+  * Currently only handles GET endpoints. See -h for a full list.
+  * Uses ~/.gem/credentials for a higher query rate.
+email:
+- ryand-ruby@zenspider.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/rubygems/commands/api_command.rb
+- lib/rubygems_plugin.rb
+- test/rubygems/test_api.rb
+homepage: https://github.com/seattlerb/rubygems-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seattlerb/rubygems-api
+  documentation_uri: https://docs.seattlerb.org/rubygems-api
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Send requests to rubygems' API and print the output
+test_files: []