moex_iss 1.0.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931ab0fc8f2e2b3a7f04baa97c08b7078040dd278e461d3743b4128661a33dc1
-  data.tar.gz: 555072f46a7e8298f0424fcb199c9a9000a4eed80981c148e8b748e94fbeda42
+  metadata.gz: 71d87cc339f313c78295e2d5d3569aade22989f93ecef8cf27fcfde8cb151562
+  data.tar.gz: '0181b5dc0b1e9e01b93a685ce68bee1a84767c354b35ac27d3b50f48eeff2b5c'
 SHA512:
-  metadata.gz: 6d1e0e7e037c4e3a9ebf7ce0ca08f52f89795ba9c09fa96c14d5b8c13aa532cad30179abd8d2f4230fff0b5347d457226dd165ca46c268eefbc0d2aff49e2096
-  data.tar.gz: 0e87922f366dbcaba06a5ceb04598ad86405ce29903193adfe604e00f5daa434756533804846c5973da2629ea02c10e305d852fad43c87c0097b3e146b43b3ac
+  metadata.gz: d5fc0c6b4c6884de71e79c727bb0c5a9923038783736a10f2d0806eef5c765f5cd50dd9f45ce7670cf08dda27279118dee7766d0baca73e1ac1428dcbb9f8165
+  data.tar.gz: f6281f2e0f278f577bacdbd179ed3bb7ddd7db31a5ebefc89453de63c5f49235a1658a6e2440cd2cbb387cc3621781d0fdd14866fe7eed2c625d7b98cc8a0568

data/CHANGELOG.md

@@ -1,3 +1,10 @@
 # Change log
+Все важные изменения в этом проекте будут задокументированы в этом файле.
 
