cdek 0.3.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c7afff0a9b23550c0fd818553814200a2550c8088c775b9dc43344a6ce82b2f
+  data.tar.gz: f427ad01eb5f7616d30a957bb3b2ac7dd9e6e089dd2e0ff2c9c8c5abd17a630f
+SHA512:
+  metadata.gz: 740f1d591c45ab97ae6e571671cced18c139dcd955977a2776ef19ed8db871746ca403f6dfe4f9c9c034edcabd254634225618e5ded052f0d0c17321275416dd
+  data.tar.gz: cc8d3e212823258212ad61d44343d09d5847f99f00219dadfb842ca23e295ba8e9a3caf27ac5232aa09ff7a1bebd8ec86d8a5ee12200406fefd5d90d6527374e

data/CHANGELOG.md

@@ -0,0 +1,123 @@
+# Changelog
+
+## 0.3.9
+
+* В `cdek.gemspec` добавлена development-зависимость `rake`, потому что
+  `Rakefile` использует `bundler/gem_tasks`, а `bundle exec rake build`
+  падал, если `rake` не был явно включён в bundle.
+
+## 0.3.8
+
+* `cdek_widget_tag` больше не подставляет статичный DEFAULT_GOODS, если
+  хост-приложение не передало `goods:`. Это убирает расчёт доставки по
+  выдуманному коробу: реальные габариты и вес должны приходить из корзины
+  хост-приложения.
+* Шаблон `cdek_widget_controller.js` больше не фильтрует тарифы жёстким
+  списком `office: [136, 234]`. Виджет получает полный ответ CDEK и сам
+  выбирает доступные тарифы, поэтому новые/региональные тарифы не
+  отбрасываются на фронте.
+* Шаблон `cdek_widget_controller.js` пишет выбранный ПВЗ из полей
+  `office.address` и `office.city_code`, а не из `office.location`, где
+  виджет передаёт координаты.
+* Логи HTTP-клиента маскируют OAuth body и `access_token`, чтобы
+  `client_secret` и токен не попадали в Rails logs.
+
+## 0.3.7
+
+* `cdek_widget_tag`: добавлен параметр `goods:` — массив хэшей
+  `{ width:, height:, length:, weight: }`, описывающих габариты и вес
+  отправления для расчёта тарифа. По умолчанию — один «средний коробок»
+  30×10×30 см / 1 кг (как было захардкожено в шаблоне Stimulus в 0.3.6).
+  Хост-приложения с реальными корзинами могут собрать массив из cart-items
+  (например, в presenter'е/decorator'е) и передать в хелпер, чтобы CDEK
+  считал тариф по фактическим габаритам.
+* Шаблон `cdek_widget_controller.js`: новое значение `goods` (JSON-строка),
+  парсится с fallback на дефолт при пустом значении или невалидном JSON.
+  Хост-приложениям, уже сгенерировавшим контроллер на 0.3.6, надо
+  перегенерировать его (`bin/rails generate cdek:install`) или обновить
+  вручную, если хочется использовать `goods:` из помощника.
+* `Cdek::WidgetServiceController`: `protect_from_forgery with: :null_session`
+  заменён на `skip_forgery_protection`. CSRF и так не проверялся (виджет
+  не знает о Rails-токенах), но `:null_session` оставлял в логах
+  предупреждение `Can't verify CSRF token authenticity` на каждый POST
+  виджета. С `skip_forgery_protection` поведение идентичное, но без шума
+  в логах и без создания пустой null-сессии.
+
+## 0.3.6
+
+* `Cdek::WidgetServiceController`: явно отключён `wrap_parameters` и
+  добавлена фильтрация ключа-обёртки `widget_service` из параметров,
+  уходящих в CDEK API. Раньше Rails при JSON-POST дублировал все поля
+  body под ключом контроллера (`widget_service: {...}`), и эта обёртка
+  утекала в `/calculator/tarifflist` как лишний ключ. CDEK игнорировал
+  его (200 OK), но логи и сетевой трафик засорялись копией всего тела.
+* `cdek_widget_tag`: добавлен параметр `sender_city_code:` (Integer,
+  опционально) — CDEK-код города отправителя. Без него виджет передавал
+  в `from` только `{ address: ... }`, и CDEK возвращал только тарифы
+  `дверь-*` — виджет не мог выбрать тариф для опции «доставка в офис»
+  и показывал «Выберите тариф». С `sender_city_code:` в `from` уходит
+  `{ code: <N> }`, и CDEK возвращает полный набор тарифов включая
+  склад-склад (136, 234). Параметр опционален: без него поведение
+  прежнее (fallback на address) — обратная совместимость сохранена.
+* Шаблон `cdek_widget_controller.js`: добавлено значение
+  `senderCityCode` и выбор формы `from` по нему. Хост-приложениям,
+  которые уже сгенерировали контроллер на 0.3.5 и хотят склад-склад
+  тарифы, нужно либо перегенерировать его (`bin/rails generate
+  cdek:install`), либо обновить копию вручную из этого шаблона.
+
+## 0.3.5
+
+* Хелпер `cdek_widget_tag` теперь добавляет `position: relative` к
+  inline-стилям внешнего контейнера `.cdek-widget` и root-элемента
+  `.cdek-widget__root`. Это требование самого виджета: внутри он рисует
+  overlay'и карты, тултипы и поповеры через `position: absolute`, и без
+  позиционированного предка они привязываются к ближайшему
+  позиционированному элементу (часто — корню документа) и визуально
+  «уезжают» за пределы виджета. Хост-приложениям больше не нужно
+  прописывать `position: relative` у себя в CSS.
+
+## 0.3.4
+
+* **Критический фикс шаблона Stimulus-контроллера** в
+  `lib/generators/cdek/install/templates/cdek_widget_controller.js`.
+  Виджет `@cdek-it/widget@3` ожидает параметр `root` как строковый id,
+  не как HTMLElement. Шаблон теперь ставит уникальный id на root-таргет
+  и передаёт виджету именно строку. До этого виджет работал «в
+  стороне» — запросы офисов проходили 200 OK, но UI не отрисовывался
+  в хост-приложении.
+
+## 0.3.3
+
+* Откат flex-лейаута контейнера, введённого в 0.3.2. Box-model
+  с явной высотой работает надёжнее.
+
+## 0.3.2
+
+* Попытка перевести контейнер виджета на flex-column. Откачена в 0.3.3.
+
+## 0.3.1
+
+* Дефолтный шаблон `config/initializers/cdek.rb`: production-режим по
+  умолчанию; песочница — через `ENV["CDEK_SANDBOX"]`.
+
+## 0.3.0
+
+* Гем превращён в монтируемый Rails Engine (`Cdek::Engine`).
+* Серверный прокси `Cdek::WidgetServiceController` для JS-виджета ПВЗ.
+* Вендорный UMD-бандл `@cdek-it/widget@3.11.1` через asset pipeline.
+* View-хелпер `cdek_widget_tag`.
+* Генератор `cdek:install` ставит initializer + Stimulus-контроллер.
+
+### Breaking changes
+
+* `Cdek::Railtie` удалён, заменён на `Cdek::Engine`.
+
+## 0.2.0
+
+* High-level ресурсы `Cdek::Resources::Locations` и
+  `Cdek::Resources::Deliverypoints`.
+
+## 0.1.0
+
+* Первый релиз: тонкий клиент CDEK API v2, OAuth2, иерархия ошибок,
+  Railtie, генератор `cdek:install`.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sergey
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,138 @@
+# cdek
+
+Минималистичный Ruby/Rails-клиент для CDEK API v2 + монтируемый Rails Engine
+с виджетом ПВЗ «в коробке». Никаких внешних рантайм-зависимостей.
+
+* OAuth2 client_credentials c потокобезопасным кэшем токена.
+* Конфигурация через ENV или Rails-инициализатор.
+* High-level ресурсы для частых задач: `Cdek.locations`, `Cdek.deliverypoints`.
+* **Rails Engine** с прокси-эндпоинтом для официального JS-виджета ПВЗ
+  (cdek-it/widget@3).
+* Вендорный UMD-бандл виджета — раздаётся через asset pipeline (без CDN).
+* View-хелпер `cdek_widget_tag` — вставка виджета одной строкой.
+
+## Установка
+
+```ruby
+# Gemfile
+gem "cdek"
+```
+
+```bash
+bundle install
+bin/rails generate cdek:install
+```
+
+Генератор создаёт:
+
+* `config/initializers/cdek.rb` — заготовку настройки;
+* `app/javascript/controllers/cdek_widget_controller.js` — Stimulus-контроллер
+  виджета.
+
+Маршрут смонтируйте сами:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Cdek::Engine, at: "/cdek"
+  # ...
+end
+```
+
+Переменные окружения:
+
+```
+CDEK_ACCOUNT=...
+CDEK_SECURE_PASSWORD=...
+YANDEX_MAPS_API_KEY=...   # ключ Yandex Maps JS API для карты виджета
+```
+
+## Использование клиента
+
+```ruby
+Cdek.configure do |config|
+  config.account         = ENV["CDEK_ACCOUNT"]
+  config.secure_password = ENV["CDEK_SECURE_PASSWORD"]
+  config.production_mode!   # или config.test_mode! для песочницы
+end
+
+# Низкоуровневый вызов:
+Cdek.client.get("/deliverypoints", params: { city_code: 44, type: "PVZ" })
+
+# High-level:
+moscow = Cdek.locations.find_city("Москва")
+points = Cdek.deliverypoints.pvz_for_city(moscow.fetch("code"))
+```
+
+## Виджет ПВЗ
+
+В любой view:
+
+```erb
+<%= cdek_widget_tag api_key:      ENV["YANDEX_MAPS_API_KEY"],
+                    default_city: "Москва",
+                    goods:        current_cart.cdek_goods,
+                    modal_id:     "cdek-points-modal" %>
+```
+
+или в HAML:
+
+```haml
+= cdek_widget_tag api_key: ENV["YANDEX_MAPS_API_KEY"],
+                  default_city: "Москва",
+                  goods: current_cart.cdek_goods,
+                  modal_id: "cdek-points-modal"
+```
+
+
+`goods:` должен приходить из хост-приложения. Гем не подставляет
+статичный «средний короб», чтобы CDEK не считал доставку по выдуманным
+габаритам. Формат одного элемента массива: `width`, `height`, `length`
+в сантиметрах, `weight` в граммах. Если в приложении размеры хранятся в
+миллиметрах, перед передачей в виджет их нужно перевести в сантиметры;
+если вес хранится в килограммах — перевести в граммы.
+
+Что делает хелпер:
+
+1. Рендерит `<div class="cdek-widget">` со всеми data-* для Stimulus.
+2. JS-контроллер `cdek-widget` (поставлен генератором) подгружает
+   `/assets/cdek/widget.umd.js` (вшитый в гем UMD-бандл) и инициализирует
+   `window.CDEKWidget` в root-таргете.
+3. Виджет шлёт запросы на `/cdek/widget_service` (Engine route).
+4. На `onChoose` контроллер пишет данные выбранного пункта в скрытые поля
+   формы — по умолчанию:
+
+   * `#order_cdek_point_code`
+   * `#order_cdek_point_name`
+   * `#order_cdek_point_address`
+   * `#order_cdek_city_code`
+
+   DOM-id переопределяются именованными аргументами `field_code`,
+   `field_name`, `field_address`, `field_city_code` хелпера.
+
+5. Также диспатчится событие `cdek-widget:chosen` с `detail.office` —
+   можно слушать в собственных Stimulus-контроллерах.
+
+### Закрытие модалки
+
+Если виджет встроен в модалку, передайте её `id` в `modal_id:` — после
+выбора пункта будет отправлено `document.dispatchEvent(new CustomEvent(
+"modal:close", { detail: { id: <modal_id> } }))`. Реализация закрытия —
+на стороне хост-приложения (его modal-контроллер слушает это событие).
+
+## Обновление с 0.2.0 → 0.3.0
+
+1. `bundle update cdek`
+2. В `config/routes.rb` добавить:
+
+   ```ruby
+   mount Cdek::Engine, at: "/cdek"
+   ```
+
+3. `bin/rails generate cdek:install` — поставит Stimulus-контроллер.
+4. Внешний API (`Cdek.configure`, `Cdek.client`, `Cdek.locations`,
+   `Cdek.deliverypoints`) — без изменений.
+
+## Лицензия
+
+MIT.