(#806) Add API for uploading JSON contexts

Author: excelsior

app/api/entities/json_context.rb

@@ -0,0 +1,13 @@
+module API
+  module Entities
+    # Presenter for JsonContext
+    class JsonContext < Grape::Entity
+      expose :context,
+             documentation: { type: 'object',
+                              desc: 'The payload of the context' }
+      expose :url,
+             documentation: { type: 'string',
+                              desc: 'The URL of the context' }
+    end
+  end
+end

app/api/v1/base.rb

@@ -14,6 +14,7 @@
 require 'v1/config'
 require 'v1/bulk_purge'
 require 'v1/ctdl'
+require 'v1/json_contexts'
 
 module API
   module V1
@@ -59,6 +60,7 @@ class Base < Grape::API
         end
 
         mount API::V1::Config
+        mount API::V1::JsonContexts
         mount API::V1::Organizations
         mount API::V1::Publishers
       end

app/api/v1/json_contexts.rb

@@ -0,0 +1,46 @@
+require 'entities/json_context'
+require 'policies/json_context_policy'
+
+module API
+  module V1
+    # Json contexts API endpoints
+    class JsonContexts < Grape::API
+      helpers SharedHelpers
+
+      before do
+        authenticate!
+      end
+
+      resources :json_contexts do # rubocop:todo Metrics/BlockLength
+        desc 'Retrieves all JSON contexts'
+        get do
+          authorize JsonContext, :index?
+          present JsonContext.order(updated_at: :desc), with: Entities::JsonContext
+        end
+
+        desc 'Retrives a JSON context by its URL'
+        params do
+          requires :url, type: String, desc: 'Context URL'
+        end
+        get ':url', requirements: { url: /(.*)/i } do
+          authorize JsonContext, :index?
+          json_context = JsonContext.find_by!(url: params[:url])
+          present json_context, with: Entities::JsonContext
+        end
+
+        desc 'Uploads a JSON context'
+        params do
+          requires :context, type: Hash, desc: 'Context payload'
+          requires :url, type: String, desc: 'Context URL'
+        end
+        post do
+          authorize JsonContext, :create?
+          json_context = JsonContext.find_or_initialize_by(url: params[:url])
+          status json_context.new_record? ? :created : :ok
+          json_context.update!(context: params[:context])
+          present json_context, with: Entities::JsonContext
+        end
+      end
+    end
+  end
+end

app/policies/json_context_policy.rb

@@ -0,0 +1,12 @@
+require_relative 'application_policy'
+
+# Specifies policies for organization API
+class JsonContextPolicy < ApplicationPolicy
+  def index?
+    user.admin?
+  end
+
+  def create?
+    user.admin?
+  end
+end

lib/swagger_docs/models.rb

@@ -503,6 +503,16 @@ module Models # rubocop:todo Metrics/ModuleLength, Style/Documentation
                    type: :string,
                    format: :datetime
         end
+
+        swagger_schema :JsonContext do
+          property :context,
+                   description: 'The payload of the context',
+                   type: :object
+
+          property :url,
+                   description: 'The URL of the context',
+                   type: :string
+        end
       end
     end
   end

lib/swagger_docs/sections/admin.rb

@@ -7,6 +7,81 @@ module Admin # rubocop:todo Metrics/ModuleLength, Style/Documentation
         extend ActiveSupport::Concern
 
         included do
+          swagger_path '/metadata/json_contexts' do
+            operation :get do
+              key :operationId, 'getApiJsonContexts'
+              key :description, 'Retrieves all JSON contexts'
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              response 200 do
+                key :description, 'JSON context updated'
+                schema do
+                  key :type, :array
+                  items { key :$ref, :JsonContext }
+                end
+              end
+            end
+
+            operation :post do # rubocop:todo Metrics/BlockLength
+              key :operationId, 'postApiJsonContexts'
+              key :description, 'Uploads a JSON context'
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              parameter do
+                key :name, :body
+                key :in, :body
+                key :description, 'Request body'
+                key :required, true
+
+                schema do
+                  key :required, %i[context url]
+
+                  property :context do
+                    key :type, :object
+                    key :description, 'Context payload'
+                  end
+
+                  property :url do
+                    key :type, :string
+                    key :description, 'Context URL'
+                  end
+                end
+              end
+
+              response 200 do
+                key :description, 'JSON context updated'
+                schema { key :$ref, :JsonContext }
+              end
+
+              response 201 do
+                key :description, 'JSON context created'
+                schema { key :$ref, :JsonContext }
+              end
+            end
+          end
+
+          swagger_path '/metadata/json_contexts/{url}' do
+            operation :get do
+              key :operationId, 'getApiJsonContext'
+              key :description, 'Retrieves a JSON context by its URL'
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              parameter name: :url,
+                        in: :path,
+                        type: :string,
+                        required: true,
+                        description: 'The URL of the JSON context'
+
+              response 200 do
+                key :description, 'JSON context updated'
+                schema { key :$ref, :JsonContext }
+              end
+            end
+          end
+
           swagger_path '/metadata/organizations' do
             operation :get do
               key :operationId, 'getApiOrganizations'

spec/api/v1/json_contexts_spec.rb

@@ -0,0 +1,134 @@
+require_relative 'shared_examples/auth'
+
+RSpec.describe 'Json contexts API' do # rubocop:todo RSpec/DescribeClass
+  let(:admin) { token.admin }
+  let(:admin_token) { create(:auth_token, :admin) }
+  let(:url) { Faker::Internet.url }
+
+  describe 'GET /metadata/json_contexts' do
+    let!(:json_context1) { create(:json_context) } # rubocop:todo RSpec/IndexedLet
+    let!(:json_context2) { create(:json_context) } # rubocop:todo RSpec/IndexedLet
+
+    include_examples 'requires auth', :post, '/metadata/json_contexts'
+
+    it 'returns all JSON contexts' do
+      get '/metadata/json_contexts', 'Authorization' => "Token #{admin_token.value}"
+      expect_status(:ok)
+      expect_json('0.context', **json_context2.context.symbolize_keys)
+      expect_json('0.url', json_context2.url)
+      expect_json('1.context', **json_context1.context.symbolize_keys)
+      expect_json('1.url', json_context1.url)
+    end
+  end
+
+  describe 'GET /metadata/json_contexts/:url' do
+    let!(:json_context) { create(:json_context) }
+
+    include_examples 'requires auth', :post, '/metadata/json_contexts/0'
+
+    it 'returns the JSON context with the given URL' do
+      get "/metadata/json_contexts/#{CGI.escape(json_context.url)}",
+          'Authorization' => "Token #{admin_token.value}"
+      expect_status(:ok)
+      expect_json('context', **json_context.context.symbolize_keys)
+      expect_json('url', json_context.url)
+    end
+  end
+
+  describe 'POST /metadata/json_contexts' do
+    let(:context) { JSON(Faker::Json.shallow_json) }
+    let(:params) { { context:, url: } }
+
+    include_examples 'requires auth', :post, '/metadata/json_contexts'
+
+    context 'as admin' do # rubocop:todo RSpec/ContextWording
+      before do
+        post '/metadata/json_contexts',
+             params,
+             'Authorization' => "Token #{admin_token.value}"
+      end
+
+      # rubocop:todo RSpec/NestedGroups
+      context 'new context' do # rubocop:todo RSpec/ContextWording, RSpec/NestedGroups
+        # rubocop:enable RSpec/NestedGroups
+        # rubocop:todo RSpec/NestedGroups
+        context 'empty context' do # rubocop:todo RSpec/ContextWording, RSpec/NestedGroups
+          # rubocop:enable RSpec/NestedGroups
+          let(:context) { nil }
+
+          it 'returns 422' do
+            expect_status(:unprocessable_entity)
+            expect_json('error', "Context can't be blank")
+          end
+        end
+
+        # rubocop:todo RSpec/NestedGroups
+        context 'empty URL' do # rubocop:todo RSpec/ContextWording, RSpec/NestedGroups
+          let(:url) { nil }
+
+          # rubocop:enable RSpec/NestedGroups
+          it 'return 422' do
+            expect_status(:unprocessable_entity)
+            expect_json('error', "Url can't be blank")
+          end
+        end
+
+        context 'all params' do # rubocop:todo RSpec/ContextWording, RSpec/NestedGroups
+          it 'creates a next context' do
+            json_context = JsonContext.order(:created_at).last
+            expect(json_context.context).to eq(context)
+            expect(json_context.url).to eq(url)
+            expect_status(:created)
+            expect_json('context', **context.symbolize_keys)
+            expect_json('url', url)
+          end
+        end
+      end
+
+      # rubocop:todo RSpec/MultipleMemoizedHelpers
+      # rubocop:todo RSpec/NestedGroups
+      context 'existing context' do # rubocop:todo RSpec/ContextWording, RSpec/MultipleMemoizedHelpers, RSpec/NestedGroups
+        let(:json_context) { create(:json_context) }
+        let(:url) { json_context.url }
+
+        # rubocop:todo RSpec/MultipleMemoizedHelpers
+        # rubocop:todo RSpec/NestedGroups
+        context 'empty context' do # rubocop:todo RSpec/ContextWording, RSpec/MultipleMemoizedHelpers, RSpec/NestedGroups
+          let(:context) { nil }
+
+          # rubocop:enable RSpec/NestedGroups
+          it 'returns 422' do
+            expect_status(:unprocessable_entity)
+            expect_json('error', "Context can't be blank")
+          end
+        end
+        # rubocop:enable RSpec/MultipleMemoizedHelpers
+
+        context 'all params' do # rubocop:todo RSpec/ContextWording, RSpec/MultipleMemoizedHelpers, RSpec/NestedGroups
+          it 'updates the context' do
+            json_context.reload
+            expect(json_context.context).to eq(context)
+            expect(json_context.url).to eq(url)
+            expect_status(:ok)
+            expect_json('context', **context.symbolize_keys)
+            expect_json('url', url)
+          end
+        end
+      end
+      # rubocop:enable RSpec/MultipleMemoizedHelpers
+    end
+
+    # rubocop:todo RSpec/MultipleMemoizedHelpers
+    context 'as publisher' do # rubocop:todo RSpec/ContextWording
+      let(:token) { create(:auth_token) }
+
+      it 'returns 403' do
+        post '/metadata/json_contexts',
+             params,
+             'Authorization' => "Token #{token.value}"
+        expect_status(:forbidden)
+      end
+    end
+    # rubocop:enable RSpec/MultipleMemoizedHelpers
+  end
+end

spec/factories/json_contexts.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :json_context do
+    url { Faker::Internet.url }
+  end
+end