chandler 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec007e148274235db641d253dd9fa9fe1acbb945
-  data.tar.gz: 1f28e083665578567a9dd64f53034011ab894b2c
+  metadata.gz: 8ca571dcd740acdf7ea4863eb43a0de361344213
+  data.tar.gz: cce37a9c6b223a77c740f913eed635feb0d47b2d
 SHA512:
-  metadata.gz: ac6bbf38b10b06cd5ee908b41fe69f1561729dd235bb9a44a8b97cec9e06ac8aaaecd848e4c26d39d5fb4b6e8327d4985f84b46c034587d34da442bf6f53c162
-  data.tar.gz: 684fbf5edf1686d1b258c9b10d6a86f5dc1d66ed68f5dfcc55bb035d9133cd85e9ba86c00a93bc956b155c9c55c4bc5b012d14c10394ae57eb2ea9b77af04cdb
+  metadata.gz: 730d4f1e2e19824164be7a03dc91e32676dbec33f2968cb24de5fb47ea0575bfe1dae43ae9cbaefd29e1ffea1e4e025ae28274c695896daff2608e4c314be049
+  data.tar.gz: 547e330cff56d6fe05a07e70f9c0133ff9e73f2825ca34771821b92717bc68386a66ef5d0da5d3ce8b1288c6543d12dd8d1ed7c0d4dcb47d916731e330d6295d

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.1
+  DisplayCopNames: true
+  DisplayStyleGuide: true
   Exclude:
     - "*.gemspec"
 
@@ -15,6 +17,9 @@ Metrics/ClassLength:
   Exclude:
     - "test/**/*"
 
+Performance/Casecmp:
+  Enabled: false
+
 Style/BarePercentLiterals:
   EnforcedStyle: percent_q
 

data/.travis.yml

@@ -2,5 +2,10 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
-  - 2.3.0
-before_install: gem install bundler -v 1.10.4
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1
+matrix:
+  include:
+    # Run Danger only once, on 2.3.1
+    - rvm: 2.3.1
+      before_script: bundle exec danger

data/CHANGELOG.md

@@ -8,6 +8,10 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 
 * Your contribution here!
 
