witch_doctor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e488255c1787360c0530fa7db20210960c9e40d
-  data.tar.gz: 2fd9f892ad7f38f8af98d45aa6db85c33b44511d
+  metadata.gz: 62a6d2446df132b40062054df4cefaa444b038a2
+  data.tar.gz: 7a73956f5b7ec02a248628b5d2189297d7637854
 SHA512:
-  metadata.gz: 0da25a445b251b6d7a648b8c5b4e3da8d31c4b1559047987e4a97c82a975abd316f2acf9bb0dc1df910bed73d08c9afa5ab0484dc93aece4a42f85d8c90a7bab
-  data.tar.gz: 2691da3d55694e2690127890c885547c8982c04ff5e7057ca69aa5bc287f6b295906bb2611d15056dceff4d027223f8d4c79d77fa1b8140541d86b92ea8aad38
+  metadata.gz: 8bdcbfc8f4ad8ef68d392f243ea1d7a9e58ddd2d938a46ba276cf01fb24507386463860b813206791343fd7f8d1667fc7996d8fb773fe687a91e8bfb93d324c1
+  data.tar.gz: 06078977ef998a31963d69287397148eea095d5ec014fc8b06c50daffbed48ce23b172a2aa218b129e1d9fdc8a162a502cd7b68d61af0be9ab7abf7f6e8cda3a

data/README.md

