epages-rest 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abbbdaf768efb6c4a943963ef45e768d5adc434b
-  data.tar.gz: ee5a7d1afbd68df9f2e188ced17aad97f3658aab
+  metadata.gz: fafdb220142f238edcc64a66dc7dd8b45c175ad4
+  data.tar.gz: db9b309d88f49ce649abc04c7776a6d914a05e26
 SHA512:
-  metadata.gz: c8490ff0dc25cc868dbfc794908a9bc422898150d24b0202b300251eb26ecd9b6bb396992708c71648eb69b2480bcd1a983c4c99b33dbc171593d96294df91ea
-  data.tar.gz: af53cbc4a04ef403810b94b28b4c404eb1fb11eb3bbce92a231f0b5cee2f824b5bd250d7506173ce1fab134dc5bd0287680cb6b547b1d1fcc0c14dce46521b2f
+  metadata.gz: d6c7bc46d20543e1bc2e303062a8f1ac8aef70673e95cf035aaa1172419d8871064204f6b18611e3479870f95f848dd398469fb29e86306ae7fa8b5432b091c0
+  data.tar.gz: 3f93d80851535b4d880a0d29e34708047cdfaf48177d418c869a36aa769d3339f6e96cc23cde9325cd1a478cc699597dba309e2967984b2f3d0aebcb3a085041

data/lib/epages/cart.rb

@@ -14,5 +14,7 @@ module Epages
       parse_attribute_as(:line_item_container, data.delete(:lineItemContainer), Epages::LineItemContainer)
       parse_attributes(data)
     end
+
+    alias_method :id, :cart_id
   end
 end

data/lib/epages/category.rb

@@ -10,9 +10,9 @@ module Epages
     attr_reader *KEYS
 
     def initialize(data)
-      @images = data.delete(:images).collect { |i| Epages::Image.new(i) }
-      @links = data.delete(:links).collect { |i| Epages::Link.new(i) }
-      @sub_categories = data.delete(:subCategories).collect { |i| Epages::Link.new(i) }
+      @images = data.delete(:images).collect { |i| Epages::Image.new(i) } if data[:images]
+      @links = data.delete(:links).collect { |i| Epages::Link.new(i) } if data[:links]
+      @sub_categories = data.delete(:subCategories).collect { |i| Epages::Link.new(i) } if data[:subCategories]
       @parent = Epages::Link.new(data.delete(:parent)) if data[:parent]
       parse_attributes(data)
     end
@@ -21,5 +21,7 @@ module Epages
       return false if other.class != Epages::Category
       category_id == other.category_id && name == other.name
     end
+
+    alias_method :id, :category_id
   end
 end

data/lib/epages/image_size.rb

@@ -4,10 +4,11 @@ module Epages
   class ImageSize
     include Epages::Utils
 
-    attr_accessor :images
+    attr_accessor :images, :name
 
     def initialize(data)
-      parse_attribute_as_array_of(:images, data[:sizes], Epages::Image)
+      parse_attribute_as_array_of(:images, data.delete(:sizes), Epages::Image)
+      parse_attributes(data)
     end
 
     # return a sorted array with the name of all available sizes
@@ -22,5 +23,10 @@ module Epages
       link = images.find { |i| i.classifier == size }
       link ? link.url : nil
     end
+
+    # return the length of the slideshow
+    def length
+      images.size
+    end
   end
 end

data/lib/epages/order.rb

@@ -9,20 +9,26 @@ module Epages
                     cancelled_on closed_on paid_on returned_on)
 
     ATTRS = %w(order_id order_number billing_address shipping_address customer_id locale currency_id tax_model
-               grand_total total_before_tax comment line_item_container product_line_items shipping_price links)
+               grand_total total_before_tax line_item_container product_line_items shipping_price links internal_note
+               customer_comment shipping_data payment_data)
 
     KEYS = (ATTRS + DATE_ATTRS).collect(&:to_sym).freeze
 
     attr_reader *KEYS
 
     def initialize(data)
