auchandirect-scrAPI 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d467fe59e8fbdaec06eac26018e63a1f35144ee6
+  data.tar.gz: 0e6fa119d92864dda09e498dbcee4f388c70b1b7
+SHA512:
+  metadata.gz: 6d5dcb57103f62abc269e1ba4c73e09d3db88c5df6e654eb590dbff2fc3d2d600b06d30a429b9a85ee71b05dca6bd945d066621856cfdf6ee520945540221f95
+  data.tar.gz: 866b9b4bff3e1819ddb3a63b816e466a381ab37469f60825d54ec91929914c7df4a1968a0a590553830d13116030d1be0af0acd81963199783dad02c7bc0254e

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-version
+Gemfile.lock
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# emacs files
+*~
+*#
+.#*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 2.0.0
+  - jruby-head
+  - jruby-21mode
+  - jruby-20mode
+script: bundle exec rake
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  # no lazy for enumerators in jruby
+  - rvm: jruby-head
+  - rvm: jruby-21mode
+  - rvm: jruby-20mode
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auchandirect-scrAPI.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,29 @@
+# Auchandirect::ScrAPI
+
+A ruby gem providing, through scrapping, an API to the french www.auchandirect.com online grocery
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'auchandirect-scrAPI'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auchandirect-scrAPI
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/auchandirect-scrAPI.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auchandirect/scrAPI/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auchandirect-scrAPI"
+  spec.version       = Auchandirect::ScrAPI::VERSION
+  spec.authors       = ["Philou"]
+  spec.email         = ["philippe.bourgau@gmail.com"]
+  spec.description   = %q{Through scrapping, an API to the french www.auchandirect.com online grocery}
+  spec.summary       = %q{auchandirect.com grocery API}
+  spec.homepage      = "https://github.com/philou/auchandirect-scrAPI"
+  spec.license       = "LGPL v3"
+
+  spec.files         = `git ls-files`.split($/).reject {|f| f.match(/^offline_sites/)}
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'storexplore', '~> 0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
+  spec.add_development_dependency "net-ping", "~> 1.7"
+  spec.add_development_dependency "spec_combos", "~> 0.2"
+
+end

data/lib/auchandirect/scrAPI.rb

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI.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
+
+require 'storexplore'
+require 'auchandirect/scrAPI/version'
+require 'auchandirect/scrAPI/items'
+require 'auchandirect/scrAPI/base_cart'
+require 'auchandirect/scrAPI/dummy_cart'
+require 'auchandirect/scrAPI/cart'
+require 'auchandirect/scrAPI/invalid_account_error'
+require 'auchandirect/scrAPI/webrick_uri_escape_monkey_patch'

data/lib/auchandirect/scrAPI/base_cart.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/base_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
+
+    # Objects providing an api like access to third party online stores
+    class BaseCart
+
+      class << self
+        alias :login :new
+      end
+
+      # main url of the store
+      # def self.url
+      def url
+        self.class.url
+      end
+
+      # url at which a client browser can login
+      # def self.login_url
+
+      # parameters for a client side login
+      # def self.login_parameters(login, password)
+
+      # login and password parameters names
+      # def self.login_parameter
+      # def self.password_parameter
+
+      # url at which a client browser can logout
+      # def self.logout_url
+
+      # logs in to the remote store
+      # def initialize(login, password)
+
+      # logs out from the store
+      # def logout
+
+      # total value of the remote cart
+      # def cart_value
+
+      # empties the cart of the current user
+      # def empty_the_cart
+
+      # adds items to the cart of the current user
+      # def add_to_cart_cart(quantity, item_remote_id)
+
+    end
+  end
+end

data/lib/auchandirect/scrAPI/cart.rb

