auchandirect-scrAPI 0.0.1

data/lib/auchandirect/scrAPI/dummy_cart.rb

@@ -0,0 +1,128 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/dummy_cart.rb
+#
+# Copyright (c) 2011-2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Auchandirect
+  module ScrAPI
+
+    # Logger mock api
+    class DummyCart < BaseCart
+
+      def self.url
+        "http://www.#{Storexplore::Testing::DummyStoreConstants::NAME}.com"
+      end
+      def self.valid_email
+        "valid@mail.com"
+      end
+      def self.valid_password
+        "valid-password"
+      end
+
+      def self.logout_url
+        url+"/logout"
+      end
+      def self.login_url
+        url+"/login"
+      end
+      def self.login_parameters(login,password)
+        [{'name' => 'session_data', 'value' => 'crypted_data', 'type' => 'hidden'},
+         {'name' => login_parameter, 'value' => login, 'type' => 'text'},
+         {'name' => password_parameter, 'value' => password, 'type' => 'password'}]
+      end
+      def self.login_parameter
+        'login'
+      end
+      def self.password_parameter
+        'password'
+      end
+
+      attr_reader :login, :password, :log
+
+      def initialize(login = nil, password = nil)
+        @log = []
+        @login = ""
+        @password = ""
+        @unavailable_items = {}
+        @content = Hash.new(0)
+
+        if !login.nil? || !password.nil?
+          relog(login, password)
+        end
+      end
+
+      def relog(login, password)
+        if login != DummyCart.valid_email
+          raise InvalidAccountError.new
+        end
+
+        @log.push(:login)
+        @login = login
+        @password = password
+      end
+
+      def logout
+        @log.push(:logout)
+      end
+
+      def empty_the_cart
+        @log.push(:empty_the_cart)
+        @content.clear
+      end
+
+      def add_to_cart(quantity, item)
+        if available?(item)
+          @log.push(:add_to_cart)
+          @content[item] += quantity
+        end
+      end
+
+      def cart_value
+        @content.to_a.inject(0.0) do |amount,id_and_quantity|
+          item = id_and_quantity.first
+          quantity = id_and_quantity.last
+
+          unit_price = item.hash.abs.to_f/1e7
+
+          amount + quantity * unit_price
+        end
+      end
+
+      def content
+        @content.keys
+      end
+
+      def empty?
+        @content.empty?
+      end
+
+      def containing?(item, quantity)
+        @content[item] == quantity
+      end
+
+      def add_unavailable_item(item)
+        @unavailable_items[item] = true
+      end
+      def available?(item)
+        !@unavailable_items[item]
+      end
+
+    end
+  end
+end

data/lib/auchandirect/scrAPI/invalid_account_error.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/invalid_account_error.rb
+#
+# Copyright (c) 2011-2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Auchandirect
+  module ScrAPI
+    class InvalidAccountError < RuntimeError
+    end
+  end
+end

