inat-channel 0.8.2 → 0.9.0

data/lib/inat-channel/data_types.rb

@@ -4,56 +4,21 @@ require 'sanitize'
 
 require_relative 'icons'
 
-module INatChannel
-  FORMATS = {
-    date: '%Y.%m.%d',
-    time: '%H:%M %Z',
-    datetime: '%Y.%m.%d %H:%M %Z',
-    location: :DMS,   # or :decimal
-    zoom: 12,
-    description_limit: 512
-  }
-end
-
 class Date
   def icon
-    INatChannel::Icons::ICONS[:calendar]
-  end
-  def to_s
-    fmt = INatChannel::FORMATS[:date]
-    if fmt
-      self.strftime fmt
-    else
-      super
-    end
+    IC::ICONS[:calendar]
   end
 end
 
 class Time
   def icon
-    INatChannel::Icons::clock_icon self
-  end
-  def to_s
-    fmt = INatChannel::FORMATS[:time]
-    if fmt
-      self.strftime fmt
-    else
-      super
-    end
+    IC::clock_icon self
   end
 end
 
 class DateTime
   def icon
-    INatChannel::Icons::ICONS[:calendar]
-  end
-  def to_s
-    fmt = INatChannel::FORMATS[:datetime]
-    if fmt
-      self.strftime fmt
-    else
-      super
-    end
+    IC::ICONS[:calendar]
   end
 end
 
@@ -93,9 +58,9 @@ class Array
   end
 end
 
-Observation = Struct::new :taxon, :id, :uuid, :url, :user, :datetime, :places, :place_guess, :description, :location, keyword_init: true do
+Observation = Data::define :taxon, :id, :uuid, :url, :user, :datetime, :places, :place_guess, :description, :location do
   def icon
-    INatChannel::Icons::ICONS[:observation]
+    IC::ICONS[:observation]
   end
   def date
     datetime.to_date
@@ -105,9 +70,9 @@ Observation = Struct::new :taxon, :id, :uuid, :url, :user, :datetime, :places, :
   end
 end
 
-Taxon = Struct::new :scientific_name, :common_name, :id, :ancestors, keyword_init: true do
+Taxon = Data::define :scientific_name, :common_name, :id, :ancestors do
   def icon
-    INatChannel::Icons::ancestors_icon ancestors.map(&:id)
+    IC::ancestors_icon ancestors.map(&:id)
   end
   def title
     if common_name && !common_name.empty?
@@ -124,15 +89,15 @@ Taxon = Struct::new :scientific_name, :common_name, :id, :ancestors, keyword_ini
   end
 end
 
-Ancestor = Struct::new :scientific_name, :id, keyword_init: true do
+Ancestor = Data::define :scientific_name, :id do
   def to_tag
     scientific_name.to_tag
   end
 end
 
-Place = Struct::new :ids, :text, :link, :tag, keyword_init: true do
+Place = Data::define :text, :link, :tag do
   def icon
-    INatChannel::Icons::ICONS[:place]
+    IC::ICONS[:place]
   end
   def to_tag
     tag&.to_tag
@@ -145,9 +110,9 @@ Place = Struct::new :ids, :text, :link, :tag, keyword_init: true do
   end
 end
 
-User = Struct::new :id, :login, :name, keyword_init: true do
+User = Data::define :id, :login, :name do
   def icon
-    INatChannel::Icons::ICONS[:user]
+    IC::ICONS[:user]
   end
   def title
     if name && !name.empty?
@@ -161,28 +126,32 @@ User = Struct::new :id, :login, :name, keyword_init: true do
   end
 end
 
