reddit-to-telegram 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3666d02e34ba14d6a7030a0e8cd11a6c6de74b71b6062e7df34e4856c5a7f98c
-  data.tar.gz: 8423e5fdb9fd749e06c1a672d36078824d5016bccaec15450a42fc3fc682417e
+  metadata.gz: 3cd7fa85cc2779888fb3ea2a3f778e0875ed0393021774c35c50d8e3c74b99bb
+  data.tar.gz: 2fe6776eea5999edb03316b26d664f084c7405664cac2b539c40254ed8632cbb
 SHA512:
-  metadata.gz: a5afa435363aaf50e0fdbee4fa878d752f99889c830dd842e1cae957db1d3ac362ba681f79158095d16a439626c423bbb2b895164bfc87685c87250cf38ca8f7
-  data.tar.gz: 0a72c0f8759303c1647dc3871e45349ae103ebfb099f40db32ddfd0cca1214eae5a74ec0ecf2b3f942623b98289ad0547c0c58e821780cfbce596238c9664c23
+  metadata.gz: 85f2191d33d580a8692b92e5d30c5a4e883f8e39e47f4a30054f95e971e7c26bf79b52770318a9cb9ad07dcad95a45b3531ba791dfe161c9bb31c4a0b289c63a
+  data.tar.gz: 963e0e776365e757fe051f33d91211a2189c6f0a1fd166964937a965ae93e8776e1bd4b6f1e1243a140d0530653b683d446cf6b562082eb90dc4dcaf929eb2e4

data/README.md

