redd 0.6.5 → 0.7.0

data/lib/redd/client/unauthenticated/users.rb

@@ -1,67 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods to interact with other redditors
-      module Users
-        # Return a User object from the username of a redditor.
-        # @param username [String] The username.
-        # @return [Redd::Object::User]
-        def user(username)
-          object_from_response :get, "/user/#{username}/about.json"
-        end
-
-        # @!method get_user_overview
-        # @!method get_user_submitted
-        # @!method get_user_comments
-        # @!method get_user_liked
-        # @!method get_user_disliked
-        # @!method get_user_hidden
-        # @!method get_user_saved
-        # @!method get_user_gilded
-        #
-        # Get the appropriate listing.
-        # @param user [Redd::Object::User] The user to query.
-        # @param params [Hash] A list of params to send with the request.
-        # @return [Redd::Object::Listing]
-        #
-        # @see #get_user_listing
-        %w(
-          overview submitted comments liked disliked hidden saved gilded
-        ).each do |sort|
-          define_method :"get_user_#{sort}" do |user, params = {}|
-            get_user_listing(user, sort, params)
-          end
-        end
-
-        private
-
-        # Get comments and submissions related to a user.
-        #
-        # @param user [Redd::Object::User, String] The user to query.
-        # @param type [:overview, :submitted, :comments, :liked, :disliked,
-        #   :hidden, :saved, :gilded] The type of listing to return.
-        # @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 [:hot, :new, :top, :controversial] :sort The order to
-        #   sort the results by.
-        # @option params [:hour, :day, :week, :month, :year, :all] :t The
-        #   time period to consider when sorting.
-        # @return [Redd::Object::Listing] A listing of submissions or comments.
-        def get_user_listing(user, type, params = {})
-          name = extract_attribute(user, :name)
-          path = "/user/#{name}/#{type}.json"
-          params[:show] ||= :given
-
-          object_from_response :get, path, params
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/unauthenticated/utilities.rb

@@ -1,109 +0,0 @@
-require "redd/thing"
-require "redd/object/listing"
-require "redd/object/comment"
-require "redd/object/more_comments"
-require "redd/object/private_message"
-require "redd/object/submission"
-require "redd/object/subreddit"
-require "redd/object/user"
-require "redd/object/wiki_page"
-
-module Redd
-  module Client
-    class Unauthenticated
-      # Non-API methods that make life easier
-      module Utilities
-        def comment_stream(*args, &block)
-          submission_stream(:comments, *args, &block)
-        end
-
-        def submission_stream(listing, subreddit = nil, params = {}, &block)
-          loop do
-            # Get the latest comments from the subreddit. By the way, this line
-            #   is the one where the sleeping/rate-limiting happens.
-            objects = get_listing(listing, subreddit, params)
-            unless objects.empty?
-              # Run the loop for each of the new comments accessed.
-              # I should probably add it to a Set to avoid duplicates.
-              objects.reverse_each { |object| block.call(object) }
-              # Set the latest comment.
-              params[:before] = objects.first.fullname
-            end
-          end
-        end
-
-        private
-
-        def extract_attribute(object, attribute)
-          case object
-          when ::String
-            object
-          else
-            object.send(attribute)
-          end
-        end
-
-        def extract_fullname(object)
-          extract_attribute(object, :fullname)
-        end
-
-        def extract_id(object)
-          extract_attribute(object, :id)
-        end
-
-        # rubocop:disable Style/MethodLength, Style/CyclomaticComplexity
-        def object_from_kind(kind)
-          case kind
-          when "Listing"
-            Redd::Object::Listing
-          when "more"
-            Redd::Object::MoreComments
-          when "t1"
-            Redd::Object::Comment
-          when "t2"
-            Redd::Object::User
-          when "t3"
-            Redd::Object::Submission
-          when "t4"
-            Redd::Object::PrivateMessage
-          when "t5"
-            Redd::Object::Subreddit
-          when "wikipage"
-            Redd::Object::WikiPage
-          else
-            Redd::Thing
-          end
-        end
-        # rubocop:enable Style/MethodLength, Style/CyclomaticComplexity
-
-        def objects_from_listing(thing)
-          thing[:data][:children].map do |child|
-            object_from_body(child)
-          end
-        end
-
-        def object_from_body(body)
-          return nil unless body.is_a?(Hash) && body.key?(:kind)
-          object = object_from_kind(body[:kind])
-
-          if object == Redd::Object::Listing
-            body[:data][:children] = objects_from_listing(body)
-            object.new(body)
-          else
-            object.new(self, body)
-          end
-        end
-
-        def comments_from_response(*args)
-					body = request(*args).body[1]
-          object_from_body(body)
-        end
-
-        def object_from_response(*args)
-					body = request(*args).body
-          object_from_body(body)
-        end
-      end
-    end
-  end
-end

data/lib/redd/client/unauthenticated/wiki.rb

