gls_agent 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDk4YzRmNDRkYzIxNDdlMDY0MGRiYTFmODZiN2FiNDdmNDhlZDljYQ==
+    NjYzODZlNGZkOWY4ZjkzNTc5NmYzZjUyMGM5YjBkMDc3Y2M4ODQ5OQ==
   data.tar.gz: !binary |-
-    YWQ1OTY3NzlkZjJiOWMwMDkwZmMzNDk0MDU2NWZlOTVmNTkxNTUxMA==
+    M2YyMjJjNjQxZTdiMDQ3YjVhYTFkOGMzZTEwNGM2N2ZjOTk0NjY3Ng==
 SHA512:
   metadata.gz: !binary |-
-    ODY5Y2M1YzBiY2ViMDA3YWUyNGNiMTZlNDBiZjM5YTc3ZmMwODVkN2QwYWIw
-    YzQ4MTVjNmUzZGE2NDk0NmJmMjMzMjVhNmJlNDlkYzkwODQ0OTljY2ZjY2Q5
-    YTI4NDI3OWZjMjZjNzZhMWJiNTNhZDcwYzVkNzY0NWFmYjMwZTM=
+    ZDJmMmM4ZjY4OWUyZGI5YWE5OTE2NWNhMmU2NGQ3YjUyOGQyOTE0MzM5ZmRm
+    NzZkYjJhNmU4NjE0YzRjYjVlZDZmODRiNTYwNTYwMDhhNWQxYzkzM2U0NWFh
+    NmU4M2I5OWQ1ZGNmMGI5ZTc2MzU0ODE0MmE4NmY5MGY0Y2I3Mjk=
   data.tar.gz: !binary |-
-    ZTQ2NjUwMTZkODVmNzAyYzE3MDVjZjY4MjU3MjdmZGVmNDM3Y2Y5YjZmODhl
-    OTYxMDg4YzI0ZjFmNzY5NjlhY2YwODJiNTZmNGI3NmM0ZWM4NzBmYmY0OTk0
-    NzMyNTE3NWRjYTRhZjI1N2IwNzllNjUwZTRhYTNiNjc5ZGViNDQ=
+    Y2Q2MTczZWUwYmNiZjY3NmUxYTNkMzgzMjNiYWU3ZjQwODdlNmI5MjA4MGFh
+    ODFlNDRiMmUyNDEzOGM3ZWUxMDZlNmJlMDJiZjI3M2E0ZjUyNThiYWMzY2E3
+    MDBiNTkzYWU0OWM2Mzk3NzYwM2JmYzVhNGY1ZTVmNzcwMTA0M2Q=

data/bin/gls_create_label

@@ -2,10 +2,25 @@
 
 require 'optparse'
 require 'gls_agent'
+require 'rainbow'
+
+def puts_error message
+  STDERR.puts Rainbow("Error: #{message}").red
+end
+
+def puts_info message
+  puts Rainbow(message).yellow
+end
+
+def puts_success message
+  puts Rainbow("Success: #{message}").green
+end
+
 
 options = {}
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: gls_create_label [OPTIONS]"
+  opts.banner = "Usage: gls_create_label [OPTIONS] [FILE]\n
+  Register and download a GLS parcel sticker."
 
   opts.separator ""
   opts.separator "GLS login options"
@@ -22,12 +37,13 @@ optparse = OptionParser.new do |opts|
 
   opts.on('-l', '--label-data DATA', 'Label data, comma-separated.') do |l|
     fields = l.split(',')
-    if fields.length != 7
-      STDERR.puts 'Error: label data has to be in format "01.01.2016,John Doe,Home Street,1,1234,City,1".'
+    if fields.length != 8
+      puts_error 'Error: label data has to be in format "01.01.2016,John Doe,Company,Home Street,1,1234,City,1".'
       exit 1
     end
     options[:date] = fields.shift
     options[:name] = fields.shift
+    options[:company_name] = fields.shift
     options[:street] = fields.shift
     options[:streetno] = fields.shift
     options[:zip] = fields.shift
@@ -61,35 +77,57 @@ defaults = GLSAgent::Dotfile::get_opts
 options = defaults.merge options
 
 if !options[:user] || !options[:pass]
-  STDERR.puts 'Error: Need to specify user and pass in ~/.gls_agent or -u -p .'
+  puts_error 'Need to specify user and pass in ~/.gls_agent or -u -p .'
   exit 1
 end
 
-if !options[:date] || !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 .'
+if ARGV.empty? && (!options[:date] || !options[:name] || !options[:street] || !options[:streetno] || !options[:zip] || !options[:city] || !options[:weight])
+  puts_error 'Need to specify delivery data in ~/.gls_agent or -l.'
   exit 1
 end
 
 options[:output_file] ||= 'gls-label.pdf'
 
-parcel = GLSAgent::job_from_hash(options)
-
 mech = GLSMech.new
 mech.user = options[:user]
 mech.pass = options[:pass]
 
-pdf_file_path = mech.save_parcel_label parcel, options[:output_file]
+if !ARGV.empty?
+  parcels = File.readlines(ARGV[0]).map do |line|
+    GLSAgent::job_from_csv line
+  end
+  filenames = parcels.map do |parcel|
+    "#{parcel.name.gsub(/\W+/,'_')}.pdf"
+  end
+  mech.save_parcel_labels(parcels, filenames) do |error,saved_as|
+    if error
+      puts_error error
+    else
+      puts_info "Saved #{saved_as}."
+    end
+  end
+else
+  parcel = GLSAgent::job_from_hash(options)
+ 
+  begin
+    pdf_file_path = mech.save_parcel_label parcel, options[:output_file]
+  rescue GLSAgent::GLSEndpointError => error
+    puts_error "The GLS Endpoint answered:\n#{error.message}"
+    exit 3
+  end
 
-if !pdf_file_path
-  STDERR.puts "Error: Could not login or navigate GLS page."
-  exit 2
-end
+  if !pdf_file_path
+    puts_error "Could not login or navigate GLS page."
+    exit 2
+  end
 
-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}."
+  if pdf_file_path != options[:output_file]
+    puts_info "Warning: #{options[:output_file]} already exists, saved to #{pdf_file_path} instead!."
+  else
+    puts_success "Saved label to #{pdf_file_path}."
+  end
 end
 
 # Be cool, explicitely.
 exit 0
+

data/gls_agent.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'mechanize'
+  spec.add_dependency 'rainbow'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/gls_agent.rb

@@ -3,18 +3,28 @@ require 'gls_agent/gls_mech'
 require 'gls_agent/dotfile'
 
 module GLSAgent
-  ParcelJob = Struct.new(:date, :name, :street, :streetno, :zip, :city, :weight)
+  # GLS webpage reports something is bad.
+  class GLSEndpointError < StandardError; end
+
+  ParcelJob = Struct.new(:date, :name, :company, :street, :streetno, :zip, :city, :weight)
 
   def self.job_from_csv string
     fields = string.split(',')
-    if fields.length != 7
-      fail 'job_from_csv needs 6 fields'
+    if fields.length != 8
+      fail 'job_from_csv needs 8 fields'
       return nil
     end
     ParcelJob.new(*fields)
   end
 
   def self.job_from_hash hash
-    ParcelJob.new(hash[:date], hash[:name], hash[:street], hash[:streetno], hash[:zip], hash[:city], hash[:weight])
+    ParcelJob.new(hash[:date],
+                  hash[:name],
+                  hash[:company],
+                  hash[:street],
+                  hash[:streetno],
+                  hash[:zip],
+                  hash[:city],
+                  hash[:weight])
   end
 end

data/lib/gls_agent/gls_mech.rb

@@ -1,11 +1,14 @@
 require 'mechanize'
 require 'logger'
+require 'date'
+require 'gls_agent'
 
 # Utilize mechanize to do stuff on GLS webpage.
 class GLSMech
   attr_accessor :mech
   attr_accessor :user
   attr_accessor :pass
+  @@parcel_creation_url = 'http://www.your-gls.eu/276-I-PORTAL-WEB/content/GLS/DE03/DE/15005.htm'.freeze
 
   # Setup the mech.
   def initialize
@@ -18,32 +21,69 @@ class GLSMech
     @mech.log = Logger.new filename
   end
 
+  # Saves parcel labels as pdf, does not overwrite file if exists,
+  # yields error, filename that was saved to.
+  # Later is nil if login, creation or redirect failed.
+  def save_parcel_labels parcel_jobs, filenames
+    return nil if !login! @user, @pass
+
+    parcel_jobs.zip(filenames).each do |parcel, filename|
+      if @mech.page.uri.to_s != @@parcel_creation_url
+        @mech.get @@parcel_creation_url
+      end
+
+      if @mech.page.uri.to_s != @@parcel_creation_url
+        yield "not logged in", nil
+        next
+      end
+
+      form = @mech.page.forms.first
+      fill_parcel_form form, parcel
+      
+      @mech.submit(form, form.buttons.first)
+
+      pdf_iframe = @mech.page.iframes.first
+
+      @mech.page.save_as "save_label#{DateTime.now.strftime('%s')}.html"
+      
+      if page_has_error?
+        yield page_error_text, nil
+      elsif pdf_iframe
+        yield nil, pdf_iframe.content.save_as(filename)
+      else
+        yield 'unkown error', nil
+      end
+    end
+  end
+
   # Saves parcel label as pdf, does not overwrite file if exists,
-  # returns filename that label was saved to.
-  # returns nil if login, creation or redirect failed.
+  # returns filename that label was saved to,
+  # or nil if login, creation or redirect failed.
   def save_parcel_label parcel_job, filename
-    return nil if !login! @user, @pass
+    if !login! @user, @pass
+      raise GLSAgent::GLSEndpointError.new page_error_text
+    end
 
     form = @mech.page.forms.first
+    fill_parcel_form form, parcel_job
 
-    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
-    form.field_with(:name => 'txtDate').value = parcel_job.date
-    
     @mech.submit(form, form.buttons.first)
 
     pdf_iframe = @mech.page.iframes.first
 
+    if @mech.log
+      @mech.page.save_as "save_label#{DateTime.now.strftime('%s')}.html"
+    end
+
+    if page_has_error?
+      raise GLSAgent::GLSEndpointError.new page_error_text
+    end
+
     if pdf_iframe
-      return @mech.page.iframes.first.content.save_as filename
+      return pdf_iframe.content.save_as filename
     elsif @mech.log
       @mech.page.save_as "gls_agent_debug_save-parcel-fail.html"
     end
-
     return nil
   end
 
@@ -52,14 +92,35 @@ class GLSMech
   # Login to GLS parcel creation web page using provided credentials.
   # returns true if login and navigation afterwards succeeded.
   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
+    page = @mech.get @@parcel_creation_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
-    page.uri.to_s == target_url
+    page = @mech.get @@parcel_creation_url
+    page.uri.to_s == @@parcel_creation_url
+  end
+
+  def fill_parcel_form form, parcel_job
+    form.field_with(:name => 'txtName1').value = parcel_job.name
+    form.field_with(:name => 'txtName2').value = parcel_job.company
+    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
+    form.field_with(:name => 'txtDate').value = parcel_job.date
+  end
+
+  # Is there an error (div with .prefix class) on the current page?
+  def page_has_error?
+    !@mech.page.search(".prefix").empty?
+  end
+
+  # Error text (div with .prefix class) of the current page.
+  def page_error_text
+    error_div = @mech.page.search(".prefix")[0]
+    error_div ? error_div.text : "general error"
   end
 end

data/lib/gls_agent/version.rb

@@ -1,3 +1,3 @@
 module GLSAgent
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/spec/gls_agent_spec.rb

@@ -2,21 +2,22 @@ require_relative '../lib/gls_agent'
 
 describe 'GLSAgent Module helpers' do
   it 'creates ParcelJob from csv string' do
-    job = GLSAgent::job_from_csv '02.02.2014,Name,Street,1,1234,City,1'
+    job = GLSAgent::job_from_csv '02.02.2014,Name,Company,Street,1,1234,City,1'
     expect(job.date).to eq '02.02.2014'
     expect(job.name).to eq 'Name'
+    expect(job.company).to eq 'Company'
     expect(job.street).to eq 'Street'
     expect(job.streetno).to eq '1'
     expect(job.zip).to eq '1234'
     expect(job.city).to eq 'City'
     expect(job.weight).to eq '1'
   end
-
   it 'creates ParcelJob from hash' do
-    hash = {:date => '02.12.2012', :name => 'Name', :street => 'Street', :streetno => '1', :zip => '1234', :city => 'City', :weight => '1'}
+    hash = {:date => '02.12.2012', :name => 'Name', :company => 'Company', :street => 'Street', :streetno => '1', :zip => '1234', :city => 'City', :weight => '1'}
     job = GLSAgent::job_from_hash hash
     expect(job.date).to eq '02.12.2012'
     expect(job.name).to eq 'Name'
+    expect(job.company).to eq 'Company'
     expect(job.street).to eq 'Street'
     expect(job.streetno).to eq '1'
     expect(job.zip).to eq '1234'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gls_agent
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -24,6 +24,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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