gemstash 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912995cae585f3bc5fb9a4b1e1737fc9ef8afdfc47892d66e6360374dc37dc40
-  data.tar.gz: d6b0c0e60e4dba8ea22113b29f02f19817e79b1a83fb335ee3901a3840df5d85
+  metadata.gz: d58f7aa439647ca176542a5baa37d06ecc97a932d01c865dfc6c84ced8339eec
+  data.tar.gz: 5c2509224be5415b8beb839973c529d58cb76986bb93a4231069122974b85179
 SHA512:
-  metadata.gz: ef4f8e1a2e605b727ecb3209ae78e8f178e6b4967c3c98f431be973760cec50a6321cbac294817a201017cdc574ff6a849b02db8b6545cc87d938c4d3d7866ee
-  data.tar.gz: 4eea0daecfdb6686801d540f356db7673a87d3075b88fffb62ef6e730e55139e4cac7b287f456de4c07d2ff4caf2aebda3cc27f1818e5d8d3d4bd42a96f78de9
+  metadata.gz: becd0a79decd3a755c9867935e942854b614b2bbfa03a1928a770aed8faa9b4fcbd1d4f672c60cd01d45d9ebd20d591f2d4e30da0076bbe6d966cbea76b123eb
+  data.tar.gz: f775af62ccd3e2c5efada9cd41208fcbf060bfe2ab23a16fe79f70947d171a403d43aa2e4f96a48c78b73e5045f5aeda07af1e0d3fa80a210ffefd015cbc6ace

data/CHANGELOG.md

@@ -1,57 +1,56 @@
-## 2.3.2 (2023-09-14)
+## 2.4.0 (2023-09-27)
+
+### Changes
 
