gemsmith 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28d4c64a7cb8cc5819196a8c3ee614e2da031350
-  data.tar.gz: 1dfec05ae110a647cc69134ed9f2e522d7a0a830
+  metadata.gz: b15a788991bc084549c98a462eed3c3f5c38cdca
+  data.tar.gz: 9738979e1f90e3f9e32a1e43da1a5ab1122bcab2
 SHA512:
-  metadata.gz: 410efca04dbfdd99d472a4d986a4a15192afbf86766397be24d4af210dde4532294a286dc2206132156aa8f3dc6f3fe822b71d7171d30dd9aa06884d12172e99
-  data.tar.gz: ebf4fa5d837dbd5eda29f22080fceddd1545cc5034e2f0834a38346f2db5327fb0290fc9196a6243acf0fb69637cdd6c9bfa1df6c987a03160bb95e6111bb506
+  metadata.gz: e44ec634d3ed7706e7b2b3a807d57bbf36631b9e8d818e4e3f2fc02b8166bf13b401dad37de89dd7bfb933da86d929c02c9813890549d31ace84987ba3b9c9c1
+  data.tar.gz: c983d010a5878a9a28082c66e61eb51a3ee0d235a224b612b5a5d7d629f0a6e0c1aa42c774c0e98eb8e6e0c3b3c6cabdae50f5ef3d14c04af2ce99c8f95a47b2

data/README.md