+## [0.6.0][] (2016-11-09)
+
+* [#19](https://github.com/mattbrictson/chandler/pull/19): Add GitHub Enterprise support - [@mattbrictson](https://github.com/mattbrictson)
+
 ## [0.5.0][] (2016-10-07)
 
 * Adds support for using `CHANDLER_GITHUB_API_TOKEN` to authenticate your API requests - Orta
@@ -46,7 +50,8 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/mattbrictson/chandler/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/mattbrictson/chandler/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/mattbrictson/chandler/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/mattbrictson/chandler/compare/v0.3.0...v0.3.1

data/Dangerfile

@@ -0,0 +1,54 @@
+# Adapted from https://github.com/ruby-grape/danger/blob/master/Dangerfile
+# Q: What is a Dangerfile, anyway? A: See http://danger.systems/
+
+# ------------------------------------------------------------------------------
+# Additional pull request data
+# ------------------------------------------------------------------------------
+project_name = github.pr_json["base"]["repo"]["name"]
+pr_number = github.pr_json["number"]
+pr_url = github.pr_json["_links"]["html"]["href"]
+
+# ------------------------------------------------------------------------------
+# What changed?
+# ------------------------------------------------------------------------------
+has_lib_changes = !git.modified_files.grep(/^lib/).empty?
+has_test_changes = !git.modified_files.grep(/^test/).empty?
+has_changelog_changes = git.modified_files.include?("CHANGELOG.md")
+
+# ------------------------------------------------------------------------------
+# You've made changes to lib, but didn't write any tests?
+# ------------------------------------------------------------------------------
+if has_lib_changes && !has_test_changes
+  warn("There are code changes, but no corresponding tests. "\
+       "Please include tests if this PR introduces any modifications in "\
+       "#{project_name}'s behavior.",
+       :sticky => false)
+end
+
+# ------------------------------------------------------------------------------
+# Have you updated CHANGELOG.md?
+# ------------------------------------------------------------------------------
+if !has_changelog_changes && has_lib_changes
+  markdown <<-MARKDOWN
+Here's an example of a CHANGELOG.md entry (place it immediately under the `* Your contribution here!` line):
+
+```markdown
+* [##{pr_number}](#{pr_url}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author})
+```
+MARKDOWN
+  warn("Please update CHANGELOG.md with a description of your changes. "\
+       "If this PR is not a user-facing change (e.g. just refactoring), "\
+       "you can disregard this.", :sticky => false)
+end
+
+# ------------------------------------------------------------------------------
+# Did you remove the CHANGELOG's "Your contribution here!" line?
+# ------------------------------------------------------------------------------
+if has_changelog_changes
+  unless IO.read("CHANGELOG.md") =~ /^\* Your contribution here/i
+    fail(
+      "Please put the `* Your contribution here!` line back into CHANGELOG.md.",
+      :sticky => false
+    )
+  end
+end

data/README.md

@@ -38,7 +38,7 @@ gem install chandler
 
 ### 2. Configure .netrc or set ENV vars
 
-In order to access the GitHub API on your behalf, you must provide chandler with your GitHub credentials. 
+In order to access the GitHub API on your behalf, you must provide chandler with your GitHub credentials.
 
 Do this by creating a `~/.netrc` file with your GitHub username and password, like this:
 
@@ -80,6 +80,21 @@ Other command-line options:
 * `--changelog=History.md` – location of the CHANGELOG (defaults to `CHANGELOG.md`)
 * `--tag-prefix=myapp-` – specify Git version tags are in the format `myapp-1.0.0` instead of `1.0.0`
 
+## GitHub Enterprise
+
+Chandler supports GitHub Enterprise as well as public GitHub repositories. It will make an educated guess as to where your GitHub Enterprise installation is located based on the `origin` git remote. You can also specify your GitHub Enterprise repository using the `--github` option like this:
+
+```
+--github=git@github.mycompany.com:organization/project.git
+```
+
+Or like this:
+
+```
+--github=https://github.mycompany.com/organization/project
+```
+
+To authenticate, Chandler relies on your `~/.netrc`, as explained above. Replace `api.github.com` with the hostname of your GitHub Enterprise installation (`github.mycompany.com` in the example).
 
 ## Rakefile integration
 

data/chandler.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "danger"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"

data/lib/chandler/cli/parser.rb

@@ -30,7 +30,10 @@ module Chandler
         @args = unprocessed.compact
       end
 
-      def option_parser # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/BlockLength
+      def option_parser
         OptionParser.new do |opts|
           opts.banner = "Usage: chandler push [tag] [options]"
           opts.separator("")

data/lib/chandler/configuration.rb

@@ -23,23 +23,6 @@ module Chandler
       @git ||= Chandler::Git.new(:path => git_path, :tag_mapper => tag_mapper)
     end
 
-    def octokit
-      @octokit ||= Octokit::Client.new(octokit_options)
-    end
-
-    def octokit_options
-      chandler_token_key = "CHANDLER_GITHUB_API_TOKEN"
-      if environment[chandler_token_key]
-        { :access_token => environment[chandler_token_key] }
-      else
-        { :netrc => true }
-      end
-    end
-
-    def environment
-      @environment ||= ENV
-    end
-
     def github
       @github ||= Chandler::GitHub.new(
         :repository => github_repository,

data/lib/chandler/github.rb

@@ -1,4 +1,6 @@
-require "octokit"
+require "chandler/github/client"
+require "chandler/github/errors"
+require "chandler/github/remote"
 
 module Chandler
   # A facade for performing GitHub API operations on a given GitHub repository
@@ -7,12 +9,11 @@ module Chandler
   # is available in the host environment at "CHANDLER_GITHUB_API_TOKEN""
   #
   class GitHub
-    MissingCredentials = Class.new(StandardError)
-
     attr_reader :repository, :config
 
     def initialize(repository:, config:)
-      @repository = parse_repository(repository)
+      @repository = repository
+      @remote = Remote.parse(repository)
       @config = config
     end
 
@@ -23,16 +24,16 @@ module Chandler
       return update_release(release, title, description) if release
 
       create_release(tag, title, description)
+    rescue Octokit::NotFound
+      raise InvalidRepository, repository
     end
 
     private
 
-    def parse_repository(repo)
-      repo[%r{(git@github.com:|://github.com/)(.*)\.git}, 2] || repo
-    end
+    attr_reader :remote
 
     def existing_release(tag)
-      release = client.release_for_tag(repository, tag)
+      release = client.release_for_tag(remote.repository, tag)
       release.id.nil? ? nil : release
     rescue Octokit::NotFound
       nil
@@ -48,21 +49,13 @@ module Chandler
     end
 
     def create_release(tag, title, desc)
-      client.create_release(repository, tag, :name => title, :body => desc)
+      client.create_release(
+        remote.repository, tag, :name => title, :body => desc
+      )
     end
 
     def client
-      @client ||= begin
-        octokit = config.octokit
-        octokit.login ? octokit : fail_missing_credentials
-      end
-    end
-
-    def fail_missing_credentials
-      message = "Couldn’t load GitHub credentials from ~/.netrc.\n"
-      message << "For .netrc instructions, see: "
-      message << "https://github.com/octokit/octokit.rb#using-a-netrc-file"
-      raise MissingCredentials, message
+      @client ||= Client.new(:host => remote.host).tap(&:login!)
     end
   end
 end

data/lib/chandler/github/client.rb

@@ -0,0 +1,42 @@
+require "chandler/github/errors"
+require "delegate"
+require "octokit"
+require "uri"
+
+module Chandler
+  class GitHub
+    # A thin wrapper around Octokit::Client that adds support for automatic
+    # GitHub Enterprise, .netrc, and ENV token-based authentication.
+    #
+    class Client < SimpleDelegator
+      def initialize(host: "github.com",
+                     environment: ENV,
+                     octokit_client: Octokit::Client)
+        options = {}
+        options.merge!(detect_auth_option(environment))
+        options.merge!(detect_enterprise_endpoint(host))
+        super(octokit_client.new(options))
+      end
+
+      def login!
+        return if login
+        raise netrc ? NetrcAuthenticationFailure : TokenAuthenticationFailure
+      end
+
+      private
+
+      def detect_auth_option(env)
+        if (token = env["CHANDLER_GITHUB_API_TOKEN"])
+          { :access_token => token }
+        else
+          { :netrc => true }
+        end
+      end
+
+      def detect_enterprise_endpoint(host)
+        return {} if host.downcase == "github.com"
+        { :api_endpoint => "https://#{host}/api/v3/" }
+      end
+    end
+  end
+end

data/lib/chandler/github/errors.rb

@@ -0,0 +1,34 @@
+module Chandler
+  class GitHub
+    Error = Class.new(StandardError)
+
+    class InvalidRepository < Error
+      def initialize(repository)
+        @repository = repository
+      end
+
+      def message
+        "Failed to find GitHub repository: #{@repository}.\n"\
+        "Verify you have permission to access it. Use the --github option to "\
+        "specify a different repository."
+      end
+    end
+
+    class NetrcAuthenticationFailure < Error
+      def message
+        "GitHub authentication failed.\n"\
+        "Check that ~/.netrc is properly configured.\n"\
+        "For instructions, see: "\
+        "https://github.com/octokit/octokit.rb#using-a-netrc-file"
+      end
+    end
+
+    class TokenAuthenticationFailure < Error
+      def message
+        "GitHub authentication failed.\n"\
+        "Check that the CHANDLER_GITHUB_API_TOKEN environment variable "\
+        "is correct."
+      end
+    end
+  end
+end

data/lib/chandler/github/remote.rb

@@ -0,0 +1,37 @@
+require "uri"
+
+module Chandler
+  class GitHub
+    # Assuming a git remote points to a public GitHub or a GitHub Enterprise
+    # repository, this class parses the remote to obtain the host and repository
+    # path. Supports SSH and HTTPS style git remotes.
+    #
+    # This class also handles parsing values passed into the `--github` command
+    # line option, which may be a public GitHub repository name, like
+    # "mattbrictson/chandler".
+    #
+    class Remote
+      def self.parse(url)
+        if (match = url.match(/@([^:]+):(.+)$/))
+          new(match[1], match[2])
+        else
+          parsed_uri = URI(url)
+          host = parsed_uri.host || "github.com"
+          path = parsed_uri.path.sub(%r{^/+}, "")
+          new(host, path)
+        end
+      end
+
+      attr_reader :host, :path
+
+      def initialize(host, path)
+        @host = host.downcase
+        @path = path
+      end
+
+      def repository
+        path.sub(/\.git$/, "")
+      end
+    end
+  end
+end

data/lib/chandler/tasks.rb

@@ -2,6 +2,7 @@ require "bundler/gem_helper"
 require "chandler/configuration"
 require "chandler/refinements/version_format"
 require "chandler/commands/push"
+require "rake"
 
 using Chandler::Refinements::VersionFormat
 

data/lib/chandler/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Chandler
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chandler
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -168,6 +183,9 @@ files:
 - lib/chandler/configuration.rb
 - lib/chandler/git.rb
 - lib/chandler/github.rb
+- lib/chandler/github/client.rb
+- lib/chandler/github/errors.rb
+- lib/chandler/github/remote.rb
 - lib/chandler/logger.rb
 - lib/chandler/logging.rb
 - lib/chandler/refinements/color.rb
@@ -194,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Syncs CHANGELOG entries to GitHub's release notes