dtn 0.0.0 → 0.1.0

data/lib/dtn/lookups/historical/interval_day.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Interval datapoint requests
+      class IntervalDay < Interval
+        TEMPLATE =
+          "HID,%<symbol>s,%<interval>d,%<days>d,%<max_datapoints>d,%<begin_filter_time>s,"\
+          "%<end_filter_time>s,%<data_direction>d,%<id>d,%<datapoints_per_send>d,%<interval_type>s"
+
+        # HID - Retrieves [Days] days of interval data for the specified [Symbol].
+        #
+        # Example message
+        #
+        #   HID,[Symbol],[Interval],[Days],[MaxDatapoints],[BeginFilterTime],[EndFilterTime],
+        #   [DataDirection],[RequestID],[DatapointsPerSend],[IntervalType]<CR><LF>
+        def call(symbol:, interval:, days:, **options)
+          self.combined_options = defaults(**options).merge(
+            {
+              symbol: validate_symbol(symbol),
+              days: validate_short_int(days),
+              interval: validate_int(interval),
+              interval_type: validate_interval_type(options[:interval_type])
+            }
+          )
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/interval_timeframe.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Interval timeframe requests
+      class IntervalTimeframe < Interval
+        TEMPLATE =
+          "HIT,%<symbol>s,%<interval>d,%<begin_datetime>s,%<end_datetime>s,%<max_datapoints>d,"\
+          "%<begin_filter_time>s,%<end_filter_time>s,%<data_direction>d,%<id>d,"\
+          "%<datapoints_per_send>d,%<interval_type>s"
+
+        # HIT - Retrieves interval data between [BeginDate BeginTime] and [EndDate EndTime] for the
+        # specified [Symbol].
+        #
+        # Example message
+        #
+        #   HIT,[Symbol],[Interval],[BeginDate BeginTime],[EndDate EndTime],[MaxDatapoints],\
+        #   [BeginFilterTime],[EndFilterTime],[DataDirection],[RequestID],[DatapointsPerSend],\
+        #   [IntervalType]<CR><LF>
+
+        def call(symbol:, interval:, begin_datetime:, end_datetime:, **options)
+          self.combined_options = defaults(**options).merge(
+            {
+              symbol: validate_symbol(symbol),
+              interval: validate_int(interval),
+              interval_type: validate_interval_type(options[:interval_type]),
+              begin_datetime: validate_datetime(begin_datetime),
+              end_datetime: validate_datetime(end_datetime)
+            }
+          )
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/monthly_datapoint.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Weekly datapoint requests
+      class MonthlyDatapoint < Datapoint
+        TEMPLATE =
+          "HMX,%<symbol>s,%<max_datapoints>d,%<data_direction>d,%<id>d,%<datapoints_per_send>d"
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/tick.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Tick requests
+      class Tick < Base
+        def expected_messages_class
+          Messages::Historical::Tick
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/tick_datapoint.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Tick datapoint requests
+      class TickDatapoint < Tick
+        TEMPLATE =
+          "HTX,%<symbol>s,%<max_datapoints>d,%<data_direction>d,%<id>d,%<datapoints_per_send>d"
+
+        # Retrieves up to [MaxDatapoints] number of ticks for the specified [Symbol].
+        #
+        # Example message
+        #
+        #   HTX,[Symbol],[MaxDatapoints],[DataDirection],[RequestID],[DatapointsPerSend]<CR><LF>
+        def call(symbol:, **options)
+          self.combined_options = defaults(**options).merge(symbol: validate_symbol(symbol))
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/tick_day.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Tick days requests
+      class TickDay < Tick
+        TEMPLATE =
+          "HTD,%<symbol>s,%<days>s,%<max_datapoints>d,%<begin_filter_time>s,%<end_filter_time>s," \
+          "%<data_direction>d,%<id>d,%<datapoints_per_send>d"
+
+        # Retrieves ticks for the previous [Days] days for the specified [Symbol].
+        #
+        # NOTE: Unfortunately I constantly get an empty response with this and
+        #       more information about this data point needed.
+        #
+        # Example message
+        #
+        #   HTD,[Symbol],[Days],[MaxDatapoints],[BeginFilterTime],[EndFilterTime],[DataDirection],\
+        #   [RequestID],[DatapointsPerSend]<CR><LF>
+        #
+        # @returns Integer id
+        def call(symbol:, days:, **options)
+          self.combined_options = defaults(**options).merge({
+                                                              symbol: validate_symbol(symbol),
+                                                              days: validate_short_int(days)
+                                                            })
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/tick_timeframe.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Tick timeframe requests
+      class TickTimeframe < Tick
+        TEMPLATE =
+          "HTT,%<symbol>s,%<begin_datetime>s,%<end_datetime>s,%<max_datapoints>d," \
+          "%<begin_filter_time>s,%<end_filter_time>s,%<data_direction>d,%<id>d," \
+          "%<datapoints_per_send>d"
+
+        # Retrieves tick data between [BeginDate BeginTime] and [EndDate EndTime] for the specified [Symbol].
+        #
+        # Example message
+        #
+        #   HTT,[Symbol],[BeginDate BeginTime],[EndDate EndTime],[MaxDatapoints],[BeginFilterTime],\
+        #   [EndFilterTime],[DataDirection],[RequestID],[DatapointsPerSend]<CR><LF>
+        def call(symbol:, begin_datetime:, end_datetime:, **options)
+          self.combined_options = defaults(**options).merge({
+                                                              symbol: validate_symbol(symbol),
+                                                              begin_datetime: validate_datetime(begin_datetime),
+                                                              end_datetime: validate_datetime(end_datetime)
+                                                            })
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/historical/weekly_datapoint.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module Historical
+      # Weekly datapoint requests
+      class WeeklyDatapoint < Datapoint
+        TEMPLATE =
+          "HWX,%<symbol>s,%<max_datapoints>d,%<data_direction>d,%<id>d,%<datapoints_per_send>d"
+      end
+    end
+  end
+end

