epages-rest 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e6f19f5ad1f0b8bc0e7663906f8be81128a4535
-  data.tar.gz: f41c9b37e7eb3ecac2ff9de7d6eec000f5f0207a
+  metadata.gz: 90f0916b52d7493d5a4e551e896a5087f691880e
+  data.tar.gz: 24c8d720fda0a80806c383455cd2025b05627504
 SHA512:
-  metadata.gz: 747c2442660724bcbffe03750ef9b86294509a8c2c574738f0e6c48b2350535b557d707b2b63bb222952fbfcf481df5bcb7ddcda606e4910e8b2fc210593d3a2
-  data.tar.gz: 590f481c30757145466070a8b6e9624e980c36ea940917fbd565c947363c3e6eeab00d4b00f5b1e132ff7d7be607418034dc902bddef1bbd926b696121ddbe28
+  metadata.gz: 1e101a31f432ef803fc953c9ef0d12bfd35f046b1cf7771bf04cc61ac4cd941046c99c556b4f272aaa100d00817a1321c057ffb6f0f2a613bd2ff29ccb5743b9
+  data.tar.gz: ae871cbb63b7e786782616f1e8270d17b98e5d4d17d1e77935eda3d94307831f19642ee6e70f4f2c7ccf94821290ada1dd4dfd69052fe97425ee9e17fa006d95

data/lib/epages/newsletter.rb

@@ -0,0 +1,17 @@
+require 'epages/utils'
+
+module Epages
+  class Newsletter
+    include Epages::Utils
+
+    KEYS = %w(campaign_id language identifier name description number_of_subscribers subject).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+
+    alias_method :id, :campaign_id
+  end
+end

data/lib/epages/product.rb

@@ -8,7 +8,8 @@ module Epages
 
     KEYS = %w(product_id name short_description description product_image 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 essential_features search_keywords links).collect(&:to_sym).freeze
+              product_data_sheet sf_url product_number manufacturer upc ean essential_features search_keywords links tax_class
+              stocklevel watchers).collect(&:to_sym).freeze
 
     attr_reader *KEYS
 
@@ -97,19 +98,6 @@ module Epages
       product_lowest_price(self) if link?('lowest-price')
     end
 
-    # returns the stock level of the product
-    def stock_level
-      product_stock_level(self)[:stocklevel]
-    end
-
-    # modify the current stock level in [units]
-    #
-    # @param units [Fixnum]. Number of units to change. Can be negative
-    # @param shop [Epages::Shop]. The shop that contains the authorization to do the call
-    def change_stock_level(units, shop)
-      shop.product_change_stock_level(self, units)[:stocklevel]
-    end
-
     # return a hash with productId and quantity. This format is used for the line_items of Cart
     def to_line_item(quantity = 1)
       {productId: product_id, quantity: quantity}

data/lib/epages/rest/api.rb

@@ -3,6 +3,7 @@ require 'epages/rest/categories'
 require 'epages/rest/customers'
 require 'epages/rest/legal'
 require 'epages/rest/miscellaneous'
+require 'epages/rest/newsletters'
 require 'epages/rest/orders'
 require 'epages/rest/products'
 require 'epages/rest/sales'
@@ -16,6 +17,7 @@ module Epages
       include REST::Customers
       include REST::Legal
       include REST::Miscellaneous
+      include REST::Newsletters
       include REST::Orders
       include REST::Products
       include REST::Sales

data/lib/epages/rest/carts.rb

@@ -49,7 +49,7 @@ module Epages
       end
 
       # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-carts-cartid-billing-address.html
-      def delete_billing_address(cart)
+      def delete_cart_billing_address(cart)
         id = epages_id(cart)
         perform_delete_with_object("/carts/#{id}/billing-address", {}, Epages::Cart)
       end
@@ -62,10 +62,16 @@ module Epages
       end
 
       # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-carts-cartid-shipping-address.html
-      def delete_shipping_address(cart)
+      def delete_cart_shipping_address(cart)
         id = epages_id(cart)
         perform_delete_with_object("/carts/#{id}/shipping-address", {}, Epages::Cart)
       end
+
+      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-carts-cartid-order.html
+      def order_cart(cart)
+        id = epages_id(cart)
+        perform_post_with_object("/carts/#{id}/order", {}, Epages::Order)
+      end
     end
   end
 end

data/lib/epages/rest/customers.rb

@@ -6,6 +6,14 @@ module Epages
     module Customers
       include REST::Utils
 