-## master
+Формат основан на ведении журнала изменений, и этот проект придерживается семантического управления версиями.
+## [1.1.0] - 2023-12-30
+### Добавлено
+- Возможность работы с историческими данными акции
+## [1.11.0] - 2024-01-03
+### Добавлено
+- Возможность получать данные об актуальных курсах валют ЦБ РФ

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/moex_iss.svg)](https://rubygems.org/gems/moex_iss)
+[![Gem Version](https://badge.fury.io/rb/moex_iss.svg)](https://badge.fury.io/rb/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)
 
@@ -37,25 +37,54 @@ gem "moex_iss"
 client = MoexIss.client
 ```
 
+### Валюты
+Для получения последних актульных данных о курсах валют:
+```ruby
+currencies = client.currencies # => MoexIss::Market::Currencies
+
+cny_rub = currencues.cny_rub # => MoexIss::Market::Currency
+cny_urb.price = 12.5762
+...
+```
+
 ### Акции
 
-Для получения одной акций:
+Для получения последних актульных данных:
+- Все акции
+```ruby
+client.stocks # => MoexIss::Market::Stocks
+```
+Получаем класс, по которому можно итерироваться а так же вызывать искомую ценную бумагу по ее `isin`
+```ruby
+stocks.sber # => MoexIss::Market::Stock
+```
+- Одна Акция
 ```ruby
 client.stock(:sber) # => MoexIss::Market::Stock
 ```
-Для получения всех акций:
++ Для получения данные об исторических данных:
 ```ruby
-client.stocks # => MoexIss::Market::Stocks
+client.stock(:sber, from: '2023-12-01', till: '2023-12-05') # => MoexIss::Market::History::Stocks
 ```
-Получаем класс, по которому можно итерироваться а так же вызывать искомую ценную бумагу по ее `isin`
+Есть возможность работы с коллекцией через дату:
 ```ruby
-stocks.sber
+stocks = client.stock(:sber, from: '2023-12-01', till: '2023-12-05') # => MoexIss::Market::History::Stocks
+stocks['2023-12-03']  # => MoexIss::Market::History::Stock
 ```
-Экземпляр класса `MoexIss::Market::Stocks` отвечает на методы:
+Максимальное количесво дней: _100_
+
+Аргументы `from` и `till` можно использовать по одиночке
+
+### Обратите внимание
+
+Все экземпляры классов отвечает на метод `response`, который содержит полный ответ от MOEX ISS, из которого можно получать доп.параметры,
+так же у каждого класса свой набор специфических методов для удобства работы с данными.
 ```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]
+# Пример
+client.stock(:sber).market_price # => 271.37
+client.stock(:sber).prev_date # => 2023-12-2
+...
 ```
-где `response` содержит полный ответ от MOEX ISS, из которого можно получать доп.параметры
 
 
 ## Лицензия

data/lib/moex_iss/client.rb

@@ -6,28 +6,62 @@ module MoexIss
     include MoexIss::Hendler
 
     STOCKS_ENDPOINT = "engines/stock/markets/shares/boards/tqbr/securities"
+    CURRENCIES_ENDPOINT = "statistics/engines/currency/markets/selt/rates"
     STANDARD_PARAMS = {
       "iss.json" => "extended",
-      "iss.only" => "securities,marketdata",
       "iss.meta" => "off"
     }
 
     def stocks
       endpoint = "#{STOCKS_ENDPOINT}.json"
       params = STANDARD_PARAMS
+      params["iss.only"] = "securities,marketdata"
 
       raw_response = get(endpoint, params)
 
       MoexIss::Market::Stocks.new(handle_response(raw_response))
     end
 
-    def stock(isin)
+    def stock(isin, from: nil, till: nil)
+      return historical_data_of_the_stock(isin, from, till) if from || till
+
       endpoint = "#{STOCKS_ENDPOINT}/#{isin}.json"
       params = STANDARD_PARAMS
+      params["iss.only"] = "securities,marketdata"
 
       raw_response = get(endpoint, params)
 
       MoexIss::Market::Stock.new(handle_response(raw_response))
     end
+
+    def currencies
+      endpoint = "#{CURRENCIES_ENDPOINT}.json"
+      params = STANDARD_PARAMS
+      params["iss.only"] = "wap_rates"
+
+      raw_response = get(endpoint, params)
+
+      MoexIss::Market::Currencies.new(handle_response(raw_response))
+    end
+
+    private
+
+    def historical_data_of_the_stock(isin, from, till)
+      validate_date(from, till) if from || till
+
+      endpoint = "history/#{STOCKS_ENDPOINT}/#{isin}.json"
+      params = STANDARD_PARAMS.merge({from: from, till: till})
+
+      raw_response = get(endpoint, params)
+
+      MoexIss::Market::History::Stocks.new(handle_response(raw_response))
+    end
+
+    def validate_date(*dates)
+      error = Error::InvalidDateError
+      message = "Невалидная дата"
+
+      dates.compact.each { |date| date.match?(/^\d{4}-\d{2}-\d{2}$/) ? nil : fail(error, message) }
+    end
   end
 end

data/lib/moex_iss/connection.rb

@@ -34,9 +34,3 @@ module MoexIss
     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

@@ -4,6 +4,7 @@ module MoexIss
   class Error < StandardError
     ResponseSchemaError = Class.new(self)
     ResponseParseError = Class.new(self)
+    InvalidDateError = Class.new(self)
 
     ClientError = Class.new(self)
     ServerError = Class.new(self)

data/lib/moex_iss/hendler.rb

@@ -4,6 +4,8 @@ module MoexIss
   module Hendler
     def handle_response(response)
       return standard_hendler(response) if standard_schema?(response)
+      return response[1] if history_schema?(response)
+      return response[1] if currencies_schema?(response)
 
       fail MoexIss::Error::ResponseSchemaError, "Неизвестная схема ответа"
     end
@@ -17,6 +19,14 @@ module MoexIss
         response[1]["marketdata"].is_a?(Array)
     end
 
+    def history_schema?(response)
+      response.is_a?(Array) && response[1]&.has_key?("history")
+    end
+
+    def currencies_schema?(response)
+      response.is_a?(Array) && response[1]&.has_key?("wap_rates")
+    end
+
     def standard_hendler(response)
       response[1]["securities"].map.with_index do |x, i|
         {"securities" => x, "marketdata" => response[1]["marketdata"][i]}

data/lib/moex_iss/market/collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    class Collection
+      include Enumerable
+
+      attr_reader :response
+
+      def initialize(response, instance_class: Security)
+        @response = response
+        @instance_class = instance_class
+        @stocks_map = {}
+
+        create_instances
+      end
+
+      def create_instances
+        @response.each do |data|
+          method = method_name(data)
+
+          setup_method(method, data)
+        end
+      end
+
+      def each
+        @stocks_map.values.each { |stock| yield stock }
+      end
+
+      private
+
+      def method_name(data)
+        :some_name
+      end
+
+      def setup_method(method, data)
+        @stocks_map[method] = @instance_class.new(data)
+
+        self.class.send(:define_method, method) { @stocks_map[method] }
+      end
+    end
+  end
+end

data/lib/moex_iss/market/currencies.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    class Currencies < Collection
+      def initialize(response, instance_class: MoexIss::Market::Currency)
+        super
+      end
+
+      def create_instances
+        @response["wap_rates"].each do |data|
+          method = method_name(data)
+
+          setup_method(method, data)
+        end
+      end
+
+      private
+
+      def method_name(data)
+        data["shortname"]
+          .split("_")
+          .first.downcase
+          .insert(3, "_")
+          .to_sym
+      end
+    end
+  end
+end

data/lib/moex_iss/market/currency.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    class Currency
+      METHODS = {
+        "tradedate" => :trade_date, "tradetime" => :trade_time,
+        "secid" => :secid, "shortname" => :short_name,
+        "price" => :price, "lasttoprevprice" => :last_top_rev_price,
+        "nominal" => :nominal, "decimals" => :decimals
+      }.freeze
+
+      attr_reader(:response, *METHODS.values)
+
+      def initialize(response)
+        @response = response
+
+        setup_instance_varibales(@response)
+      end
+
+      private
+
+      def setup_instance_varibales(data)
+        return if data.nil?
+
+        data.each do |key, value|
+          next unless METHODS.has_key?(key)
+
+          instance_variable_set("@#{METHODS[key]}", value)
+        end
+      end
+    end
+  end
+end

data/lib/moex_iss/market/history/stock.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    module History
+      class Stock
+        METHODS = {
+          "TRADEDATE" => :trade_date, "SHORTNAME" => :short_name, "SECID" => :secid, "VALUE" => :value,
+          "OPEN" => :open, "LOW" => :low, "HIGH" => :high, "LEGALCLOSEPRICE" => :legal_close_price,
+          "VOLUME" => :volume
+        }.freeze
+
+        attr_reader(:response, *METHODS.values)
+
+        def initialize(response)
+          @response = response
+
+          setup_instance_varibales(@response["history"])
+        end
+
+        private
+
+        def setup_instance_varibales(data)
+          return if data.nil?
+
+          data.each do |key, value|
+            next unless METHODS.has_key?(key)
+
+            instance_variable_set("@#{METHODS[key]}", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moex_iss/market/history/stocks.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    module History
+      class Stocks < MoexIss::Market::Collection
+        def initialize(response, instance_class: MoexIss::Market::History::Stock)
+          super
+        end
+
+        def create_instances
+          @response["history"].each do |data|
+            @stocks_map[data["TRADEDATE"]] = History::Stock.new({"history" => data})
+          end
+        end
+
+        def [](key)
+          @stocks_map[key]
+        end
+      end
+    end
+  end
+end

data/lib/moex_iss/market/stock.rb

@@ -19,13 +19,23 @@ module MoexIss
       def initialize(response)
         @response = response.is_a?(Array) ? response.first : response
 
-        @response["securities"].merge(@response["marketdata"]).each do |key, value|
+        setup_instance_varibales(@response["securities"])
+        setup_instance_varibales(@response["marketdata"])
+        setup_instance_varibales(@response["history"])
+
+        @market_data = @response["marketdata"]&.slice(*MARKET_DATA)
+      end
+
+      private
+
+      def setup_instance_varibales(data)
+        return if data.nil?
+
+        data.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

data/lib/moex_iss/market/stocks.rb

@@ -2,30 +2,23 @@
 
 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
+    class Stocks < Collection
+      def initialize(response, instance_class: MoexIss::Market::Stock)
+        super
       end
 
       def create_instances_stock
-        @stocks_response.each do |stock_response|
-          sicid = stock_response["securities"]["SECID"].downcase.to_sym
+        @response.each do |data|
+          method = method_name(data)
 
-          @stocks_map[sicid] = Stock.new(stock_response)
-
-          self.class.send(:define_method, sicid) { @stocks_map[sicid] }
+          setup_method(method, data)
         end
       end
 
-      def each
-        @stocks_map.values.each { |stock| yield stock }
+      private
+
+      def method_name(data)
+        data["securities"]["SECID"].downcase.to_sym
       end
     end
   end

data/lib/moex_iss/request.rb

@@ -21,9 +21,9 @@ module MoexIss
     end
 
     def respond_with_error(code, body)
-      raise(MoexIss::Error, body) unless MoexIss::Error::ERRORS.key?(code)
+      fail(MoexIss::Error, body) unless MoexIss::Error::ERRORS.key?(code)
 
-      raise MoexIss::Error::ERRORS[code], body
+      fail MoexIss::Error::ERRORS[code], body
     end
   end
 end

data/lib/moex_iss/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moex_iss
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Vyacheslav Konovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,11 @@ files:
 - lib/moex_iss/connection.rb
 - lib/moex_iss/error.rb
 - lib/moex_iss/hendler.rb
+- lib/moex_iss/market/collection.rb
+- lib/moex_iss/market/currencies.rb
+- lib/moex_iss/market/currency.rb
+- lib/moex_iss/market/history/stock.rb
+- lib/moex_iss/market/history/stocks.rb
 - lib/moex_iss/market/stock.rb
 - lib/moex_iss/market/stocks.rb
 - lib/moex_iss/request.rb
@@ -124,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Client for MOEX ISS API