@@ -53,7 +53,7 @@ end
 ```ruby
 # /config/initializers/witch_doctor.rb
 
-VirusScan.token = Rails
+WitchDoctor.token = Rails
   .application
   .secrets
   .fetch('antivirus_scan')
@@ -125,8 +125,33 @@ end
 
 # Testing
 
-The gem/engine is pretty well tested but I recomend everyone to write
-interation test for every application it's introduced to.
+Make sure you turn of `virus_scan_scheduling_on` option so that gem wont
+create extra records when your tests are running
+
+```
+# config/initializers/witch_doctor.rb
+WitchDoctor.skip_virus_scan_scheduling = true
+```
+
+turn it on only when needed
+
+```ruby
+# spec/request/virus_scan.rb
+
+# ...
+before do
+  WitchDoctor.skip_virus_scan_scheduling = false
+end
+
+after do
+  WitchDoctor.skip_virus_scan_scheduling = true
+end
+
+# ...
+```
+
+The gem/engine is pretty well tested but I recomend to write
+interation test for every application it is introduced to.
 
 Example with RSpec request test:
 

data/app/controllers/witch_doctor/virus_scans_controller.rb

@@ -53,7 +53,7 @@ module WitchDoctor
     def authenticate!
       if provided_token == nil
         render json: { errors: { request: ['Not Authenticated'] } }, status: 401
-      elsif provided_token.to_s == VirusScan.token
+      elsif provided_token.to_s == WitchDoctor.token
         yield
       else
         render json: { errors: { request: ['Not Authorized'] } }, status: 403
@@ -61,12 +61,18 @@ module WitchDoctor
     end
 
     def provided_token
-      (request.headers['HTTP_AUTHORIZATION'] || request.headers['rack.session']['Authorization'])
+      authorization
         .to_s
         .match(/Token\s+(.*)/) { |m| m[1] } \
         || params[:token]
     end
 
+    def authorization
+      (rails4 = request.headers['HTTP_AUTHORIZATION']) \
+        || (rails3 = request.headers['Authorization']) \
+        || (rspec = request.headers['rack.session']['Authorization'])
+    end
+
     def virus_scan_params
       VirusScanPermitter.new.attributes(params)
     end

data/app/models/virus_scan.rb

@@ -1,39 +1 @@
-class VirusScan < ActiveRecord::Base
-  TokenNotSpecified = Class.new(StandardError)
-
-  class << self
-    attr_writer :token
-
-    def token
-      @token || raise(TokenNotSpecified)
-    end
-  end
-
-  belongs_to :resource, polymorphic: true
-  scope :not_scanned, -> { where scan_result: nil }
-  validates_inclusion_of :scan_result, in: WitchDoctor::Antivirus::RESULTS, allow_nil: true
-
-  before_update :set_scanned_at, if: :scan_updated?
-
-  def as_json(options={})
-    attributes
-      .slice('id', 'scan_result')
-      .tap { |hash|
-        hash.merge!('file_url'   => file_url,
-                    'scanned_at' => scanned_at.try(:utc).try(:iso8601))
-      }
-  end
-
-  # S3 will give url, file wil show mount point, we care just about s3
-  def file_url
-    resource.send(mount_point).url
-  end
-
-  def set_scanned_at
-    self.scanned_at = WitchDoctor.time_stamper.call
-  end
-
-  def scan_updated?
-    scan_result.in? WitchDoctor::Antivirus::RESULTS
-  end
-end
+VirusScan = Class.new(WitchDoctor::VirusScan)

data/app/models/witch_doctor/virus_scan.rb

@@ -0,0 +1,33 @@
+module WitchDoctor
+  class VirusScan < ActiveRecord::Base
+    self.table_name = "virus_scans"
+
+    belongs_to :resource, polymorphic: true
+    scope :not_scanned, -> { where scan_result: nil }
+    validates_inclusion_of :scan_result, in: WitchDoctor::Antivirus::RESULTS, allow_nil: true
+
+    before_update :set_scanned_at, if: :scan_updated?
+
+    def as_json(options={})
+      attributes
+        .slice('id', 'scan_result')
+        .tap { |hash|
+          hash.merge!('file_url'   => file_url,
+                      'scanned_at' => scanned_at.try(:utc).try(:iso8601))
+        }
+    end
+
+    # S3 will give url, file wil show mount point, we care just about s3
+    def file_url
+      resource.send(mount_point).url
+    end
+
+    def set_scanned_at
+      self.scanned_at = WitchDoctor.time_stamper.call
+    end
+
+    def scan_updated?
+      scan_result.in? WitchDoctor::Antivirus::RESULTS
+    end
+  end
+end

data/app/permiterters/virus_scan_permitter.rb

@@ -2,6 +2,6 @@ class VirusScanPermitter
   def attributes(params)
     params
       .require(:virus_scan)
-      .permit [:scan_result]
+      .permit(:scan_result)
   end
 end

data/lib/witch_doctor/antivirus_concern.rb

@@ -6,11 +6,15 @@ module WitchDoctor
       has_many :virus_scans, as: :resource
     end
 
+    def virus_scan_scheduling_on?
+      !WitchDoctor.skip_virus_scan_scheduling
+    end
+
     module ClassMethods
       def schedule_virus_scan(options)
         mount_point = options.fetch(:on)
 
-        after_save "schedule_#{mount_point}_virus_scan", if: "schedule_#{mount_point}_virus_scan?"
+        after_save "schedule_#{mount_point}_virus_scan", if: ["schedule_#{mount_point}_virus_scan?", :virus_scan_scheduling_on?]
 
         define_method("schedule_#{mount_point}_virus_scan") do
           virus_scans.create! do |vs|

data/lib/witch_doctor/version.rb

@@ -1,3 +1,3 @@
 module WitchDoctor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/witch_doctor.rb

@@ -3,8 +3,10 @@ require "witch_doctor/antivirus"
 require "witch_doctor/antivirus_concern"
 
 module WitchDoctor
+  TokenNotSpecified = Class.new(StandardError)
+
   class << self
-    attr_writer :time_stamper, :virus_scan_limit
+    attr_writer :time_stamper, :virus_scan_limit, :token, :skip_virus_scan_scheduling
 
     def time_stamper
       @time_stamper ||= -> { Time.now }
@@ -13,5 +15,13 @@ module WitchDoctor
     def virus_scan_limit
       @virus_scan_limit ||= 10
     end
+
+    def token
+      @token || raise(TokenNotSpecified)
+    end
+
+    def skip_virus_scan_scheduling
+      !!@skip_virus_scan_scheduling
+    end
   end
 end

data/spec/dummy/config/initializers/witch_doctor.rb

@@ -1 +1 @@
-VirusScan.token = '1234'
+WitchDoctor.token = '1234'

data/spec/dummy/log/development.log

@@ -279,3 +279,5 @@ Migrating to CreateWitchDoctorVirusScans (20150209121818)
   ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
   ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
   ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"