reddit-to-telegram 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c3e44dd622e534404baf7a42ecd2bfab3c6a61ae0fb662f9803e674c626dcf
-  data.tar.gz: f7f48164b5746abded0025b5025e0b295e7c4f3287b65d2d2a58fd04bd8a577b
+  metadata.gz: 141226c6670a9b95e6ec4f7a9e74da982ed135ac22d57173c39625d4c1acfb11
+  data.tar.gz: 05c3a7b11a49162ed3742abfa3b2ea38a39048393133f9e1b16130b6c8c747ec
 SHA512:
-  metadata.gz: e2e562fbb1831955bb921311e963c02ed3dbf6a05e46d93fb729a2604b15397f0dda97afee91c1fd967d83b5196a4ff311cf286b352e4e6cf5a59e15e2cb537d
-  data.tar.gz: 644e1ef22281b1ba0a97c419a321c1ec9f00e3e71b41d25c998a6e9a7820c60bff9e38c2eec7f514c23962671d7460ec546ac129d6f31a5fcda5ad4f0af010be
+  metadata.gz: bca6427e5ab1fe8fd76f2e11f0b0101f624f37874915b056731385ba74f4b584aed9b7180b7ae380227db1745b15538ecdd2df4cdbf0c8b0f0ecabed17e571d5
+  data.tar.gz: bd53e70c0a7587af11fc27016e236205b4966ba5c4cd2bdfad1eedc72170abe035ad21945dc2c9933198608e8517053f7e467733cb36acf8c36c4efdcf198879

data/README.md

@@ -7,6 +7,8 @@
 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).
+
 ## Installation
 In your `Gemfile` add:
 ```
@@ -40,10 +42,10 @@ To run it, you'll need some env variables set.
 
 You can also set them dynamically:
 ```
-RedditToTelegram::Variables.aws.access_key_id =
-RedditToTelegram::Variables.telegram.bot_token =
+RedditToTelegram.config.aws.access_key_id =
+RedditToTelegram.config.telegram.bot_token =
 ```
-Check out `lib/variables` for list of all available variables.
+Check out `lib/configuration` for full configuration.
 
 ## Usage
 
@@ -57,7 +59,7 @@ RedditToTelegram.hot(
 ```
 Or to push one specific post (the only thing you need to set up for this is your telegram bot token):
 ```
-RedditToTelegram.single("regular_link_to_post", :telegram_channel_id)
+RedditToTelegram.from_link("regular_link_to_post", :telegram_channel_id)
 ```
 Use `:telegram_channel_id` without the `@`.
 

data/lib/reddit-to-telegram.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "reddit_to_telegram/post"
-require_relative "reddit_to_telegram/version"
+Dir["#{File.dirname(__FILE__)}/reddit_to_telegram/**/*.rb"].each { |file| require file }
 
 module RedditToTelegram
   class << self
     extend Forwardable
 
-    def_delegators :post, :hot, :single
+    def_delegators :post, :hot, :from_link
 
     def post
       Post
     end
 
+    def config
+      Configuration
+    end
+
     def version
       VERSION
     end

data/lib/reddit_to_telegram/{variables.rb → configuration.rb}

@@ -1,26 +1,20 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module RedditToTelegram
-  module Variables
+  module Configuration
     class << self
-      def aws
-        RedditToTelegram::Variables::AWS
-      end
-
-      def google
-        RedditToTelegram::Variables::Google
-      end
-
-      def reddit
-        RedditToTelegram::Variables::Reddit
-      end
+      attr_writer :logger, :on_error
 
-      def store
-        RedditToTelegram::Variables::Store
+      def logger
+        @logger ||= Logger.new($stdout).tap do |log|
+          log.progname = "RedditToTelegram"
+        end
       end
 
-      def telegram
-        RedditToTelegram::Variables::Telegram
+      def on_error
+        @on_error ||= :log
       end
     end
 
@@ -115,5 +109,19 @@ module RedditToTelegram
         end
       end
     end
+
+    class << self
+      NESTED_CONFIG = {
+        aws: AWS,
+        google: Google,
+        reddit: Reddit,
+        store: Store,
+        telegram: Telegram
+      }.freeze
+
+      NESTED_CONFIG.each do |key, value|
+        define_method(key) { value }
+      end
+    end
   end
 end

