harpiya_api 4.3.0.alpha

data/app/controllers/harpiya/api/v2/storefront/checkout_controller.rb

@@ -0,0 +1,136 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class CheckoutController < ::Harpiya::Api::V2::BaseController
+          include Harpiya::Api::V2::Storefront::OrderConcern
+          before_action :ensure_order
+
+          def next
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = next_service.call(order: harpiya_current_order)
+
+            render_order(result)
+          end
+
+          def advance
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = advance_service.call(order: harpiya_current_order)
+
+            render_order(result)
+          end
+
+          def complete
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = complete_service.call(order: harpiya_current_order)
+
+            render_order(result)
+          end
+
+          def update
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = update_service.call(
+              order: harpiya_current_order,
+              params: params,
+              # defined in https://github.com/harpiya/harpiya/blob/master/core/lib/harpiya/core/controller_helpers/strong_parameters.rb#L19
+              permitted_attributes: permitted_checkout_attributes,
+              request_env: request.headers.env
+            )
+
+            render_order(result)
+          end
+
+          def add_store_credit
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = add_store_credit_service.call(
+              order: harpiya_current_order,
+              amount: params[:amount].try(:to_f)
+            )
+
+            render_order(result)
+          end
+
+          def remove_store_credit
+            harpiya_authorize! :update, harpiya_current_order, order_token
+
+            result = remove_store_credit_service.call(order: harpiya_current_order)
+            render_order(result)
+          end
+
+          def shipping_rates
+            result = shipping_rates_service.call(order: harpiya_current_order)
+
+            if result.success?
+              render_serialized_payload { serialize_shipping_rates(result.value) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          def payment_methods
+            render_serialized_payload { serialize_payment_methods(harpiya_current_order.available_payment_methods) }
+          end
+
+          private
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_cart_serializer.constantize
+          end
+
+          def next_service
+            Harpiya::Api::Dependencies.storefront_checkout_next_service.constantize
+          end
+
+          def advance_service
+            Harpiya::Api::Dependencies.storefront_checkout_advance_service.constantize
+          end
+
+          def add_store_credit_service
+            Harpiya::Api::Dependencies.storefront_checkout_add_store_credit_service.constantize
+          end
+
+          def remove_store_credit_service
+            Harpiya::Api::Dependencies.storefront_checkout_remove_store_credit_service.constantize
+          end
+
+          def complete_service
+            Harpiya::Api::Dependencies.storefront_checkout_complete_service.constantize
+          end
+
+          def update_service
+            Harpiya::Api::Dependencies.storefront_checkout_update_service.constantize
+          end
+
+          def payment_methods_serializer
+            Harpiya::Api::Dependencies.storefront_payment_method_serializer.constantize
+          end
+
+          def shipping_rates_service
+            Harpiya::Api::Dependencies.storefront_checkout_get_shipping_rates_service.constantize
+          end
+
+          def shipping_rates_serializer
+            Harpiya::Api::Dependencies.storefront_shipment_serializer.constantize
+          end
+
+          def serialize_payment_methods(payment_methods)
+            payment_methods_serializer.new(payment_methods, params: serializer_params).serializable_hash
+          end
+
+          def serialize_shipping_rates(shipments)
+            shipping_rates_serializer.new(
+              shipments,
+              params: serializer_params,
+              include: [:shipping_rates, :stock_location]
+            ).serializable_hash
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/countries_controller.rb

@@ -0,0 +1,50 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class CountriesController < ::Harpiya::Api::V2::ResourceController
+          private
+
+          def serialize_collection(collection)
+            collection_serializer.new(
+              collection,
+              collection_options(collection).merge(params: collection_serializer_params)
+            ).serializable_hash
+          end
+
+          def serializer_params
+            super.merge(include_states: true)
+          end
+
+          def collection_serializer_params
+            serializer_params.merge(include_states: false)
+          end
+
+          def resource
+            return scope.default if params[:iso] == 'default'
+
+            scope.find_by(iso: params[:iso]&.upcase) ||
+              scope.find_by(id: params[:iso]&.upcase) ||
+              scope.find_by(iso3: params[:iso]&.upcase)
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_country_serializer.constantize
+          end
+
+          def collection_serializer
+            Harpiya::Api::Dependencies.storefront_country_serializer.constantize
+          end
+
+          def collection_finder
+            Harpiya::Api::Dependencies.storefront_country_finder.constantize
+          end
+
+          def model_class
+            Harpiya::Country
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/menus_controller.rb

@@ -0,0 +1,42 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class MenusController < ::Harpiya::Api::V2::ResourceController
+          private
+
+          def serialize_collection(collection)
+            collection_serializer.new(
+              collection,
+              collection_options(collection).merge(params: serializer_params)
+            ).serializable_hash
+          end
+
+          def resource
+            @resource ||= scope.find_by(location: params[:location])
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_menu_serializer.constantize
+          end
+
+          def collection_serializer
+            Harpiya::Api::Dependencies.storefront_menu_serializer.constantize
+          end
+
+          def collection_finder
+            Harpiya::Api::Dependencies.storefront_menu_finder.constantize
+          end
+
+          def model_class
+            Harpiya::Menu
+          end
+
+          def scope
+            super.by_store(current_store).by_locale(I18n.locale)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/order_status_controller.rb

@@ -0,0 +1,34 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class OrderStatusController < ::Harpiya::Api::V2::ResourceController
+          include Harpiya::Api::V2::Storefront::OrderConcern
+
+          before_action :ensure_order_token
+
+          private
+
+          def resource
+            resource = resource_finder.new(number: params[:number], token: order_token).execute.take
+            raise ActiveRecord::RecordNotFound if resource.nil?
+
+            resource
+          end
+
+          def resource_finder
+            Harpiya::Api::Dependencies.storefront_completed_order_finder.constantize
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_cart_serializer.constantize
+          end
+
+          def ensure_order_token
+            raise ActiveRecord::RecordNotFound unless order_token.present?
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/products_controller.rb

@@ -0,0 +1,55 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class ProductsController < ::Harpiya::Api::V2::ResourceController
+          private
+
+          def sorted_collection
+            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
+          end
+
+          def collection
+            @collection ||= collection_finder.new(scope: scope, params: params, current_currency: current_currency).execute
+          end
+
+          def resource
+            @resource ||= scope.find_by(slug: params[:id]) || scope.find(params[:id])
+          end
+
+          def collection_sorter
+            Harpiya::Api::Dependencies.storefront_products_sorter.constantize
+          end
+
+          def collection_finder
+            Harpiya::Api::Dependencies.storefront_products_finder.constantize
+          end
+
+          def collection_serializer
+            Harpiya::Api::Dependencies.storefront_product_serializer.constantize
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_product_serializer.constantize
+          end
+
+          def model_class
+            Harpiya::Product
+          end
+
+          def scope_includes
+            {
+              master: :default_price,
+              variants: [],
+              variant_images: [],
+              taxons: [],
+              product_properties: :property,
+              option_types: :option_values,
+              variants_including_master: %i[default_price option_values]
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/stores_controller.rb

@@ -0,0 +1,23 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class StoresController < ::Harpiya::Api::V2::ResourceController
+          private
+
+          def model_class
+            Harpiya::Store
+          end
+
+          def resource
+            @resource ||= scope.find_by!(code: params[:code])
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_store_serializer.constantize
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/harpiya/api/v2/storefront/taxons_controller.rb

@@ -0,0 +1,47 @@
+module Harpiya
+  module Api
+    module V2
+      module Storefront
+        class TaxonsController < ::Harpiya::Api::V2::ResourceController
+          private
+
+          def collection_serializer
+            Harpiya::Api::Dependencies.storefront_taxon_serializer.constantize
+          end
+
+          def resource_serializer
+            Harpiya::Api::Dependencies.storefront_taxon_serializer.constantize
+          end
+
+          def collection_finder
+            Harpiya::Api::Dependencies.storefront_taxon_finder.constantize
+          end
+
+          def paginated_collection
+            @paginated_collection ||= collection_paginator.new(collection, params).call
+          end
+
+          def resource
+            @resource ||= scope.find_by(permalink: params[:id]) || scope.find(params[:id])
+          end
+
+          def model_class
+            Harpiya::Taxon
+          end
+
+          def scope_includes
+            node_includes = %i[icon products parent taxonomy]
+
+            {
+              parent: node_includes,
+              children: node_includes,
+              taxonomy: [root: node_includes],
+              products: [],
+              icon: [attachment_attachment: :blob]
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/harpiya/api/api_helpers.rb

@@ -0,0 +1,190 @@
+module Harpiya
+  module Api
+    module ApiHelpers
+      ATTRIBUTES = [
+        :product_attributes,
+        :product_property_attributes,
+        :variant_attributes,
+        :image_attributes,
+        :option_value_attributes,
+        :order_attributes,
+        :line_item_attributes,
+        :option_type_attributes,
+        :payment_attributes,
+        :payment_method_attributes,
+        :shipment_attributes,
+        :taxonomy_attributes,
+        :taxon_attributes,
+        :address_attributes,
+        :country_attributes,
+        :state_attributes,
+        :adjustment_attributes,
+        :inventory_unit_attributes,
+        :return_authorization_attributes,
+        :creditcard_attributes,
+        :payment_source_attributes,
+        :user_attributes,
+        :property_attributes,
+        :stock_location_attributes,
+        :stock_movement_attributes,
+        :stock_item_attributes,
+        :promotion_attributes,
+        :store_attributes,
+        :tag_attributes,
+        :customer_return_attributes,
+        :reimbursement_attributes
+      ]
+
+      mattr_reader *ATTRIBUTES
+
+      def required_fields_for(model)
+        required_fields = model._validators.select do |_field, validations|
+          validations.any? { |v| v.is_a?(ActiveModel::Validations::PresenceValidator) }
+        end.map(&:first) # get fields that are invalid
+        # Permalinks presence is validated, but are really automatically generated
+        # Therefore we shouldn't tell API clients that they MUST send one through
+        required_fields.map!(&:to_s).delete('permalink')
+        # Do not require slugs, either
+        required_fields.delete('slug')
+        required_fields
+      end
+
+      @@product_attributes = [
+        :id, :name, :description, :price, :display_price, :available_on,
+        :slug, :meta_description, :meta_keywords, :shipping_category_id,
+        :taxon_ids, :total_on_hand
+      ]
+
+      @@product_property_attributes = [
+        :id, :product_id, :property_id, :value, :property_name
+      ]
+
+      @@variant_attributes = [
+        :id, :name, :sku, :price, :weight, :height, :width, :depth, :is_master,
+        :slug, :description, :track_inventory
+      ]
+
+      @@image_attributes = [
+        :id, :position, :attachment_content_type, :attachment_file_name, :type,
+        :attachment_updated_at, :attachment_width, :attachment_height, :alt
+      ]
+
+      @@option_value_attributes = [
+        :id, :name, :presentation, :option_type_name, :option_type_id,
+        :option_type_presentation
+      ]
+
+      @@order_attributes = [
+        :id, :number, :item_total, :total, :ship_total, :state, :adjustment_total,
+        :user_id, :created_at, :updated_at, :completed_at, :payment_total,
+        :shipment_state, :payment_state, :email, :special_instructions, :channel,
+        :included_tax_total, :additional_tax_total, :display_included_tax_total,
+        :display_additional_tax_total, :tax_total, :currency, :considered_risky,
+        :canceler_id
+      ]
+
+      @@line_item_attributes = [:id, :quantity, :price, :variant_id]
+
+      @@option_type_attributes = [:id, :name, :presentation, :position]
+
+      @@payment_attributes = [
+        :id, :source_type, :source_id, :amount, :display_amount,
+        :payment_method_id, :state, :avs_response, :created_at,
+        :updated_at, :number
+      ]
+
+      @@payment_method_attributes = [:id, :name, :description]
+
+      @@shipment_attributes = [:id, :tracking, :number, :cost, :shipped_at, :state]
+
+      @@taxonomy_attributes = [:id, :name]
+
+      @@taxon_attributes = [
+        :id, :name, :pretty_name, :permalink, :parent_id,
+        :taxonomy_id, :meta_title, :meta_description
+      ]
+
+      @@inventory_unit_attributes = [
+        :id, :lock_version, :state, :variant_id, :shipment_id,
+        :return_authorization_id
+      ]
+
+      @@return_authorization_attributes = [
+        :id, :number, :state, :order_id, :memo, :created_at, :updated_at
+      ]
+
+      @@address_attributes = [
+        :id, :firstname, :lastname, :full_name, :address1, :address2, :city,
+        :zipcode, :phone, :company, :alternative_phone, :country_id, :state_id,
+        :label, :state_name, :state_text
+      ]
+
+      @@country_attributes = [:id, :iso_name, :iso, :iso3, :name, :numcode]
+
+      @@state_attributes = [:id, :name, :abbr, :country_id]
+
+      @@adjustment_attributes = [
+        :id, :source_type, :source_id, :adjustable_type, :adjustable_id,
+        :originator_type, :originator_id, :amount, :label, :mandatory,
+        :locked, :eligible, :created_at, :updated_at
+      ]
+
+      @@creditcard_attributes = [
+        :id, :month, :year, :cc_type, :last_digits, :name,
+        :gateway_customer_profile_id, :gateway_payment_profile_id
+      ]
+
+      @@payment_source_attributes = [
+        :id, :month, :year, :cc_type, :last_digits, :name
+      ]
+
+      @@user_attributes = [:id, :email, :created_at, :updated_at]
+
+      @@property_attributes = [:id, :name, :presentation]
+
+      @@stock_location_attributes = [
+        :id, :name, :address1, :address2, :city, :state_id, :state_name,
+        :country_id, :zipcode, :phone, :active
+      ]
+
+      @@stock_movement_attributes = [:id, :quantity, :stock_item_id]
+
+      @@stock_item_attributes = [
+        :id, :count_on_hand, :backorderable, :lock_version, :stock_location_id,
+        :variant_id
+      ]
+
+      @@promotion_attributes = [
+        :id, :name, :description, :expires_at, :starts_at, :type, :usage_limit,
+        :match_policy, :code, :advertise, :path
+      ]
+
+      @@store_attributes = [
+        :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
+        :mail_from_address, :customer_support_email, :default_currency,
+        :code, :default, :facebook, :twitter, :instagram,
+        :supported_currencies, :default_locale, :supported_locales
+      ]
+
+      @@tag_attributes = [:id, :name]
+
+      @@customer_return_attributes = [
+        :id, :number, :order_id, :fully_reimbursed?, :pre_tax_total,
+        :created_at, :updated_at
+      ]
+
+      @@reimbursement_attributes = [
+        :id, :reimbursement_status, :customer_return_id, :order_id,
+        :number, :total, :created_at, :updated_at
+      ]
+
+      def variant_attributes
+        if @current_user_roles&.include?('admin')
+          @@variant_attributes + [:cost_price]
+        else
+          @@variant_attributes
+        end
+      end
+    end
+  end
+end