reddit_bot 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f403237693827c791d79ee8904c9cfb9dc5a5a7
-  data.tar.gz: a3804dca179ba6cb72455d65f6b50cd1cecd3939
+  metadata.gz: 0d2ed897b55ef286ce14857b2d4cfd82c69ed861
+  data.tar.gz: 40c30c1b24122c3f964ec2e6d447a08eeeb1a9cb
 SHA512:
-  metadata.gz: 601b5f77064340aedbc9264a0f96483705c49302f913af46db8fc3d347ade2222969516804976d6af55dac7cbc3b041e46918c5170b141ebc1b6cf31d05a7d59
-  data.tar.gz: 906036dc78a34315d0df25958c094e042b4d66ed68f8198004f530eea20df76a8013a33ee7ef67108bf8299a81602dd5ea7d774f92742ecac0b5911353a446db
+  metadata.gz: 667e9d3cb500e53e4c3f5eac0374ee6e71e116a02292df4517d90ba6904f642e67785f0e990df0cd3c724dd4cfb972cf8a23c7ac35a8027878c8e7e6d149570c
+  data.tar.gz: 8dde680bd8addba2765e8a849660465cc8460c21867ca1b48ad451b00ce51b60310097266bce7d6d155b6b15ed4d7b48a3e9924c36301b0bd152f2ffe30ae9a3

data/README.md

@@ -1,8 +1,7 @@
 # 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?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-[![Gem Version](https://badge.fury.io/rb/reddit_bot.svg)](http://badge.fury.io/rb/mll)  
+[![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
 
@@ -26,17 +25,17 @@ The [examples folder](examples) includes:
   It calculates quality of x-posts from different subreddits based on mods activity (remove/approve).  
   For example, this shows that it would be ok to ignore /r/pics from now:
 
-             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%   
-                                                       
+             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%  
+
 You obviously can't run these examples as is, because they have some dependencies that are not in this repo. Like `secrets.yaml` file for authorization of the following format:
 
     :client_id: Kb9.......6wBw

data/examples/yayornay/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: ../..
+  specs:
+    reddit_bot (1.1.2)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  reddit_bot!
+
+BUNDLED WITH
+   1.11.2

data/lib/reddit_bot.rb

@@ -8,35 +8,38 @@ require "json"
 
 
 module RedditBot
-  VERSION = "1.1.2"
+  VERSION = "1.1.3" # :nodoc:
 
   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 :ignore_captcha that is true by default and :subreddit for clever methods
     def initialize secrets, **kwargs
       @secrets = secrets.values_at *%i{ client_id client_secret password login }
+      @name = secrets[:login]
       @ignore_captcha = true
       @ignore_captcha = kwargs[:ignore_captcha] if kwargs.has_key?(:ignore_captcha)
       @subreddit = kwargs[:subreddit]
     end
 
-    # attr_accessor :token_cached
-    # attr_accessor :username
-    # attr_accessor :iden_and_captcha
-    # attr_accessor :ignore_captcha
-    # attr_accessor :secrets
-
-    def json mtd, url, _form = []
+    # [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.parse resp_with_token mtd, url, form.merge({api_type: "json"})
+      response = JSON.parse resp_with_token mtd, path, form.merge({api_type: "json"})
       if response.is_a?(Hash) && response["json"] # for example, flairlist.json and {"error": 403} do not have it
-        puts "ERROR OCCURED on #{[mtd, url]}" unless response["json"]["errors"].empty?
+        puts "ERROR OCCURED on #{[mtd, path]}" unless response["json"]["errors"].empty?
         # pp response["json"]
         response["json"]["errors"].each do |error, description|
           puts "error: #{[error, description]}"
           case error
           when "ALREADY_SUB" ; puts "was rejected by moderator if you didn't see in dups"
           when "BAD_CAPTCHA" ; update_captcha
-            json mtd, url, form.merger( {
+            json mtd, path, form.merger( {
               iden: @iden_and_captcha[0],
               captcha: @iden_and_captcha[1],
             } ) unless @ignore_captcha
@@ -47,7 +50,11 @@ module RedditBot
       response
     end
 
+    # [subreddit] +String+ subreddit name without "/r" prefix
+    # [page] +String+ page name without "/wiki/" prefix
+    # [text] :nodoc:
     def wiki_edit subreddit, page, text
+      puts "editing wiki page '/r/#{subreddit}/wiki/#{page}'"
       json :post,
         "/r/#{subreddit}/api/wiki/edit",
         page: page,
@@ -55,28 +62,48 @@ 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
+      puts "reporting '#{thing_id}'"
       json :post, "/api/report",
         reason: "other",
         other_reason: reason,
         thing_id: thing_id
     end
 
-    # def each_new_post &block
-    #   # Enumerator.new do |e|
-    #   json(:get, "/r/#{@subreddit}/new")["data"]["children"].each do |post|
-    #     fail "unknown type post['kind']: #{post["kind"]}" unless post["kind"] == "t3"
-    #     block.call post["data"]
-    #   end
-    # 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
+      puts "setting flair '#{link_flair_css_class}' with text '#{link_flair_text}' to post '#{post["name"]}'"
+      json :post, "/api/selectflair",
+        link: post["name"],
+        text: link_flair_text,
+        flair_template_id: (@flairselector_choices ||=
+          json :post, "/r/#{@subreddit}/api/flairselector", link: post["name"]
+        )["choices"].find{ |i| i["flair_css_class"] == link_flair_css_class }.tap{ |flair|
+          fail "can't find '#{link_flair_css_class}' flair class at https://www.reddit.com/r/#{@subreddit}/about/flair/#link_templates" unless flair
+        }["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
+      puts "leaving a comment on '#{thing_id}'"
+      json(:post, "/api/comment",
+        thing_id: thing_id,
+        text: text,
+      ).tap do |result|
+        fail result["json"]["errors"].to_s unless result["json"]["errors"].empty?
+      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
       json(:get, "/r/#{@subreddit}/new")["data"]["children"].each do |post|
         fail "unknown type post['kind']: #{post["kind"]}" unless post["kind"] == "t3"
-        t = BOT.json :get, "/comments/#{post["data"]["id"]}",
-          # sort: "top",
-          depth: 1,
-          limit: 100500
+        t = json :get, "/comments/#{post["data"]["id"]}", depth: 1, limit: 100500#, sort: "top"
         fail "smth weird about /comments/<id> response" unless t.size == 2
         yield post["data"], t[1]["data"]["children"].map{ |child|
           fail "unknown type child['kind']: #{child["kind"]}" unless child["kind"] == "t1"
@@ -85,15 +112,20 @@ module RedditBot
       end
     end
 
-    def set_post_flair post, link_flair_css_class, link_flair_text
-      json :post, "/api/selectflair",
-        link: post["name"],
-        text: link_flair_text,
-        flair_template_id: (@flairselector_choices ||=
-          json :post, "/r/#{@subreddit}/api/flairselector", link: post["name"]
-        )["choices"].find{ |i| i["flair_css_class"] == link_flair_css_class }.tap{ |flair|
-          fail "can't find '#{link_flair_css_class}' flair class at https://www.reddit.com/r/#{@subreddit}/about/flair/#link_templates" unless flair
-        }["flair_template_id"]
+    # [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|
+          smth["data"]["children"].each do |child|
+            f[child["data"]["replies"]] if child["data"]["replies"].is_a? Hash
+            fail "unknown type child['kind']: #{child["kind"]}" unless child["kind"] == "t1"
+            e << [child["data"]["name"], child["data"]]
+          end
+        end
+        f[ json(:get, "/comments/#{article}", depth: 100500, limit: 100500).tap do |t|
+          fail "smth weird about /comments/<id> response" unless t.size == 2
+        end[1] ]
+      end
     end
 
     private
@@ -125,9 +157,9 @@ module RedditBot
       @iden_and_captcha = [iden, gets.strip]
     end
 
-    def resp_with_token mtd, url, form
+    def resp_with_token mtd, path, form
       nil until _ = catch(:"401") do
-        reddit_resp mtd, "https://oauth.reddit.com" + url, form, [
+        reddit_resp mtd, "https://oauth.reddit.com" + path, form, [
           ["Authorization", "bearer #{token}"],
           ["User-Agent", "bot/#{@username}/0.0.0 by /u/nakilon"],
         ], nil # base auth

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit_bot
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Victor Maslov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,7 @@ files:
 - examples/pokemon_trading/Gemfile.lock
 - examples/pokemon_trading/main.rb
 - examples/yayornay/Gemfile
+- examples/yayornay/Gemfile.lock
 - examples/yayornay/main.rb
 - lib/reddit_bot.rb
 - reddit_bot.gemspec