Sha256: 10c30206bef90e8cd2c72a0b9b9bc3f5f6e7068625ebd6601cd70abcd874efb0

Contents?: true

Size: 1.17 KB

Versions: 9

Compression:

Stored size: 1.17 KB

Contents

module Redd
  module Clients
    class Base
      # Methods that require the "wikiread" scope.
      # @note This method is not limited to {Objects::Subreddit} because there
      #   are also top-level wiki pages.
      module Wikiread
        # Get a list of pages in the subreddit wiki.
        # @param subreddit [Objects::Subreddit, String] The subreddit to
        #   look in.
        # @return [Array<String>] An array of wikipage titles.
        def get_wikipages(subreddit = nil)
          path = "/wiki/pages.json"
          name = property(subreddit, :display_name)
          path.prepend("/r/#{name}") if subreddit
          get(path).body[:data]
        end

        # Get a wiki page.
        # @param page [String] The title of the wiki page.
        # @param subreddit [Objects::Subreddit, String] The subreddit to
        #   look in.
        # @return [Objects::WikiPage] A wiki page.
        def wikipage(page, subreddit = nil)
          path = "/wiki/#{page}.json"
          name = property(subreddit, :display_name)
          path.prepend("/r/#{name}") if subreddit
          request_object(:get, path)
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
redd-0.7.8 lib/redd/clients/base/wikiread.rb
redd-0.7.7 lib/redd/clients/base/wikiread.rb
redd-0.7.6 lib/redd/clients/base/wikiread.rb
redd-0.7.5 lib/redd/clients/base/wikiread.rb
redd-0.7.4 lib/redd/clients/base/wikiread.rb
redd-0.7.3 lib/redd/clients/base/wikiread.rb
redd-0.7.2 lib/redd/clients/base/wikiread.rb
redd-0.7.1 lib/redd/clients/base/wikiread.rb
redd-0.7.0 lib/redd/clients/base/wikiread.rb