yandex-dostavka 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbb5ab099b6984b9856405b5c43a7116d47495b7c88f08bd22d7adf493dc6996
+  data.tar.gz: 42ea3078f2cb52aaa2e7eacf8a47480d7f7cd3f60e85ec5f56cfbc4e885c3a16
+SHA512:
+  metadata.gz: 459ccb9da2c1e49de500eddbf6ae57a4e10c8c8185425f8e82f6f57ebd7b8b3c9d3e65008a163c2b7d7a52ce20fa4ff0ffe0890895cfa1dad80af2af84128a09
+  data.tar.gz: d94127db0ade19647fbf9f0b4b6bd13997dd2f507579d48e5574380a5c45346802a18bb870964c46f498b124e518f5b193464dfdc0d0e8e9e4a2ddad209a904d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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,82 @@
+# Yandex Dostavka API
+
+API wrapper для Yandex Dostavka API
+
+# Оглавление
+0. [Установка](#install)
+    1. [Использование Rails](#using_rails)
+    2. [Использование Ruby](#using_ruby)
+    3. [Debug Logging](#debug_logging)
+    4. [Custom logger](#custom_logger)
+
+# <a name="install"></a> Установка
+
+### Получение OAuth-токена:
+
+1. Войдите в [Кабинет Корпоративного Клиента Яндекс Доставки](https://dostavka.yandex.ru/change/) с помощью выданного вам логина и пароля.
+Перейдите на вкладку Профиль компании.
+2. В разделе Токен для API нажмите Получить.
+3. На странице https://oauth.yandex.ru нажмите Разрешить.
+4. В Кабинете Корпоративного Клиента Яндекс Доставки на вкладке Профиль компании в разделе Токен для API будет отображен ваш OAuth-токен.
+
+## Ruby
+    $ gem install yandex-dostavka
+## Rails
+добавьте в Gemfile:
+
+    gem 'yandex-dostavka'
+
+и запустите `bundle install`.
+
+Затем:
+
+    rails g yandex_dostavka:install
+
+## <a name="using_rails"></a> Использование Rails
+
+В файл `config/yandex_dostavka.yml` вставьте ваши данные
+
+## <a name="using_ruby"></a> Использование Ruby
+
+Сначала создайте экземпляр объекта `YandexDostavka::Request`:
+
+```ruby
+dostavka = YandexDostavka::Request.new(api_key: "***")
+```
+
+Вы можете изменять `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+
+```ruby
+YandexDostavka::Request.timeout = 15
+YandexDostavka::Request.open_timeout = 15
+YandexDostavka::Request.symbolize_keys = true
+YandexDostavka::Request.debug = false
+
+YandexDostavka::Request.api_key = "your_api_key"
+```
+
+Либо в файле `config/initializers/yandex_dostavka.rb` для Rails.
+
+## <a name="debug_logging"></a> Debug Logging
+
+Измените `debug: true` чтобы включить логирование в STDOUT.
+
+```ruby
+dostavka = YandexDostavka::Request.new(api_key: "***", debug: true)
+```
+
+### <a name="custom_logger"></a> Custom logger
+
+`Logger.new` используется по умолчанию, но вы можете изменить на свой:
+
+```ruby
+dostavka = YandexDostavka::Request.new(api_key: "***", debug: true, logger: MyLogger.new)
+```
+
+Или:
+
+```ruby
+YandexDostavka::Request.logger = MyLogger.new
+```
+
+# <a name="examples"></a> Примеры

data/lib/generators/yandex-dostavka/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+  yandex_dostavka:install

data/lib/generators/yandex-dostavka/install/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module YandexDostavka
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def generate_install
+      copy_file 'yandex_dostavka.yml', 'config/yandex_dostavka.yml'
+      copy_file 'yandex_dostavka.rb', 'config/initializers/yandex_dostavka.rb'
+    end
+  end
+end
+

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

@@ -0,0 +1,18 @@
+require 'yandex-dostavka'
+
+YandexDostavka.setup do |config|
+  if File.exist?('config/yandex_dostavka.yml')
+    processed = YAML.load_file('config/yandex_dostavka.yml')[Rails.env]
+
+    processed.each do |k, v|
+      config::register k.underscore.to_sym, v
+    end
+
+    config::Request.token ||= ENV['YANDEX_DOSTAVKA_TOKEN']
+
+    config::Request.timeout = 60
+    config::Request.open_timeout = 60
+    config::Request.symbolize_keys = true
+    config::Request.debug = false
+  end
+end

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

@@ -0,0 +1,12 @@
+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

data/lib/yandex-dostavka/api_request.rb

@@ -0,0 +1,158 @@
+module YandexDostavka
+  class APIRequest
+
+    def initialize(builder: nil)
+      @request_builder = builder
+    end
+
+    def post(params: nil, headers: nil, suffix: nil, body: {})
+      validate_api_key
+      begin
+        response = self.rest_client(suffix).post do |request|
+          configure_request(request: request, params: params, headers: headers, body: body)
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def get(params: nil, headers: nil, body: {})
+      validate_api_key
+
+      begin
+        response = self.rest_client.get do |request|
+          configure_request(request: request, params: params, headers: headers, body: body)
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    protected
+
+    # Convenience accessors
+
+    def token
+      @request_builder.token
+    end
+
+    def api_endpoint
+      @request_builder.api_endpoint
+    end
+
+    def timeout
+      @request_builder.timeout
+    end
+
+    def open_timeout
+      @request_builder.open_timeout
+    end
+
+    def proxy
+      @request_builder.proxy
+    end
+
+    def ssl_options
+      @request_builder.ssl_options
+    end
+
+    def adapter
+      @request_builder.faraday_adapter
+    end
+
+    def symbolize_keys
+      @request_builder.symbolize_keys
+    end
+
+    # Helpers
+
+    def handle_error(error)
+      error_params = {}
+
+      begin
+        if error.is_a?(Faraday::ClientError) && error.response
+          error_params[:status_code] = error.response[:status]
+          error_params[:raw_body] = error.response[:body]
+
+          parsed_response = MultiJson.load(error.response[:body], symbolize_keys: symbolize_keys)
+
+          if parsed_response
+            error_params[:body] = parsed_response
+
+            title_key = symbolize_keys ? :title : "title"
+            detail_key = symbolize_keys ? :detail : "detail"
+
+            error_params[:title] = parsed_response[title_key] if parsed_response[title_key]
+            error_params[:detail] = parsed_response[detail_key] if parsed_response[detail_key]
+          end
+
+        end
+      rescue MultiJson::ParseError
+      end
+
+      error_to_raise = Error.new(error.message, error_params)
+
+      raise error_to_raise
+    end
+
+    def configure_request(request: nil, params: nil, headers: nil, body: nil)
+      if request
+        request.params.merge!(params) if params
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['Authorization'] = "Bearer #{YandexDostavka::Request.token}"
+        request.headers['User-Agent'] = "YandexDostavka/#{YandexDostavka::VERSION} Ruby gem"
+        request.headers.merge!(headers) if headers
+        request.body = MultiJson.dump(body) if body
+        request.options.timeout = self.timeout
+        request.options.open_timeout = self.open_timeout
+      end
+    end
+
+    def rest_client(suffix=nil)
+      client = Faraday.new("#{self.api_url}#{suffix.present? ? "/#{suffix}": ""}", proxy: self.proxy,
+                           ssl: self.ssl_options) do |faraday|
+        faraday.request :gzip
+        faraday.response :raise_error
+        faraday.adapter adapter
+        if @request_builder.debug
+          faraday.response :logger, @request_builder.logger, bodies: true
+        end
+      end
+      client
+    end
+
+    def parse_response(response)
+      parsed_response = nil
+
+      if response.body && !response.body.empty?
+        begin
+          headers = response.headers
+          body = MultiJson.load(response.body, symbolize_keys: symbolize_keys)
+          parsed_response = Response.new(headers: headers, body: body)
+        rescue MultiJson::ParseError
+          error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
+          error = Error.new("Unparseable response: #{response.body}", error_params)
+          raise error
+        end
+      end
+
+      parsed_response
+    end
+
+    def validate_api_key
+      unless self.token && self.api_endpoint
+        raise YandexDostavka::Error, "You must set an token prior to making a call #{self.token} #{self.api_endpoint}"
+      end
+    end
+
+    def api_url
+      base_api_url + @request_builder.path
+    end
+
+    def base_api_url
+      "#{YandexDostavka.api_endpoint}/api/b2b/platform/"
+    end
+  end
+end

data/lib/yandex-dostavka/error.rb

@@ -0,0 +1,29 @@
+module YandexDostavka
+  class Error < StandardError
+    attr_reader :title, :detail, :body, :raw_body, :status_code
+
+    def initialize(message = "", params = {})
+      @title       = params[:title]
+      @detail      = params[:detail]
+      @body        = params[:body]
+      @raw_body    = params[:raw_body]
+      @status_code = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:title, :detail, :body, :raw_body, :status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end

data/lib/yandex-dostavka/request.rb

@@ -0,0 +1,102 @@
+module YandexDostavka
+  class Request
+    attr_accessor :token, :api_endpoint,
+                  :timeout, :open_timeout, :proxy, :ssl_options, :faraday_adapter, :symbolize_keys, :debug,
+                  :logger, :test
+
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    def initialize(token: nil,
+                   api_endpoint: nil, api_auth_method: nil, timeout: nil, open_timeout: nil, proxy: nil, ssl_options: nil,
+                   faraday_adapter: nil, symbolize_keys: false, debug: false,
+                   logger: nil, test: false)
+
+      @path_parts = []
+      @token = token || self.class.token || ENV['YANDEX_DOSTAVKA_TOKEN']
+      @api_endpoint = api_endpoint || self.class.api_endpoint
+      @api_endpoint = YandexDostavka::api_endpoint if @api_endpoint.nil?
+      @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
+      @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
+      @proxy = proxy || self.class.proxy || ENV['API_PROXY']
+      @ssl_options = ssl_options || self.class.ssl_options || { version: "TLSv1_2" }
+      @faraday_adapter = faraday_adapter || self.class.faraday_adapter || Faraday.default_adapter
+      @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
+      @debug = debug || self.class.debug || false
+      @test = test || self.class.test || false
+      @logger = logger || self.class.logger || ::Logger.new(STDOUT)
+    end
+
+    def method_missing(method, *args)
+      @path_parts << method.to_s.downcase.gsub("_", "-")
+      @path_parts << args if args.length > 0
+      @path_parts.flatten!
+      self
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
+    def send(*args)
+      if args.length == 0
+        method_missing(:send, args)
+      else
+        __send__(*args)
+      end
+    end
+
+    def path
+      @path_parts.join('/')
+    end
+
+    def create(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def update(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def retrieve(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).get(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def delete(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).post(params: params, headers: headers, body: {})
+    ensure
+      reset
+    end
+
+    protected
+
+    def reset
+      @path_parts = []
+    end
+
+    class << self
+      attr_accessor :token,
+                    :timeout, :open_timeout, :api_endpoint, :proxy, :ssl_options, :faraday_adapter, :symbolize_keys,
+                    :debug, :logger, :test
+
+      def method_missing(sym, *args, &block)
+        new(token: self.token,
+            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, ssl_options: self.ssl_options, logger: self.logger,
+            test: self.test).send(sym, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+    end
+  end
+end

data/lib/yandex-dostavka/response.rb

@@ -0,0 +1,10 @@
+module YandexDostavka
+  class Response
+    attr_accessor :body, :headers
+    
+    def initialize(body: {}, headers: {})
+      @body = body
+      @headers = headers
+    end 
+  end
+end

data/lib/yandex-dostavka/version.rb

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

data/lib/yandex-dostavka.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'faraday/gzip'
+require 'multi_json'
+require 'yandex-dostavka/version'
+require 'yandex-dostavka/error'
+require 'yandex-dostavka/request'
+require 'yandex-dostavka/api_request'
+require 'yandex-dostavka/response'
+
+module YandexDostavka
+  class << self
+    def setup
+      yield self
+    end
+
+    def register(name, value, type = nil)
+      cattr_accessor "#{name}_setting".to_sym
+
+      add_reader(name)
+      add_writer(name, type)
+      send "#{name}=", value
+    end
+
+    def add_reader(name)
+      define_singleton_method(name) do |*args|
+        send("#{name}_setting").value(*args)
+      end
+    end
+
+    def add_writer(name, type)
+      define_singleton_method("#{name}=") do |value|
+        send("#{name}_setting=", DynamicSetting.build(value, type))
+      end
+    end
+  end
+
+  class DynamicSetting
+    def self.build(setting, type)
+      (type ? klass(type) : self).new(setting)
+    end
+
+    def self.klass(type)
+      klass = "#{type.to_s.camelcase}Setting"
+      raise ArgumentError, "Unknown type: #{type}" unless YandexDostavka.const_defined?(klass)
+      YandexDostavka.const_get(klass)
+    end
+
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def value(*_args)
+      @setting
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: yandex-dostavka
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Osetrov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-gzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: ''
+email: pavel.osetrov@me.com
+executables: []
+extensions: []
+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/yandex-dostavka.rb
+- lib/yandex-dostavka/api_request.rb
+- lib/yandex-dostavka/error.rb
+- lib/yandex-dostavka/request.rb
+- lib/yandex-dostavka/response.rb
+- lib/yandex-dostavka/version.rb
+homepage: https://github.com/osetrov/yandex-dostavka
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: YandexDostavka API
+test_files: []