-SANITIZE_HTML_CONFIG = {
-  elements: [ 'b', 'strong', 'i', 'em', 'u', 's', 'strike', 'del', 'a', 'code', 'pre', 'tg-spoiler', 'blockquote' ],
-  attributes: { 'a' => [ 'href' ] },
-  protocols: { 'a' => { 'href' => [ 'http', 'https', 'mailto', 'tg' ] } },
-  remove_contents: [ 'script', 'style' ]
-}
+module IC
+
+  SANITIZE_HTML_CONFIG = {
+    elements: [ 'b', 'strong', 'i', 'em', 'u', 's', 'strike', 'del', 'a', 'code', 'pre', 'tg-spoiler', 'blockquote' ],
+    attributes: { 'a' => [ 'href' ] },
+    protocols: { 'a' => { 'href' => [ 'http', 'https', 'mailto', 'tg' ] } },
+    remove_contents: [ 'script', 'style' ]
+  }
+
+  SANITIZE_TEXT_CONFIG = {
+    elements: [],
+    remove_contents: [ 'script', 'style' ]
+  }
 
-SANITIZE_TEXT_CONFIG = {
-  elements: [],
-  remove_contents: [ 'script', 'style' ]
-}
+end
 
-Description = Struct::new :value, keyword_init: true do
+Description = Data::define :value do
   def icon
-    INatChannel::Icons::ICONS[:description]
+    IC::ICONS[:description]
   end
   def text
-    Sanitize.fragment(value, SANITIZE_TEXT_CONFIG).limit(FORMATS[:description_limit])
+    Sanitize.fragment(value, IC::SANITIZE_TEXT_CONFIG).limit(IC::CONFIG.dig(:tg_bot, :desc_limit))
   end
   def html
-    sanitized = Sanitize.fragment value, SANITIZE_HTML_CONFIG
-    if sanitized.length > FORMATS[:description_limit]
+    sanitized = Sanitize.fragment value, IC::SANITIZE_HTML_CONFIG
+    if sanitized.length > IC::CONFIG.dig(:tg_bot, :desc_limit)
       # В отличие от простого текста, обрезка HTML требует куда более изощренной логики, что неоправданно
       text
     else
@@ -191,36 +160,39 @@ Description = Struct::new :value, keyword_init: true do
   end
 end
 
-Location = Struct::new :lat, :lng, keyword_init: true do
+Location = Data::define :lat, :lng do
   def icon
-    INatChannel::Icons::ICONS[:location]
+    IC::ICONS[:location]
   end
-  def title
-    lat_dir = lat >= 0 ? 'N' : 'S'
-    lng_dir = lng >= 0 ? 'E' : 'W'
+  def dms
+    lat_dir = lat >= 0 ? "N" : "S"
+    lng_dir = lng >= 0 ? "E" : "W"
     lat_abs = lat.abs
     lng_abs = lng.abs
-    if FORMATS[:location] == :DMS
-      lat_d = lat_abs.floor
-      lat_m = ((lat_abs - lat_d) * 60).floor
-      lat_s = ((lat_abs - lat_d - lat_m / 60.0) * 3600).round
-      lng_d = lng_abs.floor
-      lng_m = ((lng_abs - lng_d) * 60).floor
-      lng_s = ((lng_abs - lng_d - lng_m / 60.0) * 3600).round
-      "%d°%02d'%02d\"%s %d°%02d'%02d\"%s" % [ lat_d, lat_m, lat_s, lat_dir, lng_d, lng_m, lng_s, lng_dir ]
-    else
-      "%.4f°%s, %.4f°%s" % [ lat_abs, lat_dir, lng_abs, lng_dir ]
-    end
+    lat_d = lat_abs.floor
+    lat_m = ((lat_abs - lat_d) * 60).floor
+    lat_s = ((lat_abs - lat_d - lat_m / 60.0) * 3600).round
+    lng_d = lng_abs.floor
+    lng_m = ((lng_abs - lng_d) * 60).floor
+    lng_s = ((lng_abs - lng_d - lng_m / 60.0) * 3600).round
+    "%d°%02d'%02d\"%s %d°%02d'%02d\"%s" % [lat_d, lat_m, lat_s, lat_dir, lng_d, lng_m, lng_s, lng_dir]
+  end
+  def decimal
+    lat_dir = lat >= 0 ? "N" : "S"
+    lng_dir = lng >= 0 ? "E" : "W"
+    lat_abs = lat.abs
+    lng_abs = lng.abs
+    "%.4f°%s, %.4f°%s" % [lat_abs, lat_dir, lng_abs, lng_dir]
   end
   def google
     # "https://www.google.com/maps/search/?api=1&query=#{lat},#{lng}&z=#{FORMATS[:zoom]}&ll=#{lat},#{lng}"
