yandex-dostavka 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb5ab099b6984b9856405b5c43a7116d47495b7c88f08bd22d7adf493dc6996
-  data.tar.gz: 42ea3078f2cb52aaa2e7eacf8a47480d7f7cd3f60e85ec5f56cfbc4e885c3a16
+  metadata.gz: 9640f2cfed42f6a1ad69212d4c255ca82482f1e4f98a2d4a0b5b50316aea99d7
+  data.tar.gz: 3c29642ce1ab73e829030fd3ba4a4a95eabc38b315370b891559c3a409beed35
 SHA512:
-  metadata.gz: 459ccb9da2c1e49de500eddbf6ae57a4e10c8c8185425f8e82f6f57ebd7b8b3c9d3e65008a163c2b7d7a52ce20fa4ff0ffe0890895cfa1dad80af2af84128a09
-  data.tar.gz: d94127db0ade19647fbf9f0b4b6bd13997dd2f507579d48e5574380a5c45346802a18bb870964c46f498b124e518f5b193464dfdc0d0e8e9e4a2ddad209a904d
+  metadata.gz: 51041e29403e882c72a1b4403428e1f8b9b65eeb521ad56472e6ddb3cb841dae25b097b2beee0c4756505a1694c95785d212620e641db6182652fd9bea0bf32f
+  data.tar.gz: a30bda566869acd6974153480b7571e5504e1e3d5a00e5241cf07cc467b0a125f237fe296328584db802ad63e855675de7aff27f182246e27e4b59631238d683

data/README.markdown

@@ -1,6 +1,6 @@
 # Yandex Dostavka API
 
-API wrapper для Yandex Dostavka API
+API wrapper для [Yandex Dostavka API](https://yandex.ru/dev/logistics/delivery-api/doc/about/intro.html)
 
 # Оглавление
 0. [Установка](#install)
@@ -8,6 +8,22 @@ API wrapper для Yandex Dostavka API
     2. [Использование Ruby](#using_ruby)
     3. [Debug Logging](#debug_logging)
     4. [Custom logger](#custom_logger)
+1. [Подготовка заявки](#part1)
+   1. [Предварительная оценка стоимости доставки](#api_b2b_platform_pricing-calculator_post)
+   2. [Получение интервалов доставки](#api_b2b_platform_offers_info_get)
+2. [Точки самопривоза и ПВЗ](#part2)
+   1. [Получение идентификатора населённого пункта](#api_b2b_platform_location_detect_post)
+   2. [Получение списка точек самопривоза и ПВЗ](#api_b2b_platform_pickup-points_list_post)
+3. [Основные запросы](#part3)
+   1. [Создание заявки](#api_b2b_platform_offers_create_post)
+   2. [Подтверждение заявки](#api_b2b_platform_offers_confirm_post)
+   3. [Получение информации о заявке](#api_b2b_platform_request_info_get)
+   4. [Получение информации о заявках во временном интервале](#api_b2b_platform_requests_info_get)
+   5. [История статусов заявки](#api_b2b_platform_request_history_get)
+   6. [Отмена заявки](#api_b2b_platform_request_cancel_post)
+4. [Ярлыки и акты приема-передачи](#part4)
+   1. [Получение ярлыков](#api_b2b_platform_request_generate-labels_post)
+   2. [Получение актов приёма-передачи для отгрузки](#api_b2b_platform_request_get-handover-act_post)
 
 # <a name="install"></a> Установка
 
@@ -41,10 +57,10 @@ API wrapper для Yandex Dostavka API
 Сначала создайте экземпляр объекта `YandexDostavka::Request`:
 
 ```ruby
-dostavka = YandexDostavka::Request.new(api_key: "***")
+dostavka = YandexDostavka::Request.new(token: "your_token")
 ```
 
-Вы можете изменять `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+Вы можете изменять `token`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
 
 ```ruby
 YandexDostavka::Request.timeout = 15
@@ -52,7 +68,7 @@ YandexDostavka::Request.open_timeout = 15
 YandexDostavka::Request.symbolize_keys = true
 YandexDostavka::Request.debug = false
 
-YandexDostavka::Request.api_key = "your_api_key"
+YandexDostavka::Request.token = "your_token"
 ```
 
 Либо в файле `config/initializers/yandex_dostavka.rb` для Rails.
@@ -62,7 +78,7 @@ YandexDostavka::Request.api_key = "your_api_key"
 Измените `debug: true` чтобы включить логирование в STDOUT.
 
 ```ruby
-dostavka = YandexDostavka::Request.new(api_key: "***", debug: true)
+dostavka = YandexDostavka::Request.new(token: "AgAAAADzeAQMAAAPeISvM_9LUkxCijQoFXOH5QE", debug: true)
 ```
 
 ### <a name="custom_logger"></a> Custom logger
@@ -70,7 +86,7 @@ dostavka = YandexDostavka::Request.new(api_key: "***", debug: true)
 `Logger.new` используется по умолчанию, но вы можете изменить на свой:
 
 ```ruby
-dostavka = YandexDostavka::Request.new(api_key: "***", debug: true, logger: MyLogger.new)
+dostavka = YandexDostavka::Request.new(token: "AgAAAADzeAQMAAAPeISvM_9LUkxCijQoFXOH5QE", debug: true, logger: MyLogger.new)
 ```
 
 Или:
@@ -79,4 +95,175 @@ dostavka = YandexDostavka::Request.new(api_key: "***", debug: true, logger: MyLo
 YandexDostavka::Request.logger = MyLogger.new
 ```
 
-# <a name="examples"></a> Примеры
+## <a name="part1"></a> [Подготовка заявки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part1.html) 
+### <a name="api_b2b_platform_pricing-calculator_post"></a> [Предварительная оценка стоимости доставки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part1/api_b2b_platform_pricing-calculator_post.html)
+```ruby
+body = { 
+        client_price: 10000,
+        destination: {
+                address: "Санкт-Петербург, ул. Академика Павлова, д. 5"
+        },
+        payment_method: "already_paid",
+        source: {
+                address: "Санкт-Петербург, ул. Профессора Попова, д. 38"
+        },
+        tariff: "time_interval",
+        total_assessed_price: 10000,
+        total_weight: 1000
+}
+response = YandexDostavka::Request.pricing_calculator.create(body: body)
+pricing_total = response.body[:pricing_total]
+#=> "360 RUB"
+```
+### <a name="api_b2b_platform_offers_info_get"></a> [Получение интервалов доставки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part1/api_b2b_platform_offers_info_get.html)
+```ruby
+params = {
+        station_id: "03840f16-3c53-400c-b382-1ecf30e06b64",
+        full_address: "Санкт-Петербург, Професора Попова, 38",
+        geo_id: 2
+}
+response = YandexDostavka::Request.offers.info.retrieve(params: params)
+```
+## <a name="part2"></a> [Точки самопривоза и ПВЗ](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part2.html)
+### <a name="api_b2b_platform_location_detect_post"></a> [Получение идентификатора населённого пункта](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part2/api_b2b_platform_location_detect_post.html)
+```ruby
+body = {
+        location: "Санкт-Петербург"
+}
+response = YandexDostavka::Request.location.detect.create(body: body)
+variants = response.body[:variants]
+#=> [{:geo_id=>2, :address=>"Россия, Санкт-Петербург"}] 
+```
+### <a name="api_b2b_platform_pickup-points_list_post"></a> [Получение списка точек самопривоза и ПВЗ](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part2/api_b2b_platform_pickup-points_list_post.html)
+```ruby
+body = {
+        available_for_dropoff: true,
+        payment_method: "already_paid",
+        type: "pickup_point"
+}
+response = YandexDostavka::Request.pickup_points.list.create(body: body)
+points = response.body[:points]
+# =>
+#         [{:id=>"03840f16-3c53-400c-b382-1ecf30e06b64",
+#           ...
+```
+## <a name="part3"></a> [Основные запросы](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3.html)
+### <a name="api_b2b_platform_offers_create_post"></a> [Создание заявки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_offers_create_post.html)
+```ruby
+body = {
+        billing_info: {
+                delivery_cost: 10000,
+                payment_method: "card_on_receipt"
+        },
+        destination: {
+                custom_location: {
+                        details: {
+                                comment: "БЦ Ривер Хаус",
+                                full_address: "Санкт-Петербург, ул. Академика Павлова, 5",
+                                room: "601"
+                        }
+                },
+                interval: {
+                        from: DateTime.now.to_i,
+                        to: DateTime.tomorrow.to_datetime.to_i
+                },
+                type: "custom_location"
+        },
+        info: {
+                comment: "Позвонить за час",
+                operator_request_id: "100023"
+        },
+        items: [
+                {
+                        article: "55185",
+                        billing_details: {
+                                assessed_unit_price: 237900,
+                                unit_price: 237900
+                        },
+                        count: 1,
+                        name: "Автомобильный держатель Mage Safe Qi для iPhone, магнитный, черный",
+                        place_barcode: "4680431123446"
+                }
+        ],
+        places: [
+                {
+                        barcode: "4680431123446",
+                        physical_dims: {
+                                predefined_volume: 10000,
+                                weight_gross: 1000
+                        }
+                }
+        ],
+        recipient_info: {
+                email: "recipient@email.com",
+                first_name: "Осетров",
+                last_name: "Павел",
+                partonymic: "Федорович",
+                phone: "+7111111111111"
+        },
+        source: {
+                platform_station: {
+                        platform_id: "03840f16-3c53-400c-b382-1ecf30e06b64"
+                }
+        }
+}
+response = YandexDostavka::Request.offers("create").create(body: body)
+```
+### <a name="api_b2b_platform_offers_confirm_post"></a> [Подтверждение заявки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_offers_confirm_post.html)
+```ruby
+body = {
+        offer_id: "1"
+}
+response = YandexDostavka::Request.offers.confirm.create(body: body)
+```
+### <a name="api_b2b_platform_request_info_get"></a> [Получение информации о заявке](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_request_info_get.html)
+```ruby
+response = YandexDostavka::Request.request.info.retrieve(params: {request_id: "873113ce-819a-4a73-b500-dce9dae82299"})
+```
+### <a name="api_b2b_platform_requests_info_get"></a> [Получение информации о заявках во временном интервале](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_requests_info_get.html)
+```ruby
+params = {
+        from: (DateTime.now - 7.day).to_i,
+        to: DateTime.now.to_i
+}
+response = YandexDostavka::Request.requests.info.retrieve(params: params)
+```
+### <a name="api_b2b_platform_request_history_get"></a> [История статусов заявки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_request_history_get.html)
+```ruby
+response = YandexDostavka::Request.request.history.retrieve(params: {request_id: "873113ce-819a-4a73-b500-dce9dae82299"})
+```
+### <a name="api_b2b_platform_request_cancel_post"></a> [Отмена заявки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part3/api_b2b_platform_request_cancel_post.html)
+```ruby
+response = YandexDostavka::Request.request.cancel.create(body: {request_id: "873113ce-819a-4a73-b500-dce9dae82299"})
+```
+## <a name="part4"></a> [Ярлыки и акты приема-передачи](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part4.html)
+### <a name="api_b2b_platform_request_generate-labels_post"></a> [Получение ярлыков](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part4/api_b2b_platform_request_generate-labels_post.html)
+```ruby
+body = {
+        generate_type: "many",
+        request_ids: [
+                "873113ce-819a-4a73-b500-dce9dae82299"
+        ]
+}
+
+```
+### <a name="api_b2b_platform_request_get-handover-act_post"></a> [Получение актов приёма-передачи для отгрузки](https://yandex.ru/dev/logistics/delivery-api/doc/ref/part4/api_b2b_platform_request_get-handover-act_post.html)
+```ruby
+params = {
+        editable_format: true,
+        new_requests: true,
+        created_since: 1643711508,
+        created_until: 1644489108,
+        created_since_utc: "2021-10-25T15:00:0.000000Z",
+        created_until_utc: "2021-10-25T17:00:0.000000Z",
+        request_ids: "873113ce-819a-4a73-b500-dce9dae82299,dbc17cb3-d3de-48e2-9f7f-b4ff23095df7",
+        request_code: "my_request_id_123"
+}
+body = {
+        request_ids: [
+                "873113ce-819a-4a73-b500-dce9dae82299",
+                "dbc17cb3-d3de-48e2-9f7f-b4ff23095df7"
+        ]
+}
+response = YandexDostavka::Request.request.get_handover_act.create(params: params, body: body)
+```

data/lib/generators/{yandex-dostavka → yandex_dostavka}/install/templates/yandex_dostavka.rb

@@ -8,7 +8,7 @@ YandexDostavka.setup do |config|
       config::register k.underscore.to_sym, v
     end
 
-    config::Request.token ||= ENV['YANDEX_DOSTAVKA_TOKEN']
+    config::Request.token = YandexDostavka.token || ENV['YANDEX_DOSTAVKA_TOKEN']
 
     config::Request.timeout = 60
     config::Request.open_timeout = 60

data/lib/generators/yandex_dostavka/install/templates/yandex_dostavka.yml

@@ -0,0 +1,12 @@
+defaults: &defaults
+  API_ENDPOINT: "https://b2b.taxi.tst.yandex.net"
+production:
+  <<: *defaults
+  API_ENDPOINT: "https://b2b-authproxy.taxi.yandex.net"
+  YANDEX_DOSTAVKA_TOKEN: "***"
+development:
+  <<: *defaults
+  API_ENDPOINT: "https://b2b.taxi.tst.yandex.net"
+  YANDEX_DOSTAVKA_TOKEN: "AgAAAADzeAQMAAAPeISvM_9LUkxCijQoFXOH5QE"
+test:
+  <<: *defaults

data/lib/yandex-dostavka/version.rb

@@ -1,3 +1,3 @@
 module YandexDostavka
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex-dostavka
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Pavel Osetrov
@@ -74,10 +74,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.markdown
-- lib/generators/yandex-dostavka/install/USAGE
-- lib/generators/yandex-dostavka/install/install_generator.rb
-- lib/generators/yandex-dostavka/install/templates/yandex_dostavka.rb
-- lib/generators/yandex-dostavka/install/templates/yandex_dostavka.yml
+- lib/generators/yandex_dostavka/install/USAGE
+- lib/generators/yandex_dostavka/install/install_generator.rb
+- lib/generators/yandex_dostavka/install/templates/yandex_dostavka.rb
+- lib/generators/yandex_dostavka/install/templates/yandex_dostavka.yml
 - lib/yandex-dostavka.rb
 - lib/yandex-dostavka/api_request.rb
 - lib/yandex-dostavka/error.rb

data/lib/generators/yandex-dostavka/install/templates/yandex_dostavka.yml

@@ -1,12 +0,0 @@
-defaults: &defaults
-  API_ENDPOINT: "https://b2b.taxi.tst.yandex.net/"
-  YANDEX_DOSTAVKA_TOKEN: "***"
-production:
-  <<: *defaults
-  API_ENDPOINT: "https://b2b-authproxy.taxi.yandex.net"
-  YANDEX_DOSTAVKA_TOKEN: "***"
-development:
-  <<: *defaults
-  API_ENDPOINT: "https://b2b.taxi.tst.yandex.net/"
-test:
-  <<: *defaults