yar 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac226a0af6b4c8761daa6f7814417fcf12ff2548604e49ba53d398a9791c62f1
-  data.tar.gz: 7d3b2293ab13f4abcb10f466083b18265f6cecefad12b8cf77dfa17900827538
+  metadata.gz: c1cac2e98c7750bbdcdd306332845964e801cb1f7eff12ff6a8450685921df07
+  data.tar.gz: 6a9e04d28248e37357f7c0c251426dcda1b206bb3b366320ffc230addf8f1367
 SHA512:
-  metadata.gz: 5c47e561f76733d7304f6bc0d37e612abf69f185e1e78923afed4bfd3e9f69b0afc7945175468aa3fe7140b5864cd316fa3f6f1af756ceef88d408b60ff27edb
-  data.tar.gz: 49ae082c99afe2e21e1075124d3018b8b1575a9bf0d279c260e577e540e4e825555ef9c3e56414e258e09def824fb1779120cd9f8ee21fe6e3bbb3e343e8aaaf
+  metadata.gz: 6626d1a76d10ac0b7ac3d4f94bd2f814706eb568478c892aae3921d717588f00108a0cb1ea2af22c7b06f3c7d190e0a73767e7e6ce06cb8ccb25eb92fc34c94d
+  data.tar.gz: ea195e9c03006172bac11c7f664ea7c2c674fe4b2a56d1a2e77a5558b53d6a34fc7154fd82e2fdd024f56c81b87e7c069212645af92e63ccdac36b59b51f8fbc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yar (1.0.1)
+    yar (1.0.2)
       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 = 2
   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 = 2
+  VERSION = "#{major}.#{minor}.#{patch}"
+end

data/spec/client_spec.rb

@@ -14,6 +14,6 @@ RSpec.describe Yar::Client do
   end
 
   describe "VERSION" do
-    it { expect(Yar::VERSION).to eq "1.0.1" }
+    it { expect(Yar::VERSION).to eq "1.0.2" }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ilya Brin
@@ -161,6 +161,22 @@ files:
 - lib/Yar/resources/stations.rb
 - lib/Yar/version.rb
 - lib/yar.rb
+- 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
 - spec/client_spec.rb
 - spec/lib/resources/carrier_spec.rb
 - spec/lib/resources/copyright_spec.rb