-    "https://www.google.com/maps/place/#{lat},#{lng}/@#{lat},#{lng},#{FORMATS[:zoom]}z/"
+    "https://www.google.com/maps/place/#{lat},#{lng}/@#{lat},#{lng},#{IC::CONFIG.dig(:tg_bot, :link_zoom)}z/"
   end
   def yandex
-    "https://yandex.ru/maps/?ll=#{lng},#{lat}&z=#{FORMATS[:zoom]}&pt=#{lng},#{lat},pm2rdm1"
+    "https://yandex.ru/maps/?ll=#{lng},#{lat}&z=#{IC::CONFIG.dig(:tg_bot, :link_zoom)}&pt=#{lng},#{lat},pm2rdm1"
   end
   def osm
-     "https://www.openstreetmap.org/?mlat=#{lat}&mlon=#{lng}#map=#{FORMATS[:zoom]}/#{lat}/#{lng}"
+     "https://www.openstreetmap.org/?mlat=#{lat}&mlon=#{lng}#map=#{IC::CONFIG.dig(:tg_bot, :link_zoom)}/#{lat}/#{lng}"
   end
   def url
     osm

data/lib/inat-channel/icons.rb

@@ -112,3 +112,24 @@ module INatChannel
   end
 
 end
+
+module IC
+
+  TAXA_ICONS = INatChannel::Icons::TAXA_ICONS
+  ICONS = INatChannel::Icons::ICONS
+
+  def taxon_icon taxon
+    INatChannel::Icons::taxon_icon taxon
+  end
+
+  def ancestors_icon ancestor_ids
+    INatChannel::Icons::ancestors_icon ancestor_ids
+  end
+
+  def clock_icon time
+    INatChannel::Icons::clock_icon time
+  end
+
+  module_function :taxon_icon, :ancestors_icon, :clock_icon
+
+end

data/lib/inat-channel/lock.rb

@@ -12,13 +12,13 @@ module INatChannel
     class << self
 
       def acquire!
-        file = INatChannel::CONFIG[:lock_file]
+        file = IC::CONFIG.dig(:lock_file, :path)
         FileUtils.mkdir_p File.dirname(file)
 
         if File.exist?(file)
           data = load_data file
           if stale?(data)
-            INatChannel::LOGGER.info "Remove stale lock: #{file}"
+            IC::logger.info "Remove stale lock: #{file}"
             File.delete file
           else
             raise "Another instance is already running (PID: #{data[:pid]})"
@@ -30,15 +30,15 @@ module INatChannel
           started_at: Time.now.utc.iso8601
         }
         File.write file, JSON.pretty_generate(data)
-        INatChannel::LOGGER.info "Lock acquired: #{file}"
+        IC::logger.info "Lock acquired: #{file}"
       end
 
       def release!
-        file = INatChannel::CONFIG[:lock_file]
+        file = IC::CONFIG.dig(:lock_file, :path)
         return nil unless File.exist?(file)
 
         File.delete file
-        INatChannel::LOGGER.info "Lock release: #{file}"
+        IC::logger.info "Lock release: #{file}"
       end
 
       private
@@ -49,7 +49,7 @@ module INatChannel
         {}
       end
 
-      LOCK_TTL = 1800  # 30 min
+      LOCK_TTL = 300  # 5 min
 
       def stale? data
         if data[:started_at]

data/lib/inat-channel/logger.rb

@@ -14,7 +14,7 @@ module INatChannel
 
       def get_logger
         lgr = ::Logger::new $stderr
-        lgr.level = INatChannel::CONFIG[:log_level]
+        lgr.level = IC::CONFIG[:log_level]
         lgr
       end
 
@@ -22,7 +22,15 @@ module INatChannel
 
   end
 
