witch_doctor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62a6d2446df132b40062054df4cefaa444b038a2
-  data.tar.gz: 7a73956f5b7ec02a248628b5d2189297d7637854
+  metadata.gz: 650c3ce0616680e392499a923f74f19b8786ce71
+  data.tar.gz: 82d4262010013f84a259bf5e985e30e37cee9822
 SHA512:
-  metadata.gz: 8bdcbfc8f4ad8ef68d392f243ea1d7a9e58ddd2d938a46ba276cf01fb24507386463860b813206791343fd7f8d1667fc7996d8fb773fe687a91e8bfb93d324c1
-  data.tar.gz: 06078977ef998a31963d69287397148eea095d5ec014fc8b06c50daffbed48ce23b172a2aa218b129e1d9fdc8a162a502cd7b68d61af0be9ab7abf7f6e8cda3a
+  metadata.gz: 3e0bba87c3db83b2f36c1aa1d5e7f4ea33f4d4ac4ff88205575e241a200a21b9bef87e94a90ca66a356354ffb0708ca99ea348d068145df363ab0196df03def6
+  data.tar.gz: f3e566771992cb017041faa6c268c153c60d56a79335507a81923e81ce1c255967fd281daffc23cc0549b127b88a36136f96dd45f7fed760f8d01934913dc5b0

data/README.md

