filecop 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d03fa4509bea5b712d0dcfe3636e9f04e527b714
-  data.tar.gz: abbbd7649770fbe12a851c9ee45551db63b44564
+  metadata.gz: 10b25501425618f4192f3478fbc7c8f726220f50
+  data.tar.gz: d457ffe22015eaf5f946f8c463ac2bbeac39435f
 SHA512:
-  metadata.gz: cf273290780505684a3b4651b31d5d50baa0d69b4606231a3d2d85cdfba46db118fae8d03fcc5fa0b58b07b442a2618244192ada4c8b74abe4f2ca64a5218022
-  data.tar.gz: 07900113c8151e2c319b29b99a75bcd102c2f5ff551462482027196f2a761b9fbf05d5f8487023cec655cb0335f0bf9e2134cb9c30726bd06756486d761c14c1
+  metadata.gz: 6ba4e3c32d92863c92e4b67e567040782ca220ad5f7e1beaf83a5553b22bedb4797f219517f73819b665896ff892cac58dad5ebc4b4c2e0d8f880de7bc8b8a09
+  data.tar.gz: e36ed8895ae16120b3007570183e72af987b7520f0f1a76df926e4cddfc02bf164b3e0fad883581c2b9f7955002f2c9585a5410da932a689d072a5bdac86f227

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/filecop.svg)](https://badge.fury.io/rb/filecop)
+
 # Filecop
 
 Filecop is designed to find sensitive files in a provided list. Ideally this would be integrated into something like a git pre-commit hook or post commit check to reduce instances of leaked credentials.
@@ -22,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-Using filecop is easy, pass no arguments to check all files in the current directory:
+Using filecop is easy, pass no arguments to check all files in the current directory from the command line:
 
     $ filecop
 
@@ -52,6 +54,14 @@ Or pass the `--json` flag to get a machine parseable output
 ]
 ```
 
+You can also require filecop to use within a Ruby script like so:
+
+```
+require('filecop')
+filecop = Filecop::Runner(['private.key', '.bashrc'])
+result = filecop.run
+```
+
 ## 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.

data/lib/filecop.rb

@@ -1,63 +1,8 @@
 require "json"
 require "pathname"
 
-require "filecop/version"
-require "filecop/options"
-require "filecop/rule"
-
-module Filecop
-  class CLI
-
-    def run(args = ARGV)
-      @options, @paths = Options.parse!(args)
-      @paths = Dir.entries(".") if @paths.length==0
-
-      unless @options.json
-        puts "Checking #{@paths.length} files\n"
-      end
-
-      files = matching_files
-
-      if @options.json
-        puts JSON.generate files.map { |p| { file: p[:file], message: p[:rule].message } } 
-      else
-        if files.length>0
-          puts "\nIssues:\n\n"
-        end
-        puts files.map { |p| "#{p[:file]}: #{p[:rule].message}" } 
-        puts "\n"
-        puts "#{@paths.length} files checked, #{files.length} potential problems"
-      end
-
-      return files.length>0 ? 1 : 0
-    rescue StandardError, SyntaxError => e
-      $stderr.puts e.message
-      $stderr.puts e.backtrace
-      return 1
-    end
-
-    private
-
-    def matching_files
-      # load banned patterns from config file
-      patterns = JSON.parse File.read(File.join(File.dirname(__FILE__), 'patterns.json'))
-      rules = patterns.map { |o| Rule.new(o) }
-      output = []
-
-      @paths.each do |file|
-        rules.each do |rule|
-          if rule.matches?(file)
-            output << {
-              file: file,
-              rule: rule
-            }
-            break
-          end
-        end
-      end
-      
-      output
-    end
-    
-  end
-end
+require_relative "./filecop/runner"
+require_relative "./filecop/version"
+require_relative "./filecop/options"
+require_relative "./filecop/rule"
+require_relative "./filecop/cli"

data/lib/filecop/cli.rb

@@ -0,0 +1,31 @@
+module Filecop
+  class CLI
+
+    def run(args = ARGV)
+      @options, @paths = Options.parse!(args)
+      @paths = Dir.entries(".") if @paths.length==0
+      runner = Runner.new(@paths)
+
+      if @options.json
+        files = runner.run
+        puts JSON.generate files.map { |p| { file: p[:file], message: p[:rule].message } } 
+      else
+        puts "Checking #{@paths.length} files\n"
+        files = runner.run
+        
+        if files.length>0
+          puts "\nIssues:\n\n"
+        end
+        puts files.map { |p| "#{p[:file]}: #{p[:rule].message}" } 
+        puts "\n"
+        puts "#{@paths.length} files checked, #{files.length} potential problems"
+      end
+
+      return files.length>0 ? 1 : 0
+    rescue StandardError, SyntaxError => e
+      $stderr.puts e.message
+      $stderr.puts e.backtrace
+      return 1
+    end
+  end
+end

data/lib/filecop/runner.rb

@@ -0,0 +1,28 @@
+module Filecop
+  class Runner
+    def initialize(paths)
+      @paths = paths
+    end
+
+    def run
+      # load banned patterns from config file
+      patterns = JSON.parse File.read(File.join(File.dirname(__FILE__), '..', 'patterns.json'))
+      rules = patterns.map { |o| Rule.new(o) }
+      output = []
+
+      @paths.each do |file|
+        rules.each do |rule|
+          if rule.matches?(file)
+            output << {
+              file: file,
+              rule: rule
+            }
+            break
+          end
+        end
+      end
+      
+      output
+    end
+  end
+end

data/lib/filecop/version.rb

@@ -1,3 +1,3 @@
 module Filecop
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filecop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tom Moor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,8 +73,10 @@ files:
 - bin/setup
 - filecop.gemspec
 - lib/filecop.rb
+- lib/filecop/cli.rb
 - lib/filecop/options.rb
 - lib/filecop/rule.rb
+- lib/filecop/runner.rb
 - lib/filecop/version.rb
 - lib/patterns.json
 homepage: https://github.com/tommoor/filecop