epages-rest 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6676eb9661237a4c3595dbd3a4bfc5a6829be2df
+  data.tar.gz: daa58bb9a83513b666ca159396241621326fe257
+SHA512:
+  metadata.gz: 6f36af9de4320fa9d55a5f8f5989de42ae7c94bf36b16ab16e66115883a3ada633eac7d60da6f8ab2e864c1198c4ceed035c23c3ba9ba74459ef174fc0facecc
+  data.tar.gz: 2679ccd11eea7de87ed145f9e0b92749b02aed185c1ce752846ec906ccb995ad1a6914f241d6013a0488ce3e6f1f8e31a1dcfbae7c8ac13fb99065f2dd0c1934

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Domingo Cividanes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# The Epages REST Ruby Gem
+
+A Ruby interface to the Epages REST API
+
+## Installation
+
+```
+gem install epages-rest
+```
+
+You can require it in the Ruby Interpreter using:
+```
+require 'epages-rest'
+```
+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.
+
+# Usage examples
+
+The first thing is create your REST shop.
+`shop = Epages::REST::Shop.new('shop_name')` or `shop = Epages::REST::Shop.new('shop_name', 'token')`
+
+Once this is done, you can use the API calls.
+
+#### [Get products](https://developer.epages.com/apps/api-reference/get-shops-shopid-products.html)
+`products = shop.products`
+`sorted_products = shop.products(sort: name)`
+
+#### [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)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mingoscd/epages.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/epages-rest.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epages/version'
+
+Gem::Specification.new do |spec|
+  spec.version       = Epages::VERSION
+  spec.name          = 'epages-rest'
+  spec.authors       = ['Domingo Cividanes']
+  spec.email         = ['dcividanes91@gmail.com', 'dcividanes@epages.com']
+  spec.description   = 'A Ruby interface that allows to integrate any Epages Shop with any ruby framework via Epages Rest API.'
+  spec.summary       = 'A Ruby interface to the Epages Rest API.'
+  spec.homepage      = 'https://github.com/ePages-de/epages-rest-ruby'
+  spec.license       = 'MIT'
+
+  spec.require_paths = %w(lib)
+  spec.files         = %w(LICENSE.txt README.md epages-rest.gemspec) + Dir['lib/**/*.rb']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_dependency 'http', '~> 0.9.4'
+  spec.add_dependency 'activesupport', '~> 4.2'
+end

data/lib/epages/address.rb

@@ -0,0 +1,29 @@
+require 'epages/utils'
+
+module Epages
+  class Address
+    include Epages::Utils
+
+    KEYS = %w(company salutation title first_name last_name street street_details zip_code
+              city state country vat_id birthday email_address).collect(&:to_sym).freeze
+
+    attr_accessor *KEYS
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+
+    def to_json
+      {
+        firstName: first_name,
+        lastName: last_name,
+        street: street,
+        zipCode: zip_code,
+        city: city,
+        country: country,
+        birthday: birthday,
+        emailAddress: email_address,
+      }
+    end
+  end
+end

data/lib/epages/base_price.rb

@@ -0,0 +1,16 @@
+require 'epages/utils'
+
+module Epages
+  class BasePrice
+    include Epages::Utils
+
+    KEYS = %w(ref_quantity ref_price formatted quantity).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:ref_price, data.delete(:refPrice), Epages::Price)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/cart.rb

@@ -0,0 +1,18 @@
+require 'epages/utils'
+
+module Epages
+  class Cart
+    include Epages::Utils
+
+    KEYS = %w(cart_id billing_address shipping_address line_item_container min_cart_value checkout_url).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      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_attributes(data)
+    end
+  end
+end

data/lib/epages/category.rb

@@ -0,0 +1,25 @@
+require 'epages/utils'
+require 'epages/error'
+
+module Epages
+  class Category
+    include Epages::Utils
+
+    KEYS = %w(category_id name page_title description special_offer images parent sub_categories sf_url links).collect(&:to_sym).freeze
+
+    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) }
+      @parent = Epages::Link.new(data.delete(:parent)) if data[:parent]
+      parse_attributes(data)
+    end
+
+    def ==(other)
+      return false if other.class != Epages::Category
+      category_id == other.category_id && name == other.name
+    end
+  end
+end

data/lib/epages/content_page_summary.rb

@@ -0,0 +1,13 @@
+require 'epages/utils'
+
+module Epages
+  class ContentPageSummary
+    include Epages::Utils
+
+    attr_accessor :name
+
+    def initialize(data)
+      @name = data[:name]
+    end
+  end
+end

data/lib/epages/custom_attribute.rb

@@ -0,0 +1,20 @@
+require 'epages/utils'
+
+module Epages
+  class CustomAttribute
+    include Epages::Utils
+
+    KEYS = %w(key display_key single_value type values).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+
+    # return a Hash with the display value as key and an array with all the displayValue as value
+    def formatted_attributes
+      Hash[display_key.downcase.to_sym, values.collect { |el| el[:displayValue] }]
+    end
+  end
+end

data/lib/epages/error.rb

@@ -0,0 +1,61 @@
+module Epages
+  class Error < StandardError
+    attr_reader :code
+
+    # Raised when a 4xx HTTP status code is returned
+    ClientError = Class.new(self)
+
+    # HTTP status code 400, 401, 403, 404, 406, 422, 429 respectively
+    BadRequest =          Class.new(ClientError)
+    Unauthorized =        Class.new(ClientError)
+    Forbidden =           Class.new(ClientError)
+    NotFound =            Class.new(ClientError)
+    NotAcceptable =       Class.new(ClientError)
+    UnprocessableEntity = Class.new(ClientError)
+    TooManyRequests =     Class.new(ClientError)
+
+    # Raised when a 5xx HTTP status code is returned
+    ServerError = Class.new(self)
+
+    # HTTP status code 500, 502, 503, 504 respectively
+    InternalServerError = Class.new(ServerError)
+    BadGateway =          Class.new(ServerError)
+    ServiceUnavailable =  Class.new(ServerError)
+    GatewayTimeout =      Class.new(ServerError)
+
+    ERRORS = {
+      400 => Epages::Error::BadRequest,
+      401 => Epages::Error::Unauthorized,
+      403 => Epages::Error::Forbidden,
+      404 => Epages::Error::NotFound,
+      406 => Epages::Error::NotAcceptable,
+      422 => Epages::Error::UnprocessableEntity,
+      429 => Epages::Error::TooManyRequests,
+      500 => Epages::Error::InternalServerError,
+      502 => Epages::Error::BadGateway,
+      503 => Epages::Error::ServiceUnavailable,
+      504 => Epages::Error::GatewayTimeout,
+    }
+
+  private
+
+    def parse_error(body)
+      if body.nil? || body.empty?
+        ['', nil]
+      elsif body[:error]
+        [body[:error], nil]
+      elsif body[:errors]
+        extract_message_from_errors(body)
+      end
+    end
+
+    def extract_message_from_errors(body)
+      first = Array(body[:errors]).first
+      if first.is_a?(Hash)
+        [first[:message].chomp, first[:code]]
+      else
+        [first.chomp, nil]
+      end
+    end
+  end
+end

data/lib/epages/image.rb

@@ -0,0 +1,13 @@
+require 'epages/utils'
+
+module Epages
+  class Image
+    include Epages::Utils
+
+    attr_reader :url, :classifier
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/image_size.rb

@@ -0,0 +1,26 @@
+require 'epages/utils'
+
+module Epages
+  class ImageSize
+    include Epages::Utils
+
+    attr_accessor :images
+
+    def initialize(data)
+      parse_attribute_as_array_of(:images, data[:sizes], Epages::Image)
+    end
+
+    # return a sorted array with the name of all available sizes
+    def sizes
+      images.collect(&:classifier).sort
+    end
+
+    # return the link of image with the indicated size
+    #
+    # @param size [String]. The name of the image classifier
+    def size_link(size)
+      link = images.find { |i| i.classifier == size }
+      link ? link.url : nil
+    end
+  end
+end

data/lib/epages/line_item_container.rb

