epages-rest 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fafdb220142f238edcc64a66dc7dd8b45c175ad4
-  data.tar.gz: db9b309d88f49ce649abc04c7776a6d914a05e26
+  metadata.gz: 9e6f19f5ad1f0b8bc0e7663906f8be81128a4535
+  data.tar.gz: f41c9b37e7eb3ecac2ff9de7d6eec000f5f0207a
 SHA512:
-  metadata.gz: d6c7bc46d20543e1bc2e303062a8f1ac8aef70673e95cf035aaa1172419d8871064204f6b18611e3479870f95f848dd398469fb29e86306ae7fa8b5432b091c0
-  data.tar.gz: 3f93d80851535b4d880a0d29e34708047cdfaf48177d418c869a36aa769d3339f6e96cc23cde9325cd1a478cc699597dba309e2967984b2f3d0aebcb3a085041
+  metadata.gz: 747c2442660724bcbffe03750ef9b86294509a8c2c574738f0e6c48b2350535b557d707b2b63bb222952fbfcf481df5bcb7ddcda606e4910e8b2fc210593d3a2
+  data.tar.gz: 590f481c30757145466070a8b6e9624e980c36ea940917fbd565c947363c3e6eeab00d4b00f5b1e132ff7d7be607418034dc902bddef1bbd926b696121ddbe28

data/README.md

