harpiya_api 4.3.0.alpha

data/app/serializers/harpiya/v2/storefront/product_serializer.rb

@@ -0,0 +1,67 @@
+module Harpiya
+  module V2
+    module Storefront
+      class ProductSerializer < BaseSerializer
+        include ::Harpiya::Api::V2::DisplayMoneyHelper
+
+        set_type :product
+
+        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at
+
+        attribute :purchasable do |product|
+          product.purchasable?
+        end
+
+        attribute :in_stock do |product|
+          product.in_stock?
+        end
+
+        attribute :backorderable do |product|
+          product.backorderable?
+        end
+
+        attribute :available do |product|
+          product.available?
+        end
+
+        attribute :currency do |_product, params|
+          params[:currency]
+        end
+
+        attribute :price do |product, params|
+          price(product, params[:currency])
+        end
+
+        attribute :display_price do |product, params|
+          display_price(product, params[:currency])
+        end
+
+        attribute :compare_at_price do |product, params|
+          compare_at_price(product, params[:currency])
+        end
+
+        attribute :display_compare_at_price do |product, params|
+          display_compare_at_price(product, params[:currency])
+        end
+
+        has_many :variants
+        has_many :option_types
+        has_many :product_properties
+        has_many :taxons
+
+        # all images from all variants
+        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

data/app/serializers/harpiya/v2/storefront/promotion_serializer.rb

@@ -0,0 +1,12 @@
+module Harpiya
+  module V2
+    module Storefront
+      class PromotionSerializer < BaseSerializer
+        set_id     :promotion_id
+        set_type   :promotion
+
+        attributes :name, :description, :amount, :display_amount, :code
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/shipment_serializer.rb

@@ -0,0 +1,20 @@
+module Harpiya
+  module V2
+    module Storefront
+      class ShipmentSerializer < BaseSerializer
+        set_type :shipment
+
+        attributes :number, :final_price, :display_final_price,
+                   :state, :shipped_at, :tracking_url
+
+        attribute :free do |shipment|
+          shipment.free?
+        end
+
+        has_many :shipping_rates
+
+        belongs_to :stock_location
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/shipping_rate_serializer.rb

@@ -0,0 +1,16 @@
+module Harpiya
+  module V2
+    module Storefront
+      class ShippingRateSerializer < BaseSerializer
+        set_type :shipping_rate
+
+        attributes :name, :selected, :final_price, :display_final_price, :cost,
+                   :display_cost, :tax_amount, :display_tax_amount, :shipping_method_id
+
+        attribute :free do |shipping_rate|
+          shipping_rate.free?
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/state_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StateSerializer < BaseSerializer
+        set_type :state
+
+        attributes :abbr, :name
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/stock_location_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StockLocationSerializer < BaseSerializer
+        set_type :stock_location
+
+        attributes :name
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/store_credit_category_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StoreCreditCategorySerializer < BaseSerializer
+        set_type :store_credit_category
+
+        attributes :name
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/store_credit_event_serializer.rb

@@ -0,0 +1,15 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StoreCreditEventSerializer < BaseSerializer
+        set_type :store_credit_event
+
+        attributes :action, :amount, :user_total_amount, :created_at
+
+        attribute :order_number do |object|
+          object.order&.number
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/store_credit_serializer.rb

@@ -0,0 +1,17 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StoreCreditSerializer < BaseSerializer
+        set_type :store_credit
+
+        belongs_to :category, serializer: :store_credit_category
+        has_many :store_credit_events
+        belongs_to :credit_type,
+                   id_method_name: :type_id,
+                   serializer: :store_credit_type
+
+        attributes :amount, :amount_used, :created_at
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/store_credit_type_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StoreCreditTypeSerializer < BaseSerializer
+        set_type :store_credit_type
+
+        attributes :name
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/store_serializer.rb

@@ -0,0 +1,23 @@
+module Harpiya
+  module V2
+    module Storefront
+      class StoreSerializer < BaseSerializer
+        set_type :store
+
+        attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency, :default, :supported_currencies, :facebook,
+                   :twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
+                   :address, :contact_phone, :supported_locales
+
+        has_many :menus
+        has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
+
+        attribute :favicon_path do |store|
+          if store.favicon_image.attached?
+            url_helpers = Rails.application.routes.url_helpers
+            url_helpers.rails_representation_path(store.favicon, only_path: true)
+          end
+        end
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/taxon_image_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class TaxonImageSerializer < BaseSerializer
+        set_type   :taxon_image
+
+        attributes :viewable_type, :viewable_id, :styles
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/taxon_serializer.rb

@@ -0,0 +1,36 @@
+module Harpiya
+  module V2
+    module Storefront
+      class TaxonSerializer < BaseSerializer
+        set_type   :taxon
+
+        attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
+                   :meta_keywords, :left, :right, :position, :depth, :updated_at
+
+        attribute :is_root do |taxon|
+          taxon.root?
+        end
+
+        attribute :is_child do |taxon|
+          taxon.child?
+        end
+
+        attribute :is_leaf do |taxon|
+          taxon.leaf?
+        end
+
+        belongs_to :parent,   record_type: :taxon, serializer: :taxon
+        belongs_to :taxonomy, record_type: :taxonomy
+
+        has_many   :children, record_type: :taxon, serializer: :taxon
+        has_many   :products, record_type: :product
+
+        has_one    :image,
+                   object_method_name: :icon,
+                   id_method_name: :icon_id,
+                   record_type: :taxon_image,
+                   serializer: :taxon_image
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/taxonomy_serializer.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module V2
+    module Storefront
+      class TaxonomySerializer < BaseSerializer
+        set_type   :taxonomy
+
+        attributes :name, :position
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/user_serializer.rb

@@ -0,0 +1,31 @@
+module Harpiya
+  module V2
+    module Storefront
+      class UserSerializer < BaseSerializer
+        set_type :user
+
+        attributes :email
+
+        attribute :store_credits do |user|
+          user.total_available_store_credit
+        end
+
+        attribute :completed_orders do |object|
+          object.orders.complete.count
+        end
+
+        has_one :default_billing_address,
+          id_method_name: :bill_address_id,
+          object_method_name: :bill_address,
+          record_type: :address,
+          serializer: :address
+
+        has_one :default_shipping_address,
+          id_method_name: :ship_address_id,
+          object_method_name: :ship_address,
+          record_type: :address,
+          serializer: :address
+      end
+    end
+  end
+end

data/app/serializers/harpiya/v2/storefront/variant_serializer.rb

@@ -0,0 +1,49 @@
+module Harpiya
+  module V2
+    module Storefront
+      class VariantSerializer < BaseSerializer
+        include ::Harpiya::Api::V2::DisplayMoneyHelper
+
+        set_type :variant
+
+        attributes :sku, :weight, :height, :width, :depth, :is_master, :options_text
+
+        attribute :purchasable do |variant|
+          variant.purchasable?
+        end
+
+        attribute :in_stock do |variant|
+          variant.in_stock?
+        end
+
+        attribute :backorderable do |variant|
+          variant.backorderable?
+        end
+
+        attribute :currency do |_product, params|
+          params[:currency]
+        end
+
+        attribute :price do |product, params|
+          price(product, params[:currency])
+        end
+
+        attribute :display_price do |product, params|
+          display_price(product, params[:currency])
+        end
+
+        attribute :compare_at_price do |product, params|
+          compare_at_price(product, params[:currency])
+        end
+
+        attribute :display_compare_at_price do |product, params|
+          display_compare_at_price(product, params[:currency])
+        end
+
+        belongs_to :product
+        has_many :images
+        has_many :option_values
+      end
+    end
+  end
+end

data/app/services/harpiya/api/error_handler.rb

@@ -0,0 +1,40 @@
+module Harpiya
+  module Api
+    class ErrorHandler
+      prepend ::Harpiya::ServiceModule::Base
+
+      def call(exception:, opts: {})
+        run :format_message
+        run :log_error
+        run :report_error
+      end
+
+      protected
+
+      def format_message(exception:, opts:)
+        message = if exception.respond_to?(:original_message)
+                    exception.original_message
+                  else
+                    exception.message
+                  end
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def log_error(exception:, message:, opts:)
+        Rails.logger.error message
+        Rails.logger.error "User ID: #{opts[:user]&.id}" if opts[:user]
+        Rails.logger.error exception.backtrace.join("\n")
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def report_error(exception:, message:, opts:)
+        # overwrite this method in your application to support different error handlers
+        # eg. Sentry, Rollbar, etc
+
+        success(exception: exception, message: message)
+      end
+    end
+  end
+end

data/app/views/harpiya/api/errors/gateway_error.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:gateway_error, scope: 'harpiya.api', text: @error) }

data/app/views/harpiya/api/errors/invalid_api_key.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:invalid_api_key, key: api_key, scope: 'harpiya.api') }

data/app/views/harpiya/api/errors/invalid_resource.rabl

@@ -0,0 +1,3 @@
+object false
+node(:error) { I18n.t(:invalid_resource, scope: 'harpiya.api') }
+node(:errors) { @resource.errors.to_hash }

data/app/views/harpiya/api/errors/must_specify_api_key.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:must_specify_api_key, scope: 'harpiya.api') }

data/app/views/harpiya/api/errors/not_found.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:resource_not_found, scope: 'harpiya.api') }