reddit_bot 1.7.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dca4b66ca047773ac0de806e1281cf7a088bf8f
-  data.tar.gz: d53ad1a90ba44333ab2245b98a304da5e0f89974
+  metadata.gz: 99ebebd30c2e4bfa221cc6b78c6521f4eb2e5c7b
+  data.tar.gz: 79b8d91f910d5ca649f8350f1009bb6c21afd702
 SHA512:
-  metadata.gz: a97e1f8905b56cafa91ce4c3509f7a779db5e5579f8f480363876f45bf4bc152cffd5c4b75ea2040607d95892b831d728981c372440145153577e04ca213e0f6
-  data.tar.gz: 950cbf9d106d01f4f6a68e3a8884d36cc7b0962a4488b3c8363c7d44cda637570e706581b7d07413e0c4d2dfe121f54575b0c14a8bbe3b01176f1f7284a734dc
+  metadata.gz: 9049548db4c55006a9fd9dd7fef394cb3b973ea3df7047a25528dcd2495e230acaa8217fd17ffa8128e9f23784bd292875d6e01015c785d465c3acc7c51db0b9
+  data.tar.gz: 6e9849c6d4d3c7ed2eacc8b404f256764e0756e773d567ab7004d7f0a041bbdb5b722106d4fbba281b1ef0f8b6898d551b7742b19a232b942058523e8235a669

data/lib/reddit_bot.rb

@@ -1,5 +1,4 @@
 STDOUT.sync = true
-# require "pp"
 
 require "openssl"
 require "json"
@@ -7,8 +6,6 @@ require "yaml"
 
 require "nethttputils"
 
-require_relative "reddit_bot/version" # TODO: deprecate this
-
 module RedditBot
   require "logger"
   class << self
@@ -17,12 +14,8 @@ module RedditBot
   self.logger = Logger.new STDOUT
 
   class Bot
-
-    # bot's Reddit username; set via constructor parameter secrets[:login]
     attr_reader :name
 
-    # [secrets] +Hash+ with keys :client_id, :client_secret, :password: and :login
-    # [kwargs] keyword params may include :subreddit for clever methods
     def initialize secrets, **kwargs
       @name, @secret_password, @user_agent, *@secret_auth = secrets.values_at *%i{ login password user_agent client_id client_secret }
       # @ignore_captcha = true
@@ -30,12 +23,14 @@ module RedditBot
       @subreddit = kwargs[:subreddit]
     end
 
-    # [mtd] +Symbol+ :get or :post
-    # [path] +String+ an API method
-    # [_form] +Array+ or +Hash+ API method params
     def json mtd, path, _form = []
       form = Hash[_form]
-      response = JSON.load resp_with_token mtd, path, form.merge({api_type: "json"})
+      response = begin
+        JSON.load resp_with_token mtd, path, form.merge({api_type: "json"})
+      rescue JSON::ParserError
+        $!.message.slice! 1000..-1
+        raise
+      end
       if response.is_a?(Hash) && response["json"] && # for example, flairlist.json and {"error": 403} do not have it
          !response["json"]["errors"].empty?
         Module.nesting[1].logger.error "ERROR OCCURED on #{[mtd, path]}"
@@ -72,8 +67,6 @@ module RedditBot
     #   # ["previous", result["data"]["children"].last["id"]],
     # end
 
-    # [reason] :nodoc:
-    # [thing_id] +String+ fullname of a "link, commenr or message"
     def report reason, thing_id
       Module.nesting[1].logger.warn "reporting '#{thing_id}'"
       json :post, "/api/report",
@@ -82,9 +75,6 @@ module RedditBot
         thing_id: thing_id
     end
 
