chandler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7106a3817c6b804c4e46f9debbadf26fc3f30fc6
-  data.tar.gz: ec0e62704eb8867142e5bb81b082a92b66bab4ae
+  metadata.gz: ec007e148274235db641d253dd9fa9fe1acbb945
+  data.tar.gz: 1f28e083665578567a9dd64f53034011ab894b2c
 SHA512:
-  metadata.gz: ff409c22243a01e099e80bbba377b10a46e2cdb5f89252388de03f821ff3acf180b917ce6e35909e78a3c33ae2749ac8927d4d7d63fed3bc8ce22a10b902269f
-  data.tar.gz: b1d77ab60077e0c173090f979f35b4bf4af1dd1ab2fd4b0be137d67af10bb6247bcf3d8cb8aae1ad80f80c958dc7248ef88d4e10da085d79d2d3d8384b3de6ef
+  metadata.gz: ac6bbf38b10b06cd5ee908b41fe69f1561729dd235bb9a44a8b97cec9e06ac8aaaecd848e4c26d39d5fb4b6e8327d4985f84b46c034587d34da442bf6f53c162
+  data.tar.gz: 684fbf5edf1686d1b258c9b10d6a86f5dc1d66ed68f5dfcc55bb035d9133cd85e9ba86c00a93bc956b155c9c55c4bc5b012d14c10394ae57eb2ea9b77af04cdb

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.5.0][] (2016-10-07)
+
+* Adds support for using `CHANDLER_GITHUB_API_TOKEN` to authenticate your API requests - Orta
+
 ## [0.4.0][] (2016-09-23)
 
 * Support for reStructuredText `definition-list` style CHANGELOG layouts.
@@ -42,7 +46,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.4.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.5.0...HEAD
+[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
 [0.3.0]: https://github.com/mattbrictson/chandler/compare/v0.2.0...v0.3.0

data/Gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 gemspec
 
 # Optional development dependencies; requires bundler >= 1.10.
-# Note that these gems assume a Ruby 2.2 environment. Install them using:
+# Note that these gems assume a Ruby environment greater than 2.2.5.
+# Install them using:
 #
 # bundle install --with guard
 #

data/README.md

@@ -36,9 +36,11 @@ chandler takes the hassle out of maintaining these two separate formats: your CH
 gem install chandler
 ```
 
-### 2. Configure .netrc
+### 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. Do this by creating a `~/.netrc` file with your GitHub username and password, like this:
+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:
 
 ```
 machine api.github.com
@@ -46,6 +48,8 @@ machine api.github.com
   password c0d3b4ssssss!
 ```
 
+Or expose an ENV variable: `CHANDLER_GITHUB_API_TOKEN` inside your CI.
+
 For more security, you can use an OAuth access token in place of your password. [Here's how to generate one][access-token]. Make sure to enable `public_repo` scope for the token.
 
 

data/lib/chandler/configuration.rb

@@ -6,7 +6,7 @@ require "chandler/logger"
 module Chandler
   class Configuration
     attr_accessor :changelog_path, :git_path, :github_repository, :dry_run,
-                  :tag_prefix, :logger
+                  :tag_prefix, :logger, :environment
 
     def initialize
       @changelog_path = "CHANGELOG.md"
@@ -23,9 +23,28 @@ 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, :config => self)
+      @github ||= Chandler::GitHub.new(
+        :repository => github_repository,
+        :config => self
+      )
     end
 
     def changelog

data/lib/chandler/github.rb

@@ -2,8 +2,9 @@ require "octokit"
 
 module Chandler
   # A facade for performing GitHub API operations on a given GitHub repository
-  # (specified as a git URL or as `owner/repo` format). Requires that
-  # "~/.netrc" is properly configured with GitHub credentials.
+  # (specified as a git URL or as `owner/repo` format). Requires either that
+  # "~/.netrc" is properly configured with GitHub credentials or an auth token
+  # is available in the host environment at "CHANDLER_GITHUB_API_TOKEN""
   #
   class GitHub
     MissingCredentials = Class.new(StandardError)
@@ -52,7 +53,7 @@ module Chandler
 
     def client
       @client ||= begin
-        octokit = Octokit::Client.new(:netrc => true)
+        octokit = config.octokit
         octokit.login ? octokit : fail_missing_credentials
       end
     end

data/lib/chandler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chandler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Syncs CHANGELOG entries to GitHub's release notes