workarea-api-admin 4.4.6

data/app/controllers/workarea/api/admin/releases_controller.rb

@@ -0,0 +1,304 @@
+module Workarea
+  module Api
+    module Admin
+      class ReleasesController < Admin::ApplicationController
+        before_action :find_release, except: [:index, :create, :bulk]
+
+        swagger_path '/releases' do
+          operation :get do
+            key :summary, 'All Releases'
+            key :description, 'Returns all releases from the system'
+            key :operationId, 'listReleases'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :page
+              key :in, :query
+              key :description, 'Current page'
+              key :required, false
+              key :type, :integer
+              key :default, 1
+            end
+            parameter do
+              key :name, :sort_by
+              key :in, :query
+              key :description, 'Field on which to sort (see responses for possible values)'
+              key :required, false
+              key :type, :string
+              key :default, 'created_at'
+            end
+            parameter do
+              key :name, :sort_direction
+              key :in, :query
+              key :description, 'Direction for sort by'
+              key :type, :string
+              key :enum, %w(asc desc)
+              key :default, 'desc'
+            end
+
+            response 200 do
+              key :description, 'Releases'
+              schema do
+                key :type, :object
+                property :releases do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Release'
+                  end
+                end
+              end
+            end
+          end
+
+          operation :post do
+            key :summary, 'Create Release'
+            key :description, 'Creates a new release.'
+            key :operationId, 'addRelease'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Release to add'
+              key :required, true
+              schema do
+                key :type, :object
+                property :release do
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+
+            response 201 do
+              key :description, 'Release created'
+              schema do
+                key :type, :object
+                property :release do
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+
+            response 422 do
+              key :description, 'Validation failure'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :document do
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          @releases = Release
+                        .all
+                        .order_by(sort_field => sort_direction)
+                        .page(params[:page])
+          respond_with releases: @releases
+        end
+
+        def create
+          @release = Release.create!(params[:release])
+          respond_with(
+            { release: @release },
+            { status: :created,
+            location: release_path(@release) }
+          )
+        end
+
+        swagger_path '/releases/{id}' do
+          operation :get do
+            key :summary, 'Find Release by ID'
+            key :description, 'Returns a single release'
+            key :operationId, 'showRelease'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of release to fetch'
+              key :required, true
+              key :type, :string
+            end
+
+            response 200 do
+              key :description, 'Release details'
+              schema do
+                key :type, :object
+                property :release do
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'Release not found'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :params do
+                  key :type, :object
+                  key :additionalProperties, true
+                end
+              end
+            end
+          end
+
+          operation :patch do
+            key :summary, 'Update a Release'
+            key :description, 'Updates attributes on a release'
+            key :operationId, 'updateRelease'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of release to update'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :required, true
+              schema do
+                key :type, :object
+                property :release do
+                  key :description, 'New attributes'
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Release updated successfully'
+            end
+
+            response 422 do
+              key :description, 'Validation failure'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :document do
+                  key :'$ref', 'Workarea::Release'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'Release not found'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :params do
+                  key :type, :object
+                  key :additionalProperties, true
+                end
+              end
+            end
+          end
+
+          operation :delete do
+            key :summary, 'Remove a Release'
+            key :description, 'Remove a release'
+            key :operationId, 'removeRelease'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of release to remove'
+              key :required, true
+              key :type, :string
+            end
+
+            response 204 do
+              key :description, 'Release removed successfully'
+            end
+
+            response 404 do
+              key :description, 'Release not found'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :params do
+                  key :type, :object
+                  key :additionalProperties, true
+                end
+              end
+            end
+          end
+        end
+
+        def show
+          respond_with release: @release
+        end
+
+        def update
+          @release.update_attributes!(params[:release])
+          respond_with release: @release
+        end
+
+        swagger_path '/releases/bulk' do
+          operation :patch do
+            key :summary, 'Bulk Upsert Releases'
+            key :description, 'Creates new releases or updates existing ones in bulk.'
+            key :operationId, 'upsertReleases'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Array of releases to upsert'
+              key :required, true
+              schema do
+                key :type, :object
+                property :releases do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Release'
+                  end
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Upsert received'
+            end
+          end
+        end
+
+        def bulk
+          @bulk = Api::Admin::BulkUpsert.create!(
+            klass: Release,
+            data: params[:releases].map(&:to_h)
+          )
+
+          head :no_content
+        end
+
+        def destroy
+          @release.destroy
+          head :no_content
+        end
+
+        private
+
+        def find_release
+          @release = Release.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/workarea/api/admin/saved_addresses_controller.rb

@@ -0,0 +1,232 @@
+module Workarea
+  module Api
+    module Admin
+      class SavedAddressesController < Admin::ApplicationController
+        before_action :find_user
+        before_action :find_saved_address, except: [:index, :create]
+
+        swagger_path '/users/{id}/saved_addresses' do
+          operation :get do
+            key :summary, 'All Saved Addresses'
+            key :description, 'Returns all saved addresses for a user'
+            key :operationId, 'listSavedAddresses'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'user ID'
+              key :required, true
+              key :type, :string
+            end
+
+            response 200 do
+              key :description, 'Saved addresses'
+              schema do
+                key :type, :object
+                property :saved_addresses do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::User::SavedAddress'
+                  end
+                end
+              end
+            end
+          end
+
+          operation :post do
+            key :summary, 'Create Saved Address'
+            key :description, 'Creates a new saved address'
+            key :operationId, 'addSavedAddress'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'product ID'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Saved address to add'
+              key :required, true
+              schema do
+                key :type, :object
+                property :saved_address do
+                  key :'$ref', 'Workarea::User::SavedAddress'
+                end
+              end
+            end
+
+            response 201 do
+              key :description, 'Saved address created'
+              schema do
+                key :type, :object
+                property :saved_address do
+                  key :'$ref', 'Workarea::User::SavedAddress'
+                end
+              end
+            end
+
+            response 422 do
+              key :description, 'Validation failure'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :document do
+                  key :'$ref', 'Workarea::User::SavedAddress'
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          respond_with saved_addresses: @user.addresses
+        end
+
+        def create
+          @saved_address = @user.addresses.create!(params[:saved_address])
+          respond_with(
+            { saved_address: @saved_address },
+            { status: :created,
+            location: user_saved_addresses_path(@user) }
+          )
+        end
+
+        swagger_path '/users/{user_id}/saved_addresses/{id}' do
+          operation :patch do
+            key :summary, 'Update a saved address'
+            key :description, 'Updates attributes on a saved address'
+            key :operationId, 'updateSavedAddress'
+
+            parameter do
+              key :name, :user_id
+              key :in, :path
+              key :description, 'ID of user'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of saved address to update'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'New attributes'
+              key :required, true
+              schema do
+                key :type, :object
+                property :saved_address do
+                  key :'$ref', 'Workarea::User::SavedAddress'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Saved address updated successfully'
+            end
+
+            response 422 do
+              key :description, 'Validation failure'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :document do
+                  key :'$ref', 'Workarea::User::SavedAddress'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'User or saved address not found'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :params do
+                  key :type, :object
+                  key :additionalProperties, true
+                end
+              end
+            end
+          end
+
+          operation :delete do
+            key :summary, 'Remove a Saved Address'
+            key :description, 'Remove a saved address'
+            key :operationId, 'removeSavedAddress'
+
+            parameter do
+              key :name, :user_id
+              key :in, :path
+              key :description, 'ID of user'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of saved address to update'
+              key :required, true
+              key :type, :string
+            end
+
+            response 204 do
+              key :description, 'Saved address removed successfully'
+            end
+
+            response 404 do
+              key :description, 'User or saved address not found'
+              schema do
+                key :type, :object
+                property :problem do
+                  key :type, :string
+                end
+                property :params do
+                  key :type, :object
+                  key :additionalProperties, true
+                end
+              end
+            end
+          end
+        end
+
+        def update
+          @saved_address.update_attributes!(params[:saved_address])
+          respond_with saved_address: @saved_address
+        end
+
+        def destroy
+          @saved_address.destroy
+          head :no_content
+        end
+
+        private
+
+        def find_user
+          @user = User.find(params[:user_id])
+        end
+
+        def find_saved_address
+          @saved_address = @user.addresses.find(params[:id])
+        end
+      end
+    end
+  end
+end