-    # [post] JSON object of a post of self.post
-    # [link_flair_css_class] :nodoc:
-    # [link_flair_text] :nodoc:
     def set_post_flair post, link_flair_css_class, link_flair_text
       Module.nesting[1].logger.warn "setting flair '#{link_flair_css_class}' with text '#{link_flair_text}' to post '#{post["name"]}'"
       if {"error"=>403} == @flairselector_choices ||= json(:post, "/r/#{@subreddit}/api/flairselector", link: post["name"])
@@ -99,8 +89,6 @@ module RedditBot
         }["flair_template_id"]
     end
 
-    # [thing_id] +String+ fullname of a post (or self.post?), comment (and private message?)
-    # [text] :nodoc:
     def leave_a_comment thing_id, text
       Module.nesting[1].logger.warn "leaving a comment on '#{thing_id}'"
       json(:post, "/api/comment",
@@ -154,7 +142,9 @@ module RedditBot
                                                   result["data"].keys == %w{ modhash dist children after before }
           @@skip_erroneous_descending_ids[ result["data"]["children"].map do |post|
             fail "unknown type post['kind']: #{post["kind"]}" unless post["kind"] == "t3"
-            post["data"]
+            post["data"].dup.tap do |data|
+              data["url"] = "https://www.reddit.com" + data["url"] if /\A\/r\/[0-9a-zA-Z_]+\/comments\/[0-9a-z]{5,6}\// =~ data["url"] if data["crosspost_parent"]
+            end
           end ].each do |data|
             e << data
           end
@@ -164,7 +154,6 @@ module RedditBot
       end
     end
 
-    # :yields: JSON objects: ["data"] part of post or self.post, top level comment (["children"] element)
     def each_new_post_with_top_level_comments
       # TODO add keys assertion like in method above?
       json(:get, "/r/#{@subreddit}/new")["data"]["children"].each do |post|
@@ -178,7 +167,6 @@ module RedditBot
       end
     end
 
-    # [article] +String+ ID36 of a post or self.post
     def each_comment_of_the_post_thread article
       Enumerator.new do |e|
         f = lambda do |smth|
@@ -194,6 +182,27 @@ module RedditBot
       end
     end
 
+    def subreddit_iterate what, **kwargs
+      Enumerator.new do |e|
+        after = {}
+        loop do
+          break unless marker = json(:get, "/r/#{@subreddit}/#{what}", {limit: 100}.merge(after).merge(kwargs)).tap do |result|
+            fail if %w{ kind data } != result.keys
+            fail if "Listing" != result["kind"]
+            fail result["data"].keys.inspect unless result["data"].keys == %w{ after dist modhash whitelist_status children before } ||
+                                                    result["data"].keys == %w{ modhash dist children after before }
+            result["data"]["children"].each do |post|
+              fail "unknown type post['kind']: #{post["kind"]}" unless post["kind"] == "t3"
+              e << ( post["data"].tap do |data|
+                data["url"] = "https://www.reddit.com" + data["url"] if /\A\/r\/[0-9a-zA-Z_]+\/comments\/[0-9a-z]{5,6}\// =~ data["url"] if data["crosspost_parent"]
+              end )
+            end
+          end["data"]["after"]
+          after = {after: marker}
+        end
+      end
+    end
+
     private
 
     def token
@@ -205,7 +214,7 @@ module RedditBot
           username: @name,
           password: @secret_password,
         }, {
-          "User-Agent" => "bot/#{@user_agent || @name}/#{RedditBot::VERSION} by /u/nakilon",
+          "User-Agent" => "bot/#{@user_agent || @name}/#{Gem::Specification::load("#{__dir__}/../reddit_bot.gemspec").version} by /u/nakilon",
         }, @secret_auth
       unless @token_cached = response["access_token"]
         fail "bot #{@name} isn't a 'developer' of app at https://www.reddit.com/prefs/apps/" if response == {"error"=>"invalid_grant"}
@@ -232,7 +241,7 @@ module RedditBot
       begin
         reddit_resp mtd, "https://oauth.reddit.com" + path, form, {
           "Authorization" => "bearer #{token}",
-          "User-Agent" => "bot/#{@user_agent || @name}/#{RedditBot::VERSION} by /u/nakilon",
+          "User-Agent" => "bot/#{@user_agent || @name}/#{Gem::Specification::load("#{__dir__}/../reddit_bot.gemspec").version} by /u/nakilon",
         }
       rescue NetHTTPUtils::Error => e
         raise unless e.code == 401
@@ -303,14 +312,7 @@ module RedditBot
           "https://api.twitter.com/1.1/statuses/user_timeline.json",
           form: { screen_name: TWITTER_ACCOUNT, count: 200, tweet_mode: "extended" },
           header: { Authorization: "Bearer #{TWITTER_ACCESS_TOKEN}" }
-        ) do |res|
-          next unless res.key? "x-rate-limit-remaining"
-          remaining = res.fetch("x-rate-limit-remaining").to_i
-          next if 100 < remaining
-          t = (res.fetch("x-rate-limit-reset").to_i - Time.now.to_i + 1).fdiv remaining
-          puts "sleep #{t}"
-          sleep t
-        end
+        )
       rescue NetHTTPUtils::Error => e
         fail unless [500, 503].include? e.code
         sleep timeout

data/reddit_bot.gemspec

@@ -1,23 +1,21 @@
 Gem::Specification.new do |spec|
   spec.name          = "reddit_bot"
-  spec.version       = "1.7.5"
-  spec.authors       = ["Victor Maslov"]
-  spec.email         = ["nakilon@gmail.com"]
+  spec.version       = "1.9.0"
+  spec.summary       = "Simple library for Reddit bots"
 
-  spec.summary       = "Library for Reddit bots"
-  spec.description   = "better than PRAW"
-  spec.homepage      = "https://github.com/Nakilon/reddit_bot"
+  spec.author        = "Victor Maslov aka Nakilon"
+  spec.email         = "nakilon@gmail.com"
   spec.license       = "MIT"
+  spec.metadata      = {"source_code_uri" => "https://github.com/Nakilon/reddit_bot"}
 
-  spec.files         = `git ls-files -z`.split("\x0")#.reject { |f| f.match(%r{^(test|spec|features)/})/ }
-  # spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "nethttputils", "~>0.4.0.0"
+  spec.add_dependency "json_pure"
+  spec.add_dependency "nethttputils", "~>0.4.1.0"
   # spec.add_development_dependency "bundler", "~> 1.11"
   # spec.add_development_dependency "rake", "~> 10.0"
   # spec.add_development_dependency "rspec", "~> 3.0"
   spec.required_ruby_version = ">= 2.0.0"
+
+  spec.files         = %w{ LICENSE.txt reddit_bot.gemspec lib/reddit_bot.rb }
 end
 
   # spec.test_files    = ["spec/"]

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reddit_bot
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.9.0
 platform: ruby
 authors:
-- Victor Maslov
+- Victor Maslov aka Nakilon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,89 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0.0
+        version: 0.4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0.0
-description: better than PRAW
-email:
-- nakilon@gmail.com
+        version: 0.4.1.0
+description: 
+email: nakilon@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- examples/.bashrc
-- examples/.gitignore
-- examples/Gemfile.lock
-- examples/boilerplate.rb
-- examples/councilofricks/Gemfile
-- examples/councilofricks/Gemfile.lock
-- examples/councilofricks/main.rb
-- examples/cptflairbot3/.bashrc
-- examples/cptflairbot3/Code.gs
-- examples/cptflairbot3/Gemfile
-- examples/cptflairbot3/Gemfile.lock
-- examples/cptflairbot3/app.js
-- examples/cptflairbot3/casual/casualpokemontrades.htm
-- examples/cptflairbot3/casual/script.js
-- examples/cptflairbot3/casual/style.css
-- examples/cptflairbot3/log.htm
-- examples/cptflairbot3/main.rb
-- examples/cptflairbot3/package.json
-- examples/cptflairbot3/pubsub.rb
-- examples/cptflairbot3/update_gas_hook_secret.rb
-- examples/devflairbot/Gemfile
-- examples/devflairbot/Gemfile.lock
-- examples/devflairbot/main.rb
-- examples/get_dimensions.rb
-- examples/iostroubleshooting/Gemfile
-- examples/iostroubleshooting/Gemfile.lock
-- examples/iostroubleshooting/main.rb
-- examples/johnnymarr/Gemfile
-- examples/johnnymarr/Gemfile.lock
-- examples/johnnymarr/main.rb
-- examples/johnnymarr/twitter.rb
-- examples/largeimages/Gemfile
-- examples/largeimages/Gemfile.lock
-- examples/largeimages/main.rb
-- examples/largeimagesreview/Gemfile
-- examples/largeimagesreview/Gemfile.lock
-- examples/largeimagesreview/main.rb
-- examples/mlgtv/Gemfile
-- examples/mlgtv/Gemfile.lock
-- examples/mlgtv/channels.txt
-- examples/mlgtv/main.rb
-- examples/net_http_utils.rb
-- examples/oneplus/Gemfile
-- examples/oneplus/Gemfile.lock
-- examples/oneplus/main.rb
-- examples/realtimeww2/.bashrc
-- examples/realtimeww2/Gemfile
-- examples/realtimeww2/Gemfile.lock
-- examples/realtimeww2/main.rb
-- examples/sexypizza/Gemfile
-- examples/sexypizza/Gemfile.lock
-- examples/sexypizza/main.rb
-- examples/wallpaper/Gemfile
-- examples/wallpaper/Gemfile.lock
-- examples/wallpaper/main.rb
-- examples/yayornay/Gemfile
-- examples/yayornay/Gemfile.lock
-- examples/yayornay/main.rb
 - lib/reddit_bot.rb
 - reddit_bot.gemspec
-homepage: https://github.com/Nakilon/reddit_bot
+homepage: 
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/Nakilon/reddit_bot
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -132,5 +71,5 @@ rubyforge_project:
 rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
-summary: Library for Reddit bots
+summary: Simple library for Reddit bots
 test_files: []

data/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-# git: "git@github.com:Nakilon/nethttputils.git", tag: "v0.0.1.4"

data/README.md

@@ -1,101 +0,0 @@
-# RedditBot
-
-[![Join the chat at https://gitter.im/Nakilon/reddit_bot](https://badges.gitter.im/Nakilon/reddit_bot.svg)](https://gitter.im/Nakilon/reddit_bot)
-[![Gem Version](https://badge.fury.io/rb/reddit_bot.svg)](http://badge.fury.io/rb/reddit_bot)
-
-### What
-
-This library provides an easy way to run bots and scripts that use Reddit API.  
-I ([/u/nakilon](https://www.reddit.com/u/nakilon)) currently run near 10 bots with it.
-
-### Why
-
-Python (and so PRAW) sucks.
-
-### Examples
-
-I'm not usually publish every program (since there are thousand of them and adequate programmer knows that publishing everything is like throwing trash on street) but I'll add bots here so you could see how to use the library.  
-The [examples folder](examples) includes:
-
-* **sexypizza** -- bot that updates wiki page with current flairs statistics
-* **devflairbot** -- bot that flairs posts when some specifically flaired user comments there
-* **mlgtv** -- bot that updates sidebar with currently streaming twitch channels
-* **councilofricks** -- bot that flairs users according to Google Spreadsheet
-* **wallpaper** -- bot that reports images with dimensions being not the same as in title
-* **cptflairbot3** -- bot that sets user flair according to request submitted via web form  
-  also publishes its activily log here http://www.nakilon.pro/casualpokemontrades/log.htm via Google Cloud Platform automations (Apps Script and Functions)
-* **oneplus** -- bot that removes and modmails about links to 1080x1920 images
-* **yayornay** -- bot that flairs posts according to voting in top level comments
-* **realtimeww2** -- bot that posts tweets to a subreddit from a Twitter user timeline
-* **johnnymarr** -- another Twitter timeline streaming bot working in the similar way
-* **largeimages** -- this was my first bot -- it uses two approaches to track the most high resolution photos posted anywhere on Reddit to x-post them to [subreddit /r/largeimages](https://www.reddit.com/r/largeimages)
-* **largeimagesreview** -- script that was used /r/largeimages to calculates quality of x-posts from different subreddits based on mods activity (remove/approve) so it showed that /r/pics and /r/foodporn should better be excluded:
-
-             pics            Total: 98     Quality: 19%  
-          wallpapers         Total: 69     Quality: 52%  
-          wallpaper          Total: 45     Quality: 51%  
-           woahdude          Total: 30     Quality: 66%  
-           CityPorn          Total: 17     Quality: 82%  
-           FoodPorn          Total: 13     Quality: 7%  
-           MapPorn           Total: 13     Quality: 46%  
-           SkyPorn           Total: 11     Quality: 45%  
-           carporn           Total: 11     Quality: 45%  
-      InfrastructurePorn     Total: 9      Quality: 77%  
-
-         EarthPorn      Total: 23  Quality: 82%   ✅⛔✅✅✅✅⛔✅✅✅✅✅⛔⛔✅✅✅✅✅✅✅✅✅  
-          FoodPorn      Total: 5   Quality: 0%    ⛔⛔⛔⛔⛔                   
-          carporn       Total: 4   Quality: 0%    ⛔⛔⛔⛔                    
-          CityPorn      Total: 4   Quality: 100%  ✅✅✅✅                    
-         spaceporn      Total: 4   Quality: 100%  ✅✅✅✅                    
-          MapPorn       Total: 4   Quality: 50%   ✅⛔✅⛔                    
-       BotanicalPorn    Total: 3   Quality: 66%   ✅✅⛔                     
-        CemeteryPorn    Total: 2   Quality: 0%    ⛔⛔                      
-        MilitaryPorn    Total: 2   Quality: 50%   ✅⛔                      
-        DessertPorn     Total: 2   Quality: 50%   ⛔✅                      
-            pic         Total: 2   Quality: 100%  ✅✅                      
-      ArchitecturePorn  Total: 2   Quality: 50%   ✅⛔                      
-       AbandonedPorn    Total: 2   Quality: 100%  ✅✅                      
-
-### Usage
-
-    $ gem install reddit_bot
-
-or via Gemfile:
-
-    source "https://rubygems.org"
-    gem "reddit_bot"
-
-helloworld.rb:
-
-```ruby
-require "reddit_bot"
-```
-
-You obviously can't run these examples as is, because they use local configs that are not in git repo, like `secrets.yaml` file for Reddit authorization of the following format:
-
-    :client_id: Kb9.......6wBw
-    :client_secret: Fqo.....................AFI
-    :password: mybotpassword
-    :login: MyBotUsername
-    # :user_agent: optional_custom_useragent_to_bypass_reddit_spam_protection
-
-To change log level:
-
-```ruby
-RedditBot.logger.level = Logger::ERROR
-```
-
-To update the gem version in Gemfile.lock when using Gemfile like this: `gem "reddit_bot", "~>1.1.0"`, do the:
-
-    $ bundle update reddit_bot
-
-### Contributing and License
-
-Bug reports and pull requests are welcome.  
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-### TODO
-
-* write more usage instructions here
-* manual on how to create bots with Reddit web interface and run via bash console
-* about NetHTTPUtils dependency; and that get_response returns String code not Integer like request_data

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-
-# require "rspec/core/rake_task"
-# RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/examples/.bashrc

@@ -1,2 +0,0 @@
-echo "for get_dimensions.rb self-test: bundle exec ruby get_dimensions.rb"
-source ./secrets