tcat 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 649a0ce80d0bd52cde6c0cd171b869ab557d7b085467d2e0e950a652456a29a9
-  data.tar.gz: 2519e582fd44fc108a05b1c69a0bbcc80dba5620f6acb5f8baf21a96c8289b38
+  metadata.gz: 66a34a4165a334cea5fc3e1297f49265cff8cff2099aa8ea6ea0912d953798a1
+  data.tar.gz: 72cd8a878a16a17829ffbb0dfbe6588c04828ed1e72de0799f3fe66460b9451b
 SHA512:
-  metadata.gz: 5040e5ed15e2bef7e946a7b237f50464ecf52fbe0dd50fec8aba99c9ee78e9d1c43de2d78840a84921876c713b1af46cfbe90d2d2a75183619a5d8839466620b
-  data.tar.gz: fdcacbc2c3bdd76754cf73083bd59dd8791501f22404966992bc827a78d90ddb2e3f8f8819b2bc1611175f451eb9c9e8ec8b55a6136826e8ddc7026f1461648a
+  metadata.gz: 96960dd54febe02718c8fb068206b3d1b0d23ca45ddb65b4097920cdf58d87b5bba346e2fce0bcc3ef11109b67d78c6a00d6ad84d8d1899358ee094e4245f863
+  data.tar.gz: d5a1a0ee708bb6179d62b8596af30137ecd0965f146bb6f009a3ac9b834242fe61046e553f6620a457e215c99f13375306c13bddbb7b011bf217614b1683f961

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.7
+  Exclude:
+    - 'bin/*'
 
 # Style/StringLiterals:
 #   Enabled: true
@@ -9,5 +11,15 @@ AllCops:
 #   Enabled: true
 #   EnforcedStyle: double_quotes
 
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/tcat/query.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/tcat/query.rb'
+
 Layout/LineLength:
-  Max: 120
+  Exclude:
+    - 'lib/tcat/query.rb'
+    - tcat.gemspec

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.3
+ruby 3.3.6

data/README.md

@@ -1,35 +1,112 @@
 # Tcat
 
-TODO: Delete this and the text below, and describe your gem
+A Ruby gem for tracking T-Cat (Taiwan Pelican Express) shipment status. Provides a simple and easy-to-use API interface.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tcat`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
+
+- Track shipment status
+- Secure encrypted requests
+- Simple API interface
+- Non-blocking HTTP requests
+- Comprehensive error handling
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tcat'
+```
+
+And then execute:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+$ bundle install
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+$ gem install tcat
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Configuration
+
+Configure the gem before use:
+
+```ruby
+Tcat.configure do |config|
+  config.secret_string = 'your_secret_string'
+  config.secret_key = 'your_secret_key'
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+```ruby
+# Create a query instance
+query = Tcat::Query.new('your_tracking_number')
+
+# Get shipment status
+status = query.perform
+
+# Status will be one of the following:
+# :done        - Successfully delivered
+# :delivering  - Out for delivery
+# :collected   - Package collected
+# :in_transit  - In transit
+# :unknown     - Unknown status
+```
+
+### Error Handling
+
+```ruby
+begin
+  status = query.perform
+rescue Tcat::HttpClient::RequestError => e
+  puts "Network request error: #{e.message}"
+rescue Tcat::EncryptionService::EncryptionError => e
+  puts "Encryption error: #{e.message}"
+rescue StandardError => e
+  puts "Other error: #{e.message}"
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+1. Fork the 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. Create a Pull Request
+
+### Running Tests
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+$ bundle exec rake spec
+```
+
+### Local Installation
+
+```bash
+$ bundle exec rake install
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tcat.
+Bug reports and pull requests are welcome.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+### 0.1.5 (2024-01-11)
+
+- Refactored HTTP request handling with new HttpClient class
+- Refactored encryption logic with new EncryptionService class
+- Improved error handling
+- Updated documentation

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/tcat/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Tcat
+  # Configuration class handles settings for Tcat
   class Configuration
     attr_accessor :secret_string, :secret_key
 