data/lib/auchandirect/scrAPI/items.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/items.rb
+#
+# Copyright (c) 2010-2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Auchandirect
+  module ScrAPI
+
+    module Items
+      NAMES_SEPARATOR = ', '
+    end
+
+    Storexplore::Api.define "auchandirect.fr" do
+
+      categories '#footer-menu h2 a' do
+        attributes do
+          { name: page.get_one('#content .titre-principal').content }
+        end
+
+        categories '#content .menu-listes h2 a' do
+          attributes do
+            { name: page.get_one('#content .titre-principal').content }
+          end
+
+          categories '#content .bloc_prd > a' do
+            attributes do
+              { :name => page.get_one("#wrap-liste-produits-nav .titre-principal").content }
+            end
+
+            items '.infos-produit-2 > a' do
+              attributes do
+                {
+                  :brand => page.get_one('#produit-infos .titre-principal').content,
+                  :name => page.get_all('#produit-infos .titre-annexe, #produit-infos .titre-secondaire', Items::NAMES_SEPARATOR),
+                  :price => page.get_one('#produit-infos .prix-actuel > span, #produit-infos .bloc-prix-promo > span.prix-promo').content.to_f,
+                  :image => page.get_image('#produit-infos img.produit').url.to_s,
+                  :remote_id => /\/([^\/\.]*)[^\/]*$/.match(uri.to_s)[1]
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auchandirect/scrAPI/version.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/version.rb
+#
+# Copyright (c) 2010-2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Auchandirect
+  module ScrAPI
+    VERSION = "0.0.1"
+  end
+end
+

data/lib/auchandirect/scrAPI/webrick_uri_escape_monkey_patch.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+#
+# lib/auchandirect/scrAPI/webrick_uri_escape_monkey_patch.rb
+#
+# Copyright (C) 2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+require "webrick/httputils"
+
+# monkey patch to avoid a regex uri encoding error when importing
+#      incompatible encoding regexp match (ASCII-8BIT regexp with UTF-8 string) (Encoding::CompatibilityError)
+#      .../webrick/httputils.rb:353:in `gsub'
+#      .../webrick/httputils.rb:353:in `_escape'
+#      .../webrick/httputils.rb:363:in `escape'
+#      from uri method
+#
+# I would be glad to find a better way to fix this !
+
+module WEBrick::HTTPUtils
+  def self.escape(s)
+    URI.escape(s)
+  end
+end

data/spec/lib/auchandirect/scrAPI/cart_shared_examples.rb

@@ -0,0 +1,189 @@
+# -*- encoding: utf-8 -*-
+#
+# spec/lib/auchandirect/scrAPI/cart_shared_examples.rb
+#
+# Copyright (C) 2011-2014 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+require 'spec_helper'
+
+shared_examples_for "Any Cart" do |store_cart_class, store_url|
+
+  before :all do
+    @store_url = store_url
+  end
+
+  it "should know its logout url" do
+    logout_url = store_cart_class.logout_url
+
+    expect(logout_url).to(match(URI.regexp(['http'])), "#{logout_url} is not an http url !")
+  end
+
+  it "should know its login url" do
+    expect(store_cart_class.login_url).not_to be_empty
+  end
+
+  it "should know its login parameters" do
+    expect(store_cart_class.login_parameters(store_cart_class.valid_email, store_cart_class.valid_password)).not_to be_nil
+  end
+
+  {login_parameter: 'text', password_parameter: 'password'}.each do |parameter_reader, html_input_type|
+    it "should know its #{parameter_reader} name" do
+      parameter_name = store_cart_class.send(parameter_reader)
+      expect(parameter_name).not_to be_empty
+
+      param = store_cart_class.login_parameters("","").find{|param| param['name'] == parameter_name}
+      expect(param).not_to be_nil
+      expect(param['type']).to eq(html_input_type)
+    end
+  end
+
+  it "should raise when login in with an invalid account" do
+    expect(lambda {
+             store_cart_class.login("unknown-account", "wrong-password")
+           }).to raise_error(Auchandirect::ScrAPI::InvalidAccountError)
+  end
+
+  context "with a valid account" do
+
+    attr_reader :sample_item_id, :another_item_id, :store_cart_api
+
+    before(:all) do
+      @api = store_cart_class.login(store_cart_class.valid_email, store_cart_class.valid_password)
+
+      sample_items = extract_sample_items
+      sample_item = sample_items.next
+      @sample_item_id = sample_item.attributes[:remote_id]
+      @another_item_id = extract_another_item_id(sample_items, sample_item)
+    end
+    before(:each) do
+      @api.empty_the_cart
+    end
+
+    after(:all) do
+      @api.logout
+    end
+
+    # Some tests are redudant with what is item extractions, but the followings
+    # are clearer about what is expected from the cart
+
+    it "should set the cart value to 0 when emptying the cart" do
+      @api.add_to_cart(1, sample_item_id)
+
+      @api.empty_the_cart
+      expect(@api.cart_value).to eq 0
+    end
+
+    it "should set the cart value to something greater than 0 when adding items to the cart" do
+      @api.empty_the_cart
+
+      @api.add_to_cart(1, sample_item_id)
+      expect(@api.cart_value).to be > 0
+    end
+
+    it "should set the cart value to 2 times that of one item when adding 2 items" do
+      @api.empty_the_cart
+
+      @api.add_to_cart(1, sample_item_id)
+      item_price = @api.cart_value
+
+      @api.add_to_cart(1, sample_item_id)
+      expect(@api.cart_value).to eq 2*item_price
+    end
+
+    it "should set different cart values with different items" do
+      sample_item_cart_value = cart_value_with_item(sample_item_id)
+      another_item_cart_value = cart_value_with_item(another_item_id)
+
+      expect(sample_item_cart_value).not_to eq another_item_cart_value
+    end
+
+    it "should synchronize different sessions with logout login" do
+      @api.add_to_cart(1, sample_item_id)
+
+      api2 = store_cart_class.login(store_cart_class.valid_email, store_cart_class.valid_password)
+      begin
+        api2.empty_the_cart
+      ensure
+        api2.logout
+      end
+
+      @api.logout
+      @api = store_cart_class.login(store_cart_class.valid_email, store_cart_class.valid_password)
+
+      expect(@api.cart_value).to eq 0
+    end
+
+    private
+
+    def extract_another_item_id(sample_items, sample_item)
+      another_item = sample_item
+      while sample_item.attributes[:price] == another_item.attributes[:price]
+        another_item = sample_items.next
+      end
+      another_item.attributes[:remote_id]
+    end
+
+    def extract_sample_items
+      extract_sample_items_from(Storexplore::Api.browse(@store_url))
+    end
+
+    def extract_sample_items_from(category)
+      items = find_available_items(category)
+
+      sub_items = nationaly_available_first(category.categories).lazy.map do |sub_category|
+        extract_sample_items_from(sub_category)
+      end
+
+      [items, sub_items].lazy.flatten
+    end
+
+    def find_available_items(category)
+      nationaly_available_first(category.items)
+        .find_all {|item| item_available?(item.attributes[:remote_id]) }
+    end
+
+    def item_available?(item_id)
+      @api.empty_the_cart
+      @api.add_to_cart(1, item_id)
+      item_price = @api.cart_value
+      return false if 0 == item_price
+
+      @api.add_to_cart(1, item_id)
+      return @api.cart_value == item_price * 2
+    end
+
+    def nationaly_available_first(elements)
+      # Sometimes the tests used to fail because the sample item was not available
+      # in the geographical region of the test user.
+      milks, others = elements.partition { |element| is_milk(element) }
+      milks + others
+    end
+
+    def is_milk(element)
+      ["lait", "crème"].any? do |word|
+        element.title.downcase.include?(word)
+      end
+    end
+
+    def cart_value_with_item(item_id)
+      @api.empty_the_cart
+      @api.add_to_cart(1, item_id)
+      @api.cart_value
+    end
+  end
+end