telepost 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72e3854ed2c2ef04727919095d396357f7cd91641387825a039d28cafdf819cf
-  data.tar.gz: 4ef6fe085695c41b615dbc31ce0c885c966ecd357e361625e91d74aad61a07a4
+  metadata.gz: bb2f082807cb2bf827333ccbaf2dbe286b46edd1ddd8518df9628c7507822dc3
+  data.tar.gz: bcd93a98a219b978a7673c49746b54dd8240bbbfa51c2a1749fd17d129a96455
 SHA512:
-  metadata.gz: 29ef8828ecfb355777daffb9a8a69fffd59b3393357bd60bc9b5012a9be6062c67ffd0660cd6d4bbd5c9a5effec7ef4a4c1bafbed5be7801b4494b935c1a3db2
-  data.tar.gz: 9e5aab74dccdca37292a2eb5959c2b24396cddfdd6189de47445ad0e48194efee77dbc3a7728303a70d1860f8f80984a9809794cdfecdf0440b5fb929d6effae
+  metadata.gz: 6a96040340518bec226b2ff447ac0d784e23785050de3c518c84369f64e265eba8225459d04405de64e2b877529d594f04597f8617689af6331f6d76f56c1d14
+  data.tar.gz: a1278e354d65fe8fbc9ae8adcea25ae851e6f10223ccfd735de47b8d39331982191b01b6abf76e79d593f235423d52f591715c3d28b828b78e46f243b3d53de0

data/Gemfile.lock

@@ -11,25 +11,25 @@ GEM
       public_suffix (>= 2.0.2, < 8.0)
     ansi (1.6.0)
     ast (2.4.3)
-    bigdecimal (4.1.0)
+    bigdecimal (4.1.2)
     builder (3.3.0)
-    concurrent-ruby (1.3.5)
+    concurrent-ruby (1.3.7)
     crack (1.0.1)
       bigdecimal
       rexml
     docile (1.4.1)
     drb (2.2.3)
-    dry-core (1.1.0)
+    dry-core (1.2.0)
       concurrent-ruby (~> 1.0)
       logger
       zeitwerk (~> 2.6)
-    dry-inflector (1.2.0)
+    dry-inflector (1.3.1)
     dry-logic (1.6.0)
       bigdecimal
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    dry-struct (1.8.0)
+    dry-struct (1.8.1)
       dry-core (~> 1.1)
       dry-types (~> 1.8, >= 1.8.2)
       ice_nine (~> 0.11)
@@ -41,26 +41,21 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    faraday (2.13.2)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-multipart (1.1.1)
+    faraday-multipart (1.2.0)
       multipart-post (~> 2.0)
-    faraday-net_http (3.4.1)
-      net-http (>= 0.5.0)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
     hashdiff (1.2.1)
     ice_nine (0.11.2)
-    json (2.19.2)
-    json-schema (6.2.0)
-      addressable (~> 2.8)
-      bigdecimal (>= 3.1, < 5)
-    language_server-protocol (3.17.0.5)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
-    mcp (0.9.2)
-      json-schema (>= 4.1)
-    minitest (6.0.5)
+    minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
     minitest-reporters (1.8.0)
@@ -69,10 +64,10 @@ GEM
       minitest (>= 5.0, < 7)
       ruby-progressbar
     multipart-post (2.4.1)
-    net-http (0.6.0)
-      uri
-    parallel (1.27.0)
-    parser (3.3.10.2)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    parallel (2.1.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
     prism (1.9.0)
@@ -80,33 +75,32 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.4.2)
-    regexp_parser (2.11.3)
+    regexp_parser (2.12.0)
     rexml (3.4.4)