data/lib/tcat/encryption_service.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+
+module Tcat
+  class EncryptionService
+    class EncryptionError < StandardError; end
+
+    CIPHER_ALGORITHM = 'AES-128-ECB'
+
+    def initialize(secret_key)
+      @secret_key = secret_key
+      validate_key!
+    end
+
+    def encrypt(message)
+      cipher = setup_cipher
+      padded_message = pad_message(message, cipher.block_size)
+      encrypted = cipher.update(padded_message)
+      Base64.strict_encode64(encrypted)
+    rescue OpenSSL::Cipher::CipherError => e
+      raise EncryptionError, "Encryption failed: #{e.message}"
+    rescue StandardError => e
+      raise EncryptionError, "Unexpected error during encryption: #{e.message}"
+    end
+
+    private
+
+    def validate_key!
+      raise EncryptionError, 'Secret key cannot be nil or empty' if @secret_key.nil? || @secret_key.empty?
+    end
+
+    def setup_cipher
+      cipher = OpenSSL::Cipher.new(CIPHER_ALGORITHM)
+      cipher.encrypt
+      cipher.key = @secret_key
+      cipher
+    end
+
+    def pad_message(message, block_size)
+      padding_size = block_size - (message.length % block_size)
+      padding = padding_size.chr * padding_size
+      message + padding
+    end
+  end
+end

data/lib/tcat/http_client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Tcat
+  class HttpClient
+    DEFAULT_HEADERS = {
+      'User-Agent' => 'BlackCat/2.49 (iPhone; iOS 17.6.1; Scale/3.00)',
+      'Accept-Language' => 'zh-Hant-TW;q=1, en-TW;q=0.9',
+      'Cookie' => 'citrix_ns_id=AAE7go4rZDusCRcEAAAAADuVBLGLdqo1FolMO02r_jOEnjNmr4u9sIYwtllmmfsOOw==KJArZA==AQJLxyeLYOXPo3Uzfh_rWrr_NcU=; ASP.NET_SessionId=p4v1z4nijrynbortgf4iqml4'
+    }.freeze
+
+    API_ENDPOINT = 'https://www.t-cat.com.tw/iPhone/TCatApp.aspx'
+    API_VERSION = '24.26'
+
+    class RequestError < StandardError; end
+
+    def initialize(timeout: 30)
+      @timeout = timeout
+    end
+
+    def post(params)
+      uri = URI("#{API_ENDPOINT}?ver=#{API_VERSION}")
+      http = setup_http_client(uri)
+      
+      request = Net::HTTP::Post.new(uri)
+      DEFAULT_HEADERS.each { |key, value| request[key] = value }
+      request.body = URI.encode_www_form(params)
+
+      handle_response(http.request(request))
+    rescue Net::ReadTimeout, Net::OpenTimeout => e
+      raise RequestError, "Request timeout: #{e.message}"
+    rescue SocketError, Net::HTTPError => e
+      raise RequestError, "Network error: #{e.message}"
+    rescue StandardError => e
+      raise RequestError, "Unexpected error: #{e.message}"
+    end
+
+    private
+
+    def setup_http_client(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.read_timeout = @timeout
+      http.open_timeout = @timeout
+      http
+    end
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        response.body
+      when Net::HTTPRedirection
+        raise RequestError, "Unexpected redirect to #{response['location']}"
+      else
+        raise RequestError, "HTTP #{response.code}: #{response.message}"
+      end
+    end
+  end
+end

data/lib/tcat/query.rb

@@ -3,8 +3,11 @@
 require 'net/http'
 require 'base64'
 require 'ox'
+require_relative 'http_client'
+require_relative 'encryption_service'
 
 module Tcat
+  # Query class handles making requests to the Tcat system
   class Query
     def initialize(tracking_number)
       @secret_string = Tcat.configuration.secret_string
@@ -12,27 +15,23 @@ module Tcat
       validate_secrets!
 
       @tracking_number = tracking_number
+      @http_client = HttpClient.new
+      @encryption_service = EncryptionService.new(@secret_key)
     end
 
     def perform
-      cookies = 'citrix_ns_id=AAE7go4rZDusCRcEAAAAADuVBLGLdqo1FolMO02r_jOEnjNmr4u9sIYwtllmmfsOOw==KJArZA==AQJLxyeLYOXPo3Uzfh_rWrr_NcU=; ASP.NET_SessionId=p4v1z4nijrynbortgf4iqml4'
-      ua = 'BlackCat/2.49 (iPhone; iOS 17.6.1; Scale/3.00)'
-      headers = { 'User-Agent': ua, 'Accept-Language': 'zh-Hant-TW;q=1, en-TW;q=0.9', Cookie: cookies }
-      uri = URI('https://www.t-cat.com.tw/iPhone/TCatApp.aspx?ver=24.26')
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      body = URI.encode_www_form(data)
-      response = Net::HTTP.post(uri, body, headers)
-
-      parse_response(response.body) if response.code == '200'
+      response_body = @http_client.post(data)
+      parse_response(response_body) if response_body
+    rescue HttpClient::RequestError => e
+      # Log error or handle it appropriately
+      nil
     end
 
     private
 
     def validate_secrets!
-      raise ArgumentError, "SECRET_STRING must be configured" if @secret_string.nil? || @secret_string.empty?
-      raise ArgumentError, "SECRET_KEY must be configured" if @secret_key.nil? || @secret_key.empty?
+      raise ArgumentError, 'SECRET_STRING must be configured' if @secret_string.nil? || @secret_string.empty?
+      raise ArgumentError, 'SECRET_KEY must be configured' if @secret_key.nil? || @secret_key.empty?
     end
 
     def data
@@ -40,14 +39,13 @@ module Tcat
         ConsignmentNo: @tracking_number,
         f: 5,
         isForeign: 'N',
-        secret: secret,
+        secret: generate_secret,
         SVC: 'TCATAPP'
       }
     end
 
     def date_string
