belpost 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53d02403855e383fbb7d309ddeeeec66b2065303321cdde544d0e4fa6aba93e
-  data.tar.gz: aef5e4c2911ae80fca64dff3fb347cbf270ca66ea82da3905d3446a65efd543e
+  metadata.gz: d81d235b373255e2bff25ee56958cd6658a44e9546560ae96486986d278c1f0b
+  data.tar.gz: a155cca07102f767c12b05bf2c574fdb827f46cae00357e0b213c4daf0d35c84
 SHA512:
-  metadata.gz: cfef1ca328d78d3ff55335a2271ba505e02ef2a95af81924a43acc736fc1a09828197a5075bc501d219ed60847dcf606eea082a68d7617769a5cbc6a94395ff4
-  data.tar.gz: ffe48fcfa53026d756eccc552db0cdac37c17aed4b14489852d51a51d2a6ae97e9f931bbd7babcd2842232003f807152c550e315f7c9bee34446955994cb05f4
+  metadata.gz: cf7a95cd9ae059a9f0d4e10c3ac7e24cf7f94447817d9d104a58a2d2eb9382f4c13ea1fe5bb512589a9e92141ea92100632864a0637ac47150eed848af1d11d7
+  data.tar.gz: 4fa75a2f2af404733bcf1eff337ac0c102629d8c8ae67085e44858174e9f17975ffb70cced4e5444834801419391e484c340e5d9c87813ec1ce105f9616e2687

data/.env.test.example

@@ -0,0 +1,11 @@
+# Example environment variables for testing
+# Copy this file to .env.test and adjust values as needed
+
+# API URL for testing (required)
+BELPOST_API_URL=https://test-api.belpost.by
+
+# Test JWT token - not a real token
+BELPOST_JWT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTUxNjIzOTAyMn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+
+# Timeout for API requests in seconds
+BELPOST_TIMEOUT=5 

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [0.4.0] - 2025-04-01
+### Added
+- Added configuration via environment variables
+- Added test coverage and CI setup
+- Added basic documentation in README
+- Added .env.test.example for testing setup
+- Added spec helper with test configuration
+
+
+## [0.1.0] - 2025-03-31
+### Added
+- Initial gem version
+- Core classes for interacting with the Belpost API
+- Support for creating parcels
+- Data validation before sending to API
+- Error handling and request retries

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing Guide
+
+## Development Environment Setup
+
+1. Fork the repository and clone it:
+   ```
+   git clone https://github.com/YOUR_USERNAME/belpost.git
+   cd belpost
+   ```
+
+2. Install dependencies:
+   ```
+   bundle install
+   ```
+
+3. Run tests to make sure everything works:
+   ```
+   bundle exec rspec
+   ```
+
+## Development Process
+
+1. Create a new branch for your feature or fix:
+   ```
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make changes and add tests for new functionality.
+
+3. Make sure all tests pass:
+   ```
+   bundle exec rspec
+   ```
+
+4. Update documentation if you've added new features or changed existing ones.
+
+5. Commit your changes:
+   ```
+   git commit -am "Added new feature: XYZ"
+   ```
+
+6. Push your branch to GitHub:
+   ```
+   git push origin feature/your-feature-name
+   ```
+
+7. Create a Pull Request from your branch to the main repository.
+
+## Code Conventions
+
+- Follow the code style used in the project
+- Write YARD format documentation for new classes and methods
+- Always add tests for new functionality
+- Update CHANGELOG.md with descriptions of your changes in the [Unreleased] section
+
+## Review Process
+
+After creating a Pull Request:
+1. Wait for all CI checks to pass
+2. Respond to comments and make necessary corrections
+3. After approval, your Pull Request will be merged into the main branch
+
+Thank you for your contribution! 

data/README.md

@@ -1,54 +1,57 @@
 # Belpost
 
-Клиент для работы с Belpochta API (Белпочта).
+Client for working with Belpochta API (Belpost).
 
-## Установка
+![Tests](https://github.com/KuberLite/belpost/actions/workflows/test.yml/badge.svg)
+![Gem Version](https://badge.fury.io/rb/belpost.svg)
 
-Добавьте эту строку в Gemfile вашего приложения:
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
 gem 'belpost'
 ```
 
-И выполните:
+And then execute:
 
 ```bash
 $ bundle install
 ```
 
-Или установите самостоятельно:
+Or install it yourself:
 
 ```bash
 $ gem install belpost
 ```
 
-## Настройка
+## Configuration
 
-Настройте клиент для работы с API Белпочты:
+Configure the client to work with the Belpost API:
 
 ```ruby
 require 'belpost'
 
 Belpost.configure do |config|
-  config.jwt_token = 'ваш_jwt_токен_от_Белпочты'
+  config.jwt_token = 'your_jwt_token_from_belpost'
   config.base_url = 'https://api.belpost.by'
-  config.timeout = 30 # Таймаут в секундах (по умолчанию 10)
+  config.timeout = 30 # Timeout in seconds (default 10)
 end
 ```
 
-Вы также можете использовать переменные окружения:
+You can also use environment variables:
 
 ```
-BELPOST_JWT_TOKEN=ваш_jwt_токен_от_Белпочты
+BELPOST_JWT_TOKEN=your_jwt_token_from_belpost
 BELPOST_BASE_URL=https://api.belpost.by
 BELPOST_TIMEOUT=30
 ```
 
-## Использование
+## Usage
 
-### Создание посылки
+### Creating a parcel
 
-#### Базовый пример
+#### Basic example
 
 ```ruby
 client = Belpost::Client.new
@@ -82,23 +85,23 @@ parcel_data = {
   sender: {
     type: "legal_person",
     info: {
-      organization_name: "ООО \"Компания\"",
+      organization_name: "LLC \"Company\"",
       taxpayer_number: "123456789",
       IBAN: "BY26BAPB30123418400100000000",
       BIC: "BAPBBY2X",
-      bank: "ОАО 'БЕЛАГРОПРОМБАНК'"
+      bank: "JSC 'BELAGROPROMBANK'"
     },
     location: {
       code: "225212",
-      region: "Брестская",
-      district: "Березовский",
+      region: "Brest",
+      district: "Bereza",
       locality: {
-        type: "город",
-        name: "Береза"
+        type: "city",
+        name: "Bereza"
       },
       road: {
-        type: "улица",
-        name: "Ленина"
+        type: "street",
+        name: "Lenin"
       },
       building: "1",
       housing: "",
@@ -110,21 +113,21 @@ parcel_data = {
   recipient: {
     type: "natural_person",
     info: {
-      first_name: "Иван",
-      second_name: "Иванович",
-      last_name: "Иванов"
+      first_name: "Ivan",
+      second_name: "Ivanovich",
+      last_name: "Ivanov"
     },
     location: {
       code: "231365",
-      region: "Гродненская",
-      district: "Ивьевский",
+      region: "Grodno",
+      district: "Ivye",
       locality: {
-        type: "деревня",
-        name: "Дуды"
+        type: "village",
+        name: "Dudy"
       },
       road: {
-        type: "улица",
-        name: "Центральная"
+        type: "street",
+        name: "Central"
       },
       building: "1",
       housing: "",
@@ -136,40 +139,40 @@ parcel_data = {
 }
 
 response = client.create_parcel(parcel_data)
-puts "Трекинг код: #{response["data"]["parcel"]["s10code"]}"
+puts "Tracking code: #{response["data"]["parcel"]["s10code"]}"
 ```
 