-  LOGGER = Logger::logger
+end
+
+module IC
+
+  def logger
+    INatChannel::Logger::logger
+  end
+
+  module_function :logger
 
 end
 

data/lib/inat-channel/message.rb

@@ -12,10 +12,10 @@ module INatChannel
     class << self
 
       def make_message observation
-        template = if INatChannel::CONFIG[:template]
-          INatChannel::Template::load INatChannel::CONFIG[:template]
+        template = if IC::CONFIG.dig(:tg_bot, :template)
+          IC::load_template IC::CONFIG.dig(:tg_bot, :template)
         else
-          INatChannel::Template::default
+          IC::default_template
         end
         template.process observation
       end
@@ -30,3 +30,18 @@ module INatChannel
   end
 
 end
+
+module IC
+
+  def make_message observation
+    INatChannel::Message::make_message observation
+  end
+
+  def list_photos observation
+    INatChannel::Message::list_photos observation
+  end
+
+  module_function :make_message, :list_photos
+
+end
+

data/lib/inat-channel/telegram.rb

@@ -11,30 +11,29 @@ module INatChannel
       TELEGRAM_API = 'https://api.telegram.org/bot'
 
       def send_observation observation
-        photos = INatChannel::Message::list_photos observation
-        message = INatChannel::Message::make_message observation
+        photos = IC::list_photos observation
+        message = IC::make_message observation
 
         unless photos.empty?
-          msg_id = send_media_group INatChannel::CONFIG[:chat_id], photos[0..9], message
+          msg_id = send_media_group IC::CONFIG.dig(:tg_bot, :chat_id), photos[0..9], message
         else
-          msg_id = send_message INatChannel::CONFIG[:chat_id], message
+          msg_id = send_message IC::CONFIG.dig(:tg_bot, :chat_id), message
         end
 
-        INatChannel::Data::sent[observation[:uuid]] = { msg_id: msg_id, sent_at: Time.now.to_s }
-        INatChannel::LOGGER.info "Posted #{observation[:id]} (#{photos.size} photos)"
+        IC::logger.info "Posted #{observation[:id]} (#{photos.size} photos)"
         msg_id
       end
 
       def notify_admin text
-        send_message(INatChannel::CONFIG[:admin_telegram_id], "iNatChannel: #{text}")
+        send_message(IC::CONFIG.dig(:tg_bot, :admin_id), "iNatChannel: #{text}")
       rescue
-        INatChannel::LOGGER.error "Admin notify failed"
+        IC::logger.error "Admin notify failed"
       end
 
       private
 
       def token 
-        @token ||= INatChannel::CONFIG[:telegram_bot_token]
+        @token ||= IC::CONFIG.dig(:tg_bot, :token)
       end
 
       def send_message chat_id, text
@@ -71,11 +70,15 @@ module INatChannel
 
       def faraday
         @faraday ||= Faraday.new do |f|
-          f.request :retry, max: INatChannel::CONFIG[:retries], interval: 2.0, interval_randomness: 0.5,  
+          f.request :retry, 
+                    max: IC::CONFIG.dig(:tg_bot, :retries), 
+                    interval: IC::CONFIG.dig(:tg_bot, :interval), 
+                    interval_randomness: IC::CONFIG.dig(:tg_bot, :randomness),
+                    backoff_factor: IC::CONFIG.dig(:tg_bot, :backoff),
                     exceptions: [ Faraday::TimeoutError, Faraday::ConnectionFailed, Faraday::SSLError, Faraday::ClientError ]
     
-          if INatChannel::LOGGER.level == ::Logger::DEBUG
-            f.response :logger, INatChannel::LOGGER, bodies: true, headers: true 
+          if IC::logger.level == ::Logger::DEBUG
+            f.response :logger, IC::logger, bodies: true, headers: true 
           end
     
           f.adapter Faraday.default_adapter
@@ -87,3 +90,18 @@ module INatChannel
   end
 
 end
+
+module IC
+
+  def send_observation observation
+    INatChannel::Telegram::send_observation observation
+  end
+
+  def notify_admin text
+    INatChannel::Telegram::notify_admin text
+  end
+
+  module_function :send_observation, :notify_admin
+
+end
+

