redd 0.7.10 → 0.8.0.pre.1

data/lib/redd/objects/comment.rb

@@ -1,22 +0,0 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A comment that can be made on a link.
-    class Comment < Thing
-      include Thing::Editable
-      include Thing::Inboxable
-      include Thing::Moderatable
-      include Thing::Refreshable
-      include Thing::Saveable
-      include Thing::Votable
-
-      alias_property :reports_count, :num_reports
-
-      # @return [Listing] The comment's replies.
-      def replies
-        @replies ||= (client.object_from_body(self[:replies]) || [])
-      end
-    end
-  end
-end

data/lib/redd/objects/labeled_multi.rb

@@ -1,13 +0,0 @@
-module Redd
-  module Objects
-    # A comment that can be made on a link.
-    class LabeledMulti < Base
-      # @see Objects::Base
-      def initialize(client, attributes = {})
-        attr_dup = attributes.dup
-        attr_dup[:subreddits].map! { |sub| sub[:name] }
-        super(client, attr_dup)
-      end
-    end
-  end
-end

data/lib/redd/objects/listing.rb

@@ -1,29 +0,0 @@
-module Redd
-  module Objects
-    # A collection of reddit things.
-    # @see https://www.reddit.com/dev/api#listings
-    class Listing < Array
-      # @!attribute [r] before
-      # @return [String] The id of the object before the listing.
-      attr_reader :before
-
-      # @!attribute [r] after
-      # @return [String] The id of the object after the listing.
-      attr_reader :after
-
-      # @param [Clients::Base] client The client to expand the comments with.
-      # @param [{:before => String, :after => String,
-      #   :children => Array<Hash>}] attributes The data to initialize the
-      #   class with.
-      # @todo Only call Clients::Base#object_from_body when item is being
-      #   accessed.
-      def initialize(client, attributes)
-        @before = attributes[:before]
-        @after = attributes[:after]
-        attributes[:children].each do |child|
-          self << (client.object_from_body(child) || child)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/more_comments.rb

@@ -1,11 +0,0 @@
-module Redd
-  module Objects
-    # The model for a morecomments object
-    class MoreComments < Array
-      def initialize(_, attributes)
-        #Return an empty arrar if there are no children
-        super(attributes[:children]) if attributes[:children]
-      end
-    end
-  end
-end

data/lib/redd/objects/private_message.rb

@@ -1,28 +0,0 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # The model for private messages
-    class PrivateMessage < Thing
-      include Thing::Inboxable
-
-      alias_property :from, :author
-      alias_property :to, :dest
-
-      # Block the sender of the message from sending any more.
-      def block_sender!
-        post("/api/block", id: fullname)
-      end
-
-      # Mark the message as read.
-      def mark_as_read
-        post("/api/read_message", id: fullname)
-      end
-
-      # Mark the message as unread and add orangered to account.
-      def mark_as_unread
-        post("/api/unread_message", id: fullname)
-      end
-    end
-  end
-end

data/lib/redd/objects/submission.rb

@@ -1,139 +0,0 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A submission made in a subreddit.
-    class Submission < Thing
-      include Thing::Editable
-      include Thing::Hideable
-      include Thing::Moderatable
-      include Thing::Refreshable
-      include Thing::Saveable
-      include Thing::Votable
-
-      alias_property :nsfw?, :over_18
-      alias_property :self?, :is_self
-      alias_property :comments_count, :num_comments
-
-      # The shorter url for sharing.
-      def short_url
-        "http://redd.it/#{self[:id]}"
-      end
-
-      # Whether the comment was gilded.
-      def gilded?
-        self[:gilded] > 0
-      end
-
-      # Mark the thing as Not Suitable For Work.
-      def mark_as_nsfw
-        get("/api/marknsfw", id: fullname)
-        self[:over_18] = true
-      end
-
-      # No longer mark the thing as Not Suitable For Work.
-      def unmark_as_nsfw
-        get("/api/unmarknsfw", id: fullname)
-        self[:over_18] = false
-      end
-      alias_method :mark_as_safe, :unmark_as_nsfw
-
-      # Reply to the thing.
-      # @param text [String] The text to comment.
-      # @return [Objects::Comment] The reply.
-      def add_comment(text)
-        client.add_comment(self, text)
-      end
-
-      # Set the submission to "contest mode" (comments are randomly sorted)
-      def set_contest_mode
-        post("/api/set_contest_mode", id: fullname, state: true)
-      end
-
-      # Unset the "contest mode".
-      def unset_contest_mode
-        post("/api/set_contest_mode", id: fullname, state: false)
-      end
-
-      # Set the submission as the sticky post of the subreddit
-      def set_sticky
-        post("/api/set_subreddit_sticky", id: fullname, state: true)
-        self[:stickied] = true
-      end
-
-      # Unsticky the post from the subreddit
-      def unset_sticky
-        post("/api/set_subreddit_sticky", id: fullname, state: false)
-        self[:stickied] = false
-      end
-
-      # @return [Listing] The submission's comments.
-      # @todo Allow for various depths and contexts and what not. Maybe a
-      #   get_comment method?
-      def comments
-        refresh! unless @comments
-        @comments
-      end
-      alias_method :replies, :comments
-
-      # Refresh the submission AND its comments.
-      # @return [Submission] The updated submission.
-      def refresh!
-        body = get("/comments/#{id}.json").body
-        @comments = client.object_from_body(body[1])
-        deep_merge!(body[0])
-      end
-
-      # Take a MoreComments and return a listing of comments.
-      # @param [MoreComments] more The object to expand.
-      # @return [Listing] A listing of the expanded comments.
-      def expand_more(more)
-        response = client.get(
-          "/api/morechildren",
-          children: more.join(","),
-          link_id: fullname
-        )
-
-        client.object_from_body(
-          kind: "Listing",
-          data: {
-            before: "", after: "",
-            children: response.body[:json][:data][:things]
-          }
-        )
-      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,330 +0,0 @@
-require "fastimage"
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A comment made on links.
-    # @todo #subscribe! and #unsubscribe!
-    class Subreddit < Thing
-      include Thing::Messageable
-      include Thing::Refreshable
-
-      alias_property :header_image, :header_img
-      alias_property :nsfw?, :over18
-      alias_property :users_online, :accounts_active
-      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.merge!(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.
-      def stylesheet_url
-        get("/r/#{display_name}/stylesheet").headers["location"]
-      end
-
-      # @return [String] The css for the subreddit.
-      def stylesheet
-        Faraday.get(stylesheet_url).body
-      end
-
-      # Edit the subreddit's stylesheet
-      #
-      # @param [String] contents The new CSS.
-      # @param [String] reason Why you modified the stylesheet.
-      # @author Takashi M (@beatak) and Avinash Dwarapu (@avidw)
-      # @note https://www.reddit.com/r/naut/about/stylesheet/ is a good place
-      #   to test if you have an error.
-      def edit_stylesheet(contents, reason = nil)
-        params = {op: "save", stylesheet_contents: contents}
-        params[:reason] = reason if reason
-        post("/r/#{display_name}/api/subreddit_stylesheet", params)
-      end
-
-      # @!endgroup
-
-      # @!group Invites
-
-      # Accept a moderator invite from a subreddit.
-      def accept_moderator_invite!
-        post("/r/#{display_name}/api/accept_moderator_invite")
-      end
-
-      # Stop being a contributor of the subreddit.
-      def leave_contributor_status!
-        post("/api/leavecontributor", id: fullname)
-      end
-
-      # Stop being a moderator of the subreddit.
-      def leave_moderator_status!
-        post("/api/leavemoderator", id: fullname)
-      end
-
-      # @!endgroup
-
-      # @!group Flairs
-
-      # Get a list of everbody on the subreddit with a user flair.
-      #
-      # @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..1000] :limit The maximum number of things to
-      #   return.
-      # @option params [String] :name The username when getting the flair of
-      #   just one user.
-      # @return [Objects::Listing<Hash>] A listing of flair hashes.
-      def get_flairlist(**params)
-        body = get("/r/#{display_name}/api/flairlist.json", params).body
-        client.object_from_body(
-          kind: "Listing",
-          data: {
-            children: body[:users],
-            before: body[:prev],
-            after: body[:next]
-          }
-        )
-      end
-
-      # Get the flair of a user.
-      #
-      # @param [Objects::User, String] user The user to find.
-      # @return [Hash, nil] Flair info about the user or nil if nobody was
-      #   found.
-      def get_flair(user)
-        username = client.property(user, :name)
-        flair = get_flairlist(user: username).first
-        flair if flair[:user].casecmp(username) == 0
-      end
-
-      # Set the flair of a user or link.
-      # @param [Objects::Subreddit, Objects::User] thing The user or link to
-      #   set the flair to.
-      # @param [:user, :link] type The type of thing.
-      # @param [String] text The text to set the flair to.
-      # @param [String] css_class The css_class of the flair.
-      def set_flair(thing, type = nil, text = nil, css_class = nil)
-        params = {text: text, css_class: css_class}
-        if thing.is_a?(Objects::User) || type == :user
-          params[:name] = client.property(thing, :name)
-        elsif thing.is_a?(Objects::Submission) || type == :link
-          params[:link] = client.property(thing, :fullname)
-        else
-          fail "You should provide a proper type."
-        end
-
-        post("/r/#{display_name}/api/flair", params)
-      end
-
-      # @!endgroup
-
-      # @!group Listings
-
-      # @!method get_hot(**params)
-      # @!method get_new(**params)
-      # @!method get_top(**params)
-      # @!method get_controversial(**params)
-      # @!method get_comments(**params)
-      #
-      # Get the appropriate listing.
-      # @param params [Hash] 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 (0) The number of items already seen
-      #   in the listing.
-      # @option params [1..100] :limit (25) The maximum number of things to
-      #   return.
-      # @option params [:hour, :day, :week, :month, :year, :all] :t The
-      #   time period to consider when sorting.
-      #
-      # @note The option :t only applies to the top and controversial sorts.
-      # @return [Objects::Listing<Objects::Thing>]
-      %w(hot new top controversial comments).each do |sort|
-        define_method :"get_#{sort}" do |**params|
-          client.send(:"get_#{sort}", self, **params)
-        end
-      end
-
-      # Search.
-      # @param query [String] The query string.
-      # @param params [Hash] 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.
-      # @option params [:cloudsearch, :lucene, :plain] :syntax The type of
-      #   syntax to use.
-      # @option params [:relevance, :new, :hot, :top, :comments] :sort The
-      #   way to sort the results.
-      # @option params [:hour, :day, :week, :month, :year, :all] :t The
-      #   time period to consider when sorting.
-      #
-      # @note The option :t only applies to the top and controversial sorts.
-      # @return [Objects::Listing<Objects::Thing>]
-      def search(query, **params)
-        client.search(query, self, **params)
-      end
-
-      # @!endgroup
-
-      # @!group Moderation
-
-      # @!method get_reports(**params)
-      # @!method get_spam(**params)
-      # @!method get_modqueue(**params)
-      # @!method get_unmoderated(**params)
-      # @!method get_edited(**params)
-      #
-      # Get the appropriate moderator listing.
-      # @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.
-      # @option params :location No idea what this does.
-      # @option params [:links, :comments] :only The type of things to show.
-      #
-      # @return [Objects::Listing<Objects::Thing>]
-      # @see https://www.reddit.com/dev/api#GET_about_{location}
-      %w(reports spam modqueue unmoderated edited).each do |sort|
-        define_method :"get_#{sort}" do |**params|
-          client.request_object(
-            :get, "/r/#{display_name}/about/#{sort}", params
-          )
-        end
-      end
-
-      # @return [Objects::Base] The current settings of a subreddit.
-      def admin_about
-        client.request_object(:get, "/r/#{display_name}/about/edit.json")
-      end
-
-      # @return [Objects::Base] The current moderators of a subreddit.
-      def moderator_about
-        body = get("/r/#{display_name}/about/moderators.json").body
-        client.object_from_body(
-          kind: "Listing",
-          data: {
-            children: body[:data][:children]
-          }
-        )
-      end
-
-      # Edit the subreddit's settings
-      # @param [Hash] attributes The subreddit's new settings.
-      # @note This method may make additional requests if not all of the
-      #   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 = {
-          # 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 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.all? { |key| attributes.key?(key) }
-          params.merge!(attributes)
-        else
-          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
-end