postat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc5fb921e2c840e64f5898d80641eadfd0aeee0
+  data.tar.gz: 6cc55eef198ebdfe38491975df306432cc1f354a
+SHA512:
+  metadata.gz: bd81648edd06753ab585c64c398090d29c13c4f9eda9c31101fd9831c3ff46d334fab4adcdb11d6249a8cded9fde8e1d96136fe119b8e0001a768b58686ba0a6
+  data.tar.gz: 9a00e643428e73be9c73611552525c681079db95ed7cdb27f0a31e8889798e840c3798f5138599336c8e66384961ee74a1d35875c5664293e1b7c2cd56224665

data/.gitignore

@@ -0,0 +1 @@
+spec/config.yml

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gem 'savon', '~> 2.11.1'
+
+group :dev do # not development <-> would add unneeded development dependencies in gemspec
+  gem 'rake'
+  gem 'rspec', '~>2'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.3.0)
+    builder (3.2.3)
+    diff-lcs (1.1.2)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.2)
+      rack
+      socksify
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    nori (2.6.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rainbow (2.2.2)
+      rake
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    savon (2.11.2)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    unicode-display_width (1.3.0)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec (~> 2)
+  rubocop
+  savon (~> 2.11.1)
+
+BUNDLED WITH
+   1.16.0

data/Readme.md

@@ -0,0 +1,54 @@
+# Shipgate-Soap Wrapper for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postat'
+```
+
+And then execute:
+```shell
+$ bundle
+```
+Or install it yourself as:
+```shell
+$ gem install postat
+```
+
+##### After bundle
+```shell
+$ rails g postat
+```
+This adds the following:
+* `config/initializers/postat.rb`
+
+* `config/postat.yml`
+  `config/postat-example.yml`
+```yml
+development:
+  guid:       'guid'
+  username:   'username'
+  password:   'password'
+  namespace:  'http://example.com/'
+  wsdl:       'http://example.com/soap?WSDL'
+```
+
+* `.gitignore`
+```
+config/postat.yml
+```
+
+## Usage
+This Gem provides you with a Wrapper for the Shipgate-Soap-Api
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/datyv/postat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/postat/postat_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class PostatGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc 'Copy the initializer for Postat'
+  def copy_initializer_file
+    copy_file 'initializer.rb', 'config/initializers/postat.rb'
+  end
+
+  desc 'Copy the yml for Postat'
+  def copy_yml_files
+    copy_file 'initializer.yml', 'config/postat.yml'
+    copy_file 'initializer.yml', 'config/postat-example.yml'
+  end
+
+  desc 'Add yml to .gitignore'
+  def add_to_gitignore
+    append_to_file '.gitignore', 'config/postat.yml'
+  end
+end

data/lib/generators/postat/templates/initializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+POSTAT_CONFIG = {
+  guid: ENV['POSTAT_GUID'] || 'guid',
+  username: ENV['POSTAT_USERNAME'] || 'username',
+  password: ENV['POSTAT_PASSWORD'] || 'password',
+  namespace: ENV['POSTAT_NAMESPACE'] || 'http://example.com/',
+  wsdl: ENV['POSTAT_WSDL'] || 'http://example.com/soap?WSDL'
+}
+
+config_file = File.expand_path("#{Rails.root}/config/postat.yml", __FILE__)
+if File.exist?(config_file)
+  configs_from_file = YAML.safe_load(File.read(config_file))
+  POSTAT_CONFIG.merge!(configs_from_file[Rails.env])
+  POSTAT_CONFIG.symbolize_keys!
+end

data/lib/generators/postat/templates/initializer.yml

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+development:
+  guid:       'guid'
+  username:   'username'
+  password:   'password'
+  namespace:  'http://example.com/'
+  wsdl:       'http://example.com/soap?WSDL'
+
+test:
+  guid:       'guid'
+  username:   'username'
+  password:   'password'
+  namespace:  'http://example.com/'
+  wsdl:       'http://example.com/soap?WSDL'
+
+beta:
+  guid:       'guid'
+  username:   'username'
+  password:   'password'
+  namespace:  'http://example.com/'
+  wsdl:       'http://example.com/soap?WSDL'
+
+production:
+  guid:       'guid'
+  username:   'username'
+  password:   'password'
+  namespace:  'http://example.com/'
+  wsdl:       'http://example.com/soap?WSDL'

data/lib/postat.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'savon'
+
+class Postat
+  attr_reader :client
+
+  def initialize
+    @user = POSTAT_CONFIG[:username] || raise('missing :user')
+    @password = POSTAT_CONFIG[:password] || raise('missing :password')
+    @guid = POSTAT_CONFIG[:guid] || raise('missing :guid')
+    @client = Savon.client wsdl: POSTAT_CONFIG[:wsdl], namespace_identifier: :ryl, convert_request_keys_to: :none
+  end
+
+  def delete_label(options = {})
+    message = add_common_params
+    options[:shipments]&.each do |shipment|
+      message[:Shipments] << { 'CancelRequest.Shipment' => shipment }
+    end
+    response = client.call(:delete_label, message: { ShippingRequest: message })
+    handle_response response
+  end
+
+  def generate_label(options = {})
+    message = add_common_params
+    message[:DeliveryProductCode] = options[:delivery_code]
+    message[:ReturnProductCode] = options[:return_code]
+    message[:Shipments]['Request.Shipment'] = build_shipment(options)
+    response = client.call(:create_label, message: { ShippingRequest: message },
+                                          attributes: { 'xmlns' => 'http://rylos.lu/' })
+    handle_response response
+  end
+
+  private
+
+  def handle_response(response)
+    response = response.to_hash
+    success = response&.dig(:create_label_response, :create_label_result, :was_successful) || false
+    return response if success
+    message = response&.dig(:create_label_response, :create_label_result, :messages, :message) || []
+    raise StandardError, message.values&.join(': ')
+  end
+
+  def build_shipment(options = {})
+    shipment = {}
+    shipment[:Shipper] = add_address(options[:from])
+    shipment[:Receiver] = add_address(options[:to])
+    shipment[:Date] = (Time.zone.now + 180).iso8601
+    shipment[:PaymentType] = 'RECEIVER'
+    shipment[:CustomerReference] = options[:reference_number] if options[:delivery_code]
+    shipment[:ReturnReference] = options[:reference_number] if options[:return_code]
+    shipment[:CurrencyCode] = 'EUR'
+    shipment[:AdditionalInsurance] = 0
+    commodities = add_commodities(options[:commodities])
+    shipment[:Commodities] = commodities unless commodities.empty?
+    packages = add_packages(options[:package])
+    shipment[:Packages] = packages unless packages.empty?
+    shipment[:Label] = { ImageType: 'PDF', PaperFormat: 'A5' }
+    shipment
+  end
+
+  def add_common_params
+    { Credentials: {
+      Guid: @guid,
+      Username: @user,
+      Password: @password
+    },
+      Carrier: 'POSTAT',
+      Shipments: {} }
+  end
+
+  def add_address(address)
+    { CompanyName: address[:company].to_s,
+      PersonName: "#{address[:first_name]} #{address[:last_name]}".squish,
+      CareOf: address[:care_of].to_s,
+      PhoneNumber: address[:phone].to_s,
+      EMailAddress: address[:email].to_s,
+      CountryCode: address[:country].to_s,
+      StateCode: address[:state_code].to_s,
+      PostalCode: address[:zip_code].to_s,
+      CityName: address[:city].to_s,
+      StreetName: address[:street].to_s,
+      StreetNo: address[:street_no].to_s }
+  end
+
+  def add_commodities(commodities = [])
+    commodity_array = []
+    commodities = [commodities] if commodities.is_a?(Hash)
+    [*commodities].each_with_index do |commodity, _i|
+      commodity_array << {
+        'Request.Commodity' => {
+          CountryOfManufacture: commodity[:country_iso].to_s,
+          CustomsValue: { Amount: commodity[:price], Currency: 'EUR' },
+          Weight: { Amount: commodity[:weight].to_i, WeightType: 'KG' },
+          Description: commodity[:category].to_s,
+          Name: commodity[:name].to_s,
+          NumberOfPieces: 1,
+          UnitPrice: { Amount: commodity[:price], Currency: 'EUR' },
+          Quantity: 1
+        }
+      }
+    end
+    commodity_array
+  end
+
+  def add_packages(packages = [])
+    package_array = []
+    packages = [packages] if packages.is_a?(Hash)
+    [*packages].each_with_index do |package, i|
+      package_array << {
+        'Request.Package' => {
+          SequenceNumber: i += 1,
+          GroupPackageCount: packages.size,
+          Weight: { Amount: package[:weight].to_i, WeightType: 'KG' },
+          Length: package[:length].to_i,
+          Width: package[:width].to_i,
+          Height: package[:height].to_i,
+          DimensionType: 'CM',
+          PackageType: 'CARTON'
+        }
+      }
+    end
+    package_array
+  end
+end

data/postat.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'postat'
+  s.version       = '0.0.1'
+  s.authors       = ['Datyv']
+  s.email         = ['yvesgoizet@gmail.com']
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  s.homepage      = 'https://github.com/Datyv/postat'
+  s.license       = 'MIT'
+  s.require_paths = ['lib']
+  s.summary       = 'Wrapper for Rylos SOAP Api for PostAt'
+  s.test_files    = ['spec/postat_spec.rb', 'spec/spec_helper.rb']
+
+  if s.respond_to? :specification_version
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
+      s.add_runtime_dependency('savon', ['~> 2.10.0'])
+    else
+      s.add_dependency('savon', ['~> 2.10.0'])
+    end
+  else
+    s.add_dependency('savon', ['~> 2.10.0'])
+  end
+end

data/spec/postat_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path('spec/spec_helper')
+
+describe Postat do
+  let(:config) { YAML.load_file('spec/config.yml') }
+  let(:client) { Postat.new(config) }
+
+  it 'has a VERSION' do
+    Postat::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+
+  describe :flush do
+    it 'can do it' do
+      client.flush(config[:cname], '/foo')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift 'lib'
+require 'post_at'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: postat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Datyv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: 
+email:
+- yvesgoizet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- lib/generators/postat/postat_generator.rb
+- lib/generators/postat/templates/initializer.rb
+- lib/generators/postat/templates/initializer.yml
+- lib/postat.rb
+- postat.gemspec
+- spec/postat_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Datyv/postat
+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.6.13
+signing_key: 
+specification_version: 3
+summary: Wrapper for Rylos SOAP Api for PostAt
+test_files:
+- spec/postat_spec.rb
+- spec/spec_helper.rb