-#### Использование ParcelBuilder
+#### Using ParcelBuilder
 
 ```ruby
 client = Belpost::Client.new
 
-# Создание внутренней посылки
+# Creating a domestic parcel
 parcel_data = Belpost::Models::ParcelBuilder.new
   .with_type("package")
   .with_attachment_type("products")
-  .with_weight(1500) # вес в граммах
-  .with_dimensions(300, 200, 100) # длина, ширина, высота в мм
+  .with_weight(1500) # weight in grams
+  .with_dimensions(300, 200, 100) # length, width, height in mm
   .to_country("BY")
   .with_declared_value(100)
   .with_cash_on_delivery(50)
   .add_service(:simple_notification)
   .add_service(:email_notification)
-  .from_legal_person("ООО \"Компания\"")
+  .from_legal_person("LLC \"Company\"")
   .with_sender_details(
     taxpayer_number: "123456789",
-    bank: "ОАО 'БЕЛАГРОПРОМБАНК'",
+    bank: "JSC 'BELAGROPROMBANK'",
     iban: "BY26BAPB30123418400100000000",
     bic: "BAPBBY2X"
   )
   .with_sender_location(
     postal_code: "225212",
-    region: "Брестская",
-    district: "Березовский",
-    locality_type: "город",
-    locality_name: "Береза",
-    road_type: "улица",
-    road_name: "Ленина",
+    region: "Brest",
+    district: "Bereza",
+    locality_type: "city",
+    locality_name: "Bereza",
+    road_type: "street",
+    road_name: "Lenin",
     building: "1"
   )
   .with_sender_contact(
@@ -177,18 +180,18 @@ parcel_data = Belpost::Models::ParcelBuilder.new
     phone: "375291234567"
   )
   .to_natural_person(
-    first_name: "Иван",
-    last_name: "Иванов", 
-    second_name: "Иванович"
+    first_name: "Ivan",
+    last_name: "Ivanov", 
+    second_name: "Ivanovich"
   )
   .with_recipient_location(
     postal_code: "231365",
-    region: "Гродненская",
-    district: "Ивьевский",
-    locality_type: "деревня",
-    locality_name: "Дуды",
-    road_type: "улица",
-    road_name: "Центральная",
+    region: "Grodno",
+    district: "Ivye",
+    locality_type: "village",
+    locality_name: "Dudy",
+    road_type: "street",
+    road_name: "Central",
     building: "1"
   )
   .with_recipient_contact(
@@ -197,24 +200,24 @@ parcel_data = Belpost::Models::ParcelBuilder.new
   .build
 
 response = client.create_parcel(parcel_data)
-puts "Трекинг код: #{response["data"]["parcel"]["s10code"]}"
+puts "Tracking code: #{response["data"]["parcel"]["s10code"]}"
 ```
 
-#### Создание международной посылки с таможенной декларацией
+#### Creating an international parcel with a customs declaration
 
 ```ruby
 client = Belpost::Client.new
 
-# Создание таможенной декларации
+# Creating a customs declaration
 customs_declaration = Belpost::Models::CustomsDeclaration.new
 customs_declaration.set_category("gift")
 customs_declaration.set_price("USD", 50)
 customs_declaration.add_item(
   {
-    name: "Книга",
-    local: "Книга",
+    name: "Book",
+    local: "Book",
     unit: {
-      local: "ШТ",
+      local: "PCS",
       en: "PCS"
     },
     count: 1,
@@ -227,22 +230,22 @@ customs_declaration.add_item(
   }
 )
 
-# Создание международной посылки
+# Creating an international parcel
 parcel_data = Belpost::Models::ParcelBuilder.new
   .with_type("package")
   .with_attachment_type("products")
   .with_weight(500)
-  .to_country("DE") # Германия
+  .to_country("DE") # Germany
   .with_declared_value(50, "USD")
-  .from_legal_person("ООО \"Компания\"")
+  .from_legal_person("LLC \"Company\"")
   .with_sender_location(
     postal_code: "225212",
-    region: "Брестская",
-    district: "Березовский",
-    locality_type: "город",
-    locality_name: "Береза",
-    road_type: "улица",
-    road_name: "Ленина",
+    region: "Brest",
+    district: "Bereza",
+    locality_type: "city",
+    locality_name: "Bereza",
+    road_type: "street",
+    road_name: "Lenin",
     building: "1"
   )
   .with_sender_contact(
@@ -265,10 +268,10 @@ parcel_data = Belpost::Models::ParcelBuilder.new
   .build
 
 response = client.create_parcel(parcel_data)
-puts "Трекинг код: #{response["data"]["parcel"]["s10code"]}"
+puts "Tracking code: #{response["data"]["parcel"]["s10code"]}"
 ```
 
