cetustek 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 722407201f6462aed26f91e61295dc87fcfdc970db2b55adf8aa73f4a4840f1a
+  data.tar.gz: ab37a4849d55a493854202d343c2cf082fb118813eea9d491e09970209317066
+SHA512:
+  metadata.gz: db34fb0378f5fd87b4c42cec44306b69afaa09ceb9ade280993f1618ed487e0c92ea6e61f3645747277e4a1e548b736f7806ced8e659c4a84a0d1a98da3efbe8
+  data.tar.gz: 5164f077cb9fff85c4879ea31e0f51710d03b6b621545c2b757deac19f3833e7f50802470577812ca95cfccb8742b271dc71c418625a8e9b5947f08e8c22bf2a

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# 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).
+
+## [0.2.0] - 2025-01-22
+
+### Added
+- Environment-specific configuration support (sandbox/production)
+- Service-oriented architecture implementation
+- XML builder service for invoice generation
+- SOAP service wrapper
+- Response handler with improved error handling
+- Data transfer objects for invoice data
+
+### Changed
+- Refactored CreateInvoice class to use service pattern
+- Unified configuration system
+- Improved code organization and maintainability
+- Enhanced error handling and logging
+
+### Removed
+- Deprecated Config class in favor of Configuration
+
+## [0.1.0] - 2025-01-22
+
+### Added
+- Initial release
+- Electronic invoice cancellation functionality
+- Integrated SOAP Web Services
+- Added `ox` gem for XML processing
+- Added `savon` gem for SOAP service integration

data/README.md

@@ -0,0 +1,96 @@
+# Cetustek
+
+Cetustek is a Ruby gem designed for handling electronic invoice operations, including invoice cancellation. It communicates with the e-invoice system through SOAP Web Services.
+
+## Features
+
+- Electronic invoice cancellation
+- XML format generation
+- SOAP Web Services integration
+- Environment-specific configuration (sandbox/production)
+- Service-oriented architecture
+- Robust error handling
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cetustek'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Configure Cetustek in your application:
+
+```ruby
+# config/initializers/cetustek.rb
+Cetustek.configure do |config|
+  # Set environment (:production or :sandbox)
+  config.environment = Rails.env.production? ? :production : :sandbox
+  
+  # Set authentication credentials
+  config.site_id = ENV['CETUSTEK_SITE_ID']
+  config.username = ENV['CETUSTEK_USERNAME']
+  config.password = ENV['CETUSTEK_PASSWORD']
+end
+```
+
+## Usage
+
+### Cancel an Invoice
+
+```ruby
+invoice = YourInvoiceModel.find(invoice_id)
+invoice_data = Cetustek::Models::InvoiceData.new(
+  order_id: invoice.order_id,
+  order_date: Time.zone.today,
+  buyer_identifier: invoice.receipt,
+  buyer_name: invoice.name,
+  buyer_email: invoice.email,
+  items: invoice.items.map { |item| 
+    Cetustek::Models::InvoiceItem.new(
+      code: item.sku,
+      name: item.name,
+      quantity: item.quantity,
+      unit_price: item.price
+    )
+  }
+)
+
+result = Cetustek::CreateInvoice.new(invoice_data).execute
+```
+
+## Development
+
+1. Clone this repository
+2. Run `bin/setup` to install dependencies
+3. Run `bin/console` for an interactive prompt to experiment
+
+## Requirements
+
+- Ruby >= 2.7.0
+- `ox` gem for XML processing
+- `savon` gem for SOAP services
+
+## Contributing
+
+1. Fork this project
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -am 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Versioning
+
+This project follows [Semantic Versioning](https://semver.org/). See the [CHANGELOG.md](CHANGELOG.md) file for version details.
+
+## License
+
+This gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/cetustek/cancel_invoice.rb

@@ -0,0 +1,54 @@
+module Cetustek
+  class CancelInvoice
+    def initialize(invoice)
+      @invoice = invoice
+    end
+
+    def execute
+      generate_xml
+      perform
+      analize_response
+    end
+
+    private
+
+    def perform
+      url = Cetustek.config.url
+      client = Savon.client(
+        wsdl: url,
+        open_timeout: 300,
+        read_timeout: 300
+      )
+
+      @response = client.call(:cancel_invoice, message:
+        { invoicexml: @xml,
+          source: Cetustek.config.site_id + Cetustek.config.password,
+          rentid: Cetustek.config.username })
+    end
+
+    def generate_xml
+      doc = Ox::Document.new
+
+      instruct = Ox::Instruct.new(:xml)
+      instruct[:version] = '1.0'
+      instruct[:encoding] = 'UTF-8'
+      instruct[:standalone] = 'yes'
+      doc << instruct
+
+      invoice = Ox::Element.new('Invoice')
+      invoice[:XSDVersion] = '2.8'
+      doc << invoice
+
+      invoice << Ox::Raw.new("<InvoiceNumber>#{@invoice.number}</InvoiceNumber>")
+      invoice << Ox::Raw.new("<InvoiceYear>#{@invoice.created_at.year}</InvoiceYear>")
+      invoice << Ox::Raw.new('<Remark>退貨</Remark>')
+      @xml = Ox.dump(doc)
+    end
+
+    def analize_response
+      return unless @response.body[:cancel_invoice_response][:return] == 'C0'
+
+      @invoice.update(canceled: true)
+    end
+  end
+end

data/lib/cetustek/configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Cetustek
+  class Configuration
+    attr_accessor :environment, :site_id, :username, :password
+
+    def initialize
+      @environment = :sandbox
+    end
+
+    def url
+      if @environment == :production
+        'https://www.ei.com.tw/InvoiceMultiWeb/InvoiceAPI?wsdl'
+      else
+        'https://invoice.cetustek.com.tw/InvoiceMultiWeb/InvoiceAPI?wsdl'
+      end
+    end
+
+    def production?
+      @environment == :production
+    end
+
+    def sandbox?
+      @environment == :sandbox
+    end
+  end
+
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/cetustek/create_invoice.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'models/invoice_data'
+require_relative 'services/invoice_xml_builder'
+require_relative 'services/invoice_service'
+require_relative 'services/response_handler'
+
+module Cetustek
+  class CreateInvoice
+    def initialize(invoice_data)
+      @invoice_data = invoice_data
+    end
+
+    def execute
+      xml = Services::InvoiceXmlBuilder.new(@invoice_data).build
+      response = Services::InvoiceService.new(xml, @invoice_data.order_id).create
+      result = Services::ResponseHandler.new(response, @invoice_data, xml).process
+      
+      if defined?(Rails) && result[:number] && result[:random_number]
+        update_invoice_info(result)
+      end
+      
+      result
+    end
+
+    private
+
+    def update_invoice_info(result)
+      return unless @invoice_data.respond_to?(:invoice_info)
+      
+      @invoice_data.invoice_info.update(
+        number: result[:number],
+        random_number: result[:random_number],
+        created_at: Time.zone.today
+      )
+    end
+  end
+end

data/lib/cetustek/models/invoice_data.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Cetustek
+  module Models
+    class InvoiceData
+      attr_reader :order_id, :order_date, :buyer_identifier, :buyer_name,
+                 :buyer_email, :donate_mark, :carrier_type, :carrier_id,
+                 :npo_ban, :items, :payment_type, :total_discount,
+                 :coupon_discount, :delivery_fee, :handling_fee
+
+      def initialize(attributes = {})
+        @order_id = attributes[:order_id]
+        @order_date = attributes[:order_date]
+        @buyer_identifier = attributes[:buyer_identifier]
+        @buyer_name = attributes[:buyer_name]
+        @buyer_email = attributes[:buyer_email]
+        @donate_mark = attributes[:donate_mark]
+        @carrier_type = attributes[:carrier_type]
+        @carrier_id = attributes[:carrier_id]
+        @npo_ban = attributes[:npo_ban]
+        @items = attributes[:items] || []
+        @payment_type = attributes[:payment_type]
+        @total_discount = attributes[:total_discount] || 0
+        @coupon_discount = attributes[:coupon_discount] || 0
+        @delivery_fee = attributes[:delivery_fee] || 0
+        @handling_fee = attributes[:handling_fee] || 0
+      end
+    end
+
+    class InvoiceItem
+      attr_reader :code, :name, :quantity, :unit_price
+
+      def initialize(attributes = {})
+        @code = attributes[:code]
+        @name = attributes[:name]
+        @quantity = attributes[:quantity]
+        @unit_price = attributes[:unit_price]
+      end
+    end
+  end
+end

data/lib/cetustek/query_invoice_by_order_id.rb

@@ -0,0 +1,19 @@
+module Cetustek
+  class QueryInvoiceByOrderId
+    def self.query(order_id)
+      url = Cetustek.config.url
+      client = Savon.client(
+        wsdl: url,
+        open_timeout: 300,
+        read_timeout: 300
+      )
+
+      @response = client.call(:query_invoice_by_orderid, message:
+        {
+          orderid: order_id,
+          source: Cetustek.config.site_id + Cetustek.config.password,
+          rentid: Cetustek.config.username
+        })
+    end
+  end
+end

data/lib/cetustek/services/invoice_service.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'savon'
+require 'logger'
+
+module Cetustek
+  module Services
+    class InvoiceService
+      def initialize(xml, order_id = nil)
+        @xml = xml
+        @order_id = order_id
+      end
+
+      def create
+        client = build_soap_client
+        response = call_create_invoice(client)
+        log_response(response)
+        response
+      end
+
+      private
+
+      def build_soap_client
+        Savon.client(
+          wsdl: Cetustek.config.url,
+          open_timeout: 300,
+          read_timeout: 300
+        )
+      end
+
+      def call_create_invoice(client)
+        client.call(:create_invoice_v3, message: {
+          invoicexml: @xml,
+          source: Cetustek.config.site_id + Cetustek.config.password,
+          rentid: Cetustek.config.username,
+          hastax: 1
+        })
+      end
+
+      def log_response(response)
+        return unless defined?(Rails)
+
+        logger = Logger.new(Rails.root.join('log/invoice.log'))
+        logger.debug("#{@order_id} - #{response.body}") if @order_id
+      end
+    end
+  end
+end

data/lib/cetustek/services/invoice_xml_builder.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'ox'
+require 'cgi'
+
+module Cetustek
+  module Services
+    class InvoiceXmlBuilder
+      def initialize(invoice_data)
+        @data = invoice_data
+      end
+
+      def build
+        doc = Ox::Document.new
+        doc << create_xml_instruct
+        doc << create_invoice_element
+
+        Ox.dump(doc)
+      end
+
+      private
+
+      def create_xml_instruct
+        instruct = Ox::Instruct.new(:xml)
+        instruct[:version] = '1.0'
+        instruct[:encoding] = 'UTF-8'
+        instruct
+      end
+
+      def create_invoice_element
+        invoice = Ox::Element.new('Invoice')
+        invoice[:XSDVersion] = '2.8'
+
+        add_basic_info(invoice)
+        add_buyer_info(invoice)
+        add_invoice_type_info(invoice)
+        add_details(invoice)
+
+        invoice
+      end
+
+      def add_basic_info(invoice)
+        invoice << Ox::Raw.new("<OrderId>#{@data.order_id}</OrderId>")
+        invoice << Ox::Raw.new("<OrderDate>#{@data.order_date.strftime('%Y/%m/%d')}</OrderDate>")
+      end
+
+      def add_buyer_info(invoice)
+        invoice << Ox::Raw.new("<BuyerIdentifier>#{@data.buyer_identifier}</BuyerIdentifier>")
+        invoice << Ox::Raw.new("<BuyerName>#{CGI.escapeHTML(@data.buyer_name)}</BuyerName>")
+        invoice << Ox::Raw.new("<BuyerEmailAddress>#{@data.buyer_email}</BuyerEmailAddress>")
+      end
+
+      def add_invoice_type_info(invoice)
+        invoice << Ox::Raw.new("<DonateMark>#{@data.donate_mark}</DonateMark>")
+        invoice << Ox::Raw.new('<InvoiceType>07</InvoiceType>')
+        invoice << Ox::Raw.new("<CarrierType>#{@data.carrier_type}</CarrierType>")
+        invoice << Ox::Raw.new("<CarrierId1>#{@data.carrier_id}</CarrierId1>")
+        invoice << Ox::Raw.new("<CarrierId2>#{@data.carrier_id2}</CarrierId2>")
+        invoice << Ox::Raw.new("<NPOBAN>#{@data.npo_ban}</NPOBAN>")
+        invoice << Ox::Raw.new('<TaxType>1</TaxType>')
+        invoice << Ox::Raw.new("<PayWay>#{@data.payment_type}</PayWay>")
+      end
+
+      def add_details(invoice)
+        details = Ox::Element.new('Details')
+        invoice << details
+
+        @data.items.each do |item|
+          details << create_product_item(item)
+        end
+
+        add_additional_items(details)
+      end
+
+      def create_product_item(item)
+        product = Ox::Element.new('ProductItem')
+        product << Ox::Raw.new("<ProductionCode>#{item.code}</ProductionCode>")
+        product << Ox::Raw.new("<Description>#{CGI.escapeHTML(item.name)}</Description>")
+        product << Ox::Raw.new("<Quantity>#{item.quantity}</Quantity>")
+        product << Ox::Raw.new("<UnitPrice>#{item.unit_price}</UnitPrice>")
+        product
+      end
+
+      def add_additional_items(details)
+        add_discount_item(details) if @data.total_discount.positive?
+        add_coupon_item(details) if @data.coupon_discount.positive?
+        add_delivery_fee_item(details) if @data.delivery_fee.positive?
+        add_handling_fee_item(details) if @data.handling_fee.positive?
+      end
+
+      def add_discount_item(details)
+        discount = Ox::Element.new('ProductItem')
+        discount << Ox::Raw.new('<ProductionCode>DISCOUNT</ProductionCode>')
+        discount << Ox::Raw.new('<Description>折抵金額</Description>')
+        discount << Ox::Raw.new('<Quantity>1</Quantity>')
+        discount << Ox::Raw.new("<UnitPrice>#{@data.total_discount * -1}</UnitPrice>")
+        details << discount
+      end
+
+      def add_coupon_item(details)
+        coupon = Ox::Element.new('ProductItem')
+        coupon << Ox::Raw.new('<ProductionCode>COUPON</ProductionCode>')
+        coupon << Ox::Raw.new('<Description>分享折讓</Description>')
+        coupon << Ox::Raw.new('<Quantity>1</Quantity>')
+        coupon << Ox::Raw.new("<UnitPrice>#{@data.coupon_discount * -1}</UnitPrice>")
+        details << coupon
+      end
+
+      def add_delivery_fee_item(details)
+        delivery = Ox::Element.new('ProductItem')
+        delivery << Ox::Raw.new('<ProductionCode>DELIVERY_FEE</ProductionCode>')
+        delivery << Ox::Raw.new('<Description>運費</Description>')
+        delivery << Ox::Raw.new('<Quantity>1</Quantity>')
+        delivery << Ox::Raw.new("<UnitPrice>#{@data.delivery_fee}</UnitPrice>")
+        details << delivery
+      end
+
+      def add_handling_fee_item(details)
+        handling = Ox::Element.new('ProductItem')
+        handling << Ox::Raw.new('<ProductionCode>HANDLING_FEE</ProductionCode>')
+        handling << Ox::Raw.new('<Description>手續費</Description>')
+        handling << Ox::Raw.new('<Quantity>1</Quantity>')
+        handling << Ox::Raw.new("<UnitPrice>#{@data.handling_fee}</UnitPrice>")
+        details << handling
+      end
+    end
+  end
+end

data/lib/cetustek/services/response_handler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cetustek
+  module Services
+    class ResponseHandler
+      class InvalidResponseError < StandardError; end
+
+      def initialize(response, invoice_data, xml = nil)
+        @response = response
+        @invoice_data = invoice_data
+        @xml = xml
+      end
+
+      def process
+        response_body = @response.body[:create_invoice_v3_response][:return]
+        number, random_number = response_body.split(';')
+
+        unless random_number
+          log_error
+          raise InvalidResponseError, "Invalid response: #{response_body}"
+        end
+
+        { number: number, random_number: random_number }
+      end
+
+      private
+
+      def log_error
+        return unless defined?(Rails) && @xml
+
+        logger = Logger.new(Rails.root.join('log/invoice_xml.log'))
+        logger.debug("#{@invoice_data.order_id} - #{@xml.force_encoding('UTF-8')}")
+      end
+    end
+  end
+end

data/lib/cetustek/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cetustek
+  VERSION = "0.2.0"
+end

data/lib/cetustek.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "cetustek/version"
+require_relative "cetustek/configuration"
+require_relative "cetustek/create_invoice"
+require_relative "cetustek/cancel_invoice"
+require_relative "cetustek/query_invoice_by_order_id"
+
+module Cetustek
+  class Error < StandardError; end
+
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/sig/cetustek.rbs

@@ -0,0 +1,4 @@
+module Cetustek
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cetustek
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zac
+bindir: exe
+cert_chain: []
+date: 2025-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Cetustek is a Ruby gem designed for handling electronic invoice operations,
+  including invoice cancellation. It communicates with the e-invoice system through
+  SOAP Web Services.
+email:
+- 579103+7a6163@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/cetustek.rb
+- lib/cetustek/cancel_invoice.rb
+- lib/cetustek/configuration.rb
+- lib/cetustek/create_invoice.rb
+- lib/cetustek/models/invoice_data.rb
+- lib/cetustek/query_invoice_by_order_id.rb
+- lib/cetustek/services/invoice_service.rb
+- lib/cetustek/services/invoice_xml_builder.rb
+- lib/cetustek/services/response_handler.rb
+- lib/cetustek/version.rb
+- sig/cetustek.rbs
+homepage: https://github.com/7a6163/cetustek
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/7a6163/cetustek
+  source_code_uri: https://github.com/7a6163/cetustek
+  changelog_uri: https://github.com/7a6163/cetustek/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby gem for handling electronic invoice operations
+test_files: []