how_is 23.0.0 → 24.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7aa606b0958adefd623b3eb2e0fce083ec1b1950d67e84c4f359cb3a9407696
-  data.tar.gz: d98bf782f58102d3dfe440610a587e4be85a59e7710d5244992db29115592724
+  metadata.gz: 929a77a2520bd87d7067b5b9e0af99199d8d45f16056f105e3cdefc9da7475b5
+  data.tar.gz: d49f3e59bc73ea1b2edd90ca0524e1c38c0e619b29795e57005973652adf8b37
 SHA512:
-  metadata.gz: ca20afb8eeb3d12aa9e2569fde59c3a01986b482b5c25b94c77cc29da19a335d16326b0f151109c123a5b68ddea9dc13928f310bb1d24af5e136585508c14ad7
-  data.tar.gz: 2d4deb12aa5ff8fc583da3ea4cdd7d925b25f03c1cdce8faefb722b813d63e0b068218fe06ba30750840e3345ec0859ed49300045f9220b36c3986fd46b215a7
+  metadata.gz: 0c731eb03f270014a8b48bbeb5fa24b5cb1e5602ae700f58ba9ab72b47afee5a3fa645b9fb191717ceea5457610752510e9909c4c0feafc8383e6cedb52c56fe
+  data.tar.gz: b026dcd32d434658c9b4acfd7679d2971adbb0a72c1523198f98f8940afd9f47626f9d1b854f2670d2f7ebb458c03188494aacffce4d30676a5fead0088f975b

data/.travis.yml

@@ -2,3 +2,20 @@ language: ruby
 rvm:
   - 2.3.3
   - 2.4.1
+  - 2.5.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm:
+      - ruby-head
+
+# See https://bors.tech/documentation/getting-started/
+branches:
+  only:
+    # This is where pull requests from "bors r+" are built.
+    - staging
+    # This is where pull requests from "bors try" are built.
+    - trying
+    # Build pull requests.
+    - master

data/CHANGELOG.md

@@ -1,10 +1,26 @@
 # Change Log
 
+## [v24.0.0](https://github.com/how-is/how_is/tree/v24.0.0) (2018-03-17)
+[Full Changelog](https://github.com/how-is/how_is/compare/v23.0.0...v24.0.0)
+
+**Merged pull requests:**
+
+- Improve error output; update README. [\#224](https://github.com/how-is/how_is/pull/224) ([duckinator](https://github.com/duckinator))
+- update .travis.yml. [\#223](https://github.com/how-is/how_is/pull/223) ([duckinator](https://github.com/duckinator))
+
+## [v23.0.0](https://github.com/how-is/how_is/tree/v23.0.0) (2018-01-19)
+[Full Changelog](https://github.com/how-is/how_is/compare/v22.0.0...v23.0.0)
+
+**Merged pull requests:**
+
+- Make config-based reports work again. [\#221](https://github.com/how-is/how_is/pull/221) ([duckinator](https://github.com/duckinator))
+
 ## [v22.0.0](https://github.com/how-is/how_is/tree/v22.0.0) (2018-01-19)
 [Full Changelog](https://github.com/how-is/how_is/compare/v21.0.0...v22.0.0)
 
 **Merged pull requests:**
 
+- Make CLI parser store the date when passed --config. [\#220](https://github.com/how-is/how_is/pull/220) ([duckinator](https://github.com/duckinator))
 - Update readme [\#219](https://github.com/how-is/how_is/pull/219) ([duckinator](https://github.com/duckinator))
 
 ## [v21.0.0](https://github.com/how-is/how_is/tree/v21.0.0) (2018-01-19)

data/README.md

@@ -16,6 +16,41 @@ If you want to contribute or discuss how_is, you can [join Bundler's slack](http
 
     $ gem install how_is
 
+## Configuration
+
+HowIs can hit the default API limits for GitHub for even small reports.
+
+To avoid errors due to hitting rate limits, HowIs requires a Personal
+Access Token, which GitHub provides with higher rate limits.
+
+### Acquiring A Personal Access Token
+
+To acquire a personal access token:
+
+1. Go to: https://github.com/settings/tokens/new
+2. For `Token description`, enter `how_is CLI client`.
+3. Scroll to the bottom of the page.
+4. Click `Generate token`. This will take you to a new page.
+5. Save the token somewhere. **You can't access it again.**
+
+**NOTE:** HowIs _only_ needs read access.
+
+#### Using The Token
+
+You now need to define the `HOWIS_GITHUB_TOKEN` and `HOWIS_BASIC_AUTH`
+variables.
+
+An example of how to do so for the Bash shell is provided below.
+
+Make sure to replaceall instances of `<TOKEN>` with the actual token,
+and `<USERNAME>` with your GitHub username.
+
+```bash
+export HOWIS_GITHUB_TOKEN=<TOKEN>
+export HOWIS_BASIC_AUTH="<USERNAME>:<TOKEN>"
+```
+
+
 ## Usage
 
 ### Command Line
@@ -27,7 +62,6 @@ or
 
     $ how_is REPOSITORY --config CONFIG_FILENAME
 
-
 #### Example \#1
 
     $ how_is rubygems/rubygems 2016-12-01 --output report-2016-12-01.html

data/Rakefile

@@ -16,6 +16,10 @@ task :generate_changelog do
   sh "github_changelog_generator"
 end
 
+task :future_changelog do
+  sh "github_changelog_generator --future-release v#{HowIs::VERSION}"
+end
+
 # Helper functions used later in the Rakefile.
 class HelperFunctions
   def self.freeze_time(&_block)

data/bors.toml

@@ -0,0 +1,8 @@
+status = [
+  "continuous-integration/travis-ci/push",
+  #"continuous-integration/appveyor/branch"
+]
+
+# Uncomment this to use a two hour timeout.
+# The default is one hour.
+#timeout_sec = 7200

data/how_is.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "okay", "~> 7.0.0"
 
+  spec.add_runtime_dependency "json"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.7"

data/lib/how_is/sources/github.rb

@@ -7,9 +7,24 @@ require "okay/graphql"
 
 module HowIs
   module Sources
+    # Contains configuration information for GitHub-based sources.
     class Github
-      BASIC_AUTH    = ENV["HOWIS_BASIC_AUTH"]
-      ACCESS_TOKEN  = ENV["HOWIS_GITHUB_TOKEN"]
+      # An exception which is only raised if an environment variable
+      # is undefined.
+      class ConfigurationError < StandardError
+        def initialize(env_variable)
+          super("environment variable #{env_variable} not defined." \
+                  " See README.md for details.")
+        end
+      end
+
+      # A GitHub Personal Access Token.
+      ACCESS_TOKEN = ENV["HOWIS_GITHUB_TOKEN"]
+      raise ConfigurationError, "HOWIS_GITHUB_TOKEN" if ACCESS_TOKEN.nil?
+
+      # "<github username>:<personal access token>"
+      BASIC_AUTH = ENV["HOWIS_BASIC_AUTH"]
+      raise ConfigurationError, "HOWIS_BASIC_AUTH" if BASIC_AUTH.nil?
 
       # Used for the the Authorization header when talking to the
       # GitHub API.

data/lib/how_is/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HowIs
-  VERSION = "23.0.0"
+  VERSION = "24.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 23.0.0
+  version: 24.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +218,7 @@ files:
 - bin/console
 - bin/prerelease-generate-changelog
 - bin/setup
+- bors.toml
 - design/01-functionality.md
 - design/02-implementation.md
 - exe/how_is
@@ -260,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.