+      # call the API and return an array of Epages::Customer
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-customers.html
+      #
+      # @param options [Hash]
+      def customers(options = {})
+        perform_get_with_key_and_objects('/customers', options, :items, Epages::Customer)
+      end
+
       # call the API to creates a customer. If customer_number is not provided in the request, it will be generated automatically.
       # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-customers.html
       #

data/lib/epages/rest/newsletters.rb

@@ -0,0 +1,21 @@
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implements the calls in https://developer.epages.com/apps/api-reference/resource-newsletter-campaigns.html
+    module Newsletters
+      include REST::Utils
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-newsletter-campaigns.html
+      def newsletters(options = {})
+        perform_get_with_key_and_objects('/newsletter-campaigns', options, :items, Epages::Newsletter)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-newsletter-campaigns-campaignid-subscribers.html
+      def newsletter_subscribers(newsletter, options = {})
+        id = epages_id(newsletter)
+        perform_get_with_key_and_objects("/newsletter-campaigns/#{id}/subscribers", options, :items, Epages::Subscriber)
+      end
+    end
+  end
+end

data/lib/epages/rest/orders.rb

@@ -17,14 +17,6 @@ module Epages
         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 modify_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
-
       # implements the calls in https://developer.epages.com/apps/api-reference/patch-shops-shopid-orders-orderid.html
       def update_order(order, options = {}, locale = 'en_GB')
         id = epages_id(order)

data/lib/epages/rest/products.rb

@@ -24,6 +24,15 @@ module Epages
         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
       #
@@ -124,25 +133,6 @@ module Epages
         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 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
       #
@@ -160,6 +150,14 @@ module Epages
       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
     end
   end
 end

data/lib/epages/subscriber.rb

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

data/lib/epages/utils.rb

@@ -52,12 +52,12 @@ module Epages
     # @param hash [Hash]
     def camelize_keys(hash)
       return unless hash.is_a?(Hash)
+      other = {}
       hash.keys.each do |k|
         key = k.to_s.camelize(:lower).to_sym
-        hash[key] = hash[k]
-        hash.delete(k) if key != k
+        other[key] = hash[k]
       end
-      hash
+      other
     end
 
     # return the hash with the keys converted to underscore
@@ -116,5 +116,13 @@ module Epages
     def camelize_words(string)
       string.to_s.gsub(/(\w+)/) { |s| s.camelize(:lower) }
     end
+
+    # return a string that acts as a query parameters (for POST calls)
+    #
+    # @param options [Hash]
+    def to_query_options(options)
+      return '' if !options.is_a?(Hash) || options.empty?
+      "?#{options.map{ |k,v| "#{k}=#{v}" }.join('&')}"
+    end
   end
 end

data/lib/epages/version.rb

@@ -1,3 +1,3 @@
 module Epages
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/epages-rest.rb

@@ -10,6 +10,7 @@ require 'epages/image'
 require 'epages/image_size'
 require 'epages/line_item_container'
 require 'epages/link'
+require 'epages/newsletter'
 require 'epages/order'
 require 'epages/payment_data'
 require 'epages/payment_method_info'
@@ -22,6 +23,7 @@ require 'epages/shipping_data'
 require 'epages/shipping_method'
 require 'epages/shipping_method_info'
 require 'epages/shop'
+require 'epages/subscriber'
 require 'epages/utils'
 require 'epages/variation'
 require 'epages/variation_attribute'
@@ -32,6 +34,7 @@ require 'epages/rest/carts'
 require 'epages/rest/categories'
 require 'epages/rest/customers'
 require 'epages/rest/legal'
+require 'epages/rest/newsletters'
 require 'epages/rest/orders'
 require 'epages/rest/products'
 require 'epages/rest/request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epages-rest
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Domingo Cividanes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/epages/image_size.rb
 - lib/epages/line_item_container.rb
 - lib/epages/link.rb
+- lib/epages/newsletter.rb
 - lib/epages/order.rb
 - lib/epages/payment_data.rb
 - lib/epages/payment_method_info.rb
@@ -90,6 +91,7 @@ files:
 - lib/epages/rest/customers.rb
 - lib/epages/rest/legal.rb
 - lib/epages/rest/miscellaneous.rb
+- lib/epages/rest/newsletters.rb
 - lib/epages/rest/orders.rb
 - lib/epages/rest/products.rb
 - lib/epages/rest/request.rb
@@ -102,6 +104,7 @@ files:
 - lib/epages/shipping_method.rb
 - lib/epages/shipping_method_info.rb
 - lib/epages/shop.rb
+- lib/epages/subscriber.rb
 - lib/epages/utils.rb
 - lib/epages/variation.rb
 - lib/epages/variation_attribute.rb