harpiya_api 4.3.0.alpha

data/app/helpers/harpiya/api/v2/collection_options_helpers.rb

@@ -0,0 +1,46 @@
+module Harpiya
+  module Api
+    module V2
+      module CollectionOptionsHelpers
+        def collection_links(collection)
+          {
+            self: request.original_url,
+            next: pagination_url(collection.next_page || collection.total_pages),
+            prev: pagination_url(collection.prev_page || 1),
+            last: pagination_url(collection.total_pages),
+            first: pagination_url(1)
+          }
+        end
+
+        def collection_meta(collection)
+          {
+            count: collection.size,
+            total_count: collection.total_count,
+            total_pages: collection.total_pages
+          }
+        end
+
+        # leaving this method in public scope so it's still possible to modify
+        # those params to support non-standard non-JSON API parameters
+        def collection_permitted_params
+          params.permit(:format, :page, :per_page, :sort, :include, :fields, filter: {})
+        end
+
+        private
+
+        def pagination_url(page)
+          url_for(collection_permitted_params.merge(page: page))
+        end
+
+        def collection_options(collection)
+          {
+            links: collection_links(collection),
+            meta: collection_meta(collection),
+            include: resource_includes,
+            fields: sparse_fields
+          }
+        end
+      end
+    end
+  end
+end

data/app/helpers/harpiya/api/v2/display_money_helper.rb

@@ -0,0 +1,43 @@
+module Harpiya
+  module Api
+    module V2
+      module DisplayMoneyHelper
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def find_price(product_or_variant, currency)
+            product_or_variant.price_in(currency)
+          end
+
+          def price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            format('%.2f', price.amount)
+          end
+
+          def display_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            Harpiya::Money.new(price.amount, currency: currency).to_s
+          end
+
+          def compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            format('%.2f', price.compare_at_amount)
+          end
+
+          def display_compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            Harpiya::Money.new(price.compare_at_amount, currency: currency).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/harpiya/user_api_authentication.rb

@@ -0,0 +1,19 @@
+module Harpiya
+  module UserApiAuthentication
+    def generate_harpiya_api_key!
+      self.harpiya_api_key = generate_harpiya_api_key
+      save!
+    end
+
+    def clear_harpiya_api_key!
+      self.harpiya_api_key = nil
+      save!
+    end
+
+    private
+
+    def generate_harpiya_api_key
+      SecureRandom.hex(24)
+    end
+  end
+end

data/app/models/concerns/harpiya/user_api_methods.rb

@@ -0,0 +1,7 @@
+module Harpiya
+  module UserApiMethods
+    extend ActiveSupport::Concern
+
+    include Harpiya::UserApiAuthentication
+  end
+end

data/app/models/harpiya/api_configuration.rb

@@ -0,0 +1,8 @@
+module Harpiya
+  class ApiConfiguration < Preferences::Configuration
+    preference :requires_authentication, :boolean, default: true
+    preference :api_v2_cache_ttl, :integer, default: 3600 # 1 hour in seconds
+    preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
+    preference :api_v2_per_page_limit, :integer, default: 100
+  end
+end

data/app/models/harpiya/api_dependencies.rb

@@ -0,0 +1,98 @@
+module Harpiya
+  class ApiDependencies
+    include Harpiya::DependenciesHelper
+
+    INJECTION_POINTS = [
+      :storefront_cart_create_service, :storefront_cart_add_item_service, :storefront_cart_remove_line_item_service,
+      :storefront_cart_remove_item_service, :storefront_cart_set_item_quantity_service, :storefront_cart_recalculate_service,
+      :storefront_cart_update, :storefront_coupon_handler, :storefront_checkout_next_service, :storefront_checkout_advance_service,
+      :storefront_checkout_update_service, :storefront_checkout_complete_service, :storefront_checkout_add_store_credit_service,
+      :storefront_checkout_remove_store_credit_service, :storefront_checkout_get_shipping_rates_service,
+      :storefront_cart_compare_line_items_service, :storefront_cart_serializer, :storefront_credit_card_serializer,
+      :storefront_credit_card_finder, :storefront_shipment_serializer, :storefront_payment_method_serializer, :storefront_country_finder,
+      :storefront_country_serializer, :storefront_menu_serializer, :storefront_menu_finder, :storefront_current_order_finder,
+      :storefront_completed_order_finder, :storefront_order_sorter, :storefront_collection_paginator, :storefront_user_serializer,
+      :storefront_products_sorter, :storefront_products_finder, :storefront_product_serializer, :storefront_taxon_serializer,
+      :storefront_taxon_finder, :storefront_find_by_variant_finder, :storefront_cart_update_service,
+      :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
+      :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
+      :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,
+      :storefront_account_create_service, :storefront_account_update_service, :storefront_collection_sorter, :error_handler
+    ].freeze
+
+    attr_accessor *INJECTION_POINTS
+
+    def initialize
+      set_storefront_defaults
+    end
+
+    private
+
+    def set_storefront_defaults
+      # cart services
+      @storefront_cart_create_service = Harpiya::Dependencies.cart_create_service
+      @storefront_cart_add_item_service = Harpiya::Dependencies.cart_add_item_service
+      @storefront_cart_compare_line_items_service = Harpiya::Dependencies.cart_compare_line_items_service
+      @storefront_cart_update_service = Harpiya::Dependencies.cart_update_service
+      @storefront_cart_remove_line_item_service = Harpiya::Dependencies.cart_remove_line_item_service
+      @storefront_cart_remove_item_service = Harpiya::Dependencies.cart_remove_item_service
+      @storefront_cart_set_item_quantity_service = Harpiya::Dependencies.cart_set_item_quantity_service
+      @storefront_cart_recalculate_service = Harpiya::Dependencies.cart_recalculate_service
+      @storefront_cart_estimate_shipping_rates_service = Harpiya::Dependencies.cart_estimate_shipping_rates_service
+
+      # coupon code handler
+      @storefront_coupon_handler = Harpiya::Dependencies.coupon_handler
+
+      # checkout services
+      @storefront_checkout_next_service = Harpiya::Dependencies.checkout_next_service
+      @storefront_checkout_advance_service = Harpiya::Dependencies.checkout_advance_service
+      @storefront_checkout_update_service = Harpiya::Dependencies.checkout_update_service
+      @storefront_checkout_complete_service = Harpiya::Dependencies.checkout_complete_service
+      @storefront_checkout_add_store_credit_service = Harpiya::Dependencies.checkout_add_store_credit_service
+      @storefront_checkout_remove_store_credit_service = Harpiya::Dependencies.checkout_remove_store_credit_service
+      @storefront_checkout_get_shipping_rates_service = Harpiya::Dependencies.checkout_get_shipping_rates_service
+
+      # account services
+      @storefront_account_create_service = Harpiya::Dependencies.account_create_service
+      @storefront_account_update_service = Harpiya::Dependencies.account_update_service
+      @storefront_account_create_address_service = Harpiya::Dependencies.account_create_address_service
+      @storefront_account_update_address_service = Harpiya::Dependencies.account_update_address_service
+
+      # serializers
+      @storefront_address_serializer = 'Harpiya::V2::Storefront::AddressSerializer'
+      @storefront_cart_serializer = 'Harpiya::V2::Storefront::CartSerializer'
+      @storefront_credit_card_serializer = 'Harpiya::V2::Storefront::CreditCardSerializer'
+      @storefront_country_serializer = 'Harpiya::V2::Storefront::CountrySerializer'
+      @storefront_menu_serializer = 'Harpiya::V2::Storefront::MenuSerializer'
+      @storefront_user_serializer = 'Harpiya::V2::Storefront::UserSerializer'
+      @storefront_shipment_serializer = 'Harpiya::V2::Storefront::ShipmentSerializer'
+      @storefront_taxon_serializer = 'Harpiya::V2::Storefront::TaxonSerializer'
+      @storefront_payment_method_serializer = 'Harpiya::V2::Storefront::PaymentMethodSerializer'
+      @storefront_product_serializer = 'Harpiya::V2::Storefront::ProductSerializer'
+      @storefront_estimated_shipment_serializer = 'Harpiya::V2::Storefront::EstimatedShippingRateSerializer'
+      @storefront_store_serializer = 'Harpiya::V2::Storefront::StoreSerializer'
+      @storefront_order_serializer = 'Harpiya::V2::Storefront::CartSerializer'
+
+      # sorters
+      @storefront_collection_sorter = Harpiya::Dependencies.collection_sorter
+      @storefront_order_sorter = Harpiya::Dependencies.collection_sorter
+      @storefront_products_sorter = Harpiya::Dependencies.products_sorter
+
+      # paginators
+      @storefront_collection_paginator = Harpiya::Dependencies.collection_paginator
+
+      # finders
+      @storefront_address_finder = Harpiya::Dependencies.address_finder
+      @storefront_country_finder = Harpiya::Dependencies.country_finder
+      @storefront_menu_finder = Harpiya::Dependencies.menu_finder
+      @storefront_current_order_finder = Harpiya::Dependencies.current_order_finder
+      @storefront_completed_order_finder = Harpiya::Dependencies.completed_order_finder
+      @storefront_credit_card_finder = Harpiya::Dependencies.credit_card_finder
+      @storefront_find_by_variant_finder = Harpiya::Dependencies.line_item_by_variant_finder
+      @storefront_products_finder = Harpiya::Dependencies.products_finder
+      @storefront_taxon_finder = Harpiya::Dependencies.taxon_finder
+
+      @error_handler = 'Harpiya::Api::ErrorHandler'
+    end
+  end
+end

data/app/serializers/concerns/harpiya/api/v2/resource_serializer_concern.rb

@@ -0,0 +1,16 @@
+module Harpiya
+  module Api
+    module V2
+      module ResourceSerializerConcern
+        extend ActiveSupport::Concern
+
+        def self.included(base)
+          model_klazz = "Harpiya::#{base.to_s.demodulize.gsub(/Serializer/, '')}".constantize
+
+          base.set_type model_klazz.json_api_type
+          base.attributes(*model_klazz.json_api_columns)
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/base_serializer.rb

@@ -0,0 +1,32 @@
+module Harpiya
+  module Api
+    module V2
+      class BaseSerializer
+        include JSONAPI::Serializer
+
+        # to learn more about caching, please refer to:
+        # https://github.com/jsonapi-serializer/jsonapi-serializer#caching
+        # https://guides.rubyonrails.org/caching_with_rails.html#low-level-caching
+        cache_options(store: Rails.cache, namespace: 'jsonapi-serializer', expires_in: Harpiya::Api::Config[:api_v2_cache_ttl])
+
+        def self.record_cache_options(options, fieldset, include_list, params)
+          opts = options.dup
+
+          params_cache_key = params.map do |param|
+            next if param.nil? || param.last.nil?
+
+            if param.last.respond_to?(:cache_key_with_version)
+              param.last.cache_key_with_version
+            else
+              param.last.to_s.downcase
+            end
+          end.compact.reject(&:blank?).join('-')
+
+          opts[:namespace] += "-#{params_cache_key}"
+
+          super(opts, fieldset, include_list, params)
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/address_serializer.rb

@@ -0,0 +1,15 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class AddressSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          belongs_to :country
+          belongs_to :state
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/base_serializer.rb

@@ -0,0 +1,10 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class BaseSerializer < ::Harpiya::Api::V2::BaseSerializer
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/country_serializer.rb

@@ -0,0 +1,13 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class CountrySerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          has_many :states
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/image_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class ImageSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/menu_item_serializer.rb

@@ -0,0 +1,22 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class MenuItemSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          has_one :image,
+                  object_method_name: :icon,
+                  id_method_name: :icon_id,
+                  record_type: :image,
+                  serializer: :image
+
+          belongs_to :menu
+          belongs_to :parent, record_type: :menu_item, serializer: :menu_item
+
+          has_many   :children, record_type: :menu_item, serializer: :menu_item
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/menu_serializer.rb

@@ -0,0 +1,14 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class MenuSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          belongs_to :store
+          has_many :menu_items
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/option_type_serializer.rb

@@ -0,0 +1,13 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class OptionTypeSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          has_many :option_values
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/option_value_serializer.rb

@@ -0,0 +1,13 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class OptionValueSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          belongs_to :option_type
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/product_property_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class ProductPropertySerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/api/v2/platform/product_serializer.rb

@@ -0,0 +1,28 @@
+module Harpiya
+  module Api
+    module V2
+      module Platform
+        class ProductSerializer < BaseSerializer
+          include ::Harpiya::Api::V2::ResourceSerializerConcern
+
+          has_many :variants
+          has_many :option_types
+          has_many :product_properties
+          has_many :taxons
+
+          has_many :images,
+                   object_method_name: :variant_images,
+                   id_method_name: :variant_image_ids,
+                   record_type: :image,
+                   serializer: :image
+
+          has_one  :default_variant,
+                   object_method_name: :default_variant,
+                   id_method_name: :default_variant_id,
+                   record_type: :variant,
+                   serializer: :variant
+        end
+      end
+    end
+  end
+end