@@ -26,8 +26,7 @@ A command line interface for smithing new Ruby gems.
   - [Gem Certificates](#gem-certificates)
 - [Private Gem Servers](#private-gem-servers)
   - [Gem Specification Metadata](#gem-specification-metadata)
-  - [RubyGems Credentials](#rubygems-credentials)
-  - [Generating Credentials](#generating-credentials)
+  - [Gem Credentials](#gem-credentials)
 - [Promotion](#promotion)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -43,7 +42,6 @@ A command line interface for smithing new Ruby gems.
 - Builds a gem skeleton with enhanced Bundler functionality.
 - Uses [Milestoner](https://github.com/bkuhlmann/milestoner) for consistent project/gem versioning.
 - Uses [Tocer](https://github.com/bkuhlmann/tocer) for README table of contents generation.
-- Uses common settings and a structured layout for building new gems.
 - Supports [Thor](https://github.com/erikhuda/thor).
 - Supports [Ruby on Rails](http://rubyonrails.org).
 - Supports [Pry](http://pryrepl.org).
@@ -55,10 +53,12 @@ A command line interface for smithing new Ruby gems.
 - Supports [Gemnasium](https://gemnasium.com).
 - Supports [Travis CI](https://travis-ci.org).
 - Supports [Patreon](https://www.patreon.com).
-- Adds commonly needed [README](README.md), [CHANGELOG](CHANGELOG.md), [CONTRIBUTING](CONTRIBUTING.md),
+- Supports common settings and a structured layout for building new gems.
+- Supports publishing to public or private gem servers.
+- Provides commonly needed [README](README.md), [CHANGELOG](CHANGELOG.md), [CONTRIBUTING](CONTRIBUTING.md),
   [CODE OF CONDUCT](CODE_OF_CONDUCT.md), [LICENSE](LICENSE.md), etc. documentation.
-- Provides the ability to open the source code of any gem within your favorite editor.
-- Provides the ability to read the documentation of any gem within your default browser.
+- Provides the ability to view source code of any gem within your favorite editor.
+- Provides the ability to view the documentation of any gem within your default browser.
 
 # Screencasts
 
@@ -295,46 +295,21 @@ following:
   credentials are not used within your gemspec.
 - `allowed_push_host`: Provides the URL of the private gem server to push your gem to.
 
-## RubyGems Credentials
+## Gem Credentials
 
-The "example_key" defined within the gem specification, mentioned above, *must* be defined withing your
-`~/.gem/credentials` file and should look like this:
-
-    ---
-    :example_key: "Basic dXNlcjpwYXNzd29yZA=="
-
-The "example_key" *must* be a symbol (hence the double colons) due to RubyGems requirements.
-
-## Generating Credentials
-
-RubyGems uses an `Authorization` HTTP header when pushing a gem to a remote server. This can be an API key, HTTP Basic
-Auth, etc. When pushing a gem to RubyGems, you'll want to use the API key associated with your account. If that is the
-case, you're credentials would contain the following:
+With your gem specification metadata established, you are ready to publish your gem to a public or private server. If
+this is your first time publishing a gem and no gem credentials have been configured, you'll be prompted for them. This
+gem will ask you for your login and password during gem publish. Gem credentials will are stored in the
+`~/.gem/credentials` file as defined by RubyGems. *This will only happen once.* Afterwards, future gem publishing will
+your stored credentials instead. Multiple credentials can be stored in the `~/.gem/credentials` file. Example:
 
     ---
     :rubygems_api_key: 2a0b460650e67d9b85a60e183defa376
-
-For a server that might use HTTP Basic auth, you can generate the key value by launching IRB and running the following:
-
-    require "net/http"
-    Net::HTTP::Get.new("http://gems.example.com").basic_auth "user", "password"
-
-The URL is arbitrary but the user and password should be your account credentials. The output, from running the code
-above, should look like the following:
-
-    ["Basic dXNlcjpwYXNzd29yZA=="]
-
-You can then add this value to your credentials file like so:
-
-    ---
     :example_key: "Basic dXNlcjpwYXNzd29yZA=="
 
-You can add multiple accounts to your RubyGems credentials (there is no limit to the number of accounts you might need
-to have access to). Example:
-
-    ---
-    :rubygems_api_key: 2a0b460650e67d9b85a60e183defa376
-    :example_key: "Basic dXNlcjpwYXNzd29yZA=="
+Should you need delete a credential (due to a bad login/password for example), you can open the `~/.gem/credentials` in
+your default editor and remove the line(s) you don't need. Upon next publish of your gem, this gem will prompt you for
+new credentials.
 
 # Promotion
 

data/lib/gemsmith/aids/gem_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Gemsmith
+  module Aids
+    # A Gem::Specification with additional enhancements.
+    class GemSpec
+      def self.specification
+        ::Gem::Specification
+      end
+
+      def self.default_gem_host
+        ::Gem::DEFAULT_HOST
+      end
+
+      def self.editor
+        ENV.fetch "EDITOR"
+      end
+
+      def self.find name, version
+        specification.find_by_name name, version
+      end
+
+      def self.find_all name
+        specification.find_all_by_name name
+      end
+
+      def initialize file_path, shell: Open3
+        @file_path = file_path
+        @shell = shell
+        @spec = self.class.specification.load file_path
+        validate
+      end
+
+      def homepage_url
+        String spec.homepage
+      end
+
+      def allowed_push_key
+        spec.metadata.fetch("allowed_push_key") { "rubygems_api_key" }
+      end
+
+      def allowed_push_host
+        spec.metadata.fetch("allowed_push_host") { self.class.default_gem_host }
+      end
+
+      def open_gem
+        shell.capture2 self.class.editor, spec.full_gem_path
+        String spec.full_gem_path
+      end
+
+      def open_homepage
+        shell.capture2 "open", homepage_url
+        homepage_url
+      end
+
+      def version_number
+        spec.version.version
+      end
+
+      def version_label
+        "v#{version_number}"
+      end
+
+      def package_file_name
+        "#{spec.name}-#{version_number}.gem"
+      end
+
+      private
+
+      attr_reader :file_path, :spec, :shell
+
+      def validate
+        unless spec.is_a?(self.class.specification)
+          fail(Errors::Specification, %(Unknown gem specification: "#{file_path}".))
+        end
+      end
+    end
+  end
+end

data/lib/gemsmith/authenticators/basic.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module Gemsmith
+  module Authenticators
+    # An authenticator for retrieving HTTP Basic authorization.
+    class Basic
+      def self.url
+        ""
+      end
+
+      def initialize login, password, encrypter: Net::HTTP::Get.new("https://ignore.example.com")
+        @login = login
+        @password = password
+        @encrypter = encrypter
+      end
+
+      def authorization
+        encrypter.basic_auth(login, password).first
+      end
+
+      private
+
+      attr_reader :login, :password, :encrypter
+    end
+  end
+end

data/lib/gemsmith/authenticators/ruby_gems.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module Gemsmith
+  module Authenticators
+    # An authenticator for retrieving RubyGems authorization.
+    class RubyGems
+      def self.url
+        "https://rubygems.org/api/v1/api_key"
+      end
+
+      def initialize login, password
+        @login = login
+        @password = password
+        @uri = URI.parse self.class.url
+        configure_client
+      end
+
+      def authorization
+        request = Net::HTTP::Get.new uri.request_uri
+        request.basic_auth login, password
+        response = client.request request
+        String response.body
+      end
+
+      private
+
+      attr_reader :login, :password, :uri, :client
+
+      def configure_client
+        @client = Net::HTTP.new uri.host, uri.port
+        @client.use_ssl = true
+        @client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+  end
+end

data/lib/gemsmith/cli.rb

@@ -5,8 +5,11 @@ require "thor"
 require "thor/actions"
 require "thor_plus/actions"
 require "gemsmith/aids/gem"
+require "gemsmith/aids/gem_spec"
 require "gemsmith/aids/git"
 require "gemsmith/aids/spec"
+require "gemsmith/errors/base"
+require "gemsmith/errors/specification"
 require "gemsmith/skeletons/base_skeleton"
 require "gemsmith/skeletons/bundler_skeleton"
 require "gemsmith/skeletons/cli_skeleton"
@@ -62,7 +65,7 @@ module Gemsmith
     def initialize args = [], options = {}, config = {}
       super args, options, config
       @configuration = Configuration.new
-      @spec_aid = Aids::Spec.new
+      @gem_spec = Aids::GemSpec
     end
 
     desc "-c, [--create=CREATE]", "Create new gem."
@@ -93,14 +96,14 @@ module Gemsmith
     desc "-o, [--open=OPEN]", "Open a gem in default editor."
     map %w(-o --open) => :open
     def open name
-      result = process_gem name, "open"
+      result = process_gem name, "open_gem"
       info("Opening: #{result}") unless result.nil? || result.empty?
     end
 
     desc "-r, [--read=READ]", "Open a gem in default browser."
     map %w(-r --read) => :read
     def read name
-      result = process_gem name, "read"
+      result = process_gem name, "open_homepage"
 
       if result.nil? || result.empty?
         error "Gem home page is not defined."
@@ -113,7 +116,7 @@ module Gemsmith
     map %w(-e --edit) => :edit
     def edit
       info "Editing: #{configuration.file_path}..."
-      `#{spec_aid.editor} #{configuration.file_path}`
+      `#{gem_spec.editor} #{configuration.file_path}`
     end
 
     desc "-v, [--version]", "Show #{Gemsmith::Identity.label} version."
@@ -130,7 +133,7 @@ module Gemsmith
 
     private
 
-    attr_reader :configuration, :spec_aid
+    attr_reader :configuration, :gem_spec
 
     def setup_configuration name, options
       gem = Aids::Gem.new name

data/lib/gemsmith/cli_helpers.rb

@@ -28,21 +28,26 @@ module Gemsmith
       return if answer == "q"
 
       if (1..gems.size).cover?(answer.to_i)
-        spec_aid.find name, gems[answer.to_i - 1].version.version
+        gem_spec.find name, gems[answer.to_i - 1].version.version
       else
         error "Invalid option: #{answer}"
       end
     end
 
+    def open_gem specification, method
+      spec = gem_spec.new specification.spec_file
+      spec.public_send method
+    end
+
     def process_gem name, method
-      specs = spec_aid.find_all name
+      specs = gem_spec.find_all name
 
       case
         when specs.size == 1
-          spec_aid.public_send method, specs.first
+          open_gem specs.first, method
         when specs.size > 1
           print_gems specs
-          spec_aid.public_send method, pick_gem(specs, name)
+          open_gem pick_gem(specs, name), method
         else
           error("Unable to find gem: #{name}.") && ""
       end

data/lib/gemsmith/credentials.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
+require "gemsmith/authenticators/ruby_gems"
+require "gemsmith/authenticators/basic"
+
+module Gemsmith
+  # Configures gem credentials for RubyGems and/or alternative servers.
+  class Credentials
+    attr_reader :key, :url
+
+    def self.default_key
+      :rubygems_api_key
+    end
+
+    def self.default_url
+      "https://rubygems.org"
+    end
+
+    def self.file_path
+      File.join ENV.fetch("HOME"), ".gem", "credentials"
+    end
+
+    def self.authenticators
+      [Authenticators::RubyGems, Authenticators::Basic]
+    end
+
+    def initialize key: self.class.default_key, url: self.class.default_url, shell: Bundler::UI::Shell.new
+      @key = key
+      @url = url
+      @shell = shell
+      @credentials = load_credentials
+    end
+
+    def authenticator
+      selected = self.class.authenticators.detect { |auth| auth.url.include? url }
+      selected ? selected : Authenticators::Basic
+    end
+
+    def value
+      String credentials[key]
+    end
+
+    def valid?
+      credentials? && !String(credentials[key]).empty?
+    end
+
+    def create
+      return if valid?
+
+      login = shell.ask %(What is your "#{url}" login?)
+      password = shell.ask %(What is your "#{url}" password?)
+      new_credentials = credentials.merge key => authenticator.new(login, password).authorization
+
+      FileUtils.mkdir_p File.dirname self.class.file_path
+      File.open(self.class.file_path, "w") { |file| file << YAML.dump(new_credentials) }
+      FileUtils.chmod(0600, self.class.file_path)
+    end
+
+    private
+
+    attr_reader :credentials, :shell
+
+    def credentials?
+      File.exist? self.class.file_path
+    end
+
+    def load_credentials
+      Hash YAML.load_file(self.class.file_path)
+    rescue
+      {}
+    end
+  end
+end

data/lib/gemsmith/errors/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Errors
+    # The base error class for all gem related errors.
+    class Base < StandardError
+    end
+  end
+end

data/lib/gemsmith/errors/specification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Errors
+    # The error class for gem specification errors.
+    class Specification < Base
+    end
+  end
+end

data/lib/gemsmith/identity.rb

@@ -12,7 +12,7 @@ module Gemsmith
     end
 
     def self.version
-      "7.3.0"
+      "7.4.0"
     end
 
     def self.version_label

data/lib/gemsmith/rake/release.rb

@@ -1,64 +1,40 @@
 # frozen_string_literal: true
 
 require "milestoner"
+require "gemsmith/credentials"
 
 module Gemsmith
   module Rake
     # Provides gem release functionality. Meant to be wrapped in Rake tasks.
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/ParameterLists
     class Release
-      def self.default_gem_host
-        Gem::DEFAULT_HOST
+      def self.gem_spec_path
+        String Dir["#{Dir.pwd}/*.gemspec"].first
       end
 
-      def initialize gem_spec_path = Dir.glob("#{Dir.pwd}/*.gemspec").first,
-                     gem_config: Gem::ConfigFile.new([]),
-                     bundler: Bundler,
+      def initialize gem_spec: Gemsmith::Aids::GemSpec.new(self.class.gem_spec_path),
+                     credentials: Gemsmith::Credentials,
                      publisher: Milestoner::Publisher.new,
                      shell: Bundler::UI::Shell.new,
                      kernel: Kernel
 
-        @gem_spec_path = gem_spec_path
-        @gem_config = gem_config
+        @gem_spec = gem_spec
+        @credentials = credentials
         @publisher = publisher
         @shell = shell
         @kernel = kernel
-        @gem_spec = bundler.load_gemspec gem_spec_path.to_s
-      rescue Errno::ENOENT
-        @shell.error "Invalid gemspec file path: #{@gem_spec_path}."
-      end
-
-      def version_number
-        gem_spec.version.version
-      end
-
-      def version_label
-        "v#{version_number}"
-      end
-
-      def gem_file_name
-        "#{gem_spec.name}-#{version_number}.gem"
-      end
-
-      def allowed_push_key
-        gem_spec.metadata.fetch("allowed_push_key") { "rubygems_api_key" }
-      end
-
-      def allowed_push_host
-        gem_spec.metadata.fetch("allowed_push_host") { self.class.default_gem_host }
       end
 
       def push
-        return false unless gem_credentials? && gem_credential_value?
+        creds = credentials.new key: gem_spec.allowed_push_key.to_sym, url: gem_spec.allowed_push_host
+        creds.create
 
-        kernel.system %(gem push "pkg/#{gem_file_name}" --key "#{translated_api_key}" --host "#{allowed_push_host}")
-        shell.confirm "Pushed #{gem_file_name} to #{allowed_push_host}."
-        true
+        options = %(--key "#{translate_key creds.key}" --host "#{gem_spec.allowed_push_host}")
+        status = kernel.system %(gem push "pkg/#{gem_spec.package_file_name}" #{options})
+        process_push status
       end
 
       def publish sign: true
-        publisher.publish version_number, sign: sign
+        publisher.publish gem_spec.version_number, sign: sign
         push
       rescue Milestoner::Errors::Base => error
         shell.error error.message
@@ -66,25 +42,21 @@ module Gemsmith
 
       private
 
-      attr_reader :gem_spec_path, :gem_config, :gem_spec, :publisher, :shell, :kernel
-
-      def gem_credentials?
-        return true if File.exist?(gem_config.credentials_path)
-        shell.error "Unable to load gem credentials: #{gem_config.credentials_path}."
-        false
-      end
+      attr_reader :gem_spec, :credentials, :publisher, :shell, :kernel
 
-      def translated_api_key
-        return :rubygems if allowed_push_key == "rubygems_api_key"
-        allowed_push_key.to_sym
+      def translate_key key
+        key == credentials.default_key ? :rubygems : key
       end
 
-      def gem_credential_value?
-        value = gem_config.api_keys[translated_api_key]
-        return true unless value.nil? || value.empty?
+      def process_push status
+        if status
+          shell.confirm "Pushed #{gem_spec.package_file_name} to #{gem_spec.allowed_push_host}."
+        else
+          shell.error "Failed pushing #{gem_spec.package_file_name} to #{gem_spec.allowed_push_host}. " \
+                      "Check gemspec and gem credential settings."
+        end
 
-        shell.error %(Invalid credential (#{gem_config.credentials_path}): :#{allowed_push_key}: "#{value}".)
-        false
+        status
       end
     end
   end

data/lib/gemsmith/rake/tasks.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "gemsmith/aids/gem_spec"
+require "gemsmith/errors/base"
+require "gemsmith/errors/specification"
 require "gemsmith/rake/build"
 require "gemsmith/rake/release"
 
@@ -15,6 +18,7 @@ module Gemsmith
       end
 
       def initialize
+        @gem_spec = Gemsmith::Aids::GemSpec.new Dir.glob("#{Dir.pwd}/*.gemspec").first
         @build = Gemsmith::Rake::Build.new
         @release = Gemsmith::Rake::Release.new
       end
@@ -37,12 +41,12 @@ module Gemsmith
           build.validate
         end
 
-        desc "Build, tag #{release.version_label} (unsigned), and push #{release.gem_file_name} to RubyGems"
+        desc "Build, tag #{gem_spec.version_label} (unsigned), and push #{gem_spec.package_file_name} to RubyGems"
         task release: :build do
           release.publish sign: false
         end
 
-        desc "Build, tag #{release.version_label} (signed), and push #{release.gem_file_name} to RubyGems"
+        desc "Build, tag #{gem_spec.version_label} (signed), and push #{gem_spec.package_file_name} to RubyGems"
         task publish: :build do
           release.publish
         end
@@ -50,7 +54,7 @@ module Gemsmith
 
       private
 
-      attr_reader :build, :release
+      attr_reader :gem_spec, :build, :release
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -327,11 +327,17 @@ files:
 - bin/gemsmith
 - lib/gemsmith.rb
 - lib/gemsmith/aids/gem.rb
+- lib/gemsmith/aids/gem_spec.rb
 - lib/gemsmith/aids/git.rb
 - lib/gemsmith/aids/spec.rb
+- lib/gemsmith/authenticators/basic.rb
+- lib/gemsmith/authenticators/ruby_gems.rb
 - lib/gemsmith/cli.rb
 - lib/gemsmith/cli_helpers.rb
 - lib/gemsmith/configuration.rb
+- lib/gemsmith/credentials.rb
+- lib/gemsmith/errors/base.rb
+- lib/gemsmith/errors/specification.rb
 - lib/gemsmith/identity.rb
 - lib/gemsmith/rake/build.rb
 - lib/gemsmith/rake/release.rb