spree_api 4.4.0 → 4.5.0

data/app/controllers/spree/api/v1/taxons_controller.rb

@@ -1,100 +0,0 @@
-module Spree
-  module Api
-    module V1
-      class TaxonsController < Spree::Api::BaseController
-        def index
-          @taxons = if taxonomy
-                      taxonomy.root.children
-                    elsif params[:ids]
-                      Spree::Taxon.includes(:children).accessible_by(current_ability).where(id: params[:ids].split(','))
-                    else
-                      Spree::Taxon.includes(:children).accessible_by(current_ability).order(:taxonomy_id, :lft)
-                    end
-          @taxons = @taxons.ransack(params[:q]).result
-          @taxons = @taxons.page(params[:page]).per(params[:per_page])
-          respond_with(@taxons)
-        end
-
-        def show
-          @taxon = taxon
-          respond_with(@taxon)
-        end
-
-        def jstree
-          show
-        end
-
-        def new; end
-
-        def create
-          authorize! :create, Taxon
-          @taxon = Spree::Taxon.new(taxon_params)
-          @taxon.taxonomy_id = params[:taxonomy_id]
-          taxonomy = Spree::Taxonomy.find_by(id: params[:taxonomy_id])
-
-          if taxonomy.nil?
-            @taxon.errors.add(:taxonomy_id, I18n.t('spree.api.invalid_taxonomy_id'))
-            invalid_resource!(@taxon) and return
-          end
-
-          @taxon.parent_id = taxonomy.root_id unless params[:taxon][:parent_id]
-
-          if @taxon.save
-            respond_with(@taxon, status: 201, default_template: :show)
-          else
-            invalid_resource!(@taxon)
-          end
-        end
-
-        def update
-          authorize! :update, taxon
-          if taxon.update(taxon_params)
-            respond_with(taxon, status: 200, default_template: :show)
-          else
-            invalid_resource!(taxon)
-          end
-        end
-
-        def destroy
-          authorize! :destroy, taxon
-          taxon.destroy
-          respond_with(taxon, status: 204)
-        end
-
-        def products
-          # Returns the products sorted by their position with the classification
-          # Products#index does not do the sorting.
-          taxon = Spree::Taxon.find(params[:id])
-          @products = taxon.products.ransack(params[:q]).result
-          @products = @products.page(params[:page]).per(params[:per_page] || 500)
-          render 'spree/api/v1/products/index'
-        end
-
-        private
-
-        def taxonomy
-          if params[:taxonomy_id].present?
-            @taxonomy ||=
-              if defined?(SpreeGlobalize)
-                Spree::Taxonomy.includes(:translations, taxons: [:translations]).accessible_by(current_ability, :show).find(params[:taxonomy_id])
-              else
-                Spree::Taxonomy.accessible_by(current_ability, :show).find(params[:taxonomy_id])
-              end
-          end
-        end
-
-        def taxon
-          @taxon ||= taxonomy.taxons.accessible_by(current_ability, :show).find(params[:id])
-        end
-
-        def taxon_params
-          if params[:taxon] && !params[:taxon].empty?
-            params.require(:taxon).permit(permitted_taxon_attributes)
-          else
-            {}
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v1/users_controller.rb

@@ -1,97 +0,0 @@
-module Spree
-  module Api
-    module V1
-      class UsersController < Spree::Api::BaseController
-        rescue_from Spree::Core::DestroyWithOrdersError, with: :error_during_processing
-
-        def index
-          users
-
-          if params[:ids]
-            load_users_by_ids
-          elsif params.dig(:q, :ship_address_firstname_start)
-            load_users_by_address
-          elsif params.dig(:q, :email_start)
-            load_users_by_email
-          end
-
-          prepare_index_response
-          respond_with(@users)
-        end
-
-        def users
-          @users ||= Spree.user_class.accessible_by(current_ability, :show)
-        end
-
-        def load_users_by_ids
-          @users = @users.where(id: params[:ids])
-        end
-
-        def load_users_by_address
-          address_params = params[:q][:ship_address_firstname_start] ||
-            params[:q][:ship_address_lastname_start] ||
-            params[:q][:bill_address_firstname_start] ||
-            params[:q][:bill_address_lastname_start]
-          @users = @users.with_email_or_address(params[:q][:email_start], address_params)
-        end
-
-        def load_users_by_email
-          @users = @users.with_email(params[:q][:email_start])
-        end
-
-        def paginate_users
-          @users = @users.page(params[:page]).per(params[:per_page])
-        end
-
-        def prepare_index_response
-          paginate_users
-          expires_in 15.minutes, public: true
-          headers['Surrogate-Control'] = "max-age=#{15.minutes}"
-        end
-
-        def show
-          respond_with(user)
-        end
-
-        def new; end
-
-        def create
-          authorize! :create, Spree.user_class
-          @user = Spree.user_class.new(user_params)
-          if @user.save
-            respond_with(@user, status: 201, default_template: :show)
-          else
-            invalid_resource!(@user)
-          end
-        end
-
-        def update
-          authorize! :update, user
-          if user.update(user_params)
-            respond_with(user, status: 200, default_template: :show)
-          else
-            invalid_resource!(user)
-          end
-        end
-
-        def destroy
-          authorize! :destroy, user
-          user.destroy
-          respond_with(user, status: 204)
-        end
-
-        private
-
-        def user
-          @user ||= Spree.user_class.accessible_by(current_ability, :show).find(params[:id])
-        end
-
-        def user_params
-          params.require(:user).permit(permitted_user_attributes |
-                                         [bill_address_attributes: permitted_address_attributes,
-                                          ship_address_attributes: permitted_address_attributes])
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v1/variants_controller.rb

