yandex-delivery 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace5fa6ba5f600789f8e2b9a3b265c349b41bb08d4d1f4e9bd9cadc29efc95d7
-  data.tar.gz: 5df92db3acc8ae0bd0d805ea6ecfe48ff5d314432d82209c2009105aa07c4b59
+  metadata.gz: 879dec72178429f7404eda56de3ffa39002530a8451a82753ce79e26cb64e38e
+  data.tar.gz: 99cb8023968d3a40c9b03a834a812b418ac410a79287fcfd72a5fe1f36f20493
 SHA512:
-  metadata.gz: be081c9b8b8a6bfa927627f0590dd75a0a84a66827926b5911d7915d7ccaea1598bb097a5acd21b48881090a467a80f8a7f0441d4dc9a7d4bd6d42f4d7be426c
-  data.tar.gz: b3f05e6c3762f59de904606a6127d94fb57989e0f1249ecc06155dea676d491daf8f54d47b309c8ff604c4b5dae61c58fd08ed4dfd88b2bea1bc271951aa02b7
+  metadata.gz: 0bc51ee3f55b3fbab1c6939fc926435d6e25b27cdc06e80d9691166e579c8207a8c565353081b4aa6999aa746bad7c9ce9689800d0c11f479235e4259d3fb108
+  data.tar.gz: b6ea88f077d315ed92a2be1512c25a4ca202db48ee2c2ef352290004afeee27642e1183cdb75d1cf4cea2a85ad1f6810b9f07c1905d27e17616c904e5fa612fb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Pavel Osetrov
+
+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.markdown

