dadatas 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0422db824d58176c9804c59fd32a1e37f83d2127f7db1613e121c0566eb95d
-  data.tar.gz: c1a7195688b6b1b20be07dade613c0b6a980b2538913e6835235315cbf2c1df1
+  metadata.gz: bfd127fc088248df5ba04bc959eb2e42f733283988d3c65ffe9fb4af549cacda
+  data.tar.gz: 4b0a24497dddbf09962bdb404c6303ed89adf541c5e350ace1763833c5a65f43
 SHA512:
-  metadata.gz: 670647ab62e12f1f51e39aed1d222623e68f122eed6ecddf13deda0ce682bc89914937017f2c11af5c94658fe7def97a1328b8caaaf300a71d18cb33ea642192
-  data.tar.gz: 245131fe5b87c785b53b1f39396e65881961e87d6566c39b7e54079a02e55a91de0cc83d22e5ec2c910b4602c9881c8f8351eddf49b50719f877b6d61b116980
+  metadata.gz: 617b18a29b63c53667f46c702eea55041f16269dcdecf4e0aca4bff209e5459bc366b94b2ca2f065efa275d3c5cd9737186d8ffe04ddecf68b19e58458167fb0
+  data.tar.gz: 8011273da255784265da566577e7204996493e675fc2c55ff822964c6a63e666b7f1cd080bf99ff932ae63372c7a140279628a790ec02eb2e09bcd679913521e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+
+## 0.1.6 - 2022-06-18
+
+* Refactoring Dadatas::Suggestion
+
 ## 0.1.5 - 2022-06-08
 
 * change method  address_by_str in Dadatas::Suggestion now method can pass many arguments. 

data/README.md

@@ -1,6 +1,5 @@
 # Dadata
 
-[![Ruby](https://github.com/sendit-ru/dadatas/actions/workflows/main.yml/badge.svg)](https://github.com/sendit-ru/dadatas/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/dadatas.svg)](https://badge.fury.io/rb/dadatas)
 
 [Dadata.ru](https://dadata.ru/) API интеграционная обертка для проектов ruby
@@ -21,13 +20,59 @@ gem 'dadatas'
 
     $ gem install dadata
 
-## Использование Suggestion
+# Использование подсказок (Suggestion)
+Добавьте в ваш код инициализацию класса с параметрами (ключи API dadata)
 
 ```ruby
 require 'dadatas'
 
-dadata = Dadatas::Suggestion.new(api_key: 'YOURKEY',  secret_key: 'YOURSECRETKEY')
+dadata = Dadatas::Suggestion.new(api_key: 'YOURKEY', secret_key: 'YOURSECRETKEY')
 ```
+
+## Получение подсказок по адресам
+> Официальная документация: [Dadata.ru](https://dadata.ru/api/suggest/address/)
+
+Базовый запрос: 
+```ruby
+dadata.address(query: "москва сухонская 11")
+# => [true, [{:value=>"г Москва, ул Сухонская, д 11, кв 8", ... }]]
+```
+Сложный запрос:
+> Сложный запрос может включать в себя такие параметры как:
+- **query(string)** - Текст запроса
+- **count(integer)** - Количество результатов (максимум — 20)
+- **language(string)** - На каком языке вернуть результат (ru / en)
+- **locations(array)** - Ограничение по родителю (страна, регион, район, город, улица)
+- **locations_geo(array)** - Ограничение по радиусу окружности
+- **locations_boost(array)** - Приоритет города при ранжировании
+- **from_bound(array)** - Гранулярные подсказки по адресу
+- **to_bound(array)** - Гранулярные подсказки по адресу
+
+```ruby
+dadata.address(
+  query: "москва", 
+  from_bound: { value: 'city' }, 
+  to_bound: { value: 'settlement' }, 
+  locations: { country_iso_code: "RU" }
+)
+# => [true, [{:value=>"г Москва", :unrestricted_value=>"101000, г Москва", ... }]]
+
+```
+Сложный поиск позволяет находить только в РФ.
+```ruby
+dadata.address(query: "Гюмри", locations: { country_iso_code: "AM" })
+# => [true, [{:value=>"Армения, Ширакская обл, г Гюмри", ... }]]
+```
+
+### Город по IP 
+```ruby
+dadata.city_by_ip(ip: "46.226.227.20")
+# => [true, {:value=>"г Краснодар", ... }]]
+
+dadata.city_by_ip(ip: "46.226.227.20", language: "en")
+# => [true, {:value=>"Russia, gorod Krasnodar", ... }]]
+```
+
 ### Подсказки по организациям
 
 Получение подсказок по названию:
@@ -70,6 +115,21 @@ dadata.bank_branch(query: '7728168971', kpp: '667102002')
 # => [true, [{:value=>"ФИЛИАЛ \"ЕКАТЕРИНБУРГСКИЙ\" АО \"АЛЬФА-БАНК\"", :unrestricted_value=>"ФИЛИАЛ \"ЕКАТЕРИНБУРГСКИЙ\" АО \"АЛЬФА-БАНК\"", ... }]]
 ```
 
+## Справочник стран мира по стандарту ISO 3166.
+#### параметр `query` может принимать значения:
+- code
+- alfa2
+- alfa3
+- name_short
+- name
+```ruby
+dadata.country(query: "Россия")
+=> [true, [{:value=>"Россия", :unrestricted_value=>"Российская Федерация", :data=>{:code=>"643", :alfa2=>"RU", :alfa3=>"RUS", :name_short=>"Россия", :name=>"Российская Федерация", :req_value=>"Россия"}}]]
+
+)
+dadata.country(query: "Россия")
+=> [true, [{:value=>"Россия", :unrestricted_value=>"Российская Федерация", :data=>{:code=>"643", :alfa2=>"RU", :alfa3=>"RUS", :name_short=>"Россия", :name=>"Российская Федерация", :req_value=>"Россия"}}]]
+```
 
 ## Использование Clean
 

data/lib/dadatas/api_call.rb

@@ -29,9 +29,15 @@ module Dadatas
 
       return success(response_body[:suggestions]) if response_body.key?(:suggestions)
 
+      return special_success(response_body[:location]) if location_condition?(response_body)
+
       error_response(response, response_body)
     end
 
+    def location_condition?(response_body)
+      response_body.key?(:location) && !response_body[:location].nil?
+    end
+
     def error_response(response, response_body)
       [false, { code: response.status, message: response_body }]
     end
@@ -45,6 +51,10 @@ module Dadatas
       [response.any?, new_response]
     end
 
+    def special_success(response)
+      [response.any?, response]
+    end
+
     def header
       {
         'Content-Type' => 'application/json',

data/lib/dadatas/suggestion.rb

@@ -1,38 +1,38 @@
 # frozen_string_literal: true
 
 require 'dadatas/api_call'
+require 'byebug'
 
 module Dadatas
   # Suggestion API
   class Suggestion
     BASE_URL = 'https://suggestions.dadata.ru/suggestions/api/4_1/rs/'
 
+    TYPES = {
+      address: 'suggest/address',
+      city_by_ip: 'iplocate/address',
+      bank: 'findById/bank',
+      organization: 'suggest/party',
+      address_by_str: 'suggest/address',
+      country: 'suggest/country'
+    }.freeze
+
     attr_reader :config
 
     def initialize(config)
       @config = config
     end
 
-    def organization(query: nil)
-      call_method('suggest/party', query: query)
+    TYPES.each_key do |type|
+      define_method(type) do |args = nil|
+        call_method(Dadatas::Suggestion::TYPES[type], **args)
+      end
     end
 
     def address_by_fias_id(fias_id: nil)
       call_method('findById/address', query: fias_id)
     end
 
-    def address_by_str(**params)
-      call_method('suggest/address', **params)
-    end
-
-    def bank(query: nil)
-      call_method('findById/bank', query: query)
-    end
-
-    def bank_branch(query: nil, kpp: nil)
-      call_method('findById/bank', query: query, kpp: kpp)
-    end
-
     private
 
     def call_method(method, **query_data)

data/lib/dadatas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dadatas
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Michael Hitchens
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday