rubygems-source-cli 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rubygems-source-cli_patches.gemspec
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+rubygems-source-cli ![travis-ci](https://secure.travis-ci.org/textgoeshere/rubygems-source-cli.png)
+===================
+
+This is a collection of dirty, dirty patches for `gem push` and `gem
+yank`:
+
+* When you do not supply an API key and you are not using
+  `rubygems.org`, you are not prompted to sign into `rubygems.org`
+* `gem yank` accepts `--host [HOST]` and `--key [KEY]` options
+
+Usage
+-----
+
+API keys should be stored in YAML format in `$HOME/.gem/credentials`:
+
+    ---
+    :rubygems_api_key: 198dbad38sadasd87
+    :another_key: 2897234987bsdb90834
+
+Then specify `--host` and `--key` options when pushing/yanking:
+
+    $ gem push mygem-1.0.0.gem --host https://example.com --key another_key
+    $ gem yank mygem-1.0.0.gem --host https://example.com --key another_key
+
+Install
+-------
+
+* `gem install rubygems-source-cli`
+
+or add it to your `Gemfile`:
+
+* `gem "rubygems-source-cli"`
+
+Development
+-----------
+
+* Source hosted at [GitHub](https://github.com/kapoq/rubygems-source-cli)
+* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/kapoq/rubygems-source-cli)
+* CI at [Travis](http://travis-ci.org/#!/textgoeshere/rubygems-source-cli)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
+you make.
+
+### Testing ###
+
+    $ rake
+
+Related projects
+----------------
+
+* [rubygems-source](https://github.com/kapoq/rubygems-source): 
+  remote source server for Rubygems that implements the core Rubygems gem source web API
+* [rubygems-source-features](https://github.com/kapoq/rubygems-source-features):
+  Cucumber features for Rubygems sources
+* [rubygems.org](https://github.com/rubygems/rubygems.org): 
+  Daddy
+* [geminabox](https://github.com/cwninja/geminabox): 
+  Very similar project, no `gem yank`, no tests of any kind
+* [sinatra-rubygems](https://github.com/jnewland/sinatra-rubygems): 
+  Replacement for `gem server` - no `gem push`, `gem yank` or resolver
+
+Author
+------
+
+[Dave Nolan](https://github.com/textgoeshere)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]

data/features/per-source_api_authentication.feature

@@ -0,0 +1,29 @@
+Feature: per-source API authentication
+  In order maintain a thin veneer of security
+  As a gem developer
+  I want to use the correct key to authenticate with Rubygems sources
+
+  Scenario: authenticate with Rubygems.org with a rubygems.org api key
+    Given I have a gem credentials file with a valid rubygems.org api key
+    And a gem package named "foo.gem"
+    When I run `gem push foo.gem`
+    Then I am not prompted to sign into rubygems.org
+    Then I am authenticated with host "https://rubygems.org"
+
+  Scenario: authenticate with custom api key
+    Given I have a gem credentials file with a valid api key for host "other.org"
+    And a gem package named "foo.gem"
+    When I run `gem push foo.gem --host https://other.org --key other.org`
+    Then I am authenticated with host "https://other.org"
+
+  Scenario: prompted to enter rubygems.org credentials when pushing to rubygems.org without an API key
+    Given I have no stored gem credentials 
+    And a gem package named "foo.gem"
+    When I run `gem push foo.gem`
+    Then I am prompted to sign into rubygems.org
+
+  Scenario: not prompted to enter unnecessary rubygems.org credentials
+    Given I have no stored gem credentials 
+    And a gem package named "foo.gem"
+    When I run `gem push foo.gem --host https://notrubygems.org`
+    Then I am not prompted to sign into rubygems.org

data/features/require_source_option_for_gem_push_and_yank.feature

@@ -0,0 +1,5 @@
+Feature: require source option for gem push and yank
+  In order to ensure my code is only shared with the people I want
+  As a gem developer
+  I want to be forced to specify the Rubygems source explicitly
+

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,23 @@
+When /^I read the help for the patched commands$/ do
+  @output = {}
+  Rubygems::Source::CLI::COMMANDS.each do |command|
+    run_simple("gem help #{command}")
+    @output[command] = all_stdout
+  end
+end
+
+When /^I run the patched commands$/ do
+  @output = {}
+  Rubygems::Source::CLI::COMMANDS.each do |command|
+    # Don't want wait for the command to execute successfully,
+    # so force an error by passing an invalid option
+    run_simple("gem #{command} --invalid-option-to-force-error", false)
+    @output[command] = all_output
+  end
+end
+
+Then /^I see a warning they are patched$/ do
+  @output.each do |cmd, s|
+    unescape(s).should include("patched by rubygems-source-cli")
+  end
+end

data/features/step_definitions/gem_steps.rb

@@ -0,0 +1,15 @@
+Given /^a gem package named "([^"]*)"$/ do |package_name|
+  write_file(package_name, "fake")
+end
+
+Given /^I have a gem credentials file with a valid rubygems\.org api key$/ do
+  @key = create_valid_api_key("rubygems_api_key")
+end
+
+Given /^I have a gem credentials file with a valid api key for host "([^"]*)"$/ do |host|
+  @key = create_valid_api_key(host)
+end
+
+Given /^I have no stored gem credentials$/ do
+  delete_gem_credentials
+end

data/features/step_definitions/response_steps.rb

@@ -0,0 +1,11 @@
+Then /^I am authenticated with host "([^"]*)"$/ do |host|
+  assert_partial_output("Authenticated successfully with #{host}", all_output)
+end
+
+Then /^I am prompted to sign into rubygems\.org$/ do
+  assert_partial_output("Enter your RubyGems.org credentials.", all_output)
+end
+
+Then /^I am not prompted to sign into rubygems\.org$/ do
+  assert_no_partial_output("Enter your RubyGems.org credentials.", all_output)
+end

data/features/support/credentials_helper.rb

@@ -0,0 +1,11 @@
+module CredentialsHelper
+  def create_valid_api_key(name)
+    write_file("credentials", ":#{name}: valid_key_for_#{name}")
+  end
+
+  def delete_gem_credentials
+    remove_file("credentials") if File.exists?("credentials")
+  end
+end
+
+World(CredentialsHelper)

data/features/support/env.rb

@@ -0,0 +1,9 @@
+ENV["RUBY_ENV"] ||= "test"
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'rubygems-source-cli'
+require 'aruba/cucumber'
+
+

data/features/warn_commands_are_patched.feature

@@ -0,0 +1,12 @@
+Feature: warn commands are patched
+  In order to manage a shitload of dependencies
+  As a developer
+  I want to be reminded that I have patched gem commands
+
+  Scenario: see warning in help
+    When I read the help for the patched commands
+    Then I see a warning they are patched
+
+  Scenario: see warning on execute
+    When I run the patched commands
+    Then I see a warning they are patched

data/features/yank_from_non-rubygems.org_source.feature

@@ -0,0 +1,9 @@
+Feature: yank gem from non-Rubygems.org source
+  In order to defend my team from sub-awesome code
+  As a gem developer
+  I want to yank a bad gem from our local Rubygems source server
+
+  Scenario: yank gem from custom Rubygems source
+    Given I have a gem credentials file with a valid api key for host "other.org"
+    When I run `gem yank mygem.gem -v 1.0.0 --host https://other.org --key other.org`
+    And I am authenticated with host "https://other.org"

data/lib/rubygems-source-cli.rb

@@ -0,0 +1,12 @@
+module Rubygems
+  module Source
+    module CLI
+      autoload :VERSION, "rubygems-source-cli/version"
+      autoload :CommandPatch, "rubygems-source-cli/command_patch"
+      
+      COMMANDS = %w(yank push server)
+    end
+  end
+end
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "test", "test_helper")) if ENV['RUBY_ENV'] == 'test'

