inat-channel 0.8.0.14 → 0.9.0

data/lib/inat-channel/message.rb

@@ -1,7 +1,9 @@
 require 'set'
 require 'sanitize'
+
 require_relative 'config'
 require_relative 'icons'
+require_relative 'template'
 
 module INatChannel
 
@@ -10,12 +12,12 @@ module INatChannel
     class << self
 
       def make_message observation
-        [
-          taxon_title(observation[:taxon]),
-          observation_block(observation),
-          "#{INatChannel::Icons::ICONS[:location]} #{geo_link(observation)}\n" + (place_block(observation[:place_ids]) || observation[:place_guess]),
-          ancestors_block(observation)
-        ].join("\n\n")
+        template = if IC::CONFIG.dig(:tg_bot, :template)
+          IC::load_template IC::CONFIG.dig(:tg_bot, :template)
+        else
+          IC::default_template
+        end
+        template.process observation
       end
 
       def list_photos observation
@@ -23,117 +25,23 @@ module INatChannel
         observation[:photos].map { |ph| ph[:url].gsub("square", "large") }
       end
 
-      private
-
-      def taxon_title taxon
-        icon = INatChannel::Icons::taxon_icon taxon
-        link = "https://www.inaturalist.org/taxa/#{taxon[:id]}"
-
-        common_name = taxon[:preferred_common_name]
-        scientific_name = taxon[:name]
-
-        title = if common_name
-            "<b>#{common_name}</b> <i>(#{scientific_name})</i>"
-          else
-            "<b><i>#{scientific_name}</i></b>"
-          end
-
-        "#{icon} <a href='#{link}'>#{title}</a>"
-      end
-
-      def observation_block observation
-        user = observation[:user]
-        user_title = if user[:name] && !user[:name].empty?
-          user[:name] 
-        else
-          "<code>#{user[:login]}</code>"
-        end
-        user_link = "https://www.inaturalist.org/people/#{user[:login]}"
-        observation_part = "#{INatChannel::Icons::ICONS[:observation]} <a href='#{observation[:uri]}'><b>\##{observation[:id]}</b></a>"
-        user_part = "#{INatChannel::Icons::ICONS[:user]} <a href='#{user_link}'>#{user_title}</a>"
-        date_part = "#{INatChannel::Icons::ICONS[:calendar]} #{observation[:observed_on_string]}"
-        description = observation[:description] && Sanitize.fragment(observation[:description])
-        description_part = if description && !description.empty?
-            "\n#{INatChannel::Icons::ICONS[:description]} #{limit_text(description, 500)}"
-          else
-            ""
-          end
-        "#{observation_part}\n#{date_part}\n#{user_part}#{description_part}"
-      end
-
-      def limit_text text, limit
-        return text if text.length <= limit
-        truncated = text[0, limit]
-        last_space = truncated.rindex(/\s/)
-        last_sign = truncated.rindex(/[,.;:!?]/)
-        if last_space
-          if last_sign && last_sign + 1 > last_space
-            return truncated[0, last_sign + 1] + '...'
-          end
-          return truncated[0, last_space] + '...'
-        else
-          if last_sign
-            return truncated[0, last_sign + 1] + '...'
-          end
-          return truncated + '...'
-        end
-      end
-
-      def place_block place_ids
-        return nil unless CONFIG[:places]
-
-        place_ids = Set[*place_ids]
-        found = []
-        CONFIG[:places].each do |_, list|
-          list.each do |item|
-            item_ids = Set[*item[:place_ids]]
-            if place_ids.intersect?(item_ids)
-              found << item
-              break
-            end
-          end
-        end
-
-        if found.empty?
-          nil
-        else
-          found.map { |i| "#{INatChannel::Icons::ICONS[:place]} <a href='#{i[:link]}'>#{i[:text]}</a>" }.join("\n")
-        end
-      end
-
-      def ancestors_block observation
-        taxon_id = observation[:taxon][:id]
-        ancestors = nil
-        observation[:identifications].each do |ident|
-          it = ident[:taxon]
-          if it[:id] == taxon_id
-            ancestors = it[:ancestors]
-            break
-          end
-        end
-
-        if ancestors
-          (ancestors.map { |a| name_to_hashtag(a[:name]) } + [name_to_hashtag(observation[:taxon][:name])]).join(" • ")
-        else
-          # TODO: load ancestors with new query...
-          nil
-        end
-      end
+    end
 
-      def name_to_hashtag name
-        "\##{name.gsub(".", "").gsub("-", "").gsub(" ", "_")}"
-      end
+  end
 
-      def geo_link observation
-        return nil unless observation[:geojson]&.[](:coordinates) && observation[:geojson][:type] == "Point"
+end
 
-        lon, lat = observation[:geojson][:coordinates]
-        url = "https://maps.google.com/?q=#{lat},#{lon}"
-        "<a href='#{url}'>#{lat.round(4)}°N, #{lon.round(4)}°E</a>"
-      end
+module IC
 
-    end
+  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

@@ -0,0 +1,106 @@
+require 'yaml'
+require 'erb'
+
+require_relative 'data_types'
+require_relative 'data_convert'
+
+module INatChannel
+
+  class Template
+
+    attr_reader :template, :data
+
+    def initialize template, data
+      @template = template
+      @data = data
+      @renderer = ERB::new @template, trim_mode: '-'
+      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 = IC::convert_observation observation_source
+      vars = {
+        observation: observation,
+        datetime: observation.datetime,
+        location: observation.location,
+        places: observation.places,
+        taxon: observation.taxon,
+        user: observation.user,
+        date: observation.date,
+        time: observation.time,
+        icons: IC::ICONS,
+        taxa_icons: IC::TAXA_ICONS,
+        config: IC::CONFIG,
+        data: @data
+      }
+      @renderer.result_with_hash vars
+    end
+
+    class << self
+
+      def load path
+        content = File.read path
+        if content.lines(chomp: true).first == '---'
+          docs = content.split(/^---\n/m, 3)
+          data = if docs[0].strip.empty? && docs[1]
+            YAML.safe_load docs[1], symbolize_names: true
+          else
+            YAML.safe_load docs[0], symbolize_names: true
+          end || {}
+          template = docs[2] || docs[1] || content
+        else
+          data = {}
+          template = content
+        end
+        new(template, data)
+      end
+
+      DEFAULT_TEMPLATE = <<~ERB
+        <%= taxon.icon %> <a href="<%= taxon.url %>"><%= taxon.title %></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.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 %>
+        <%   end -%>
+        <% else -%>
+        <%= icons[:place] %> <%= observation.place_guess %>
+        <% end -%>
+
+        <%= taxon.to_tags&.join(' • ') %>
+      ERB
+
+      private_constant :DEFAULT_TEMPLATE
+
+      def default
+        @default ||= new(DEFAULT_TEMPLATE, {}).freeze
+      end
+
+      private :new
+
+    end
+
+  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.0.14'
+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.0.14
+  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:
@@ -151,11 +123,14 @@ files:
 - lib/inat-channel/api.rb
 - lib/inat-channel/config.rb
 - lib/inat-channel/data.rb
+- lib/inat-channel/data_convert.rb
+- lib/inat-channel/data_types.rb
 - lib/inat-channel/icons.rb
 - lib/inat-channel/lock.rb
 - lib/inat-channel/logger.rb
 - lib/inat-channel/message.rb
 - lib/inat-channel/telegram.rb
+- lib/inat-channel/template.rb
 - lib/inat-channel/version.rb
 homepage: https://github.com/inat-get/inat-channel
 licenses: