auchandirect-scrAPI 0.0.1 → 0.1.0

checksums.yaml

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

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - ruby-head
-  - 2.1.0
+  - 2.1.1
   - 2.0.0
   - jruby-head
   - jruby-21mode

data/README.md

@@ -1,6 +1,6 @@
 # Auchandirect::ScrAPI
 
-A ruby gem providing, through scrapping, an API to the french www.auchandirect.com online grocery
+A ruby gem providing, through scrapping, an API to the french www.auchandirect.fr online grocery
 
 ## Installation
 
@@ -16,9 +16,61 @@ Or install it yourself as:
 
     $ gem install auchandirect-scrAPI
 
+## Status
+
+This library should be production ready.
+* It is automaticaly tested through Travis[https://travis-ci.org/philou/auchandirect-scrAPI]
+* It should be daily tested through TravisCron[http://traviscron.pythonanywhere.com/] to quickly detect modification at auchandirect.fr
+
 ## Usage
 
-TODO: Write usage instructions here
+This API has 2 main features :
+* walking the store to collect all the different items in the different subsections
+* Connecting with a user account in order to fill his cart
+
+It is not currently possible to pay and validate an order through this API. In order to do so, a user must :
+1. first disconnect from the API
+2. only then reconnect with his account through a browser, and order his pre-filled cart
+
+### Sample usage
+
+Suppose you'd want to fill your cart with all the pizzas available on the store, this is how you would do it :
+
+```ruby
+cart = Auchandirect::ScrAPI::Cart.login('buyer@mail.org', 'password')
+
+begin
+
+  Storexplore::Api.browse('http://www.auchandirect.fr').categories.each do |cat|
+    cat.categories.each do |s_cat|
+      s_cat.categories.each do |ss_cat|
+        ss_cat.items.each do |item|
+
+          if item.attributes[:name] =~ /pizza/i
+
+            cart.add_to_cart(item.attributes[:remote_id])
+
+          end
+        end
+      end
+    end
+  end
+
+ensure
+
+  ensure cart.logout
+
+end
+
+```
+
+### Client side usage
+
+In order to make it possible for a web browser to automaticaly connect to auchandirect.fr (for example in an iframe, to pay for a cart that was previously filled with this gem on the server), the cart The Auchandirect::ScrAPI::Cart classes exposes enough information to generate the html that makes this possible. You can have a look at spec/lib/auchandirect/scrAPI/client_cart_shared_examples.rb for more details. /This whole thing remains tricky and subject to failures though./
+
+### Testing
+
+In order to run quicker and offline tests for the rest of your app, you can use Auchandirect::ScrAPI::DummyCart in place of a real cart. This cart is compatible with Storexplore's dummy store generators [https://github.com/philou/storexplore].
 
 ## Contributing
 

data/auchandirect-scrAPI.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{Through scrapping, an API to the french www.auchandirect.fr online grocery}
   spec.summary       = %q{auchandirect.com grocery API}
   spec.homepage      = "https://github.com/philou/auchandirect-scrAPI"
   spec.license       = "LGPL v3"

data/lib/auchandirect/scrAPI/base_cart.rb

@@ -22,19 +22,21 @@
 module Auchandirect
   module ScrAPI
 
-    # Objects providing an api like access to third party online stores
+    # Base class for objects providing an api like access to third party online stores
     class BaseCart
 
+      # :login is a synonym for :new
       class << self
         alias :login :new
       end
 
-      # main url of the store
-      # def self.url
+      # Main url of the store
       def url
         self.class.url
       end
 
+      # def self.url
+
       # url at which a client browser can login
       # def self.login_url
 

data/lib/auchandirect/scrAPI/cart.rb

@@ -24,10 +24,10 @@ require 'json'
 module Auchandirect
   module ScrAPI
 
-    # Store API for AuchanDirect store
+    # Cart API for AuchanDirect store
     class Cart < BaseCart
 
-      # main url of the store
+      # Main url of the store
       def self.url
         "http://www.auchandirect.fr"
       end
@@ -39,11 +39,11 @@ module Auchandirect
         raise InvalidAccountError unless logged_in?
       end
 
-      # url at which a client browser can login
+      # Url at which a client browser can login
       def self.login_url
         url + login_path
       end
-      # parameters for a client side login
+      # 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'},
@@ -53,42 +53,57 @@ module Auchandirect
         default_params + user_params
       end
 
-      # login and password parameters names
+      # Client side 'login' parameter name
       def self.login_parameter
         LOGIN_PARAMETER
       end
+      # Client side 'password' parameter name
       def self.password_parameter
         PASSWORD_PARAMETER
       end
 
-      # url at which a client browser can logout
+      # Url at which a client browser can logout
       def self.logout_url
         url + logout_path
       end
 
-      # logs out from the store
+      # Logs out from the store
       def logout
         get(self.class.logout_path)
       end
 
-      # total value of the remote cart
+      # 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
+      # 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
+      # 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
 
+      # Missing methods can be forwarded to the class
+      def method_missing(method_sym, *arguments, &block)
+        if delegate_to_class?(method_sym)
+          self.class.send(method_sym, *arguments, &block)
+        else
+          super
+        end
+      end
+
+      # It can respond to messages that the class can handle
+      def respond_to?(method_sym)
+        super or delegate_to_class?(method_sym)
+      end
+
       private
 
       def do_login(login,password)
@@ -150,17 +165,6 @@ module Auchandirect
         {'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

data/lib/auchandirect/scrAPI/dummy_cart.rb

@@ -22,15 +22,18 @@
 module Auchandirect
   module ScrAPI
 
-    # Logger mock api
+    # A mock for Auchandirect::ScrAPI::Cart
+    # It provides a call log as a way of testing
     class DummyCart < BaseCart
 
       def self.url
         "http://www.#{Storexplore::Testing::DummyStoreConstants::NAME}.com"
       end
+      # The valid login to log into this dummy store
       def self.valid_email
         "valid@mail.com"
       end
+      # The valid password to log into this dummy store
       def self.valid_password
         "valid-password"
       end
@@ -53,20 +56,25 @@ module Auchandirect
         'password'
       end
 
+      # Accessors to the login and passwords used to login
+      # And to the received messages log
       attr_reader :login, :password, :log
 
+      # As the real store, the remote cart outlives the sessions
+      @@content = Hash.new(0)
+
       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
 
+      # Resets the session as if a new one was started
       def relog(login, password)
         if login != DummyCart.valid_email
           raise InvalidAccountError.new
@@ -83,18 +91,18 @@ module Auchandirect
 
       def empty_the_cart
         @log.push(:empty_the_cart)
-        @content.clear
+        @@content.clear
       end
 
       def add_to_cart(quantity, item)
         if available?(item)
           @log.push(:add_to_cart)
-          @content[item] += quantity
+          @@content[item] += quantity
         end
       end
 
       def cart_value
-        @content.to_a.inject(0.0) do |amount,id_and_quantity|
+        @@content.to_a.inject(0.0) do |amount,id_and_quantity|
           item = id_and_quantity.first
           quantity = id_and_quantity.last
 
@@ -104,21 +112,27 @@ module Auchandirect
         end
       end
 
+      # Collection of all the different items in the cart
       def content
-        @content.keys
+        @@content.keys
       end
 
+      # Is the cart empty ?
       def empty?
-        @content.empty?
+        @@content.empty?
       end
 
+      # Does the cart contain the specified quantity of this item ?
       def containing?(item, quantity)
-        @content[item] == quantity
+        @@content[item] == quantity
       end
 
+      # Makes an item temporarily unavailable
       def add_unavailable_item(item)
         @unavailable_items[item] = true
       end
+
+      # Is the given item available at this moment ?
       def available?(item)
         !@unavailable_items[item]
       end

data/lib/auchandirect/scrAPI/invalid_account_error.rb

@@ -21,6 +21,7 @@
 
 module Auchandirect
   module ScrAPI
+    # Error thrown when one tries to login with invalid credentials
     class InvalidAccountError < RuntimeError
     end
   end

data/lib/auchandirect/scrAPI/items.rb

@@ -22,6 +22,20 @@
 module Auchandirect
   module ScrAPI
 
+    # Storexplore api definition to browse all the items available
+    # at auchandirect.com
+    # See[https://github.com/philou/storexplore/blob/master/README.md]
+    #
+    # The store has 3 depths of categories.
+    # The only attribute the categories have is their name
+    # The items are all child of the bottom categories, here are
+    # their attributes
+    # * brand
+    # * name
+    # * price
+    # * image (url of the link to the image)
+    # * remote_id (the id of this item in the auchandirect database)
+
     module Items
       NAMES_SEPARATOR = ', '
     end

data/lib/auchandirect/scrAPI/version.rb

@@ -21,7 +21,7 @@
 
 module Auchandirect
   module ScrAPI
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end
 

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

@@ -24,6 +24,7 @@ require 'spec_helper'
 shared_examples_for "Any Cart" do |store_cart_class, store_url|
 
   before :all do
+    @store_cart_class = store_cart_class
     @store_url = store_url
   end
 
@@ -63,7 +64,7 @@ shared_examples_for "Any Cart" do |store_cart_class, store_url|
     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)
+      @session = new_session
 
       sample_items = extract_sample_items
       sample_item = sample_items.next
@@ -71,38 +72,38 @@ shared_examples_for "Any Cart" do |store_cart_class, store_url|
       @another_item_id = extract_another_item_id(sample_items, sample_item)
     end
     before(:each) do
-      @api.empty_the_cart
+      @session.empty_the_cart
     end
 
     after(:all) do
-      @api.logout
+      @session.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)
+      @session.add_to_cart(1, sample_item_id)
 
-      @api.empty_the_cart
-      expect(@api.cart_value).to eq 0
+      @session.empty_the_cart
+      expect(@session.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
+      @session.empty_the_cart
 
-      @api.add_to_cart(1, sample_item_id)
-      expect(@api.cart_value).to be > 0
+      @session.add_to_cart(1, sample_item_id)
+      expect(@session.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
+      @session.empty_the_cart
 
-      @api.add_to_cart(1, sample_item_id)
-      item_price = @api.cart_value
+      @session.add_to_cart(1, sample_item_id)
+      item_price = @session.cart_value
 
-      @api.add_to_cart(1, sample_item_id)
-      expect(@api.cart_value).to eq 2*item_price
+      @session.add_to_cart(1, sample_item_id)
+      expect(@session.cart_value).to eq 2*item_price
     end
 
     it "should set different cart values with different items" do
@@ -112,24 +113,41 @@ shared_examples_for "Any Cart" do |store_cart_class, store_url|
       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)
+    it "should save the cart between sessions" do
+      @session.add_to_cart(1, sample_item_id)
+      @session.logout
 
-      api2 = store_cart_class.login(store_cart_class.valid_email, store_cart_class.valid_password)
-      begin
-        api2.empty_the_cart
-      ensure
-        api2.logout
-      end
+      @session = new_session
 
-      @api.logout
-      @api = store_cart_class.login(store_cart_class.valid_email, store_cart_class.valid_password)
+      expect(@session.cart_value).not_to eq 0
+    end
+
+    it "should save the cart between sessions, even while another session" do
+      background_session = @session
+
+      run_session do |session|
+        session.add_to_cart(1, sample_item_id)
+      end
 
-      expect(@api.cart_value).to eq 0
+      run_session do |session|
+        expect(session.cart_value).not_to eq 0
+      end
     end
 
     private
 
+    def run_session
+      session = new_session
+      begin
+        yield session
+      ensure
+        session.logout
+      end
+    end
+
+    def new_session
+      @store_cart_class.login(@store_cart_class.valid_email, @store_cart_class.valid_password)
+    end
     def extract_another_item_id(sample_items, sample_item)
       another_item = sample_item
       while sample_item.attributes[:price] == another_item.attributes[:price]
@@ -158,13 +176,13 @@ shared_examples_for "Any Cart" do |store_cart_class, store_url|
     end
 
     def item_available?(item_id)
-      @api.empty_the_cart
-      @api.add_to_cart(1, item_id)
-      item_price = @api.cart_value
+      @session.empty_the_cart
+      @session.add_to_cart(1, item_id)
+      item_price = @session.cart_value
       return false if 0 == item_price
 
-      @api.add_to_cart(1, item_id)
-      return @api.cart_value == item_price * 2
+      @session.add_to_cart(1, item_id)
+      return @session.cart_value == item_price * 2
     end
 
     def nationaly_available_first(elements)
@@ -181,9 +199,9 @@ shared_examples_for "Any Cart" do |store_cart_class, store_url|
     end
 
     def cart_value_with_item(item_id)
-      @api.empty_the_cart
-      @api.add_to_cart(1, item_id)
-      @api.cart_value
+      @session.empty_the_cart
+      @session.add_to_cart(1, item_id)
+      @session.cart_value
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auchandirect-scrAPI
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Philou
@@ -31,102 +31,102 @@ cert_chain:
   yLcl1cmm5ALtJ/+Bkkmp0i4amXeTDMvq9r8PBsVsQwxYOYJBP+Umxz3PX6HjFHrQ
   XdkXx3oZ
   -----END CERTIFICATE-----
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: storexplore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net-ping
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: spec_combos
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-description: Through scrapping, an API to the french www.auchandirect.com online grocery
+description: Through scrapping, an API to the french www.auchandirect.fr online grocery
 email:
 - philippe.bourgau@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -161,17 +161,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: auchandirect.com grocery API