Read-only Bans API

app/controllers/api/v1/users_controller.rb

@@ -12,6 +12,22 @@ def steam_id
 
         render json: @user, serializer: UserSerializer
       end
+
+      def bans
+        @user = User.find(params[:id])
+
+        @ban_models = User.ban_models.map do |_action, bans|
+          bans.map do |_subject, model|
+            next if model.subject?
+
+            model
+          end
+        end.reduce(:+).compact.sort_by(&:association_name)
+        @bans = @ban_models.map { |model| model.where(user: @user).to_a }.reduce(:+).sort_by(&:created_at)
+        @new_bans = @ban_models.map(&:new)
+
+        render json: @bans, each_serializer: BanSerializer
+      end
     end
   end
 end

app/serializers/api/v1/ban_serializer.rb

@@ -0,0 +1,10 @@
+module API
+  module V1
+    class BanSerializer < ActiveModel::Serializer
+      type :ban
+
+      attributes :id, :created_at, :terminated_at
+      attribute(:type) { object.class.subject }
+    end
+  end
+end

config/routes.rb

@@ -10,7 +10,11 @@
       end
 
       get 'users/steam_id/:id', to: 'users#steam_id'
-      resources :users, only: [:show]
+      resources :users, only: [:show] do
+        member do
+          get 'bans'
+        end
+      end
       resources :teams, only: [:show]
     end
   end

docs/api/v1.md

@@ -26,6 +26,14 @@ User:
 
 ```
 
+```
+Ban:
+  id: Integer
+  created_at: DateTime(ISO 8601)
+  terminated_at: DateTime(ISO 8601)
+  type: String
+```
+
 ### GET `/users/:id`
 
 Options:
@@ -69,6 +77,25 @@ Options:
 
 Example same as above.
 
+### GET `/users/:user_id/bans`
+
+Options:
+- `:user_id`, the unique id of the user
+
+Example:
+```json
+{
+  "bans": [
+    {
+      "id": 1,
+      "created_at": "2018-01-21T14:12:31.498+10:00",
+      "terminated_at": "2019-01-21T14:11:00.000+10:00",
+      "type": "leagues"
+    }
+  ]
+}
+```
+
 ## Teams
 
 ### Resource

spec/controllers/api/v1/users_controller_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+
+describe API::V1::UsersController do
+  let(:key) { create(:api_key) }
+  let(:user) { create(:user) }
+
+  describe 'GET #bans' do
+    context 'when unauthenticated' do
+      it 'fails with unauthorized error' do
+        get :bans, params: { id: user.id }
+
+        expect(response).to have_http_status(:unauthorized)
+        expect(json['status']).to eq(401)
+        expect(json['message']).to eq('Unauthorized API key')
+      end
+    end
+
+    context 'when authenticated' do
+      context 'retrieving unbanned player' do
+        it 'succeeds with 0 bans' do
+          request.headers['X-API-Key'] = key.key
+          get :bans, params: { id: user.id }
+
+          expect(response).to have_http_status(:success)
+          expect(json['bans'].length).to eq(0)
+        end
+      end
+
+      context 'retrieving league banned player' do
+        it 'succeeds with 1 league ban' do
+          user.ban(:use, :leagues)
+
+          request.headers['X-API-Key'] = key.key
+          get :bans, params: { id: user.id }
+
+          expect(response).to have_http_status(:success)
+          expect(json['bans'].length).to eq(1)
+          expect(json['bans'].first['type']).to eq('leagues')
+        end
+      end
+    end
+  end
+end

spec/rails_helper.rb

@@ -65,4 +65,6 @@
 
   # Include url helpers
   config.include Rails.application.routes.url_helpers
+
+  config.include JsonHelpers
 end

spec/support/json_helpers.rb

@@ -0,0 +1,5 @@
+module JsonHelpers
+  def json
+    JSON.parse(response.body)
+  end
+end