+      DATE_ATTRS.each { |i| parse_attribute_as(i.to_sym, data.delete(i.camelize(:lower).to_sym), DateTime) }
       parse_attribute_as_array_of(:links, data.delete(:links), Epages::Link)
       parse_attribute_as_array_of(:product_line_items, data.delete(:productLineItems), Epages::ProductLineItem)
       parse_attribute_as(:shipping_price, data.delete(:shippingPrice), Epages::Price)
       parse_attribute_as(:billing_address, data.delete(:billingAddress), Epages::Address)
       parse_attribute_as(:shipping_address, data.delete(:shippingAddress), Epages::Address)
       parse_attribute_as(:line_item_container, data.delete(:lineItemContainer), Epages::LineItemContainer)
+      parse_attribute_as(:shipping_data, data.delete(:shippingData), Epages::ShippingData)
+      parse_attribute_as(:payment_data, data.delete(:paymentData), Epages::PaymentData)
       parse_attributes(data)
     end
+
+    alias_method :id, :order_id
   end
 end

data/lib/epages/payment_data.rb

@@ -0,0 +1,16 @@
+require 'epages/utils'
+
+module Epages
+  class PaymentData
+    include Epages::Utils
+
+    KEYS = %w(payment_method price).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:payment_method, data.delete(:paymentMethod), Epages::PaymentMethodInfo)
+      parse_attribute_as(:price, data.delete(:price), Epages::Price)
+    end
+  end
+end

data/lib/epages/payment_method_info.rb

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

data/lib/epages/product.rb

@@ -8,7 +8,7 @@ module Epages
 
     KEYS = %w(product_id name short_description description images price_info for_sale special_offer delivery_weight
               shipping_methods_restricted_to availability_text availability energy_labels_string energy_label_source_file
-              product_data_sheet sf_url product_number manufacturer upc ean links).collect(&:to_sym).freeze
+              product_data_sheet sf_url product_number manufacturer upc ean links product_image).collect(&:to_sym).freeze
 
     attr_reader *KEYS
 
@@ -51,6 +51,32 @@ module Epages
       product_slideshow(self) if link?('slideshow')
     end
 
+    # add an image to the slideshow
+    #
+    # @param image [String]
+    def add_slideshow_image(image)
+      product_add_slideshow_image(self, image)
+    end
+
+    # remove the image passed from the slideshow and return the new slideshow
+    #
+    # @param image [String]
+    def delete_slideshow_image(image)
+      product_delete_slideshow_image(self, image)
+    end
+
+    # returns an array containing the slideshow sequence
+    def slideshow_sequence
+      product_slideshow_sequence(self)
+    end
+
+    # updates the order of the sequence with the data passed as parameter
+    #
+    # @param data [Array]
+    def update_slideshow_sequence(data)
+      product_update_slideshow_sequence(self, data)
+    end
+
     # returns the list of variations of the product
     def variations
       product_variations(self) if link?('variations')
@@ -88,5 +114,7 @@ module Epages
     def to_line_item(quantity = 1)
       {productId: product_id, quantity: quantity}
     end
+
+    alias_method :id, :product_id
   end
 end

data/lib/epages/rest/api.rb

@@ -4,6 +4,7 @@ require 'epages/rest/legal'
 require 'epages/rest/miscellaneous'
 require 'epages/rest/orders'
 require 'epages/rest/products'
+require 'epages/rest/sales'
 require 'epages/rest/shipping_methods'
 
 module Epages
@@ -15,6 +16,7 @@ module Epages
       include REST::Miscellaneous
       include REST::Orders
       include REST::Products
+      include REST::Sales
       include REST::ShippingMethods
     end
   end

data/lib/epages/rest/products.rb

@@ -24,6 +24,16 @@ module Epages
         perform_get_with_object("/products/#{id}", options, 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
       #
@@ -44,6 +54,45 @@ module Epages
         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
       #

data/lib/epages/rest/request.rb

@@ -12,13 +12,13 @@ module Epages
         @shop = build_shop_from(object)
         @uri = URI.parse("https://#{@shop.host}/rs/shops/#{@shop.name.to_s + path}")
         @path = uri.path
-        set_options(request_method, options)
+        set_request_options(request_method, options)
       end
 
-      def set_options(method, options)
-        @options = camelize_keys(options)
+      def set_request_options(method, options)
         @request_method = method
         @headers = request_headers
+        @options = format_options(options)
       end
 
       def auth_token
@@ -27,24 +27,54 @@ module Epages
 
       # @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)
+        response = HTTP.with(@headers).public_send(@request_method, @uri.to_s, options_passed_by => @options)
         fail_or_return_response_body(response)
       end
 
       def request_headers
         headers = {}
-        headers['Content-Type']  = 'application/json'
+        headers['Content-Type']  = content_type_options unless @request_method == :multipart_post
         headers['Accept']        = '*/*'
         headers['Authorization'] = auth_token if @shop.token?
         headers
       end
 
+      def options_passed_by
+        return :form if @request_method == :post && @options.key?(:image)
+        case @request_method
+        when :get   then :params
+        when :patch then :body
+        else :json
+        end
+      end
+
+      def content_type_options
+        @request_method == :patch ? 'application/json-patch+json' : 'application/json'
+      end
+
+      def format_options(options)
+        case @request_method
+        when :multipart_post then options_to_multipart_request(options)
+        when :patch then options_to_patch_request(options).to_json
+        else options.is_a?(Hash) ? camelize_keys(options) : options
+        end
+      end
+
+      def mime_type(basename)
+        case basename
+        when /.gif/   then 'image/gif'
+        when /.jpe?g/ then 'image/jpeg'
+        when /.png/   then 'image/png'
+        else 'application/octet-stream'
+        end
+      end
+
       def fail_or_return_response_body(response)
+        return if response.code == 204
         if response.code.between?(200, 206)
           symbolize_keys!(response.parse)
         else
-          fail Epages::Error::ERRORS[response.code], JSON.parse(response.body.to_s)['message']
+          fail Epages::Error::ERRORS[response.code], response.body.to_s
         end
       end
     end

data/lib/epages/rest/sales.rb

@@ -0,0 +1,19 @@
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implements the calls in https://developer.epages.com/apps/api-reference/resource-sales.html
+    module Sales
+      include REST::Utils
+
+      # call the API and return an array of Epages::Sale
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-sales.html
+      #
+      # @param options [Hash]
+      def sales(options = {})
+        options[:product_id] = epages_id(options[:product_id]) if options[:product_id]
+        perform_get_with_key_and_objects('/sales', format_dates_options(options), :salesPerCurrency, Epages::Sale)
+      end
+    end
+  end
+end

data/lib/epages/rest/shop.rb

@@ -7,6 +7,21 @@ module Epages
   module REST
     class Shop < Epages::Shop
       include Epages::REST::API
+
+      def parallel_calls(requests)
+        threads = []
+        result = requests
+        requests.each do |key, values|
+          values.each_with_index do |call, i|
+            threads << (values.is_a?(Array) ? process_thread(key, call, i) : process_thread(key, values))
+          end
+        end
+        threads.each do |t|
+          t.join
+          t[:index].nil? ? result[t[:name]] = t[:result] : result[t[:name]][t[:index]] = t[:result]
+        end
+        result
+      end
     end
   end
 end

data/lib/epages/rest/utils.rb

@@ -29,6 +29,13 @@ module Epages
         perform_request_with_object(:put, path, options, klass)
       end
 
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_patch_with_object(path, options, klass)
+        perform_request_with_object(:patch, path, options, klass)
+      end
+
       # @param path [String]
       # @param options [Hash]
       # @param klass [Class]
@@ -59,6 +66,14 @@ module Epages
         perform_request_with_objects(:post, path, options, klass)
       end
 
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_multipart_post_with_objects(path, image, klass)
+        response = perform_request(:multipart_post, path, file: image)
+        response.key?('items') ? response[:items].collect { |data| klass.new(data) } : klass.new(response)
+      end
+
       # @param request_method [Symbol]
       # @param path [String]
       # @param options [Hash]
@@ -85,7 +100,6 @@ module Epages
         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]
