gls_agent 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTYyODU5ZTE4NTYyZjk1OTkwMTI0OGYyNDM4M2Q5MDlkM2M1MDkxZQ==
+  data.tar.gz: !binary |-
+    NjQ4ZTdmOWVmNTA2Y2ZhZDIzMTIxYjcwNTQ2ZjA3Njk5Zjk0YjU2MA==
+SHA512:
+  metadata.gz: !binary |-
+    ZWMwNTQwYzJhZjcxMDBiNDUzNjI1MGJiMGQ1NTU1OWI1ZjIwMzNjNTJjN2Q5
+    YmE4NTJiMzJjNDIwNmRmYTEzZTc0MGZmMWU4MWFlYjNmMjg0ZWJjOTY2NjNh
+    ZjY2ZDNjZGM2Njc1OTVjMjU3MTA4YzhkYzJhNTYwY2IzZDQ1ZjY=
+  data.tar.gz: !binary |-
+    MjUwMzVhNzYyMjk0MDcwYWY3ZmQ1ZGE2ZTIyYTZhNDgzOGI4YzM1MDNkY2Y3
+    NzhkMGFkM2U2NTdkNTViZTQ3ZjYzNTVhODJjMWViYjAzNDk2ZjU3N2I2MDlm
+    NzkzMDU2YTYxODA5MjgyMTkwNjgwMGFjMGNiOTM3N2U5YTM2YzU=

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+**/*.swp

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-p484@gls_agent"
+
+# 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 gls_agent.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,54 @@
+# GLSAgent
+
+Log into GLS (General Logistics Systems) webpage, create a new parcel sticker and save it to disk.
+
+You'll need a "Easy-Start"/"Your GLS" account to do so.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gls_agent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gls_agent
+
+## Usage
+
+There is a small standalone script:
+
+    $ gls_create_label -u glsuser -p glspass -d "John Doe,Home Street,1,1234,City,1" -o output.pdf
+
+Note that while not gemified, use
+
+    $ bundle exec bin/gls_create_label ...
+
+and
+
+    $ bundle console
+
+to play around.
+
+## Configuration
+
+You can invoke gls_agent without any configuration by specifying command line parameters.
+If you do not want to retype your gls credentials or do not want them to travel the wire (ssh), be present in the history (i.e. bash) or visible in the process list, you can put credentials or delivery details in ~/.gls_agent .
+
+Its syntax follows the
+
+    option=value
+
+scheme, where option can be anything of: user, pass, name, street, streetno, zip, city, weight, output_file .
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gls_agent/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/gls_create_label

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'gls_agent'
+require 'json'
+
+options = {}
+
+# Get defaults from ~/.gls_agent
+begin
+  filecontent = File.open("#{Dir.home}/.gls_agent").read
+  # from option=value\noption2=value2 make {'option':'value','option2':'value2'}
+  filecontent.gsub!(/ *= */, ':')
+  filecontent.gsub!(/(\w+)/, '"\1"')
+  filecontent.gsub!("\n", ",\n")
+  filecontent.chomp!("\n")
+  filecontent.chomp!(',')
+  filecontent = "{ #{filecontent} }"
+  begin
+    j_options = JSON.parse filecontent
+    j_options.each {|o,v| options[o.to_sym] = v}
+    puts "Info: read configuration parameters from ~/.gls_agent, may be overriden with cmd line options."
+  rescue
+    STDERR.puts "Error: configuration file in ~/.gls_agent found but could not be parsed."
+    STDERR.puts $!.inspect,$@
+  end
+rescue
+  STDERR.puts "Info: No configuration file in ~/.gls_agent found, all options need to be specified on command line."
+end
+
+optparse = OptionParser.new do |opts|
+  opts.on('-l', '--label-data DATA', 'label data, comma-separated.') do |l|
+    fields = l.split(',')
+    if fields.length != 6
+      STDERR.puts 'Error: label data has to be in format "John Doe,Home Street,1,1234,City,1".'
+      exit 1
+    end
+    options[:name] = fields.shift
+    options[:street] = fields.shift
+    options[:streetno] = fields.shift
+    options[:zip] = fields.shift
+    options[:city] = fields.shift
+    options[:weight] = fields.shift
+  end
+  opts.on('-u', '--gls-user GLSUSER', 'username of GLS account.') do |u|
+    options[:user] = u
+  end
+  opts.on('-p', '--gls-password GLSPASSWORD', 'password of GLS account.') do |p|
+    options[:pass] = p
+  end
+  opts.on('-o', '--output-file FILE', 'Write output (pdf) to FILE') do |o|
+    options[:output_file] = o
+  end
+  opts.on('-h', '--help', 'Show help.') do
+    puts opts
+    exit 0
+  end
+end
+
+optparse.parse!
+
+if !options[:user] || !options[:pass]
+  STDERR.puts 'Error: Need to specify user and pass in ~/.gls_agent or -u -p .'
+  exit 1
+end
+
+if !options[:name] || !options[:street] || !options[:streetno] || !options[:zip] || !options[:city] || !options[:weight]
+  STDERR.puts 'Error: Need to specify delivery data in ~/.gls_agent or -l .'
+  exit 1
+end
+
+options[:output_file] ||= 'gls-label.pdf'
+
+parcel = GLSAgent::ParcelJob.new(options[:name], options[:street], options[:streetno], options[:zip], options[:city], options[:weight])
+
+mech = GLSMech.new
+mech.user = options[:user]
+mech.pass = options[:pass]
+
+pdf_file_path = mech.save_parcel_label parcel, options[:output_file]
+if pdf_file_path != options[:output_file]
+  STDERR.puts "Warning: #{options[:output_file]} already exists, saved to #{pdf_file_path} instead!."
+else
+  puts "Success: Saved label to #{pdf_file_path}."
+end
+
+# Be cool, explicitely.
+exit 0

