magento_remote 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjcxMjU3NmFhYWRhZDEzOTI3MjdkZmQzZDkyYzBkODUwOWMyMjdjYw==
+  data.tar.gz: !binary |-
+    MDVjOTk5ZjViYmQ1ZDY2ZjEwNDBiMjAxZjEyNWM2YzE5ZjFhYzVjNg==
+SHA512:
+  metadata.gz: !binary |-
+    OTZiMGJhZjUwYzkyNmM5ZDczYjU3M2E0OTIyOGUzODFlNTdmZDFkNjE1MmMx
+    OGFmNjhhOGQ4NzMyYTg1MDI3ZjRiZDRkNzRhZTY2OTJkZDgzYzIyMmUzYzNi
+    YjUzYzg0ZDhhZTU4ZWFjYWE1OTQ3YzZkMTcxY2Y0NmYwMjAzNzk=
+  data.tar.gz: !binary |-
+    YWRmYTMyMWRhMmUxMjA5YWQ3NTU3NDE3OTMzNTU0NmIyMzFhMTQ0NDgwODky
+    NDlkODM4OTcxOTUzNzczMDg2ODY2OWI0YmZlODJjMTdjYzA3NmVlOGI2YzA5
+    ZTRkNTNmOTczOGUxMWMyYzMyNWE2MWQyNDg0ZTk2YjFiMTQ5OGI=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+**/*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p545@magento_remote"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.25.19 (stable)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Felix Wolfsteller
+
+MIT License
+
+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,43 @@
+# MagentoRemote
+
+Interact with a specific but defaultish Magento shop via its webpage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'magento_remote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install magento_remote
+
+## Usage
+
+Call 
+
+    magento_add_to_cart -u customerlogin -p customerpassword -b https://theshop -w productid -q quantity -c
+
+to put *quantity* of the product with *productid* in your shopping cart.
+
+Note that you should work with
+
+    bundle exec
+
+and
+
+    bundle console
+
+while developing.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/magento_remote/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/magento_add_to_cart

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'magento_remote'
+
+# Sweet, sweet options.
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: magento_add_to_cart [OPTIONS]"
+
+  opts.separator ""
+  opts.separator "Magento shop options"
+
+  opts.on('-u', '--customer USER', 'customer/username of shop.') do |u|
+    options[:user] = u
+  end
+  opts.on('-p', '--password PASSWORD', 'password of customer account.') do |p|
+    options[:pass] = p
+  end
+  opts.on('-b', '--base-uri URI', 'base URI of shop.') do |b|
+    options[:base_uri] = b
+  end
+
+  opts.separator ""
+  opts.separator "Product options"
+
+  opts.on('-w', '--product-id PRODUCTID', 'product id of product to put in cart.') do |p|
+    options[:product_id] = p
+  end
+
+  opts.on('-q', '--quantity QUANTITY', 'quantity of product to put in cart.') do |q|
+    options[:quantity] = q
+  end
+
+  opts.separator ""
+  opts.separator "Output options"
+
+  opts.on('-c', '--show-cart', 'show cart contents afterwards') do |c|
+    options[:show_cart] = true
+  end
+
+  opts.on('-d', '--debug FILE', 'enable debugging output, STDOUT, or FILE if given') do |d|
+    if d
+      options[:debug] = d
+    else
+      options[:debug] = true
+    end
+  end
+
+  opts.separator ""
+  opts.separator "General options"
+
+  opts.on_tail('--version', 'Show version.') do
+    puts "magento_add_to_cart #{MagentoRemote::VERSION}"
+    exit 0
+  end
+  opts.on('-h', '--help', 'Show help.') do
+    puts opts
+    exit 0
+  end
+end
+
+optparse.parse!
+
+if !options[:user] || !options[:pass] || !options[:base_uri]
+  STDERR.puts "Error: You have to define user, pass and base_uri"
+  exit 1
+end
+
+mech = MagentoMech.from_config options
+if options[:debug] == true
+  mech.log_to! STDOUT
+elsif options[:debug]
+  mech.log_to! options[:debug]
+end
+
+return_code = 0
+
+mech.login
+
+if mech.add_to_cart options[:product_id], options[:quantity]
+  puts "INFO: Succeeded in adding to cart"
+else
+  STDERR.puts "ERROR: Something went wrong."
+  return_code = 3
+end
+
+if options[:show_cart]
+  puts "Current Cart Content"
+  puts mech.get_cart_content.map {|c| "#{c[1]} #{c[0]}"}
+end
+
+exit return_code

data/lib/magento_remote.rb

@@ -0,0 +1,6 @@
+require "magento_remote/version"
+require 'magento_remote/magento_mech'
+
+module MagentoRemote
+  # Your code goes here...
+end

data/lib/magento_remote/magento_mech.rb

@@ -0,0 +1,83 @@
+require 'mechanize'
+require 'logger'
+
+# The Mech Driver, interacting with a Magento shop page.
+# Note that the Mech does not keep too much state, you have to
+# care about login etc yourself.
+class MagentoMech
+  attr_accessor :user
+  attr_accessor :pass
+
+  # Create Mech from hash
+  # Argument conf
+  #   values :base_uri, :user, :pass.
+  def self.from_config(conf)
+    client = MagentoMech.new(conf[:base_uri])
+    client.user = conf[:user]
+    client.pass = conf[:pass]
+    client
+  end
+
+  # Create Mech with base_uri
+  def initialize base_uri
+    @mech = Mechanize.new
+    @mech.user_agent = 'RawBot, Felix sends the Mech.'
+    @base_uri = base_uri
+  end
+
+  # Log to given file (-like object).
+  def log_to! file
+    puts @mech.log
+    @mech.log = Logger.new file
+  end
+
+  # Login to webpage
+  def login
+    login_with @user, @pass
+  end
+
+  # Put stuff in the cart.
+  # Returns true if succeeded, false otherwise.
+  def add_to_cart product_id, qty
+    fail "Empty obligatory parameter" if product_id.nil? || qty.to_i <= 0
+    url = "#{@base_uri}/checkout/cart/add?product=#{product_id}&qty=#{qty}"
+
+    # Check the returned page name
+    result_page = @mech.get url
+
+    # There are multiple reasons of failure:
+    #   * product_id unknown
+    #   * product out of stock
+
+    # There are multiple ways to detect failure:
+    #   * contains a form with post action ending on product/#{product_id}/
+    #   * title is different (stays at product page when failing)
+    #   * no success msg div is shown.
+    #   * body has a different class.
+    #
+    # Using the last of these options:
+    # return result_page.search('.catalog-product-view').empty?
+
+    return !result_page.search('.success-msg span').empty?
+  end
+
+  # Get the current carts contents
+  def get_cart_content
+    cart_page = @mech.get("#{@base_uri}/checkout/cart/")
+    name_links = cart_page.search('td h2 a')
+    names = name_links.map &:text
+    quantities_inputs = cart_page.search('.qty')
+    quantities = quantities_inputs.map {|n| n[:value]}
+    names.zip quantities
+  end
+
+  # Login with given credentials
+  def login_with username, password
+    login_page = @mech.get("#{@base_uri}/customer/account/login/")
+
+    form = login_page.form_with(:action => "#{@base_uri}/customer/account/loginPost/")
+    form.fields.find{|f| f.name == 'login[username]'}.value = username
+    form.fields.find{|f| f.name == 'login[password]'}.value = password
+    @mech.submit(form)
+  end
+end

data/lib/magento_remote/version.rb

@@ -0,0 +1,3 @@
+module MagentoRemote
+  VERSION = "0.0.1"
+end

data/magento_remote.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magento_remote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magento_remote"
+  spec.version       = MagentoRemote::VERSION
+  spec.authors       = ["Felix Wolfsteller"]
+  spec.email         = ["felix.wolfsteller@gmail.com"]
+  spec.summary       = %q{Login to a magento shop and do stuff.}
+  spec.description   = %q{Allows ordering through a (defaultish) magento web page.}
+  spec.homepage      = 'https://github.com/fwolfst/magento_remote'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mechanize'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: magento_remote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Felix Wolfsteller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows ordering through a (defaultish) magento web page.
+email:
+- felix.wolfsteller@gmail.com
+executables:
+- magento_add_to_cart
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/magento_add_to_cart
+- lib/magento_remote.rb
+- lib/magento_remote/magento_mech.rb
+- lib/magento_remote/version.rb
+- magento_remote.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/fwolfst/magento_remote
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Login to a magento shop and do stuff.
+test_files:
+- spec/spec_helper.rb