redd 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d1b17c6950acfb37e70062b5ef884ccd842b48
-  data.tar.gz: f5d053a918a167558cb3b4d22bf0939d42fb8f5e
+  metadata.gz: 36eb57cd9b39fd9bc40fa5fb242f0ce23808c623
+  data.tar.gz: 167e62283d79e46b12e3bdc55f44acbf8f87703e
 SHA512:
-  metadata.gz: 57df8f09c68ab163d15c4589a2f268b3fd393c63d4afcb04977dd89842af88d6c0b4d84f2e76e35e289ca878430cfa4e810611c399714e3062c11ebdc6c423fd
-  data.tar.gz: 341a6eae53925c15d7a70fa07e241fdba578fc099c0c11d2e3a0b18c1e4bd59f4daf46d502e24fa664a9073221869edd0943776a8f7355d837a0049300f1dd8f
+  metadata.gz: f94502a932a54d1f6c63bb14ae42f08897ba3e5a4958f211119ce71ad3bdb72a96f2b2699ae31856a66c6c5baf8ac5f5be90050f18b5cbb63f9457afe33db0a3
+  data.tar.gz: b17c0e4d62fc82f8dd31c62d25ecf4e38e87f59071b54229e96f4ec3a68954d143ec2b7d76b2fe251375dbc38030750df6e8cf0065cf854caad2adf4053b7bde

data/README.md

@@ -136,6 +136,6 @@ Redd::Objects::Submission.include(MyGildingExtension)
 ```ruby
 # Copyright.rb
 #
-# Copyright (c) Avinash Dwarapu under the MIT License. See LICENSE.txt for more details.
-# Redd::Error has been modified from RedditKit.rb. See RedditKit.LICENSE.txt for its license.
+# Copyright (c) Avinash Dwarapu under the MIT License. See LICENSE.md for more details.
+# Redd::Error has been modified from RedditKit.rb. See RedditKit.LICENSE.md for its license.
 ```

data/{RedditKit.LICENSE.txt → RedditKit.LICENSE.md}

@@ -1,7 +1,3 @@
-error.rb would have been impossible if it weren't for @samsymons :)
-
----
-
 Copyright (c) 2013 Sam Symons
 
 MIT License

data/lib/redd/clients/base.rb

@@ -130,6 +130,7 @@ module Redd
         @middleware ||= Faraday::RackBuilder.new do |builder|
           builder.use Response::RaiseError
           builder.use Response::ParseJson
+          builder.use Faraday::Request::Multipart
           builder.use Faraday::Request::UrlEncoded
           builder.adapter Faraday.default_adapter
         end

data/lib/redd/clients/base/stream.rb

@@ -56,19 +56,26 @@ module Redd
           bset = PRAWBoundedQueueSet.new(10)
           before = ""
           loop do
-            # Get the latest comments from the subreddit. By the way, this line
-            # is the one where the sleeping/rate-limiting happens.
-            params = kwargs.merge(before: before)
-            listing = send(meth, *args, **params)
-            # Run the loop for each of the item in the listing
-            listing.reverse_each do |thing|
-              yield thing if bset.enqueue?(thing.fullname)
+            begin
+              # Get the latest comments from the subreddit.
+              params = kwargs.merge(before: before)
+              listing = send(meth, *args, **params)
+              # Run the loop for each of the item in the listing
+              listing.reverse_each do |thing|
+                yield thing if bset.enqueue?(thing.fullname)
+              end
+              # Set the latest comment.
+              before = listing.first.fullname unless listing.empty?
+            rescue Redd::Error::RateLimited => error
+              # If this error pops up, you probably have an issue with your bot.
+              sleep(error.time)
+            rescue Redd::Error => error
+              # 5-something errors are usually errors on reddit's end.
+              raise error unless (500...600).include?(error.code)
             end
-            # Set the latest comment.
-            before = listing.first.fullname unless listing.empty?
           end
         end
-      end
-    end
+      end # <- See, this is why I sometimes prefer Python.
+    end # <- Thank god for code folding.
   end
 end

data/lib/redd/clients/base/submit.rb

@@ -3,41 +3,6 @@ module Redd
     class Base
       # Methods that require the "submit" scope
       module Submit