@@ -1,33 +0,0 @@
-module Redd
-  module Client
-    class Unauthenticated
-      # Methods to interact with subreddit wikis
-      module Wiki
-        # Get a list of pages in the subreddit wiki.
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   look in.
-        # @return [Array] An array of wikipage titles.
-        def get_wikipages(subreddit = nil)
-          name = extract_attribute(subreddit, :display_name)
-
-          path = "/wiki/pages.json"
-          path.prepend("/r/#{name}") if subreddit
-          get(path)[:data]
-        end
-
-        # Get a wiki page.
-        # @param page [String] The title of the wiki page.
-        # @param subreddit [Redd::Object::Subreddit, String] The subreddit to
-        #   look in.
-        # @return [Redd::Object::WikiPage] A wiki page.
-        def wikipage(page, subreddit = nil)
-          name = extract_attribute(subreddit, :display_name)
-
-          path = "/wiki/#{page}.json"
-          path.prepend("/r/#{name}") if subreddit
-          object_from_response :get, path
-        end
-      end
-    end
-  end
-end

data/lib/redd/oauth2_access.rb

@@ -1,70 +0,0 @@
-require "multi_json"
-
-module Redd
-  # A container for the client's access to their account via OAuth2
-  class OAuth2Access
-    # @!attribute [r] access_token
-    #   @return [String] The access token used to access the users account.
-    attr_reader :access_token
-
-    # @!attribute [r] refresh_token
-    #   @return [String, nil] The refresh token, if the access was permanent.
-    attr_reader :refresh_token
-
-    # @!attribute [r] scope
-    #   @return [Array] The scope that the client is allowed to access.
-    attr_reader :scope
-
-    # @!attribute [r] duration
-    #   @return [Symbol] Time the client is given access (temporary/permanent)
-    attr_reader :duration
-
-    # @!attribute [r] expires_at
-    #   @return [Time] The time when the access token expires.
-    attr_reader :expires_at
-
-    # @param response [String] The response body containing the required info.
-    def initialize(response)
-      @access_token = response[:access_token]
-      @refresh_token = response[:refresh_token]
-      @scope = response[:scope].split(",").map { |s| s.to_sym }
-      @duration = @refresh_token ? :permanent : :temporary
-      @expires_at =
-        if response[:expires_at]
-          Time.at(response[:expires_at])
-        else
-          Time.now + response[:expires_in]
-        end
-    end
-
-    # Refresh the object with the new response.
-    # This happens when a new access token is requested using a request token.
-    # @param response [Hash] The new response body.
-    def refresh(response)
-      @access_token = response[:access_token]
-      @expires_at = Time.now + response[:expires_in]
-    end
-
-    # @return [Boolean] Whether the access has expired.
-    def expired?
-      Time.now > @expires_at
-    end
-
-    # @return [String] A JSON representation of the data that can be loaded later.
-    def to_json
-      MultiJson.dump(
-        access_token: @access_token,
-        refresh_token: @refresh_token,
-        scope: @scope.join(","),
-        expires_at: @expires_at.to_i
-      )
-    end
-
-    # Create a new instance of the class from the JSON returned from #to_json
-    # @return [OAuth2Access]
-    def self.from_json(json)
-      hash = MultiJson.load(json, symbolize_keys: true)
-      new(hash)
-    end
-  end
-end

data/lib/redd/object/comment.rb

@@ -1,74 +0,0 @@
-require "redd/thing"
-
-module Redd
-  module Object
-    # A comment made on links.
-    class Comment < Redd::Thing
-      require "redd/thing/commentable"
-      require "redd/thing/editable"
-      require "redd/thing/inboxable"
-      require "redd/thing/moderatable"
-      require "redd/thing/reportable"
-      require "redd/thing/voteable"
-
-      include Redd::Thing::Commentable
-      include Redd::Thing::Editable
-      include Redd::Thing::Inboxable
-      include Redd::Thing::Moderatable
-      include Redd::Thing::Reportable
-      include Redd::Thing::Voteable
-
-      attr_reader :author
-
-      attr_reader :edited
-      attr_reader :saved
-      attr_reader :gilded
-
-      attr_reader :ups
-      attr_reader :downs
-      attr_reader :score
-      attr_reader :likes
-      attr_reader :controversiality
-
-      attr_reader :banned_by
-      attr_reader :approved_by
-      attr_reader :score_hidden
-      attr_reader :distinguished
-      attr_reader :num_reports
-
-      attr_reader :parent_id
-      attr_reader :link_id
-      attr_reader :body
-      attr_reader :body_html
-      attr_reader :author_flair_text
-      attr_reader :author_flair_css_class
-
-      alias_method :reports_count, :num_reports
-
-      def comments
-        @comments ||= client.get_replies(self)
-      end
-      alias_method :replies, :comments
-
-      def subreddit
-        @subreddit ||= client.subreddit(@attributes[:subreddit])
-      end
-
-      def submission
-        @submission ||= client.get_info(id: link_id).first
-      end
-
-      def created
-        @created ||= Time.at(@attributes[:created_utc])
-      end
-
-      def root?
-        !parent_id || parent_id == link_id
-      end
-
-      def gilded?
-        gilded > 0
-      end
-    end
-  end
-end

