spree_elta_courier 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0138c167e19a827d9eda2caef4333702930eb2d1f436b6a7f9755bb83b9a79d6'
-  data.tar.gz: 6aaf7177fb8045fb654cb47282a148baab634bb6d541a8731561bd52dcbf252d
+  metadata.gz: 299aba1d364e609c4578085d0638d4c79ef57e189ab77d50b00b80576120e208
+  data.tar.gz: 1baef138576cd3836b195ec0c4fbe91c216eb4eabe083c6e781cd09b2812f4a9
 SHA512:
-  metadata.gz: eaa5dfcba4320663fd8f21880aaa667e754fc5e56ebcbb242a430a77eafda2df4a75afc83dfa0a5ce83085ddfb23dddc32a57cc189c1cde146c02d51c7cca29d
-  data.tar.gz: 8bef0689177ce154d5c51aeda6f245349707632258e09596572cf019d468d70df14f99db56d41788ce4c2ba4eac414ab9734c5c33b7a6b049dee8a4dca643806
+  metadata.gz: 696c147dbd40e9cb7014756e36c006bf4c7fc92c0c26d46db0c1e809d6e0f6622dae2976714d696f625a4087a6062d668fbd6f2c93992d366f2af898ca3793f7
+  data.tar.gz: 03b5341408f149e988b729fa8fdc9581ec71c440ed7a77d281e8a5b7c39bc8be87abce348ce4977cadaeaa6c1a0120dd408a1ec8b32e42bf1929414fcb2be79b

data/LICENSE.md

@@ -1,10 +1,15 @@
-# MIT License
+# LICENSE
 
-Copyright (c) 2025 OlympusOne
+Copyright (c) 2025 OlympusOne. All rights reserved.
 
-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:
+This program is free software: you can redistribute it and/or modify it under the terms of the
+GNU Affero General Public License as published by the Free Software Foundation, either
+version 3 of the License, or any later version.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
 
-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.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

data/README.md

@@ -1,45 +1,59 @@
 # 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.
