reddit-to-telegram 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0409bbca53a356490970298ad89f7990a7cc34a806a4211faef79c772bf7a7f9'
-  data.tar.gz: 3c1029e0f2c335eb34d26c2be1f31c08d13643fdd7a5915812f44f4667b8b1e4
+  metadata.gz: 36d1523dfcd1455f13aaf69a3460c86c588dc51a318c956bcaa25acbbee0cd82
+  data.tar.gz: b5d4d20eedf4a41ffec66d26479955627e205c944696ef445e539e1bb2d9d2a0
 SHA512:
-  metadata.gz: 062ab3a460e4599fcba146020dd9e3713eb78f4e992f13f8aa370a5df25baa9890b64075c3392eba5b2c921661e2ba3e47028a3dde02df79afa0277f1c5bfc42
-  data.tar.gz: 81fa4e1dd727da653f3786641e75d08b6f50890b92192a35ff70d5a908fec5dded3c67a0a85f7ee4c83cb4b79e58adca9d488a50755afca753646145cb6088b0
+  metadata.gz: 51f3e8460aa53bb0d028e27b9852d9a23501a3fa4d6a886d382ae232d68d7a3fcf466c61af82fb38079eea4911fdb10cd830226b4bc4373b5a96426ce8e1378f
+  data.tar.gz: 04465e55387e6e5c96e1b891a0ea2189538b9b038e92c80c7a369f4e417092b0f6b2dba6411f9ad83405d9712b764c53b6ab6e207b9bc99d5dd3005823ca8ecb

data/README.md

@@ -4,7 +4,60 @@
 
 #### Fetches hot posts from chosen subreddits and pushes them to Telegram channels.
 
-I'll update readme with instructions soon.
+Beware, this is remotely not production-ready and you'll see lots of bugs. Be sure to check for gem updates.
 
-### TODO:
+## Installation
+In your `Gemfile` add:
+```
+gem "reddit-to-telegram"
+```
+Then run `bundle install`.
+
+Or `gem install reddit-to-telegram`, but don't forget to `require` it first then.
+
+## Prerequisites
+- You need an AWS account to host a free SimpleDB (memory and local file storage options are available, but no way to switch for now)
+- (Optionally) Create a Reddit app, which would allow more requests to reddit
+- [Obtain](https://core.telegram.org/bots/tutorial#create-your-project) 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_REGION= # AWS region your SimpleDB will be hosted on. Beware, it's on 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_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:,
+  aws_access_key_id:,
+  aws_secret_access_key:,
+  aws_region:,
+  reddit_client_id:,
+  reddit_client_secret:,
+  telegram_bot_token:
+)
+```
+## Usage
+
+1. Add the bot as administrator to Telegram channels you'd like to post to.
+2.
+```
+RedditToTelegram.post(
+    subreddit_name_1: :telegram_channel_id_1,
+    subreddit_name_2: :telegram_channel_id_2
+  )
+
+```
+Use `:telegram_channel_id` without the `@`.
+
+## TODO
+- Storage options
 - Error handling (maybe send them to another channel in Telegram)

data/lib/reddit-to-telegram.rb

@@ -3,6 +3,7 @@
 require_relative "reddit_to_telegram/reddit/fetch"
 require_relative "reddit_to_telegram/store"
 require_relative "reddit_to_telegram/telegram/post"
+require_relative "reddit_to_telegram/version"
 
 module RedditToTelegram
   class << self

data/lib/reddit_to_telegram/store/temp_file.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "../vars"
 
 module RedditToTelegram
   module Store
     class TempFile
-      STORE_FILE_DIR = "#{Dir.pwd}/tmp/store.json".freeze
-
       class << self
         attr_reader :reddit_token, :posts
 
@@ -36,9 +35,9 @@ module RedditToTelegram
         end
 
         def read_file
-          return assign_default_values unless File.exist?(STORE_FILE_DIR)
+          return assign_default_values unless File.exist?(temp_file_path)
 
-          file = File.read(STORE_FILE_DIR)
+          file = File.read(temp_file_path)
           data = JSON.parse(file)
           @reddit_token = data["reddit_token"]
           @posts = {}
@@ -52,13 +51,17 @@ module RedditToTelegram
           @posts.each do |subreddit, values|
             data["posts_#{subreddit}".to_sym] = values
           end
-          File.open(STORE_FILE_DIR, "w") { |f| f.write(data.to_json) }
+          File.open(temp_file_path, "w") { |f| f.write(data.to_json) }
         end
 
         def assign_default_values
           @reddit_token = nil
           @posts = {}
         end
+
+        def temp_file_path
+          "#{Vars.tmp_dir}/store.json"
+        end
       end
     end
   end

data/lib/reddit_to_telegram/telegram/prepare_request.rb

@@ -32,7 +32,7 @@ module RedditToTelegram
           return post[:media] unless post[:misc][:binary]
 
           Video.from_link(post[:media])
-          File.open(Video::TEMP_VIDEO_PATH)
+          File.open(Video.temp_video_path)
         end
       end
     end

data/lib/reddit_to_telegram/telegram/video.rb

@@ -1,23 +1,28 @@
 # frozen_string_literal: true
 
 require "open-uri"
+require_relative "../vars"
 
 module RedditToTelegram
   module Telegram
     class Video
-      TEMP_VIDEO_PATH = "#{Dir.pwd}/tmp/video.mp4".freeze
-
       class << self
         def from_link(link)
           download = URI.parse(link).open
-          IO.copy_stream(download, TEMP_VIDEO_PATH)
+          File.open(temp_video_path, "w+b") do |file|
+            download.respond_to?(:read) ? IO.copy_stream(download, file) : file.write(download)
+          end
         end
 
         def delete_file
-          f = File.open(TEMP_VIDEO_PATH, "r")
+          f = File.open(temp_video_path, "r")
         ensure
           f.close unless f.nil? || f.closed?
-          File.delete(TEMP_VIDEO_PATH) if File.exist?(TEMP_VIDEO_PATH)
+          File.delete(temp_video_path) if File.exist?(temp_video_path)
+        end
+
+        def temp_video_path
+          "#{Vars.tmp_dir}/video.mp4"
         end
       end
     end

data/lib/reddit_to_telegram/vars.rb

@@ -2,10 +2,13 @@
 
 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:,
@@ -15,6 +18,7 @@ module RedditToTelegram
       )
 
         @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)
@@ -27,6 +31,10 @@ module RedditToTelegram
       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

data/lib/reddit_to_telegram/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-to-telegram
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Tityuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-simpledb