workarea-api-admin 4.4.6

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

@@ -0,0 +1,232 @@
+module Workarea
+  module Api
+    module Admin
+      class VariantsController < Admin::ApplicationController
+        before_action :find_product
+        before_action :find_variant, except: [:index, :create]
+
+        swagger_path '/products/{id}/variants' do
+          operation :get do
+            key :summary, 'All Product Variants'
+            key :description, 'Returns all variants for a product'
+            key :operationId, 'listProductVariants'
+            key :produces, ['application/json']
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'product ID'
+              key :required, true
+              key :type, :string
+            end
+
+            response 200 do
+              key :description, 'Product variants'
+              schema do
+                key :type, :object
+                property :variants do
+                  key :type, :array
+                  items do
+                    key :'$ref', 'Workarea::Catalog::Variant'
+                  end
+                end
+              end
+            end
+          end
+
+          operation :post do
+            key :summary, 'Create Product Variant'
+            key :description, 'Creates a new produt variant'
+            key :operationId, 'addProductVariant'
+            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, 'Variant to add'
+              key :required, true
+              schema do
+                key :type, :object
+                property :variant do
+                  key :'$ref', 'Workarea::Catalog::Variant'
+                end
+              end
+            end
+
+            response 201 do
+              key :description, 'Variant created'
+              schema do
+                key :type, :object
+                property :variant do
+                  key :'$ref', 'Workarea::Catalog::Variant'
+                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::Catalog::Variant'
+                end
+              end
+            end
+          end
+        end
+
+        def index
+          respond_with variants: @product.variants
+        end
+
+        def create
+          @variant = @product.variants.create!(params[:variant])
+          respond_with(
+            { variant: @variant },
+            { status: :created,
+            location: product_variants_path(@product) }
+          )
+        end
+
+        swagger_path '/products/{product_id}/variants/{id}' do
+          operation :patch do
+            key :summary, 'Update a product variant'
+            key :description, 'Updates attributes on a product variant'
+            key :operationId, 'updateProductVariant'
+
+            parameter do
+              key :name, :product_id
+              key :in, :path
+              key :description, 'ID of product'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of variant 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 :variant do
+                  key :'$ref', 'Workarea::Catalog::Variant'
+                end
+              end
+            end
+
+            response 204 do
+              key :description, 'Variant 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::Catalog::Variant'
+                end
+              end
+            end
+
+            response 404 do
+              key :description, 'Product or variant 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 Product Variant'
+            key :description, 'Remove a product variant'
+            key :operationId, 'removeProductVariant'
+
+            parameter do
+              key :name, :product_id
+              key :in, :path
+              key :description, 'ID of product'
+              key :required, true
+              key :type, :string
+            end
+
+            parameter do
+              key :name, :id
+              key :in, :path
+              key :description, 'ID of variant to remove'
+              key :required, true
+              key :type, :string
+            end
+
+            response 204 do
+              key :description, 'Variant removed successfully'
+            end
+
+            response 404 do
+              key :description, 'Product or variant 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
+          @variant.update_attributes!(params[:variant])
+          respond_with variant: @variant
+        end
+
+        def destroy
+          @variant.destroy
+          head :no_content
+        end
+
+        private
+
+        def find_product
+          @product = Catalog::Product.find(params[:product_id])
+        end
+
+        def find_variant
+          @variant = @product.variants.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/api/admin/bulk_upsert.rb

@@ -0,0 +1,74 @@
+module Workarea
+  module Api
+    module Admin
+      class BulkUpsert
+        include ApplicationDocument
+
+        field :klass, type: String
+        field :data, type: Array, default: []
+        field :data_errors, type: Hash, default: {}
+        field :started_at, type: DateTime
+        field :completed_at, type: DateTime
+
+        validates :data,
+          presence: true,
+          length: {
+            maximum: Workarea.config.max_api_bulk_data_size,
+            message: I18n.t('workarea.api.admin.bulk_upserts.data_too_large')
+          }
+
+        validate :model_validity
+
+        def perform!
+          update_attribute(:started_at, Time.now)
+
+          data.each_with_index do |attrs, i|
+            instance = find_updated_model_for(attrs)
+            instance.save
+
+            if instance.errors.present?
+              data_errors[i.to_s] = instance.errors.as_json
+            end
+          end
+
+          if data_errors.blank?
+            destroy!
+          else
+            self.completed_at = Time.now
+            save!(validate: false)
+          end
+        end
+
+        def model_class
+          @model_class ||= klass.constantize
+        end
+
+        private
+
+        def model_validity
+          data.each_with_index do |attrs, i|
+            instance = find_updated_model_for(attrs)
+
+            next if instance.valid?
+            instance.errors.full_messages.each do |message|
+              errors.add(i.to_s, message)
+            end
+          end
+        end
+
+        def find_updated_model_for(attrs)
+          id = attrs['_id'].presence || attrs['id'].presence ||
+                 attrs[:_id].presence || attrs[:id]
+
+          if id.present?
+            result = model_class.find_or_initialize_by(id: id)
+            result.attributes = attrs
+            result
+          else
+            model_class.new(attrs)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/user.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate User, with: 'admin_api' do
+    decorated do
+      field :api_access, type: Boolean, default: false
+    end
+  end
+end

