moex_iss 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931ab0fc8f2e2b3a7f04baa97c08b7078040dd278e461d3743b4128661a33dc1
-  data.tar.gz: 555072f46a7e8298f0424fcb199c9a9000a4eed80981c148e8b748e94fbeda42
+  metadata.gz: e2a3f9ad4ce42c5fe38d5b16bf09ec3d937654cf12225360c2c24f4a16b0322a
+  data.tar.gz: fa3d5358f2ce99cf174c31a1eb27da86f2ba827d632bcd1214e19cd356080431
 SHA512:
-  metadata.gz: 6d1e0e7e037c4e3a9ebf7ce0ca08f52f89795ba9c09fa96c14d5b8c13aa532cad30179abd8d2f4230fff0b5347d457226dd165ca46c268eefbc0d2aff49e2096
-  data.tar.gz: 0e87922f366dbcaba06a5ceb04598ad86405ce29903193adfe604e00f5daa434756533804846c5973da2629ea02c10e305d852fad43c87c0097b3e146b43b3ac
+  metadata.gz: 5a9374940f414e6309bbb3fa1249c1406fb34932deeeb33d50a99c762faffede6a063dd891fa4fac96ec479da194c4dff5c8af5b7c81335cfe29243d40a268e9
+  data.tar.gz: feee8548808c648d93726e2a79ac4240f15bd9afd4f469f7123cc743a714e8d12a56ea7d2147d4e42c9b9328fc492d07bb0ac0e048ca390ca3ac7cdb39984f47

data/CHANGELOG.md

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

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)
 
@@ -39,23 +39,41 @@ client = MoexIss.client
 
 ### Акции
 
-Для получения одной акций:
+Для получения последних актульных данных:
+- Все акции
+```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

@@ -21,7 +21,9 @@ module MoexIss
       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
 
@@ -29,5 +31,25 @@ module MoexIss
 
       MoexIss::Market::Stock.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

@@ -36,7 +36,3 @@ module MoexIss
 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,7 @@ module MoexIss
   module Hendler
     def handle_response(response)
       return standard_hendler(response) if standard_schema?(response)
+      return history_hendler(response) if history_schema?(response)
 
       fail MoexIss::Error::ResponseSchemaError, "Неизвестная схема ответа"
     end
@@ -17,10 +18,18 @@ module MoexIss
         response[1]["marketdata"].is_a?(Array)
     end
 
+    def history_schema?(response)
+      response.is_a?(Array) && response[1]&.has_key?("history")
+    end
+
     def standard_hendler(response)
       response[1]["securities"].map.with_index do |x, i|
         {"securities" => x, "marketdata" => response[1]["marketdata"][i]}
       end
     end
+
+    def history_hendler(response)
+      response[1]
+    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,19 @@
+# frozen_string_literal: true
+
+module MoexIss
+  module Market
+    module History
+      class Stocks < MoexIss::Market::Stocks
+        def create_instances_stock
+          @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

@@ -5,28 +5,34 @@ module MoexIss
     class Stocks
       include Enumerable
 
-      attr_reader :stocks_response
+      attr_reader :response
 
-      def initialize(stocks_response)
-        @stocks_response = stocks_response
+      def initialize(response)
+        @response = 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
+        @response.each do |data|
+          method = data["securities"]["SECID"].downcase.to_sym
 
-          @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 }
       end
+
+      private
+
+      def setup_method(method, data)
+        @stocks_map[method] = Stock.new(data)
+
+        self.class.send(:define_method, method) { @stocks_map[method] }
+      end
     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.1.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.1.0
 platform: ruby
 authors:
 - Vyacheslav Konovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,8 @@ files:
 - lib/moex_iss/connection.rb
 - lib/moex_iss/error.rb
 - lib/moex_iss/hendler.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