-### Получение списка доступных стран
+### Getting a list of available countries
 
 ```ruby
 client = Belpost::Client.new
@@ -276,7 +279,7 @@ countries = client.fetch_available_countries
 puts countries
 ```
 
-### Получение данных для валидации почтового отправления
+### Obtaining data for postal item validation
 
 ```ruby
 client = Belpost::Client.new
@@ -284,7 +287,7 @@ validation_data = client.validate_postal_delivery("BY")
 puts validation_data
 ```
 
-### Получение кодов HS для таможенного декларирования
+### Obtaining HS codes for customs declaration
 
 ```ruby
 client = Belpost::Client.new
@@ -292,43 +295,71 @@ hs_codes = client.fetch_hs_codes
 puts hs_codes
 ```
 
-## Обработка ошибок
+## Error handling
 
-Клиент может выбрасывать следующие исключения:
+The client may throw the following exceptions:
 
-- `Belpost::ConfigurationError` - ошибка конфигурации
-- `Belpost::ValidationError` - ошибка валидации данных
-- `Belpost::ApiError` - базовая ошибка API
-- `Belpost::AuthenticationError` - ошибка аутентификации
-- `Belpost::InvalidRequestError` - ошибка запроса
-- `Belpost::RateLimitError` - превышен лимит запросов
-- `Belpost::ServerError` - ошибка сервера
-- `Belpost::NetworkError` - сетевая ошибка
-- `Belpost::TimeoutError` - таймаут запроса
+- `Belpost::ConfigurationError` - configuration error
+- `Belpost::ValidationError` - data validation error
+- `Belpost::ApiError` - basic API error
+- `Belpost::AuthenticationError` - authentication error
+- `Belpost::InvalidRequestError` - request error
+- `Belpost::RateLimitError` - request limit exceeded
+- `Belpost::ServerError` - server error
+- `Belpost::NetworkError` - network error
+- `Belpost::RequestError` - request timeout
 
-Пример обработки ошибок:
+Example of error handling:
 
 ```ruby
 begin
   client = Belpost::Client.new
   response = client.create_parcel(parcel_data)
 rescue Belpost::ValidationError => e
-  puts "Ошибка валидации: #{e.message}"
+  puts "Validation error: #{e.message}"
 rescue Belpost::AuthenticationError => e
-  puts "Ошибка аутентификации: #{e.message}"
+  puts "Authentication error: #{e.message}"
 rescue Belpost::ApiError => e
-  puts "Ошибка API: #{e.message}"
+  puts "API error: #{e.message}"
 end
 ```
 
-## Документация
+## Documentation
+
+Full documentation on the Belpost API is available in the official documentation.
+
+## Development
+
+After cloning the repository, run `bin/setup` to install dependencies. Then run `rake spec` to run tests. You can also run `bin/console` for an interactive REPL that allows you to experiment.
+
+### Setting up test environment
+
+For running tests, the gem uses environment variables that can be configured in different ways:
+
+1. Copy the `.env.test.example` file to `.env.test` and adjust the values:
+   ```
+   cp .env.test.example .env.test
+   ```
 
-Полная документация по API Белпочты доступна в официальной документации.
+2. The test suite will automatically use these values, or fall back to default test values if not provided.
 
-## Разработка
+3. For CI environments, the necessary environment variables are already configured in the GitHub workflow files.
 
-После клонирования репозитория выполните `bin/setup` для установки зависимостей. Затем выполните `rake spec` для запуска тестов.
+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).
+
+## Continuous Integration (CI/CD)
+
+The project is set up to use GitHub Actions for continuous integration (CI) and continuous delivery (CD):
+
+1. **Testing**: Every push and pull request to the `master` branch automatically runs tests on various Ruby versions.
+2. **Release**: When a tag starting with `v` is created (e.g., `v0.1.0`), the gem will be automatically published to RubyGems.
+
+For more detailed information about the release process, see the [RELEASING.md](RELEASING.md) file.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub.
+For information on how to contribute to the project, please see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/RELEASING.md

@@ -0,0 +1,41 @@
+# Releasing a New Gem Version
+
+This document describes the process for releasing a new version of the Belpost gem.
+
+## Release Steps
+
+1. Make sure all tests pass successfully:
+   ```
+   bundle exec rspec
+   ```
+
+2. Update the version number in `lib/belpost/version.rb`
+
+3. Update CHANGELOG.md with descriptions of changes in the new version
+
+4. Commit your changes:
+   ```
+   git add lib/belpost/version.rb CHANGELOG.md
+   git commit -m "Release version X.Y.Z"
+   ```
+
+5. Create a tag for the new version:
+   ```
+   git tag -a vX.Y.Z -m "Version X.Y.Z"
+   ```
+
+6. Push the commit and tag to GitHub:
+   ```
+   git push origin master
+   git push origin vX.Y.Z
+   ```
+
+7. GitHub Actions will automatically publish the gem to RubyGems.org when a new tag starting with 'v' is created.
+
+## Setup
+
+For automatic gem publication, you need to add the `RUBYGEMS_API_KEY` secret in your GitHub repository settings:
+
+1. Create an API key on RubyGems.org (if not already created)
+2. Go to your repository settings on GitHub: Settings > Secrets and variables > Actions
+3. Add a new secret named `RUBYGEMS_API_KEY` with the value of your API key from RubyGems.org 

data/Rakefile

@@ -2,11 +2,74 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
 require "rubocop/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+namespace :gem do
+  desc "Build the belpost gem"
+  task :build do
+    system "gem build belpost.gemspec"
+  end
+
+  desc "Install the gem locally"
+  task install: :build do
+    system "gem install belpost-*.gem"
+  end
+
+  desc "Clean up gem-related files"
+  task :clean do
+    system "rm -f *.gem"
+  end
+end
+
+namespace :version do
+  desc "Display current version"
+  task :show do
+    require_relative "lib/belpost/version"
+    puts "Current version: #{Belpost::VERSION}"
+  end
+
+  desc "Increment patch version (x.y.Z)"
+  task :patch do
+    update_version(:patch)
+  end
+
+  desc "Increment minor version (x.Y.z)"
+  task :minor do
+    update_version(:minor)
+  end
+
+  desc "Increment major version (X.y.z)"
+  task :major do
+    update_version(:major)
+  end
+end
+
+def update_version(level)
+  version_file = "lib/belpost/version.rb"
+  content = File.read(version_file)
+  major, minor, patch = content.match(/VERSION\s*=\s*["'](\d+)\.(\d+)\.(\d+)["']/)[1, 3].map(&:to_i)
+
+  case level
+  when :major
+    major += 1
+    minor = 0
+    patch = 0
+  when :minor
+    minor += 1
+    patch = 0
+  when :patch
+    patch += 1
+  end
+
+  new_version = "#{major}.#{minor}.#{patch}"
+  new_content = content.gsub(/VERSION\s*=\s*["']\d+\.\d+\.\d+["']/, "VERSION = \"#{new_version}\"")
+  
+  File.write(version_file, new_content)
+  puts "Version updated to #{new_version}"
+  puts "Don't forget to update CHANGELOG.md!"
+end

data/lib/belpost/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Belpost
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: belpost
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - KuberLite
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -46,9 +45,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example "
+- ".env.test.example"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - README.md
+- RELEASING.md
 - Rakefile
 - belpost.gemspec
 - lib/belpost.rb
@@ -72,7 +75,6 @@ metadata:
   source_code_uri: https://github.com/belpost/evropochta
   homepage_uri: https://github.com/KuberLite/belpost
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Belpost API wrapper
 test_files: []