spree_elta_courier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0138c167e19a827d9eda2caef4333702930eb2d1f436b6a7f9755bb83b9a79d6'
+  data.tar.gz: 6aaf7177fb8045fb654cb47282a148baab634bb6d541a8731561bd52dcbf252d
+SHA512:
+  metadata.gz: eaa5dfcba4320663fd8f21880aaa667e754fc5e56ebcbb242a430a77eafda2df4a75afc83dfa0a5ce83085ddfb23dddc32a57cc189c1cde146c02d51c7cca29d
+  data.tar.gz: 8bef0689177ce154d5c51aeda6f245349707632258e09596572cf019d468d70df14f99db56d41788ce4c2ba4eac414ab9734c5c33b7a6b049dee8a4dca643806

data/LICENSE.md

@@ -0,0 +1,10 @@
+# MIT License
+
+Copyright (c) 2025 OlympusOne
+
+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,75 @@
+# Spree Elta Courier
+
+This is a Elta Courier extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds the ability to manage Elta Courier vouchers to Spree stores.
+
+[![Gem Version](https://badge.fury.io/rb/spree_elta_courier.svg)](https://badge.fury.io/rb/spree_elta_courier)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_elta_courier
+    ```
+
+2. Run the install generator
+
+    ```ruby
+    bundle exec rails g spree_elta_courier:install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Developing
+
+1. Create a dummy app
+
+    ```bash
+    bundle update
+    bundle exec rake test_app
+    ```
+
+2. Add your new code
+3. Run tests
+
+    ```bash
+    bundle exec rspec
+    ```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_elta_courier/factories'
+```
+
+## Testing
+
+By running the Spree test_app rake task, we can generate a barebones Spree application within our spec directory to run our tests against.
+
+We can do this with the following command from the root directory of our extension:
+
+```bash
+bundle exec rake test_app
+```
+
+After this command completes, you should be able to run `rspec`.
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2025 OlympusOne, released under the MIT

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_elta_courier'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/config/spree_elta_courier_manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link spree_elta_courier/application.js
+//= link_tree ../../javascript/spree_elta_courier/controllers .js

data/app/controllers/spree/admin/elta_courier_controller.rb

@@ -0,0 +1,91 @@
+require 'combine_pdf'
+
+module Spree
+  module Admin
+    class EltaCourierController < Spree::Admin::BaseController
+      include Spree::Admin::OrdersFiltersHelper
+
+      def create
+        begin
+          load_order
+
+          @order.shipments.each do |shipment|
+            next unless shipment.can_create_voucher?
+
+            result = SpreeEltaCourier::CreateVoucher.new(shipment).call
+
+            shipment.update(
+              tracking: result[:vg_code]
+            )
+          end
+
+          flash[:success] = Spree.t('admin.integrations.elta_courier.voucher_successfully_created')
+          redirect_to spree.admin_order_path(@order)
+        rescue ActiveRecord::RecordNotFound
+          order_not_found
+        rescue StandardError => e
+          Rails.logger.error "Elta Courier Error: #{e.message}"
+
+          flash[:error] = Spree.t('admin.integrations.elta_courier.voucher_creation_failed')
+          redirect_to spree.admin_order_path(@order)
+        end
+      end
+
+      def print
+        begin
+          load_order
+
+          voucher_numbers = @order.shipments.select(&:can_print_voucher?)
+                                  .map(&:tracking).compact
+
+          if voucher_numbers.empty?
+            raise StandardError, Spree.t('admin.integrations.elta_courier.voucher_print_failed')
+          end
+
+          decoded_pdfs = voucher_numbers.map do |number|
+            voucher = SpreeEltaCourier::PrintVouchers.new(number).call
+
+            Base64.decode64(voucher[:b64_string])
+          end
+
+          merged_bytes =
+            if decoded_pdfs.size == 1
+              decoded_pdfs.first
+            else
+              combined = CombinePDF.new
+              decoded_pdfs.each { |bytes| combined << CombinePDF.parse(bytes) }
+              combined.to_pdf
+            end
+
+          send_data merged_bytes,
+            filename: "#{@order.number}.pdf",
+            type: 'application/pdf',
+            disposition: 'inline'
+        rescue ActiveRecord::RecordNotFound
+          render json: {
+            error: flash_message_for(Spree::Order.new, :not_found)
+          }, status: 404
+        rescue StandardError => e
+          Rails.logger.error "Elta Courier Error: #{e.message}"
+
+          render json: {
+            error: Spree.t('admin.integrations.elta_courier.voucher_print_failed')
+          }, status: 400
+        end
+      end
+
+      private
+
+      def load_order
+        @order = current_store.orders.find(params[:order_id])
+        authorize! action, @order
+        @order
+      end
+
+      def order_not_found
+        flash[:error] = flash_message_for(Spree::Order.new, :not_found)
+        redirect_to spree.admin_orders_path
+      end
+    end
+  end
+end

data/app/javascript/spree_elta_courier/application.js

@@ -0,0 +1,12 @@
+import '@hotwired/turbo-rails'
+import { Application } from '@hotwired/stimulus'
+
+let application
+
+if (typeof window.Stimulus === "undefined") {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}

data/app/lib/elta_courier/soap_client.rb

@@ -0,0 +1,72 @@
+require 'savon'
+
+module EltaCourier
+  class SoapClient
+    include Spree::IntegrationsConcern
+
+    SERVICE_WSDL_FILES = {
+      create: 'CREATEAWB02.wsdl',
+      print:  'PELB64VG.wsdl',
+      track:  'PELTT03.wsdl',
+      pudo:   'GETPUDODETAILS.wsdl'
+    }.freeze
+
+    attr_reader :client
+
+    def initialize(service)
+      integration = store_integration('elta_courier')
+      raise 'Integration not found' unless integration
+
+      wsdl_url = integration.preferred_wsdl_url
+      raise 'WSDL URL is required' unless wsdl_url
+
+      wsdl_source = resolve_wsdl(service)
+
+      @customer_code = integration.preferred_customer_code
+      @user_code = integration.preferred_user_code
+      @password = integration.preferred_password
+
+      @client = Savon.client(
+        wsdl: wsdl_source,
+        endpoint: wsdl_url,
+        convert_request_keys_to: :none
+      )
+    end
+
+    def call(method, message = {})
+      begin
+        response = client.call(
+          method,
+          message: default_auth_params.merge(message)
+        )
+
+        response.body.dig(:"#{method}_response")
+      rescue Savon::SOAPFault => e
+        raise SoapError, "SOAP Fault: #{e.message}"
+      rescue Savon::HTTPError => e
+        raise SoapError, "HTTP Error: #{e.message}"
+      rescue Savon::UnknownOperationError
+        raise SoapError, "Unknown SOAP method: #{method}"
+      rescue Savon::Error => e
+        raise SoapError, "SOAP call failed: #{e.message}"
+      end
+    end
+
+    def default_auth_params
+      {
+        'pel_apost_code' => @customer_code,
+        'pel_user_code' => @user_code,
+        'pel_user_pass' => @password
+      }.compact
+    end
+
+    def resolve_wsdl(service)
+      filename = SERVICE_WSDL_FILES[service]
+      raise ArgumentError, "Unknown ELTA service: #{service}" unless filename
+
+      SpreeEltaCourier::Engine.root.join('lib', 'spree_elta_courier', 'wsdl', filename).to_s
+    end
+
+    class SoapError < StandardError; end
+  end
+end

data/app/models/spree/integrations/elta_courier.rb

@@ -0,0 +1,25 @@
+module Spree
+  module Integrations
+    class EltaCourier < Spree::Integration
+      preference :wsdl_url, :string
+      preference :customer_code, :string
+      preference :user_code, :string
+      preference :password, :string
+      preference :paper_size, :string, default: "1"
+
+      validates :preferred_wsdl_url, presence: true
+      validates :preferred_customer_code, presence: true
+      validates :preferred_user_code, presence: true
+      validates :preferred_password, presence: true
+      validates :preferred_paper_size, presence: true, inclusion: { in: %w[0 1] }
+
+      def self.integration_group
+        'shipping'
+      end
+
+      def self.icon_path
+        'integration_icons/elta-courier-logo.png'
+      end
+    end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  module OrderDecorator
+    def can_create_voucher?
+      shipments.any?(&:can_create_voucher?)
+    end
+
+    def can_print_voucher?
+      shipments.any?(&:can_print_voucher?)
+    end
+  end
+end
+
+Spree::Order.prepend Spree::OrderDecorator

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  module ShipmentDecorator
+    def can_create_voucher?
+      !tracked? && ready?
+    end
+
+    def can_print_voucher?
+      tracked?
+    end
+  end
+end
+
+Spree::Shipment.prepend Spree::ShipmentDecorator

data/app/services/spree_elta_courier/create_voucher.rb

@@ -0,0 +1,42 @@
+module SpreeEltaCourier
+  class CreateVoucher
+    attr_reader :order, :shipment, :client
+
+    def initialize(shipment)
+      @order = shipment.order
+      @shipment = shipment
+
+      @client = EltaCourier::SoapClient.new(:create)
+    end
+
+    def call
+      address = shipment.address
+      cod_payment = order.payment_method&.cod_payment?
+
+      record = {
+        'pel_paral_name' => address.full_name,
+        'pel_paral_address' => address.address1,
+        'pel_paral_area' => address.city,
+        'pel_paral_tk' => address.zipcode.gsub(/\s+/, ''),
+        'pel_paral_thl_1' => address.phone,
+        'pel_baros' => shipment.item_weight.to_f,
+        'pel_temaxia' => 1,
+        'pel_paral_sxolia' => order.special_instructions,
+        'pel_ant_poso' => cod_payment ? shipment.final_price_with_items.to_f : 0,
+        'pel_ref_no' => shipment.number,
+        'sideta_eidos' => 2 # 1=Documents, 2=Parcel
+      }
+
+      result = client.call(
+        :read,
+        record
+      )
+
+      return result if result[:st_flag].to_i.zero?
+
+      raise VoucherError, "Failed to create voucher: #{result[:st_title]}" if result[:st_flag].to_i != 0
+    end
+
+    class VoucherError < StandardError; end
+  end
+end

data/app/services/spree_elta_courier/print_vouchers.rb

@@ -0,0 +1,35 @@
+module SpreeEltaCourier
+  class PrintVouchers
+    include Spree::IntegrationsConcern
+
+    attr_reader :vg_code, :client
+
+    def initialize(vg_code)
+      @vg_code = vg_code
+
+      @client = EltaCourier::SoapClient.new(:print)
+    end
+
+    def call
+      integration = store_integration('elta_courier')
+
+      raise 'Integration not found' unless integration
+
+      preferred_paper_size = integration.preferred_paper_size
+
+      record = {
+        'vg_code' => vg_code,
+        'paper_size' => preferred_paper_size
+      }
+
+      result = client.call(
+        :read,
+        record
+      )
+
+      return result if result[:st_flag].to_i.zero?
+
+      raise VoucherError, "Failed to print voucher: #{result[:st_title]}" if result[:st_flag].to_i != 0
+    end
+  end
+end

data/app/views/spree/admin/integrations/forms/_elta_courier.html.erb

@@ -0,0 +1,16 @@
+<div class="col-12 col-md-6 p-0">
+  <div class="card mb-4">
+    <div class="card-body">
+      <%= preference_field(@integration, form, 'wsdl_url', i18n_scope: 'admin.integrations.elta_courier') %>
+      <%= preference_field(@integration, form, 'customer_code', i18n_scope: 'admin.integrations.elta_courier') %>
+      <%= preference_field(@integration, form, 'user_code', i18n_scope: 'admin.integrations.elta_courier') %>
+      <%= preference_field(@integration, form, 'password', i18n_scope: 'admin.integrations.elta_courier') %>
+
+      <div class="form-group">
+        <%= form.label :preferred_paper_size, Spree.t('admin.integrations.elta_courier.preferred_paper_size') %>
+        <%= form.select :preferred_paper_size, options_for_select([['A4', '0'], ['A6', '1']], @integration.preferred_paper_size), {}, { class: 'custom-select', data: {  action: 'auto-submit#submit' } } %>
+        <%= form.error_message_on :preferred_paper_size %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/spree_elta_courier/_head.html.erb

@@ -0,0 +1 @@
+<%= javascript_import_module_tag 'application-spree-elta-courier' %>

data/app/views/spree_elta_courier/_order_dropdown_options.html.erb

@@ -0,0 +1,19 @@
+<% if store_integration('elta_courier').present? %>
+  <% if @order.can_create_voucher? %>
+    <%= link_to_with_icon 'package',
+      Spree.t('admin.integrations.elta_courier.create_voucher'),
+      spree.admin_elta_courier_create_path(@order.id),
+      class: 'btn text-left dropdown-item',
+      data: { turbo_method: :post, turbo_confirm: Spree.t(:are_you_sure) }
+    %>
+  <% end %>
+
+  <% if @order.can_print_voucher? %>
+    <%= link_to_with_icon 'printer',
+      Spree.t('admin.integrations.elta_courier.print_voucher'),
+      spree.admin_elta_courier_print_path(@order.id),
+      class: 'btn text-left dropdown-item',
+      target: '_blank'
+    %>
+  <% end %>
+<% end %>

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin 'application-spree-elta-courier', to: 'spree_elta_courier/application.js', preload: false
+
+pin_all_from SpreeEltaCourier::Engine.root.join('app/javascript/spree_elta_courier/controllers'),
+  under:    'spree_elta_courier/controllers',
+  to:       'spree_elta_courier/controllers',
+  preload:  'application-spree-elta-courier'

data/config/initializers/spree.rb

@@ -0,0 +1,9 @@
+Rails.application.config.after_initialize do
+  Rails.application.config.spree.integrations << Spree::Integrations::EltaCourier
+
+  if Rails.application.config.respond_to?(:spree_admin)
+    Rails.application.config.spree_admin.head_partials << 'spree_elta_courier/head'
+
+    Rails.application.config.spree_admin.order_page_dropdown_partials << 'spree_elta_courier/order_dropdown_options'
+  end
+end

data/config/locales/el.yml

@@ -0,0 +1,18 @@
+---
+el:
+  spree:
+    admin:
+      integrations:
+        elta_courier:
+          title: ΕΛΤΑ Courier
+          description: Διασύνδεση με τις υπηρεσίες της ΕΛΤΑ Courier
+          preferred_wsdl_url: WSDL URL
+          preferred_customer_code: Customer Code
+          preferred_user_code: User Code
+          preferred_password: Password
+          preferred_paper_size: Μέγεθος Χαρτιού
+          create_voucher: Δημιουργία Voucher
+          print_voucher: Εκτύπωση Voucher
+          voucher_successfully_created: Voucher δημιουργήθηκε επιτυχώς
+          voucher_creation_failed: Αποτυχία δημιουργίας Voucher
+          voucher_print_failed: Αποτυχία εκτύπωσης Voucher

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+---
+en:
+  spree:
+    admin:
+      integrations:
+        elta_courier:
+          title: ΕΛΤΑ Courier
+          description: Elta Courier is a shipping integration for Greece
+          preferred_wsdl_url: WSDL URL
+          preferred_customer_code: Customer Code
+          preferred_user_code: User Code
+          preferred_password: Password
+          preferred_paper_size: Paper Size
+          create_voucher: Create Voucher
+          print_voucher: Print Voucher
+          voucher_successfully_created: Voucher successfully created
+          voucher_creation_failed: Voucher creation failed
+          voucher_print: Voucher printing failed

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin, path: Spree.admin_path do
+    post  'elta_courier/:order_id/create',      to: 'elta_courier#create',      as: :elta_courier_create
+    get   'elta_courier/:order_id/print',       to: 'elta_courier#print',       as: :elta_courier_print
+  end
+end

data/lib/generators/spree_elta_courier/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SpreeEltaCourier
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_elta_courier'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_elta_courier/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeEltaCourier
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+   # preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/lib/spree_elta_courier/engine.rb

@@ -0,0 +1,39 @@
+module SpreeEltaCourier
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_elta_courier'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_elta_courier.environment', before: :load_config_initializers do |_app|
+      SpreeEltaCourier::Config = SpreeEltaCourier::Configuration.new
+    end
+
+    initializer 'spree_elta_courier.assets' do |app|
+      app.config.assets.paths << root.join('app/javascript')
+      app.config.assets.precompile += %w[spree_elta_courier_manifest]
+    end
+
+    initializer 'spree_elta_courier.importmap', after: 'spree.admin.importmap' do |app|
+      app.config.spree_admin.importmap.draw(root.join('config/importmap.rb'))
+
+      app.config.spree_admin.cache_sweepers << root.join('app/javascript')
+    end
+
+    initializer 'spree_elta_courier.cache_sweeper', before: 'spree.admin.importmap.cache_sweeper' do |app|
+      app.config.spree_admin.cache_sweepers << root.join('app/javascript')
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_elta_courier/factories.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/testing_support/factories/**"].each do |f|
+  load File.expand_path(f)
+end

data/lib/spree_elta_courier/testing_support/factories/elta_courier_integration.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :elta_courier_integration, class: Spree::Integrations::EltaCourier do
+    active { true }
+    preferred_wsdl_url { ENV['ELTA_COURIER_WSDL_URL'] }
+    preferred_customer_code { ENV['ELTA_COURIER_CUSTOMER_CODE'] }
+    preferred_username { ENV['ELTA_COURIER_USERNAME'] }
+    preferred_password { ENV['ELTA_COURIER_PASSWORD'] }
+    store { Spree::Store.default }
+  end
+end

data/lib/spree_elta_courier/version.rb

@@ -0,0 +1,7 @@
+module SpreeEltaCourier
+  VERSION = '1.0.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end