-      date = Time.now.utc
-      date.strftime('%Y%m%d%H%M%S')
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
     end
 
     def random
@@ -58,18 +56,11 @@ module Tcat
       random + @secret_string + date_string
     end
 
-    def secret
-      cipher = OpenSSL::Cipher.new('AES-128-ECB')
-      cipher.encrypt
-      cipher.key = @secret_key
-
-      block_size = cipher.block_size
-      padding_size = block_size - (source_string.length % block_size)
-      padding = padding_size.chr * padding_size
-      padded_message = source_string + padding
-
-      encrypted = cipher.update(padded_message)
-      Base64.strict_encode64(encrypted)
+    def generate_secret
+      @encryption_service.encrypt(source_string)
+    rescue EncryptionService::EncryptionError => e
+      # Log error or handle it appropriately
+      raise "Failed to generate secret: #{e.message}"
     end
 
     def parse_response(xml)
@@ -89,12 +80,16 @@ module Tcat
     end
 
     def parse_status_message(statuses)
-      if '順利送達'.in?(statuses)
+      if statuses.include?('順利送達')
         :done
-      elsif '配送中'.in?(statuses)
+      elsif statuses.include?('配送中')
         :delivering
-      elsif '已集貨'.in?(statuses)
+      elsif statuses.include?('已集貨')
         :collected
+      elsif statuses.include?('轉運中')
+        :in_transit
+      else
+        :unknown
       end
     end
   end

data/lib/tcat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tcat
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/tcat.rb

@@ -4,6 +4,7 @@ require 'tcat/configuration'
 require_relative 'tcat/version'
 require_relative 'tcat/query'
 
+# Tcat module provides functionality for tracking packages
 module Tcat
   class << self
     attr_writer :configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcat
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -55,6 +55,8 @@ files:
 - Rakefile
 - lib/tcat.rb
 - lib/tcat/configuration.rb
+- lib/tcat/encryption_service.rb
+- lib/tcat/http_client.rb
 - lib/tcat/query.rb
 - lib/tcat/version.rb
 - sig/tcat.rbs
@@ -78,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for tracking packages using the Tcat system.