bundler-push-host-key 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbd344862c377182985d31e5318a7059d813d3b0d0a52ac0b34a2de10a422a02
+  data.tar.gz: cfcfd8ca9c9083de7bd366c1e601eb8e3ac1e0b3253000956f35210c75f3abe3
+SHA512:
+  metadata.gz: 8b2aacc143a0c023b8268ce6841eb7ab0ecab338659f678bbac35e0aae5fcbd8b0d2bb3029139ec4080c873f3be79dd5788a997cee2a9f9474db481a978e3f9e
+  data.tar.gz: cedd1cb486de90be3b47a3a4ecdcecd3c91bcd4f982ad8592d3ab95a2c862346201b1937c6887d0f1043293d6b8b895de37525887d9307e36edbc5056b8fd80a

data/.gitignore

@@ -0,0 +1,2 @@
+/.idea
+/pkg

data/README.md

@@ -0,0 +1,40 @@
+# bundle-push-host-key
+
+This gem adds support for multiple keys when pushing gems using the bundler rake tasks
+
+## Usage
+
+ * In the Rakefile, replace `require 'bundler/gem_tasks'` with `require 'bundler/gem_tasks/push_host_key'`
+ * In `.gem/credentials add a new credential with your gemserver's hostname (only the hostname!) as key`:
+
+       ---
+       # Official rubygems API key entry 
+       :rubygems_api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+       
+       # Your custom API key for gemserver.example.net
+       :gemserver.example.net: <API Key>
+       
+       # Basic Authentication instead of API key 
+       :gemserver.example.net: "Basic dXNlcjpwYXNzCg=="
+
+ * In your gemspecs, set the `allowed_push_host`:
+ 
+       Gem::Specification.new do |gem|
+         # ...
+         gem.metadata = {
+           'allowed_push_host' => 'https://gemserver.example.com',
+         }
+         # ...
+       end
+
+## Notes
+
+This gem uses the `--key` feature of the `gem` command.
+When pushing with the `gem` command directly, you can specify `--key gemserver.example.net`  
+
+Afaik, the `gem` command has no official way to authenticate when loading gems.
+In Bundler you can set the basic auth credentials with this command: `bundle config gemserver.example.net user:pass`  
+
+If there is a better, official way to have multiple private gemserver with individual credentials
+and not only push-authentication, I will happily drop this gem.
+  

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH << File.join(__dir__, 'lib')
+
+require "rake/testtask"
+require 'bundler/gem_tasks/push_host_key'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end

data/bundler-push-host-key.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name    = 'bundler-push-host-key'
+  s.authors = ['Christian Haase']
+
+  s.version       = '1.0.0'
+  s.date          = '2020-07-03'
+  s.summary       = 'Use the correct api key when pushing gems'
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+end

data/lib/bundler/gem_helper/push_host_key.rb

@@ -0,0 +1,4 @@
+require 'bundler/gem_helper'
+require 'bundler_push_host_key'
+
+Bundler::GemHelper.prepend(BundlerPushHostKey)

data/lib/bundler/gem_tasks/push_host_key.rb

@@ -0,0 +1,4 @@
+require 'bundler/gem_helper/push_host_key'
+require 'bundler/gem_tasks'
+
+

data/lib/bundler_push_host_key.rb

@@ -0,0 +1,10 @@
+require 'uri'
+
+module BundlerPushHostKey
+  def gem_key
+    uri = URI.parse(gem_push_host)
+    uri = URI.parse("http://#{gem_push_host}") if uri.host.nil?
+
+    uri.host == 'rubygems.org' ? nil : uri.host
+  end
+end

data/test/bin/gem

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+echo "$@" > "$GEM_COMMANDLINE"

data/test/gem/all-allowed.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name    = 'gem'
+  s.authors = ['Somebody else']
+
+  s.version       = '1.0.0'
+  s.date          = '2020-07-03'
+  s.summary       = 'A Gem'
+  s.files         = []
+  s.require_paths = []
+end

data/test/gem/example-net-allowed.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name    = 'gem'
+  s.authors = ['Somebody else']
+
+  s.metadata = {
+    'allowed_push_host' => 'http://example.net',
+  }
+
+  s.version       = '1.0.0'
+  s.date          = '2020-07-03'
+  s.summary       = 'A Gem'
+  s.files         = []
+  s.require_paths = []
+end

data/test/test_push_host_key.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH << File.join(__dir__, '..', 'lib')
+require 'minitest/autorun'
+require 'rake'
+require 'tempfile'
+require 'bundler/gem_helper'
+require 'bundler/gem_helper/push_host_key'
+
+
+class TestPushHostKey < Minitest::Test
+  def setup
+    @orig_path = ENV['PATH']
+    ENV['PATH'] = File.join(__dir__, 'bin')
+
+    Tempfile.new.tap { |t| @gem_commandline_path = t.path }.close
+    ENV['GEM_COMMANDLINE'] = @gem_commandline_path
+  end
+
+  def teardown
+    Rake.application = nil
+    Bundler::GemHelper.instance = nil
+    ENV['PATH'] = @orig_path
+    ENV['GEM_COMMANDLINE'] = nil
+    File.unlink(@gem_commandline_path)
+  end
+
+  def gem_commandline
+    File.read(@gem_commandline_path).strip
+  end
+
+  def push_testgem(name)
+    Bundler::GemHelper.install_tasks(dir: File.join(__dir__, 'gem'), name: name)
+    Bundler.ui = nil
+
+    Rake::Task['release:rubygem_push'].reenable
+    Rake::Task['release:rubygem_push'].execute
+  end
+
+  def test_push_to_custom_host
+    push_testgem('example-net-allowed')
+    assert_includes(gem_commandline, '--key example.net')
+    assert_includes(gem_commandline, '--host http://example.net')
+  end
+
+  def test_push_to_rubygems
+    push_testgem('all-allowed')
+
+    refute_includes(gem_commandline, '--host')
+    refute_includes(gem_commandline, '--key')
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: bundler-push-host-key
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- bundler-push-host-key.gemspec
+- lib/bundler/gem_helper/push_host_key.rb
+- lib/bundler/gem_tasks/push_host_key.rb
+- lib/bundler_push_host_key.rb
+- test/bin/gem
+- test/gem/all-allowed.gemspec
+- test/gem/example-net-allowed.gemspec
+- test/test_push_host_key.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.8
+signing_key: 
+specification_version: 4
+summary: Use the correct api key when pushing gems
+test_files:
+- test/bin/gem
+- test/gem/all-allowed.gemspec
+- test/gem/example-net-allowed.gemspec
+- test/test_push_host_key.rb