data/lib/rubygems-source-cli/command_patch.rb

@@ -0,0 +1,11 @@
+module Rubygems::Source::CLI
+  module CommandPatch
+    def initialize(*args)
+      warning = "* This command is patched by rubygems-source-cli v#{Rubygems::Source::CLI::VERSION} *"
+      say "\n" + (%w(*) * warning.length).join
+      say warning
+      say (%w(*) * warning.length).join + "\n\n"
+      super
+    end
+  end
+end

data/lib/rubygems-source-cli/commands/push_command.rb

@@ -0,0 +1,19 @@
+class Gem::Commands::PushCommand < Gem::Command
+  RUBYGEMS_HOST = "rubygems.org"
+  
+  def execute
+    sign_into_rubygems if host_is_rubygems? && !Gem.configuration.rubygems_api_key
+    send_gem get_one_gem_name
+  end
+
+  def sign_into_rubygems
+    sign_in
+  end
+
+  private
+
+  def host_is_rubygems?
+    uri = ENV['RUBYGEMS_HOST'] || options[:host] || Gem.host
+    URI.parse(uri).host == RUBYGEMS_HOST
+  end
+end

data/lib/rubygems-source-cli/commands/server_command.rb

@@ -0,0 +1,4 @@
+module Rubygems::Source::CLI
+  module ServerCommand
+  end
+end