@@ -2,9 +2,9 @@
 [![Code Climate](https://codeclimate.com/github/ePages-de/epages-rest-ruby/badges/gpa.svg)](https://codeclimate.com/github/ePages-de/epages-rest-ruby)
 [![Test Coverage](https://codeclimate.com/github/ePages-de/epages-rest-ruby/badges/coverage.svg)](https://codeclimate.com/github/ePages-de/epages-rest-ruby/coverage)
 
-# The Epages REST Ruby Gem
+# The ePages REST Ruby Gem
 
-A Ruby interface to the Epages REST API
+A Ruby interface to the ePages REST API.
 
 ## Installation
 
@@ -20,14 +20,17 @@ or add it to your Rails application adding the gem to your Gemfile.
 
 ## Usage
 
-This gem is used to connect any Ruby application with any [Epages](http://www.epages.com/en/) Shop.
-You can get any public information of any shop indicating only the name of the shop, but for security reasons, to modify content from your shop you need the token you will get in your online shop space.
+This gem is used to connect any Ruby application with any [ePages](http://www.epages.com/en/) shop.
+You can get any public information of any shop indicating only the name of the shop.
+But for security reasons, to modify content from your shop, you need the token you will get in the developer environment of your test shop.
 
 # Usage examples
 
 The first thing is create your REST shop.
 `shop = Epages::REST::Shop.new(shop_host, shop_name)` or `shop = Epages::REST::Shop.new(shop_host, shop_name, token)`
 
+Additionally, you can indicate if your shop uses https or not (default true) `shop = Epages::REST::Shop.new(shop_host, shop_name, token, https: false)`
+
 Once this is done, you can use the API calls.
 
 #### [Get products](https://developer.epages.com/apps/api-reference/get-shops-shopid-products.html)
@@ -37,13 +40,12 @@ Once this is done, you can use the API calls.
 #### [Get Categories](https://developer.epages.com/apps/api-reference/get-shops-shopid-categories.html)
 `categories = shop.categories`
 
-### Full collection of examples [here](https://github.com/mingoscd/epages/tree/master/examples)
+### Full collection of examples [here](https://github.com/ePages-de/epages-rest-ruby/tree/master/examples)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mingoscd/epages.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ePages-de/epages-rest-ruby.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/epages/customer.rb

@@ -0,0 +1,20 @@
+require 'epages/utils'
+
+module Epages
+  class Customer
+    include Epages::Utils
+
+    KEYS = %w(customer_id customer_number creation_date billing_address internal_note links).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:billing_address, data.delete(:billingAddress), Epages::Address)
+      parse_attribute_as_array_of(:links, data.delete(:links), Epages::Link)
+      parse_attribute_as(:creation_date, data.delete(:creationDate), DateTime)
+      parse_attributes(data)
+    end
+
+    alias_method :id, :customer_id
+  end
+end

data/lib/epages/order.rb

@@ -5,12 +5,12 @@ module Epages
   class Order
     include Epages::Utils
 
-    DATE_ATTRS = %w(creation_date invoiced_on shipped_on pending_on archived_on dispatched_on viewed_on
-                    cancelled_on closed_on paid_on returned_on)
+    DATE_ATTRS = %w(creation_date invoiced_on delivered_on pending_on archived_on dispatched_on viewed_on
+                    rejected_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 line_item_container product_line_items shipping_price links internal_note
-               customer_comment shipping_data payment_data)
+               customer_comment customer_number shipping_data payment_data)
 
     KEYS = (ATTRS + DATE_ATTRS).collect(&:to_sym).freeze
 

data/lib/epages/product.rb

@@ -6,16 +6,16 @@ module Epages
     include Epages::Utils
     include Epages::REST::Products
 
-    KEYS = %w(product_id name short_description description images price_info for_sale special_offer delivery_weight
+    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 links product_image).collect(&:to_sym).freeze
+              product_data_sheet sf_url product_number manufacturer upc ean essential_features search_keywords links).collect(&:to_sym).freeze
 
     attr_reader *KEYS
 
     def initialize(data)
       parse_attribute_as_array_of(:images, data.delete(:images), Epages::Image)
       parse_attribute_as_array_of(:links, data.delete(:links), Epages::Link)
-      parse_attribute_as(:priceInfo, data.delete(:priceInfo), Epages::PriceInfo)
+      parse_attribute_as(:price_info, data.delete(:priceInfo), Epages::PriceInfo)
       parse_attributes(data)
     end
 

data/lib/epages/rest/api.rb

@@ -1,5 +1,6 @@
 require 'epages/rest/carts'
 require 'epages/rest/categories'
+require 'epages/rest/customers'
 require 'epages/rest/legal'
 require 'epages/rest/miscellaneous'
 require 'epages/rest/orders'
@@ -12,6 +13,7 @@ module Epages
     module API
       include REST::Carts
       include REST::Categories
+      include REST::Customers
       include REST::Legal
       include REST::Miscellaneous
       include REST::Orders

data/lib/epages/rest/customers.rb

@@ -0,0 +1,37 @@
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implements the calls in https://developer.epages.com/apps/api-reference/resource-customers.html
+    module Customers
+      include REST::Utils
+
+      # 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
+      #
+      # @param options [Hash]
+      def create_customer(options = {})
+        perform_post_with_object('/customers', options, Epages::Customer)
+      end
+
+      # call the API and returns a specified customer
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-customers-customerid.html
+      #
+      # @param customer [String], [Epages::Customer]
+      def customer(customer)
+        id = epages_id(customer)
+        perform_get_with_object("/customers/#{id}", {}, Epages::Customer)
+      end
+
+      # call the API to update the information for a single customer
+      # implements the call https://developer.epages.com/apps/api-reference/patch-shops-shopid-customers-customerid.html
+      #
+      # @param customer [String], [Epages::Product]
+      # @param options [Hash]
+      def update_customer(customer, options = {})
+        id = epages_id(customer)
+        perform_patch_with_object("/customers/#{id}", options, Epages::Customer)
+      end
+    end
+  end
+end

data/lib/epages/rest/miscellaneous.rb

@@ -7,6 +7,12 @@ module Epages
     module Miscellaneous
       include Epages::Utils
 
+      # implements the cal https://developer.epages.com/apps/api-reference/get-shops-shopid.html
+      def info(options = {})
+        response = perform_get_request('/', options)
+        underscorize_keys(response)
+      end
+
       # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-locales.html
       def locales
         perform_get_request('/locales', {})

data/lib/epages/rest/orders.rb

@@ -18,12 +18,18 @@ module Epages
       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')
+      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)
+        perform_patch_with_object("/orders/#{id}?locale=#{locale}", options, Epages::Order)
+      end
     end
   end
 end

data/lib/epages/rest/products.rb

@@ -143,6 +143,16 @@ module Epages
         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
+      #
+      # @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
       #

data/lib/epages/rest/request.rb

@@ -10,7 +10,7 @@ module Epages
 
       def initialize(object, request_method, path, options = {})
         @shop = build_shop_from(object)
-        @uri = URI.parse("https://#{@shop.host}/rs/shops/#{@shop.name.to_s + path}")
+        @uri = URI.parse("#{@shop.protocol}://#{@shop.host}/rs/shops/#{@shop.name.to_s + path}")
         @path = uri.path
         set_request_options(request_method, options)
       end

data/lib/epages/rest/utils.rb

@@ -131,7 +131,7 @@ module Epages
       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")
+        object.send(:id)
       end
 
       def parse_product_variations(data)

data/lib/epages/shop.rb

@@ -2,12 +2,13 @@ require 'epages/error'
 
 module Epages
   class Shop
-    attr_accessor :host, :name, :token
+    attr_reader :host, :name, :token, :protocol
 
-    def initialize(host, name, token = nil)
+    def initialize(host, name, token = nil, options = { https: true })
       @host = host
       @name = name
       @token = token
+      @protocol = options[:https] ? 'https' : 'http'
     end
 
     # return the shop name

data/lib/epages/version.rb

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

data/lib/epages-rest.rb

@@ -3,6 +3,7 @@ require 'epages/base_price'
 require 'epages/cart'
 require 'epages/category'
 require 'epages/content_page_summary'
+require 'epages/customer'
 require 'epages/custom_attribute'
 require 'epages/error'
 require 'epages/image'
@@ -29,6 +30,7 @@ require 'epages/version'
 require 'epages/rest/api'
 require 'epages/rest/carts'
 require 'epages/rest/categories'
+require 'epages/rest/customers'
 require 'epages/rest/legal'
 require 'epages/rest/orders'
 require 'epages/rest/products'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epages-rest
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Domingo Cividanes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/epages/category.rb
 - lib/epages/content_page_summary.rb
 - lib/epages/custom_attribute.rb
+- lib/epages/customer.rb
 - lib/epages/error.rb
 - lib/epages/image.rb
 - lib/epages/image_size.rb
@@ -86,6 +87,7 @@ files:
 - lib/epages/rest/api.rb
 - lib/epages/rest/carts.rb
 - lib/epages/rest/categories.rb
+- lib/epages/rest/customers.rb
 - lib/epages/rest/legal.rb
 - lib/epages/rest/miscellaneous.rb
 - lib/epages/rest/orders.rb