Merge pull request #21 from upmc-enterprises/HOPS-310-12-months-volum…

…e-report-review

[HOPS-320]12 months volumes report.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neutrino_api_client (5.0.0dev0.02)
+    neutrino_api_client (5.1.0dev0.01)
       activesupport (~> 6.0)
       api-auth (= 2.3.1)
       mime-types (= 3.2.2)

lib/neutrino/gateway/data_quality_report.rb

@@ -6,16 +6,25 @@ module Gateway
     class DataQualityReport < Neutrino::Gateway::Requestor
       private_class_method :new
       class << self
-        
+
         # Get the summary of data quality
         # @param [Hash] options specify query values
         # @return [Hash] NEUTRINO response
         def summary(options = {})
           path = "#{api}/reports/data-quality/summary"
           request(path, options).
-            if_400_raise(Neutrino::Gateway::Exceptions::BadRequestError.new()).to_hash
+            if_400_raise(Neutrino::Gateway::Exceptions::BadRequestError.new).to_hash
         end
 
+        # Update the twelve month volume report
+        # Create a new one if there is no existing report
+        # @param [Hash] options specify query values
+        # @return [Hash] NEUTRINO response
+        def twelve_month_volume(options = {})
+          path = "#{api}/reports/data-quality/twelve_month_volume"
+          request(path, options)
+            .if_400_raise(Neutrino::Gateway::Exceptions::BadRequestError.new).to_hash
+        end
       end
     end
   end

lib/neutrino/gateway/version.rb

@@ -1,5 +1,5 @@
 module Neutrino
   module Gateway
-    VERSION = '5.0.0dev0.02'.freeze
+    VERSION = '5.1.0dev0.01'.freeze
   end
 end

spec/neutrino/gateway/data_quality_report_spec.rb

@@ -4,13 +4,11 @@
 require './lib/neutrino/gateway/exceptions'
 
 describe Neutrino::Gateway::DataQualityReport do
-
   before(:each) do
     Neutrino::Api::Client.config = TestConfig.to_hash
   end
 
   describe 'self.summary' do
-
     let(:path) { '/api/v1/reports/data-quality/summary' }
     let(:response_message) { { 'content' => 'some data', 'message'=>'The system is updating the report' }  }
 
@@ -27,7 +25,6 @@
     end
 
     context 'when the server returns a 400 error' do
-
       before(:each) do
         WebMock.stub_request(
           :get,
@@ -39,8 +36,37 @@
       it 'raises a bad request error' do
         expect { described_class.summary(OPTIONS_WITH_REMOTE_IP) }.to raise_error(Neutrino::Gateway::Exceptions::BadRequestError)
       end
+    end
+  end
+
+  describe 'self.twelve_month_volume' do
+    let(:path) { '/api/v1/reports/data-quality/twelve_month_volume' }
+    let(:response_message) { { 'content' => 'some data', 'message'=>'The system is updating the report' }  }
+
+    before(:each) do
+      WebMock.stub_request(
+        :get,
+        'http://testhost:4242/api/v1/reports/data-quality/twelve_month_volume?user%5Bextension%5D=spameggs&user%5Broot%5D=foobar')
+        .with(headers: { 'X-Forwarded-For' => REMOTE_IP })
+        .to_return(body: response_message.to_json , status: ['200', 'OK'])
+    end
 
+    it 'returns the expected result' do
+      expect(described_class.twelve_month_volume(OPTIONS_WITH_REMOTE_IP)).to eq(response_message)
     end
 
+    context 'when the server returns a 400 error' do
+      before(:each) do
+        WebMock.stub_request(
+          :get,
+          'http://testhost:4242/api/v1/reports/data-quality/twelve_month_volume?user%5Bextension%5D=spameggs&user%5Broot%5D=foobar')
+          .with(headers: { 'X-Forwarded-For' => REMOTE_IP })
+          .to_return(body: 'Bad Request', status: ['400', 'Bad Request'])
+      end
+
+      it 'raises a bad request error' do
+        expect { described_class.twelve_month_volume(OPTIONS_WITH_REMOTE_IP) }.to raise_error(Neutrino::Gateway::Exceptions::BadRequestError)
+      end
+    end
   end
 end