yar 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac226a0af6b4c8761daa6f7814417fcf12ff2548604e49ba53d398a9791c62f1
-  data.tar.gz: 7d3b2293ab13f4abcb10f466083b18265f6cecefad12b8cf77dfa17900827538
+  metadata.gz: e6761bb224ba7edb4489779cc8420ca3253109440bbaa99ef41944079a4f0493
+  data.tar.gz: dd7cdb4cc45403c79e7bff546de0b7d75acfc782b7b3a423dcf3c8cdf490c0e1
 SHA512:
-  metadata.gz: 5c47e561f76733d7304f6bc0d37e612abf69f185e1e78923afed4bfd3e9f69b0afc7945175468aa3fe7140b5864cd316fa3f6f1af756ceef88d408b60ff27edb
-  data.tar.gz: 49ae082c99afe2e21e1075124d3018b8b1575a9bf0d279c260e577e540e4e825555ef9c3e56414e258e09def824fb1779120cd9f8ee21fe6e3bbb3e343e8aaaf
+  metadata.gz: 9086b3f810a0a6c36f4da403bdc054d6e2a7b20ce0900b89e49dde7929d18baec03015517f285c15e216d3eaa23d26ef5f757582b9faef688a51671a26ebd90f
+  data.tar.gz: 846528c02d13bc1bf0d32617bdde71f05c762d96558ebec9a149ef3b3729a0868ada0d6f0e93acaeb3cfbc695ac4dd6918fd66f5fea9563d41a484586c4264ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yar (1.0.1)
+    yar (1.0.3)
       faraday (~> 1.7)
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-# yar
+# yar [![Ruby specs](https://github.com/ruby-api-client/yar/actions/workflows/ci.yml/badge.svg)](https://github.com/ruby-api-client/yar/actions/workflows/ci.yml) [![Gem Version](https://badge.fury.io/rb/yar.svg)](https://badge.fury.io/rb/yar) ![GitHub](https://img.shields.io/github/license/ruby-api-client/yar) [![Coverage Status](https://coveralls.io/repos/github/ruby-api-client/yar/badge.svg?branch=main)](https://coveralls.io/github/ruby-api-client/yar?branch=main) ![Gem](https://img.shields.io/gem/dt/yar)
 
 Yandex.Rasp API - API Яндекс.Расписаний  
 docs: <https://yandex.ru/dev/rasp/doc/concepts/about.html>  

data/lib/Yar/version.rb

@@ -3,6 +3,6 @@
 module Yar
   major = 1
   minor = 0
-  patch = 1
+  patch = 3
   VERSION = "#{major}.#{minor}.#{patch}"
 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

data/lib/yar/resources/stations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Yar
+  class StationsResource < Resource
+    # def list
+    #   resp = get("stations_list/")
+    #   Collection.from_response(resp, key: "countries", type: Region)
+    # end
+    def list
+      Object.new get("stations_list/").body
+    end
+
+    # TODO: move to Schedule.info station: -> Schedule
+    def schedule(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

data/lib/yar/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Yar
+  major = 1
+  minor = 0
+  patch = 3
+  VERSION = "#{major}.#{minor}.#{patch}"
+end

data/yar.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.description   = "Yandex.Rasp API wrapper written in Ruby"
   s.authors       = ["Ilya Brin"]
   s.email         = "ilya@codeplay.ru"
-  s.files         = `git ls-files -z`.split("\x0")
+  s.files         = `git ls-files`.split($RS).reject {|fn| fn.start_with? "spec" }
   s.executables   = s.files.grep(%r{^bin/}) {|f| File.basename(f) }
   s.require_paths = ["lib"]
   s.homepage      = "https://github.com/ruby-api-client/yar"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Ilya Brin
@@ -161,21 +161,22 @@ files:
 - lib/Yar/resources/stations.rb
 - lib/Yar/version.rb
 - lib/yar.rb
-- spec/client_spec.rb
-- spec/lib/resources/carrier_spec.rb
-- spec/lib/resources/copyright_spec.rb
-- spec/lib/resources/nearest_spec.rb
-- spec/lib/resources/schedule_spec.rb
-- spec/lib/resources/stations_spec.rb
-- spec/spec_helper.rb
-- spec/vcr/carrier/schedule.yml
-- spec/vcr/copyright/info.yml
-- spec/vcr/nearest/city.yml
-- spec/vcr/nearest/stations.yml
-- spec/vcr/schedule/between.yml
-- spec/vcr/schedule/schedule.yml
-- spec/vcr/stations/between.yml
-- spec/vcr/stations/schedule.yml
+- lib/yar/client.rb
+- lib/yar/collection.rb
+- lib/yar/error.rb
+- lib/yar/object.rb
+- lib/yar/objects/carrier.rb
+- lib/yar/objects/city.rb
+- lib/yar/objects/copyright.rb
+- lib/yar/objects/schedule.rb
+- lib/yar/objects/station.rb
+- lib/yar/resource.rb
+- lib/yar/resources/carrier.rb
+- lib/yar/resources/copyright.rb
+- lib/yar/resources/nearest.rb
+- lib/yar/resources/schedule.rb
+- lib/yar/resources/stations.rb
+- lib/yar/version.rb
 - yar.gemspec
 homepage: https://github.com/ruby-api-client/yar
 licenses:

data/spec/client_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Yar::Client do
-  subject(:client) { described_class.new token: "TOKEN" }
-
-  context "with default format" do
-    it { expect(client).to be_an Yar::Client }
-    it { expect(client.format).to eq "json" }
-  end
-
-  context "with format XML" do
-    subject(:client) { described_class.new token: "TOKEN", format: "xml" }
-    it { expect(client.format).to eq "xml" }
-  end
-
-  describe "VERSION" do
-    it { expect(Yar::VERSION).to eq "1.0.1" }
-  end
-end

data/spec/lib/resources/carrier_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "yar"
-
-RSpec.describe "#carrier" do
-  describe ".info" do
-    subject(:resp) do
-      VCR.use_cassette("carrier/schedule") do
-        @yar.carrier.info code: "TK", system: "iata"
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Carrier }
-  end
-end