data/lib/dtn/lookups/news/base.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module News
+      # User news requests
+      class Base < Request
+        DEFAULT_NEWS_FORMAT_TYPE = "t"
+
+        include Dtn::Concerns::Validation
+
+        private
+
+        def validate_format_type(value)
+          it = value.to_s.downcase[0]
+          return it if [nil, "x", "t"].include?(it)
+
+          raise ValidationError, "Got #{value}, but interval_type can be only 't' for text or 'x' for XML"
+        end
+
+        def validate_list(value)
+          return value.join(";") if value.is_a? Array
+
+          value
+        end
+
+        # Date range validator.
+        # Consume Date, Range or String as a values (or any combination of them as the args,
+        # Array including)
+        # Returns Dtn valid String
+        class DateRangeValidator
+          include Dtn::Concerns::Validation
+
+          def initialize(*values)
+            @values = values.flatten
+          end
+
+          def call
+            return "" if empty_values?
+
+            check_each_value.join(":")
+          end
+
+          private
+
+          attr_reader :values
+
+          def empty_values?
+            values.all?(&:blank?)
+          end
+
+          def check_each_value
+            values.inject([]) do |acc, value|
+              case value
+              when Date then acc.push(check_date(value))
+              when Range then acc.push(check_range(value))
+              else acc + check(value)
+              end
+            end
+          end
+
+          def check_date(value)
+            validate_date(value)
+          end
+
+          def check_range(value)
+            "#{validate_date(value.begin)}-#{validate_date(value.end)}"
+          end
+
+          def check(value)
+            value.split(":").map do |pair|
+              raise(ValidationError, "Wrong dates range group in '#{pair}'") unless pair =~ /^\d{8}(-\d{8})?$/
+
+              pair.to_s.split("-").map { |d| validate_date(d) }.join("-")
+            end
+          end
+        end
+
+        def validate_date_ranges(*values)
+          DateRangeValidator.new(*values).call
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/news/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module News
+      # News config
+      class Config < Base
+        TEMPLATE = "NCG,%<format_type>s,%<id>d"
+
+        # Returns the News configuration which tells you what news sources
+        # you are subscribed to.
+        #
+        # Example messages
+        #
+        #   NCG,[XML/Text],[RequestID]<CR><LF>
+        def call(format_type: DEFAULT_NEWS_FORMAT_TYPE)
+          self.combined_options = defaults.merge(
+            format_type: validate_format_type(format_type)
+          )
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/news/headline.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module News
+      # News headlines
+      class Headline < Base
+        TEMPLATE = "NHL,%<sources>s,%<symbols>s,%<format_type>s,%<limit>d,%<date_range>s,%<id>d"
+
+        DEFAULT_NEWS_HEADLINES_LIMIT = 1000
+
+        # Returns all current news headlines.
+        #
+        # @params sources Array of Strings or ';' separated String,
+        #         Filter news sources to query. Default all sources.
+        # @params symbols Array of Strings or ';' separated String,
+        #         Filter symbols you want news for. Default all symbols.
+        # @params date_range String or Date
+        #         Filter News only for dates. Default no date filter
+        # @params limit Integer
+        #         Limit fetching stories, Default 1000
+        #
+        # Example messages
+        #
+        #   NHL,[Sources],[Symbols],[XML/Text],[Limit],[Date],[RequestID]
+        def call(date_range: "", symbols: [], sources: [], format_type: DEFAULT_NEWS_FORMAT_TYPE,
+                 limit: DEFAULT_NEWS_HEADLINES_LIMIT)
+          self.combined_options = defaults.merge(
+            format_type: validate_format_type(format_type),
+            symbols: validate_list(symbols),
+            sources: validate_list(sources),
+            date_range: validate_date_ranges(date_range),
+            limit: limit
+          )
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/news/story.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module News
+      # News story
+      class Story < Base
+        NEWS_FORMAT_TYPES = %w[x t e].freeze
+
+        TEMPLATE = "NSY,%<story_id>s,%<format_type>s,%<deliver_to>s,%<id>d"
+
+        # Returns all current news story.
+        #
+        # Note: email support was not implemented
+        #
+        # Example messages
+        #
+        #   NSY,[ID],[XML/Text/Email],[DeliverTo],[RequestID]<CR><LF>
+        def call(story_id:, deliver_to: nil, format_type: DEFAULT_NEWS_FORMAT_TYPE)
+          self.combined_options = defaults.merge(
+            format_type: validate_format_type(format_type),
+            deliver_to: deliver_to,
+            story_id: story_id
+          )
+          super
+        end
+
+        private
+
+        def validate_format_type(value)
+          it = value.to_s.downcase[0]
+          return it if [nil, "x", "t", "e"].include?(it)
+
+          raise ValidationError,
+                "Got #{value}, but interval_type can be only 't' for text, 'e' for email or 'x' for XML"
+        end
+      end
+    end
+  end
+end

data/lib/dtn/lookups/news/story_count.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dtn
+  module Lookups
+    module News
+      # News story count
+      class StoryCount < Base
+        TEMPLATE = "NSC,%<symbols>s,%<format_type>s,%<sources>s,%<date_range>s,%<id>d"
+
+        DEFAULT_NEWS_HEADLINES_LIMIT = 1000
+
+        # Returns all current news headlines.
+        #
+        # @params sources Array of Strings or ';' separated String,
+        #         Filter news sources to query. Default all sources.
+        # @params symbols Array of Strings or ';' separated String,
+        #         Filter symbols you want news for. Default all symbols.
+        # @params date_range String or Date
+        #         Filter News only for dates. Default no date filter
+        #
+        # Example messages
+        #
+        #   NSC,[Symbols],[XML/Text],[Sources],[DateRange],[RequestID]<CR>
+        def call(date_range: "", symbols: [], sources: [], format_type: DEFAULT_NEWS_FORMAT_TYPE)
+          self.combined_options = defaults.merge(
+            format_type: validate_format_type(format_type),
+            symbols: validate_list(symbols),
+            sources: validate_list(sources),
+            date_range: validate_date_ranges(date_range)
+          )
+          super
+        end
+      end
+    end
+  end
+end