redd 0.7.10 → 0.8.0.pre.1

data/lib/redd/objects/thing.rb

@@ -1,26 +0,0 @@
-require_relative "base"
-
-module Redd
-  module Objects
-    # A reddit thing.
-    # @see http://www.reddit.com/dev/api#fullnames
-    class Thing < Base
-      # Load up all the possible mixins for the thing.
-      Dir[File.join(File.dirname(__FILE__), "thing", "*.rb")].each do |file|
-        require(file)
-      end
-
-      # Check for equality.
-      # @param other The other object.
-      # @return [Boolean]
-      def ==(other)
-        other.is_a?(Thing) && fullname == other.fullname
-      end
-
-      # @return [String] The fullname of the thing.
-      def fullname
-        self[:name] || "#{kind}_#{id}"
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/editable.rb

@@ -1,22 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be edited and deleted.
-      module Editable
-        # Edit a thing.
-        # @param text [String] The new text.
-        # @return [Thing] The edited thing.
-        def edit(text)
-          post("/api/editusertext", thing_id: fullname, text: text)
-          self[(self.is_a?(Submission) ? :selftext : :body)] = text
-          self
-        end
-
-        # Delete the thing
-        def delete!
-          post("/api/del", id: fullname)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/hideable.rb

@@ -1,18 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be hidden from the user.
-      module Hideable
-        # Hide a link from the user.
-        def hide
-          post("/api/hide", id: fullname)
-        end
-
-        # Unhide a previously hidden link.
-        def unhide
-          post("/api/unhide", id: fullname)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/inboxable.rb

@@ -1,25 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be sent to a user's inbox.
-      module Inboxable
-        # Mark this thing as read.
-        def mark_as_read
-          post("/api/read_message", id: fullname)
-        end
-
-        # Mark one or more messages as unread.
-        def mark_as_unread
-          post("/api/unread_message", id: fullname)
-        end
-
-        # Reply to the thing.
-        # @param text [String] The text to comment.
-        # @return [Objects::Comment, Objects::PrivateMessage] The reply.
-        def reply(text)
-          client.add_comment(self, text)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/messageable.rb

@@ -1,34 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be sent a message.
-      module Messageable
-        # Compose a message to a person or the moderators of a subreddit.
-        #
-        # @param [String] subject The subject of the message.
-        # @param [String] text The message text.
-        # @param [String] from_sr The subreddit to send the message on behalf
-        #   of or nil if from the user.
-        # @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.
-        def send_message(
-          subject, text, from_sr = nil, captcha = nil, identifier = nil
-        )
-          params = {subject: subject, text: text}
-          params.merge!(captcha: captcha, iden: identifier) if captcha
-          params[:from_sr] = client.property(from_sr, :display_name) if from_sr
-          params[:to] =
-            if respond_to?(:display_name)
-              "/r/#{self[:display_name]}"
-            else
-              self[:name]
-            end
-
-          post("/api/compose", params)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/moderatable.rb

@@ -1,43 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that a moderator can manage.
-      module Moderatable
-        # Approve a submission.
-        def approve!
-          post("/api/approve", id: fullname)
-        end
-
-        # Remove a submission.
-        # @param [Boolean] spam Whether or not this item is removed due to it
-        #   being spam.
-        def remove!(spam = false)
-          post("/api/remove", id: fullname, spam: spam)
-        end
-
-        # Distinguish a link or comment with a sigil to show that it has
-        # been created by a moderator.
-        # @param [:yes, :no, :admin, :special] how How to distinguish the
-        #   thing.
-        def distinguish(how = :yes)
-          post("/api/distinguish", id: fullname, how: how)
-        end
-
-        # Remove the sigil that shows a thing was created by a moderator.
-        def undistinguish
-          distinguish(:no)
-        end
-
-        # Stop getting any moderator-related reports on the thing.
-        def ignore_reports
-          post("/api/ignore_reports", id: fullname)
-        end
-
-        # Start getting moderator-related reports on the thing again.
-        def unignore_reports
-          post("/api/unignore_reports", id: fullname)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/refreshable.rb

@@ -1,14 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be refreshed with the current data.
-      module Refreshable
-        # Refresh the thing.
-        def refresh!
-          body = get("/api/info", id: fullname).body[:data][:children][0]
-          deep_merge!(body[:data])
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/saveable.rb

@@ -1,21 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be saved to a user's account.
-      module Saveable
-        # Save a link or comment (if gilded) to the user's account.
-        # @param [String] category A category to save to (if gilded).
-        def save(category = nil)
-          params = {id: fullname}
-          params.merge!(category: category) if category
-          post("/api/save", params)
-        end
-
-        # Remove the link or comment from the user's saved links.
-        def unsave
-          post("/api/unsave", id: fullname)
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/thing/votable.rb

@@ -1,33 +0,0 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be voted upon.
-      module Votable
-        # Upvote the thing.
-        def upvote
-          vote(1)
-        end
-
-        # Downvote the thing.
-        def downvote
-          vote(-1)
-        end
-
-        # Remove your vote on the thing.
-        def clear_vote
-          vote(0)
-        end
-        alias_method :unvote, :clear_vote
-
-        private
-
-        # Send a vote.
-        # @param [-1, 0, 1] direction The direction to vote in.
-        def vote(direction)
-          post("/api/vote", id: fullname, dir: direction)
-          self[:ups] += direction
-        end
-      end
-    end
-  end
-end

data/lib/redd/objects/user.rb

@@ -1,52 +0,0 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # The model for a reddit user
-    class User < Thing
-      include Thing::Messageable
-
-      # @!method get_overview(**params)
-      # @!method get_submitted(**params)
-      # @!method get_comments(**params)
-      # @!method get_liked(**params)
-      # @!method get_disliked(**params)
-      # @!method get_hidden(**params)
-      # @!method get_saved(**params)
-      # @!method get_gilded(**params)
-      #
-      # Get the appropriate listing.
-      # @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 [:hot, :new, :top, :controversial] :sort The type of
-      #   sort to use.
-      # @option params [:hour, :day, :week, :month, :year, :all] :t The
-      #   time period to consider when sorting.
-      # @option params [:given] :show For {#get_gilded}, whether to show the
-      #   gildings given.
-      # @note The option :t only applies to the top and controversial sorts.
-      # @return [Listing<Submission>]
-      %w(
-        overview submitted comments liked disliked hidden saved gilded
-      ).each do |type|
-        define_method :"get_#{type}" do |**params|
-          client.request_object(
-            :get, "/user/#{name}/#{type}.json", **params
-          )
-        end
-      end
-
-      # Get posts that the user has gilded.
-      # @see #get_gilded
-      def get_gildings_given(**params)
-        get_gilded(**params.merge(show: "given"))
-      end
-    end
-  end
-end

data/lib/redd/objects/wiki_page.rb

@@ -1,15 +0,0 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A submission made in a subreddit.
-    class WikiPage < Thing
-      alias_property :content, :content_md
-      alias_property :body, :content_md
-
-      def revision_user
-        @revision_by ||= client.object_from_body(revision_by)
-      end
-    end
-  end
-end

data/lib/redd/rate_limit.rb

@@ -1,88 +0,0 @@
-# The main Redd module.
-module Redd
-  # The class that handles rate limiting for reddit.
-  #
-  # If you'd rather have an asynchronous or queue-based limiting, it's easy to
-  # write one yourself. A rate limiting class is any class that has an
-  # {#after_limit} method. The block returns a Faraday::Response object, so you
-  # can also extract the headers from the response and use those instead. To
-  # remove rate limiting entirely, follow the example below.
-  #
-  # @example To remove rate limiting entirely, just burst forever.
-  #     rt = Redd::RateLimit.new
-  #     rt.burst!(Float::INFINITY)
-  class RateLimit
-    # @!attribute [rw] gap
-    # @return [Integer, Float] The minimum time between requests.
-    attr_accessor :gap
-
-    # @!attribute [rw] burst_length
-    # @return [Integer] The number of requests left to burst.
-    attr_accessor :burst_length
-
-    # @!attribute [r] last_request
-    # @return [Time] The time the last request was made.
-    attr_reader :last_request
-
-    # @!attribute [r] used
-    # @!attribute [r] remaining
-    # @!attribute [r] reset
-    # @return [Integer] The data from reddit's response headers.
-    attr_reader :used, :remaining, :reset
-
-    # @param [Float, Integer] gap The minimum time between each request.
-    def initialize(gap)
-      # Some time ages ago, because we never made a request.
-      @last_request = Time.at(0)
-      @gap = gap
-      @burst_length = 0
-    end
-
-    # Don't sleep for the next few requests.
-    # @param [Integer] times The number of times to ignore limiting.
-    # @return [Integer] The total times rate limiting will be ignored.
-    def burst!(times)
-      @burst_length += times
-    end
-
-    # Sleep until 1 second has passed since the last request and perform the
-    # given request unless bursting.
-    #
-    # @yield [Faraday::Response] A response.
-    # @return [Faraday::Response] The response.
-    def after_limit
-      response = yield
-      update!(response)
-      sleep(wait_time)
-      response
-    end
-
-    private
-
-    # Update necessary info with each request.
-    # @param [Faraday::Response] response The response to the request made.
-    def update!(response)
-      @last_request_time = Time.now
-      %w(used remaining reset).each do |type|
-        value = response.headers["x-ratelimit-#{type}"]
-        instance_variable_set("@#{type}", value.to_i) unless value.nil?
-      end
-    end
-
-    # @return [Float, Integer] The number of seconds to sleep.
-    def wait_time
-      if @burst_length > 0 && @remaining > 0
-        # Don't sleep if we are in burst mode.
-        @burst_length -= 1
-        0
-      elsif @reset.nil? || @remaining.nil?
-        # Just guess if no headers were given (max 1 sec after last request).
-        time = @last_request_time - Time.now + @gap
-        time > 0 ? time : 0
-      else
-        # Most cases, spread out requests over available time.
-        @reset.to_f / (@gap * @remaining + 1)
-      end
-    end
-  end
-end

data/lib/redd/response/parse_json.rb

@@ -1,18 +0,0 @@
-require "faraday/response"
-require_relative "../error"
-
-module Redd
-  # The module that contains middleware that alters the Faraday response.
-  module Response
-    # Faraday Middleware that parses JSON using OJ, via MultiJson.
-    class ParseJson < Faraday::Response::Middleware
-      dependency "multi_json"
-
-      def on_complete(env)
-        env[:body] = MultiJson.load(env[:body], symbolize_keys: true)
-      rescue MultiJson::ParseError
-        raise ::Redd::Error::JSONError.new(env), env[:body]
-      end
-    end
-  end
-end

data/lib/redd/response/raise_error.rb

@@ -1,16 +0,0 @@
-require "faraday/response"
-require_relative "../error"
-
-module Redd
-  # The module that contains middleware that alters the Faraday response.
-  module Response
-    # Faraday Middleware that raises an error if there's one.
-    # @see Error
-    class RaiseError < Faraday::Response::Middleware
-      def on_complete(env)
-        error = Redd::Error.from_response(env)
-        fail error.new(env), env[:body] if error
-      end
-    end
-  end
-end

data/spec/redd/objects/base_spec.rb

@@ -1 +0,0 @@
-# There's no point in testing Base, since we'd basically be testing Hashie.