file_sentry 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '038280c3b1fdd9399c90743e646ac52e54beafd43b677ab42938e65070b413bd'
-  data.tar.gz: 8f46245693744561fb4d4b982714d53159794ec877d600649aea93fd07d7f3a9
+  metadata.gz: d3bf7d25773053b1ae4842894ff4f13a3ed11eb5054519a068929370bcc4c8a2
+  data.tar.gz: 7cecacf8e10405f41653ea44bd922cb99be54a4fc21404d203ddfb0ffeee8268
 SHA512:
-  metadata.gz: 73c2c3595bca680d7328ecb6e072a4ce98a1577f08ae55c4b285218cfd2fa82594e817f3a360a34fca72216ba4a43871495c03899061b689a6a32a24d372de25
-  data.tar.gz: d5e43ac1738e73e4726866c0003eca21f1e1b29e152d48275eb5a9dc41017c3dfd98b874ab7d8a813560a2fdd17dd2bd8c9cfd22fa2571838a192b5de5b3810f
+  metadata.gz: d4ac7282895ca166e1244cfd1ceda951251118a7732c72ebfa03ca7d59712aba33d484b57178eefcd367677d54b1e4db538329f99b5e237474e0b1c1e1cdf057
+  data.tar.gz: bef1c4986147adba31fa8ebec5f0684459678b2319a3918d32b85dc011e98b0461551c53506a63ab4d0655171ed7499ebb68fcaa3f94af51a0d6ab358e935bf2

data/README.md

@@ -7,7 +7,7 @@ It displays results from each engine as well as a brief summary. FileSentry is p
 
 First, make sure you have the latest version of Ruby installed. FileSentry was developed using Ruby 2.5.0, and might not work with older versions of Ruby.
 
-If you do not have Ruby installed, follow the instructions on this blog post to install rbenv and Ruby 2.5.0:[Setup Ruby On Rails on Ubuntu 16.04 Xenial Xerus](https://gorails.com/setup/ubuntu/16.04).
+If you do not have Ruby installed, follow the instructions on this blog post to install rbenv and Ruby 2.5.0: [Setup Ruby On Rails on Ubuntu 16.04 Xenial Xerus](https://gorails.com/setup/ubuntu/16.04).
 
 Only install Ruby and rbenv as specified in the 'Installing Ruby' section. Don't
 forget to run
@@ -23,7 +23,7 @@ To install the gem, enter the following in your terminal of choice:
 You can also clone this repo if you want to tweak FileSentry. Read the development section for more info if that floats your boat.
 
 ## Usage
-If you do not have an OPSWAT account/API key, visit [portal.opswat.com](portal.opswat.com) to sign up. After creating an account, the "home" tab will display your OPSWAT API Key.
+If you do not have an OPSWAT account/API key, visit [portal.opswat.com](https://portal.opswat.com/) to sign up. After creating an account, the "home" tab will display your OPSWAT API Key.
 
 After installation, to scan a file for malware enter the following command:
 
@@ -34,7 +34,11 @@ If this is your first time running the application, you will be prompted to ente
 
 The RELATIVE_PATH_TO_FILE argument loads the specified file into FileSentry, relative to the current working directory. To enter a file name with spaces, use quotation marks or escape whitespace with a backslash.
 
-The HASH_DIGEST argument is optional. If the gem is ran without the HASH_DIGEST argument, FileSentry will default to MD5.
+The HASH_DIGEST argument is optional. If the gem is ran without the HASH_DIGEST argument, FileSentry will default to MD5. Options are MD5, SHA256, and SHA1.
+
+An example command to scan a readme in the current working directory using SHA256 is as follows:
+    
+    $ file_sentry readme.txt sha256
 
 You can change the API key at any time by running the gem without any command line arguments.
 
@@ -44,7 +48,7 @@ After checking out the repo, run `bin/setup` to install development dependencies
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/<github username>/file_sentry. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/f3mshep/file_sentry. 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.
 
 ## License
 
@@ -52,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the FileSentry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<github username>/file_sentry/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the FileSentry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/f3mshep/file_sentry/blob/master/CODE_OF_CONDUCT.md).

data/config/environment.rb

@@ -9,4 +9,4 @@ require_relative '../lib/file_sentry/op_file'
 require 'digest'
 require 'colorize'
 require 'httparty'
-require 'pry'
+

data/lib/file_sentry/version.rb

@@ -1,3 +1,3 @@
 module FileSentry
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_sentry
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Alexandra Wright