ePages-de/epages-rest-ruby

require 'epages/rest/utils'

module Epages
  module REST
    # implements the calls in https://developer.epages.com/apps/api-reference/resource-product.html
    module Products
      include REST::Utils

      # call the API and return an array of Epages::Product
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products.html
      #
      # @param options [Hash]
      def products(options = {})
        perform_get_with_object('/products', options, Epages::ProductsResponse)
      end

      # call the API and return a Epages::Product
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid.html
      #
      # @param product [String], [Epages::Product]
      # @param options [Hash]
      def product(product, options = {})
        id = epages_id(product)
        perform_get_with_object("/products/#{id}", options, Epages::Product)
      end

      # call the API to create a new product wit hte data provided and return the product created as Epages::Product
      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-products.html
      #
      # @param data [Hash]
      # @param options [Hash]
      def create_product(data, options = {})
        perform_post_with_object("/products#{to_query_options(options)}", data, Epages::Product)
      end

      # call the API and return a Epages::Product
      # implements the call https://developer.epages.com/apps/api-reference/patch-shops-shopid-products-productid.html
      #
      # @param product [String], [Epages::Product]
      # @param options [Hash]
      def update_product(product, options = {})
        id = epages_id(product)
        perform_patch_with_object("/products/#{id}", options, Epages::Product)
      end

      # call the API and return a Hash with the respective variation_attributes and the variation products
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-variations.html
      #
      # @param product [String], [Epages::Product]
      # @param options [Hash]
      def product_variations(product, options = {})
        id = epages_id(product)
        response = perform_get_request("/products/#{id}/variations", options)
        parse_product_variations(response)
      end

      # call the API and return an array of Epages::ImageSize (slides) of the product
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-slideshow.html
      #
      # @param product [String], [Epages::Product]
      def product_slideshow(product)
        id = epages_id(product)
        perform_get_with_key_and_objects("/products/#{id}/slideshow", {}, :items, Epages::ImageSize)
      end

      # call the API to post a new image to the slideshow of a product and return an array of Epages::ImageSize (slides) of the product
      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-products-productid-slideshow.html
      #
      # @param product [String], [Epages::Product]
      # @param image [String]
      def product_add_slideshow_image(product, image)
        id = epages_id(product)
        perform_multipart_post_with_objects("/products/#{id}/slideshow", image, Epages::ImageSize)
      end

      # call the API to delete an image from the slideshow of a product
      # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-products-productid-slideshow-imagename.html
      #
      # @param product [String], [Epages::Product]
      # @param image [String]
      def product_delete_slideshow_image(product, image)
        id = epages_id(product)
        perform_delete_request("/products/#{id}/slideshow/#{image}")
      end

      # call the API to get the slideshow sequence of a product
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-slideshow-sequence.html
      #
      # @param product [String], [Epages::Product]
      def product_slideshow_sequence(product)
        id = epages_id(product)
        perform_get_request("/products/#{id}/slideshow/sequence", {})
      end

      # call the API to update the slideshow sequence of a product
      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-products-productid-slideshow-sequence.html
      #
      # @param product [String], [Epages::Product]
      # @param data [Array]
      def product_update_slideshow_sequence(product, data)
        id = epages_id(product)
        perform_put_request("/products/#{id}/slideshow/sequence", data)
      end

      # call the API and return an array of Epages::CustomAttribute of the product
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-custom-attributes.html
      #
      # @param product [String], [Epages::Product]
      # @param options [Hash]
      def product_custom_attributes(product, options = {})
        id = epages_id(product)
        perform_get_with_key_and_objects("/products/#{id}/custom-attributes", options, :items, Epages::CustomAttribute)
      end

      # call the API and return a hash with the lowest price of the product and the respective link
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-lowest-price.html
      #
      # @param product [String], [Epages::Product]
      # @param options [Hash]
      def product_lowest_price(product, options = {})
        id = epages_id(product)
        response = perform_get_request("/products/#{id}/lowest-price", options)
        parse_product_lowest_price(response)
      end

      # call the API and return an array of Epages::Product with updated attribute
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-updated-productproperty.html
      #
      # @param property [String], [Symbol]
      # @param options [Hash]
      def updated_products_by_property(property, options = {})
        res = perform_get_request("/products/updated/#{property.to_s.camelize(:lower)}", options)
        res[:items].collect { |i| Epages::Product.new(i[:item]) }
      end

      # call the API and return a CSV with the proper data of the products
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-export.html
      #
      # @param options [Hash]
      def export_products(options = {})
        perform_get_request('/products/export', options)
      end

      # call the API and returns the list of all watched products. Watched products refers to items currently out of stock and therefore can be watched by online shop customers.
      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-watched-products.html
      #
      # @param options [Hash]
      def watched_products(options = {})
        perform_get_with_key_and_objects('/watched-products', options, :items, Epages::Product)
      end

      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-product-category-assignments.html
      # Same as Epages::REST::Categories#`assign_products`
      def assign_categories(options = {})
        perform_post_request('/product-category-assignments', options)
      end

      # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-product-category-assignments.html
      # Same as Epages::REST::Categories#`delete_products`
      def delete_from_categories(options = {})
        perform_delete_request('/product-category-assignments', options)
      end
    end
  end
end