reddit-to-telegram 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141226c6670a9b95e6ec4f7a9e74da982ed135ac22d57173c39625d4c1acfb11
-  data.tar.gz: 05c3a7b11a49162ed3742abfa3b2ea38a39048393133f9e1b16130b6c8c747ec
+  metadata.gz: '05893e8e006a0f401dbcec8e91cfd46be3cf3b53bbc1c9e89ccd95620db3087c'
+  data.tar.gz: 62ef80526ab1051177eafcab26de219b6d196262024c473dc53813fcbac32365
 SHA512:
-  metadata.gz: bca6427e5ab1fe8fd76f2e11f0b0101f624f37874915b056731385ba74f4b584aed9b7180b7ae380227db1745b15538ecdd2df4cdbf0c8b0f0ecabed17e571d5
-  data.tar.gz: bd53e70c0a7587af11fc27016e236205b4966ba5c4cd2bdfad1eedc72170abe035ad21945dc2c9933198608e8517053f7e467733cb36acf8c36c4efdcf198879
+  metadata.gz: 4319bf2ff9cbe27433514492093865c55ee65a77ef6d1eaae1a89376ea37cf0b16a998856b8f5c7ad21f7442d4ca2aca9f710d74fd40a7def9d8859f429d0dee
+  data.tar.gz: 58a917a293a78fdca894d5249114d26f19c79d27574ea02d3f412152aec321a45fb7ebc6672e63e46ebafcad5c3ed561867ace3420b15a1dd5b77d33d26ad392

data/README.md

@@ -7,7 +7,7 @@
 Beware, this is remotely not production-ready, API will change, you'll see lots of bugs and it may break at any time.
 Be sure to check for gem updates.
 
