moex_iss 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff742bbab0ebea3db2a2a57e0e8b76285f910ae84e27723217334ee5c86f2797
+  data.tar.gz: eb0ee71a6ecb99c00abc9e2eff15eaba516a9345161852250e958d92af396922
+SHA512:
+  metadata.gz: 9044394d7813c40661d5c7bf0ba690ce80972ad20d80425927d5e290aa1419ba68dcb1148592077f827aa97e16d72981948e5e0b5b5240eb27e8c89821a3a9ef
+  data.tar.gz: ef3537013d7b14c0b3ba6afb88a7ba25013833782ac97d56b4224cd2d459225485e1aaf74dfa944704aed6840d16d263da7b99477d683ce37b764c9d1e8b8c2a

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change log
+
+## master

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2023 Vyacheslav Konovalov
+
+MIT License
+
+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,63 @@
+[![Gem Version](https://badge.fury.io/rb/moex_iss.svg)](https://rubygems.org/gems/moex_iss)
+[![Build](https://github.com/K0Hb/moex_iss/workflows/Build/badge.svg)](https://github.com/palkan/moex_iss/actions)
+[![JRuby Build](https://github.com/K0Hb/moex_iss/workflows/JRuby%20Build/badge.svg)](https://github.com/K0Hb/moex_iss/actions)
+
+# Moex Iss
+
+Реализация части запросов к [MOEX Informational & Statistical Server](https://www.moex.com/a2193).
+
+Реализовано несколько функций-запросов информации о торгуемых ценных бумаг, результаты которых напрямую конвертируются в Ruby класс.
+
+Класс ценной бумаги имеет методы для получения наиболее часто использумеых показателей ценной бумаги а так же метод для получения полного ответа полученного от MOEX ISS.
+
+## Установка
+
+```ruby
+# Gemfile
+gem "moex_iss"
+```
+А затем выполнить:
+
+    $ bundle install
+
+Или установите его самостоятельно как:
+
+    $ gem install moex_api
+
+### Поддерживаемые Ruby версии
+
+- Ruby (MRI) >= 2.7.0
+- JRuby >= 9.3.0
+
+## Использование
+
+### Создаем клиент
+
+```ruby
+client = MoexIss.client
+```
+
+### Акции
+
+Для получения одной акций:
+```ruby
+client.stock(:sber) # => MoexIss::Market::Stock
+```
+Для получения всех акций:
+```ruby
+client.stocks # => MoexIss::Market::Stocks
+```
+Получаем класс, по которому можно итерироваться а так же вызывать искомую ценную бумагу по ее `isin`
+```ruby
+stocks.sber
+```
+Экземпляр класса `MoexIss::Market::Stocks` отвечает на методы:
+```ruby
+%i[bid market_price_today market_price secid short_name lat_name board_id board_name isin prev_price prev_date response market_data]
+```
+где `response` содержит полный ответ от MOEX ISS, из которого можно получать доп.параметры
+
+
+## Лицензия
+
+Исходный код распространяется под лицензией [MIT License](http://opensource.org/licenses/MIT).

data/lib/moex_iss/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MoexIss
+  class Client
+    include MoexIss::Request
+    include MoexIss::Hendler
+
+    STOCKS_ENDPOINT = "engines/stock/markets/shares/boards/tqbr/securities"
+    STANDARD_PARAMS = {
+      "iss.json" => "extended",
+      "iss.only" => "securities,marketdata",
+      "iss.meta" => "off"
+    }
+
+    def stocks
+      endpoint = "#{STOCKS_ENDPOINT}.json"
+      params = STANDARD_PARAMS
+
+      raw_response = get(endpoint, params)
+
+      MoexIss::Market::Stocks.new(handle_response(raw_response))
+    end
+
+    def stock(isin)
+      endpoint = "#{STOCKS_ENDPOINT}/#{isin}.json"
+      params = STANDARD_PARAMS
+
+      raw_response = get(endpoint, params)
+
+      MoexIss::Market::Stock.new(handle_response(raw_response))
+    end
+  end
+end

data/lib/moex_iss/connection.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Connection
+    BASE_URL = "https://iss.moex.com/iss"
+
+    module DoNotEncoder
+      def self.encode(params)
+        params.map { |k, v| "#{k}=#{v}" }.join("&")
+      end
+    end
+
+    def connection
+      Faraday.new(options) do |con|
+        con.adapter Faraday.default_adapter
+        con.request :url_encoded
+        con.options.params_encoder = DoNotEncoder
+      end
+    end
+
+    private
+
+    def options
+      headers = {
+        accept: "application/json",
+        content_type: "application/x-www-from-urlencoded",
+        user_agent: "moex_iss gem"
+      }
+
+      {
+        headers: headers,
+        url: BASE_URL
+      }
+    end
+  end
+end
+
+# CURENCY    https://iss.moex.com/iss/statistics/engines/currency/markets/selt/rates.json?iss.meta=off&iss.json=extended&iss.only=wap_rates
+
+# STOCKS ALL https://iss.moex.com/iss/engines/stock/markets/shares/boards/tqbr/securities.json?iss.meta=off&iss.json=extended&iss.only=securities,marketdata&marketdata.columns=BID,OPEN,CLOSEPRICE,LOW,HIGH,LAST,VALUE,MARKETPRICETODAY,MARKETPRICE,TIME&securities.columns=SECID,SHORTNAME,LATNAME,BOARDID,BOARDNAME,ISIN,PREVPRICE
+
+# STOCK ONE  https://iss.moex.com/iss/engines/stock/markets/shares/boards/tqbr/securities/sber.json?iss.meta=off&iss.json=extended&iss.only=securities,marketdata&marketdata.columns=BID,OPEN,CLOSEPRICE,LOW,HIGH,LAST,VALUE,MARKETPRICETODAY,MARKETPRICE,TIME&securities.columns=SECID,SHORTNAME,LATNAME,BOARDID,BOARDNAME,ISIN,PREVPRICE

data/lib/moex_iss/error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MoexIss
+  class Error < StandardError
+    ResponseSchemaError = Class.new(self)
+    ResponseParseError = Class.new(self)
+
+    ClientError = Class.new(self)
+    ServerError = Class.new(self)
+
+    BadRequest = Class.new(ClientError)
+    Unauthorized = Class.new(ClientError)
+    NotAcceptable = Class.new(ClientError)
+    NotFound = Class.new(ClientError)
+    Conflict = Class.new(ClientError)
+    TooManyRequests = Class.new(ClientError)
+    Forbidden = Class.new(ClientError)
+    Locked = Class.new(ClientError)
+    MethodNotAllowed = Class.new(ClientError)
+
+    NotImplemented = Class.new(ServerError)
+    BadGateway = Class.new(ServerError)
+    ServiceUnavailable = Class.new(ServerError)
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => MoexIss::Error::BadRequest,
+      401 => MoexIss::Error::Unauthorized,
+      403 => MoexIss::Error::Forbidden,
+      404 => MoexIss::Error::NotFound,
+      405 => MoexIss::Error::MethodNotAllowed,
+      406 => MoexIss::Error::NotAcceptable,
+      409 => MoexIss::Error::Conflict,
+      423 => MoexIss::Error::Locked,
+      429 => MoexIss::Error::TooManyRequests,
+      500 => MoexIss::Error::ServerError,
+      502 => MoexIss::Error::BadGateway,
+      503 => MoexIss::Error::ServiceUnavailable,
+      504 => MoexIss::Error::GatewayTimeout
+    }.freeze
+  end
+end

data/lib/moex_iss/hendler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Hendler
+    def handle_response(response)
+      return standard_hendler(response) if standard_schema?(response)
+
+      fail MoexIss::Error::ResponseSchemaError, "Неизвестная схема ответа"
+    end
+
+    private
+
+    def standard_schema?(response)
+      response.is_a?(Array) &&
+        response[1]&.keys == %w[securities marketdata] &&
+        response[1]["securities"].is_a?(Array) &&
+        response[1]["marketdata"].is_a?(Array)
+    end
+
+    def standard_hendler(response)
+      response[1]["securities"].map.with_index do |x, i|
+        {"securities" => x, "marketdata" => response[1]["marketdata"][i]}
+      end
+    end
+  end
+end

data/lib/moex_iss/market/stock.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    class Stock
+      METHODS = {
+        "BID" => :bid, "MARKETPRICETODAY" => :market_price_today,
+        "MARKETPRICE" => :market_price, "SECID" => :secid,
+        "SHORTNAME" => :short_name, "LATNAME" => :lat_name,
+        "BOARDID" => :board_id, "BOARDNAME" => :board_name,
+        "ISIN" => :isin, "PREVPRICE" => :prev_price,
+        "PREVDATE" => :prev_date
+      }.freeze
+
+      MARKET_DATA = %w[CLOSEPRICE OPEN LOW HIGH LAST VALUE SYSTIME]
+
+      attr_reader(:response, :market_data, *METHODS.values)
+
+      def initialize(response)
+        @response = response.is_a?(Array) ? response.first : response
+
+        @response["securities"].merge(@response["marketdata"]).each do |key, value|
+          next unless METHODS.has_key?(key)
+
+          instance_variable_set("@#{METHODS[key]}", value)
+        end
+
+        @market_data = @response["marketdata"].slice(*MARKET_DATA)
+      end
+    end
+  end
+end

data/lib/moex_iss/market/stocks.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    class Stocks
+      include Enumerable
+
+      attr_reader :stocks_response
+
+      def initialize(stocks_response)
+        @stocks_response = stocks_response
+        @stocks_map = {}
+
+        create_instances_stock
+      end
+
+      def create_instances_stock
+        @stocks_response.each do |stock_response|
+          sicid = stock_response["securities"]["SECID"].downcase.to_sym
+
+          @stocks_map[sicid] = Stock.new(stock_response)
+
+          self.class.send(:define_method, sicid) { @stocks_map[sicid] }
+        end
+      end
+
+      def each
+        @stocks_map.values.each { |stock| yield stock }
+      end
+    end
+  end
+end

data/lib/moex_iss/request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Request
+    include MoexIss::Connection
+
+    def get(path, params = {})
+      respond_with(connection.get(path, params))
+    end
+
+    private
+
+    def respond_with(raw_response)
+      return if raw_response.body.empty?
+
+      respond_with_error(raw_response.status, raw_response.body) if !raw_response.success?
+
+      JSON.parse(raw_response.body)
+    rescue JSON::ParserError
+      raise MoexIss::Error::ResponseParseError, "Ошибка парсинга json из ответа"
+    end
+
+    def respond_with_error(code, body)
+      raise(MoexIss::Error, body) unless MoexIss::Error::ERRORS.key?(code)
+
+      raise MoexIss::Error::ERRORS[code], body
+    end
+  end
+end

data/lib/moex_iss/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MoexIss # :nodoc:
+  VERSION = "1.0.0"
+end

data/lib/moex_iss.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module MoexIss
+  def self.client
+    MoexIss::Client.new
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: moex_iss
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vyacheslav Konovalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+description: 
+email:
+- goplit2010.konovalov@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/moex_iss.rb
+- lib/moex_iss/client.rb
+- lib/moex_iss/connection.rb
+- lib/moex_iss/error.rb
+- lib/moex_iss/hendler.rb
+- lib/moex_iss/market/stock.rb
+- lib/moex_iss/market/stocks.rb
+- lib/moex_iss/request.rb
+- lib/moex_iss/version.rb
+homepage: https://github.com/K0Hb/moex_iss
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/K0Hb/moex_iss/issues
+  changelog_uri: https://github.com/K0Hb/moex_iss/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/K0Hb/moex_iss
+  homepage_uri: https://github.com/K0Hb/moex_iss
+  source_code_uri: https://github.com/K0Hb/moex_iss
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Client for MOEX ISS API
+test_files: []