@@ -1,81 +0,0 @@
-module Spree
-  module Api
-    module V1
-      class VariantsController < Spree::Api::BaseController
-        before_action :product
-
-        def create
-          authorize! :create, Variant
-          @variant = scope.new(variant_params)
-          if @variant.save
-            respond_with(@variant, status: 201, default_template: :show)
-          else
-            invalid_resource!(@variant)
-          end
-        end
-
-        def destroy
-          @variant = scope.accessible_by(current_ability, :destroy).find(params[:id])
-          @variant.destroy
-          respond_with(@variant, status: 204)
-        end
-
-        # The lazyloaded associations here are pretty much attached to which nodes
-        # we render on the view so we better update it any time a node is included
-        # or removed from the views.
-        def index
-          @variants = scope.includes(*variant_includes).for_currency_and_available_price_amount.
-                      ransack(params[:q]).result.page(params[:page]).per(params[:per_page])
-          respond_with(@variants)
-        end
-
-        def new; end
-
-        def show
-          @variant = scope.includes(*variant_includes).find(params[:id])
-          respond_with(@variant)
-        end
-
-        def update
-          @variant = scope.accessible_by(current_ability, :update).find(params[:id])
-          if @variant.update(variant_params)
-            respond_with(@variant, status: 200, default_template: :show)
-          else
-            invalid_resource!(@product)
-          end
-        end
-
-        private
-
-        def product
-          if params[:product_id]
-            @product ||= Spree::Product.accessible_by(current_ability, :show).
-                         friendly.find(params[:product_id])
-          end
-        end
-
-        def scope
-          variants = if @product
-                       @product.variants_including_master
-                     else
-                       Variant
-                     end
-
-          if current_ability.can?(:manage, Variant) && params[:show_deleted]
-            variants = variants.with_deleted
-          end
-
-          variants.eligible.accessible_by(current_ability)
-        end
-
-        def variant_params
-          params.require(:variant).permit(permitted_variant_attributes)
-        end
-
-        def variant_includes
-          [{ option_values: :option_type }, :product, :default_price, :images, { stock_items: :stock_location }]
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v1/zones_controller.rb

@@ -1,55 +0,0 @@
-module Spree
-  module Api
-    module V1
-      class ZonesController < Spree::Api::BaseController
-        def create
-          authorize! :create, Zone
-          @zone = Spree::Zone.new(zone_params)
-          if @zone.save
-            respond_with(@zone, status: 201, default_template: :show)
-          else
-            invalid_resource!(@zone)
-          end
-        end
-
-        def destroy
-          authorize! :destroy, zone
-          zone.destroy
-          respond_with(zone, status: 204)
-        end
-
-        def index
-          @zones = Zone.accessible_by(current_ability).order('name ASC').ransack(params[:q]).result.page(params[:page]).per(params[:per_page])
-          respond_with(@zones)
-        end
-
-        def show
-          respond_with(zone)
-        end
-
-        def update
-          authorize! :update, zone
-          if zone.update(zone_params)
-            respond_with(zone, status: 200, default_template: :show)
-          else
-            invalid_resource!(zone)
-          end
-        end
-
-        private
-
-        def zone_params
-          attrs = params.require(:zone).permit!
-          if attrs[:zone_members]
-            attrs[:zone_members_attributes] = attrs.delete(:zone_members)
-          end
-          attrs
-        end
-
-        def zone
-          @zone ||= Spree::Zone.accessible_by(current_ability, :show).find(params[:id])
-        end
-      end
-    end
-  end
-end

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

@@ -1,190 +0,0 @@
-module Spree
-  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

data/app/models/spree/api_configuration.rb

@@ -1,10 +0,0 @@
-module Spree
-  class ApiConfiguration < Preferences::Configuration
-    preference :requires_authentication, :boolean, default: true
-    preference :api_v2_serializers_cache_ttl, :integer, default: 3600 # 1 hour in seconds
-    preference :api_v2_collection_cache_ttl, :integer, default: 3600 # 1 hour in seconds
-    preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'
-    preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
-    preference :api_v2_per_page_limit, :integer, default: 500
-  end
-end

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

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

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

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

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

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

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

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

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

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