@@ -0,0 +1,173 @@
+# -*- encoding: utf-8 -*-
+#
+# auchandirect/scrAPI/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
+
+require 'json'
+
+module Auchandirect
+  module ScrAPI
+
+    # Store API for AuchanDirect store
+    class Cart < BaseCart
+
+      # main url of the store
+      def self.url
+        "http://www.auchandirect.fr"
+      end
+
+      # Logins to auchan direct store
+      def initialize(login, password)
+        @agent = Mechanize.new
+        do_login(login, password)
+        raise InvalidAccountError unless logged_in?
+      end
+
+      # url at which a client browser can login
+      def self.login_url
+        url + login_path
+      end
+      # parameters for a client side login
+      def self.login_parameters(login, password)
+        default_params = post_parameters.map {|name, value| {'name' => name, 'value' => value, 'type' => 'hidden'}}
+        user_params = [{'name' => FORMDATA_PARAMETER, 'value' => login_form_data(Mechanize.new), 'type' => 'hidden'},
+                       {'name' => LOGIN_PARAMETER, 'value' => login, 'type' => 'text'},
+                       {'name' => PASSWORD_PARAMETER, 'value' => password, 'type' => 'password'}]
+
+        default_params + user_params
+      end
+
+      # login and password parameters names
+      def self.login_parameter
+        LOGIN_PARAMETER
+      end
+      def self.password_parameter
+        PASSWORD_PARAMETER
+      end
+
+      # url at which a client browser can logout
+      def self.logout_url
+        url + logout_path
+      end
+
+      # logs out from the store
+      def logout
+        get(self.class.logout_path)
+      end
+
+      # total value of the remote cart
+      def cart_value
+        cart_page = get("/monpanier")
+        cart_page.search("span.prix-total").first.content.gsub(/€$/,"").to_f
+      end
+
+      # empties the cart of the current user
+      def empty_the_cart
+        post("/boutiques.blockzones.popuphandler.cleanbasketpopup.cleanbasket")
+      end
+
+      # adds items to the cart of the current user
+      def add_to_cart(quantity, item_remote_id)
+        quantity.times do
+          post("/boutiques.mozaique.thumbnailproduct.addproducttobasket/#{item_remote_id}")
+        end
+      end
+
+      private
+
+      def do_login(login,password)
+        formdata = login_form_data(@agent)
+
+        post(login_path,
+             FORMDATA_PARAMETER => formdata,
+             LOGIN_PARAMETER => login,
+             PASSWORD_PARAMETER => password)
+      end
+
+      def self.login_path
+        "/boutiques.blockzones.popuphandler.authenticatepopup.authenticateform"
+      end
+
+      def self.login_form_data(agent)
+        home_page = agent.get(Cart.url)
+
+        login_form_json = post(agent, "/boutiques.paniervolant.customerinfos:showsigninpopup", {}, {'Referer' => home_page.uri})
+
+        html_body = JSON.parse(login_form_json.body)["zones"]["secondPopupZone"]
+        doc = Nokogiri::HTML("<html><body>#{html_body}</body></html>")
+        doc.xpath("//input[@name='#{FORMDATA_PARAMETER}']/@value").first.content
+      end
+
+      def logged_in?
+        main_page = get("/Accueil")
+        !main_page.body.include?("Identifiez-vous")
+      end
+
+      def get(path)
+        @agent.get(url + path)
+      end
+
+      def post(path, parameters = {}, headers = {})
+        self.class.post(@agent, path, parameters, headers)
+      end
+
+      def self.post(agent, path, parameters = {}, headers = {})
+        agent.post(url + path, post_parameters.merge(parameters), fast_header.merge(headers))
+      end
+
+      def self.fast_header
+        {'X-Requested-With' => 'XMLHttpRequest'}
+      end
+
+      def self.logout_path
+        parametrized_path("/boutiques.paniervolant.customerinfos:totallogout", post_parameters)
+      end
+
+      def self.parametrized_path(path, parameters)
+        string_parameters = parameters.map do |key,value|
+          "#{key}=#{value}"
+        end
+        "#{path}?#{string_parameters.join('&')}"
+      end
+
+      def self.post_parameters
+        {'t:ac' => "Accueil", 't:cp' => 'gabarit/generated'}
+      end
+
+      def method_missing(method_sym, *arguments, &block)
+        if delegate_to_class?(method_sym)
+          self.class.send(method_sym, *arguments, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_sym)
+        super or delegate_to_class?(method_sym)
+      end
+      def delegate_to_class?(method_sym)
+        self.class.respond_to?(method_sym)
+      end
+
+      FORMDATA_PARAMETER = 't:formdata'
+      LOGIN_PARAMETER = 'inputLogin'
+      PASSWORD_PARAMETER = 'inputPwd'
+    end
+  end
+end