data/lib/reddit_to_telegram/errors.rb

@@ -2,6 +2,21 @@
 
 module RedditToTelegram
   class RedditToTelegramError < StandardError; end
+
   class InvalidStoreType < RedditToTelegramError; end
-  class MissingVariables < RedditToTelegramError; end
+  class MissingConfiguration < RedditToTelegramError; end
+
+  class Errors
+    class << self
+      def new(error, 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
+      end
+    end
+  end
 end

data/lib/reddit_to_telegram/post.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "reddit/fetch"
-require_relative "store"
-require_relative "telegram/post"
-require_relative "variables"
-
 module RedditToTelegram
   class Post
     class << self
       def hot(sources, opts = {})
+        check_config
         return if sources.empty?
 
         Store.setup
@@ -19,21 +15,28 @@ module RedditToTelegram
         end
       end
 
-      def single(link, telegram_chat_id, opts = {})
+      def from_link(link, telegram_chat_id, opts = {})
+        check_config
         return if link.empty?
 
-        Variables.store.type = :memory
+        Configuration.store.type = :memory
         Store.setup
 
         res = Reddit::Fetch.post(link)
+        return unless res_ok?(res)
+
         Telegram::Post.push(res, telegram_chat_id, opts)
         res
       end
 
       private
 
+      def check_config
+        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 = {})
-        return if res.nil?
+        return unless res_ok?(res)
 
         post = find_new_post(subreddit, res)
         return if post.nil?
@@ -43,6 +46,18 @@ module RedditToTelegram
         res
       end
 
+      def res_ok?(res)
+        if res.nil?
+          Configuration.logger.warn("Could not fetch Reddit post")
+          false
+        elsif res[:type].nil?
+          Configuration.logger.warn("Could not determine Reddit post type")
+          false
+        else
+          true
+        end
+      end
+
       def find_new_post(subreddit, posts)
         posts.find { |post| !Store::Posts.dup?(subreddit, post[:id]) }
       end

data/lib/reddit_to_telegram/reddit/auth.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "httparty"
-require_relative "../variables"
 
 module RedditToTelegram
   module Reddit
@@ -18,7 +17,7 @@ module RedditToTelegram
             URI,
             body: PARAMS,
             headers: HEADERS,
-            basic_auth: { username: Variables.reddit.client_id, password: Variables.reddit.client_secret }
+            basic_auth: { username: Configuration.reddit.client_id, password: Configuration.reddit.client_secret }
           )["access_token"]
         end
       end

data/lib/reddit_to_telegram/reddit/fetch.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 require "httparty"
-require_relative "auth"
-require_relative "output"
-require_relative "../store"
-require_relative "../variables"
 
 module RedditToTelegram
   module Reddit
@@ -14,7 +10,7 @@ module RedditToTelegram
       BASE_URI = "https://oauth.reddit.com/r"
       WEBSITE_URI = "https://www.reddit.com/r"
       QUERY_FOR_POST = { g: "GLOBAL" }.freeze
-      QUERY_FOR_SUBREDDIT = QUERY_FOR_POST.merge(limit: Variables.store.max_stored_posts).freeze
+      QUERY_FOR_SUBREDDIT = QUERY_FOR_POST.merge(limit: Configuration.store.max_stored_posts).freeze
       BASE_HEADERS = {
         "Content-Type" => "application/json",
         "Accept" => "application/json"
@@ -28,6 +24,7 @@ module RedditToTelegram
             query: QUERY_FOR_SUBREDDIT,
             headers:
           )
+
           handle_response(res, hot: [subreddit, retries_left])
         end
 
@@ -41,6 +38,7 @@ module RedditToTelegram
             query: QUERY_FOR_POST,
             headers:
           )
+
           handle_response(res, post: [link, retries_left])
         end
 

data/lib/reddit_to_telegram/reddit/output/imgur.rb

@@ -43,7 +43,7 @@ module RedditToTelegram
           end
 
           def format_imgur_post(data, video_url, width)
-            RedditToTelegram::Reddit::Output.send(
+            Reddit::Output.send(
               :base_post_format_attrs, data
             ).merge(
               {

data/lib/reddit_to_telegram/reddit/output.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "cgi"
-require_relative "output/imgur"
 
 module RedditToTelegram
   module Reddit
@@ -23,6 +22,12 @@ module RedditToTelegram
 
         def format_post(post)
           data = post["data"]
+
+          unless data["removed_by_category"].nil?
+            Configuration.logger.warn("Reddit post was removed")
+            return
+          end
+
           if data["post_hint"] == "image"
             format_image_post(data)
           elsif data["post_hint"] == "link"
@@ -49,7 +54,7 @@ module RedditToTelegram
 
           base_post_format_attrs(data).merge(
             { type: :text,
-              text: "#{data['title']}\n\n#{data['url']}" }
+              text: "#{CGI.unescapeHTML(data['title'])}\n\n#{data['url']}" }
           )
         end
 

data/lib/reddit_to_telegram/services/translate.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "httparty"
-require_relative "../store"
 
 module RedditToTelegram
   module Services
@@ -19,7 +18,7 @@ module RedditToTelegram
             BASE_URI,
             body: body(string, target_language),
             headers: HEADERS.merge(
-              "X-goog-api-key" => Variables.google.api_key
+              "X-goog-api-key" => Configuration.google.api_key
             )
           )
           res.dig("data", "translations")&.first&.dig("translatedText")
@@ -28,9 +27,9 @@ module RedditToTelegram
         private
 
         def check
-          return if Variables.google.set_up?
+          return if Configuration.google.set_up?
 
-          raise(MissingVariables.new("Missing Google credentials. Set them up or disable translation"))
+          Errors.new(MissingConfiguration, "Missing Google credentials. Set them up or disable translation")
         end
 
         def body(string, target_language)

data/lib/reddit_to_telegram/store/aws_simple_db.rb

@@ -2,8 +2,6 @@
 
 require "aws-sdk-simpledb"
 require "json"
-require_relative "../errors"
-require_relative "../variables"
 
 module RedditToTelegram
   module Store
@@ -13,9 +11,9 @@ module RedditToTelegram
       class << self
         def client
           @client ||= Aws::SimpleDB::Client.new(
-            access_key_id: Variables.aws.access_key_id,
-            secret_access_key: Variables.aws.secret_access_key,
-            region: Variables.aws.region
+            access_key_id: Configuration.aws.access_key_id,
+            secret_access_key: Configuration.aws.secret_access_key,
+            region: Configuration.aws.region
           )
         end
 
@@ -25,17 +23,19 @@ module RedditToTelegram
 
         def setup
           check_credentials
-          create_domain unless client.list_domains.domain_names.include?(Variables.aws.domain_name)
+          create_domain unless client.list_domains.domain_names.include?(Configuration.aws.domain_name)
           read_db
         end
 
         def check_credentials
-          return unless Variables.store.type == :aws_simple_db
+          return unless Configuration.store.type == :aws_simple_db
 
-          return if Variables.aws.set_up?
+          return if Configuration.aws.set_up?
 
-          raise(MissingVariables.new("Missing AWS credentials. "\
-            "Set them up or change store type to anything other than aws_simple_db"))
+          Errors.new(
+            MissingConfiguration,
+            "Missing AWS credentials. Set them up or change store type to anything other than aws_simple_db"
+          )
         end
 
         def reddit_token=(val)
@@ -59,7 +59,7 @@ module RedditToTelegram
         def read_db
           res = client.get_attributes(
             {
-              domain_name: Variables.aws.domain_name,
+              domain_name: Configuration.aws.domain_name,
               item_name: "cached_data",
               consistent_read: true
             }
@@ -81,7 +81,7 @@ module RedditToTelegram
         def write_db
           client.put_attributes(
             {
-              domain_name: Variables.aws.domain_name,
+              domain_name: Configuration.aws.domain_name,
               item_name: ITEM_NAME,
               attributes: prepare_db_attrs
             }
@@ -113,9 +113,9 @@ module RedditToTelegram
           res = client.list_domains
           return unless res.successful?
 
-          return if res.domain_names.include?(Variables.aws.domain_name)
+          return if res.domain_names.include?(Configuration.aws.domain_name)
 
-          client.create_domain({ domain_name: Variables.aws.domain_name })
+          client.create_domain({ domain_name: Configuration.aws.domain_name })
         end
       end
     end

data/lib/reddit_to_telegram/store/temp_file.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "../variables"
 
 module RedditToTelegram
   module Store
@@ -62,7 +61,7 @@ module RedditToTelegram
         end
 
         def temp_file_path
-          "#{Variables.store.tmp_dir}/store.json"
+          "#{Configuration.store.tmp_dir}/store.json"
         end
       end
     end

data/lib/reddit_to_telegram/store.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "errors"
-require_relative "store/aws_simple_db"
-require_relative "store/memory"
-require_relative "store/temp_file"
-require_relative "variables"
-
 module RedditToTelegram
   module Store
-    MAX_STORED_POSTS = Variables.store.max_stored_posts - 1
+    MAX_STORED_POSTS = Configuration.store.max_stored_posts - 1
     CLASS_MAP = {
       aws_simple_db: "RedditToTelegram::Store::AWSSimpleDB",
       memory: "RedditToTelegram::Store::Memory",
@@ -21,9 +15,9 @@ module RedditToTelegram
       attr_accessor :active
 
       def setup
-        raise(InvalidStoreType.new) unless CLASS_MAP.keys.include?(Variables.store.type)
+        Errors.new(InvalidStoreType) unless CLASS_MAP.keys.include?(Configuration.store.type)
 
-        self.active = Object.const_get(CLASS_MAP[RedditToTelegram::Variables.store.type])
+        self.active = Object.const_get(CLASS_MAP[Configuration.store.type])
         active.send(:setup)
       end
     end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../post"
-
 module RedditToTelegram
   module Telegram
     class Post
@@ -25,7 +23,7 @@ module RedditToTelegram
           end
 
           def push_gallery_caption(post, channel, res, opts = {})
-            Post.push(
+            Telegram::Post.push(
               { type: :text,
                 id: post[:id],
                 text: post[:text] },

data/lib/reddit_to_telegram/telegram/post.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 require "httparty"
-require_relative "post/gallery"
-require_relative "prepare_request"
-require_relative "video"
-require_relative "../variables"
 
 module RedditToTelegram
   module Telegram
@@ -25,7 +21,7 @@ module RedditToTelegram
       class << self
         def push(post, channel, opts = {})
           res = HTTParty.post(
-            "#{BASE_URI}#{Variables.telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
+            "#{BASE_URI}#{Configuration.telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
             **params(post, channel, opts)
           )
 
@@ -54,7 +50,7 @@ module RedditToTelegram
         end
 
         def push_error(post, channel, res, opts = {})
-          return if Variables.telegram.error_channel_id.to_s.empty?
+          return if Configuration.telegram.error_channel_id.to_s.empty?
 
           push(
             {
@@ -62,7 +58,7 @@ module RedditToTelegram
               id: post[:id],
               text: "Channel: @#{channel}\n\nResponse: #{res}"
             },
-            Variables.telegram.error_channel_id,
+            Configuration.telegram.error_channel_id,
             opts.merge(
               add_reddit_link: true,
               disable_link_preview: true,

data/lib/reddit_to_telegram/telegram/prepare_request.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "video"
-require_relative "../services/translate"
-
 module RedditToTelegram
   module Telegram
     class PrepareRequest

data/lib/reddit_to_telegram/telegram/video.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "open-uri"
-require_relative "../variables"
 
 module RedditToTelegram
   module Telegram
@@ -23,7 +22,7 @@ module RedditToTelegram
         end
 
         def temp_video_path
-          "#{Variables.store.tmp_dir}/video.mp4"
+          "#{Configuration.store.tmp_dir}/video.mp4"
         end
       end
     end

data/lib/reddit_to_telegram/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-to-telegram
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Mark Tityuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-simpledb
@@ -66,6 +66,7 @@ files:
 - LICENSE
 - README.md
 - lib/reddit-to-telegram.rb
+- lib/reddit_to_telegram/configuration.rb
 - lib/reddit_to_telegram/errors.rb
 - lib/reddit_to_telegram/post.rb
 - lib/reddit_to_telegram/reddit/auth.rb
@@ -81,7 +82,6 @@ files:
 - lib/reddit_to_telegram/telegram/post/gallery.rb
 - lib/reddit_to_telegram/telegram/prepare_request.rb
 - lib/reddit_to_telegram/telegram/video.rb
-- lib/reddit_to_telegram/variables.rb
 - lib/reddit_to_telegram/version.rb
 - reddit-to-telegram.gemspec
 - tmp/.keep