cdek_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59e95212ed17015e114c28f4fd91691991f0f679827194410fdf8b9cc348952c
+  data.tar.gz: 4547c0e0b9ae640f752992b2928804eca7dc20aaea359a0f6a31addc3bc9c86f
+SHA512:
+  metadata.gz: a306eb3956070db989b66acf817295fd85155031e22425e5fd53f8538c016e32a68bd8b0d52e79ee0b6ea4e7076bdab1ac69cbb9651369248cd244836443de4b
+  data.tar.gz: 54a79eea3eb1bfcd23991a78fab76ec54828c67f49bc361140922294e29fd3af76ece81cd6fc4c9dd849d38ebf7ca5352a9f7454622efb9d29331829e7979caa

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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,77 @@
+# СДЭК АПИ
+
+API wrapper для СДЭК [API](https://api-docs.cdek.ru/29923741.html).
+
+## Установка Ruby
+
+    $ gem install cdek_api
+
+## Установка Rails
+
+добавьте в Gemfile:
+
+    gem 'cdek_api'
+
+и запустите `bundle install`.
+
+Затем:
+
+    rails g cdek_api:install
+
+## Требования
+
+Необходимо запросить CLIENT_ID и CLIENT_SECRET для production
+
+## Использование Rails
+
+В файл `config/cdek_api.yml` вставьте ваши данные
+
+## Использование Ruby
+
+Сначала cгенерируйте access_token
+Затем создайте экземпляр объекта `CdekApi::Request`:
+
+```ruby
+access_token = CdekApi.generate_access_token('EMscd6r9JnFiQ3bLoyjJY6eM78JrJceI', 'PjLZkKBHEiLK3YsjtNrt3TGNG0ahs3kG', 'client_credentials')
+delivery = CdekApi::Request.new(access_token: access_token)
+```
+
+Вы можете изменять `access_token`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+
+```ruby
+CdekApi::Request.access_token = "your_access_token"
+CdekApi::Request.timeout = 15
+CdekApi::Request.open_timeout = 15
+CdekApi::Request.symbolize_keys = true
+CdekApi::Request.debug = false
+```
+
+Либо в файле `config/initializers/cdek_api.rb` для Rails.
+
+## Debug Logging
+
+Pass `debug: true` to enable debug logging to STDOUT.
+
+```ruby
+delivery = CdekApi::Request.new(access_token: "your_access_token", debug: true)
+```
+
+### Custom logger
+
+Ruby `Logger.new` is used by default, but it can be overrided using:
+
+```ruby
+delivery = CdekApi::Request.new(access_token: "your_access_token", debug: true, logger: MyLogger.new)
+```
+
+Logger can be also set by globally:
+
+```ruby
+CdekApi::Request.logger = MyLogger.new
+```
+
+## Примеры
+
+```ruby
+  CdekApi::Request.location.regions.retrieve.body
+```

data/lib/cdek_api/api_request.rb

@@ -0,0 +1,218 @@
+module CdekApi
+  class APIRequest
+
+    def initialize(builder: nil)
+      @request_builder = builder
+    end
+
+    def post(params: nil, headers: nil, body: {}, first_time: true)
+      validate_access_token
+
+      begin
+        response = self.rest_client.post do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue StandardError => e
+        if e.response.try(:dig, :status) == 401 && first_time
+          CdekApi::Request.access_token = CdekApi.generate_access_token.try(:dig, "access_token")
+          self.post(params: params, headers: headers, body: body, first_time: false)
+        else
+          handle_error(e)
+        end
+      end
+    end
+
+    def patch(params: nil, headers: nil, body: {}, first_time: true)
+      validate_access_token
+
+      begin
+        response = self.rest_client.patch do |request|
+          body[:senderId] = CdekApi.senders.first["id"] if body[:senderId].nil?
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue StandardError => e
+        if e.response.dig(:status) == 401 && first_time
+          CdekApi::Request.access_token = CdekApi.generate_access_token.try(:dig, "access_token")
+          self.patch(params: params, headers: headers, body: body, first_time: false)
+        else
+          handle_error(e)
+        end
+      end
+    end
+
+    def put(params: nil, headers: nil, body: {}, first_time: true)
+      validate_access_token
+
+      begin
+        response = self.rest_client.put do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue StandardError => e
+        if e.response.dig(:status) == 401 && first_time
+          CdekApi::Request.access_token = CdekApi.generate_access_token.try(:dig, "access_token")
+          self.put(params: params, headers: headers, body: body, first_time: false)
+        else
+          handle_error(e)
+        end
+      end
+    end
+
+    def get(params: nil, headers: nil, first_time: true)
+      validate_access_token
+
+      begin
+        response = self.rest_client.get do |request|
+          configure_request(request: request, params: params, headers: headers)
+        end
+        parse_response(response)
+      rescue StandardError => e
+        if e.response.dig(:status) == 401 && first_time
+          CdekApi::Request.access_token = CdekApi.generate_access_token.try(:dig, "access_token")
+          self.get(params: params, headers: headers, first_time: false)
+        else
+          handle_error(e)
+        end
+      end
+    end
+
+    def delete(params: nil, headers: nil, first_time: true)
+      validate_access_token
+
+      begin
+        response = self.rest_client.delete do |request|
+          configure_request(request: request, params: params, headers: headers)
+        end
+        parse_response(response)
+      rescue StandardError => e
+        if e.response.dig(:status) == 401 && first_time
+          CdekApi::Request.access_token = CdekApi.generate_access_token.try(:dig, "access_token")
+          self.delete(params: params, headers: headers, first_time: false)
+        else
+          handle_error(e)
+        end
+      end
+    end
+
+    protected
+
+    # Convenience accessors
+
+    def access_token
+      @request_builder.access_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 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 #{CdekApi::Request.access_token}"
+        request.headers['User-Agent'] = "CdekApi/#{CdekApi::VERSION} Ruby gem"
+        request.headers.merge!(headers) if headers
+        request.body = body if body
+        request.options.timeout = self.timeout
+        request.options.open_timeout = self.open_timeout
+      end
+    end
+
+    def rest_client
+      client = Faraday.new(self.api_url, proxy: self.proxy, ssl: { version: "TLSv1_2" }) do |faraday|
+        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_access_token
+      unless self.access_token
+        raise CdekApi::Error, "You must set an access_token prior to making a call"
+      end
+    end
+
+    def api_url
+      base_api_url + @request_builder.path
+    end
+
+    def base_api_url
+      "#{CdekApi.host}/v2/"
+    end
+  end
+end

data/lib/cdek_api/error.rb

@@ -0,0 +1,29 @@
+module CdekApi
+  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/cdek_api/request.rb

@@ -0,0 +1,94 @@
+module CdekApi
+  class Request
+    attr_accessor :access_token, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger, :test
+
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    def initialize(access_token: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false)
+      @path_parts = []
+      @access_token = access_token || self.class.access_token || CdekApi.generate_access_token.try(:dig, "access_token")
+      @access_token = @access_token.strip if @access_token
+      @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
+      @proxy = proxy || self.class.proxy || ENV['CDEK_PROXY']
+      @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
+      @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).patch(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def upsert(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).put(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def retrieve(params: nil, headers: nil)
+      APIRequest.new(builder: self).get(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    def delete(params: nil, headers: nil)
+      APIRequest.new(builder: self).delete(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    protected
+
+    def reset
+      @path_parts = []
+    end
+
+    class << self
+      attr_accessor :access_token, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger, :test
+
+      def method_missing(sym, *args, &block)
+        new(access_token: self.access_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, 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/cdek_api/response.rb

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

data/lib/cdek_api/version.rb

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

data/lib/cdek_api.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'multi_json'
+require 'cdek_api/error'
+require 'cdek_api/request'
+require 'cdek_api/api_request'
+require 'cdek_api/response'
+require 'cdek_api/version'
+
+module CdekApi
+  class << self
+    def generate_access_token(client_id=CdekApi.client_id, client_secret=CdekApi.client_secret, grant_type=CdekApi.grant_type)
+      response = Faraday.post(CdekApi.url_token, "grant_type=#{grant_type}&client_id=#{client_id}&client_secret=#{client_secret}")
+      JSON.parse(response.body)
+    end
+
+    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 CdekApi.const_defined?(klass)
+      CdekApi.const_get(klass)
+    end
+
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def value(*_args)
+      @setting
+    end
+  end
+end

data/lib/generators/cdek_api/install/USAGE

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

data/lib/generators/cdek_api/install/install_generator.rb

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

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

@@ -0,0 +1,17 @@
+require 'cdek_api'
+
+CdekApi.setup do |config|
+  if File.exist?('config/cdek_api.yml')
+    processed = YAML.load_file('config/cdek_api.yml')[Rails.env]
+
+    processed.each do |k, v|
+      config::register k.underscore.to_sym, v
+    end
+
+    config::Request.access_token = ENV['CDEK_ACCESS_TOKEN'] || CdekApi.generate_access_token.try(:dig, "access_token")
+    config::Request.timeout = 15
+    config::Request.open_timeout = 15
+    config::Request.symbolize_keys = true
+    config::Request.debug = false
+  end
+end

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

@@ -0,0 +1,16 @@
+defaults: &defaults
+  GRANT_TYPE: 'client_credentials'
+  CLIENT_ID: 'EMscd6r9JnFiQ3bLoyjJY6eM78JrJceI'
+  CLIENT_SECRET: 'PjLZkKBHEiLK3YsjtNrt3TGNG0ahs3kG'
+  URL_TOKEN: 'https://api.edu.cdek.ru/v2/oauth/token?parameters'
+  HOST: 'https://api.edu.cdek.ru'
+production:
+  <<: *defaults
+  URL_TOKEN: 'https://api.cdek.ru/v2/oauth/token?parameters'
+  HOST: 'https://api.cdek.ru'
+  CLIENT_ID: ''
+  CLIENT_SECRET: ''
+development:
+  <<: *defaults
+test:
+  <<: *defaults

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: cdek_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Osetrov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.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
+description: ''
+email: pavel.osetrov@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- lib/cdek_api.rb
+- lib/cdek_api/api_request.rb
+- lib/cdek_api/error.rb
+- lib/cdek_api/request.rb
+- lib/cdek_api/response.rb
+- lib/cdek_api/version.rb
+- lib/generators/cdek_api/install/USAGE
+- lib/generators/cdek_api/install/install_generator.rb
+- lib/generators/cdek_api/install/templates/cdek_api.rb
+- lib/generators/cdek_api/install/templates/cdek_api.yml
+homepage: https://github.com/osetrov/cdek_api
+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: CDEK API
+test_files: []