dadatas 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd127fc088248df5ba04bc959eb2e42f733283988d3c65ffe9fb4af549cacda
-  data.tar.gz: 4b0a24497dddbf09962bdb404c6303ed89adf541c5e350ace1763833c5a65f43
+  metadata.gz: 16ae5296d65bbeb306942498533a7657e3aacc8e2baeb50b86f0758aac4ba572
+  data.tar.gz: a58ea80c9f9c01226911dc83a0edc7d956eab8442c5f34b52ea274b77e86ec6e
 SHA512:
-  metadata.gz: 617b18a29b63c53667f46c702eea55041f16269dcdecf4e0aca4bff209e5459bc366b94b2ca2f065efa275d3c5cd9737186d8ffe04ddecf68b19e58458167fb0
-  data.tar.gz: 8011273da255784265da566577e7204996493e675fc2c55ff822964c6a63e666b7f1cd080bf99ff932ae63372c7a140279628a790ec02eb2e09bcd679913521e
+  metadata.gz: c4733e251a5b71b7f2b1977bea5713bce2ec94b2f22ccc4c8f0c7ef425d59bc04918da59e16680b913eda9df755044a7f793b1199f3204a3663db267cb7affd3
+  data.tar.gz: acd248fb765cdf03cc121543bc040b2b17cf5add8d8705a40abb353ca71468f4f9c2dad5fd771e94b54343f649e6b13a824f6f75a086388ff9ecc52d4f4b886c

data/.rubocop.yml

@@ -12,6 +12,10 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 110
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
 Metrics/MethodLength:
   Max: 20
 Metrics/AbcSize:

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 0.2.0 - 2026-10-30
+
+* `Suggestion#proxy` returns the DaData document unchanged for a server-side browser proxy.
+* Paths are limited to suggest/findById and address, party, bank, country. The host stays on suggestions.dadata.ru.
+* Requests time out and do not follow redirects. The token is not written to a logger, and it is removed from error bodies.
+* Faraday dependency is `>= 0.17, < 2`, so the gem loads next to Faraday 0.x.
+* Runtime no longer loads byebug.
+
+## 0.1.7 - 2022-09-28
+
+* Add geo method suggestion address
 
 ## 0.1.6 - 2022-06-18
 

data/Gemfile

@@ -4,6 +4,6 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'faraday', '~> 1.8.0'
+gem 'faraday', '>= 0.17', '< 2'
 
 gemspec

data/README.md

@@ -131,6 +131,19 @@ dadata.country(query: "Россия")
 => [true, [{:value=>"Россия", :unrestricted_value=>"Российская Федерация", :data=>{:code=>"643", :alfa2=>"RU", :alfa3=>"RUS", :name_short=>"Россия", :name=>"Российская Федерация", :req_value=>"Россия"}}]]
 ```
 
+## Прокси для браузера
+
+`proxy` нужен, когда токен остаётся на сервере, а виджету нужен исходный документ DaData (`suggestions`), без `req_value` и без признака `[true, ...]`.
+
+Путь берётся только из белого списка. Редирект не следует. В лог заголовки не пишутся.
+
+```ruby
+dadata = Dadatas::Suggestion.new(api_key: 'YOURKEY')
+ok, body = dadata.proxy('suggest', 'address', 'query' => 'москва', 'count' => 5)
+# ok => true
+# body => { "suggestions" => [{ "value" => "г Москва", ... }] }
+```
+
 ## Использование Clean
 
 ```ruby

data/lib/dadatas/api_call.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'faraday'
+require 'dadatas/transport'
 
 module Dadatas
   # Call API DADATA
@@ -16,10 +16,10 @@ module Dadatas
 
     def call
       response = perform_request(url, params)
+      return unavailable unless response.respond_to?(:status)
+      return response_handler(response) if response.status == 200
 
-      return response_handler(response) if response.status.eql?(200)
-
-      error_response(response, response.body)
+      error_response(response, redact(response.body))
     end
 
     def response_handler(response)
@@ -31,7 +31,7 @@ module Dadatas
 
       return special_success(response_body[:location]) if location_condition?(response_body)
 
-      error_response(response, response_body)
+      error_response(response, redact(response.body))
     end
 
     def location_condition?(response_body)
@@ -55,19 +55,24 @@ module Dadatas
       [response.any?, response]
     end
 
-    def header
-      {
-        'Content-Type' => 'application/json',
-        'Accept' => 'application/json',
-        'Authorization' => "Token #{@config[:api_key]}",
-        'X-Secret' => @config[:secret_key].to_s
-      }
+    private
+
+    def perform_request(request_url, request_params)
+      transport = Transport.new(api_key: config[:api_key], secret_key: config[:secret_key])
+      transport.post(request_url, request_params)
     end
 
-    def perform_request(url, params)
-      Faraday.post(url, params.to_json, header)
-    rescue StandardError => e
-      e
+    def unavailable
+      [false, { code: nil, message: 'request failed' }]
+    end
+
+    def redact(text)
+      value = text.to_s
+      [config[:api_key], config[:secret_key]].each do |secret|
+        secret = secret.to_s
+        value = value.gsub(secret, '') if secret.length >= 16
+      end
+      value
     end
   end
 end

data/lib/dadatas/suggestion.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'dadatas/api_call'
-require 'byebug'
+require 'dadatas/transport'
 
 module Dadatas
   # Suggestion API
@@ -14,7 +14,13 @@ module Dadatas
       bank: 'findById/bank',
       organization: 'suggest/party',
       address_by_str: 'suggest/address',
-      country: 'suggest/country'
+      country: 'suggest/country',
+      address_by_geo: 'geolocate/address'
+    }.freeze
+
+    PROXY_PATHS = {
+      'suggest' => %w[address party bank country].freeze,
+      'findById' => %w[address party bank].freeze
     }.freeze
 
     attr_reader :config
@@ -25,7 +31,7 @@ module Dadatas
 
     TYPES.each_key do |type|
       define_method(type) do |args = nil|
-        call_method(Dadatas::Suggestion::TYPES[type], **args)
+        call_method(Dadatas::Suggestion::TYPES[type], **(args || {}))
       end
     end
 
@@ -33,6 +39,18 @@ module Dadatas
       call_method('findById/address', query: fias_id)
     end
 
+    # Browser proxy. Returns the DaData document unchanged: [true, { "suggestions" => [...] }].
+    # kind and type are a whitelist, so the host cannot be replaced by the caller.
+    def proxy(kind, type, payload = {})
+      path = proxy_path(kind, type)
+      return proxy_failure unless path
+      return proxy_failure unless payload.is_a?(Hash)
+
+      proxy_body(transport.post(URI.join(BASE_URL, path), payload))
+    rescue JSON::ParserError
+      proxy_failure
+    end
+
     private
 
     def call_method(method, **query_data)
@@ -42,5 +60,29 @@ module Dadatas
         query_data
       ).call
     end
+
+    def proxy_path(kind, type)
+      kind = kind.to_s
+      type = type.to_s
+      return unless PROXY_PATHS[kind]&.include?(type)
+
+      "#{kind}/#{type}"
+    end
+
+    def proxy_body(response)
+      return proxy_failure unless response.respond_to?(:status)
+      return proxy_failure(response.status) unless response.status == 200
+
+      parsed = JSON.parse(response.body)
+      parsed.is_a?(Hash) ? [true, parsed] : proxy_failure(response.status)
+    end
+
+    def transport
+      Transport.new(api_key: config[:api_key], secret_key: config[:secret_key])
+    end
+
+    def proxy_failure(code = nil)
+      [false, { code: code }]
+    end
   end
 end

data/lib/dadatas/transport.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+
+module Dadatas
+  # HTTP call to a fixed DaData URL. Redirects are not followed.
+  # Faraday's response logger is not attached, so the token is not written.
+  class Transport
+    TIMEOUT = 5
+    OPEN_TIMEOUT = 3
+
+    def initialize(api_key:, secret_key: nil)
+      @api_key = api_key.to_s
+      @secret_key = secret_key
+    end
+
+    def post(url, params)
+      connection.post(url) do |request|
+        request.options.timeout = TIMEOUT
+        request.options.open_timeout = OPEN_TIMEOUT
+        request.headers.update(headers)
+        request.body = params.is_a?(String) ? params : JSON.generate(params)
+      end
+    rescue Faraday::TimeoutError, Faraday::ConnectionFailed, Net::OpenTimeout, Net::ReadTimeout
+      nil
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def headers
+      result = {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'Authorization' => "Token #{@api_key}"
+      }
+      result['X-Secret'] = @secret_key.to_s unless @secret_key.nil?
+      result
+    end
+  end
+end

data/lib/dadatas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dadatas
-  VERSION = '0.1.6'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: dadatas
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hitchens
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +139,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.14'
-description:
 email:
 - m.seleznev@sendit.ru
 executables: []
@@ -152,11 +156,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- dadatas.gemspec
 - lib/dadatas.rb
 - lib/dadatas/api_call.rb
 - lib/dadatas/clean.rb
 - lib/dadatas/suggestion.rb
+- lib/dadatas/transport.rb
 - lib/dadatas/version.rb
 - sig/dadatas.rbs
 homepage: https://github.com/sendit-ru/dadatas
@@ -166,7 +170,6 @@ metadata:
   homepage_uri: https://github.com/sendit-ru/dadatas
   source_code_uri: https://github.com/sendit-ru/dadatas
   changelog_uri: https://github.com/sendit-ru/dadatas/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Dadata.ru API integration
 test_files: []

data/dadatas.gemspec

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/dadatas/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'dadatas'
-  spec.version = Dadatas::VERSION
-  spec.authors = ['Michael Hitchens']
-  spec.email = ['m.seleznev@sendit.ru']
-
-  spec.summary = 'Dadata.ru API integration'
-  spec.homepage = 'https://github.com/sendit-ru/dadatas'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.metadata = {
-    'homepage_uri' => spec.homepage,
-    'source_code_uri' => spec.homepage,
-    'changelog_uri' => 'https://github.com/sendit-ru/dadatas/blob/master/CHANGELOG.md'
-  }
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Requires Ruby faraday to http request
-  spec.add_dependency 'faraday', '~> 1.8.0'
-
-  spec.add_development_dependency 'bundler', '>= 2.2.33', '< 3.0'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'faker', '~> 2.19.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '>= 1.17', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.21'
-  spec.add_development_dependency 'webmock', '~> 3.14'
-end