@@ -22,18 +22,20 @@ Or `gem install reddit-to-telegram`. Don't forget to `require` it.
 - [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.
-```
-RTT_AWS_ACCESS_KEY_ID= # (Optional) Your AWS access key ID. Needed for AWS SimpleDB storage.
-RTT_AWS_DOMAIN_NAME= # (Optional) Domain name to use for SimpleDB
-RTT_AWS_REGION= # (Optional) AWS region your SimpleDB will be hosted on. Beware, it's not available in all regions.
-RTT_AWS_SECRET_ACCESS_KEY= # (Optional) Your AWS access key ID. Needed for AWS SimpleDB storage.
-RTT_MAX_STORED_POSTS= # (Optional) Number of posts to store in the database to avoid duplicates, default is 25.
-RTT_REDDIT_CLIENT_ID= # Reddit app credentials to access API. Might not be needed depending on setup, reddit allows some requests without authentication.
-RTT_REDDIT_CLIENT_SECRET= # Reddit app credentials to access API. Might not be needed depending on setup, reddit allows some requests without authentication.
-RTT_STORE_TYPE= # (Optional) 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 specify another store type.
-RTT_TELEGRAM_BOT_TOKEN= # The token you've received when you've created a telegram bot.
-RTT_TEMP_DIR= (Optional) # Directory to write temp files to without trailing /
-```
+| 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_TEMP_DIR              | Directory to write temp files to without trailing `/`                                                                                                                         | No  |
+
 
 You can also set them dynamically:
 ```
@@ -57,3 +59,21 @@ Or to push one specific post (the only thing you need to set up for this is your
 RedditToTelegram.single("regular_link_to_post", :telegram_channel_id)
 ```
 Use `:telegram_channel_id` without the `@`.
+
+### Options
+
+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
+  )
+```

data/lib/reddit_to_telegram/post.rb

@@ -8,36 +8,37 @@ require_relative "variables"
 module RedditToTelegram
   class Post
     class << self
-      def hot(sources)
+      def hot(sources, opts = {})
         return if sources.empty?
 
         Store.setup
 
         sources.each do |subreddit, telegram_chat_id|
           res = Reddit::Fetch.hot(subreddit)
-          handle_res(res, subreddit, telegram_chat_id)
+          handle_res(res, subreddit, telegram_chat_id, opts)
         end
       end
 
-      def single(link, telegram_chat_id)
+      def single(link, telegram_chat_id, opts = {})
         return if link.empty?
 
         Variables.store.type = :memory
         Store.setup
 
         res = Reddit::Fetch.post(link)
-        Telegram::Post.push(res, telegram_chat_id)
+        Telegram::Post.push(res, telegram_chat_id, opts)
+        res
       end
 
       private
 
-      def handle_res(res, subreddit, telegram_chat_id)
+      def handle_res(res, subreddit, telegram_chat_id, opts = {})
         return if res.nil?
 
         post = find_new_post(subreddit, res)
         return if post.nil?
 
-        res = Telegram::Post.push(post, telegram_chat_id)
+        res = Telegram::Post.push(post, telegram_chat_id, opts)
         Store::Posts.add(subreddit, post[:id])
         res
       end

data/lib/reddit_to_telegram/reddit/fetch.rb

@@ -33,12 +33,15 @@ module RedditToTelegram
 
         def post(link, retries_left = 5)
           headers = BASE_HEADERS.merge("Authorization" => "Bearer #{Store::Reddit.token}")
+          link = link.gsub("www", "oauth") if link.match(/www.reddit.com/)
+          link += ".json" unless link.match(/.json/)
+
           res = HTTParty.get(
-            "#{link.gsub('www', 'oauth')}.json",
+            link,
             query: QUERY_FOR_POST,
             headers:
           )
-          handle_response(res, post: retries_left)
+          handle_response(res, post: [link, retries_left])
         end
 
         private

data/lib/reddit_to_telegram/services/translate.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "httparty"
+require_relative "../store"
+
+module RedditToTelegram
+  module Services
+    class Translate
+      include HTTParty
+
+      BASE_URI = "https://translation.googleapis.com/language/translate/v2"
+      HEADERS = { "Content-Type" => "application/json; charset=utf-8", "Accept" => "application/json" }.freeze
+
+      class << self
+        def text(string, target_language)
+          check
+
+          res = HTTParty.post(
+            BASE_URI,
+            body: body(string, target_language),
+            headers: HEADERS.merge(
+              "X-goog-api-key" => Variables.google.api_key
+            )
+          )
+          res.dig("data", "translations")&.first&.dig("translatedText")
+        end
+
+        private
+
+        def check
+          return if Variables.google.set_up?
+
+          raise(MissingVariables.new("Missing Google credentials. Set them up or disable translation"))
+        end
+
+        def body(string, target_language)
+          {
+            "q" => [string],
+            "source" => "en",
+            "target" => target_language,
+            "format" => "text"
+          }.to_json
+        end
+      end
+    end
+  end
+end

data/lib/reddit_to_telegram/telegram/post.rb

@@ -21,10 +21,10 @@ module RedditToTelegram
       }.freeze
 
       class << self
-        def push(post, channel)
+        def push(post, channel, opts = {})
           res = HTTParty.post(
             "#{BASE_URI}#{Variables.telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
-            **params(post, channel)
+            **params(post, channel, opts)
           )
 
           push({ type: :text, id: post[:id], text: post[:text] }, channel) if post[:type] == :gallery
@@ -34,9 +34,9 @@ module RedditToTelegram
 
         private
 
-        def params(post, channel)
+        def params(post, channel, opts = {})
           binary = post.dig(:misc)&.dig(:binary)
-          body = PrepareRequest.body(post, channel)
+          body = PrepareRequest.body(post, channel, opts)
 
           pars = {
             body: binary ? body : body.to_json,

data/lib/reddit_to_telegram/telegram/prepare_request.rb

@@ -1,35 +1,49 @@
 # frozen_string_literal: true
 
 require_relative "video"
+require_relative "../services/translate"
 
 module RedditToTelegram
   module Telegram
     class PrepareRequest
       class << self
-        def body(post, chat_id)
+        def body(post, chat_id, opts = {})
           case post[:type]
           when :image
-            { chat_id: "@#{chat_id}", photo: post[:media], caption: prepare_text(post, chat_id) }
+            { chat_id: "@#{chat_id}", photo: post[:media], caption: prepare_text(post, chat_id, opts) }
           when :gallery
-            { chat_id: "@#{chat_id}", media: prepare_gallery_media(post), caption: prepare_text(post, chat_id) }
+            { chat_id: "@#{chat_id}", media: prepare_gallery_media(post), caption: prepare_text(post, chat_id, opts) }
           when :text
-            { chat_id: "@#{chat_id}", text: prepare_text(post, chat_id) }
+            { chat_id: "@#{chat_id}", text: prepare_text(post, chat_id, opts) }
           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)
+              caption: prepare_text(post, chat_id, opts)
             }
           end
         end
 
         private
 
-        def prepare_text(post, chat_id)
-          id = post[:id].split("_")[1]
-          "#{post[:text]}\n\nhttps://redd.it/#{id}\n@#{chat_id}"
+        def prepare_text(post, chat_id, opts = {})
+          text = post[:text]
+
+          text = Services::Translate.text(text, opts[:translate]) if opts[:translate]
+
+          if opts[:add_reddit_link]
+            id = post[:id].split("_")[1]
+            text += "\n\nhttps://redd.it/#{id}"
+          end
+
+          if opts[:add_channel_handle]
+            text += opts[:add_reddit_link] ? "\n" : "\n\n"
+            text += "@#{chat_id}"
+          end
+
+          text
         end
 
         def prepare_gallery_media(post)

data/lib/reddit_to_telegram/variables.rb

@@ -7,6 +7,10 @@ module RedditToTelegram
         RedditToTelegram::Variables::AWS
       end
 
+      def google
+        RedditToTelegram::Variables::Google
+      end
+
       def reddit
         RedditToTelegram::Variables::Reddit
       end
@@ -65,7 +69,21 @@ module RedditToTelegram
         end
 
         def set_up?
-          ATTRS.all? { |a| !a.empty? }
+          ATTRS.all? { |a| !a.to_s.empty? }
+        end
+      end
+    end
+
+    class Google
+      class << self
+        attr_writer :api_key
+
+        def api_key
+          @api_key ||= ENV["RTT_GOOGLE_API_KEY"]
+        end
+
+        def set_up?
+          !api_key.to_s.empty?
         end
       end
     end

data/lib/reddit_to_telegram/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-to-telegram
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Tityuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-simpledb
@@ -71,6 +71,7 @@ files:
 - lib/reddit_to_telegram/reddit/fetch.rb
 - lib/reddit_to_telegram/reddit/output.rb
 - lib/reddit_to_telegram/reddit/output/imgur.rb
+- lib/reddit_to_telegram/services/translate.rb
 - lib/reddit_to_telegram/store.rb
 - lib/reddit_to_telegram/store/aws_simple_db.rb
 - lib/reddit_to_telegram/store/memory.rb