file_sentry 0.2.3 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -5
  3. data/config/environment.rb +1 -1
  4. data/lib/file_sentry/version.rb +1 -1
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '038280c3b1fdd9399c90743e646ac52e54beafd43b677ab42938e65070b413bd'
4
- data.tar.gz: 8f46245693744561fb4d4b982714d53159794ec877d600649aea93fd07d7f3a9
3
+ metadata.gz: d3bf7d25773053b1ae4842894ff4f13a3ed11eb5054519a068929370bcc4c8a2
4
+ data.tar.gz: 7cecacf8e10405f41653ea44bd922cb99be54a4fc21404d203ddfb0ffeee8268
5
5
  SHA512:
6
- metadata.gz: 73c2c3595bca680d7328ecb6e072a4ce98a1577f08ae55c4b285218cfd2fa82594e817f3a360a34fca72216ba4a43871495c03899061b689a6a32a24d372de25
7
- data.tar.gz: d5e43ac1738e73e4726866c0003eca21f1e1b29e152d48275eb5a9dc41017c3dfd98b874ab7d8a813560a2fdd17dd2bd8c9cfd22fa2571838a192b5de5b3810f
6
+ metadata.gz: d4ac7282895ca166e1244cfd1ceda951251118a7732c72ebfa03ca7d59712aba33d484b57178eefcd367677d54b1e4db538329f99b5e237474e0b1c1e1cdf057
7
+ data.tar.gz: bef1c4986147adba31fa8ebec5f0684459678b2319a3918d32b85dc011e98b0461551c53506a63ab4d0655171ed7499ebb68fcaa3f94af51a0d6ab358e935bf2
data/README.md CHANGED
@@ -7,7 +7,7 @@ It displays results from each engine as well as a brief summary. FileSentry is p
7
7
 
8
8
  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.
9
9
 
10
- 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).
10
+ 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).
11
11
 
12
12
  Only install Ruby and rbenv as specified in the 'Installing Ruby' section. Don't
13
13
  forget to run
@@ -23,7 +23,7 @@ To install the gem, enter the following in your terminal of choice:
23
23
  You can also clone this repo if you want to tweak FileSentry. Read the development section for more info if that floats your boat.
24
24
 
25
25
  ## Usage
26
- 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.
26
+ 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.
27
27
 
28
28
  After installation, to scan a file for malware enter the following command:
29
29
 
@@ -34,7 +34,11 @@ If this is your first time running the application, you will be prompted to ente
34
34
 
35
35
  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.
36
36
 
37
- The HASH_DIGEST argument is optional. If the gem is ran without the HASH_DIGEST argument, FileSentry will default to MD5.
37
+ 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.
38
+
39
+ An example command to scan a readme in the current working directory using SHA256 is as follows:
40
+
41
+ $ file_sentry readme.txt sha256
38
42
 
39
43
  You can change the API key at any time by running the gem without any command line arguments.
40
44
 
@@ -44,7 +48,7 @@ After checking out the repo, run `bin/setup` to install development dependencies
44
48
 
45
49
  ## Contributing
46
50
 
47
- 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.
51
+ 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.
48
52
 
49
53
  ## License
50
54
 
@@ -52,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
52
56
 
53
57
  ## Code of Conduct
54
58
 
55
- 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).
59
+ 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 CHANGED
@@ -9,4 +9,4 @@ require_relative '../lib/file_sentry/op_file'
9
9
  require 'digest'
10
10
  require 'colorize'
11
11
  require 'httparty'
12
- require 'pry'
12
+
data/lib/file_sentry/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module FileSentry
2
- VERSION = "0.2.3"
2
+ VERSION = "0.2.4"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: file_sentry
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.2.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Alexandra Wright