-        # Submit a link or a text post to a subreddit.
-        #
-        # @param [Objects::Submission, String] subreddit The subreddit
-        #   to submit to.
-        # @param [String] title The title of the submission.
-        # @param [String] captcha A possible captcha result to send if one
-        #   is required.
-        # @param [String] identifier The identifier for the captcha if one
-        #   is required.
-        # @param [String] text The text of the self-post.
-        # @param [String] url The URL of the link.
-        # @param [Boolean] resubmit Whether to post a link to a subreddit
-        #   despite it having been posted there before (you monster).
-        # @param [Boolean] sendreplies Whether to send the replies to your
-        #   inbox.
-        # @return [Objects::Thing] The returned result (url, id and name).
-        def submit(
-          subreddit, title, captcha = nil, identifier = nil, text: nil,
-          url: nil, resubmit: false, sendreplies: true
-        )
-
-          params = {
-            extension: "json", title: title,
-            resubmit: resubmit, sendreplies: sendreplies,
-            sr: property(subreddit, :display_name)
-          }
-
-          params << {captcha: captcha, iden: identifier} if captcha
-          params[:kind], params[:text] = :self, text if text
-          params[:kind], params[:url] = :link, url if url
-
-          response = post("/api/submit", params)
-          Objects::Thing.new(self, response.body[:json][:data])
-        end
-
         # Add a comment to a link, reply to a comment or reply to a message.
         # Bit of an all-purpose method, this one.
         # @param thing [Objects::Submission, Objects::Comment,

data/lib/redd/clients/base/utilities.rb

@@ -54,7 +54,7 @@ module Redd
         # @author Bryce Boe (@bboe) in Python
         # @return [Array<Objects::Comment, Objects::MoreComments>] A linear
         #   array of the submission's comments or the comments' replies.
-        def flat_comments(base)        
+        def flat_comments(base)
           meth = (base.is_a?(Objects::Submission) ? :comments : :replies)
           stack = base.send(meth).dup
           flattened = []
@@ -63,7 +63,7 @@ module Redd
             comment = stack.shift
             if comment.is_a?(Objects::Comment)
               replies = comment.replies
-              stack += replies if replies
+              stack = replies + stack if replies
             end
             flattened << comment
           end

data/lib/redd/objects/base.rb

@@ -11,8 +11,10 @@ module Redd
       include Hashie::Extensions::MethodQuery
       include Hashie::Extensions::DeepMerge
 
+      # The `delete` method is called `delete_path` because it conflicts with
+      # Hash#delete.
       extend Forwardable
-      def_delegators :@client, :get, :post, :put, :delete
+      def_delegators :@client, :get, :post, :put, :delete_path
 
       # @!attribute [r] client
       # @return [Clients::Base] The client that used to make requests.

data/lib/redd/objects/submission.rb

@@ -67,6 +67,38 @@ module Redd
           }
         )
       end
+
+      # Get the related articles.
+      # @param [Hash] params A list of params to send with the request.
+      # @option params [String] :after Return results after the given
+      #   fullname.
+      # @option params [String] :before Return results before the given
+      #   fullname.
+      # @option params [Integer] :count The number of items already seen
+      #   in the listing.
+      # @option params [1..100] :limit The maximum number of things to
+      #   return.
+      # @return [Objects::Listing<Objects::Thing>]
+      def get_related(**params)
+        related = get("/related/#{id}.json", params).body[1]
+        client.object_from_body(related)
+      end
+
+      # Get other articles with the same URL.
+      # @param [Hash] params A list of params to send with the request.
+      # @option params [String] :after Return results after the given
+      #   fullname.
+      # @option params [String] :before Return results before the given
+      #   fullname.
+      # @option params [Integer] :count The number of items already seen
+      #   in the listing.
+      # @option params [1..100] :limit The maximum number of things to
+      #   return.
+      # @return [Objects::Listing<Objects::Submission>]
+      def get_duplicates(**params)
+        duplicates = get("/duplicates/#{id}.json", params).body[1]
+        client.object_from_body(duplicates)
+      end
     end
   end
 end

data/lib/redd/objects/subreddit.rb

@@ -1,3 +1,4 @@
+require "fastimage"
 require_relative "thing"
 
 module Redd
@@ -14,6 +15,49 @@ module Redd
       alias_property :type, :subreddit_type
       alias_property :times_gilded, :gilded
 
+      # @!group Submissions
+
+      # Submit a link or a text post to the subreddit.
+      #
+      # @param [String] title The title of the submission.
+      # @param [String] captcha A possible captcha result to send if one
+      #   is required.
+      # @param [String] identifier The identifier for the captcha if one
+      #   is required.
+      # @param [String] text The text of the self-post.
+      # @param [String] url The URL of the link.
+      # @param [Boolean] resubmit Whether to post a link to the subreddit
+      #   despite it having been posted there before (you monster).
+      # @param [Boolean] sendreplies Whether to send the replies to your
+      #   inbox.
+      # @return [Objects::Thing] The returned result (url, id and name).
+      def submit(
+        title, captcha = nil, identifier = nil, text: nil, url: nil,
+        resubmit: false, sendreplies: true
+      )
+
+        params = {
+          extension: "json", title: title, sr: display_name,
+          resubmit: resubmit, sendreplies: sendreplies
+        }
+
+        params << {captcha: captcha, iden: identifier} if captcha
+        params[:kind], params[:text] = :self, text if text
+        params[:kind], params[:url] = :link, url if url
+
+        response = post("/api/submit", params)
+        Objects::Thing.new(self, response.body[:json][:data])
+      end
+
+      # Add a comment to the submission.
+      # @param text [String] The text to comment.
+      # @return [Objects::Comment] The reply.
+      def add_comment(text)
+        client.add_comment(self, text)
+      end
+
+      # @!endgroup
+
       # @!group Stylesheets
 
       # @return [String] The url for the subreddit's stylesheet.