-https://github.com/rubygems/gemstash/compare/v2.3.1...v2.3.2
+  - Support naming and listing authorizations ([#365](https://github.com/rubygems/gemstash/pull/365), [@kyrofa](https://github.com/kyrofa))
+
+## 2.3.2 (2023-09-14)
 
 ### Fixes
 
-- Require a now-needed file for Puma 6. Thanks, [@ktreis][]! ([#362](https://github.com/rubygems/gemstash/pull/362), [@olleolleolle][])
+  - Require a now-needed file for Puma 6. Thanks, [@ktreis][]! ([#362](https://github.com/rubygems/gemstash/pull/362), [@olleolleolle](https://github.com/olleolleolle))
 
 ## 2.3.1 (2023-09-05)
 
-https://github.com/rubygems/gemstash/compare/v2.3.0...v2.3.1
-
 ### Fixes
 
-- Reinstate Ruby Central in README. ([#353](https://github.com/rubygems/gemstash/pull/353), [@olleolleolle][])
-- Implement Puma 5-required logger method `#sync` ([#355](https://github.com/rubygems/gemstash/pull/355), [@ball-hayden][])
+  - Reinstate Ruby Central in README. ([#353](https://github.com/rubygems/gemstash/pull/353), [@olleolleolle](https://github.com/olleolleolle))
+  - Implement Puma 5-required logger method `#sync` ([#355](https://github.com/rubygems/gemstash/pull/355), [@ball-hayden](https://github.com/ball-hayden))
 
 ## 2.3.0 (2023-08-30)
 
-https://github.com/rubygems/gemstash/compare/v2.2.2...v2.3.0
-
 ### Changes
 
-- Support Puma 6. ([#335](https://github.com/rubygems/gemstash/pull/335), [@MSP-Greg][])
-- Make UpstreamSource intermediate specs from upstream. ([#337](https://github.com/rubygems/gemstash/pull/337), [@tedgarb][])
-- Mention RubyCentral. ([#338](https://github.com/rubygems/gemstash/pull/338), [@adarsh][])
-- Configure Dependabot. ([#341](https://github.com/rubygems/gemstash/pull/341), [@olleolleolle][])
+  - Support Puma 6. ([#335](https://github.com/rubygems/gemstash/pull/335), [@MSP-Greg](https://github.com/MSP-Greg))
+  - Make UpstreamSource intermediate specs from upstream. ([#337](https://github.com/rubygems/gemstash/pull/337), [@tedgarb](https://github.com/tedgarb))
+  - Mention RubyCentral. ([#338](https://github.com/rubygems/gemstash/pull/338), [@adarsh](https://github.com/adarsh))
+  - Configure Dependabot. ([#341](https://github.com/rubygems/gemstash/pull/341), [@olleolleolle](https://github.com/olleolleolle))
 
 ## 2.2.2 (2023-03-03)
 
 ### Changes
 
-- Allow newer versions of the `activesupport` dependency ([#332](https://github.com/rubygems/gemstash/pull/332), [@kyrofa][])
+  - Allow newer versions of the `activesupport` dependency ([#332](https://github.com/rubygems/gemstash/pull/332), [@kyrofa](https://github.com/kyrofa))
 
 ## 2.2.1 (2023-02-09)
 
 ### Bugfixes
 
-- Add permitted classes to a `YAML.load` in cache ([#329](https://github.com/rubygems/gemstash/pull/329), [@SocalNick][])
+  - Add permitted classes to a `YAML.load` in cache ([#329](https://github.com/rubygems/gemstash/pull/329), [@SocalNick](https://github.com/SocialNick))
 
 ## 2.2.0 (2023-01-27)
 
 ### Bugfixes
 
-- Respect auth set in upstream host uri ([#317](https://github.com/rubygems/gemstash/pull/317), [@jebentier][])
-- Change the response code for "/versions" from 403 to 404 ([#326](https://github.com/rubygems/gemstash/pull/326), [@hendric-dev][])
+  - Respect auth set in upstream host uri ([#317](https://github.com/rubygems/gemstash/pull/317), [@jebentier](https://github.com/jbentier))
+  - Change the response code for "/versions" from 403 to 404 ([#326](https://github.com/rubygems/gemstash/pull/326), [@hendric-dev](https://github.com/hendric-dev))
 
 ### Changes
 
-- Support Ruby 3 ([#312](https://github.com/rubygems/gemstash/pull/312), [@tonytonyjan][])
-- Drop support for EOL Ruby versions 2.4, 2.5, 2.6 ([#328](https://github.com/rubygems/gemstash/pull/328), [@indirect][])
-- Update `dalli` dependency ([#324](https://github.com/rubygems/gemstash/pull/324), [@indirect][])
-
-Also thanks to: [@indirect][] and [@hsbt][] who fixed CI issues and lint warnings.
+  - Support Ruby 3 ([#312](https://github.com/rubygems/gemstash/pull/312), [@tonytonyjan](https://github.com/tonytonyjan))
+  - Drop support for EOL Ruby versions 2.4, 2.5, 2.6 ([#328](https://github.com/rubygems/gemstash/pull/328), [@indirect](https://github.com/indirect))
+  - Update `dalli` dependency ([#324](https://github.com/rubygems/gemstash/pull/324), [@indirect](https://github.com/indirect))
+  - Also thanks to: [@indirect][] and [@hsbt][] who fixed CI issues and lint warnings.
 
 ## 2.1.0 (2020-02-26)
 
@@ -290,17 +289,3 @@ Also thanks to: [@indirect][] and [@hsbt][] who fixed CI issues and lint warning
   - Various fixes 2 ([#47](https://github.com/bundler/gemstash/pull/47), [@smellsblue](https://github.com/smellsblue))
   - Various fixes 3 ([#49](https://github.com/bundler/gemstash/pull/49), [@smellsblue](https://github.com/smellsblue))
   - Add Gemtash logo ([#50](https://github.com/bundler/gemstash/pull/50), [@jonathanrieta](https://github.com/jonathanrieta))
-
-[@SocalNick]:  https://github.com/SocalNick
-[@hendric-dev]: https://github.com/hendric-dev
-[@hsbt]: https://github.com/hsbt
-[@indirect]: https://github.com/indirect
-[@jebentier]: https://github.com/jebentier
-[@kyrofa]: https://github.com/kyrofa
-[@tonytonyjan]: https://github.com/tonytonyjan
-[@MSP-Greg]: https://github.com/MSP-Greg
-[@tedgarb]: https://github.com/tedgarb
-[@adarsh]: https://github.com/adarsh
-[@olleolleolle]: https://github.com/olleolleolle
-[@ball-hayden]: https://github.com/ball-hayden
-[@ktreis]: https://github.com/ktreis

data/lib/gemstash/authorization.rb

@@ -13,7 +13,9 @@ module Gemstash
     extend Gemstash::Logging
     VALID_PERMISSIONS = %w[push yank fetch].freeze
 
-    def self.authorize(auth_key, permissions)
+    attr_reader :name
+
+    def self.authorize(auth_key, permissions, name = nil)
       raise "Authorization key is required!" if auth_key.to_s.strip.empty?
       raise "Permissions are required!" if permissions.to_s.empty?
 
@@ -25,7 +27,7 @@ module Gemstash
         permissions = permissions.join(",")
       end
 
-      Gemstash::DB::Authorization.insert_or_update(auth_key, permissions)
+      Gemstash::DB::Authorization.insert_or_update(auth_key, permissions, name)
       gemstash_env.cache.invalidate_authorization(auth_key)
       log.info "Authorization '#{auth_key}' updated with access to '#{permissions}'"
     end
@@ -62,6 +64,7 @@ module Gemstash
 
     def initialize(record)
       @auth_key = record.auth_key
+      @name = record.name
       @all = record.permissions == "all"
       @permissions = Set.new(record.permissions.split(","))
     end

data/lib/gemstash/cli/authorize.rb

@@ -2,6 +2,7 @@
 
 require "gemstash"
 require "securerandom"
+require "terminal-table"
 
 module Gemstash
   class CLI
@@ -12,8 +13,13 @@ module Gemstash
         prepare
         setup_logging
 
+        # Catch invalid option combinations
+        raise Gemstash::CLI::Error.new(@cli, "--remove and --list cannot both be used") if @cli.options[:remove] && @cli.options[:list]
+
         if @cli.options[:remove]
           remove_authorization
+        elsif @cli.options[:list]
+          list_authorizations
         else
           save_authorization
         end
@@ -26,6 +32,8 @@ module Gemstash
       end
 
       def remove_authorization
+        raise Gemstash::CLI::Error.new(@cli, "--name cannot be used with --remove") if @cli.options[:remove] && @cli.options[:name]
+
         unless @args.empty?
           raise Gemstash::CLI::Error.new(@cli, "To remove individual permissions, you do not need --remove
 Instead just authorize with the new set of permissions")
@@ -43,7 +51,24 @@ Instead just authorize with the new set of permissions")
           end
         end
 
-        Gemstash::Authorization.authorize(auth_key, permissions)
+        begin
+          name = @cli.options[:name]
+          Gemstash::Authorization.authorize(auth_key, permissions, name)
+        rescue Sequel::UniqueConstraintViolation => e
+          raise unless name && e.message.include?("authorizations.name")
+
+          raise Gemstash::CLI::Error.new(@cli, "Authorization with name '#{name}' already exists")
+        end
+      end
+
+      def list_authorizations
+        raise Gemstash::CLI::Error.new(@cli, "--key and --name cannot both be used with --list") if @cli.options[:name] && @cli.options[:key]
+
+        rows = map_authorizations(@cli.options[:key], @cli.options[:name]) do |authorization|
+          [authorization.name, authorization.auth_key, authorization.permissions]
+        end
+
+        @cli.say Terminal::Table.new :headings => %w[Name Key Permissions], :rows => rows
       end
 
       def auth_key(allow_generate: true)
@@ -66,6 +91,22 @@ Instead just authorize with the new set of permissions")
           @args
         end
       end
+
+      def map_authorizations(key = nil, name = nil, &block)
+        return Gemstash::DB::Authorization.map(&block) unless name || key
+
+        authorization = if name
+          Gemstash::DB::Authorization[name: name].tap do |authorization|
+            raise Gemstash::CLI::Error.new(@cli, "No authorization named '#{name}'") unless authorization
+          end
+        else
+          Gemstash::DB::Authorization[auth_key: key].tap do |authorization|
+            raise Gemstash::CLI::Error.new(@cli, "No authorization with key '#{key}'") unless authorization
+          end
+        end
+
+        [yield(authorization)]
+      end
     end
   end
 end

data/lib/gemstash/cli.rb

@@ -51,10 +51,14 @@ module Gemstash
     desc "authorize [PERMISSIONS...]", "Add authorizations to push/yank private gems"
     method_option :remove, :type => :boolean, :default => false, :desc =>
       "Remove an authorization key"
+    method_option :list, :type => :boolean, :default => false, :desc =>
+      "List existing authorization keys"
     method_option :config_file, :type => :string, :desc =>
       "Config file to save to"
     method_option :key, :type => :string, :desc =>
       "Authorization key to create/update/delete (optional unless deleting)"
+    method_option :name, :type => :string, :desc =>
+      "Name of the key (optional)"
     def authorize(*args)
       Gemstash::CLI::Authorize.new(self, *args).run
     end

data/lib/gemstash/db/authorization.rb

@@ -6,14 +6,14 @@ module Gemstash
   module DB
     # Sequel model for authorizations table.
     class Authorization < Sequel::Model
-      def self.insert_or_update(auth_key, permissions)
+      def self.insert_or_update(auth_key, permissions, name = nil)
         db.transaction do
           record = self[auth_key: auth_key]
 
           if record
-            record.update(permissions: permissions)
+            record.update(permissions: permissions, name: name)
           else
-            create(auth_key: auth_key, permissions: permissions)
+            create(auth_key: auth_key, permissions: permissions, name: name)
           end
         end
       end

data/lib/gemstash/man/gemstash-authorize.1

@@ -1,66 +1,54 @@
 <!-- Automatically generated by Pandoc -->
-.\" Automatically generated by Pandoc 3.1.6.2
+.\" Automatically generated by Pandoc 3.1.8
 .\"
-.\" Define V font for inline verbatim, using C font in formats
-.\" that render this, and otherwise B font.
-.ie "\f[CB]x\f[]"x" \{\
-. ftr V B
-. ftr VI BI
-. ftr VB B
-. ftr VBI BI
-.\}
-.el \{\
-. ftr V CR
-. ftr VI CI
-. ftr VB CB
-. ftr VBI CBI
-.\}
 .TH "gemstash-authorize" "1" "October 9, 2015" "" ""
-.hy
 .SH Name
-.PP
 gemstash-authorize - Adds or removes authorization to interact with
 privately stored gems
 .SH Synopsis
-.PP
-\f[V]gemstash authorize [permissions] [--remove] [--key SECURE_KEY] [--config-file FILE]\f[R]
+\f[CR]gemstash authorize [permissions] [--remove] [--list] [--key SECURE_KEY] [--name NAME] [--config-file FILE]\f[R]
 .SH Description
-.PP
 Adds or removes authorization to interact with privately stored gems.
 .PP
 Any arguments will be used as specific permissions.
-Valid permissions include \f[V]push\f[R], \f[V]yank\f[R], and
-\f[V]fetch\f[R].
+Valid permissions include \f[CR]push\f[R], \f[CR]yank\f[R], and
+\f[CR]fetch\f[R].
 If no permissions are provided, then all permissions will be granted
 (including any that may be added in future versions of Gemstash).
 .SS Usage
 .IP
-.nf
-\f[C]
+.EX
 gemstash authorize
 gemstash authorize push yank
+gemstash authorize push --name my-auth
 gemstash authorize yank --key <secure-key>
 gemstash authorize --remove --key <secure-key>
-\f[R]
-.fi
+gemstash authorize --list
+.EE
 .SH Options
 .IP \[bu] 2
-\f[V]--config-file FILE\f[R]: Specify the config file to use.
+\f[CR]--config-file FILE\f[R]: Specify the config file to use.
 If you aren\[cq]t using the default config file at
-\f[V]\[ti]/.gemstash/config.yml\f[R] or
-\f[V]\[ti]/.gemstash/config.yml.erb\f[R], then you must specify the
+\f[CR]\[ti]/.gemstash/config.yml\f[R] or
+\f[CR]\[ti]/.gemstash/config.yml.erb\f[R], then you must specify the
 config file via this option.
 .IP \[bu] 2
-\f[V]--key SECURE_KEY\f[R]: Specify the API key to affect.
+\f[CR]--key SECURE_KEY\f[R]: Specify the API key to affect.
 This should be the actual key value, not a name.
-This option is required when using \f[V]--remove\f[R] but is optional
+This option is required when using \f[CR]--remove\f[R] but is optional
 otherwise.
 If adding an authorization, using this will either create or update the
 permissions for the specified API key.
 If missing, a new API key will always be generated.
 Note that a key can only have a maximum length of 255 chars.
 .IP \[bu] 2
-\f[V]--remove\f[R]: Remove an authorization rather than add or update
+\f[CR]--name\f[R]: Name of the authorization.
+Purely for ease of identification, not required.
+.IP \[bu] 2
+\f[CR]--remove\f[R]: Remove an authorization rather than add or update
 one.
 When removing, permission values are not allowed.
-The \f[V]--key <secure-key>\f[R] option is required.
+The \f[CR]--key <secure-key>\f[R] option is required.
+.IP \[bu] 2
+\f[CR]--list\f[R]: List current authorizations.
+Provide \f[CR]--name\f[R] or \f[CR]--key\f[R] to show only one result.

data/lib/gemstash/man/gemstash-authorize.1.txt

@@ -7,38 +7,46 @@
        privately stored gems
 
 1mSynopsis0m
-       1mgemstash authorize [permissions] [--remove] [--key SECURE_KEY]  [--con-0m
-       1mfig-file FILE]0m
+       gemstash authorize [permissions] [--remove] [--list] [--key SECURE_KEY]
+       [--name NAME] [--config-file FILE]
 
 1mDescription0m
        Adds or removes authorization to interact with privately stored gems.
 
-       Any  arguments will be used as specific permissions.  Valid permissions
-       include 1mpush22m, 1myank22m, and 1mfetch22m.  If no permissions  are  provided,  then
+       Any arguments will be used as specific permissions.  Valid  permissions
+       include	push,  yank,  and fetch.  If no permissions are provided, then
        all permissions will be granted (including any that may be added in fu-
        ture versions of Gemstash).
 
    1mUsage0m
 	      gemstash authorize
 	      gemstash authorize push yank
+	      gemstash authorize push --name my-auth
 	      gemstash authorize yank --key <secure-key>
 	      gemstash authorize --remove --key <secure-key>
+	      gemstash authorize --list
 
 1mOptions0m
-       o 1m--config-file  FILE22m:  Specify  the config file to use.  If you aren't
-	 using the default config file at  1m~/.gemstash/config.yml  22mor  1m~/.gem-0m
-	 1mstash/config.yml.erb22m,  then you must specify the config file via this
+       o --config-file FILE: Specify the config file to use.   If  you	aren't
+	 using	the  default  config file at ~/.gemstash/config.yml or ~/.gem-
+	 stash/config.yml.erb, then you must specify the config file via  this
 	 option.
 
-       o 1m--key SECURE_KEY22m: Specify the API key to affect.	This should be	the
-	 actual  key  value,  not  a name.  This option is required when using
-	 1m--remove 22mbut is optional otherwise.  If adding an authorization,	us-
-	 ing  this will either create or update the permissions for the speci-
-	 fied API key.	If missing, a new API key will	always	be  generated.
+       o --key	SECURE_KEY: Specify the API key to affect.  This should be the
+	 actual key value, not a name.	This option  is  required  when  using
+	 --remove  but is optional otherwise.  If adding an authorization, us-
+	 ing this will either create or update the permissions for the	speci-
+	 fied  API  key.   If missing, a new API key will always be generated.
 	 Note that a key can only have a maximum length of 255 chars.
 
-       o 1m--remove22m:  Remove  an  authorization  rather  than add or update one.
-	 When removing, permission values are not allowed.  The 1m--key <secure-0m
-	 1mkey> 22moption is required.
+       o --name: Name of the authorization.  Purely for  ease  of  identifica-
+	 tion, not required.
+
+       o --remove:  Remove  an	authorization  rather  than add or update one.
+	 When removing, permission values are not allowed.  The --key <secure-
+	 key> option is required.
+
+       o --list: List current authorizations.  Provide --name or --key to show
+	 only one result.
 
 				October 9, 2015 	 4mgemstash-authorize24m(1)