data/lib/rubygems-source-cli/commands/yank_command.rb

@@ -0,0 +1,69 @@
+class Gem::Commands::YankCommand < Gem::Command
+  RUBYGEMS_HOST = "rubygems.org"
+
+  def initialize(*args)
+    super 'yank', description
+    add_version_option("remove")
+    add_platform_option("remove")
+    add_option('--undo') do |value, options|
+      options[:undo] = true
+    end
+    add_key_option
+    add_option(
+               '--host HOST',
+               'Yank from another gemcutter-compatible host'
+               ) do |value, options|
+      options[:host] = value
+    end
+  end
+  
+  def execute
+    sign_into_rubygems if host_is_rubygems? && !Gem.configuration.rubygems_api_key
+    version   = get_version_from_requirements(options[:version])
+    platform  = get_platform_from_requirements(options)
+    
+    if !version.nil?
+      if options[:undo]
+        unyank_gem(version, platform)
+      else
+        yank_gem(version, platform)
+      end
+    else
+      say "A version argument is required: #{usage}"
+      terminate_interaction
+    end
+  end
+
+  def yank_gem(version, platform)
+    say "Yanking gem from #{options[:host] || 'Rubygems.org'}..."
+    yank_api_request(:delete, version, platform, "api/v1/gems/yank")
+  end
+  
+  def unyank_gem(version, platform)
+    say "Unyanking gem from #{options[:host] || 'Rubygems.org'}..."
+    yank_api_request(:put, version, platform, "api/v1/gems/unyank")
+  end
+
+  def sign_into_rubygems
+    sign_in
+  end
+
+  private
+
+  def host_is_rubygems?
+    uri = ENV['RUBYGEMS_HOST'] || options[:host] || Gem.host
+    URI.parse(uri).host == RUBYGEMS_HOST
+  end
+
+  def yank_api_request(method, version, platform, api)
+    args = [method, "api/v1/gems"]
+    args << options[:host] if options[:host]
+    
+    name = get_one_gem_name
+    response = rubygems_api_request(*args) do |request|
+      request.add_field("Authorization", api_key)
+      request.set_form_data({'gem_name' => name, 'version' => version, 'platform' => platform})
+    end
+    say response.body
+  end
+end

data/lib/rubygems-source-cli/version.rb