@@ -13,6 +13,7 @@ Engine was designed to work alongside [virus_scan_service gem](https://github.co
 to which it provides a list of VirusScans. These are created upon file resource
 create / update events.
 
+API is trying to comply with [JSON API standard](http://jsonapi.org/)
 
 ## CarrierWave
 
@@ -24,11 +25,7 @@ details
 
 ## working along `ActiveModel::Serializer`
 
-The reason why the gem is not using [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers)
-by default is that I didn't want to introduce extra dependencies.
-This engine is trying to be really lightweight.
-
-If you choose to use it in application using ActiveModel::Serializer you should have no problems.
+please read more in `docs/action_model_serializer.md`
 
 # Setup
 
@@ -175,16 +172,18 @@ RSpec.describe 'VirusScans', :type => :request do
       expect(response.status).to be 200
     end
 
-    it 'expect the JSON response to be Array' do
-      expect(JSON.parse response.body).to eq [
-        {
-          "id" => virus_scan.id,
-          "scan_result" => nil,
-          "scanned_at" => nil,
-          "file_url" => "/uploads/documents/#{virus_scan.id}/passport.jpg" # don't care about file storage (tests)
-                                                                           # as virus scans are needed only on s3
-        }
-      ]
+    it 'expect the JSON response to be JSON API hash' do
+      expect(JSON.parse response.body).to eq({
+        "data" => [
+          {
+            "id" => virus_scan.id,
+            "scan_result" => nil,
+            "scanned_at" => nil,
+            "file_url" => "/uploads/documents/#{virus_scan.id}/passport.jpg" # don't care about file storage (tests)
+                                                                             # as virus scans are needed only on s3
+          }
+        ]
+      })
     end
   end
 
@@ -204,13 +203,14 @@ RSpec.describe 'VirusScans', :type => :request do
 
     it 'expect to update existing virus_scan' do
       expect(JSON.parse response.body).to eq({
+        "data" => {
           "id" => virus_scan.id,
           "scan_result" => 'Clean',
           "scanned_at" => Time.now.midnight.utc.iso8601,
           "file_url" => "/uploads/documents/#{virus_scan.id}/passport.jpg"
-        })
+        }
+      })
     end
   end
 end
 ```
-

data/app/controllers/witch_doctor/virus_scans_controller.rb

@@ -12,12 +12,16 @@ module WitchDoctor
           .not_scanned
           .limit(WitchDoctor.virus_scan_limit)
 
+
         respond_to do |format|
           format.json do
-            render json: @virus_scans
+            render WitchDoctor.controller_object_hash_generator.call(@virus_scans)
           end
           format.html do
-            render json: { errors: { request: ['needs to be JSON request'] } }, status: 406
+            json_406 = { title: "Not Acceptable",
+                         detail: 'needs to be JSON request',
+                         status: '406' }
+            render json: { errors: [json_406] }, status: 406
           end
         end
       end
@@ -31,18 +35,30 @@ module WitchDoctor
               @virus_scan = VirusScan.where(scan_result: nil).find params[:id]
               @virus_scan.update_attributes virus_scan_params# as: :scan_update
               if @virus_scan.errors.any?
-                render json: { errors:  @virus_scan.errors }, status: 400
+                json_400 = { title: "Bad Request",
+                             detail: @virus_scan.errors.first.join(' '),
+                             status: '400' }
+                render json: { errors: [json_400] }, status: 400
               else
-                render json: @virus_scan.reload
+                render WitchDoctor.controller_object_hash_generator.call(@virus_scan.reload)
               end
             rescue ActionController::ParameterMissing => e
-              render json: { errors: { request: [e.to_s] } }, status: 406
+              json_406 = { title: "Not Acceptable",
+                           detail: e.to_s,
+                           status: '406' }
+              render json: { errors: [json_406] }, status: 406
             rescue ActiveRecord::RecordNotFound => e
-              render json: { errors: { request: ['Record not found or already scanned'] } }, status: 404
+              json_404 = { title: "Not Found",
+                           detail: 'Record not found or already scanned',
+                           status:'404' }
+              render json: { errors: [json_404] }, status: 404
             end
           end
           format.html do
-            render json: { errors: { request: ['needs to be JSON request'] } }, status: 406
+            err_json = { title: 'Not Acceptable',
+                         detail: 'needs to be JSON request',
+                         status: '406' }
+            render json: { errors: [err_json] }, status: 406
           end
         end
       end
@@ -52,11 +68,17 @@ module WitchDoctor
 
     def authenticate!
       if provided_token == nil
-        render json: { errors: { request: ['Not Authenticated'] } }, status: 401
+        unauthorized = {title: 'Unauthorized',
+                        detail: 'Not Authenticated',
+                        status: '401' }
+        render json: { errors: [unauthorized] }, status: 401
       elsif provided_token.to_s == WitchDoctor.token
         yield
       else
-        render json: { errors: { request: ['Not Authorized'] } }, status: 403
+        forbidden = { title: 'Forbidden',
+                      detail: 'Not Authorized',
+                      status: '403' }
+        render json: { errors: [forbidden] }, status: 403
       end
     end
 
@@ -78,12 +100,10 @@ module WitchDoctor
     end
 
     def incorrect_format
-      render json: { errors: { request: ["Incorrect format"] } }, status: 406
-    end
-
-    # when used in app with ActiveModel::Serializer this will prevent it to do root JSON
-    def default_serializer_options
-        {root: false}
+      json_406 = { title: 'Not Acceptable',
+                   detail: "Incorrect format",
+                   status: '406' }
+      render json: { errors: [json_406] }, status: 406
     end
   end
 end

data/lib/witch_doctor/version.rb

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

data/lib/witch_doctor.rb

@@ -6,7 +6,8 @@ module WitchDoctor
   TokenNotSpecified = Class.new(StandardError)
 
   class << self
-    attr_writer :time_stamper, :virus_scan_limit, :token, :skip_virus_scan_scheduling
+    attr_writer :time_stamper, :virus_scan_limit, :token,
+      :skip_virus_scan_scheduling, :controller_object_hash_generator
 
     def time_stamper
       @time_stamper ||= -> { Time.now }
@@ -23,5 +24,11 @@ module WitchDoctor
     def skip_virus_scan_scheduling
       !!@skip_virus_scan_scheduling
     end
+
+    def controller_object_hash_generator
+      @controller_object_hash_generator ||= begin
+        ->(object) { { json: { data: object.as_json } } }
+      end
+    end
   end
 end

data/spec/controllers/virus_scans_controller_spec.rb

@@ -13,6 +13,14 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
   before(:all) { WitchDoctor.time_stamper = -> { Time.now.midnight } }
   after(:all)  { WitchDoctor.time_stamper = (reset_stamper_to_default = nil) }
 
+  let(:json_401) do
+    %q{{"errors":[{"title":"Unauthorized","detail":"Not Authenticated","status":"401"}]}}
+  end
+
+  let(:json_403) do
+    %q{{"errors":[{"title":"Forbidden","detail":"Not Authorized","status":"403"}]}}
+  end
+
   describe 'get index' do
     let!(:scheduled_virus_scan1) { create :virus_scan }
     let!(:clean_virus_scan) { create :virus_scan, :clean }
@@ -22,7 +30,7 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
       it 'responds 401 Not Authenticated' do
         get(:index, format: format)
         expect(response.status).to eq 401
-        expect(response.body).to eq %q{{"errors":{"request":["Not Authenticated"]}}}
+        expect(response.body).to eq json_401
       end
     end
 
@@ -30,7 +38,7 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
       it 'responds 403 with Not Authorized errors' do
         get(:index, token: 999, format: format)
         expect(response.status).to eq 403
-        expect(response.body).to eq %q{{"errors":{"request":["Not Authorized"]}}}
+        expect(response.body).to eq %q{{"errors":[{"title":"Forbidden","detail":"Not Authorized","status":"403"}]}}
       end
     end
 
@@ -42,7 +50,7 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
       it 'responds 200 with ASC scheduled virus scans' do
         trigger
         expect(response.status).to eq 200
-        expect(response.body).to eq("[#{scheduled_virus_scan1.to_json},#{scheduled_virus_scan2.to_json}]")
+        expect(response.body).to eq("{\"data\":[#{scheduled_virus_scan1.to_json},#{scheduled_virus_scan2.to_json}]}")
       end
 
       context 'using header token' do
@@ -62,7 +70,16 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
         before { trigger }
         let(:format) { 'html' }
         it{ expect(response.status).to eq 406 }
-        it{ expect(response.body).to eq %q{{"errors":{"request":["needs to be JSON request"]}}} }
+        it do
+          err_json = {
+            "errors"=>[
+              { "title"=>"Not Acceptable",
+                "detail"=>"needs to be JSON request",
+                "status"=>"406"}
+            ]
+          }
+          expect(JSON.parse response.body).to match err_json
+        end
       end
     end
   end
@@ -77,7 +94,7 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
           .not_to change { virus_scan.reload.scan_result }
 
         expect(response.status).to eq 401
-        expect(response.body).to eq %q{{"errors":{"request":["Not Authenticated"]}}}
+        expect(response.body).to eq json_401
       end
     end
 
@@ -87,7 +104,7 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
           .not_to change { virus_scan.reload.scan_result }
 
         expect(response.status).to eq 403
-        expect(response.body).to eq %q{{"errors":{"request":["Not Authorized"]}}}
+        expect(response.body).to eq json_403
       end
     end
 
@@ -109,12 +126,14 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
           .from(nil)
           .to('Clean')
 
-        expect(JSON.parse response.body).to eq({
+        expect(JSON.parse response.body).to match({
+          "data" => {
             "id" => virus_scan.id,
             "scan_result" => 'Clean',
             "scanned_at" => Time.now.midnight.utc.iso8601,
             "file_url" => "https://my-s3-bucket.dummy/uploads/documents/blank_pdf.pdf"
-          })
+          }
+        })
       end
 
       context 'sending missing params' do
@@ -124,7 +143,14 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
             .not_to change { virus_scan.reload.mount_point }
 
           expect(response.status).to eq 406
-          expect(response.body).to eq(%q{{"errors":{"request":["param is missing or the value is empty: virus_scan"]}}})
+          err_json = {
+            "errors" => [
+              { "title"=>"Not Acceptable",
+                "detail"=>"param is missing or the value is empty: virus_scan",
+                "status"=>"406" }
+            ]
+          }
+          expect(JSON.parse(response.body)).to match(err_json)
         end
       end
 
@@ -135,7 +161,15 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
             .not_to change { virus_scan.reload.mount_point }
 
           expect(response.status).to eq 400
-          expect(response.body).to eq(%q{{"errors":{"scan_result":["is not included in the list"]}}})
+
+          err_json = {
+            "errors" => [
+              { 'title' => "Bad Request",
+                'detail' => "scan_result is not included in the list",
+                'status' => '400' }
+            ]
+          }
+          expect(JSON.parse(response.body)).to match(err_json)
         end
       end
 
@@ -146,7 +180,15 @@ RSpec.describe WitchDoctor::VirusScansController, type: :controller do
             .not_to change { virus_scan.reload.scan_result }
 
          expect(response.status).to eq 406
-         expect(response.body).to eq '{"errors":{"request":["needs to be JSON request"]}}'
+
+         err_json = {
+           "errors"=> [
+             { "title"=>"Not Acceptable",
+               "detail"=>"needs to be JSON request",
+               "status"=>"406" }
+           ]
+         }
+         expect(JSON.parse response.body).to match err_json
         end
       end
     end

data/spec/dummy/log/development.log

@@ -281,3 +281,25 @@ Migrating to CreateWitchDoctorVirusScans (20150209121818)
   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"
+  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"
+  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"
+  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"
+  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"
+  ActiveRecord::SchemaMigration Load (0.3ms)  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"
+  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"
+  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"