spree_packeta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a99485f4b3f4e3cdfcf8c6190029b60f3264af5382f8322fe0ac8a50ba3a0749
+  data.tar.gz: a3626fae18789cf4810e87dd8079401a431cb005a8ad421b7a4d300521b1ff41
+SHA512:
+  metadata.gz: 4be22a237a3f1aad4cb160dc6835ac9c2bea64354d6304bb85c6a491f0dbc5a6160b0ecd3e8820a36f71ca56cc02212e8ed422fc0d506a5644c239f5df77dde0
+  data.tar.gz: b3a3d1b141afdce86a3cb09df36170129c5231ad0fc6b6d03a5ec4f77d6a36f327c188f80df614c4c9abd771af5afdc5b99de621b1926d3f84ce54772d569586

data/.github/workflows/release.yml

@@ -0,0 +1,196 @@
+name: Release Gem to RubyGems and GitHub Packages
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  validate:
+    name: Validate Release
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: get_version
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          echo "version=$TAG" >> $GITHUB_OUTPUT
+          echo "Tag version: $TAG"
+
+      - name: Validate version consistency
+        run: |
+          TAG_VERSION="${{ steps.get_version.outputs.version }}"
+          FILE_VERSION=$(grep -E "VERSION = ['\"]" lib/spree_packeta/version.rb | sed "s/.*['\"]\\(.*\\)['\"].*/\\1/")
+
+          echo "Tag version: $TAG_VERSION"
+          echo "File version: $FILE_VERSION"
+
+          if [ "$TAG_VERSION" != "$FILE_VERSION" ]; then
+            echo "❌ ERROR: Version mismatch!"
+            echo "Git tag: v$TAG_VERSION"
+            echo "version.rb: $FILE_VERSION"
+            echo ""
+            echo "Please update lib/spree_packeta/version.rb to match the tag version."
+            exit 1
+          fi
+
+          echo "✅ Version validation passed"
+
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    needs: validate
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec
+
+      - name: Run RuboCop (if configured)
+        run: bundle exec rubocop || true
+        continue-on-error: true
+
+  release:
+    name: Build and Publish Gem
+    runs-on: ubuntu-latest
+    needs: [validate, test]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Build gem
+        run: |
+          gem build spree_packeta.gemspec
+          echo "✅ Gem built successfully"
+          ls -lh *.gem
+
+      - name: Configure RubyGems credentials
+        run: |
+          mkdir -p ~/.gem
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+          :github: Bearer ${{ secrets.GITHUB_TOKEN }}
+          EOF
+          chmod 0600 ~/.gem/credentials
+
+      - name: Publish to RubyGems.org
+        run: |
+          gem push spree_packeta-*.gem
+          echo "✅ Gem published to RubyGems.org"
+
+      - name: Publish to GitHub Packages
+        continue-on-error: true
+        run: |
+          # Extract owner from repository (owner/repo -> owner)
+          OWNER=$(echo "${{ github.repository }}" | cut -d'/' -f1)
+
+          gem push --key github --host https://rubygems.pkg.github.com/${OWNER} spree_packeta-*.gem
+          echo "✅ Gem published to GitHub Packages"
+
+      - name: Generate release notes
+        id: release_notes
+        run: |
+          VERSION="${{ needs.validate.outputs.version }}"
+
+          # Get previous tag
+          PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+
+          if [ -z "$PREV_TAG" ]; then
+            echo "First release - generating from all commits"
+            COMMITS=$(git log --pretty=format:"- %s (%h)" --no-merges)
+          else
+            echo "Generating changelog from $PREV_TAG to v$VERSION"
+            COMMITS=$(git log $PREV_TAG..HEAD --pretty=format:"- %s (%h)" --no-merges)
+          fi
+
+          # Create release notes file
+          cat > release_notes.md << EOF
+          ## What's Changed
+
+          $COMMITS
+
+          ## Installation
+
+          ### From RubyGems.org
+
+          Add to your Gemfile:
+
+          \`\`\`ruby
+          gem 'spree_packeta', '~> $VERSION'
+          \`\`\`
+
+          ### From GitHub Packages
+
+          Configure bundler to use GitHub Packages:
+
+          \`\`\`ruby
+          # Gemfile
+          source 'https://rubygems.pkg.github.com/${{ github.repository_owner }}' do
+            gem 'spree_packeta', '~> $VERSION'
+          end
+          \`\`\`
+
+          Then run:
+
+          \`\`\`bash
+          bundle install
+          bundle exec rails g spree_packeta:install
+          \`\`\`
+
+          ## Documentation
+
+          See the [README](https://github.com/${{ github.repository }}/blob/main/README.md) for complete documentation.
+
+          ---
+
+          **Full Changelog**: https://github.com/${{ github.repository }}/compare/$PREV_TAG...v$VERSION
+          EOF
+
+          cat release_notes.md
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          VERSION="${{ needs.validate.outputs.version }}"
+
+          gh release create "v$VERSION" \
+            --title "Release v$VERSION" \
+            --notes-file release_notes.md \
+            --verify-tag \
+            spree_packeta-*.gem
+
+          echo "✅ GitHub Release created"
+
+      - name: Cleanup credentials
+        if: always()
+        run: rm -f ~/.gem/credentials

data/.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+    branches: [main, master, develop]
+
+jobs:
+  test:
+    name: Test (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.1', '3.2']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec
+        run: bundle exec rspec
+
+      - name: Run RuboCop
+        run: bundle exec rubocop
+        continue-on-error: true
+
+  build:
+    name: Build Gem
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+
+      - name: Build gem
+        run: gem build spree_packeta.gemspec
+
+      - name: Verify gem contents
+        run: |
+          echo "Gem specification:"
+          gem spec spree_packeta-*.gem
+          echo ""
+          echo "Gem contents:"
+          tar -tzf spree_packeta-*.gem | head -20

data/.gitignore

@@ -0,0 +1,63 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+Pods/
+vendor/bundle/
+
+## 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
+
+# RSpec
+.rspec_status
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+## [0.1.0] - 2024-12-21
+
+### Added
+- Initial release of spree_packeta gem
+- SOAP client wrapper for Packeta API
+- Packet creation and tracking functionality
+- Shipping method and calculator integration
+- Database tracking fields for shipments (packet_id, barcode, status_code, etc.)
+- Installation generator (`rails g spree_packeta:install`)
+- Rake tasks for installation and status checking
+- RSpec test suite with VCR cassettes for API testing
+- Configuration system with environment variable support
+- Error handling with custom exception classes
+- Support for Czech Republic and EU shipping zones
+- Automated gem release workflow via GitHub Actions
+- Dual publishing to RubyGems.org and GitHub Packages
+- CHANGELOG.md for tracking version history
+- Release documentation in docs/RELEASING.md
+- CI workflow for running tests on PRs and commits
+
+### Features
+- Create packets via Packeta SOAP API
+- Track packet status and history
+- Integration with Spree Commerce shipping system
+- Configurable API credentials and endpoints
+- Sender information for return labels
+- Rate caching support
+- Auto-create packets on shipment option
+- Tracking sync interval configuration
+
+[Unreleased]: https://github.com/yourusername/spree_packeta/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/yourusername/spree_packeta/releases/tag/v0.1.0

data/COMMANDS.md

@@ -0,0 +1,322 @@
+# Spree Packeta Commands Reference
+
+Quick reference for all available commands and utilities.
+
+## Installation & Setup
+
+### Generator
+
+```bash
+# Full installation (interactive)
+rails g spree_packeta:install
+
+# Auto-run migrations without prompting
+rails g spree_packeta:install --auto-run-migrations
+
+# Skip shipping method installation
+rails g spree_packeta:install --skip-shipping-method
+```
+
+This will:
+- Create initializer at `config/initializers/spree_packeta.rb`
+- Copy migration files
+- Optionally run migrations
+- Optionally install shipping method
+
+### Migrations
+
+```bash
+# Copy migrations only
+rails spree_packeta:install:migrations
+
+# Run migrations
+rails db:migrate
+```
+
+## Shipping Method Management
+
+### Install Shipping Method
+
+```bash
+rake spree_packeta:install
+```
+
+Creates a ready-to-use Packeta shipping method with:
+- Name: "Packeta"
+- Admin Name: "Packeta (Zásilkovna)"
+- Code: "packeta"
+- Tracking URL: `https://tracking.packeta.com/:tracking`
+- Calculator: Packeta Shipping Calculator (99 CZK base rate)
+- Zones: Czech Republic + EU
+- Display: Both frontend and backend
+
+**Output example:**
+```
+Installing Packeta shipping method...
+  ✓ Created default shipping category
+  ✓ Created Czech Republic zone
+  ✓ Created EU zone
+  ✓ Created Packeta shipping method (ID: 42)
+  ✓ Assigned to zones: Czech Republic, EU
+  ✓ Base rate: 99.0 CZK
+
+✅ Packeta shipping method installed successfully!
+```
+
+### Check Status
+
+```bash
+rake spree_packeta:status
+```
+
+Shows:
+- Installation status
+- Shipping method details
+- Zone assignments
+- Calculator configuration
+- Configuration status (API credentials, etc.)
+
+**Output example:**
+```
+Packeta Shipping Method Status
+==================================================
+✅ Installed (ID: 42)
+
+Name:           Packeta
+Admin Name:     Packeta (Zásilkovna)
+Display On:     both
+Available:      Yes
+Calculator:     SpreePacketa::Models::ShippingCalculator
+Zones:          Czech Republic, EU
+Categories:     Default
+Base Rate:      99.0 CZK
+
+Configuration Status
+==================================================
+✅ API Password         : abc123...
+✅ SOAP Endpoint        : http://www.zasilkovna.cz/api/soap
+✅ WSDL Path           : file:///Users/oezr/Downloads/soap.wsdl
+✅ Eshop ID            : my-eshop
+✅ Sender Email        : shipping@mystore.com
+```
+
+### Uninstall Shipping Method
+
+```bash
+rake spree_packeta:uninstall
+```
+
+Removes all Packeta shipping methods from the database.
+
+## Rails Console Usage
+
+### Configuration
+
+```ruby
+# Check current configuration
+SpreePacketa.configuration
+
+# Update configuration
+SpreePacketa.configure do |config|
+  config.api_password = 'new_password'
+  config.eshop = 'new_eshop_id'
+end
+
+# Reset to defaults
+SpreePacketa.reset_configuration!
+```
+
+### SOAP Operations
+
+```ruby
+# Initialize operations
+ops = SpreePacketa::Soap::Operations.new
+
+# Create a packet
+packet = ops.create_packet(
+  number: 'ORDER-123',
+  name: 'John',
+  surname: 'Doe',
+  email: 'john@example.com',
+  phone: '+420123456789',
+  address_id: 1234,
+  value: 1000.0,
+  weight: 2.5,
+  currency: 'CZK'
+)
+
+# Get packet status
+status = ops.packet_status(packet[:id])
+
+# Get tracking history
+history = ops.packet_tracking(packet[:id])
+
+# Cancel packet
+ops.cancel_packet(packet[:id])
+
+# Get label PDF
+pdf = ops.packet_label_pdf(packet[:id], format: 'A7 on A4')
+```
+
+### Services
+
+```ruby
+# Create packet from shipment
+shipment = Spree::Shipment.find(123)
+creator = SpreePacketa::Services::PacketCreator.new(shipment)
+packet = creator.create_packet
+
+# Track shipment
+tracker = SpreePacketa::Services::Tracker.new(shipment)
+status = tracker.current_status
+history = tracker.tracking_history
+tracker.sync_status!
+
+# Check if needs sync
+tracker.needs_sync? # => true/false
+```
+
+### Order Metadata
+
+```ruby
+# Get order's pickup point
+order = Spree::Order.find_by(number: 'R123456789')
+order.packeta_pickup_point_id    # => "12345"
+order.packeta_pickup_point_name  # => "Packeta Point - Prague"
+order.packeta_address_id         # => 12345 (as integer)
+
+# Set pickup point
+order.set_packeta_pickup_point({
+  id: 12345,
+  name: 'Packeta Point - Prague',
+  street: 'Main Street 123',
+  city: 'Prague',
+  zip: '11000'
+})
+```
+
+### Shipment Tracking
+
+```ruby
+# Get shipment with Packeta data
+shipment = Spree::Shipment.find(123)
+shipment.packeta_packet_id       # => 987654321
+shipment.packeta_barcode         # => "Z123456789"
+shipment.packeta_tracking_url    # => "https://tracking.packeta.com/987654321"
+shipment.packeta_status_code     # => 3
+shipment.packeta_branch_id       # => 1234
+shipment.packeta_last_sync_at    # => 2024-12-06 10:30:00 UTC
+```
+
+## Testing & Development
+
+### Check SOAP Connection
+
+```ruby
+# In Rails console
+client = SpreePacketa::Soap::Client.new
+operations = client.call(:packet_status, packet_id: 123456)
+```
+
+### Validate Configuration
+
+```ruby
+# Check all required config is set
+config = SpreePacketa.configuration
+
+puts "API Password: #{config.api_password.present? ? '✓' : '✗'}"
+puts "SOAP Endpoint: #{config.soap_endpoint.present? ? '✓' : '✗'}"
+puts "WSDL Path: #{config.wsdl_path.present? ? '✓' : '✗'}"
+puts "Eshop: #{config.eshop.present? ? '✓' : '✗'}"
+```
+
+### Test Packet Creation
+
+```ruby
+# Test with sample data
+ops = SpreePacketa::Soap::Operations.new
+
+# Validate before creating
+begin
+  ops.packet_attributes_valid?(
+    number: 'TEST-001',
+    name: 'Test',
+    surname: 'User',
+    email: 'test@example.com',
+    phone: '+420123456789',
+    address_id: 1234,
+    value: 100.0,
+    weight: 1.0,
+    currency: 'CZK'
+  )
+  puts "✓ Attributes are valid"
+rescue SpreePacketa::ValidationError => e
+  puts "✗ Validation failed: #{e.message}"
+end
+```
+
+## Troubleshooting Commands
+
+### Check Gem Loading
+
+```ruby
+# In Rails console
+puts SpreePacketa::VERSION
+puts Spree::ShippingMethod.include?(SpreePacketa::Models::ShippingMethod)
+puts Spree::Order.instance_methods.include?(:packeta_address_id)
+```
+
+### Check Database Columns
+
+```bash
+# Check if migration ran
+rails runner "puts ActiveRecord::Base.connection.column_exists?(:spree_shipments, :packeta_packet_id)"
+```
+
+### Reset Everything
+
+```bash
+# Remove shipping method
+rake spree_packeta:uninstall
+
+# Rollback migration (optional)
+rails db:rollback
+
+# Reinstall
+rake spree_packeta:install
+```
+
+## Environment Variables
+
+Required for production:
+
+```bash
+# .env or environment
+PACKETA_API_PASSWORD=your_api_password_here
+PACKETA_ESHOP=your_eshop_id
+PACKETA_SENDER_EMAIL=shipping@yourstore.com
+
+# Optional
+PACKETA_SOAP_ENDPOINT=http://www.zasilkovna.cz/api/soap
+PACKETA_WSDL_PATH=file:///path/to/soap.wsdl
+PACKETA_SENDER_NAME=Your Store Name
+PACKETA_SENDER_PHONE=+420123456789
+```
+
+## Quick Reference
+
+| Task | Command |
+|------|---------|
+| Full install (interactive) | `rails g spree_packeta:install` |
+| Install shipping method | `rake spree_packeta:install` |
+| Check status | `rake spree_packeta:status` |
+| Uninstall shipping method | `rake spree_packeta:uninstall` |
+| Copy migrations | `rails spree_packeta:install:migrations` |
+| Run migrations | `rails db:migrate` |
+| Open console | `rails console` |
+
+## See Also
+
+- **README.md** - General documentation
+- **FRONTEND_INTEGRATION.md** - React/frontend setup
+- [Packeta API Docs](https://docs.packeta.com/)

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spree_packeta.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug'
+end