data/lib/inat-channel/template.rb

@@ -14,13 +14,13 @@ module INatChannel
       @template = template
       @data = data
       @renderer = ERB::new @template, trim_mode: '-'
-      INatChannel::Icons::TAXA_ICONS.merge! data[:taxa_icons] if data[:taxa_icons]
-      INatChannel::Icons::ICONS.merge! data[:icons] if data[:icons]
-      INatChannel::FORMATS.merge! data[:formats] if data[:formats]
+      IC::TAXA_ICONS.merge! data[:taxa_icons] if data[:taxa_icons]
+      IC::ICONS.merge! data[:icons] if data[:icons]
+      IC::FORMATS.merge! data[:formats] if data[:formats]
     end
 
     def process observation_source
-      observation = INatChannel::DataConvert::convert_observation observation_source
+      observation = IC::convert_observation observation_source
       vars = {
         observation: observation,
         datetime: observation.datetime,
@@ -30,8 +30,10 @@ module INatChannel
         user: observation.user,
         date: observation.date,
         time: observation.time,
-        icons: INatChannel::Icons::ICONS,
-        taxa_icons: INatChannel::Icons::TAXA_ICONS
+        icons: IC::ICONS,
+        taxa_icons: IC::TAXA_ICONS,
+        config: IC::CONFIG,
+        data: @data
       }
       @renderer.result_with_hash vars
     end
@@ -58,14 +60,14 @@ module INatChannel
       DEFAULT_TEMPLATE = <<~ERB
         <%= taxon.icon %> <a href="<%= taxon.url %>"><%= taxon.title %></a>
 
-        <%= observation.icon %> <a href="<%= observation.url %>">#<%= observation.id %></a>
+        <%= observation.icon %> <%= observation.url %>
         <%= datetime.icon %> <%= datetime %>
         <%= user.icon %> <a href="<%= user.url %>"><%= user.title %></a>
         <% if observation.description -%>
         <blockquote><%= observation.description.text %></blockquote>
         <% end -%>
 
-        <%= location.icon %> <%= location.title %> • <a href="<%= location.google %>">G</a> <a href="<%= location.osm %>">OSM</a>
+        <%= location.icon %> <%= location.dms %> • <a href="<%= location.google %>">G</a> <a href="<%= location.osm %>">OSM</a>
         <% if places && places.size > 0 -%>
         <%   places.each do |place| -%>
         <%= place.icon %> <a href="<%= place.link %>"><%= place.text %></a> <%= '• #' + place.tag if place.tag %>
@@ -74,9 +76,11 @@ module INatChannel
         <%= icons[:place] %> <%= observation.place_guess %>
         <% end -%>
 
-        <%= taxon.to_tags.join(' • ') %>
+        <%= taxon.to_tags&.join(' • ') %>
       ERB
 
+      private_constant :DEFAULT_TEMPLATE
+
       def default
         @default ||= new(DEFAULT_TEMPLATE, {}).freeze
       end
@@ -88,3 +92,15 @@ module INatChannel
   end
 
 end
+
+module IC
+
+  def load_template path
+    INatChannel::Template::load path
+  end
+
+  def default_template
+    INatChannel::Template::default
+  end
+
+end

data/lib/inat-channel/version.rb

@@ -1,6 +1,11 @@
-
 module INatChannel
+  
+  VERSION = '0.9.0'
+
+end
 
-  VERSION = '0.8.2'
+module IC
+  
+  VERSION = INatChannel::VERSION
 
 end

data/lib/inat-channel.rb

@@ -8,4 +8,3 @@ require_relative 'inat-channel/api'
 require_relative 'inat-channel/message'
 require_relative 'inat-channel/telegram'
 
-INCh = INatChannel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inat-channel
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Ivan Shikhalev
@@ -107,34 +107,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-- !ruby/object:Gem::Dependency
-  name: tmpdir
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: 'iNaturalist Telegram Bot: Posts random popular observations from configurable
   API queries.'
 email: