reddit-to-telegram 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ec45bcf41a275baa3ea712968010d520b4af973a78149837ebe4cbc0b4c3870
-  data.tar.gz: 328805f68a80798c6c9c3a26fbd00aac37560ac97d55b601df9471b0587c2a31
+  metadata.gz: e6c7b26fa99c0cd58ee1e6bc13e4bc357d20aa30c3efbc4ca1df02a75948afbc
+  data.tar.gz: '00183a34218ed5e32012af4b7614438bec200ecf1443cb3a5f4db649aa8dac19'
 SHA512:
-  metadata.gz: 7184c7bddf2027cfef0bd40ddd90a044e309482b1467d1ab942114d43d4b6c4b7c03d2081a06035ba4b408d82aa19c64ba28d74d5ef98c03f58399153e61dbe3
-  data.tar.gz: e46c030bd186fbef1185970769d8d9263849e2b8048c043ca5b7ffa28c9a5b7d4e980fde260ee705ae2358419c7c581ebba458e620c68c3742541bc511dbdaae
+  metadata.gz: 1f5a3a2c3d03f37ff932245225e84c7ffd35c79051db95816598323456e95fa88ab710f66f1b01e9927b897db4df2227cc1a44673431e0eee655be8f5bde897a
+  data.tar.gz: 43a98d11dc600a57ede04ff2d6279373a3965be64b27084d761e9ffc3f943f4e94147e0f0293504d33ad6ae857ef4cb117f1a0c53964157b533f4240efe62d63

data/.rubocop.yml

@@ -12,3 +12,6 @@ Style/SingleArgumentDig:
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reddit-to-telegram (0.0.0)
+    reddit-to-telegram (0.2.1)
       aws-sdk-simpledb
       httparty
 

data/README.md