-    rubocop (1.85.1)
-      json (~> 2.3)
+    rubocop (1.90.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      mcp (~> 0.6)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-elegant (0.0.20)
+    rubocop-elegant (0.5.1)
       lint_roller (~> 1.1)
       rubocop (~> 1.75)
-    rubocop-minitest (0.39.1)
+    rubocop-minitest (0.40.0)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
-    rubocop-performance (1.26.1)
+    rubocop-performance (1.27.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.75.0, < 2.0)
+      rubocop (>= 1.89.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
@@ -129,13 +123,13 @@ GEM
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
-    uri (1.0.4)
-    webmock (3.26.2)
+    uri (1.1.1)
+    webmock (3.26.3)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.43)
-    zeitwerk (2.7.3)
+    yard (0.9.45)
+    zeitwerk (2.8.2)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -37,7 +37,7 @@ tp.post(12345, 'How are you?', 'How are you doing?')
 All lines you provide to the `post()` method will be concatenated
 with a space between them.
 
-Or you can pre-configure it to talk to certain list of chats.
+Or you can pre-configure it to talk to a certain list of chats.
 Your bot has to be an admin of the channel, in order to post there.
 Here is how you "spam":
 
@@ -46,13 +46,25 @@ tp = Telepost.new('..token..', chats: [12345])
 tp.spam('How are you?')
 ```
 
-You can also attach a file (sent as a Telegram document). The
-`file` argument accepts a path or an already-open `IO`/`File`,
-and `caption:` is optional:
+You can also attach a file. The `file` argument accepts a path or
+an already-open `IO`/`File`, and `caption:` is optional. A file with
+an image extension goes out as a photo, which Telegram shows inline,
+while everything else goes out as a document:
 
 ```ruby
 tp = Telepost.new('..token..')
 tp.attach(12345, '/tmp/dump.sql', caption: 'Today is dump')
+tp.attach(12345, '/tmp/chart.png', caption: 'Today is chart')
+```
+
+You can also pass an array of files, to post them all as a single
+grouped message (a Telegram "album"). Files with an image extension
+are sent as photos, the rest as documents, and the `caption:` is
+shown once, on the first item:
+
+```ruby
+tp = Telepost.new('..token..')
+tp.attach(12345, ['/tmp/a.png', '/tmp/b.png'], caption: 'Two shots')
 ```
 
 That's it.

data/lib/telepost.rb

@@ -42,9 +42,22 @@ class Telepost
     end
 
     def attach(chat, file, caption: nil)
-      path = file.is_a?(String) ? file : file.path
-      tail = caption.nil? ? '' : " caption=#{caption}"
-      @sent << "#{chat}: [attach:#{File.basename(path)}#{tail}]"
+      @sent <<
+        if file.is_a?(Array)
+          "#{chat}: [attach-group:#{names(file)}#{cap(caption)}]"
+        else
+          "#{chat}: [attach:#{names([file])}#{cap(caption)}]"
+        end
+    end
+
+    private
+
+    def names(files)
+      files.map { |f| File.basename(f.is_a?(String) ? f : f.path) }.join(',')
+    end
+
+    def cap(caption)
+      caption.nil? ? '' : " caption=#{caption}"
     end
   end
 
@@ -108,22 +121,69 @@ class Telepost
     @bot.api.send_message(chat_id: chat, parse_mode:, disable_web_page_preview: true, text: lines.join(' '))
   end
 
-  # Attach a file (as a Telegram document) to the chat. The file
-  # argument can either be a path (String) or an open IO/File. The
-  # filename shown in Telegram comes from the basename of the path.
+  # Attach a file to the chat. The file argument can either be a
+  # path (String) or an open IO/File. The filename shown in Telegram
+  # comes from the basename of the path. A file with an image
+  # extension goes out as a photo via +sendPhoto+, so Telegram shows
+  # it inline, and everything else as a document via +sendDocument+.
+  #
+  # When +file+ is an +Array+, all of its items are posted as a single
+  # grouped message (a Telegram "album") via +sendMediaGroup+. Items
+  # with an image extension are wrapped in +InputMediaPhoto+, the rest
+  # in +InputMediaDocument+. The +caption+ is attached to the first
+  # item only, so the album shows one caption.
   #
   # @param chat [Integer, String] Chat ID or channel name
-  # @param file [String, File, IO] Path to the file or an open IO
+  # @param file [String, File, IO, Array] File (or array of files) to attach
   # @param caption [String, nil] Optional caption for the attachment
   # @param parse_mode [String] Parse mode used for the caption
   # @return [Telegram::Bot::Types::Message] The sent message object
   def attach(chat, file, caption: nil, parse_mode: 'Markdown')
-    document =
-      if file.is_a?(String)
-        Faraday::UploadIO.new(file, 'application/octet-stream', File.basename(file))
-      else
-        file
+    return album(chat, file, caption:, parse_mode:) if file.is_a?(Array)
+    io = upload(file)
+    if photo?(file)
+      @bot.api.send_photo(chat_id: chat, photo: io, caption:, parse_mode:)
+    else
+      @bot.api.send_document(chat_id: chat, document: io, caption:, parse_mode:)
+    end
+  ensure
+    io.close if file.is_a?(String) && io.respond_to?(:close)
+  end
+
+  PHOTO_EXTENSIONS = %w[.jpg .jpeg .png .gif .webp].freeze
+
+  private
+
+  def album(chat, files, caption: nil, parse_mode: 'Markdown')
+    opened = []
+    params = { chat_id: chat }
+    params[:media] =
+      files.each_with_index.map do |file, idx|
+        io = upload(file)
+        opened << io if file.is_a?(String)
+        params[:"file#{idx}"] = io
+        attrs = { media: "attach://file#{idx}" }
+        if idx.zero? && !caption.nil?
+          attrs[:caption] = caption
+          attrs[:parse_mode] = parse_mode
+        end
+        klass(file).new(**attrs)
       end
-    @bot.api.send_document(chat_id: chat, document:, caption:, parse_mode:)
+    @bot.api.send_media_group(**params)
+  ensure
+    opened.each(&:close)
+  end
+
+  def upload(file)
+    return file unless file.is_a?(String)
+    Faraday::UploadIO.new(file, 'application/octet-stream', File.basename(file))
+  end
+
+  def klass(file)
+    photo?(file) ? Telegram::Bot::Types::InputMediaPhoto : Telegram::Bot::Types::InputMediaDocument
+  end
+
+  def photo?(file)
+    PHOTO_EXTENSIONS.include?(File.extname(file.is_a?(String) ? file : file.path).downcase)
   end
 end

data/telepost.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
   s.required_ruby_version = '>=3.2'
   s.name = 'telepost'
-  s.version = '0.8.1'
+  s.version = '0.10.0'
   s.license = 'MIT'
   s.summary = 'Simple Telegram posting Ruby gem'
   s.description = 'Simple Telegram posting Ruby gem'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telepost
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Yegor Bugayenko