@@ -172,6 +216,10 @@ module Redd
         client.search(query, self, **params)
       end
 
+      # @!endgroup
+
+      # @!group Moderation
+
       # @!method get_reports(**params)
       # @!method get_spam(**params)
       # @!method get_modqueue(**params)
@@ -201,10 +249,6 @@ module Redd
         end
       end
 
-      # @!endgroup
-
-      # @!group Moderator Settings
-
       # @return [Objects::Base] The current settings of a subreddit.
       def admin_about
         client.request_object(:get, "/r/#{display_name}/about/edit.json")
@@ -212,33 +256,62 @@ module Redd
 
       # Edit the subreddit's settings
       # @param [Hash] attributes The subreddit's new settings.
-      # @author Takashi M (@beatak) and Avinash Dwarapu (@avidw)
       # @note This method may make additional requests if not all of the
-      #   required attributes are provided.
+      #   required attributes are provided. Take a look at the source for the
+      #   required attributes required to avoid making the additional request.
       # @see https://github.com/alaycock/MeetCal-bot/blob/master/serverInfo.conf
       def admin_edit(attributes)
-        params = {sr: fullname}
-        required_attributes = %i(
+        params = {
+          # Subreddit name
+          sr: fullname,
+          # Apparently useless options
+          show_cname_sidebar: true,
+          :"header-title" => title
+        }
+
+        required = %i(
           allow_top collapse_deleted_comments comment_score_hide_mins
-          css_on_cname description exclude_banned_modqueue lang name over_18
-          public_description public_traffic show_cname_sidebar show_media
-          spam_comments spam_links spam_selfposts submit_link_label
-          submit_text submit_text_label title type wiki_edit_age
-          wiki_edit_karma wikimode header-title
+          css_on_cname description exclude_banned_modqueue lang link_type name
+          over_18 public_description public_traffic show_media spam_comments
+          spam_links spam_selfposts submit_link_label submit_text
+          submit_text_label title type wiki_edit_age wiki_edit_karma wikimode
         )
 
-        if required_attributes.all? { |key| attributes.key?(key) }
+        if required.all? { |key| attributes.key?(key) }
           params.merge!(attributes)
         else
-          current = admin_about
-          current.delete(:kind)
-          complete = current.merge(attributes)
-          params.merge!(complete)
+          about = admin_about
+          final = about
+            .select { |k, _| required.include?(k) }
+            .merge(
+              name: display_name,
+              type: about[:subreddit_type],
+              lang: about[:language],
+              link_type: about[:content_options],
+              allow_top: true,
+              css_on_cname: true
+            )
+            .merge(attributes)
+          params.merge!(final)
         end
 
         post("/api/site_admin", params)
       end
 
+      # Add or replace the subreddit image or header logo.
+      # @param [String, IO] file The path/url to the file or the file itself.
+      # @param [String] name The name of the uploaded file.
+      # @return [String] The url of the image on reddit's CDN.
+      def upload_image(file, name = nil)
+        io = (file.is_a?(IO) ? file : File.open(file, "r"))
+        type = FastImage.type(io)
+        payload = Faraday::UploadIO.new(io, "image/#{type}")
+
+        params = {file: payload, header: (name ? 0 : 1), img_type: type}
+        params[:name] = name if name
+        post("/r/#{display_name}/api/upload_sr_img", params).body[:img_src]
+      end
+
       # @!endgroup
     end
   end

data/lib/redd/objects/thing.rb

@@ -21,13 +21,6 @@ module Redd
       def fullname
         self[:name] || "#{kind}_#{id}"
       end
-
-      private
-
-      def response_merge!(meth, path, params = {})
-        body = client.send(meth, path, params).body
-        deep_merge!(body[:data])
-      end
     end
   end
 end

data/lib/redd/version.rb

@@ -1,4 +1,4 @@
 module Redd # rubocop:disable Style/Documentation
   # The semantic version number.
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

data/redd.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hashie", "~> 3.4.0"
   spec.add_dependency "faraday", "~> 0.9.1"
   spec.add_dependency "multi_json", "~> 1.10.1"
+  spec.add_dependency "fastimage", "~> 1.6.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
 description: 
 email:
 - avinash@dwarapu.me
@@ -134,10 +148,10 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
-- RedditKit.LICENSE.txt
+- RedditKit.LICENSE.md
 - lib/redd.rb
 - lib/redd/access.rb
 - lib/redd/clients/base.rb