data/spec/lib/resources/copyright_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "yar"
-
-RSpec.describe "#copyright" do
-  describe ".info" do
-    subject(:resp) do
-      VCR.use_cassette("copyright/info") do
-        @yar.copyright.info
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Copyright }
-  end
-end

data/spec/lib/resources/nearest_spec.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "yar"
-
-RSpec.describe "#nearest" do
-  let(:lat)  { 55.733970 }
-  let(:long) { 37.586780 }
-
-  describe ".stations" do
-    subject(:resp) do
-      VCR.use_cassette("nearest/stations") do
-        @yar.nearest.stations lat: 55.733970, long: 37.586780, distance: 10
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Collection }
-    it { expect(resp.data.first).to be_an Yar::Station }
-  end
-
-  describe ".city" do
-    subject(:resp) do
-      VCR.use_cassette("nearest/city") do
-        @yar.nearest.city(lat: lat, long: long)
-      end
-    end
-
-    it { expect(resp).to be_an Yar::City }
-  end
-end

data/spec/lib/resources/schedule_spec.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "yar"
-
-RSpec.describe "#schedule" do
-  describe ".info" do
-    subject(:resp) do
-      VCR.use_cassette("schedule/schedule") do
-        @yar.schedule.info station: "s9848585"
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Schedule }
-  end
-
-  describe ".between" do
-    subject(:resp) do
-      VCR.use_cassette("schedule/between") do
-        @yar.schedule.between from: "s9848585", to: "s9848577"
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Schedule }
-  end
-end

data/spec/lib/resources/stations_spec.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "yar"
-
-RSpec.describe "#stations" do
-  describe ".schedule" do
-    subject(:resp) do
-      VCR.use_cassette("stations/schedule") do
-        @yar.stations.schedule station: "s9848585"
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Schedule }
-  end
-
-  describe ".between" do
-    subject(:resp) do
-      VCR.use_cassette("stations/between") do
-        @yar.stations.between from: "s9848585", to: "s9848577"
-      end
-    end
-
-    it { expect(resp).to be_an Yar::Schedule }
-  end
-end

data/spec/spec_helper.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "simplecov"
-require "simplecov-lcov"
-require "webmock/rspec"
-require "vcr"
-
-require "yar"
-
-SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
-SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
-
-SimpleCov.start do
-  add_filter "spec/"
-  add_group "Lib", "lib"
-  minimum_coverage 80.0
-end
-
-ACCESS_TOKEN = ENV["YAR_ACCESS_TOKEN"] || "SECRET_TOKEN"
-
-RSpec.configure do |config|
-  config.before(:each) do
-    @yar = Yar::Client.new(token: ACCESS_TOKEN)
-  end
-
-  config.example_status_persistence_file_path = ".rspec_status"
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-    c.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-end
-
-VCR.configure do |c|
-  c.before_record do |i|
-    i.response.body.force_encoding("UTF-8")
-  end
-
-  c.ignore_localhost = true
-  c.cassette_library_dir = "spec/vcr"
-  c.hook_into :webmock
-
-  c.default_cassette_options = {
-    decode_compressed_response: true,
-    allow_unused_http_interactions: false
-  }
-
-  c.filter_sensitive_data("TOKEN") do |i|
-    i.request["headers"]["Authorization"].first
-  end
-
-  c.configure_rspec_metadata!
-end

data/spec/vcr/carrier/schedule.yml

@@ -1,44 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: https://api.rasp.yandex.net/v3.0/carrier/?code=TK&system=iata
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      User-Agent:
-      - Faraday v1.10.2
-      Authorization:
-      - TOKEN
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Allow:
-      - GET
-      Content-Length:
-      - '311'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Sun, 23 Oct 2022 08:29:12 GMT
-      Vary:
-      - Accept, Accept-Encoding
-      X-Content-Type-Options:
-      - nosniff
-    body:
-      encoding: UTF-8
-      string: '{"carriers":[{"code":5483,"title":"AnadoluJet","codes":{"sirena":null,"iata":"TK","icao":"AJA"},"address":"Bakırköy/
-        İstanbul","url":"http://www.anadolujet.com/","email":"musteri@anadolujet.com","contacts":"","phone":"444
-        25 38","logo":"https://yastat.net/s3/rasp/media/data/company/logo/anadolujet.png","offices":[]},{"code":680,"title":"Turkish
-        Airlines","codes":{"sirena":null,"iata":"TK","icao":"THY"},"address":"Bakırköy/
-        İstanbul","url":"http://www.turkishairlines.com/","email":"","contacts":"","phone":"444
-        08 49","logo":"https://yastat.net/s3/rasp/media/data/company/logo/thy_kopya.jpg","offices":[]}]}'
-  recorded_at: Sun, 23 Oct 2022 08:29:12 GMT
-recorded_with: VCR 6.1.0