API Documentation for CDR export download (#1986)

* API Documentation for CDR export download

* fix call auth error response

Author: dmitry-sinina

app/controllers/api/rest/customer/v1/call_auth_controller.rb

@@ -3,33 +3,40 @@
 class Api::Rest::Customer::V1::CallAuthController < Api::Rest::Customer::V1::BaseController
   include CustomerV1Authorizable
 
-  def create
-    error_options = {
-      status: '500',
-      code: '500',
-      title: 'Invalid request'
-    }
+  ConfigurationError = Class.new(JSONAPI::Exceptions::Error) do
+    def initialize(detail)
+      @detail = detail
+      super()
+    end
+
+    def errors
+      [create_error_object(
+        code: JSONAPI::INTERNAL_SERVER_ERROR,
+        status: :internal_server_error,
+        title: 'Internal Server Error',
+        detail: @detail
+      )]
+    end
+  end
 
+  def create
     if auth_context.provision_gateway_id.nil?
-      render status: 500, json: {
-        errors: [error_options.merge(detail: 'Provisioning Gateway is not found.')]
-      } and return
+      raise ConfigurationError, 'Provisioning Gateway is not found.'
     end
 
     unless auth_context.provision_gateway.incoming_auth_allow_jwt?
-      render status: 500, json: {
-        errors: [error_options.merge(detail: 'Incoming JWT is disabled for Provisioning Gateway.')]
-      } and return
+      raise ConfigurationError, 'Incoming JWT is disabled for Provisioning Gateway.'
     end
 
     private_key_path = YetiConfig&.api&.customer&.call_jwt_private_key
-    raise 'Gateway Private key not found' if private_key_path.blank? || !File.exist?(private_key_path)
+    if private_key_path.blank? || !File.exist?(private_key_path)
+      raise ConfigurationError, 'Gateway Private key not found.'
+    end
 
     private_key = OpenSSL::PKey::EC.new(File.read(private_key_path))
     lifetime = YetiConfig&.api&.customer&.call_jwt_lifetime.presence
     if private_key.blank?
-      capture_error('Private key is not found.')
-      render status: 500, json: { errors: [details: 'Internal Server Error'] } and return
+      raise ConfigurationError, 'Private key is not found.'
     end
 
     now = Time.now.to_i
@@ -41,5 +48,7 @@ def create
 
     token = JWT.encode(payload, private_key, JwtToken::ES256)
     render json: { jwt: token }, status: 201
+  rescue StandardError => e
+    handle_exceptions(e)
   end
 end

spec/acceptance/rest/admin/api/cdr_exports_spec.rb

@@ -81,6 +81,14 @@
     end
   end
 
+  get '/api/rest/admin/cdr-exports/:id/download' do
+    let(:id) { create(:cdr_export, :completed).id }
+
+    example_request 'download cdr export file' do
+      expect(status).to eq(200)
+    end
+  end
+
   delete '/api/rest/admin/cdr-exports/:id' do
     let(:id) { create(:cdr_export).id }
 

spec/acceptance/rest/customer/api/v1/call_auth_spec.rb

@@ -36,7 +36,7 @@
     example_request 'Receive 500 validation error (Gateway is not found)' do
       expect(status).to eq(500)
       response_json = JSON.parse(response_body, symbolize_names: true)
-      expect(response_json[:errors]).to contain_exactly code: '500', detail: 'Provisioning Gateway is not found.', status: '500', title: 'Invalid request'
+      expect(response_json[:errors]).to contain_exactly code: '500', detail: 'Provisioning Gateway is not found.', status: '500', title: 'Internal Server Error'
     end
   end
 
@@ -46,7 +46,7 @@
     example_request 'Receive 500 validation error (Incoming JWT is disabled for Gateway)' do
       expect(status).to eq(500)
       response_json = JSON.parse(response_body, symbolize_names: true)
-      expect(response_json[:errors]).to contain_exactly code: '500', detail: 'Incoming JWT is disabled for Provisioning Gateway.', status: '500', title: 'Invalid request'
+      expect(response_json[:errors]).to contain_exactly code: '500', detail: 'Incoming JWT is disabled for Provisioning Gateway.', status: '500', title: 'Internal Server Error'
     end
   end
 end

spec/acceptance/rest/customer/api/v1/cdr_exports_spec.rb

@@ -62,4 +62,12 @@
       expect(status).to eq(200)
     end
   end
+
+  get '/api/rest/customer/v1/cdr-exports/:id/download' do
+    let(:id) { create(:cdr_export, :completed, customer_account: customer_acc).reload.uuid }
+
+    example_request 'download cdr export file' do
+      expect(status).to eq(200)
+    end
+  end
 end

spec/requests/api/rest/customer/v1/call_auth_controller_spec.rb

@@ -142,7 +142,7 @@
         expect(response.status).to eq(500)
         expect(response_json).to match(
           errors: [
-            title: 'Invalid request',
+            title: 'Internal Server Error',
             detail: 'Incoming JWT is disabled for Provisioning Gateway.',
             code: '500',
             status: '500'
@@ -161,7 +161,7 @@
         expect(response.status).to eq(500)
         expect(response_json).to match(
           errors: [
-            title: 'Invalid request',
+            title: 'Internal Server Error',
             detail: 'Provisioning Gateway is not found.',
             code: '500',
             status: '500'