-You can set this bot up absolutely for free [via AWS Lambda](https://gist.github.com/dersnek/851c32a6b45eab19f1c8748095b2a481#file-free-rtt-bot-in-aws-lambda).
+You can set this bot up absolutely for free [via AWS Lambda](https://gist.github.com/dersnek/851c32a6b45eab19f1c8748095b2a481#file-free-rtt-bot-in-aws-lambda), no ruby knowledge required.
 
 ## Installation
 In your `Gemfile` add:
@@ -19,33 +19,34 @@ Then run `bundle install`.
 Or `gem install reddit-to-telegram`. Don't forget to `require` it.
 
 ## Prerequisites
+- [Obtain a telegram bot token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token)
 - (Optionally) You'll need an [AWS account](https://aws.amazon.com/) to host a free SimpleDB (best available storage type, also default one). I also recommend hosting the bot on AWS lambda, since it would be free.
 - (Optionally) [Create a Reddit app](https://www.reddit.com/prefs/apps), which would allow more requests to reddit
-- [Obtain a telegram bot token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token)
 
-To run it, you'll need some env variables set.
-| Variable Name                 | Description                                                                                                                                                                   | Required |
-| -------------                 | -----------                                                                                                                                                                   | -------- |
-| RTT_AWS_ACCESS_KEY_ID         | Your AWS access key ID. Needed for AWS SimpleDB storage                                                                                                                       | No       |
-| RTT_AWS_DOMAIN_NAME           | Domain name to use for SimpleDB                                                                                                                                               | No       |
-| RTT_AWS_REGION                | AWS region your SimpleDB will be hosted on. Beware, it's not available in all regions.                                                                                        | No       |
-| RTT_AWS_SECRET_ACCESS_KEY     | Your AWS access key ID. Needed for AWS SimpleDB storage.                                                                                                                      | No       |
-| RTT_GOOGLE_API_KEY            | Your Google API key to translate posts via Google Translate.                                                                                                                  | No       |
-| RTT_MAX_STORED_POSTS          | Number of posts to store in the database to avoid duplicates, default is 25.                                                                                                  | No       |
-| RTT_REDDIT_CLIENT_ID          | Reddit app credentials to access API. Reddit allows more authenticated requests.                                                                                              | No       |
-| RTT_REDDIT_CLIENT_SECRET      | Reddit app credentials to access API. Reddit allows more authenticated requests.                                                                                              | No       |
-| RTT_STORE_TYPE                | Choose between `aws_simple_db`, `memory` or `temp_file`. Default is `aws_simple_db`, so if you're not specifying your AWS credentials, you have to choose another store type. | No       |
-| RTT_TELEGRAM_BOT_TOKEN        | The token you've received when you've created a telegram bot.                                                                                                                 | Yes      |
-| RTT_TELEGRAM_ERROR_CHANNEL_ID | Telegram channel to send errors to (without `@`, only errors from Telegram API responses would be sent for now)                                                               | No       |
-| RTT_TEMP_DIR                  | Directory to write temp files to without trailing `/`                                                                                                                         | No       |
+It is pretty congifurable, either dynamically or via ENV variables.
+To assign variables dynamically, set them via `RedditToTelegram.config.variable_name= `, e.g. `RedditToTelegram.config.aws.access_key_id = ...`.
+You can also create an ENV variable with a corresponding name. Here is the full configuration explained. Required options have a * next to them.
 
-
-You can also set them dynamically:
-```
-RedditToTelegram.config.aws.access_key_id =
-RedditToTelegram.config.telegram.bot_token =
-```
-Check out `lib/configuration` for full configuration.
+Config variable           | Corresponding ENV Variable    | Description                                                                                                                                                                  |
+| ----------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+add_channel_handle        | -                             | Add channel handle to Telegram posts. Accepted values: true or false. Default is false                                                                                       |
+add_reddit_link           | -                             | Add reddit link to Telegram posts. Accepted values: true or false. Default is false.                                                                                         |
+logger                    | -                             | Which logger to use. You can pass your own ruby logger                                                                                                                       |
+on_error                  | -                             | What to do when an error happens. Default is :log, but you can also :raise or :ignore                                                                                        |
+send_errors_to_telegram   | -                             | Also log errors to telegram (besides regular logging). Accepted values: true or false, default is false                                                                      |
+translate                 | -                             | Translate posts via Google Translate. Leave empty for no translation. More details below                                                                                     |
+aws.access_key_id         | RTT_AWS_ACCESS_KEY_ID         | Your AWS access key ID. Needed for AWS SimpleDB storage                                                                                                                      |
+aws.domain_name           | RTT_AWS_DOMAIN_NAME           | Domain name to use for SimpleDB                                                                                                                                              |
+aws.region                | RTT_AWS_REGION                | AWS region your SimpleDB will be hosted on. Beware, it's not available in all regions.                                                                                       |
+aws.secret_access_key     | RTT_AWS_SECRET_ACCESS_KEY     | Your AWS access key ID. Needed for AWS SimpleDB storage.                                                                                                                     |
+google.api_key            | RTT_GOOGLE_API_KEY            | Your Google API key to translate posts via Google Translate                                                                                                                  |
+reddit.client_id          | RTT_REDDIT_CLIENT_ID          | Reddit app credentials to access API. Reddit allows more authenticated requests                                                                                              |
+reddit.client_secret      | RTT_REDDIT_CLIENT_SECRET      | Reddit app credentials to access API. Reddit allows more authenticated requests                                                                                              |
+store.max_stored_posts    | RTT_MAX_STORED_POSTS          | Number of posts to store in the database to avoid duplicates, default is 25                                                                                                  |
+store.tmp_dir             | RTT_TEMP_DIR                  | Directory to write temp files to without trailing `/`                                                                                                                        |
+store.type                | RTT_STORE_TYPE                | Choose between `aws_simple_db`, `memory` or `temp_file`. Default is `aws_simple_db`, so if you're not specifying your AWS credentials, you have to choose another store type |
+telegram.bot_token *      | RTT_TELEGRAM_BOT_TOKEN        | The token you've received when you've created a telegram bot                                                                                                                 |
+telegram.error_channel_id | RTT_TELEGRAM_ERROR_CHANNEL_ID | Telegram channel to send errors to (without `@`, only errors from Telegram API responses would be sent for now)                                                              |
 
 ## Usage
 
@@ -53,30 +54,19 @@ Check out `lib/configuration` for full configuration.
 2. To fetch latest hot post which hasn't been pushed yet:
 ```
 RedditToTelegram.hot(
-    subreddit_name_1: :telegram_channel_id_1,
-    subreddit_name_2: :telegram_channel_id_2
+    telegram_channel_id_1: :subreddit_name_1,
+    telegram_channel_id_2: :subreddit_name_2
   )
 ```
-Or to push one specific post (the only thing you need to set up for this is your telegram bot token):
+You can push posts from one subreddit to one telegram channel, several-to-one, one-to-several, several-to-several, whatever you like.
+You can also push one specific post:
 ```
-RedditToTelegram.from_link("regular_link_to_post", :telegram_channel_id)
+RedditToTelegram.from_link(telegram_channel_id: "regular_link_to_post")
 ```
 Use `:telegram_channel_id` without the `@`.
 
-### Options
+### Translation
 
-Translate option is supported. You will have to set up Google Translate API key and add it to env. You can find available languages in [Google Translate docs](https://cloud.google.com/translate/docs/languages).
-```
-RedditToTelegram.hot(
-    { subreddit_name_1: :telegram_channel_id_1 },
-    translate: :ja
-  )
-```
-You can also specify if you want to add reddit link or telegram channel handle to the post text. By default they won't be added.
-```
-RedditToTelegram.hot(
-    { subreddit_name_1: :telegram_channel_id_1 },
-    add_reddit_link: true,
-    add_channel_handle: true
-  )
-```
+Translation option is supported.
+You will have to set `RedditToTelegram.config.translate` to the language key you want to translate to. You can find available languages in [Google Translate docs](https://cloud.google.com/translate/docs/languages).
+You will also have to set up Google Translate API key assign it to `RedditToTelegram.config.google.api_key`.

data/lib/reddit_to_telegram/configuration.rb

@@ -5,7 +5,16 @@ require "logger"
 module RedditToTelegram
   module Configuration
     class << self
-      attr_writer :logger, :on_error
+      attr_writer :add_channel_handle, :add_reddit_link, :logger,
+                  :on_error, :send_errors_to_telegram, :translate
+
+      def add_channel_handle
+        @add_channel_handle ||= false
+      end
+
+      def add_reddit_link
+        @add_reddit_link ||= false
+      end
 
       def logger
         @logger ||= Logger.new($stdout).tap do |log|
@@ -16,6 +25,14 @@ module RedditToTelegram
       def on_error
         @on_error ||= :log
       end
+
+      def send_errors_to_telegram
+        @send_errors_to_telegram ||= false
+      end
+
+      def translate
+        @translate ||= nil
+      end
     end
 
     class Store

data/lib/reddit_to_telegram/errors.rb

@@ -3,19 +3,48 @@
 module RedditToTelegram
   class RedditToTelegramError < StandardError; end
 
+  class BadResponseFromTelegram < RedditToTelegramError; end
+  class FailedToFetchFromReddit < RedditToTelegramError; end
   class InvalidStoreType < RedditToTelegramError; end
   class MissingConfiguration < RedditToTelegramError; end
 
   class Errors
     class << self
       def new(error, message = nil)
+        log_message = error.to_s
+        log_message += ": #{message}" unless message.nil?
+
         if Configuration.on_error == :raise
           raise(error.new(message))
         elsif Configuration.on_error == :log
-          log_message = error.to_s
-          log_message += ": #{message}" unless message.nil?
           Configuration.logger.error(log_message)
         end
+
+        return unless Configuration.send_errors_to_telegram
+
+        push_error_to_telegram(log_message)
+
+        nil
+      end
+
+      private
+
+      def push_error_to_telegram(message)
+        if Configuration.telegram.error_channel_id.to_s.empty?
+          Configuration.logger.warn("Telegram Error Channel ID is not set up, can't send errors there")
+          return
+        end
+
+        Telegram::Post.push(
+          {
+            type: :text,
+            text: message,
+            misc: { no_retry: true, disable_link_preview: true }
+          },
+          Configuration.telegram.error_channel_id
+        )
+
+        nil
       end
     end
   end

data/lib/reddit_to_telegram/post.rb

@@ -3,29 +3,27 @@
 module RedditToTelegram
   class Post
     class << self
-      def hot(sources, opts = {})
+      def hot(sources)
         check_config
-        return if sources.empty?
-
         Store.setup
 
-        sources.each do |subreddit, telegram_chat_id|
+        sources.each do |telegram_chat_id, subreddit|
           res = Reddit::Fetch.hot(subreddit)
-          handle_res(res, subreddit, telegram_chat_id, opts)
+          handle_res(res, subreddit, telegram_chat_id)
         end
       end
 
-      def from_link(link, telegram_chat_id, opts = {})
+      def from_link(sources)
         check_config
-        return if link.empty?
+        return unless check_from_link_sources(sources)
 
         Configuration.store.type = :memory
         Store.setup
 
-        res = Reddit::Fetch.post(link)
+        res = Reddit::Fetch.post(sources.values.first)
         return unless res_ok?(res)
 
-        Telegram::Post.push(res, telegram_chat_id, opts)
+        Telegram::Post.push(res, sources.keys.first)
         res
       end
 
@@ -35,13 +33,17 @@ module RedditToTelegram
         Errors.new(MissingConfiguration, "Missing Telegram bot token") if Configuration.telegram.bot_token.to_s.empty?
       end
 
-      def handle_res(res, subreddit, telegram_chat_id, opts = {})
+      def handle_res(res, subreddit, telegram_chat_id)
         return unless res_ok?(res)
 
         post = find_new_post(subreddit, res)
-        return if post.nil?
 
-        res = Telegram::Post.push(post, telegram_chat_id, opts)
+        if post.nil?
+          Configuration.logger.info("Could not find a new post to push")
+          return
+        end
+
+        res = Telegram::Post.push(post, telegram_chat_id)
         Store::Posts.add(subreddit, post[:id])
         res
       end
@@ -50,7 +52,7 @@ module RedditToTelegram
         if res.nil?
           Configuration.logger.warn("Could not fetch Reddit post")
           false
-        elsif res[:type].nil?
+        elsif res.is_a?(Hash) && res[:type].nil?
           Configuration.logger.warn("Could not determine Reddit post type")
           false
         else
@@ -61,6 +63,15 @@ module RedditToTelegram
       def find_new_post(subreddit, posts)
         posts.find { |post| !Store::Posts.dup?(subreddit, post[:id]) }
       end
+
+      def check_from_link_sources(sources)
+        if !sources.is_a?(Hash) || sources.keys.count != 1 || sources.values.count != 1
+          Errors.new(ArgumentError, "Check documentation on usage")
+          return false
+        end
+
+        true
+      end
     end
   end
 end

data/lib/reddit_to_telegram/reddit/fetch.rb

@@ -55,12 +55,22 @@ module RedditToTelegram
             handle_429(func_name, func_args)
           when 200
             Output.format_response(res)
+          else
+            Errors.new(FailedToFetchFromReddit, res.to_s)
           end
         end
 
         def handle_401(func_name, func_args)
+          retries_left = func_args.last
+          func_args[func_args.length - 1] = retries_left - 1
+
           Store::Reddit.token = Auth.token
-          send(func_name, *func_args) if func_args.last > 0
+
+          if retries_left > 0
+            send(func_name, *func_args)
+          else
+            Errors.new(FailedToFetchFromReddit, "Failed to authenticate")
+          end
         end
 
         def handle_429(func_name, func_args)
@@ -68,7 +78,12 @@ module RedditToTelegram
 
           sleep(10 / retries_left) if retries_left > 0
           func_args[func_args.length - 1] = retries_left - 1
-          send(func_name, *func_args) if retries_left > 0
+
+          if retries_left > 0
+            send(func_name, *func_args)
+          else
+            Errors.new(FailedToFetchFromReddit, "Too many requests")
+          end
         end
       end
     end

data/lib/reddit_to_telegram/reddit/output.rb

@@ -97,7 +97,8 @@ module RedditToTelegram
 
         def base_post_format_attrs(data)
           { id: data["name"],
-            text: CGI.unescapeHTML(data["title"]) }
+            text: CGI.unescapeHTML(data["title"]),
+            misc: {} }
         end
 
         def prepare_gallery_links(data)

data/lib/reddit_to_telegram/telegram/post/gallery.rb

@@ -5,30 +5,30 @@ module RedditToTelegram
     class Post
       class Gallery
         class << self
-          def push_remaining_gallery_data(post, channel, res, opts = {})
+          def push_remaining_gallery_data(post, channel, res)
             if post[:additional_media]
-              push_remaining_gallery_images(post, channel, opts)
+              push_remaining_gallery_images(post, channel)
             else
-              push_gallery_caption(post, channel, res, opts)
+              push_gallery_caption(post, channel, res)
             end
           end
 
           private
 
-          def push_remaining_gallery_images(post, channel,opts = {})
+          def push_remaining_gallery_images(post, channel)
             post[:media] = post[:additional_media].first(10)
             remaining = post.delete(:additional_media).drop(10)
             post[:additional_media] = remaining unless remaining.empty?
-            Post.push(post, channel, opts)
+            Post.push(post, channel)
           end
 
-          def push_gallery_caption(post, channel, res, opts = {})
+          def push_gallery_caption(post, channel, res)
             Telegram::Post.push(
               { type: :text,
                 id: post[:id],
-                text: post[:text] },
-              channel,
-              opts.merge(gallery_caption_opts(res))
+                text: post[:text],
+                misc: gallery_caption_opts(res) },
+              channel
             )
           end
 

data/lib/reddit_to_telegram/telegram/post.rb

@@ -19,20 +19,20 @@ module RedditToTelegram
       }.freeze
 
       class << self
-        def push(post, channel, opts = {})
+        def push(post, channel)
           res = HTTParty.post(
             "#{BASE_URI}#{Configuration.telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
-            **params(post, channel, opts)
+            **params(post, channel)
           )
 
-          handle_response(post, channel, res, opts)
+          handle_response(post, channel, res)
         end
 
         private
 
-        def params(post, channel, opts = {})
+        def params(post, channel)
           binary = post.dig(:misc)&.dig(:binary)
-          body = PrepareRequest.body(post, channel, opts)
+          body = PrepareRequest.body(post, channel)
 
           pars = {
             body: binary ? body : body.to_json,
@@ -42,29 +42,16 @@ module RedditToTelegram
           pars
         end
 
-        def handle_response(post, channel, res, opts = {})
-          push_error(post, channel, res, opts) unless res["ok"] || opts[:no_retry]
-          Gallery.push_remaining_gallery_data(post, channel, res, opts) if post[:type] == :gallery
-          Video.delete_file if post[:type] == :video && post.dig(:misc)&.dig(:binary)
+        def handle_response(post, channel, res)
+          log_error(post, channel, res) unless res["ok"]
+          Gallery.push_remaining_gallery_data(post, channel, res) if post[:type] == :gallery
+          Video.delete_file if post[:type] == :video && post.dig(:misc, :binary)
           res
         end
 
-        def push_error(post, channel, res, opts = {})
-          return if Configuration.telegram.error_channel_id.to_s.empty?
-
-          push(
-            {
-              type: :text,
-              id: post[:id],
-              text: "Channel: @#{channel}\n\nResponse: #{res}"
-            },
-            Configuration.telegram.error_channel_id,
-            opts.merge(
-              add_reddit_link: true,
-              disable_link_preview: true,
-              no_retry: true
-            )
-          )
+        def log_error(post, channel, res)
+          message = "\n\nChannel: #{channel}\n\nPost data: #{post}\n\nResponse: #{res}"
+          Errors.new(BadResponseFromTelegram, message)
         end
       end
     end

data/lib/reddit_to_telegram/telegram/prepare_request.rb

@@ -4,54 +4,65 @@ module RedditToTelegram
   module Telegram
     class PrepareRequest
       class << self
-        def body(post, chat_id, opts = {})
-          body = prepare_body(post, chat_id, opts)
-          body[:link_preview_options] = { is_disabled: true } if opts[:disable_link_preview]
-          body[:reply_parameters] = { message_id: opts[:reply_to] } if opts[:reply_to]
+        def body(post, chat_id)
+          body = prepare_body(post, chat_id)
+          body[:link_preview_options] = { is_disabled: true } if post.dig(:misc, :disable_link_preview)
+          body[:reply_parameters] = { message_id: post[:misc][:reply_to] } if post.dig(:misc, :reply_to)
           body
         end
 
         private
 
-        def prepare_body(post, chat_id, opts = {})
+        def prepare_body(post, chat_id)
           case post[:type]
           when :image
-            { chat_id: "@#{chat_id}", photo: post[:media], caption: prepare_text(post, chat_id, opts) }
+            { chat_id: "@#{chat_id}", photo: post[:media], caption: prepare_text(post, chat_id) }
           when :gallery
-            { chat_id: "@#{chat_id}", media: prepare_gallery_media(post), caption: prepare_text(post, chat_id, opts) }
+            { chat_id: "@#{chat_id}", media: prepare_gallery_media(post), caption: prepare_text(post, chat_id) }
           when :gif
-            { chat_id: "@#{chat_id}", animation: post[:media], caption: prepare_text(post, chat_id, opts) }
+            { chat_id: "@#{chat_id}", animation: post[:media], caption: prepare_text(post, chat_id) }
           when :text
-            { chat_id: "@#{chat_id}", text: prepare_text(post, chat_id, opts) }
+            { chat_id: "@#{chat_id}", text: prepare_text(post, chat_id) }
           when :video
             {
               chat_id: "@#{chat_id}",
               video: prepare_video(post),
               height: post[:misc][:video_height],
               width: post[:misc][:video_width],
-              caption: prepare_text(post, chat_id, opts)
+              caption: prepare_text(post, chat_id)
             }
           end
         end
 
-        def prepare_text(post, chat_id, opts = {})
+        def prepare_text(post, chat_id)
           text = post[:text]
 
-          text = Services::Translate.text(text, opts[:translate]) if opts[:translate]
+          text = translate(text)
+          text = add_reddit_link(text, post)
+          add_channel_handle(text, chat_id)
+        end
 
-          if opts[:add_reddit_link]
-            id = post[:id].split("_")[1]
-            text += "\n\nhttps://redd.it/#{id}"
-          end
+        def translate(text)
+          return text unless Configuration.translate
 
-          if opts[:add_channel_handle]
-            text += opts[:add_reddit_link] ? "\n" : "\n\n"
-            text += "@#{chat_id}"
-          end
+          Services::Translate.text(text, Configuration.translate)
+        end
 
+        def add_reddit_link(text, post)
+          return text unless Configuration.add_reddit_link
+
+          id = post[:id]&.split("_")&.dig(1)
+          text += "\n\nhttps://redd.it/#{id}" if id
           text
         end
 
+        def add_channel_handle(text, chat_id)
+          return text unless Configuration.add_channel_handle
+
+          text += Configuration.add_reddit_link ? "\n" : "\n\n"
+          text + "@#{chat_id}"
+        end
+
         def prepare_gallery_media(post)
           Array(post[:media]).map { |link| { type: "photo", media: link } }
         end

data/lib/reddit_to_telegram/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedditToTelegram
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reddit-to-telegram
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Mark Tityuk