yar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bccc44a614eb9a950752e62a467766e2c133ea6f1f28e69f38f1145b2fa8bc7
+  data.tar.gz: 2b226cc2d442e9aa6c70c13c63d7a6af0005d9e1ff624f026e9a60e29e5f80a6
+SHA512:
+  metadata.gz: f9af341e0634d5fce627367b5a2ef6b009af7ab52e86daa81ffd474abe7eaefedcdf25da1afc27320dd87ebb55472b12cc4511466e1dda90f3594783eec3bfe9
+  data.tar.gz: 5344ebe87f967c3730e0651d88293df63d8b7ed210c45e4fb0809cca74733572cb9eeeb3eb078b5b610a9e8ff55b460183a69e7aa99e2d40db214f691db3360e

data/.gitignore

@@ -0,0 +1,61 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# macOS
+.DS_Store
+dev
+.rspec_status

data/.rspec

@@ -0,0 +1,5 @@
+--tty
+--color
+--format documentation # progress
+--backtrace
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,142 @@
+---
+AllCops:
+  NewCops: disable # TODO: change to enable after refactoring
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength: 
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Style/OptionHash:
+  # A list of parameter names that will be flagged by this cop.
+  SuspiciousParamNames:
+    - options
+    - opts
+    - args
+    - paramsgit sttus
+    - parameters
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense. 
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false 
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false 
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    yar (1.0.0)
+      addressable (~> 2.3, >= 2.3.7)
+      faraday (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-gzip (0.1.0)
+      faraday (>= 1.0)
+      zlib (~> 2.1)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    multipart-post (2.2.3)
+    public_suffix (5.0.0)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.7.0)
+    simplecov_json_formatter (0.1.4)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zlib (2.1.1)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  bundler
+  faraday-gzip (~> 0.1.0)
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.9)
+  simplecov-lcov (~> 0.7.0)
+  vcr (~> 6.1)
+  webmock (~> 3.18, >= 3.18.1)
+  yar!
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ruby API clients
+
+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,45 @@
+# yar
+
+Yandex.Rasp API - API Яндекс.Расписаний  
+docs: <https://yandex.ru/dev/rasp/doc/concepts/about.html>  
+gem: <https://rubygems.org/gems/yar>
+
+## Install
+
+```sh
+gem install yar
+```
+
+## Example
+
+```ruby
+
+require "yar"
+
+client = Yar::Client.new(token: ENV["YAR_ACCESS_TOKEN"])
+
+# Копирайт Яндекс.Расписаний
+client.copyright.info
+
+# Список всех доступных станций
+client.stations.list
+
+# Список станций следования
+client.stations.route(uid:)
+
+# Список ближайших станций
+client.nearest.station(lat:, long:, distance:)
+
+# Ближайший город
+client.nearest.city(lat:, long:)
+
+# Расписание рейсов по станции
+client.schedule.info(station:)
+
+# Расписание рейсов между станциями
+client.schedule.between(from:, to:)
+
+# Информация о перевозчике
+client.carrier.info(code:)
+
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+task :console do
+  exec "irb -I lib -r yar.rb"
+end

data/lib/Yar/client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Yar
+  class Client
+    BASE_URL = "https://api.rasp.yandex.net/v3.0/"
+
+    attr_reader :token, :adapter, :format
+
+    # new client
+    def initialize(token:, adapter: Faraday.default_adapter, stubs: nil, format: "json")
+      @token = token
+      @adapter = adapter
+      @stubs = stubs
+      @format = format
+    end
+
+    def copyright
+      CopyrightResource.new(self)
+    end
+
+    def stations
+      StationsResource.new(self)
+    end
+
+    def carrier
+      CarrierResource.new(self)
+    end
+
+    def nearest
+      NearestResource.new(self)
+    end
+
+    def schedule
+      ScheduleResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, nil, token
+        conn.request :json
+        conn.request :url_encoded
+
+        # conn.params[:format] = @format
+
+        conn.response :json, content_type: "application/json"
+        conn.response :xml, content_type: "application/xml" if @format == "xml"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/Yar/collection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yar
+  class Collection
+    attr_reader :data, :items, :total
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map {|attrs| type.new(attrs) },
+        items: body["items"],
+        total: body["total"]
+      )
+    end
+
+    def initialize(data:, items:, total:)
+      @data   = data
+      @items  = items
+      @total  = total
+    end
+  end
+end

data/lib/Yar/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class Error < StandardError;  end
+end

data/lib/Yar/object.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Yar
+  # TODO: change to Struct
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    # Convert Array or Hash to OpenStruct
+    def to_ostruct(obj)
+      case obj
+      when Hash
+        # obj.to_struct
+        # rubocop:disable Style/HashTransformValues
+        OpenStruct.new(obj.map {|key, val| [key, to_ostruct(val)] }.to_h)
+        # rubocop:enable Style/HashTransformValues
+      when Array
+        obj.map {|o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+
+  # class Hash
+  #   def to_struct
+  #     s = Struct.new(*self.keys.map(&:to_sym))
+  #     construct = map do |k,v|
+  #       v.is_a?(Hash) ? v.to_struct : v.is_a?(Array) ? v.join(", ") : v
+  #     end
+  #     s.new(*construct)
+  #   end
+  # end
+end

data/lib/Yar/objects/carrier.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class Carrier < Object; end
+end

data/lib/Yar/objects/city.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class City < Object; end
+end

data/lib/Yar/objects/copyright.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class Copyright < Object; end
+end

data/lib/Yar/objects/schedule.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class Schedule < Object; end
+end

data/lib/Yar/objects/station.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Yar
+  class Station < Object; end
+end

data/lib/Yar/resource.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Yar
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+    alias delete_request delete
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
+    def handle_response(response)
+      case response.status
+      when 302
+        raise Error, "Redirect found. #{response.body['error']}"
+      when 400
+        raise Error, "Your request was malformed. #{response.body['error']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['error']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['error']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['error']}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body['error']}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body['error']}"
+      when 503
+        raise Error, "You have been rate limited for sending more  requests per second. #{response.body['error']}"
+      end
+
+      response
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/Yar/resources/carrier.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Yar
+  class CarrierResource < Resource
+    def info(code:, system: "yandex")
+      Carrier.new get("carrier/?code=#{code}&system=#{system}").body
+    end
+  end
+end

data/lib/Yar/resources/copyright.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Yar
+  class CopyrightResource < Resource
+    def info
+      Copyright.new get("copyright/").body
+    end
+  end
+end

data/lib/Yar/resources/nearest.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Yar
+  class NearestResource < Resource
+    def stations(lat:, long:, distance:)
+      resp = get("nearest_stations/?lat=#{lat}&lng=#{long}&distance=#{distance}")
+      Collection.from_response(resp, key: "stations", type: Station)
+    end
+
+    def city(lat:, long:)
+      City.new get("nearest_settlement/?lat=#{lat}&lng=#{long}").body
+    end
+  end
+end

data/lib/Yar/resources/schedule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yar
+  class ScheduleResource < Resource
+    # TODO: move to Schedule.info station: -> Schedule
+    def info(station:)
+      Schedule.new get("schedule/?station=#{station}").body
+    end
+
+    # TODO: move to Schedule.between(from: to:) -> Schedule
+    def between(from:, to:)
+      Schedule.new get("search/?from=#{from}&to=#{to}").body
+    end
+  end
+end