data/app/views/spree/api/errors/unauthorized.rabl

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

data/app/views/spree/api/v1/addresses/show.rabl

@@ -1,10 +0,0 @@
-object @address
-cache [I18n.locale, root_object]
-attributes *address_attributes
-
-child(:country) do |_address|
-  attributes *country_attributes
-end
-child(:state) do |_address|
-  attributes *state_attributes
-end

data/app/views/spree/api/v1/adjustments/show.rabl

@@ -1,4 +0,0 @@
-object @adjustment
-cache [I18n.locale, root_object]
-attributes *adjustment_attributes
-node(:display_amount) { |a| a.display_amount.to_s }

data/app/views/spree/api/v1/countries/index.rabl

@@ -1,7 +0,0 @@
-object false
-child(@countries => :countries) do
-  attributes *country_attributes
-end
-node(:count) { @countries.count }
-node(:current_page) { params[:page].try(:to_i) || 1 }
-node(:pages) { @countries.total_pages }

data/app/views/spree/api/v1/countries/show.rabl

@@ -1,5 +0,0 @@
-object @country
-attributes *country_attributes
-child states: :states do
-  attributes :id, :name, :abbr, :country_id
-end

data/app/views/spree/api/v1/credit_cards/index.rabl

@@ -1,7 +0,0 @@
-object false
-child(@credit_cards => :credit_cards) do
-  extends 'spree/api/v1/credit_cards/show'
-end
-node(:count) { @credit_cards.count }
-node(:current_page) { params[:page].try(:to_i) || 1 }
-node(:pages) { @credit_cards.total_pages }

data/app/views/spree/api/v1/credit_cards/show.rabl

@@ -1,3 +0,0 @@
-object @credit_card
-cache [I18n.locale, root_object]
-attributes *creditcard_attributes

data/app/views/spree/api/v1/customer_returns/index.rabl

@@ -1,7 +0,0 @@
-object false
-child(@collection => :customer_returns) do
-  attributes *customer_return_attributes
-end
-node(:count) { @collection.count }
-node(:current_page) { params[:page].try(:to_i) || 1 }
-node(:pages) { @collection.total_pages }

data/app/views/spree/api/v1/images/index.rabl

@@ -1,4 +0,0 @@
-object false
-child(@images => :images) do
-  extends 'spree/api/v1/images/show'
-end

data/app/views/spree/api/v1/images/new.rabl

@@ -1,3 +0,0 @@
-object false
-node(:attributes) { [*image_attributes] }
-node(:required_attributes) { required_fields_for(Spree::Image) }

data/app/views/spree/api/v1/images/show.rabl

@@ -1,6 +0,0 @@
-object @image
-attributes *image_attributes
-attributes :viewable_type, :viewable_id
-Spree::Image.styles.each do |k, _v|
-  node("#{k}_url") { |i| main_app.url_for(i.url(k)) }
-end

data/app/views/spree/api/v1/inventory_units/show.rabl

@@ -1,2 +0,0 @@
-object @inventory_unit
-attributes *inventory_unit_attributes

data/app/views/spree/api/v1/line_items/new.rabl

@@ -1,3 +0,0 @@
-object false
-node(:attributes) { [*line_item_attributes] - [:id] }
-node(:required_attributes) { [:variant_id, :quantity] }

data/app/views/spree/api/v1/line_items/show.rabl

@@ -1,14 +0,0 @@
-object @line_item
-cache [I18n.locale, root_object]
-attributes *line_item_attributes
-node(:single_display_amount) { |li| li.single_display_amount.to_s }
-node(:display_amount) { |li| li.display_amount.to_s }
-node(:total, &:total)
-child :variant do
-  extends 'spree/api/v1/variants/small'
-  attributes :product_id
-end
-
-child adjustments: :adjustments do
-  extends 'spree/api/v1/adjustments/show'
-end

data/app/views/spree/api/v1/option_types/index.rabl

@@ -1,3 +0,0 @@
-collection @option_types
-
-extends 'spree/api/v1/option_types/show'

data/app/views/spree/api/v1/option_types/new.rabl

@@ -1,3 +0,0 @@
-object false
-node(:attributes) { [*option_type_attributes] }
-node(:required_attributes) { required_fields_for(Spree::OptionType) }

data/app/views/spree/api/v1/option_types/show.rabl

@@ -1,5 +0,0 @@
-object @option_type
-attributes *option_type_attributes
-child option_values: :option_values do
-  attributes *option_value_attributes
-end

data/app/views/spree/api/v1/option_values/index.rabl

@@ -1,3 +0,0 @@
-collection @option_values
-
-extends 'spree/api/v1/option_values/show'