dadatas 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b14b94246fd891e914260452eb947e52e5fabd2cf66663deae2fd27d76ae1515
4
+ data.tar.gz: a275bd84fba2fb5e549016c88a4b61930b9f388af08fcee76ece6309518a951a
5
+ SHA512:
6
+ metadata.gz: 8b71cf9f37ed17d8bc11e85a7ac98748743b020c7cba759ec028d612003adcdd17e0252b04eac19444a65dd986de27cf50f3e38eb823a60a1bfd762fa9d97e80
7
+ data.tar.gz: 8569c5a9b53da9f28110f90765be95f4736174f4020b951d5a5817583e10e79df33e5c79e691af60af0f34e3e23b5083e6d130db190d39975d84c2d139fbd2bd
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,18 @@
1
+ AllCops:
2
+ TargetRubyVersion: 2.6
3
+ SuggestExtensions: false
4
+
5
+ Style/StringLiterals:
6
+ Enabled: true
7
+ EnforcedStyle: single_quotes
8
+
9
+ Style/StringLiteralsInInterpolation:
10
+ Enabled: true
11
+ EnforcedStyle: single_quotes
12
+
13
+ Layout/LineLength:
14
+ Max: 110
15
+ Metrics/MethodLength:
16
+ Max: 20
17
+ Metrics/AbcSize:
18
+ Enabled: false
data/.ruby-gemset ADDED
@@ -0,0 +1 @@
1
+ dadata
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-3.0.2
data/CHANGELOG.md ADDED
@@ -0,0 +1,10 @@
1
+ # CHANGELOG
2
+
3
+ ## 0.1.3 - 2021-12-18
4
+
5
+ * fix faraday dependency
6
+
7
+ ## 0.1.0 - 2021-12-15
8
+
9
+ * Added organizations request of Suggestion API.
10
+
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
6
+
7
+ gem 'faraday', '~> 1.8.0'
8
+
9
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 Michael Seleznev
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,93 @@
1
+ # Dadata
2
+
3
+
4
+ # Faker
5
+ [![Ruby](https://github.com/sendit-ru/dadatas/actions/workflows/main.yml/badge.svg)](https://github.com/sendit-ru/dadatas/actions/workflows/main.yml)
6
+ [![Gem Version](https://badge.fury.io/rb/dadatas.svg)](https://badge.fury.io/rb/dadatas)
7
+
8
+ [Dadata.ru](https://dadata.ru/) API интеграционная обертка для проектов ruby
9
+
10
+ ## Установка
11
+
12
+ Добавьте эту строку в Gemfile приложения:
13
+
14
+ ```ruby
15
+ gem 'dadatas'
16
+ ```
17
+
18
+ А затем выполнить:
19
+
20
+ $ bundle
21
+
22
+ Или установите его самостоятельно как:
23
+
24
+ $ gem install dadata
25
+
26
+ ## Использование Suggestion
27
+
28
+ ```ruby
29
+ require 'dadatas'
30
+
31
+ dadata = Dadatas::Suggestion.new(api_key: 'YOURKEY', secret_key: 'YOURSECRETKEY')
32
+ ```
33
+ ### Подсказки по организациям
34
+
35
+ Получение подсказок по названию:
36
+ ```ruby
37
+ dadata.organization(query: 'ООО Рога и копыта')
38
+ # => [true, [{ value: "ПАО БАНК", ... }]]
39
+ ```
40
+ Получение подсказок по ИНН:
41
+ ```ruby
42
+ dadata.organization(query: '7707083893')
43
+ # => [true, [{ value: "ПАО БАНК", ... }]]
44
+ ```
45
+ ### Подсказки по адресу
46
+ Получение подсказок по ФИАС:
47
+ ```ruby
48
+ dadata.address_by_fias_id(fias_id: '203221a4-dde4-4954-99cb-e788df9d0ce8')
49
+ # => [true, [{ value: "г Казань, ул Кремлевская, д 1", ... }]]
50
+ ```
51
+ Получение подсказок по строке:
52
+ ```ruby
53
+ dadata.address_by_str(query: 'Ижевск г, Устиновский район, Им Конструктора Калашникова М.Т. пр-кт, 17')
54
+ # => [true, [{ value: "г Ижевск, пр-кт Им Конструктора Калашникова М.Т., д 17", ... }]]
55
+ ```
56
+ ### Подсказки по банкам
57
+
58
+ Получение подсказок по БИК, SWIFT, ИНН, 'регистрационному номеру, присвоенному Банком России'.
59
+ ```ruby
60
+ dadata.bank(query: '044525225')
61
+ # => [true, [{:value=>"ПАО Сбербанк", :unrestricted_value=>"ПАО Сбербанк", ... }]]
62
+ ```
63
+
64
+ Получение подсказок по ИНН + КПП (для филиалов)
65
+ ```ruby
66
+ dadata.bank_branch(query: '7728168971', kpp: '667102002')
67
+ # => [true, [{:value=>"ФИЛИАЛ \"ЕКАТЕРИНБУРГСКИЙ\" АО \"АЛЬФА-БАНК\"", :unrestricted_value=>"ФИЛИАЛ \"ЕКАТЕРИНБУРГСКИЙ\" АО \"АЛЬФА-БАНК\"", ... }]]
68
+ ```
69
+
70
+
71
+ ## Использование Clean
72
+
73
+ ```ruby
74
+ require 'dadatas'
75
+
76
+ dadata = Dadatas::Clean.new(api_key: 'YOURKEY', secret_key: 'YOURSECRETKEY')
77
+ ```
78
+
79
+ ### Разбор адреса из строки, геокодирование
80
+
81
+ Из строки, геокодирование.
82
+ ```ruby
83
+ dadata.address('москва сухонская 11')
84
+ # => [true, [{:source=>"москва сухонская 11", :result=>"г Москва, ул Сухонская, д 11", ... }]]
85
+ ```
86
+
87
+ ## Вклад в разработку
88
+
89
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sendit-ru/dadatas.
90
+
91
+ ## Лицензия
92
+
93
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require 'rubocop/rake_task'
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'dadatas'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/dadatas.gemspec ADDED
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/dadatas/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'dadatas'
7
+ spec.version = Dadatas::VERSION
8
+ spec.authors = ['Michael Hitchens']
9
+ spec.email = ['m.seleznev@sendit.ru']
10
+
11
+ spec.summary = 'Dadata.ru API integration'
12
+ spec.homepage = 'https://github.com/sendit-ru/dadatas'
13
+ spec.license = 'MIT'
14
+ spec.required_ruby_version = '>= 2.6.0'
15
+
16
+ spec.metadata = {
17
+ 'homepage_uri' => spec.homepage,
18
+ 'source_code_uri' => spec.homepage,
19
+ 'changelog_uri' => 'https://github.com/sendit-ru/dadatas/blob/master/CHANGELOG.md'
20
+ }
21
+
22
+ # Specify which files should be added to the gem when it is released.
23
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
24
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
25
+ `git ls-files -z`.split("\x0").reject do |f|
26
+ (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
27
+ end
28
+ end
29
+ spec.bindir = 'exe'
30
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ['lib']
32
+
33
+ # Requires Ruby faraday to http request
34
+ spec.add_dependency 'faraday', '~> 1.8.0'
35
+
36
+ spec.add_development_dependency 'bundler', '>= 2.2.33', '< 3.0'
37
+ spec.add_development_dependency 'byebug'
38
+ spec.add_development_dependency 'faker', '~> 2.19.0'
39
+ spec.add_development_dependency 'rake', '~> 13.0'
40
+ spec.add_development_dependency 'rspec', '>= 1.17', '~> 3.0'
41
+ spec.add_development_dependency 'rubocop', '~> 1.21'
42
+ spec.add_development_dependency 'webmock', '~> 3.14'
43
+ end
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'json'
4
+ require 'faraday'
5
+
6
+ module Dadatas
7
+ # Call API DADATA
8
+ class ApiCall
9
+ attr_reader :url, :config, :params
10
+
11
+ def initialize(url, config, params)
12
+ @url = url
13
+ @config = config
14
+ @params = params
15
+ end
16
+
17
+ def call
18
+ response = perform_request(url, params)
19
+
20
+ return response_handler(response) if response.status.eql?(200)
21
+
22
+ error_response(response, response.body)
23
+ end
24
+
25
+ def response_handler(response)
26
+ response_body = JSON.parse(response.body, symbolize_names: true)
27
+
28
+ return success(response_body) if response_body.is_a?(Array)
29
+
30
+ return success(response_body[:suggestions]) if response_body.key?(:suggestions)
31
+
32
+ error_response(response, response_body)
33
+ end
34
+
35
+ def error_response(response, response_body)
36
+ [false, { code: response.status, message: response_body }]
37
+ end
38
+
39
+ def success(response)
40
+ [response.any?, response]
41
+ end
42
+
43
+ def header
44
+ {
45
+ 'Content-Type' => 'application/json',
46
+ 'Accept' => 'application/json',
47
+ 'Authorization' => "Token #{@config[:api_key]}",
48
+ 'X-Secret' => @config[:secret_key].to_s
49
+ }
50
+ end
51
+
52
+ def perform_request(url, params)
53
+ Faraday.post(url, params.to_json, header)
54
+ rescue StandardError => e
55
+ e
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'dadatas/api_call'
4
+
5
+ module Dadatas
6
+ # Clean API
7
+ class Clean
8
+ BASE_URL = 'https://cleaner.dadata.ru/api/v1/clean/'
9
+
10
+ attr_reader :config
11
+
12
+ def initialize(config)
13
+ @config = config
14
+ end
15
+
16
+ def address(query)
17
+ call_method('address', query.split(','))
18
+ end
19
+
20
+ private
21
+
22
+ def call_method(method, query_data)
23
+ Dadatas::ApiCall.new(
24
+ URI(URI.join(BASE_URL, method)),
25
+ config,
26
+ query_data
27
+ ).call
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'dadatas/api_call'
4
+
5
+ module Dadatas
6
+ # Suggestion API
7
+ class Suggestion
8
+ BASE_URL = 'https://suggestions.dadata.ru/suggestions/api/4_1/rs/'
9
+
10
+ attr_reader :config
11
+
12
+ def initialize(config)
13
+ @config = config
14
+ end
15
+
16
+ def organization(query: nil)
17
+ call_method('suggest/party', query: query)
18
+ end
19
+
20
+ def address_by_fias_id(fias_id: nil)
21
+ call_method('findById/address', query: fias_id)
22
+ end
23
+
24
+ def address_by_str(query: nil)
25
+ call_method('suggest/address', query: query)
26
+ end
27
+
28
+ def bank(query: nil)
29
+ call_method('findById/bank', query: query)
30
+ end
31
+
32
+ def bank_branch(query: nil, kpp: nil)
33
+ call_method('findById/bank', query: query, kpp: kpp)
34
+ end
35
+
36
+ private
37
+
38
+ def call_method(method, **query_data)
39
+ Dadatas::ApiCall.new(
40
+ URI(URI.join(BASE_URL, method)),
41
+ config,
42
+ query_data
43
+ ).call
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dadatas
4
+ VERSION = '0.1.3'
5
+ end
data/lib/dadatas.rb ADDED
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'dadatas/version'
4
+ require 'dadatas/suggestion'
5
+ require 'dadatas/clean'
6
+ require 'dadatas/api_call'
7
+
8
+ module Dadatas
9
+ class Error < StandardError; end
10
+ # Your code goes here...
11
+ end
data/sig/dadatas.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Dadatas
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,188 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dadatas
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.3
5
+ platform: ruby
6
+ authors:
7
+ - Michael Hitchens
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-12-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 1.8.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 1.8.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 2.2.33
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: '3.0'
37
+ type: :development
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: 2.2.33
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: '3.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: byebug
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: '0'
61
+ - !ruby/object:Gem::Dependency
62
+ name: faker
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: 2.19.0
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: 2.19.0
75
+ - !ruby/object:Gem::Dependency
76
+ name: rake
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '13.0'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '13.0'
89
+ - !ruby/object:Gem::Dependency
90
+ name: rspec
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '1.17'
96
+ - - "~>"
97
+ - !ruby/object:Gem::Version
98
+ version: '3.0'
99
+ type: :development
100
+ prerelease: false
101
+ version_requirements: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: '1.17'
106
+ - - "~>"
107
+ - !ruby/object:Gem::Version
108
+ version: '3.0'
109
+ - !ruby/object:Gem::Dependency
110
+ name: rubocop
111
+ requirement: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - "~>"
114
+ - !ruby/object:Gem::Version
115
+ version: '1.21'
116
+ type: :development
117
+ prerelease: false
118
+ version_requirements: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - "~>"
121
+ - !ruby/object:Gem::Version
122
+ version: '1.21'
123
+ - !ruby/object:Gem::Dependency
124
+ name: webmock
125
+ requirement: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - "~>"
128
+ - !ruby/object:Gem::Version
129
+ version: '3.14'
130
+ type: :development
131
+ prerelease: false
132
+ version_requirements: !ruby/object:Gem::Requirement
133
+ requirements:
134
+ - - "~>"
135
+ - !ruby/object:Gem::Version
136
+ version: '3.14'
137
+ description:
138
+ email:
139
+ - m.seleznev@sendit.ru
140
+ executables: []
141
+ extensions: []
142
+ extra_rdoc_files: []
143
+ files:
144
+ - ".rspec"
145
+ - ".rubocop.yml"
146
+ - ".ruby-gemset"
147
+ - ".ruby-version"
148
+ - CHANGELOG.md
149
+ - Gemfile
150
+ - LICENSE.txt
151
+ - README.md
152
+ - Rakefile
153
+ - bin/console
154
+ - bin/setup
155
+ - dadatas.gemspec
156
+ - lib/dadatas.rb
157
+ - lib/dadatas/api_call.rb
158
+ - lib/dadatas/clean.rb
159
+ - lib/dadatas/suggestion.rb
160
+ - lib/dadatas/version.rb
161
+ - sig/dadatas.rbs
162
+ homepage: https://github.com/sendit-ru/dadatas
163
+ licenses:
164
+ - MIT
165
+ metadata:
166
+ homepage_uri: https://github.com/sendit-ru/dadatas
167
+ source_code_uri: https://github.com/sendit-ru/dadatas
168
+ changelog_uri: https://github.com/sendit-ru/dadatas/blob/master/CHANGELOG.md
169
+ post_install_message:
170
+ rdoc_options: []
171
+ require_paths:
172
+ - lib
173
+ required_ruby_version: !ruby/object:Gem::Requirement
174
+ requirements:
175
+ - - ">="
176
+ - !ruby/object:Gem::Version
177
+ version: 2.6.0
178
+ required_rubygems_version: !ruby/object:Gem::Requirement
179
+ requirements:
180
+ - - ">="
181
+ - !ruby/object:Gem::Version
182
+ version: '0'
183
+ requirements: []
184
+ rubygems_version: 3.2.22
185
+ signing_key:
186
+ specification_version: 4
187
+ summary: Dadata.ru API integration
188
+ test_files: []