@@ -0,0 +1,7 @@
+module Rubygems
+  module Source
+    module CLI
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,17 @@
+require 'rubygems/command_manager'
+require 'rubygems/command'
+require 'rubygems-source-cli'
+
+#
+# Load files and apply patches for each command
+#
+Rubygems::Source::CLI::COMMANDS.each do |cmd|
+  filename   = "#{cmd}_command"
+  const_name = cmd.capitalize.gsub(/_(.)/) { $1.upcase } << "Command"
+  
+  require "rubygems/commands/#{filename}"
+  require "rubygems-source-cli/commands/#{filename}"
+  
+  klass = Gem::Commands.const_get(const_name)
+  klass.send(:include, Rubygems::Source::CLI::CommandPatch)
+end

data/rubygems-source-cli.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rubygems-source-cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rubygems-source-cli"
+  s.version     = Rubygems::Source::CLI::VERSION
+  s.authors     = ["dave@kapoq.com"]
+  s.email       = ["dave@kapoq.com"]
+  s.homepage    = "https://github.com/kapoq/rubygems-source-cli"
+  s.summary     = "Patches for gem serve, gem push, gem yank, and some utilities"
+  s.description = "Patches for gem serve, gem push, gem yank, and some utilities to allow use of non-Rubygems.org gem sources"
+
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "builder"
+  s.add_development_dependency "gemcutter"
+  if RUBY_PLATFORM =~ /linux/
+    s.add_development_dependency "rb-inotify"
+    s.add_development_dependency "libnotify"
+  end
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'webmock'
+
+#
+# Disable all net access
+#
+WebMock.disable_net_connect!
+
+#
+# Stub out expected requests
+#
+include WebMock::API
+
+stub_request(:post, "https://rubygems.org/api/v1/gems").with(:headers => {'Authorization'=>'valid_key_for_rubygems_api_key'}).to_return(:status => 200, :body => "Authenticated successfully with https://rubygems.org", :headers => {})
+
+stub_request(:post, "https://other.org/api/v1/gems").with(:headers => {'Authorization'=>'valid_key_for_other.org'}).to_return(:status => 200, :body => "Authenticated successfully with https://other.org", :headers => {})
+
+
+stub_request(:delete, "https://other.org/api/v1/gems").with(:headers => {'Authorization'=>'valid_key_for_other.org'}).to_return(:status => 200, :body => "Authenticated successfully with https://other.org", :headers => {})
+
+#
+# Overwrite credentials_path so Gem users test credentials file created by Aruba
+#
+class Gem::ConfigFile
+  def credentials_path
+    File.expand_path(File.join(File.dirname(__FILE__), "..", "tmp", "aruba", "credentials"))
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-source-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- dave@kapoq.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &22041280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22041280
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &22040740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22040740
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &22040220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22040220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22039760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22039760
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &22039220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22039220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &22038700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22038700
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &22038280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22038280
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &22037820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22037820
+- !ruby/object:Gem::Dependency
+  name: gemcutter
+  requirement: &22037280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22037280
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &22036780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22036780
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &22036240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22036240
+description: Patches for gem serve, gem push, gem yank, and some utilities to allow
+  use of non-Rubygems.org gem sources
+email:
+- dave@kapoq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- features/per-source_api_authentication.feature
+- features/require_source_option_for_gem_push_and_yank.feature
+- features/step_definitions/cli_steps.rb
+- features/step_definitions/gem_steps.rb
+- features/step_definitions/response_steps.rb
+- features/support/credentials_helper.rb
+- features/support/env.rb
+- features/warn_commands_are_patched.feature
+- features/yank_from_non-rubygems.org_source.feature
+- lib/rubygems-source-cli.rb
+- lib/rubygems-source-cli/command_patch.rb
+- lib/rubygems-source-cli/commands/push_command.rb
+- lib/rubygems-source-cli/commands/server_command.rb
+- lib/rubygems-source-cli/commands/yank_command.rb
+- lib/rubygems-source-cli/version.rb
+- lib/rubygems_plugin.rb
+- rubygems-source-cli.gemspec
+- test/test_helper.rb
+homepage: https://github.com/kapoq/rubygems-source-cli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Patches for gem serve, gem push, gem yank, and some utilities
+test_files: []