epages-rest 1.0.2

data/lib/epages/rest/legal.rb

@@ -0,0 +1,81 @@
+require 'epages/utils'
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implements the calls in https://developer.epages.com/apps/api-reference/resource-legal.html
+    module Legal
+      include Epages::Utils
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal.html
+      def legal(options = {})
+        response = perform_get_request('/legal', options)
+        parse_legal_info(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal-contact-information.html
+      def contact_info(options = {})
+        response = perform_get_request('/legal/contact-information', options)
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-legal-contact-information.html
+      def update_contact_info(options, locale = 'en_GB')
+        old_data = contact_info(locale: locale)
+        response = perform_put_request("/legal/contact-information?locale=#{locale}", old_data.merge(options))
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal-privacy-policy.html
+      def privacy_policy(options = {})
+        response = perform_get_request('/legal/privacy-policy', options)
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-legal-privacy-policy.html
+      def update_privacy_policy(options, locale = 'en_GB')
+        old_data = privacy_policy(locale: locale)
+        response = perform_put_request("/legal/privacy-policy?locale=#{locale}", old_data.merge(options))
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal-terms-and-conditions.html
+      def terms_and_conditions(options = {})
+        response = perform_get_request('/legal/terms-and-conditions', options)
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-legal-terms-and-conditions.html
+      def update_terms_and_conditions(options, locale = 'en_GB')
+        old_data = terms_and_conditions(locale: locale)
+        response = perform_put_request("/legal/terms-and-conditions?locale=#{locale}", old_data.merge(options))
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal-rights-of-withdrawal.html
+      def rights_of_withdrawal(options = {})
+        response = perform_get_request('/legal/rights-of-withdrawal', options)
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-legal-rights-of-withdrawal.html
+      def update_rights_of_withdrawal(options, locale = 'en_GB')
+        old_data = rights_of_withdrawal(locale: locale)
+        response = perform_put_request("/legal/rights-of-withdrawal?locale=#{locale}", old_data.merge(options))
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-legal-shipping-information.html
+      def shipping_info(options = {})
+        response = perform_get_request('/legal/shipping-information', options)
+        underscorize_keys(response)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-legal-shipping-information.html
+      def update_shipping_info(options, locale = 'en_GB')
+        old_data = shipping_info(locale: locale)
+        response = perform_put_request("/legal/shipping-information?locale=#{locale}", old_data.merge(options))
+        underscorize_keys(response)
+      end
+    end
+  end
+end

data/lib/epages/rest/miscellaneous.rb

@@ -0,0 +1,27 @@
+require 'epages/utils'
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implement the calls in https://developer.epages.com/apps/api-reference/resource-miscellaneous.html
+    module Miscellaneous
+      include Epages::Utils
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-locales.html
+      def locales
+        perform_get_request('/locales', {})
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-currencies.html
+      def currencies
+        perform_get_request('/currencies', {})
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-search-product-suggest.html
+      def product_suggestions_for(query, options = {})
+        response = perform_get_request('/search/product-suggest', options.merge(query: query))
+        parse_suggestions_to_products(response)
+      end
+    end
+  end
+end

data/lib/epages/rest/orders.rb

@@ -0,0 +1,29 @@
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    module Orders
+      # implements the calls in https://developer.epages.com/apps/api-reference/resource-orders.html
+      include REST::Utils
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/get-shops-shopid-orders.html
+      def orders(options = {})
+        perform_get_with_key_and_objects('/orders', options, :items, Epages::Order)
+      end
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/get-shops-shopid-orders-orderid.html
+      def order(order, options = {})
+        id = epages_id(order)
+        perform_get_with_object("/orders/#{id}", options, Epages::Order)
+      end
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/put-shops-shopid-orders-orderid.html
+      def update_order(order, options, locale = 'en_GB')
+        options.each { |k, v| options[k] = v.to_json if v.class.name.deconstantize == 'Epages' }
+        id = epages_id(order)
+        old_order = perform_get_request("/orders/#{id}", locale: locale)
+        perform_put_with_object("/orders/#{id}?locale=#{locale}", old_order.merge(options), Epages::Order)
+      end
+    end
+  end
+end

data/lib/epages/rest/products.rb

@@ -0,0 +1,106 @@
+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_key_and_objects('/products', options, :items, Epages::Product)
+      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 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 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::Link pointing to the categories of the product
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-categories.html
+      #
+      # @param product [String], [Epages::Product]
+      # @param options [Hash]
+      def product_categories(product, options = {})
+        id = epages_id(product)
+        perform_get_with_key_and_objects("/products/#{id}/categories", options, :links, Epages::Link)
+      end
+
+      # call the API and return a hash that contains the stock-level
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-stock-level.html
+      #
+      # @param product [String], [Epages::Product]
+      def product_stock_level(product)
+        id = epages_id(product)
+        perform_get_request("/products/#{id}/stock-level", {})[:stocklevel]
+      end
+
+      # call the API to modify the current stock level of the product
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-products-productid-stock-level.html
+      #
+      # @param product [String], [Epages::Product]
+      # @param units [Fixnum]
+      def product_change_stock_level(product, units)
+        id = epages_id(product)
+        perform_put_request("/products/#{id}/stock-level", changeStocklevel: units)[:stocklevel]
+      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
+    end
+  end
+end

data/lib/epages/rest/request.rb

@@ -0,0 +1,53 @@
+require 'http'
+require 'epages/utils'
+
+module Epages
+  module REST
+    class Request
+      include Epages::Utils
+
+      BASE_URL = 'https://pm.epages.com/rs/shops/'
+      attr_accessor :shop, :uri, :path, :request_method, :options, :headers
+
+      def initialize(object, request_method, path, options = {})
+        @shop = build_shop_from(object)
+        @uri = URI.parse(BASE_URL + @shop.name.to_s + path)
+        @path = uri.path
+        set_options(request_method, options)
+      end
+
+      def set_options(method, options)
+        @options = camelize_keys(options)
+        @request_method = method
+        @headers = request_headers
+      end
+
+      def auth_token
+        "Bearer #{@shop.token}"
+      end
+
+      # @return [Array, Hash]
+      def perform
+        options_key = @request_method == :get ? :params : :json
+        response = HTTP.with(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
+        fail_or_return_response_body(response)
+      end
+
+      def request_headers
+        headers = {}
+        headers['Content-Type']  = 'application/json'
+        headers['Accept']        = '*/*'
+        headers['Authorization'] = auth_token if @shop.token?
+        headers
+      end
+
+      def fail_or_return_response_body(response)
+        if response.code.between?(200, 206)
+          symbolize_keys!(response.parse)
+        else
+          fail Epages::Error::ERRORS[response.code], JSON.parse(response.body.to_s)['message']
+        end
+      end
+    end
+  end
+end

data/lib/epages/rest/shipping_methods.rb

@@ -0,0 +1,22 @@
+require 'epages/utils'
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implement the calls in https://developer.epages.com/apps/api-reference/resource-shipping-method.html
+    module ShippingMethods
+      include Epages::Utils
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-shipping-methods.html
+      def shipping_methods(options = {})
+        perform_get_with_objects('/shipping-methods', options, Epages::ShippingMethod)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-shipping-methods-shippingmethodid.html
+      def shipping_method(object, options = {})
+        id = epages_id(object)
+        perform_get_with_object("/shipping-methods/#{id}", options, Epages::ShippingMethod)
+      end
+    end
+  end
+end

data/lib/epages/rest/shop.rb

@@ -0,0 +1,12 @@
+require 'epages/shop'
+require 'epages/rest/api'
+require 'epages/rest/request'
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    class Shop < Epages::Shop
+      include Epages::REST::API
+    end
+  end
+end

data/lib/epages/rest/utils.rb

@@ -0,0 +1,166 @@
+module Epages
+  module REST
+    module Utils
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      def perform_request(request_method, path, options = {})
+        Epages::REST::Request.new(self, request_method, path, options).perform
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_get_with_object(path, options, klass)
+        perform_request_with_object(:get, path, options, klass)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_post_with_object(path, options, klass)
+        perform_request_with_object(:post, path, options, klass)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_put_with_object(path, options, klass)
+        perform_request_with_object(:put, path, options, klass)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_delete_with_object(path, options, klass)
+        perform_request_with_object(:delete, path, options, klass)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_request_with_object(request_method, path, options, klass)
+        response = perform_request(request_method, path, options)
+        klass.new(response)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_get_with_objects(path, options, klass)
+        perform_request_with_objects(:get, path, options, klass)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_post_with_objects(path, options, klass)
+        perform_request_with_objects(:post, path, options, klass)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_request_with_objects(request_method, path, options, klass)
+        perform_request(request_method, path, options).collect do |element|
+          klass.new(element)
+        end
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param key [Symbol]
+      # @param klass [Class]
+      def perform_get_with_key_and_objects(path, options, key, klass)
+        perform_request_with_key_and_objects(:get, path, options, key, klass)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      # @param key [Symbol]
+      # @param klass [Class]
+      def perform_post_with_key_and_objects(path, options, key, klass)
+        perform_request_with_key_and_objects(:post, path, options, key, klass)
+      end
+
+      # TODO: refactor code bellow
+      # @param path [String]
+      # @param options [Hash]
+      # @param key [Symbol]
+      # @param klass [Class]
+      def perform_request_with_key_and_objects(request_method, path, options, key, klass)
+        perform_request(request_method, path, options)[key].collect do |element|
+          klass.new(element)
+        end
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      def perform_get_request(path, options)
+        perform_request(:get, path, options)
+      end
+
+      # @param path [String]
+      # @param options [Hash]
+      def perform_put_request(path, options)
+        perform_request(:put, path, options)
+      end
+
+      def epages_id(object)
+        return object if object.class == String
+        return if object.class.name.deconstantize != 'Epages'
+        object.send("#{object.class.name.demodulize.downcase}_id")
+      end
+
+      def parse_product_variations(data)
+        {
+          variation_attributes: parse_variations(data),
+          items: parse_variation_object(data),
+        }
+      end
+
+      def parse_product_lowest_price(data)
+        {
+          price_info: parse_price_info(data[:priceInfo]),
+          links: parse_links(data[:links]),
+        }
+      end
+
+      def parse_legal_info(data)
+        {
+          contact_info: Epages::ContentPageSummary.new(data[:contactInformation]),
+          privacy_policy: Epages::ContentPageSummary.new(data[:privacyPolicy]),
+          terms_and_conditions: Epages::ContentPageSummary.new(data[:termsAndConditions]),
+          rights_of_withdrawal: Epages::ContentPageSummary.new(data[:rightsOfWithdrawal]),
+          shipping_info: Epages::ContentPageSummary.new(data[:shippingInformation]),
+          links: parse_links(data[:links]),
+        }
+      end
+
+      def parse_variations(data)
+        data[:variationAttributes].collect { |el| Epages::VariationAttribute.new(el) }
+      end
+
+      def parse_variation_object(data)
+        data[:items].collect { |el| Epages::Variation.new(el) }
+      end
+
+      def parse_price_info(data)
+        Epages::PriceInfo.new(data)
+      end
+
+      def parse_links(data)
+        data.collect { |link| Epages::Link.new(link) }
+      end
+
+      def parse_suggestions_to_products(data)
+        data[:products].collect do |p|
+          id = p[:link][:href].split('/').last
+          product(id)
+        end
+      end
+    end
+  end
+end

data/lib/epages/shipping_method.rb

@@ -0,0 +1,15 @@
+require 'epages/utils'
+
+module Epages
+  class ShippingMethod
+    include Epages::Utils
+
+    KEYS = %w(shipping_method_id name description logo).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/shop.rb

@@ -0,0 +1,22 @@
+require 'epages/error'
+
+module Epages
+  class Shop
+    attr_accessor :name, :token
+
+    def initialize(name, token = nil)
+      @name = name
+      @token = token
+    end
+
+    # return the shop name
+    def shop_name
+      name
+    end
+
+    # retuns a boolean indicating if the shop has a token set
+    def token?
+      !!token
+    end
+  end
+end

data/lib/epages/utils.rb

@@ -0,0 +1,85 @@
+require 'active_support/inflector'
+require 'date'
+require 'uri'
+require 'json'
+
+module Epages
+  module Utils
+  module_function
+
+    # creates a instance variable (underscore) from the [data]
+    # if [klass] is passed, creates a object of [klass] initialized with data
+    #
+    # @param name [Symbol] [String]
+    # @param data [Hash]
+    # @param klass [Class]
+    def parse_attribute_as(name, data, klass = nil)
+      return if data.nil?
+      value = klass.nil? ? data : klass.new(data)
+      instance_variable_set("@#{name.to_s.underscore}", value)
+    end
+
+    # creates a instance variable (underscore). This variable contains an array of <klass> or empty array
+    #
+    # @param name [Symbol] [String]
+    # @param data [Hash]
+    # @param klass [Class]
+    def parse_attribute_as_array_of(name, data, klass)
+      value = data.class != Array || data.empty? ? [] : data.collect { |i| klass.new(i) }
+      instance_variable_set("@#{name.to_s.underscore}", value)
+    end
+
+    # creates instance variables from the data
+    # if klass is passed, create a object initializing with data
+    #
+    # @param data [Hash]
+    # @param klass [Class]
+    def parse_attributes(data, klass = nil)
+      data.keys.each do |key|
+        next if data[key.to_sym].nil?
+        value = klass.nil? ? data[key.to_sym] : klass.new(data[key.to_sym])
+        instance_variable_set("@#{key.to_s.underscore}", value)
+      end
+    end
+
+    # return the hash with the keys converted to lower camelcase
+    #
+    # @param data [Hash]
+    def camelize_keys(hash)
+      hash.keys.each do |k|
+        key = k.to_s.camelize(:lower).to_sym
+        hash[key] = hash[k]
+        hash.delete(k) if key != k
+      end
+      hash
+    end
+
+    # return the hash with the keys converted to underscore
+    #
+    # @param data [Hash]
+    def underscorize_keys(hash)
+      hash.keys.each do |k|
+        key = k.to_s.underscore.to_sym
+        hash[key] = hash[k]
+        hash.delete(k) if key != k
+      end
+      hash
+    end
+
+    # returns a shop. If [shop] is not a Epages::REST::Shop create one calling the [shop] method shop_mame
+    def build_shop_from(shop)
+      return shop if shop.is_a? Epages::REST::Shop
+      Epages::REST::Shop.new(shop.shop_name)
+    end
+
+    # returns the object replacing all the keys as symbols
+    def symbolize_keys!(object)
+      if object.is_a?(Array)
+        object.each_with_index { |val, index| object[index] = symbolize_keys!(val) }
+      elsif object.is_a?(Hash)
+        object.keys.each { |key| object[key.to_sym] = symbolize_keys!(object.delete(key)) }
+      end
+      object
+    end
+  end
+end

data/lib/epages/variation.rb

@@ -0,0 +1,30 @@
+require 'epages/utils'
+
+module Epages
+  class Variation
+    include Epages::Utils
+
+    attr_reader :link, :attribute_selection
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+
+    # returns the url of the variation
+    def url
+      link.href
+    end
+
+    # returns the product_id of the variation
+    def product_id
+      url.split('/').last
+    end
+
+    # returns a hash formatting the property and the respective value as a pair of the hash
+    def properties
+      Hash[attribute_selection.collect { |el| [el[:name].downcase.to_sym, el[:value]] }]
+    end
+
+    alias_method :attributes, :properties
+  end
+end

data/lib/epages/variation_attribute.rb

@@ -0,0 +1,23 @@
+require 'epages/utils'
+
+module Epages
+  class VariationAttribute
+    include Epages::Utils
+
+    attr_accessor :name, :display_name, :values
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+
+    # returns an array with all the values
+    def formatted_values
+      values.collect { |el| el[:value] }
+    end
+
+    # returns an array with all the display_values
+    def display_values
+      values.collect { |el| el[:displayValue] }
+    end
+  end
+end

data/lib/epages/version.rb

@@ -0,0 +1,3 @@
+module Epages
+  VERSION = '1.0.2'
+end