data/gls_agent.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gls_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gls_agent"
+  spec.version       = GlsAgent::VERSION
+  spec.authors       = ["Felix Wolfsteller"]
+  spec.email         = ["felix.wolfsteller@gmail.com"]
+  spec.summary       = %q{Fetches parcel labels from GLS webpage.}
+  spec.description   = %q{Log into GLS site, create and save new parcel sticker.}
+  spec.homepage      = ""
+  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"
+end

data/lib/gls_agent/gls_mech.rb

@@ -0,0 +1,50 @@
+require 'mechanize'
+require 'logger'
+
+class GLSMech
+  attr_accessor :mech
+  attr_accessor :user
+  attr_accessor :pass
+
+  # Setup the mech.
+  def initialize
+    @mech = Mechanize.new
+    @mech.user_agent_alias = 'Windows Mozilla'
+  end
+
+  # Enable logging to given file.
+  def log_to filename
+    @mech.log = Logger.new filename
+  end
+
+  # Saves parcel label as pdf, does not overwrite file if exists,
+  # returns filename that label was saved to.
+  def save_parcel_label parcel_job, filename
+    login! @user, @pass
+    form = @mech.page.forms.first
+
+    form.field_with(:name => 'txtName1').value = parcel_job.name
+    form.field_with(:name => 'txtStreet').value = parcel_job.street
+    form.field_with(:name => 'txtBlockNo').value = parcel_job.streetno
+    form.field_with(:name => 'txtZipCodeDisplay').value = parcel_job.zip
+    form.field_with(:name => 'txtCity').value = parcel_job.city
+    form.field_with(:name => 'txtWeight').value = parcel_job.weight
+    
+    @mech.submit(form, form.buttons.first)
+    @mech.page.iframes.first.content.save_as filename
+  end
+
+  private
+
+  # Login to GLS parcel creation web page using provided credentials.
+  def login! username, password
+    target_url = 'http://www.your-gls.eu/276-I-PORTAL-WEB/content/GLS/DE03/DE/15005.htm'
+    page = @mech.get target_url
+    form = page.forms.first
+    form.fields[5].value = username
+    form.fields[6].value = password
+    form.submit
+    # Move on to target page.
+    page = @mech.get target_url
+  end
+end

data/lib/gls_agent/version.rb

@@ -0,0 +1,3 @@
+module GlsAgent
+  VERSION = "0.1.0"
+end

data/lib/gls_agent.rb

@@ -0,0 +1,6 @@
+require "gls_agent/version"
+require 'gls_agent/gls_mech'
+
+module GLSAgent
+  ParcelJob = Struct.new(:name, :street, :streetno, :zip, :city, :weight)
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: gls_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Wolfsteller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-03 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'
+description: Log into GLS site, create and save new parcel sticker.
+email:
+- felix.wolfsteller@gmail.com
+executables:
+- gls_create_label
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gls_create_label
+- gls_agent.gemspec
+- lib/gls_agent.rb
+- lib/gls_agent/gls_mech.rb
+- lib/gls_agent/version.rb
+homepage: ''
+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: Fetches parcel labels from GLS webpage.
+test_files: []