@@ -21,32 +21,27 @@ Or `gem install reddit-to-telegram`, but don't forget to `require` it first then
 - (Optionally) Create a Reddit app, which would allow more requests to reddit
 - [Obtain](https://core.telegram.org/bots/tutorial#obtain-your-bot-token) a telegram bot token
 
-## Installation
 To run it, you'll need some env variables set.
 ```
 RTT_AWS_ACCESS_KEY_ID= # Your AWS access key ID. Needed for AWS SimpleDB storage.
+RTT_AWS_DOMAIN_NAME= # (Optional) Domain name to use for SimpleDB
 RTT_AWS_REGION= # AWS region your SimpleDB will be hosted on. Beware, it's not available in all regions.
 RTT_AWS_SECRET_ACCESS_KEY= # 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
 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 /
 ```
 
 You can also set them dynamically:
 ```
-RedditToTelegram::Vars.assign_values(
-  max_stored_posts:,
-  tmp_dir:
-  aws_access_key_id:,
-  aws_secret_access_key:,
-  aws_region:,
-  reddit_client_id:,
-  reddit_client_secret:,
-  telegram_bot_token:
-)
+RedditToTelegram::Variables.aws.aws_access_key_id =
+RedditToTelegram::Variables.telegram.bot_token =
 ```
+Check out `lib/variables` for list of all available variables.
+
 ## Usage
 
 1. Add the bot as administrator to Telegram channels you'd like to post to.

data/lib/reddit-to-telegram.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pry"
+
 require_relative "reddit_to_telegram/reddit/fetch"
 require_relative "reddit_to_telegram/store"
 require_relative "reddit_to_telegram/telegram/post"
@@ -18,6 +20,8 @@ module RedditToTelegram
       end
     end
 
+    private
+
     def handle_res(res, subreddit, telegram_chat_id)
       return if res.nil?
 

data/lib/reddit_to_telegram/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RedditToTelegram
+  class RedditToTelegramError < StandardError; end
+  class InvalidStoreType < RedditToTelegramError; end
+end

data/lib/reddit_to_telegram/reddit/auth.rb

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

data/lib/reddit_to_telegram/reddit/fetch.rb

@@ -4,7 +4,7 @@ require "httparty"
 require_relative "auth"
 require_relative "output"
 require_relative "../store"
-require_relative "../vars"
+require_relative "../variables"
 
 module RedditToTelegram
   module Reddit
@@ -12,7 +12,7 @@ module RedditToTelegram
       include HTTParty
 
       BASE_URI = "https://oauth.reddit.com/r"
-      QUERY = { g: "GLOBAL", limit: Vars.max_stored_posts }.freeze
+      QUERY = { g: "GLOBAL", limit: Variables.store.max_stored_posts }.freeze
       BASE_HEADERS = {
         "Content-Type" => "application/json",
         "Accept" => "application/json"
@@ -29,6 +29,8 @@ module RedditToTelegram
           handle_response(res, subreddit, retries_left)
         end
 
+        private
+
         def handle_response(res, subreddit, retries_left)
           case res.code
           when 401

data/lib/reddit_to_telegram/reddit/output.rb

@@ -10,6 +10,8 @@ module RedditToTelegram
           posts.map { |post| format_post(post) }.compact
         end
 
+        private
+
         def format_post(post)
           data = post["data"]
           if data["post_hint"] == "image"

data/lib/reddit_to_telegram/store/aws_simple_db.rb

@@ -2,19 +2,28 @@
 
 require "aws-sdk-simpledb"
 require "json"
-require_relative "../vars"
+require_relative "../variables"
 
 module RedditToTelegram
   module Store
     class AWSSimpleDB
-      DOMAIN_NAME = "reddit_to_telegram"
       ITEM_NAME = "cached_data"
 
       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
+          )
+        end
+
+        private
+
         attr_reader :reddit_token
 
         def setup
-          create_domain unless client.list_domains.domain_names.include?(DOMAIN_NAME)
+          create_domain unless client.list_domains.domain_names.include?(Variables.aws.domain_name)
           read_db
         end
 
@@ -36,18 +45,10 @@ module RedditToTelegram
           @posts[subreddit].include?(id)
         end
 
-        def client
-          @client ||= Aws::SimpleDB::Client.new(
-            access_key_id: Vars::AWS.access_key_id,
-            secret_access_key: Vars::AWS.secret_access_key,
-            region: Vars::AWS.region
-          )
-        end
-
         def read_db
           res = client.get_attributes(
             {
-              domain_name: "reddit_to_telegram",
+              domain_name: Variables.aws.domain_name,
               item_name: "cached_data",
               consistent_read: true
             }
@@ -69,7 +70,7 @@ module RedditToTelegram
         def write_db
           client.put_attributes(
             {
-              domain_name: DOMAIN_NAME,
+              domain_name: Variables.aws.domain_name,
               item_name: ITEM_NAME,
               attributes: prepare_db_attrs
             }
@@ -101,9 +102,9 @@ module RedditToTelegram
           res = client.list_domains
           return unless res.successful?
 
-          return if res.domain_names.include?(DOMAIN_NAME)
+          return if res.domain_names.include?(Variables.aws.domain_name)
 
-          client.create_domain({ domain_name: DOMAIN_NAME })
+          client.create_domain({ domain_name: Variables.aws.domain_name })
         end
       end
     end

data/lib/reddit_to_telegram/store/memory.rb

@@ -4,6 +4,8 @@ module RedditToTelegram
   module Store
     class Memory
       class << self
+        private
+
         attr_accessor :reddit_token
 
         @posts = {}

data/lib/reddit_to_telegram/store/temp_file.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "../vars"
+require_relative "../variables"
 
 module RedditToTelegram
   module Store
     class TempFile
       class << self
+        private
+
         attr_reader :reddit_token, :posts
 
         @reddit_token = nil
@@ -60,7 +62,7 @@ module RedditToTelegram
         end
 
         def temp_file_path
-          "#{Vars.tmp_dir}/store.json"
+          "#{Variables.store.tmp_dir}/store.json"
         end
       end
     end

data/lib/reddit_to_telegram/store.rb

@@ -1,26 +1,29 @@
 # 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 = Vars.max_stored_posts ? Vars.max_stored_posts - 1 : 24
-    STORE_MAP = {
+    MAX_STORED_POSTS = Variables.store.max_stored_posts - 1
+    CLASS_MAP = {
       aws_simple_db: "RedditToTelegram::Store::AWSSimpleDB",
       memory: "RedditToTelegram::Store::Memory",
       temp_file: "RedditToTelegram::Store::TempFile"
     }.freeze
-    DEFAULT_STORE = :aws_simple_db
 
     STORE = Object.const_get("RedditToTelegram::Store::AWSSimpleDB")
 
     class << self
       attr_accessor :active
 
-      def setup(selected_store = DEFAULT_STORE)
-        self.active = Object.const_get(STORE_MAP[selected_store.to_sym])
+      def setup
+        raise(InvalidStoreType.new) unless CLASS_MAP.keys.include?(Variables.store.type)
+
+        self.active = Object.const_get(CLASS_MAP[RedditToTelegram::Variables.store.type])
         active.send(:setup)
       end
     end

data/lib/reddit_to_telegram/telegram/post.rb

@@ -3,6 +3,7 @@
 require "httparty"
 require_relative "prepare_request"
 require_relative "video"
+require_relative "../variables"
 
 module RedditToTelegram
   module Telegram
@@ -22,14 +23,16 @@ module RedditToTelegram
       class << self
         def push(post, channel)
           HTTParty.post(
-            "#{BASE_URI}#{Vars::Telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
+            "#{BASE_URI}#{Variables.telegram.bot_token}/send#{METHOD_MAP[post[:type]]}",
             **params(post, channel)
           )
 
           push({ type: :text, id: post[:id], text: post[:text] }, channel) if post[:type] == :gallery
-          Video.delete_file if post[:type] == :video
+          Video.delete_file if post[:type] == :video && post.dig(:misc)&.dig(:binary)
         end
 
+        private
+
         def params(post, channel)
           binary = post.dig(:misc)&.dig(:binary)
           body = PrepareRequest.body(post, channel)

data/lib/reddit_to_telegram/telegram/prepare_request.rb

@@ -19,6 +19,8 @@ module RedditToTelegram
           end
         end
 
+        private
+
         def prepare_text(post, chat_id)
           id = post[:id].split("_")[1]
           "#{post[:text]}\n\nhttps://redd.it/#{id}\n@#{chat_id}"

data/lib/reddit_to_telegram/telegram/video.rb

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

data/lib/reddit_to_telegram/variables.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RedditToTelegram
+  module Variables
+    class << self
+      def aws
+        RedditToTelegram::Variables::AWS
+      end
+
+      def reddit
+        RedditToTelegram::Variables::Reddit
+      end
+
+      def store
+        RedditToTelegram::Variables::Store
+      end
+
+      def telegram
+        RedditToTelegram::Variables::Telegram
+      end
+    end
+
+    class Store
+      DEFAULT_TMP_DIR = "#{Dir.pwd}/tmp".freeze
+      DEFAULT_TYPE = :aws_simple_db
+
+      class << self
+        attr_writer :max_stored_posts, :tmp_dir, :type
+
+        def max_stored_posts
+          @max_stored_posts ||= ENV["RTT_MAX_STORED_POSTS"].to_i || 50
+        end
+
+        def tmp_dir
+          @tmp_dir ||= ENV["RTT_TEMP_DIR"] || DEFAULT_TMP_DIR
+        end
+
+        def type
+          @type ||= ENV["RTT_STORE_TYPE"]&.to_sym || DEFAULT_TYPE
+        end
+      end
+    end
+
+    class AWS
+      DEFAULT_DOMAIN_NAME = "reddit_to_telegram"
+
+      class << self
+        attr_writer :access_key_id, :secret_access_key, :region, :domain_name
+
+        def access_key_id
+          @access_key_id ||= ENV["RTT_AWS_ACCESS_KEY_ID"]
+        end
+
+        def secret_access_key
+          @secret_access_key ||= ENV["RTT_AWS_SECRET_ACCESS_KEY"]
+        end
+
+        def region
+          @region ||= ENV["RTT_AWS_REGION"]
+        end
+
+        def domain_name
+          @domain_name ||= ENV["RTT_AWS_DOMAIN_NAME"] || DEFAULT_DOMAIN_NAME
+        end
+      end
+    end
+
+    class Reddit
+      class << self
+        attr_writer :client_id, :client_secret
+
+        def client_id
+          @client_id ||= ENV["RTT_REDDIT_CLIENT_ID"]
+        end
+
+        def client_secret
+          @client_secret ||= ENV["RTT_REDDIT_CLIENT_SECRET"]
+        end
+      end
+    end
+
+    class Telegram
+      class << self
+        attr_writer :bot_token
+
+        def bot_token
+          @bot_token ||= ENV["RTT_TELEGRAM_BOT_TOKEN"]
+        end
+      end
+    end
+  end
+end

data/lib/reddit_to_telegram/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-to-telegram
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Tityuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-simpledb
@@ -65,6 +65,7 @@ files:
 - Gemfile.lock
 - README.md
 - lib/reddit-to-telegram.rb
+- lib/reddit_to_telegram/errors.rb
 - lib/reddit_to_telegram/reddit/auth.rb
 - lib/reddit_to_telegram/reddit/fetch.rb
 - lib/reddit_to_telegram/reddit/output.rb
@@ -75,7 +76,7 @@ files:
 - lib/reddit_to_telegram/telegram/post.rb
 - lib/reddit_to_telegram/telegram/prepare_request.rb
 - lib/reddit_to_telegram/telegram/video.rb
-- lib/reddit_to_telegram/vars.rb
+- lib/reddit_to_telegram/variables.rb
 - lib/reddit_to_telegram/version.rb
 - reddit-to-telegram.gemspec
 - tmp/.keep
@@ -83,7 +84,7 @@ homepage: https://github.com/dersnek/reddit-to-telegram
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Fetches hot posts from reddit and pushes them to telegram
 test_files: []

data/lib/reddit_to_telegram/vars.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module RedditToTelegram
-  module Vars
-    DEFAULT_TMP_DIR = "#{Dir.pwd}/tmp".freeze
-
-    class << self
-      # rubocop:disable Metrics/ParameterLists
-      def assign_values(
-        max_stored_posts:,
-        tmp_dir:,
-        aws_access_key_id:,
-        aws_secret_access_key:,
-        aws_region:,
-        reddit_client_id:,
-        reddit_client_secret:,
-        telegram_bot_token:
-      )
-
-        @max_stored_posts = max_stored_posts
-        @tmp_dir = tmp_dir
-        AWS.instance_variable_set(:@access_key_id, aws_access_key_id)
-        AWS.instance_variable_set(:@secret_access_key, aws_secret_access_key)
-        AWS.instance_variable_set(:@region, aws_region)
-        Reddit.instance_variable_set(:@client_id, reddit_client_id)
-        Reddit.instance_variable_set(:@client_secret, reddit_client_secret)
-        Telegram.instance_variable_set(:@bot_token, telegram_bot_token)
-      end
-      # rubocop:enable Metrics/ParameterLists
-
-      def max_stored_posts
-        @max_stored_posts ||= ENV["RTT_MAX_STORED_POSTS"].to_i || 25
-      end
-
-      def tmp_dir
-        @tmp_dir ||= ENV["RTT_TEMP_DIR"] || DEFAULT_TMP_DIR
-      end
-    end
-
-    class AWS
-      class << self
-        def access_key_id
-          @access_key_id ||= ENV["RTT_AWS_ACCESS_KEY_ID"]
-        end
-
-        def secret_access_key
-          @secret_access_key ||= ENV["RTT_AWS_SECRET_ACCESS_KEY"]
-        end
-
-        def region
-          @region ||= ENV["RTT_AWS_REGION"]
-        end
-      end
-    end
-
-    class Reddit
-      class << self
-        def client_id
-          @client_id ||= ENV["RTT_REDDIT_CLIENT_ID"]
-        end
-
-        def client_secret
-          @client_secret ||= ENV["RTT_REDDIT_CLIENT_SECRET"]
-        end
-      end
-    end
-
-    class Telegram
-      class << self
-        def bot_token
-          @bot_token ||= ENV["RTT_TELEGRAM_BOT_TOKEN"]
-        end
-      end
-    end
-  end
-end