+This is an Elta Courier extension for [Spree Commerce](https://spreecommerce.org), an open‑source e-commerce platform built with Ruby on Rails. It adds the ability to manage Elta Courier vouchers.
 
 [![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:
+1. Add this extension to your Gemfile:
 
     ```ruby
     bundle add spree_elta_courier
     ```
 
-2. Run the install generator
+2. Restart your server.
 
-    ```ruby
-    bundle exec rails g spree_elta_courier:install
-    ```
+## Usage (Creating & Printing Vouchers)
+
+Prerequisites for an order:
+
+- Shipping and billing addresses present
+- Payment completed
+- Order state: ready (so shipments exist and are ready to ship)
+
+Workflow:
+
+1. Open the order in Spree Admin.
+2. If the order meets the prerequisites, the “Create Voucher” option appears in the top‑right dropdown.
+3. Click “Create Voucher” (creates one voucher per shipment or split shipment).
+4. After successful creation, the “Print Voucher” option becomes available.
+5. Click “Print Voucher”: a merged (or single) PDF opens in a new tab for download/printing.
 
-3. Restart your server
+Notes:
 
-  If your server was running, restart it so that it can find the assets properly.
+- Multiple shipment vouchers are merged into one PDF.
+- If no voucher can be created (e.g. order not ready), the button does not appear.
+- Errors will return and log details server‑side.
 
 ## Developing
 
-1. Create a dummy app
+1. Create a dummy app:
 
     ```bash
     bundle update
     bundle exec rake test_app
     ```
 
-2. Add your new code
-3. Run tests
+2. Add 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:
+When testing your application's integration you may use its factories:
 
 ```ruby
 require 'spree_elta_courier/factories'
@@ -47,19 +61,21 @@ 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:
+Generate the test app:
 
 ```bash
 bundle exec rake test_app
 ```
 
-After this command completes, you should be able to run `rspec`.
+Then run:
+
+```bash
+bundle exec rspec
+```
 
 ## Releasing a new version
 
-```shell
+```bash
 bundle exec gem bump -p -t
 bundle exec gem release
 ```
@@ -72,4 +88,4 @@ 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
+Copyright (c) 2025 OlympusOne, released under the AGPL-3.0 or later.

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

@@ -9,25 +9,27 @@ module Spree
         begin
           load_order
 
+          num_packages = params[:num_packages].to_i || 1
+
           @order.shipments.each do |shipment|
             next unless shipment.can_create_voucher?
 
-            result = SpreeEltaCourier::CreateVoucher.new(shipment).call
+            result = SpreeEltaCourier::CreateVoucher.new(shipment, num_packages).call
+
+            vg_child = result[:vg_child].compact
 
-            shipment.update(
-              tracking: result[:vg_code]
-            )
+            shipment.tracking = result[:vg_code]
+            shipment.private_metadata['elta_courier.vg_child'] = vg_child
+            shipment.save!
           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
 
@@ -35,8 +37,13 @@ module Spree
         begin
           load_order
 
-          voucher_numbers = @order.shipments.select(&:can_print_voucher?)
-                                  .map(&:tracking).compact
+          shipments = @order.shipments.select(&:can_print_voucher?)
+          
+          voucher_numbers = shipments.flat_map do |shipment|
+            vg_child = shipment.private_metadata['elta_courier.vg_child'] || []
+            
+            [shipment.tracking] + vg_child
+          end
 
           if voucher_numbers.empty?
             raise StandardError, Spree.t('admin.integrations.elta_courier.voucher_print_failed')
@@ -84,7 +91,6 @@ module Spree
 
       def order_not_found
         flash[:error] = flash_message_for(Spree::Order.new, :not_found)
-        redirect_to spree.admin_orders_path
       end
     end
   end

data/app/javascript/spree_elta_courier/application.js

@@ -10,3 +10,7 @@ if (typeof window.Stimulus === "undefined") {
 } else {
   application = window.Stimulus
 }
+
+import EltaCourierController from 'spree_elta_courier/controllers/elta_courier_controller'
+
+application.register('elta-courier', EltaCourierController)

data/app/javascript/spree_elta_courier/controllers/elta_courier_controller.js

@@ -0,0 +1,30 @@
+import { Controller } from "@hotwired/stimulus";
+import { post } from "@rails/request.js";
+
+export default class extends Controller {
+  static values = {
+    orderId: Number,
+    createVoucherPrompt: String,
+    createVoucherError: String,
+  };
+
+  async createVoucher(event) {
+    event.preventDefault();
+
+    const packages = window.prompt(this.createVoucherPromptValue, 1);
+
+    const numPackages = parseInt(packages, 10);
+    if (isNaN(numPackages) || numPackages <= 0) {
+      alert(this.createVoucherErrorValue);
+      return;
+    }
+
+    await post(`${Spree.adminPath}/elta_courier/${this.orderIdValue}/create`, {
+      body: {
+        num_packages: numPackages,
+      },
+    });
+
+    Turbo.visit(window.location.href, { action: "replace" });
+  }
+}

data/app/services/spree_elta_courier/create_voucher.rb

@@ -1,10 +1,12 @@
 module SpreeEltaCourier
   class CreateVoucher
-    attr_reader :order, :shipment, :client
+    attr_reader :shipment, :num_packages, :order, :client
 
-    def initialize(shipment)
-      @order = shipment.order
+    def initialize(shipment, num_packages = 1)
       @shipment = shipment
+      @num_packages = num_packages
+
+      @order = shipment.order
 
       @client = EltaCourier::SoapClient.new(:create)
     end
@@ -20,8 +22,8 @@ module SpreeEltaCourier
         '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_temaxia' => num_packages,
+        'pel_paral_sxolia' => shipment.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

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

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

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

@@ -1,11 +1,16 @@
 <% 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) }
-    %>
+    <button
+      type="button"
+      class='btn text-left dropdown-item'
+      data-controller='elta-courier'
+      data-action='elta-courier#createVoucher'
+      data-elta-courier-order-id-value='<%= @order.id %>'
+      data-elta-courier-create-voucher-prompt-value="<%= Spree.t('admin.integrations.elta_courier.create_voucher_prompt') %>"
+      data-elta-courier-create-voucher-error-value="<%= Spree.t('admin.integrations.elta_courier.create_voucher_error') %>">
+      <%= icon 'package' %>
+      <%= Spree.t('admin.integrations.elta_courier.create_voucher') %>
+    </button>
   <% end %>
 
   <% if @order.can_print_voucher? %>

data/config/initializers/spree.rb

@@ -1,9 +1,7 @@
 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
+  # Admin partials
+  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

data/config/locales/el.yml

@@ -11,8 +11,10 @@ el:
           preferred_user_code: User Code
           preferred_password: Password
           preferred_paper_size: Μέγεθος Χαρτιού
-          create_voucher: Δημιουργία Voucher
-          print_voucher: Εκτύπωση Voucher
+          create_voucher: Δημιουργία Voucher (Elta Courier)
+          print_voucher: Εκτύπωση Voucher (Elta Courier)
+          create_voucher_prompt: "Εισάγετε αριθμό δεμάτων (ανά Αποστολή):"
+          create_voucher_error: Ο αριθμός των δεμάτων πρέπει να είναι θετικός ακέραιος αριθμός.
           voucher_successfully_created: Voucher δημιουργήθηκε επιτυχώς
           voucher_creation_failed: Αποτυχία δημιουργίας Voucher
           voucher_print_failed: Αποτυχία εκτύπωσης Voucher

data/config/locales/en.yml

@@ -11,8 +11,10 @@ en:
           preferred_user_code: User Code
           preferred_password: Password
           preferred_paper_size: Paper Size
-          create_voucher: Create Voucher
-          print_voucher: Print Voucher
+          create_voucher: Create Voucher (Elta Courier)
+          print_voucher: Print Voucher (Elta Courier)
+          create_voucher_prompt: "Enter the number of package (per Shipment):"
+          create_voucher_error: The number of package must be a positive integer number.
           voucher_successfully_created: Voucher successfully created
           voucher_creation_failed: Voucher creation failed
           voucher_print: Voucher printing failed

data/lib/spree_elta_courier/engine.rb

@@ -20,7 +20,6 @@ module SpreeEltaCourier
 
     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
 

data/lib/spree_elta_courier/factories.rb

@@ -1,3 +1,11 @@
-Dir["#{File.dirname(__FILE__)}/testing_support/factories/**"].each do |f|
-  load File.expand_path(f)
+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_user_code { ENV['ELTA_COURIER_USER_CODE'] }
+    preferred_password { ENV['ELTA_COURIER_PASSWORD'] }
+    preferred_paper_size { "1" }
+    store { Spree::Store.default }
+  end
 end

data/lib/spree_elta_courier/version.rb

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

data/lib/spree_elta_courier.rb

@@ -5,7 +5,4 @@ require 'spree_elta_courier/version'
 require 'spree_elta_courier/configuration'
 
 module SpreeEltaCourier
-  def self.queue
-    'default'
-  end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_elta_courier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - OlympusOne
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +134,7 @@ files:
 - app/assets/images/integration_icons/elta-courier-logo.png
 - app/controllers/spree/admin/elta_courier_controller.rb
 - app/javascript/spree_elta_courier/application.js
+- app/javascript/spree_elta_courier/controllers/elta_courier_controller.js
 - app/lib/elta_courier/soap_client.rb
 - app/models/spree/integrations/elta_courier.rb
 - app/models/spree/order_decorator.rb
@@ -148,12 +149,10 @@ files:
 - config/locales/el.yml
 - config/locales/en.yml
 - config/routes.rb
-- lib/generators/spree_elta_courier/install/install_generator.rb
 - lib/spree_elta_courier.rb
 - lib/spree_elta_courier/configuration.rb
 - lib/spree_elta_courier/engine.rb
 - lib/spree_elta_courier/factories.rb
-- lib/spree_elta_courier/testing_support/factories/elta_courier_integration.rb
 - lib/spree_elta_courier/version.rb
 - lib/spree_elta_courier/wsdl/CREATEAWB02.wsdl
 - lib/spree_elta_courier/wsdl/ELTACOURIERPOSTSIDETA.wsdl
@@ -162,13 +161,13 @@ files:
 - lib/spree_elta_courier/wsdl/PELTT03.wsdl
 homepage: https://github.com/olympusone/spree_elta_courier
 licenses:
-- MIT
+- AGPL-3.0-or-later
 metadata:
   bug_tracker_uri: https://github.com/olympusone/spree_elta_courier/issues
-  changelog_uri: https://github.com/olympusone/spree_elta_courier/releases/tag/v1.0.0
+  changelog_uri: https://github.com/olympusone/spree_elta_courier/releases/tag/v1.1.0
   documentation_uri: https://github.com/olympusone/spree_elta_courier
   homepage_uri: https://github.com/olympusone/spree_elta_courier
-  source_code_uri: https://github.com/olympusone/spree_elta_courier/tree/v1.0.0
+  source_code_uri: https://github.com/olympusone/spree_elta_courier/tree/v1.1.0
 rdoc_options: []
 require_paths:
 - lib

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

@@ -1,20 +0,0 @@
-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/testing_support/factories/elta_courier_integration.rb

@@ -1,10 +0,0 @@
-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