sanctify 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b197dcfe1ccb2d196897c1756a2955f2b8ba032a
-  data.tar.gz: 4dd3bf16fe6185ecd421de2afb7ae3402f878fc2
+  metadata.gz: bf59b1007b7caeecd87c0ddd8e7ba24f161d7b09
+  data.tar.gz: 1761816197a0ff15372dfa777494b1dad5e63189
 SHA512:
-  metadata.gz: 8a6f071b93e6ef42bcceb0c9f3339d37fc4845216836fd20ef31dfe3da234344395ea51a166062d19e2924e68f8fe4c60eeef423e222a73ff19da9252493d348
-  data.tar.gz: f0e366b4acd7b509a942af69c3b1b6364bfc376e6fbcbe47be6ba2ec2f3d62a8a4eb23ff62ea87a9a7d849df0cd60970278c70a362ff0baf29ba1cd10dba6210
+  metadata.gz: 78b2a2a600785a4937480755ab7a14b615a03e6e9509ad863ea537d44756ad88a9a704dac9a958aca826f4c7735f8a33ed19764e32b44cdff2f84e0700f16d4b
+  data.tar.gz: 21ed93a8d1c341bf2d8c673fc754e03939e0dabece00f42de0077efaa5bb134a103106f29971a1f22ddcb34b7ea059c66ab83c8080d1b6b42f7e28d7d17569fb

data/.pre-commit-hooks.yaml

@@ -3,3 +3,4 @@
     description: This hook scans for common secrets before commit
     entry: sanctify
     language: ruby
+    files: .

data/README.md

@@ -29,6 +29,7 @@ Usage: sanctify [-r REPO_PATH] [-c CONFIG_PATH] [-d FROM_COMMIT..TO_COMMIT | -d
     -r, --repo REPO                  Repo to test
     -c, --config CONFIG              Configuration file in YAML
     -d, --diff DIFF                  Specify a diff or commit from which to check secrets
+    -v, --version                    Prints the version and exits
     -h, --help                       Prints this help
 ```
 
@@ -37,7 +38,7 @@ To integrate with pre-commit, add the following to your `pre-commit-config.yaml`
 ```
 repos:
 -   repo: https://github.com/onetwopunch/sanctify
-    sha: v0.2.2
+    sha: v0.2.5
     hooks:
     -   id: sanctify
         args:
@@ -81,12 +82,51 @@ The list of current default matchers are located in  `lib/sanctify/matcher_list.
 
 If you see any problem with a default matcher list or would like to add another to the default list, please feel free to make a pull request.
 
+## Troubleshooting
+
+- If you are facing an issue with integration with a Rail project, where you are using rbenv, and get the following error:
+```
+An unexpected error has occurred: CalledProcessError: Command: (u'/bin/bash', u'/Users/ryan/.rbenv/shims/gem', 'build', 'sanctify.gemspec')
+Return code: 1
+Expected return code: 0
+Output: (none)
+Errors:
+    WARNING:  See http://guides.rubygems.org/specification-reference/ for help
+    ERROR:  While executing gem ... (Gem::InvalidSpecificationException)
+        ["travis.yml", "literally every file in your Rails repo", ...]
+```
+
+This is an issue with pre-commit since they build their own version of rbenv that conflicts under certain circumstances I have yet to fully grok. The best way to get around this is to install sanctify external to the pre-commit repo.
+
+In your pre-commit-config.yaml:
+
+```yaml
+-   repo: local
+    hooks:
+    -   id: secret-check-hook
+        name: "Sanctify Secret Scanner"
+        entry: ./bin/secret-check
+        language: script
+        files: .
+```
+
+And then in the `./bin/secret-check` file just install and run sanctify:
+
+```bash
+#!/bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+if [[ ! $(which sanctify) ]]; then
+  gem install sanctify
+fi
+
+sanctify -c $DIR/sanctify.yml
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/onetwopunch/sanctify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -97,4 +137,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Sanctify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sanctify/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Sanctify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/onetwopunch/sanctify/blob/master/CODE_OF_CONDUCT.md).

data/lib/sanctify/version.rb

@@ -1,3 +1,3 @@
 module Sanctify
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanctify
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ryan Canty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler