dadata_metro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59de36e8df08734716ef741758e426a06c40a6838e9d6846d2ee48701937ba1f
+  data.tar.gz: 7428e5ded12560a66903941001b383281055875c051fd73770b3e003e97a5e74
+SHA512:
+  metadata.gz: 11ce2222006978468142db3ee7acd5a44d9559e49da1f7154f85d495779becdb614216e39eeeb994828acd564c9c100ecd9cfc2e0d9ce20adb6b7d0fc0ca754a
+  data.tar.gz: 420707af6792dfebacaf8837d8a9603ee4de6bead29f3c7ba24b17b32971d3ee1a129d75c97512e9d6d0256fb09d7d43f81760f4ecdc65c6c733d076906117d1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dadata_metro.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'webmock', '~> 3.13.0'

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    dadata_metro (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dadata_metro!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock (~> 3.13.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 LSK99
+
+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.md

@@ -0,0 +1,33 @@
+# Dadata
+
+Wrapper for the [Dadata.ru](https://dadata.ru/) API: Metro stations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dadata_metro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dadata_metro
+
+## Usage
+
+```ruby
+require 'dadata_metro'
+
+dadata = DadataMetro::Search.new(api_token: 'token')
+dadata.call(query: "Маяк", filters: [ { city_kladr_id: "7800000000000" } ])
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dadata_metro"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dadata_metro.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/dadata_metro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dadata_metro"
+  spec.version       = DadataMetro::VERSION
+  spec.authors       = ["LSK99"]
+  spec.email         = ["lobanova.sk99@gmail.com"]
+
+  spec.summary       = "DaData Metro"
+  spec.description   = "Wrapper for the Dadata API: Metro stations"
+  spec.homepage      = "https://github.com/LSK99/dadata_metro"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/LSK99/dadata_metro"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/dadata_metro/constants.rb

@@ -0,0 +1,9 @@
+module DadataMetro
+  class Constants
+    BASE_URL = 'https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/metro'.freeze
+
+    FILTERS_FIELDS = %i[city_kladr_id city_fias_id city line_id is_closed].freeze
+
+    QUERY_MAX_LENGTH = 300
+  end
+end

data/lib/dadata_metro/search.rb

@@ -0,0 +1,62 @@
+require "dadata_metro/constants"
+require 'json'
+require 'net/http'
+
+module DadataMetro
+  class Search
+
+    attr_reader :api_token
+
+    def initialize(api_token:)
+      @api_token = api_token
+    end
+
+    def call(query:, filters: nil)
+      check_api_token
+      check_query(query)
+      check_filters(filters)
+
+      JSON.parse(request(query, filters))
+    end
+
+    private
+
+    def url
+      URI(Constants::BASE_URL)
+    end
+
+    def request(query, filters)
+      req = Net::HTTP::Post.new(url)
+
+      req['Content-Type'] = 'application/json'
+      req['Accept'] = 'application/json'
+      req['Authorization'] = "Token #{api_token}"
+
+      req.body = { query: query, filters: filters }.to_json
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.request(req).body.force_encoding('UTF-8')
+    end
+
+    def check_query(query)
+      raise ArgumentError, 'query is required' unless query
+      raise ArgumentError, 'query is too long' if query.length > Constants::QUERY_MAX_LENGTH
+    end
+
+    def check_filters(filters)
+      return unless filters
+      raise ArgumentError, 'filters should be array' unless filters.is_a?(Array)
+      filters.each do |field|
+        pp field.keys.first
+        key = field.keys.first
+        next if Constants::FILTERS_FIELDS.include? key
+        raise ArgumentError, "filter field #{key} not supported"
+      end
+    end
+
+    def check_api_token
+      raise ArgumentError, 'api_token is required' unless api_token
+    end
+  end
+end

data/lib/dadata_metro/version.rb

@@ -0,0 +1,3 @@
+module DadataMetro
+  VERSION = "0.1.0"
+end

data/lib/dadata_metro.rb

@@ -0,0 +1,5 @@
+require "dadata_metro/version"
+require "dadata_metro/search"
+
+module DadataMetro
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: dadata_metro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- LSK99
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-13 00:00:00.000000000 Z
+dependencies: []
+description: 'Wrapper for the Dadata API: Metro stations'
+email:
+- lobanova.sk99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dadata_metro.gemspec
+- lib/dadata_metro.rb
+- lib/dadata_metro/constants.rb
+- lib/dadata_metro/search.rb
+- lib/dadata_metro/version.rb
+homepage: https://github.com/LSK99/dadata_metro
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LSK99/dadata_metro
+  source_code_uri: https://github.com/LSK99/dadata_metro
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.7
+signing_key:
+specification_version: 4
+summary: DaData Metro
+test_files: []