workarea-api 4.4.6

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

@@ -0,0 +1,299 @@
+module Workarea
+  module Api
+    module Admin
+      class ShippingServicesController < Admin::ApplicationController
+        before_action :find_shipping_service, except: [:index, :create, :bulk]
+
+        swagger_path '/shipping_services' do
+          operation :get do
+            key :summary, 'All Shipping Services'
+            key :description, 'Returns all shipping services from the system'
+            key :operationId, 'listShippingServices'
+            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, 'Shipping services'
+              schema do
+                key :type, :object
+                property :shipping_services do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Shipping::Service'
+                  end
+                end
+              end
+            end
+          end
+
+          operation :post do
+            key :summary, 'Create Shipping Service'
+            key :description, 'Creates a new shipping service.'
+            key :operationId, 'addShippingService'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Shipping service to add'
+              key :required, true
+              schema do
+                key :type, :object
+                property :shipping_service do
+                  key :'$ref', 'Workarea::Shipping::Service'
+                end
+              end
+            end
+
+            response 201 do
+              key :description, 'Shipping service created'
+              schema do
+                key :type, :object
+                property :shipping_service do
+                  key :'$ref', 'Workarea::Shipping::Service'
+                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::Shipping::Service'
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          @shipping_services = Shipping::Service
+                                .all
+                                .order_by(sort_field => sort_direction)
+                                .page(params[:page])
+
+          respond_with shipping_services: @shipping_services
+        end
+
+        def create
+          @shipping_service = Shipping::Service.create!(params[:shipping_service])
+          respond_with(
+            { shipping_service: @shipping_service },
+            { status: :created,
+            location: shipping_service_path(@shipping_service) }
+          )
+        end
+
+        swagger_path '/shipping_services/{id}' do
+          operation :get do
+            key :summary, 'Find Shipping Service by ID'
+            key :description, 'Returns a single shipping service'
+            key :operationId, 'showShippingService'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of shipping service to fetch'
+              key :required, true
+              key :type, :string
+            end
+
+            response 200 do
+              key :description, 'Shipping service details'
+              schema do
+                key :'$ref', 'Workarea::Shipping::Service'
+              end
+            end
+
+            response 404 do
+              key :description, 'Shipping service 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 Shipping Service'
+            key :description, 'Updates attributes on a shipping service'
+            key :operationId, 'updateShippingService'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of shipping service 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 :shipping_service do
+                  key :'$ref', 'Workarea::Shipping::Service'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Shipping service 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::Shipping::Service'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'Shipping service 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 Shipping Service'
+            key :description, 'Remove a shipping service'
+            key :operationId, 'removeShippingService'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of shipping service to remove'
+              key :required, true
+              key :type, :string
+            end
+
+            response 204 do
+              key :description, 'Shipping service removed successfully'
+            end
+
+            response 404 do
+              key :description, 'Shipping service 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 shipping_service: @shipping_service
+        end
+
+        def update
+          @shipping_service.update_attributes!(params[:shipping_service])
+          respond_with shipping_service: @shipping_service
+        end
+
+        swagger_path '/shipping_services/bulk' do
+          operation :patch do
+            key :summary, 'Bulk Upsert Shipping Services'
+            key :description, 'Creates new shipping services or updates existing ones in bulk.'
+            key :operationId, 'upsertShippingServices'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Array of shipping services to upsert'
+              key :required, true
+              schema do
+                key :type, :array
+                items do
+                  key :'$ref', 'Workarea::Shipping::Service'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Upsert received'
+            end
+          end
+        end
+
+        def bulk
+          @bulk = Api::Admin::BulkUpsert.create!(
+            klass: Shipping::Service,
+            data: params[:shipping_services].map(&:to_h)
+          )
+
+          head :no_content
+        end
+
+        def destroy
+          @shipping_service.destroy
+          head :no_content
+        end
+
+        private
+
+        def find_shipping_service
+          @shipping_service = Shipping::Service.find(params[:id])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+module Workarea
+  module Api
+    module Admin
+      class ShippingsController < Admin::ApplicationController
+        swagger_path '/shippings' do
+          operation :get do
+            key :summary, 'All Shippings'
+            key :description, 'Returns all shippings from the system'
+            key :operationId, 'listShippings'
+            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, 'Shippings'
+              schema do
+                key :type, :object
+                property :shippings do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Shipping'
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          @shippings = Shipping
+                          .all
+                          .order_by(sort_field => sort_direction)
+                          .page(params[:page])
+
+          respond_with shippings: @shippings
+        end
+
+        swagger_path '/shippings/{id}' do
+          operation :get do
+            key :summary, 'Find Shipping Service by ID'
+            key :description, 'Returns a single shipping'
+            key :operationId, 'showShipping'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of shipping to fetch'
+              key :required, true
+              key :type, :string
+            end
+
+            response 200 do
+              key :description, 'Shipping details'
+              schema do
+                key :'$ref', 'Workarea::Shipping'
+              end
+            end
+
+            response 404 do
+              key :description, 'Shipping 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
+          @shipping = Shipping.find(params[:id])
+          respond_with shipping: @shipping
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Workarea
+  module Api
+    module Admin
+      class SwaggerController < Admin::ApplicationController
+        include ::Swagger::Blocks
+
+        def index
+          controller = self
+          self.class.send(:swagger_root) do
+            key :swagger, '2.0'
+
+            info do
+              key :version, '1.0.0'
+              key :title, 'Workarea Admin'
+              key :description, 'A backend API for integrating and configuring Workarea'
+              key :termsOfService, 'https://workarea.com'
+              contact do
+                key :name, 'Workarea Product Team'
+              end
+            end
+
+            key :host, Workarea.config.host
+            key :basePath, controller.root_path[0..-2]
+            key :schemes, [Rails.application.config.force_ssl ? 'https' : 'http']
+            key :consumes, ['application/json']
+            key :produces, ['application/json']
+
+            security_definition :BasicAuth do
+              key :type, :basic
+            end
+            security do
+              key :BasicAuth, []
+            end
+          end
+
+          render json: ::Swagger::Blocks.build_root_json(Swagger.klasses)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,242 @@
+module Workarea
+  module Api
+    module Admin
+      class TaxCategoriesController < Admin::ApplicationController
+        before_action :find_tax_category, except: [:index, :create, :bulk]
+
+        swagger_path '/tax_categories' do
+          operation :get do
+            key :summary, 'All Tax Categories'
+            key :description, 'Returns all tax categories'
+            key :operationId, 'listTaxCategories'
+            key :produces, ['application/json']
+
+            response 200 do
+              key :description, 'Tax categories'
+              schema do
+                key :type, :object
+                property :tax_categories do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Tax::Category'
+                  end
+                end
+              end
+            end
+          end
+
+          operation :post do
+            key :summary, 'Create a tax category'
+            key :description, 'Creates a new taxable category.'
+            key :operationId, 'addTaxCategory'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Tax Category to add'
+              key :required, true
+              schema do
+                key :type, :object
+                property :tax_category do
+                  key :'$ref', 'Workarea::Tax::Category'
+                end
+              end
+            end
+
+            response 201 do
+              key :description, 'Tax category created'
+              schema do
+                key :type, :object
+                property :tax_category do
+                  key :'$ref', 'Workarea::Tax::Category'
+                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::Tax::Category'
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          @tax_categories = Tax::Category
+                                .all
+                                .order_by(sort_field => sort_direction)
+                                .page(params[:page])
+
+          respond_with tax_categories: @tax_categories
+        end
+
+        def create
+          @tax_category = Tax::Category.create!(params[:tax_category])
+          respond_with(
+            { tax_category: @tax_category },
+            { status: :created,
+            location: tax_category_path(@tax_category) }
+          )
+        end
+
+        swagger_path '/tax_categories/{id}' do
+          operation :patch do
+            key :summary, 'Update a tax category'
+            key :description, 'Updates attributes on a tax category'
+            key :operationId, 'updateTaxCategory'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of tax category 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 :tax_category do
+                  key :'$ref', 'Workarea::Tax::Category'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Tax category 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::Tax::Category'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'Tax category 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 Tax Category'
+            key :description, 'Remove a tax category'
+            key :operationId, 'removeTaxCategory'
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of tax category'
+              key :required, true
+              key :type, :string
+            end
+
+            response 204 do
+              key :description, 'Tax category removed successfully'
+            end
+
+            response 404 do
+              key :description, 'Tax category 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 tax_category: @tax_category
+        end
+
+        def update
+          @tax_category.update_attributes!(params[:tax_category])
+          respond_with tax_category: @tax_category
+        end
+
+        def destroy
+          @tax_category.destroy
+          head :no_content
+        end
+
+        swagger_path '/tax_categories/bulk' do
+          operation :patch do
+            key :summary, 'Bulk Upsert tax categories'
+            key :description, 'Creates new tax categories or updates existing ones in bulk.'
+            key :operationId, 'upsertTaxCategory'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :body
+              key :in, :body
+              key :description, 'Array of tax categories to upsert'
+              key :required, true
+              schema do
+                key :type, :object
+                property :tax_categories do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Tax::Category'
+                  end
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Upsert received'
+            end
+          end
+        end
+
+        def bulk
+          @bulk = Api::Admin::BulkUpsert.create!(
+            klass: Tax::Category,
+            data: params[:tax_categories].map(&:to_h)
+          )
+
+          head :no_content
+        end
+
+        private
+
+        def find_tax_category
+          @tax_category = Tax::Category.find(params[:id])
+        end
+      end
+    end
+  end
+end