@@ -0,0 +1,19 @@
+require 'epages/utils'
+
+module Epages
+  class LineItemContainer
+    include Epages::Utils
+
+    KEYS = %w(grand_total total_before_tax total_tax line_items_sub_total product_line_items shipping_price).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:grand_total, data[:grandTotal], Epages::Price)
+      parse_attribute_as(:total_before_tax, data[:totalBeforeTax], Epages::Price)
+      parse_attribute_as(:total_tax, data[:totalTax], Epages::Price)
+      parse_attribute_as(:line_items_sub_total, data[:lineItemsSubTotal], Epages::Price)
+      parse_attribute_as_array_of(:product_line_items, data[:productLineItems], Epages::ProductLineItem)
+    end
+  end
+end

data/lib/epages/link.rb

@@ -0,0 +1,13 @@
+require 'epages/utils'
+
+module Epages
+  class Link
+    include Epages::Utils
+
+    attr_reader :rel, :href, :title
+
+    def initialize(data)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/order.rb

@@ -0,0 +1,28 @@
+require 'epages/utils'
+require 'epages/error'
+
+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)
+
+    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)
+
+    KEYS = (ATTRS + DATE_ATTRS).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      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_attributes(data)
+    end
+  end
+end

data/lib/epages/price.rb

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

data/lib/epages/price_info.rb

@@ -0,0 +1,18 @@
+require 'epages/utils'
+require 'epages/price'
+
+module Epages
+  class PriceInfo
+    include Epages::Utils
+
+    KEYS = %w(quantity price deposit_price eco_participation_price price_with_deposits manufacturer_price base_price).collect(&:to_sym).freeze
+
+    attr_reader *KEYS
+
+    def initialize(data)
+      parse_attribute_as(:quantity, data.delete(:quantity))
+      parse_attribute_as(:base_price, data.delete(:basePrice), Epages::BasePrice)
+      parse_attributes(data, Epages::Price)
+    end
+  end
+end

data/lib/epages/product.rb

@@ -0,0 +1,87 @@
+require 'epages/utils'
+require 'epages/rest/products'
+
+module Epages
+  class Product
+    include Epages::Utils
+    include Epages::REST::Products
+
+    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
+
+    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_attributes(data)
+    end
+
+    # compare the product with another product. 2 products are considered equals if both has
+    # the same id, the same name and the same product_number
+    def ==(other)
+      return false unless other.is_a? Epages::Product
+      product_id == other.product_id && name == other.name && product_number == other.product_number
+    end
+
+    # returns the name of the shop that belongs the product
+    def shop_name
+      sf_url[%r{epages\/(\w+)}, 1]
+    end
+
+    # returns the list of links
+    def links_title
+      links.collect(&:rel)
+    end
+
+    # returns true if [name] is included in the list of links
+    def link?(name)
+      links_title.include? name
+    end
+
+    # returns the list of slides of the product
+    def slideshow
+      product_slideshow(self) if link?('slideshow')
+    end
+
+    # returns the list of variations of the product
+    def variations
+      product_variations(self) if link?('variations')
+    end
+
+    # returns the list of custom_attributes of the product
+    def custom_attributes
+      product_custom_attributes(self) if link?('custom-attributes')
+    end
+
+    # returns the categories of the product
+    def categories
+      product_categories(self) if link?('categories')
+    end
+
+    # returns the lowest price of all the variations of the product
+    def lowest_price
+      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}
+    end
+  end
+end

data/lib/epages/product_line_item.rb

@@ -0,0 +1,20 @@
+require 'epages/utils'
+
+module Epages
+  class ProductLineItem
+    include Epages::Utils
+
+    KEYS = %w(line_item_id sku name product_id quantity line_item_price single_item_price images 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(:quantity, data.delete(:quantity))
+      parse_attribute_as(:line_item_price, data.delete(:lineItemPrice), Epages::Price)
+      parse_attribute_as(:single_item_price, data.delete(:singleItemPrice), Epages::Price)
+      parse_attributes(data)
+    end
+  end
+end

data/lib/epages/rest/api.rb

@@ -0,0 +1,21 @@
+require 'epages/rest/carts'
+require 'epages/rest/categories'
+require 'epages/rest/legal'
+require 'epages/rest/miscellaneous'
+require 'epages/rest/orders'
+require 'epages/rest/products'
+require 'epages/rest/shipping_methods'
+
+module Epages
+  module REST
+    module API
+      include REST::Carts
+      include REST::Categories
+      include REST::Legal
+      include REST::Miscellaneous
+      include REST::Orders
+      include REST::Products
+      include REST::ShippingMethods
+    end
+  end
+end

data/lib/epages/rest/carts.rb

@@ -0,0 +1,71 @@
+require 'epages/utils'
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    # implements the calls in https://developer.epages.com/apps/api-reference/resource-carts.html
+    module Carts
+      include REST::Utils
+
+      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-carts.html
+      def create_cart(data = {})
+        default = {currency: 'EUR', taxType: 'GROSS', locale: 'en_GB', lineItems: []}
+        perform_post_with_object('/carts', default.merge(camelize_keys(data)), Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/get-shops-shopid-carts-cartid.html
+      def cart(cart)
+        id = epages_id(cart)
+        perform_get_with_object("/carts/#{id}", {}, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/post-shops-shopid-carts-cartid-line-items.html
+      def cart_line_item(cart, product, quantity = 1)
+        id = epages_id(cart)
+        lineitem = product.is_a?(Epages::Product) ? product.to_line_item(quantity) : product
+        perform_post_with_object("/carts/#{id}/line-items", lineitem, Epages::Cart)
+      end
+      alias_method :add_product_to_cart, :cart_line_item
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-carts-cartid-line-items-lineitemid.html
+      def update_cart_line_item(cart, lineitem, options)
+        id = epages_id(cart)
+        lineitem = lineitem.line_item_id if lineitem.is_a?(Epages::ProductLineItem)
+        perform_put_with_object("/carts/#{id}/line-items/#{lineitem}", options, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-carts-cartid-line-items-lineitemid.html
+      def delete_cart_line_item(cart, lineitem)
+        id = epages_id(cart)
+        lineitem = lineitem.line_item_id if lineitem.is_a?(Epages::ProductLineItem)
+        perform_delete_with_object("/carts/#{id}/line-items/#{lineitem}", {}, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-carts-cartid-billing-address.html
+      def update_cart_billing_address(cart, address)
+        id = epages_id(cart)
+        address = address.to_json if address.is_a?(Epages::Address)
+        perform_put_with_object("/carts/#{id}/billing-address", address, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-carts-cartid-billing-address.html
+      def delete_billing_address(cart)
+        id = epages_id(cart)
+        perform_delete_with_object("/carts/#{id}/billing-address", {}, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/put-shops-shopid-carts-cartid-shipping-address.html
+      def update_cart_shipping_address(cart, address)
+        id = epages_id(cart)
+        address = address.to_json if address.is_a?(Epages::Address)
+        perform_put_with_object("/carts/#{id}/shipping-address", address, Epages::Cart)
+      end
+
+      # implements the call https://developer.epages.com/apps/api-reference/delete-shops-shopid-carts-cartid-shipping-address.html
+      def delete_shipping_address(cart)
+        id = epages_id(cart)
+        perform_delete_with_object("/carts/#{id}/shipping-address", {}, Epages::Cart)
+      end
+    end
+  end
+end

data/lib/epages/rest/categories.rb

@@ -0,0 +1,28 @@
+require 'epages/rest/utils'
+
+module Epages
+  module REST
+    module Categories
+      # implements the calls in https://developer.epages.com/apps/api-reference/resource-category.html
+      include REST::Utils
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/get-shops-shopid-categories.html
+      def categories(options = {})
+        perform_get_with_objects('/categories', options, Epages::Category)
+      end
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/get-shops-shopid-categories-categoryid.html
+      def category(object, options = {})
+        id = epages_id(object)
+        perform_get_with_object("/categories/#{id}", options, Epages::Category)
+      end
+
+      # implements the calls in https://developer.epages.com/apps/api-reference/put-shops-shopid-categories-categoryid.html
+      def update_category(object, options)
+        id = epages_id(object)
+        options[:categoryId] = id
+        perform_put_with_object("/categories/#{id}", options, Epages::Category)
+      end
+    end
+  end
+end