clamby 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: adc57fe159207dd73de944b79537cfc443fd1dea
-  data.tar.gz: 23d0a824e8ea4d1a4c2f492a96cb4e9b29a27b66
+SHA256:
+  metadata.gz: e11cf21ff5f74654f10a44017053c0b883f382ab423e38c6fe0a46af9ce314ac
+  data.tar.gz: 233cc4ea434c05f575885336aebbba53884b019317d507855b0688179546d116
 SHA512:
-  metadata.gz: f08b205ae90fde3ec92e6fa0bbfd192bc6687feffe489421683cc8f964f09700a0be558c95ae66e66da943d14f6f09ee0236df1ca22639684fcf2762c9ef5a1b
-  data.tar.gz: 3f8af7ce3aa9716d593ee1cbd107fe2b86814ccf1741fe646ef98441353c074267b0009fe9f416cea0e7cd291ff086534c80bc384e3d36e2326a34ad6c5f14e2
+  metadata.gz: eee15a0059ebd4bf338cfda8ae30428ed0160b8bf14a2d10296bccccf41bb17bab07aea2f4de3ebd8bbb85664131fb050a5a8b64786be107c1d25c689867dab1
+  data.tar.gz: '092f0f57aee3984ab4085cf84960686cce96033095d41bd1c0ff61cb5b5ab7bafcaeec6d1563e1167b6641917d4bf95a3a80cc456553b7c36b3dbcdc1de211e6'

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.3.2
+ - [emilong](https://github.com/kobaltz/clamby/commits/master?author=emilong) added `stream` option
+ 
 # v1.3.1
  - [zealot128](https://github.com/kobaltz/clamby/commits/master?author=zealot128) added `silence_output` option
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at dave@k-innovations.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -74,6 +74,10 @@ Setting the `fdpass` configuration option to `true` will pass the `--fdpass` opt
 
 `--fdpass : Pass the file descriptor permissions to clamd. This is useful if clamd is running as a different user as it is faster than streaming the file to clamd. Only available if connected to clamd via local(unix) socket.`
 
+Setting the `stream` configuration option will stream the file to the daemon. This may be useful for forcing streaming as a test for local development. Only works when also specifying `daemonize`. From the clamdscan man page:
+
+`--stream : Forces file streaming to clamd. This is generally not needed as clamdscan detects automatically if streaming is required. This option only exists for debugging and testing purposes, in all other cases --fdpass is preferred.`
+
 ```ruby
     Clamby.configure({
       :check => false,
@@ -82,7 +86,8 @@ Setting the `fdpass` configuration option to `true` will pass the `--fdpass` opt
       :error_file_missing => false,
       :error_file_virus => false,
       :fdpass => false,
-      :silence_output => false
+      :silence_output => false,
+      :stream => false
     })
 ```
 
@@ -92,7 +97,10 @@ I highly recommend using the `daemonize` set to true. This will allow for clamsc
 
 ***Ubuntu***
 
-`sudo apt-get install clamav`
+`sudo apt-get install clamav clamav-daemon`
+
+Note, `clamav-daemon` is optional but recommended. It's needed if you wish to
+run ClamAV in daemon mode.
 
 ***Apple***
 

data/lib/clamby.rb

@@ -1,16 +1,18 @@
 require "clamby/version"
 require "clamby/exception"
 module Clamby
-
-  @config = {
+  DEFAULT_CONFIG = {
     :check => true,
     :daemonize => false,
     :error_clamscan_missing => true,
     :error_file_missing => true,
     :error_file_virus => false,
     :fdpass => false,
-    :silence_output => false
-  }
+    :silence_output => false,
+    :stream => false
+  }.freeze
+
+  @config = DEFAULT_CONFIG.dup
 
   @valid_config_keys = @config.keys
 
@@ -31,6 +33,7 @@ module Clamby
     command = [].tap do |cmd|
       cmd << clamd_executable_name
       cmd << '--fdpass' if @config[:fdpass]
+      cmd << '--stream' if @config[:stream] && @config[:daemonize]
       cmd << path
       cmd << '--no-summary'
       cmd << { out: File::NULL } if @config[:silence_output]

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/spec/clamby_spec.rb

@@ -4,6 +4,8 @@ good_path = 'README.md'
 bad_path = 'BAD_FILE.md'
 
 describe Clamby do
+  before { Clamby.configure(Clamby::DEFAULT_CONFIG.dup) }
+
   it "should find files." do
     expect(Clamby.file_exists?(good_path)).to be true
   end
@@ -25,6 +27,7 @@ describe Clamby do
   end
 
   it "should scan file and return nil" do
+    Clamby.configure({:error_file_missing => false})
     expect(Clamby.safe?(bad_path)).to be nil
     expect(Clamby.virus?(bad_path)).to be nil
   end
@@ -68,4 +71,30 @@ describe Clamby do
       expect(Clamby.system_command(good_path)).to eq ["clamscan", "--fdpass", good_path, "--no-summary"]
     end
   end
+
+  # From the clamscan man page:
+  # Forces file streaming to clamd. This is generally not needed as clamdscan
+  # detects automatically if streaming is required. This option only exists for
+  # debugging and testing purposes, in all other cases --fdpass is preferred.
+  context 'stream option' do
+    it 'is false by default' do
+      expect(Clamby.config[:stream]).to eq false
+    end
+    it 'accepts an stream option in the config' do
+      Clamby.configure(stream: true)
+      expect(Clamby.config[:stream]).to eq true
+    end
+    it 'does not include stream in the command by default' do
+      Clamby.configure(stream: false)
+      expect(Clamby.system_command(good_path)).to eq ["clamscan", good_path, "--no-summary"]
+    end
+    it 'omits the stream option when invoking clamscan if it is set, but daemonize isn\'t' do
+      Clamby.configure(stream: true)
+      expect(Clamby.system_command(good_path)).to eq ["clamscan", good_path, "--no-summary"]
+    end
+    it 'passes the stream option when invoking clamscan if it is set with daemonize' do
+      Clamby.configure(stream: true, daemonize: true)
+      expect(Clamby.system_command(good_path)).to eq ["clamdscan", "--stream", good_path, "--no-summary"]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - kobaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Scan file uploads with ClamAV