@@ -98,16 +112,22 @@ module Epages
 
       # @param path [String]
       # @param options [Hash]
-      def perform_get_request(path, options)
+      def perform_get_request(path, options = {})
         perform_request(:get, path, options)
       end
 
       # @param path [String]
       # @param options [Hash]
-      def perform_put_request(path, options)
+      def perform_put_request(path, options = {})
         perform_request(:put, path, options)
       end
 
+      # @param path [String]
+      # @param options [Hash]
+      def perform_delete_request(path, options = {})
+        perform_request(:delete, path, options)
+      end
+
       def epages_id(object)
         return object if object.class == String
         return if object.class.name.deconstantize != 'Epages'
@@ -156,11 +176,27 @@ module Epages
       end
 
       def parse_suggestions_to_products(data)
-        data[:products].collect do |p|
-          id = p[:link][:href].split('/').last
-          product(id)
+        ids = data[:products].collect { |p| p[:link][:href].split('/').last }
+        parallel_calls(product: ids)[:product]
+      end
+
+      def process_thread(key, value, index = nil)
+        Thread.new do
+          Thread.current[:name] = key
+          Thread.current[:index] = index if index
+          Thread.current[:result] = send(key, value)
         end
       end
+
+      def format_date(date)
+        (date.is_a?(Date) ? date : DateTime.parse(date)).strftime
+      end
+
+      def format_dates_options(options)
+        options[:created_before] = format_date(options[:created_before]) if options[:created_before]
+        options[:created_after] = format_date(options[:created_after]) if options[:created_after]
+        options
+      end
     end
   end
 end

data/lib/epages/sale.rb

@@ -0,0 +1,16 @@
+require 'epages/utils'
+require 'epages/rest/sales'
+
+module Epages
+  class Sale
+    include Epages::Utils
+
+    KEYS = %w(currency total_gross_revenue total_net_revenue inits_sold total_orders).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/shipping_data.rb

@@ -0,0 +1,16 @@
+require 'epages/utils'
+
+module Epages
+  class ShippingData
+    include Epages::Utils
+
+    KEYS = %w(shipping_method price).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:shipping_method, data.delete(:shippingMethod), Epages::ShippingMethodInfo)
+      parse_attribute_as(:price, data.delete(:price), Epages::Price)
+    end
+  end
+end

data/lib/epages/shipping_method.rb

@@ -11,5 +11,7 @@ module Epages
     def initialize(data)
       parse_attributes(data)
     end
+
+    alias_method :id, :shipping_method_id
   end
 end

data/lib/epages/shipping_method_info.rb

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

data/lib/epages/utils.rb

@@ -13,9 +13,14 @@ module Epages
     # @param name [Symbol] [String]
     # @param data [Hash]
     # @param klass [Class]
-    def parse_attribute_as(name, data, klass = nil)
+    def parse_attribute_as(name, data, klass = NilClass)
       return if data.nil?
-      value = klass.nil? ? data : klass.new(data)
+      value =
+        case klass.name
+        when 'NilClass' then data
+        when 'DateTime' then klass.parse(data)
+        else klass.new(data)
+        end
       instance_variable_set("@#{name.to_s.underscore}", value)
     end
 
@@ -44,8 +49,9 @@ module Epages
 
     # return the hash with the keys converted to lower camelcase
     #
-    # @param data [Hash]
+    # @param hash [Hash]
     def camelize_keys(hash)
+      return unless hash.is_a?(Hash)
       hash.keys.each do |k|
         key = k.to_s.camelize(:lower).to_sym
         hash[key] = hash[k]