data/app/views/workarea/admin/users/_api_permissions.html.haml

@@ -0,0 +1,6 @@
+.grid__cell.grid__cell--50
+  .property
+    = check_box :user, :api_access
+    = label_tag 'user_api_access', class: 'property__name' do
+      = inline_svg('workarea/api/admin/icons/api.svg', class: 'svg-icon')
+      %span= t('workarea.api.admin.users.permissions.api')

data/app/workers/workarea/perform_api_bulk_upsert.rb

@@ -0,0 +1,15 @@
+module Workarea
+  class PerformApiBulkUpsert
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: { Api::Admin::BulkUpsert => :create },
+      retry: false
+    )
+
+    def perform(id)
+      Api::Admin::BulkUpsert.find(id).perform!
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/api/admin/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/append_points.rb

@@ -0,0 +1,4 @@
+Workarea::Plugin.append_partials(
+  'admin.user_permissions',
+  'workarea/admin/users/api_permissions'
+)

data/config/initializers/config.rb

@@ -0,0 +1,15 @@
+Workarea.config.permissions_fields << 'api_access'
+Workarea.config.max_api_bulk_data_size ||= 1_000
+Workarea.config.api_admin_ignore_definitions ||= [
+  /^Workarea::Metrics/,
+  /^Workarea::Insights/,
+  /^Workarea::Reports/,
+  /^Workarea::BulkAction/,
+  /^Workarea::Help/,
+  /Workarea::User::AdminBookmark/,
+  /Workarea::User::RecentPassword/,
+  /Workarea::User::PasswordReset/,
+  /Workarea::User::AuthenticationToken/,
+  /Workarea::Api::Admin::BulkUpsert/,
+  /Workarea::User::AdminVisit/
+]

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  workarea:
+    api:
+      admin:
+        users:
+          permissions:
+            api: API
+        bulk_upserts:
+          data_too_large: has too many objects

data/config/routes.rb

@@ -0,0 +1,81 @@
+Workarea::Api::Admin::Engine.routes.draw do
+  basic_crud = [:index, :create, :show, :update, :destroy]
+  embedded_crud = basic_crud - [:show]
+  read_only = basic_crud - [:create, :update, :destroy]
+
+  get '/', to: 'application#root', as: :root # hack because Rails doesn't have a way to get engine root path
+  get '/swagger', to: 'swagger#index'
+
+  resources :content_assets, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :categories, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :product_rules, only: embedded_crud, controller: 'category_product_rules'
+  end
+  resources :content, only: basic_crud - [:destroy] do
+    collection { patch 'bulk' }
+  end
+  resources :discounts, only: basic_crud
+  resources :email_shares, only: read_only
+  resources :email_signups, only: read_only
+  resources :fulfillments, only: read_only do
+    member do
+      post 'ship_items'
+      post 'cancel_items'
+    end
+  end
+  resources :inventory_skus, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :navigation_taxons, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :navigation_menus, only: basic_crud
+  resources :orders, only: read_only
+  resources :pages, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :payments, only: read_only
+  resources :payment_profiles, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :saved_credit_cards, only: basic_crud do
+      collection { patch 'bulk' }
+    end
+  end
+  resources :payment_transactions, only: read_only
+  resources :pricing_skus, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :prices, only: embedded_crud
+  end
+  resources :products, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :variants, only: embedded_crud
+    resources :images, only: embedded_crud, controller: 'product_images'
+    resource :recommendation_settings, only: [:show, :update]
+  end
+  resources :promo_code_lists, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :redirects, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :releases, only: basic_crud do
+    collection { patch 'bulk' }
+  end
+  resources :shippings, only: read_only
+  resources :shipping_services, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :rates, only: embedded_crud, controller: 'shipping_rates'
+  end
+  resources :tax_categories, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :rates, only: basic_crud, controller: 'tax_rates' do
+      collection { patch 'bulk' }
+    end
+  end
+  resources :users, only: basic_crud do
+    collection { patch 'bulk' }
+    resources :saved_addresses, only: embedded_crud
+  end
+end