@@ -0,0 +1,254 @@
+# Yandex-delivery
+
+API wrapper для Яндекс.доставки [API](https://yandex.ru/dev/delivery-3/doc/dg/).
+
+## Установка Ruby
+
+    $ gem install yandex-delivery
+
+## Установка Rails
+
+добавьте в Gemfile:
+
+    gem 'yandex-delivery'
+
+и запустите `bundle install`.
+
+Затем:
+
+    rails g yandex_delivery:install
+
+## Требования
+
+Необходимо получить [токен авторизации](https://yandex.ru/dev/delivery-3/doc/dg/concepts/access.html).
+
+## Использование Rails
+
+В файл `config/yandex_delivery2.yml` вставьте ваши данные из настоек яндекс доставки и токен авторизации
+
+## Использование Ruby
+
+Сначала создайте экземпляр объекта `YandexDelivery::Request`:
+
+```ruby
+delivery = YandexDelivery::Request.new(api_key: "your_access_token")
+```
+
+Вы можете изменять `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+
+```ruby
+YandexDelivery::Request.api_key = "your_access_token"
+YandexDelivery::Request.timeout = 15
+YandexDelivery::Request.open_timeout = 15
+YandexDelivery::Request.symbolize_keys = true
+YandexDelivery::Request.debug = false
+```
+
+Либо в файле `config/initializers/yandex_delivery2.rb` для Rails.
+
+## Debug Logging
+
+Pass `debug: true` to enable debug logging to STDOUT.
+
+```ruby
+delivery = YandexDelivery::Request.new(api_key: "your_access_token", debug: true)
+```
+
+### Custom logger
+
+Ruby `Logger.new` is used by default, but it can be overrided using:
+
+```ruby
+delivery = YandexDelivery::Request.new(api_key: "your_access_token", debug: true, logger: MyLogger.new)
+```
+
+Logger can be also set by globally:
+
+```ruby
+YandexDelivery::Request.logger = MyLogger.new
+```
+
+## Примеры
+
+### Варианты доставки
+
+#### Поиск вариантов доставки
+
+```ruby
+# для Rails senderId указывать не обязательно, в запрос подставится значение из config/yandex_delivery2.yml
+body = {
+  :to=>{:location=>"Санкт-Петербург"}, 
+  :dimensions=>{:length=>1, :height=>1, :width=>1, :weight=>1}
+}
+
+YandexDelivery::Request.delivery_options.upsert(body: body)
+```
+
+#### Поиск пунктов выдачи заказов
+
+```ruby
+YandexDelivery::Request.pickup_points.upsert(body: {locationId: 2})
+```
+
+### Операции с заказами
+
+#### Создать черновик заказа
+
+```ruby
+response = YandexDelivery::Request.orders.create(body: {deliveryType: 'COURIER'})
+order_id = response.body
+```
+
+#### Обновить черновик заказа
+
+```ruby
+YandexDelivery::Request.orders(order_id).upsert(body: {deliveryType: 'PICKUP'})
+```
+
+#### Оформить заказ
+
+```ruby
+YandexDelivery::Request.orders.submit.create(body: {orderIds: [order_id]})
+```
+
+#### Получить данные о заказе
+
+```ruby
+response = YandexDelivery::Request.orders(order_id).retrieve
+order = response.body
+```
+
+#### Удалить заказ
+
+```ruby
+YandexDelivery::Request.orders(order_id).delete
+```
+
+#### Получить ярлык заказа
+
+```ruby
+YandexDelivery::Request.orders(order_id).label.retrieve
+```
+
+#### Поиск заказов
+
+```ruby
+sender_ids = YandexDelivery.senders.map{|sender| sender['id']}
+YandexDelivery::Request.orders.search.upsert(body: {senderIds: sender_ids, orderIds: [order_id]})
+```
+
+#### Получить историю статусов заказа
+
+```ruby
+YandexDelivery::Request.orders(order_id).statuses.retrieve
+```
+
+#### Получить статус заказов
+
+```ruby
+YandexDelivery::Request.orders.status.upsert
+```
+
+### Операции с отгрузками
+
+#### Создать заявку на отгрузку
+
+```ruby
+body = {
+  cabinetId: YandexDelivery.client['id'],
+  shipment: {
+                type: "WITHDRAW",
+                date: "2020-10-05",
+                warehouseFrom: YandexDelivery.warehouses.first['id'],
+                warehouseTo: 123,
+                partnerTo: 678
+              },
+  intervalId: 765478,
+  dimensions: {
+                length: 10,
+                width: 15,
+                height: 40,
+                weight: 5.5
+               },
+  courier: {
+                type: "CAR",
+                firstName: "Василий",
+                middleName: "Иванович",
+                lastName: "Пупкин",
+                phone: "+79998887766",
+                carNumber: "о000оо",
+                carBrand: "Maybach"
+            },
+  comment: "comment"
+}
+response = YandexDelivery::Request.shipments.application.create(body: body)
+shipment_id = response.body['id']
+```
+
+#### Подтвердить отгрузку
+
+```ruby
+body = {
+  cabinetId: YandexDelivery.client['id'],
+  shipmentApplicationIds: [shipment_id]
+}
+YandexDelivery::Request.shipments.application.submit.create(body: body)
+```
+
+#### Получить список отгрузок
+
+```ruby
+body = {
+          cabinetId: YandexDelivery.client['id'],
+          shipmentType: "IMPORT",
+          dateFrom: "2020-10-05",
+          "dateTo": "2020-11-05",
+          "partnerIds": 
+          [
+            239847,
+            98234,
+            54968
+          ]
+       }
+YandexDelivery::Request.shipments.search.upsert(body: body)
+```
+
+#### Получить интервалы самопривозов
+
+```ruby
+warehouse_id = YandexDelivery.warehouses.first['id']
+YandexDelivery::Request.shipments.intervals.import.retrieve(params: {warehouseId: warehouse_id, date: '2020-10-06'})
+```
+
+#### Получить интервалы заборов
+
+```ruby
+YandexDelivery::Request.shipments.intervals.withdraw.retrieve(params: {partnerId: 106, date: '2020-10-06'})
+```
+
+#### Получить акт передачи заказов
+
+```ruby
+YandexDelivery::Request.shipments.applications(shipment_id).act.retrieve(params: {cabinetId: YandexDelivery.client['id']})
+```
+
+### Справочные данные
+
+#### Получить полный адрес
+
+```ruby
+YandexDelivery::Request.location.retrieve(params: {term: 'Санкт-Петербург'})
+```
+
+#### Получить индекс по адресу
+
+```ruby
+response = YandexDelivery::Request.location.postal_code.retrieve(params: {address: 'Санкт-Петербург, ул. Профессора Попова, д. 37Щ, БЦ "Сенатор"'})
+postal_code = response.body.first[:postalCode]
+```
+
+#### Получить список служб доставки
+
+```ruby
+YandexDelivery::Request.delivery_services.retrieve(params: {cabinetId: YandexDelivery.client['id']})
+```

data/lib/generators/yandex_delivery/install/templates/yandex_delivery.rb

@@ -1,10 +1,11 @@
 require 'yandex_delivery'
 
 YandexDelivery.setup do |config|
-  if File.exist?('config/yandex_delivery.yml')
+  if File.exist?('config/yandex_delivery2.yml')
     template = ERB.new(File.new('config/yandex_delivery2.yml').read)
     processed = YAML.safe_load(template.result(binding))
 
+    config::Request.app_id = processed['YANDEX_DELIVERY_APP_ID']
     config::Request.api_key = processed['YANDEX_DELIVERY_ACCESS_TOKEN']
     config::Request.timeout = 15
     config::Request.open_timeout = 15

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

@@ -1,3 +1,4 @@
+YANDEX_DELIVERY_APP_ID: ''
 YANDEX_DELIVERY_ACCESS_TOKEN: ''
 
 YANDEX_DELIVERY: {

data/lib/yandex-delivery/api_request.rb

@@ -81,6 +81,10 @@ module YandexDelivery
       @request_builder.api_key
     end
 
+    def app_id
+      @request_builder.app_id
+    end
+
     def api_endpoint
       @request_builder.api_endpoint
     end
@@ -140,12 +144,11 @@ module YandexDelivery
       if request
         request.params.merge!(params) if params
         request.headers['Content-Type'] = 'application/json'
-        request.headers['Authorization'] = "OAuth #{self.api_key}"
+        request.headers['Authorization'] = "OAuth oauth_token=\"#{self.api_key}\", oauth_client_id=\"#{self.app_id}\""
         request.headers.merge!(headers) if headers
         request.body = body if body
         request.options.timeout = self.timeout
         request.options.open_timeout = self.open_timeout
-        p request
       end
     end
 
@@ -179,10 +182,12 @@ module YandexDelivery
     end
 
     def validate_api_key
-      api_key = self.api_key
-      unless api_key && (api_key["-"] || self.api_endpoint)
+      unless self.api_key
         raise YandexDelivery::YandexDeliveryError, "You must set an api_key prior to making a call"
       end
+      unless self.app_id
+        raise YandexDelivery::YandexDeliveryError, "You must set an app_id prior to making a call"
+      end
     end
 
     def api_url

data/lib/yandex-delivery/request.rb

@@ -1,14 +1,16 @@
 module YandexDelivery
   class Request
-    attr_accessor :api_key, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
+    attr_accessor :api_key, :app_id, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
 
     DEFAULT_TIMEOUT = 60
     DEFAULT_OPEN_TIMEOUT = 60
 
-    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil)
+    def initialize(api_key: nil, app_id: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil)
       @path_parts = []
       @api_key = api_key || self.class.api_key || ENV['YANDEX_DELIVERY_ACCESS_TOKEN']
       @api_key = @api_key.strip if @api_key
+      @app_id = app_id || self.class.app_id || ENV['YANDEX_DELIVERY_APP_ID']
+      @app_id = @app_id.strip if @app_id
       @api_endpoint = api_endpoint || self.class.api_endpoint
       @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
       @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
@@ -80,10 +82,12 @@ module YandexDelivery
     end
 
     class << self
-      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
+      attr_accessor :api_key, :app_id, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
 
       def method_missing(sym, *args, &block)
-        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
+        new(api_key: self.api_key, app_id: self.app_id, api_endpoint: self.api_endpoint, timeout: self.timeout,
+            open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys,
+            debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
       end
 
       def respond_to_missing?(method_name, include_private = false)

data/lib/yandex-delivery/version.rb

@@ -1,3 +1,3 @@
 module YandexDelivery
-  VERSION = "0.0.2"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: yandex-delivery
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Pavel Osetrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-08-11 00:00:00.000000000 Z
@@ -44,6 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.markdown
 - lib/generators/yandex_delivery/install/USAGE
 - lib/generators/yandex_delivery/install/install_generator.rb
 - lib/generators/yandex_delivery/install/templates/yandex_delivery.rb
@@ -59,7 +61,7 @@ homepage: https://github.com/osetrov/yandex-delivery
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Yandex delivery
 test_files: []