gls_agent 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTBiMzI3NDdkNzU3NGRlYjAxYjNjNzg3MjNlY2Y3MTg1YWM3Yjc1YQ==
+    ODI0NTc3YTlhN2NhZTcxMzcyM2QyY2NkZjg1YjY0OWUzNjI1NjgyNw==
   data.tar.gz: !binary |-
-    MDRkNDA0ODE0ZjUwYmQ2MTlhOGJmMDc0NWIwMzgyMzUwMzIyNDdkYg==
+    YTcyYmEyZWEyMjgwYTE1NjNjZGNiMjBmYzg3N2M1MThkMzUwYWJhMQ==
 SHA512:
   metadata.gz: !binary |-
-    NzBlYjE1NDFmMDYzNTI4NWIwMDU0OTU3ZTRmY2QxZWNhMTc5OTExMzQwMWNm
-    NWU3NTQ2ZTE5YTdjZTU5ZmI0NDM1ZTVhMGJiMWZmN2ExZWIwYTRjMjNiYmFk
-    OTU0NmI2YmFlMzQ1YjM0ZDc1ZmRiZTE2MjY0ZDJiNGIxNDI5MjU=
+    ODYxMWExZGI3Y2RlZjljMDljZWZlNDIwN2Q5YWY3MjQwODM5MWNiOTQ0Y2Q2
+    NmM4NTUwNzIxOTE5OWE5ZTdmNDA2YWQ4YmZlNjM1ZWY2MzBjMzIyYWI0Y2Rm
+    ODNlNThiYTQ0OWVmNWU3YWQwZjhlYWYwYTM3ODQ2NDhhMTJlOGU=
   data.tar.gz: !binary |-
-    NDU4ZDJkMjI4ODZjZDNlZTEwMjcxOWNjNzE3MmFjM2VmOWRkY2IxNTAzZmQ3
-    NTEyOTA5YjEwNWY5NmZkMzg2NWI3MTA5ZTJmYjNlZDgzYmVjODQ2YjhlNGE5
-    NWU5YWZkNTkyMzdiMjYzYTEyZjA0ZGRkYzRiY2QyZWRhNGM4NzU=
+    OWM3YzNmODIwMjNjYzcyMzhhM2Q5MDA5OWQwNDg0YTMxYzI4NWEwY2M1ZmUx
+    MDExYTI0YzUyYjMxNzczMmE2OTY2YjcxYWFiYzRmMmI4MjRiZmQzZjQwNjU3
+    ZDNjN2EzMDlkMTEyMzY1MDcwMWU5YzYzZWY5YTJmNzgwZTZiMjc=

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Usage as standalone tool
+
 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
@@ -34,6 +36,18 @@ and
 
 to play around.
 
+### Usage as lib
+
+To use gls_agent in your ruby project, install the gem and use something along these lines:
+
+    options = GLSAgent::Dotfile::get_opts
+    mech = GLSMech.new
+    mech.user = options[:user]
+    mech.pass = options[:pass]
+
+    GLSAgent::ParcelJob.new('Frank Sinatra','CloudStreet','1',1234,'HeavenCity','1')
+    saved_as = mech.save_parcel_label parcel,'gls_label_frank_sinatra.pdf'
+
 ## Configuration
 
 You can invoke gls_agent without any configuration by specifying command line parameters.

data/bin/gls_create_label

@@ -2,34 +2,25 @@
 
 require 'optparse'
 require 'gls_agent'
-require 'json'
 
 options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: gls_create_label [OPTIONS]"
+
+  opts.separator ""
+  opts.separator "GLS login 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,$@
+  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
-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|
+  opts.separator ""
+  opts.separator "Label data definition"
+
+  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".'
@@ -42,15 +33,21 @@ optparse = OptionParser.new do |opts|
     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|
+
+  opts.separator ""
+  opts.separator "Output options"
+
+  opts.on('-o', '--output-file FILE', 'Write output (pdf) to FILE, defaults to gls-label.pdf .') do |o|
     options[:output_file] = o
   end
+
+  opts.separator ""
+  opts.separator "General options"
+
+  opts.on_tail('--version', 'Show version.') do
+    puts "gls_create_label #{GLSAgent::VERSION}"
+    exit 0
+  end
   opts.on('-h', '--help', 'Show help.') do
     puts opts
     exit 0
@@ -59,6 +56,9 @@ end
 
 optparse.parse!
 
+defaults = GLSAgent::Dotfile::get_opts
+options = default.merge options
+
 if !options[:user] || !options[:pass]
   STDERR.puts 'Error: Need to specify user and pass in ~/.gls_agent or -u -p .'
   exit 1
@@ -71,13 +71,19 @@ end
 
 options[:output_file] ||= 'gls-label.pdf'
 
-parcel = GLSAgent::ParcelJob.new(options[:name], options[:street], options[:streetno], options[:zip], options[:city], options[:weight])
+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 !pdf_file_path
+  STDERR.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

data/gls_agent.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/gls_agent/dotfile.rb

@@ -0,0 +1,34 @@
+module GLSAgent
+  module Dotfile
+    # Get keys and values from file in ~/.gls_agent and put them in a hash.
+    # keys are symbols.
+    # The file should follow the syntax
+    #     option=value
+    #     option2=value2
+    # Meaningful keys are i.e. user and pass.
+    def self.get_opts
+      options = {}
+      # Get defaults from ~/.gls_agent
+      begin
+        filecontent = File.open("#{Dir.home}/.gls_agent").read
+        options = hash_from_text filecontent
+        puts "Info: read configuration parameters from ~/.gls_agent, may be overriden with cmd line options."
+      rescue
+        STDERR.puts "Info: No configuration file in ~/.gls_agent found, all options need to be specified on command line."
+        #STDERR.puts $!.inspect,$@
+      end
+      options
+    end  
+
+    def self.hash_from_text text
+      hash = {}
+      text.each_line do |line|
+        fields = line.split('=')
+        fields.each &:strip!
+        fields.each &:rstrip!
+        hash[fields[0].to_sym] = fields[1]
+      end
+      hash
+    end
+  end
+end

data/lib/gls_agent/gls_mech.rb

@@ -1,6 +1,7 @@
 require 'mechanize'
 require 'logger'
 
+# Utilize mechanize to do stuff on GLS webpage.
 class GLSMech
   attr_accessor :mech
   attr_accessor :user
@@ -19,8 +20,10 @@ class GLSMech
 
   # Saves parcel label as pdf, does not overwrite file if exists,
   # returns filename that label was saved to.
+  # returns nil if login or redirection failed.
   def save_parcel_label parcel_job, filename
-    login! @user, @pass
+    return nil if !login! @user, @pass
+
     form = @mech.page.forms.first
 
     form.field_with(:name => 'txtName1').value = parcel_job.name
@@ -37,6 +40,7 @@ class GLSMech
   private
 
   # 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
@@ -46,5 +50,6 @@ class GLSMech
     form.submit
     # Move on to target page.
     page = @mech.get target_url
+    page.uri.to_s == target_url
   end
 end

data/lib/gls_agent/version.rb

@@ -1,3 +1,3 @@
 module GLSAgent
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/gls_agent.rb

@@ -1,6 +1,20 @@
 require "gls_agent/version"
 require 'gls_agent/gls_mech'
+require 'gls_agent/dotfile'
 
 module GLSAgent
   ParcelJob = Struct.new(:name, :street, :streetno, :zip, :city, :weight)
+
+  def self.job_from_csv string
+    fields = string.split(',')
+    if fields.length != 6
+      fail 'job_from_csv needs 6 fields'
+      return nil
+    end
+    ParcelJob.new(*fields)
+  end
+
+  def self.job_from_hash hash
+    ParcelJob.new(hash[:name], hash[:street], hash[:streetno], hash[:zip], hash[:city], hash[:weight])
+  end
 end

data/spec/gls_agent_spec.rb

@@ -0,0 +1,41 @@
+require_relative '../lib/gls_agent'
+
+describe 'GLSAgent Module helpers' do
+  it 'creates ParcelJob from csv string' do
+    job = GLSAgent::job_from_csv 'Name,Street,1,1234,City,1'
+    expect(job.name).to eq 'Name'
+    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 = {:name => 'Name', :street => 'Street', :streetno => '1', :zip => '1234', :city => 'City', :weight => '1'}
+    job = GLSAgent::job_from_hash hash
+    expect(job.name).to eq 'Name'
+    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
+end
+
+describe 'Dotfile-Parsing' do
+  it 'makes a hash from abc=def options' do
+    hash = GLSAgent::Dotfile::hash_from_text 'abc=def'
+    expect(hash[:abc]).to eq 'def'
+  end
+  it 'is tolerant about spaces' do
+    hash = GLSAgent::Dotfile::hash_from_text ' abc =def '
+    expect(hash[:abc]).to eq 'def'
+  end
+  it 'handles multiple options' do
+    hash = GLSAgent::Dotfile::hash_from_text " abc =def \nuser= 123\n pass   = h"
+    expect(hash[:abc]).to eq 'def'
+    expect(hash[:user]).to eq '123'
+    expect(hash[:pass]).to eq 'h'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gls_agent
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !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: Log into GLS site, create and save new parcel sticker for Germany.
 email:
 - felix.wolfsteller@gmail.com
@@ -69,8 +83,10 @@ files:
 - bin/gls_create_label
 - gls_agent.gemspec
 - lib/gls_agent.rb
+- lib/gls_agent/dotfile.rb
 - lib/gls_agent/gls_mech.rb
 - lib/gls_agent/version.rb
+- spec/gls_agent_spec.rb
 homepage: https://github.com/fwolfst/gls_agent
 licenses:
 - MIT
@@ -95,4 +111,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fetches german parcel labels from GLS webpage.
-test_files: []
+test_files:
+- spec/gls_agent_spec.rb