@@ -56,8 +62,9 @@ module Epages
 
     # return the hash with the keys converted to underscore
     #
-    # @param data [Hash]
+    # @param hash [Hash]
     def underscorize_keys(hash)
+      return unless hash.is_a?(Hash)
       hash.keys.each do |k|
         key = k.to_s.underscore.to_sym
         hash[key] = hash[k]
@@ -73,6 +80,8 @@ module Epages
     end
 
     # returns the object replacing all the keys as symbols
+    #
+    # @param object [Hash], [Array]
     def symbolize_keys!(object)
       if object.is_a?(Array)
         object.each_with_index { |val, index| object[index] = symbolize_keys!(val) }
@@ -81,5 +90,31 @@ module Epages
       end
       object
     end
+
+    # returns the json body for the patch calls
+    #
+    # @param options [Hash]
+    def options_to_patch_request(options)
+      json = []
+      Array[options.delete(:remove)].flatten.compact.each { |i| json << {'op' => 'remove', 'path' => "/#{camelize_words(i)}"} }
+      options.each { |k, v| json << {'op' => 'add', 'path' => "/#{camelize_words(k)}", 'value' => v} }
+      json.collect { |i| Hash[i.each_pair.to_a] }
+    end
+
+    # returns the json body for the patch calls
+    #
+    # @param options [Hash]
+    def options_to_multipart_request(options)
+      file = options[:file]
+      @request_method = :post
+      {image: HTTP::FormData::File.new(file, filename: File.basename(file), mime_type: mime_type(File.basename(file)))}
+    end
+
+    # return the string passed as a parameter with all the words camelized
+    #
+    # @param string [Strimg], [Symbol]
+    def camelize_words(string)
+      string.to_s.gsub(/(\w+)/) { |s| s.camelize(:lower) }
+    end
   end
 end

data/lib/epages/variation.rb

@@ -26,5 +26,6 @@ module Epages
     end
 
     alias_method :attributes, :properties
+    alias_method :id, :product_id
   end
 end

data/lib/epages/version.rb

@@ -1,3 +1,3 @@
 module Epages
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/epages-rest.rb

@@ -10,11 +10,16 @@ require 'epages/image_size'
 require 'epages/line_item_container'
 require 'epages/link'
 require 'epages/order'
+require 'epages/payment_data'
+require 'epages/payment_method_info'
 require 'epages/price'
 require 'epages/price_info'
 require 'epages/product'
 require 'epages/product_line_item'
+require 'epages/sale'
+require 'epages/shipping_data'
 require 'epages/shipping_method'
+require 'epages/shipping_method_info'
 require 'epages/shop'
 require 'epages/utils'
 require 'epages/variation'
@@ -28,6 +33,7 @@ require 'epages/rest/legal'
 require 'epages/rest/orders'
 require 'epages/rest/products'
 require 'epages/rest/request'
+require 'epages/rest/sales'
 require 'epages/rest/shipping_methods'
 require 'epages/rest/shop'
 require 'epages/rest/utils'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epages-rest
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Domingo Cividanes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,8 @@ files:
 - lib/epages/line_item_container.rb
 - lib/epages/link.rb
 - lib/epages/order.rb
+- lib/epages/payment_data.rb
+- lib/epages/payment_method_info.rb
 - lib/epages/price.rb
 - lib/epages/price_info.rb
 - lib/epages/product.rb
@@ -89,10 +91,14 @@ files:
 - lib/epages/rest/orders.rb
 - lib/epages/rest/products.rb
 - lib/epages/rest/request.rb
+- lib/epages/rest/sales.rb
 - lib/epages/rest/shipping_methods.rb
 - lib/epages/rest/shop.rb
 - lib/epages/rest/utils.rb
+- lib/epages/sale.rb
+- lib/epages/shipping_data.rb
 - lib/epages/shipping_method.rb
+- lib/epages/shipping_method_info.rb
 - lib/epages/shop.rb
 - lib/epages/utils.rb
 - lib/epages/variation.rb