data/lib/redd/object/listing.rb

@@ -1,29 +0,0 @@
-require "forwardable"
-
-module Redd
-  module Object
-    # A listing of various reddit things.
-    # @see http://www.reddit.com/dev/api#listings
-    # @see http://stackoverflow.com/a/2080118
-    class Listing
-      include Enumerable
-      extend Forwardable
-      def_delegators :@things, :[], :length, :size, :each, :map, :empty?
-
-      # @!attribute [r] things
-      # @return [Array] A list of things in the listing.
-      attr_reader :things
-
-      attr_reader :kind
-      attr_reader :after
-      attr_reader :before
-
-      def initialize(listing)
-        @kind = "Listing"
-        @things = listing[:data][:children]
-        @after = listing[:data][:after]
-        @before = listing[:data][:before]
-      end
-    end
-  end
-end

data/lib/redd/object/more_comments.rb

@@ -1,14 +0,0 @@
-module Redd
-  module Object
-    # The model for a morecomments object
-    class MoreComments < Redd::Base
-      attr_reader :count
-      attr_reader :parent_id
-      attr_reader :children
-
-      def expand(submission = nil)
-        client.expand_morecomments(self, submission)
-      end
-    end
-  end
-end

data/lib/redd/object/private_message.rb

@@ -1,35 +0,0 @@
-require "redd/thing"
-
-module Redd
-  module Object
-    # The model for private messages
-    class PrivateMessage < Redd::Thing
-      require "redd/thing/inboxable"
-
-      include Redd::Thing::Inboxable
-
-      attr_reader :body
-      attr_reader :body_html
-      attr_reader :subreddit
-      attr_reader :parent_id
-      attr_reader :distinguished
-      attr_reader :was_comment
-      attr_reader :first_message_name
-      attr_reader :context
-
-      attr_reader :dest
-      attr_reader :author
-
-      alias_method :from, :author
-      alias_method :to, :dest
-
-      def created
-        @created ||= Time.at(@attributes[:created_utc])
-      end
-
-      def replies
-        @replies ||= client.objects_from_listing(@attributes[:replies])
-      end
-    end
-  end
-end

data/lib/redd/object/submission.rb

@@ -1,94 +0,0 @@
-require "redd/thing"
-
-module Redd
-  module Object
-    # A submission made in a subreddit.
-    class Submission < Redd::Thing
-      require "redd/thing/commentable"
-      require "redd/thing/editable"
-      require "redd/thing/hideable"
-      require "redd/thing/moderatable"
-      require "redd/thing/reportable"
-      require "redd/thing/saveable"
-      require "redd/thing/voteable"
-
-      include Redd::Thing::Commentable
-      include Redd::Thing::Editable
-      include Redd::Thing::Hideable
-      include Redd::Thing::Moderatable
-      include Redd::Thing::Saveable
-      include Redd::Thing::Voteable
-
-      attr_reader :author
-
-      attr_reader :edited
-      attr_reader :saved
-      attr_reader :gilded
-      attr_reader :clicked
-      attr_reader :visited
-      attr_reader :stickied
-      attr_reader :hidden
-
-      attr_reader :ups
-      attr_reader :downs
-      attr_reader :score
-      attr_reader :likes
-
-      attr_reader :banned_by
-      attr_reader :approved_by
-      attr_reader :distinguished
-      attr_reader :num_reports
-
-      attr_reader :link_flair_text
-      attr_reader :link_flair_css_class
-      attr_reader :author_flair_css_class
-      attr_reader :author_flair_text
-
-      attr_reader :domain
-      attr_reader :media
-      attr_reader :media_embed
-      attr_reader :selftext
-      attr_reader :selftext_html
-      attr_reader :secure_media
-      attr_reader :secure_media_embed
-      attr_reader :over_18
-      attr_reader :thumbnail
-      attr_reader :is_self
-      attr_reader :url
-      attr_reader :title
-      attr_reader :num_comments
-
-      alias_method :nsfw?, :over_18
-      alias_method :self?, :is_self
-      alias_method :comments_count, :num_comments
-
-      def subreddit_name
-        @subreddit_name ||= @attributes[:subreddit]
-      end
-
-      def subreddit
-        @subreddit ||= client.subreddit(@attributes[:subreddit])
-      end
-
-      def comments
-        @comments ||= client.submission_comments(id)
-      end
-
-      def created
-        @created ||= Time.at(@attributes[:created_utc])
-      end
-
-      def permalink
-        "http://www.reddit.com" + attributes[:permalink]
-      end
-
-      def short_url
-        "http://redd.it/" + id
-      end
-
-      def gilded?
-        gilded > 0
-      end
-    end
-  end
-end