posthorn 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c7cfb6a47a54db8e17f7b6439fb8eee498149f9
+  data.tar.gz: 724d2a078e2c60de907cd197cdb1ed4187b18a1e
+SHA512:
+  metadata.gz: 1e6c71cbd4f1830666e353a0367a48114a756bb3de4f9e5e460b2d33acb4c184e4d3332214de6df4530bf3222b8db6da0fab85defc03ccd0665bdd551ab13d59
+  data.tar.gz: d31e64dbce5574fe35f0b255f50e96d8674b8c125b4b9abcc57c9f5d2ded531205e72a4b85e5fbadfb936530f0c817ef0b70eb0341fd133b142c478497df209b

data/.gitignore

@@ -0,0 +1,98 @@
+
+# Created by https://www.gitignore.io/api/ruby,node,osx,linux
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+.rbenv-vars
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+# /doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+

data/.gitlab-ci.yml

@@ -0,0 +1,21 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+stages:
+  - test
+  - deploy
+
+
+rspec_job:
+  stage: test
+  script:
+    - bundle exec rspec
+    
+deploy_job:
+  stage: deploy
+  script:
+    - bundle exec rake build
+    - bundle exec gem inabox -g https://gems.aisler.net

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 AISLER B.V.
+
+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,79 @@
+# Posthorn
+
+Easy access to Deutsche Post 1C4A webservice
+
+With this Gem it is possible to order pre-paid shipping stickers from the Deutsche Post. Payment is done through the so called "Portokasse", a prepaid wallet service. To use this Gem a registration for the "Portokasse" and the 1C4A webservice is necessary. For more detailed information see (Sorry, only in German language...)
+
+https://portokasse.deutschepost.de/portokasse/#/
+
+https://www.deutschepost.de/de/i/internetmarke-porto-drucken/partner-werden.html
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'posthorn'
+```
+
+And then execute:
+
+    $ bundle
+
+In case this Gem is used within a Rails application add a new initializer and add the following content
+
+```ruby
+Posthorn.configure do |c|
+  c.dpwn_key = Rails.application.secrets[:posthorn_dpwn_key]
+  c.partner_id = Rails.application.secrets[:posthorn_partner_id]
+  c.key_phase = 1
+  c.username = Rails.application.secrets[:posthorn_username]
+  c.password = Rails.application.secrets[:posthorn_password]
+end
+```
+
+Use the secrets.yml file to securely store all necessary keys and passwords.
+
+
+## Usage
+
+This example will order a single domestic shipping label. The sandbox credentials can be used to run the example without burning real cash. To execute it, Posthorn should be already configured as shown above.
+
+```ruby
+# Open a new (post-)office
+office = Office.new
+
+# Create a new recveiver and sender address, country codes can be ISO3166 Alpha2 codes or Countries Gem instances
+# see https://github.com/hexorx/countries for details
+receiver = Address.new(
+  firstname: 'Hans Peter',
+  lastname: 'Wurst',
+  street: 'Carbynstraße',
+  no: '2',
+  city: 'Eschweiler',
+  zip: '52249',
+  country: 'de')
+
+sender = Address.new(
+  company: 'Your Company',
+  street: 'Charles-de-Gaulle-Straße',
+  no: '20',
+  city: 'Bonn',
+  zip: '53113',
+  country: 'de')
+
+# Add a new label to the shopping cart
+# for product_id and price, please referee to Deutsche Post ProdWS database
+# in this example ID 21 is used which is a large size letter, price is Euro 1.45
+office.cart << Label.new(sender, receiver, product_id: 21, price: 145)
+
+# all available page formats can be received with
+# puts office.page_formats
+labels = office.checkout!(page_format: 25)
+IO.write('labels_as_pdf_file.pdf', labels)
+```
+
+The output will be a ready to use shipping label as shown below.
+
+![Example label as PDF](doc/example_label.png)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/posthorn/address.rb

@@ -0,0 +1,57 @@
+module Posthorn
+  class Address
+    attr_accessor :company, :firstname, :lastname, :street, :no, :zip, :city, :country
+
+    def initialize(data)
+      @company = data[:company]
+      @lastname = data[:lastname]
+      @firstname = data[:firstname]
+
+      if data[:no]
+        @no = data[:no]
+        @street = data[:street]
+      else
+        chunks = data[:street].split(' ')
+        @no = chunks[-1]
+        @street = chunks[0..-2].join(' ')
+      end
+      @city = data[:city]
+      @zip = data[:zip]
+      @country = data[:country].is_a?(String) ? ISO3166::Country.new(data[:country]) : data[:country]
+    end
+
+    def company?
+      @company && !@company.blank? && (@company != [@firstname, @lastname].join(' '))
+    end
+
+    def to_h
+      rtn = {
+        name: {}
+      }
+
+      if company?
+        rtn[:name][:companyName] = { company: @company }
+        if @firstname && @lastname
+          rtn[:name][:companyName][:personName] = {
+              firstname: @firstname,
+              lastname: @lastname
+            }
+        end
+      else
+        rtn[:name][:personName] = {
+            firstname: @firstname,
+            lastname: @lastname
+          }
+      end
+      rtn[:address] = {
+          street: @street,
+          houseNo: @no,
+          zip: @zip,
+          city: @city,
+          country: @country.alpha3
+        }
+
+      rtn
+    end
+  end
+end

data/lib/posthorn/configuration.rb

@@ -0,0 +1,22 @@
+module Posthorn
+  def self.configuration
+    @config ||= Configuration.new
+  end
+
+  def self.configuration=(c)
+    @config = c
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :dpwn_key, :partner_id, :key_phase, :username, :password
+
+    def initialize
+      # Set default values here
+      @key_phase = 1
+    end
+  end
+end

data/lib/posthorn/label.rb

@@ -0,0 +1,30 @@
+module Posthorn
+  class Label
+    attr_accessor :sender, :receiver, :product_id, :price
+
+    def initialize(sender, receiver, args = {})
+      @sender = sender
+      @receiver = receiver
+      @product_id = args[:product_id] || 11 # Kompaktbrief
+      @price = args[:price] || 0
+    end
+
+    def to_h(args = {})
+      rtn = {
+        productCode: @product_id,
+        address: {
+          sender: @sender.to_h,
+          receiver: @receiver.to_h
+        },
+        voucherLayout: 'AddressZone',
+        position: {
+          labelX: 1,
+          labelY: 1,
+          page: (args[:page] || 0) + 1
+        }
+      }
+
+      rtn
+    end
+  end
+end

data/lib/posthorn/office.rb

@@ -0,0 +1,44 @@
+module Posthorn
+  class Office
+    attr_reader :user
+    attr_accessor :cart
+
+    def initialize
+      @client = SoapClient.new
+      @user = @client.authenticate
+      @cart = []
+    end
+
+    def page_formats
+      response = @client.call(:retrieve_page_formats)
+      response.body[:retrieve_page_formats_response][:page_format].map do |fmt|
+        OpenStruct.new fmt
+      end
+    end
+
+    def checkout!(args = {})
+      page = 0
+      price = 0
+      @cart.each { |label| price += label.price }
+
+      message = {
+        userToken: @user.user_token,
+        pageFormatId: args[:page_format] || 25, # Brother 62mm
+        positions: @cart.map.with_index { |label, ix| label.to_h(page: ix) },
+        total: price
+      }
+
+      response = @client.call(:checkout_shopping_cart_pdf, message)
+      data = response.body[:checkout_shopping_cart_pdf_response]
+      @user.wallet_balance = data[:wallet_ballance]
+
+      @cart.clear
+
+
+      request = HTTPI::Request.new
+      request.url = data[:link]
+      request.read_timeout = 240
+      HTTPI.get(request).body
+    end
+  end
+end

data/lib/posthorn/product_info.rb

@@ -0,0 +1,5 @@
+module Posthorn
+  class ProductInfo
+
+  end
+end

data/lib/posthorn/soap_client.rb

@@ -0,0 +1,32 @@
+module Posthorn
+  class SoapClient
+
+    def initialize
+      header = {
+        partner_id: Posthorn.configuration.partner_id,
+        request_timestamp: Time.now.strftime('%d%m%Y-%H%M%S'),
+        key_phase: 1
+      }
+      header[:partner_signature] = Digest::MD5.hexdigest(header.values.push(Posthorn.configuration.dpwn_key).join('::'))[0..7]
+
+
+      @base = Savon.client({
+        wsdl: 'https://internetmarke.deutschepost.de/OneClickForAppV3/OneClickForAppServiceV3?wsdl',
+        convert_request_keys_to: :none,
+        soap_header: header
+      })
+    end
+
+    def authenticate
+      response = @base.call(:authenticate_user, message: { username: Posthorn.configuration.username, password: Posthorn.configuration.password })
+      user = OpenStruct.new response.body[:authenticate_user_response]
+      user.wallet_balance = user.wallet_balance.to_i
+
+      user
+    end
+
+    def call(method, message = {})
+      @base.call(method, message: message)
+    end
+  end
+end

data/lib/posthorn/version.rb

@@ -0,0 +1,3 @@
+module Posthorn
+  VERSION = '0.0.5'
+end

data/lib/posthorn.rb

@@ -0,0 +1,17 @@
+require 'pp'
+require 'securerandom'
+require 'ostruct'
+
+require 'savon'
+require 'countries'
+require "httpi"
+
+require 'posthorn/version'
+require 'posthorn/configuration'
+require 'posthorn/soap_client'
+require 'posthorn/office'
+require 'posthorn/address'
+require 'posthorn/label'
+
+module Posthorn
+end

data/posthorn.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'posthorn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "posthorn"
+  spec.version       = Posthorn::VERSION
+  spec.authors       = ["Patrick Franken", "AISLER B.V."]
+  spec.email         = ["p.franken@aisler.net"]
+  spec.summary       = "Easy access to Deutsche Post 1C4A webservice"
+  spec.description   = "With this Gem it is possible to order pre-paid shipping stickers from the Deutsche Post. Payment is done through the so called \"Portokasse\", a prepaid wallet service. To use this Gem a registration for the \"Portokasse\" and the 1C4A webservice is necessary."
+  spec.homepage      = "http://aisler.net"
+  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_runtime_dependency 'savon', '~> 2'
+  spec.add_runtime_dependency 'countries', '~> 2'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "geminabox"
+end

data/spec/address_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Address do
+  it 'should create company and private addresses', focus: true do
+    address = Address.new(firstname: 'Hans Peter',
+      lastname: 'Wurst',
+      street: 'Schoolstraat',
+      no: '2',
+      city: 'Lemiers',
+      zip: '6295AV',
+      country: 'nl'
+      )
+
+    expect(address.company?).to be_falsey
+    expect(address.to_h[:name][:companyName]).to be_nil
+    expect(address.to_h[:name][:personName]).not_to be_nil
+
+
+    address = Address.new(company: 'Wurst & Co.',
+      firstname: 'Hans Peter',
+      lastname: 'Wurst',
+      street: 'Schoolstraat',
+      no: '2',
+      city: 'Lemiers',
+      zip: '6295AV',
+      country: 'nl'
+      )
+
+    expect(address.company?).to be_truthy
+    expect(address.to_h[:name][:companyName]).not_to be_nil
+    expect(address.to_h[:name][:personName]).to be_nil
+
+    address = Address.new(company: 'Hans Peter Wurst',
+      firstname: 'Hans Peter',
+      lastname: 'Wurst',
+      street: 'Schoolstraat',
+      no: '2',
+      city: 'Lemiers',
+      zip: '6295AV',
+      country: 'nl'
+      )
+
+    expect(address.company?).to be_falsey
+    expect(address.to_h[:name][:companyName]).to be_nil
+    expect(address.to_h[:name][:personName]).not_to be_nil
+  end
+
+  it 'should create addresses with street and number combined' do
+    address = Address.new(company: 'Wurst & Co.',
+      firstname: 'Hans Peter',
+      lastname: 'Wurst',
+      street: 'Schoolstraat 2',
+      city: 'Lemiers',
+      zip: '6295AV',
+      country: 'nl'
+      )
+
+      expect(address.street).to eq('Schoolstraat')
+      expect(address.no).to eq('2')
+  end
+
+end

data/spec/office_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Office do
+  it 'should receive all page formats' do
+    office = Office.new
+    formats = office.page_formats
+
+    expect(formats).to be_an Array
+    expect(formats.length).to eq(108)
+    expect(formats[0].id).to eq('7')
+    expect(formats[0].name).to eq('Herma 8748 CompactLine 105 x 74')
+  end
+
+  it 'should return user\'s wallet balance' do
+    office = Office.new
+    expect(office.user.wallet_balance).to be_an Fixnum
+    expect(office.user.wallet_balance).to be > 0
+  end
+
+  it 'should order national post stamps' do
+    office = Office.new
+
+    receiver = Address.new(
+      company: 'Hans Peter Wurst Inc.',
+      firstname: 'Hans Peter',
+      lastname: 'Wurst',
+      street: 'Schoolstraat',
+      no: '2',
+      city: 'Lemiers',
+      zip: '6295',
+      country: 'de')
+
+    sender = Address.new(
+      company: 'AISLER B.V.',
+      street: 'Schoolstraat',
+      no: '2',
+      city: 'Lemiers',
+      zip: '6295AV',
+      country: 'nl')
+
+    office.cart << Label.new(sender, receiver, product_id: 21, price: 145)
+    expect(office.cart.length).to eq(1)
+
+    labels = office.checkout!(page_format: 25)
+    expect(labels.length).to be >= 100
+  end
+
+end

data/spec/soap_client_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe SoapClient do
+  it 'should authenticate user and get an user token' do
+    client = SoapClient.new
+    user = client.authenticate
+    expect(user.user_token.length).to be(44)
+    expect(user.wallet_balance).to be_an Fixnum
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'posthorn'
+include Posthorn
+
+Posthorn.configure do |c|
+  c.dpwn_key = ENV['POSTHORN_DPWN_KEY']
+  c.partner_id = ENV['POSTHORN_PARTNER_ID']
+  c.key_phase = ENV['POSTHORN_KEY_PHASE']
+  c.username = ENV['POSTHORN_USERNAME']
+  c.password = ENV['POSTHORN_PASSWORD']
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: posthorn
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Patrick Franken
+- AISLER B.V.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  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: With this Gem it is possible to order pre-paid shipping stickers from
+  the Deutsche Post. Payment is done through the so called "Portokasse", a prepaid
+  wallet service. To use this Gem a registration for the "Portokasse" and the 1C4A
+  webservice is necessary.
+email:
+- p.franken@aisler.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/example_label.png
+- lib/posthorn.rb
+- lib/posthorn/address.rb
+- lib/posthorn/configuration.rb
+- lib/posthorn/label.rb
+- lib/posthorn/office.rb
+- lib/posthorn/product_info.rb
+- lib/posthorn/soap_client.rb
+- lib/posthorn/version.rb
+- posthorn.gemspec
+- spec/address_spec.rb
+- spec/office_spec.rb
+- spec/soap_client_spec.rb
+- spec/spec_helper.rb
+homepage: http://aisler.net
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easy access to Deutsche Post 1C4A webservice
+test_files:
+- spec/address_spec.rb
+- spec/office_spec.rb
+- spec/soap_client_spec.rb
+- spec/spec_helper.rb