redd 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eefcb4605d95ff4dd74d15293cfc83ad525d1c6a
-  data.tar.gz: f9f7689a053500c5d0021edf35476cbd019b0ca2
+  metadata.gz: 546ebcdeb092101a90012a2f2a3d088cdae13259
+  data.tar.gz: c0a9b544cd6e0786cf99d0d1fea4336929068ea6
 SHA512:
-  metadata.gz: 5b1ce4746c616835b1115000c04685f8f24b009a79e26857f60d0bce2f50c3a53078d0ec5f46dc28819bc92dd46d4d645899901219a80fdf8556e2d03cc376ca
-  data.tar.gz: 6ab5345939dae63c5cc132a5ca9b91efb331c55c3a7e137659306094ce2ffbe7ceb150df490e688f06484f062e2f614395797384e96cef64473c38099429f700
+  metadata.gz: 213c006802d87c57bcdd4236f793c7def0eeadb47d5991e3f7d2894dba3824373b9c7c6fe5ba817a65a9e0de54b12b2047c5a0200bc1487cfc11ef13791f9b34
+  data.tar.gz: a6ca604d6a3c55a9dd1dec45edc9537b5a2b5f153447c8d6ce05b49d721f4e12c6204af765cfc8c6d96f4848559757b8a21e38ea7361aef8f5ab5c14831b2ac1

data/README.md

@@ -1,5 +1,7 @@
 <p align="center">
   <img src="github/redd.png?raw=true" alt="redd"><br>
+  <a href="http://badge.fury.io/rb/redd"><img src="https://badge.fury.io/rb/redd.svg" alt="Gem Version" height="18"></a>
+  <a href="https://gemnasium.com/avidw/redd"><img src="https://gemnasium.com/avidw/redd.svg" alt="Dependency Status"></a>
 </p>
 
 **redd** is an API wrapper for [reddit](http://reddit.com/dev/api) written in ruby that focuses on being *simple and extensible*.  
@@ -7,4 +9,100 @@
 
 ---
 
-## 
+<p align="center">
+  <a href="#getting-started">Getting Started</a> |
+  <a href="#extending-redd">Extending Redd</a> |
+  <a href="#conventions">Conventions</a> |
+  <a href="#supported-rubies">Supported Rubies</a> |
+  <a href="#copyright">Copyright</a>
+</p>
+
+---
+
+## Getting Started
+TODO: Elaborate.
+
+```ruby
+require "redd"
+
+client = Redd.client
+redditdev = client.subreddit("redditdev")
+
+latest_post = redditdev.get_new.first
+puts latest_post.title
+```
+
+## Extending Redd
+Extending any ruby library, including redd is incredibly easy. Let's try this out by adding a gilding extension. Reddit provides an api to be able to gild posts and comments, given that you have "creddits".
+
+1. Let's start by creating a module for the methods to live in.
+   ```ruby
+   module MyGildingExtension
+   end
+   ```
+
+2. Let's add a method to gild a thing, using the [reddit api](http://www.reddit.com/dev/api#section_gold) and following the conventions.
+   ```ruby
+   module MyGildingExtension
+     def gild(thing)
+       # Redd::Client::Unauthenticated::Utilities has some pretty helpful
+       # methods.
+       fullname = extract_fullname(thing)
+
+       meth = :post
+       path = "/api/v1/gold/gild/#{fullname}"
+
+       # We're using send instead of object_from_response, because we don't
+       # expect any object from the response.
+       send(meth, path)
+     end
+   end
+   ```
+
+3. Let's add the method to the Authenticated client. You can also add it to the Unauthenticated client, but since unauthenticated users can't gild, there's no point.
+   ```ruby
+   Redd::Client::Authenticated.include(MyGildingExtension)
+   ```
+
+4. You might also want to add the method to objects to make it easier to access.
+   ```ruby
+   module Gildable
+     def gild
+       # Every Redd::Object is instantiated with the client that created
+       # it, so the method can be called on the client easily, similar to
+       # praw in python.
+       client.gild(self)
+     end
+   end
+
+   Redd::Object::Submission.include(Gildable)
+   Redd::Object::Comment.include(Gildable)
+   ```
+
+## Conventions
+### Method Names
+- A method that returns a Redd::Object directly is called that in lowercase. For example, a method that returns a single `Redd::Object::Subreddit` is called `subreddit`
+- Any method that return a listing is in the format `get_[thing]s`. For example, a method that returns a listing of subreddits is named `get_subreddits`.
+- An **internal** method that edits an existing object is **usually** named `edit_[thing]`. Some exeptions to this rule are `vote` that edit a user's vote.
+- Any method that returns something specific to the user must have "my" in the middle. For example, a method that returns a users subscribed subreddits is named `get_my_subscriptions`.
+
+### Methods
+- Most methods that use an http request should usually follow this convention. I haven't had time to check the methods to see if they follow this, but this should be the case
+  ```ruby
+  def subreddit(thing, options = {})
+    fullname = extract_fullname(thing)
+
+    meth = :get
+    path = "/r/ruby/about.json"
+    params = options << {additional: "options"}
+
+    object_from_response(meth, path, params)
+  end
+  ```
+
+## Supported Rubies
+TODO: Travis CI
+
+## Copyright
+Copyright (c) [Avinash Dwarapu](http://github.com/avidw) under the MIT License. See LICENSE.md for more details.  
+Some code has been used from [RedditKit.rb](http://github.com/samsymons/RedditKit.rb). See RedditKit.LICENSE.md for more details.

data/Rakefile

@@ -7,4 +7,4 @@ RSpec::Core::RakeTask.new
 RuboCop::RakeTask.new
 YARD::Rake::YardocTask.new
 
-task default: [:spec, :rubocop, :yard]
+task default: :spec

data/{lib/redd/RedditKit.LICENSE.md → RedditKit.LICENSE.md}

@@ -1,4 +1,4 @@
-The errors file would have been impossible if it weren't for @samsymons :)
+The error and base files would have been impossible if it weren't for @samsymons :)
 
 ---
 

data/TODO.md

@@ -0,0 +1,45 @@
+## TODO.md
+
+#### Redd::Client
+- [ ] Unauthenticated
+  - [ ] Account
+  - [ ] Links & Comments
+  - [ ] Listing
+  - [ ] Live
+  - [ ] Subreddit
+  - [ ] Utilities
+  - [ ] Wiki
+- [ ] Authenticated
+  - [ ] Account
+  - [ ] Apps
+  - [ ] Flair
+  - [ ] Gold
+  - [ ] Links & Comments
+  - [ ] Live
+  - [ ] Moderation
+  - [ ] Multis
+  - [ ] Private Messages
+  - [ ] Subreddits
+  - [ ] Users
+  - [ ] Wiki
+- [ ] OAuth2
+
+#### Redd::Thing
+- [ ] Creatable
+- [ ] Editable
+- [ ] Hideable
+- [ ] Inboxable
+- [ ] Messageable
+- [ ] Moderatable
+- [ ] Reportable
+- [ ] Saveable
+- [ ] Voteable
+
+#### Redd::Object
+- [ ] `listing` **Listing**
+- [ ] `more` **MoreComments**
+- [ ] `t1_` **Comment**
+- [ ] `t2_` **User**
+- [ ] `t3_` **Submission**
+- [ ] `t4_` **PrivateMessage**
+- [ ] `t5_` **Subreddit**

data/lib/redd/base.rb

@@ -16,11 +16,16 @@ module Redd
 
     # Define and memoize the method that returns a key from the
     # attributes hash.
-    # @param [Symbol, String] key The key to construct a method out of.
-    # @param [Symbol] attribute The attribute in the given hash to return.
-    def self.attr_reader(key, attribute = key)
-      define_method(key) { @attributes[attribute] }
-      memoize(key)
+    # @param [Symbol, String] attr The attribute to construct a method out of.
+    def self.attr_reader(attr)
+      define_attribute_method(attr)
+      define_predicate_method(attr)
+    end
+
+    def [](method)
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
     end
 
     # @param client The client to use when making requests with this object.
@@ -31,5 +36,17 @@ module Redd
       @attributes = attributes[:data]
       @attributes[:kind] = attributes[:kind]
     end
+
+    private
+
+    def self.define_attribute_method(method)
+      define_method(method) { @attributes[method] }
+      memoize method
+    end
+
+    def self.define_predicate_method(method)
+      define_method(:"#{method}?") { !!@attributes[method] }
+      memoize :"#{method}?"
+    end
   end
 end

data/lib/redd/client/authenticated.rb

@@ -30,19 +30,19 @@ module Redd
       include Redd::Client::Authenticated::Wiki
 
       # @!attribute [r] username
-      # 	@return [String] The username of the logged-in user.
+      # @return [String] The username of the logged-in user.
       attr_reader :username
 
       # @!attribute [r] cookie
-      # 	@return [String] The cookie used to store the current session.
+      # @return [String] The cookie used to store the current session.
       attr_reader :cookie
 
       # @!attribute [r] modhash
-      # 	@return [String] The returned modhash used when making requests.
+      # @return [String] The returned modhash used when making requests.
       attr_reader :modhash
 
       # @!attribute [rw] auth_endpoint
-      #   @return [String] The site to connect to authenticate with.
+      # @return [String] The site to connect to authenticate with.
       attr_accessor :auth_endpoint
 
       # Set up an authenticated connection to reddit.

data/lib/redd/client/authenticated/account.rb

@@ -1,8 +1,13 @@
 module Redd
   module Client
-  	class Authenticated
-      module Accounts
-        
+    class Authenticated
+      module Account
+        def me
+          meth = :get
+          path = "/api/me.json"
+
+          object_from_response(meth, path)
+        end
       end
     end
   end

data/lib/redd/client/authenticated/apps.rb

@@ -1,6 +1,6 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Apps
         # Low-Priority
         #

data/lib/redd/client/authenticated/flair.rb

@@ -1,6 +1,6 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Flair
         
       end

data/lib/redd/client/authenticated/gold.rb

@@ -1,6 +1,6 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Gold
         # Low-Priority
         #

data/lib/redd/client/authenticated/links_comments.rb

@@ -1,8 +1,137 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module LinksComments
-				
+        def add_comment(thing, text, return_element = true)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/comment"
+          params = {api_type: "json", text: text, thing_id: fullname}
+
+          # TODO: Return the created object.
+          send(meth, path, params)
+        end
+
+        alias_method :reply, :add_comment
+
+        def delete(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/del"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        def edit(thing, text)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/editusertext"
+          params = {api_type: "json", text: text, thing_id: fullname}
+
+          # TODO: Return the edited object.
+          send(meth, path, params)
+        end
+
+        def hide(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/hide"
+          params = {id: fullname}
+
+          send(meth, path, params)
+      end
+
+        def unhide(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/unhide"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        def mark_as_nsfw(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/marknsfw"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        def unmark_as_nsfw(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/unmarknsfw"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        alias_method :mark_as_safe, :unmark_as_nsfw
+
+        def report(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/report"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        def save(thing, category = nil)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/save"
+          params = {id: fullname}
+          params << {category: category} if category
+
+          send(meth, path, params)
+        end
+
+        def unsave(thing)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/unsave"
+          params = {id: fullname}
+
+          send(meth, path, params)
+        end
+
+        def upvote(thing)
+          vote(thing, 1)
+        end
+
+        def downvote(thing)
+          vote(thing, -1)
+        end
+
+        def unvote(thing)
+          vote(thing, 0)
+        end
+
+        private
+
+        def vote(thing, direction)
+          fullname = extract_fullname(thing)
+
+          meth = :post
+          path = "/api/vote"
+          params = {id: fullname, dir: direction}
+
+          send(meth, path, params)
+        end
       end
     end
   end

data/lib/redd/client/authenticated/live.rb

@@ -1,9 +1,9 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Live
-				# Low-priority
-				#
+        # Low-priority
+        #
         # When was this a thing? Let's just hope this doesn't become popular
         # that quickly before I get to it.
       end

data/lib/redd/client/authenticated/moderation.rb

@@ -1,8 +1,8 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Moderation
-				
+        
       end
     end
   end

data/lib/redd/client/authenticated/multis.rb

@@ -1,8 +1,8 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Multis
-				
+        
       end
     end
   end

data/lib/redd/client/authenticated/private_messages.rb

@@ -1,6 +1,6 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module PrivateMessages
         def block_message(message)
           fullname = extract_fullname(message)

data/lib/redd/client/authenticated/subreddits.rb

@@ -1,8 +1,37 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Subreddits
-				
+        def subscribe(subreddit)
+          edit_subscription(:sub, subreddit)
+        end
+
+        def unsubscribe(subreddit)
+          edit_subscription(:unsub, subreddit)
+        end
+
+        def get_subreddits(where = :subscriber, params = {})
+          meth = :get
+          path =
+            if [:popular, :new].include?(where)
+              "/subreddits/#{where}.json"
+            elsif [:subscriber, :contributor, :moderator].include?(where)
+              "/subreddits/mine/#{where}.json"
+            end
+          object_from_response(meth, path, params)
+        end
+
+        private
+
+        def edit_subscription(action, subreddit)
+          fullname = extract_fullname(subreddit)
+
+          meth = :post
+          path = "/api/subscribe"
+          params = {action: action, sr: fullname}
+
+          send(meth, path, params)
+        end
       end
     end
   end

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

@@ -1,8 +1,8 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Users
-				
+        
       end
     end
   end

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

@@ -1,8 +1,8 @@
 module Redd
   module Client
-  	class Authenticated
+    class Authenticated
       module Wiki
-				
+        
       end
     end
   end

data/lib/redd/client/unauthenticated.rb

@@ -3,17 +3,18 @@ require "redd/version"
 require "redd/rate_limit"
 require "redd/response/parse_json"
 require "redd/response/raise_error"
-require "redd/client/unauthenticated/account"
-require "redd/client/unauthenticated/links_comments"
-require "redd/client/unauthenticated/listing"
-require "redd/client/unauthenticated/subreddits"
-require "redd/client/unauthenticated/utilities"
-require "redd/client/unauthenticated/wiki"
 
 module Redd
   module Client
     # The Client used to connect without needing login credentials.
     class Unauthenticated
+      require "redd/client/unauthenticated/account"
+      require "redd/client/unauthenticated/links_comments"
+      require "redd/client/unauthenticated/listing"
+      require "redd/client/unauthenticated/subreddits"
+      require "redd/client/unauthenticated/utilities"
+      require "redd/client/unauthenticated/wiki"
+
       include Redd::Client::Unauthenticated::Account
       include Redd::Client::Unauthenticated::LinksComments
       include Redd::Client::Unauthenticated::Listing
@@ -22,15 +23,15 @@ module Redd
       include Redd::Client::Unauthenticated::Wiki
 
       # @!attribute [r] api_endpoint
-      # 	@return [String] The site to connect to.
+      # @return [String] The site to connect to.
       attr_accessor :api_endpoint
 
       # @!attribute [r] user_agent
-      # 	@return [String] The user-agent used to communicate with reddit.
+      # @return [String] The user-agent used to communicate with reddit.
       attr_accessor :user_agent
 
       # @!attribute [r] rate_limit
-      # 	@return [#after_limit] The handler that takes care of rate limiting.
+      # @return [#after_limit] The handler that takes care of rate limiting.
       attr_accessor :rate_limit
 
       # Set up an unauthenticated connection to reddit.

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

@@ -9,6 +9,20 @@ module Redd
           path = "/api/info.json"
           object_from_response(meth, path, params)
         end
+
+        def get_comments(submission)
+          id = extract_id(submission)
+
+          meth = :get
+          path = "/comments/#{id}.json"
+          comments_from_response(meth, path)
+        end
+
+        def get_replies(comment)
+          replies = comment.attributes[:replies]
+          return [] unless replies.is_a?(Hash) and replies.has_key?(:kind)
+          object_from_body(replies)
+        end
       end
     end
   end

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

@@ -2,11 +2,25 @@ module Redd
   module Client
     class Unauthenticated
       module Subreddits
-        def subreddit(name)
+        def subreddit(title)
           meth = :get
-          path = "/r/#{name}/about.json"
+          path = "/r/#{title}/about.json"
           object_from_response(meth, path)
         end
+
+        def get_subreddits(where = :popular, params = {})
+          meth = :get
+          path = "/subreddits/#{where}.json"
+          object_from_response(meth, path, params)
+        end
+
+        def search_subreddits(query, params = {})
+          meth = :get
+          path = "/subreddits/search.json"
+          params << {q: query}
+
+          object_from_response(meth, path, params)
+        end
       end
     end
   end

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

@@ -1,8 +1,10 @@
 require "redd/thing"
 require "redd/object/listing"
 require "redd/object/comment"
+require "redd/object/private_message"
 require "redd/object/submission"
 require "redd/object/subreddit"
+require "redd/object/user"
 
 module Redd
   module Client
@@ -10,12 +12,16 @@ module Redd
       module Utilities
         private
 
+        def extract_attribute(object, attribute)
+          object.send(attribute) if object.respond_to?(attribute)
+        end
+
         def extract_fullname(object)
           object.is_a?(String) ? object : extract_attribute(object, :fullname)
         end
 
-        def extract_attribute(object, attribute)
-          object.send(attribute) if object.respond_to?(attribute)
+        def extract_id(object)
+          object.is_a?(String) ? object : extract_attribute(object, :id)
         end
 
         # @todo "more"
@@ -25,8 +31,12 @@ module Redd
             Redd::Object::Listing
           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
           else
@@ -36,24 +46,30 @@ module Redd
 
         def objects_from_listing(thing)
           thing[:data][:children].map do |child|
-            get_object_from_body(child)
+            object_from_body(child)
           end
         end
 
-        def get_object_from_body(body)
+        def object_from_body(body)
+          return nil unless body.is_a?(Hash) && body.has_key?(:kind)
           object = object_from_kind(body[:kind])
 
           if object == Redd::Object::Listing
-            things = objects_from_listing(body)
-            object.new(things)
+            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
-          get_object_from_body(body)
+          object_from_body(body)
         end
       end
     end

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

@@ -1,8 +1,8 @@
 module Redd
   module Client
-  	class Unauthenticated
+    class Unauthenticated
       module Wiki
-				
+        
       end
     end
   end

data/lib/redd/object/comment.rb

@@ -4,37 +4,52 @@ module Redd
   module Object
     # A comment made on links.
     class Comment < Redd::Thing
-      # @!attribute [r] subreddit
-      # @return [String] The name of the subreddit this comment belongs to.
-      # @todo Convert to a Subreddit object?
-      attr_reader :subreddit
-
-      # @!attribute [r] parent_id
-      # @return [String] The id of the parent comment.
-      # @todo parent - get the parent comment directly.
-      attr_reader :parent_id
+      attr_reader :created_utc
+      attr_reader :author
 
-      # @!attribute [r] body
-      # @return [String] The text of the comment in markdown.
-      attr_reader :body
+      attr_reader :edited
+      attr_reader :saved
+      attr_reader :gilded
 
-      # @!attribute [r] body_html
-      # @return [String] The text of the comment in html.
-      # @note Be warned: this isn't actual html, but escaped html. So all the
-      #   <'s and >'s are converted to &lt;'s and &gt;'s.
-      attr_reader :body_html
+      attr_reader :ups
+      attr_reader :downs
+      attr_reader :score
+      attr_reader :likes
+      attr_reader :controversiality
 
-      # @!attribute [r] author_flair_text
-      # @return [String] The user's flair.
-      attr_reader :author_flair_text
+      attr_reader :banned_by
+      attr_reader :approved_by
+      attr_reader :score_hidden
+      attr_reader :distinguished
+      attr_reader :num_reports
 
-      # @!attribute [r] author_flair_css_class
-      # @return [String] The CSS class of the user's flair.
+      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
 
-      # @return [Boolean] Whether the comment is a root rather than a reply.
+      alias_method :reports_count, :num_reports
+
+      def replies
+        @replies ||= client.get_replies(self)
+      end
+
+      def subreddit
+        @subreddit ||= client.subreddit(@attributes[:subreddit])
+      end
+
+      def created
+        @created ||= Time.at(@attributes[:created])
+      end
+
       def root?
-        !parent_id || parent_id == fullname
+        !parent_id || parent_id == link_id
+      end
+
+      def gilded?
+        gilded > 0
       end
     end
   end

data/lib/redd/object/listing.rb

@@ -14,10 +14,15 @@ module Redd
       # @return [Array] A list of things in the listing.
       attr_reader :things
 
-      # Create a new listing with the given things.
-      # @param [Array] things A list of things to generate a Listing out of.
-      def initialize(things)
-        @things = things
+      attr_reader :kind
+      attr_reader :after
+      attr_reader :before
+
+      def initialize(listing)
+        @kind = listing[:kind]
+        @things = listing[:data][:children]
+        @after = listing[:data][:after]
+        @before = listing[:data][:before]
       end
     end
   end

data/lib/redd/object/private_message.rb

@@ -0,0 +1,31 @@
+require "redd/thing"
+
+module Redd
+  module Object
+    class PrivateMessage < Redd::Thing
+      attr_reader :created_utc
+      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, :author
+
+      def created
+        @created ||= Time.at(@attributes[:created])
+      end
+
+      def replies
+        @replies ||= client.objects_from_listing(@attributes[:replies])
+      end
+    end
+  end
+end

data/lib/redd/object/submission.rb

@@ -4,91 +4,73 @@ module Redd
   module Object
     # A submission made in a subreddit.
     class Submission < Redd::Thing
-      # @!attribute [r] title
-      # @return [String] The title of the submission.
-      attr_reader :title
-
-      # @!attribute [r] url
-      # @return [String] The url the submission links to.
-      attr_reader :url
-
-      # @!attribute [r] num_comments
-      # @return [Integer] The number of comments the submission has.
-      attr_reader :num_comments
-
-      # @!attribute [r] domain
-      # @return [String] The domain the url belongs to.
-      attr_reader :domain
-
-      # @!attribute [r] subreddit
-      # @return [String] The name of the subreddit this comment belongs to.
-      # @todo Convert to a Subreddit object?
-      attr_reader :subreddit
-
-      # @!attribute [r] is_self?
-      # @return [Boolean] Whether the submission is a self submission.
-      attr_reader :self?, :is_self
+      attr_reader :created_utc
+      attr_reader :author
 
-      # @!attribute [r] thumbnail
-      # @return [String] The url for the thumbnail of the submission.
-      attr_reader :thumbnail
-      alias_method :thumbnail_url, :thumbnail
+      attr_reader :edited
+      attr_reader :saved
+      attr_reader :gilded
+      attr_reader :clicked
+      attr_reader :visited
+      attr_reader :stickied
+      attr_reader :hidden
 
-      # @!attribute [r] selftext
-      # @return [String] The text of the submission in markdown.
-      # @note This returns "" if the submission is not a self submission.
-      attr_reader :selftext
+      attr_reader :ups
+      attr_reader :downs
+      attr_reader :score
+      attr_reader :likes
 
-      # @!attribute [r] selftext_html
-      # @return [String] The text of the submission in html.
-      # @note This returns nil if the submission is not a self submission.
-      # @note Be warned: this isn't actual html, but escaped html. So all the
-      #   <'s and >'s are converted to &lt;'s and &gt;'s.
-      attr_reader :selftext_html
+      attr_reader :banned_by
+      attr_reader :approved_by
+      attr_reader :distinguished
+      attr_reader :num_reports
 
-      # @!attribute [r] link_flair_text
-      # @return [String] The submission's flair.
       attr_reader :link_flair_text
-
-      # @!attribute [r] link_flair_css_class
-      # @return [String] The CSS class of the submission's flair.
       attr_reader :link_flair_css_class
-
-      # @!attribute [r] author_flair_text
-      # @return [String] The user's flair.
+      attr_reader :author_flair_css_class
       attr_reader :author_flair_text
 
-      # @!attribute [r] author_flair_css_class
-      # @return [String] The CSS class of the user's flair.
-      attr_reader :author_flair_css_class
+      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
 
-      # @!attribute [r] clicked
-      # @return [Boolean] Whether the user already clicked on the link before.
-      # @note This only works for users with reddit gold.
-      attr_reader :clicked
+      alias_method :nsfw?, :over_18
+      alias_method :self?, :is_self
+      alias_method :comments_count, :num_comments
 
-      # @!attribute [r] visited
-      # @return [Boolean] Whether the user already visited on the link before.
-      # @note I have no idea what the difference between this and {#clicked} is
-      attr_reader :visited
+      def subreddit
+        @subreddit ||= client.subreddit(@attributes[:subreddit])
+      end
 
-      # @!attribute [r] stickied
-      # @return [Boolean] Whether the submission was stickied in the subreddit.
-      attr_reader :stickied
+      def comments
+        @comments ||= client.get_comments(id)
+      end
 
-      # @!attribute [r] nsfw?
-      # @return [Boolean] Whether the post is marked as NSFW.
-      attr_reader :nsfw?, :over_18
+      def created
+        @created ||= Time.at(@attributes[:created])
+      end
 
-      # @return [String] The full url to the post on reddit.com.
       def permalink
         "http://www.reddit.com" + attributes[:permalink]
       end
 
-      # @return [String] The short url on redd.it.
       def short_url
         "http://redd.it/" + id
       end
+
+      def gilded?
+        gilded > 0
+      end
     end
   end
 end

data/lib/redd/object/subreddit.rb

@@ -5,6 +5,67 @@ module Redd
     # A comment made on links.
     # @note This model can sure benefit from some lazy-loading...
     class Subreddit < Redd::Thing
+      attr_reader :display_name
+      attr_reader :title
+
+      attr_reader :description
+      attr_reader :description_html
+
+      attr_reader :header_img
+      attr_reader :header_title
+      attr_reader :header_size
+
+      attr_reader :user_is_banned
+      attr_reader :user_is_contributor
+      attr_reader :user_is_moderator
+      attr_reader :user_is_subscriber
+
+      attr_reader :submit_text
+      attr_reader :submit_text_html
+      attr_reader :submit_link_label
+      attr_reader :submit_text_label
+
+      attr_reader :over18
+      attr_reader :accounts_active
+      attr_reader :public_traffic
+      attr_reader :subscribers
+      attr_reader :created_utc
+      attr_reader :comment_score_hide_mins
+      attr_reader :subreddit_type
+      attr_reader :submission_type
+
+      alias_method :header_image, :header_img
+      alias_method :nsfw?, :over18
+      alias_method :users_online, :accounts_active
+      alias_method :type, :subreddit_type
+
+      def created
+        @created ||= Time.at(@attributes[:created])
+      end
+
+      def url
+        "http://reddit.com" + @attributes[:url]
+      end
+
+      def get_hot(*args)
+        client.get_hot(display_name, *args)
+      end
+
+      def get_new(*args)
+        client.get_new(display_name, *args)
+      end
+
+      def get_random(*args)
+        client.get_random(display_name, *args)
+      end
+
+      def get_top(*args)
+        client.get_top(display_name, *args)
+      end
+
+      def get_controversial(*args)
+        client.get_controversial(display_name, *args)
+      end
     end
   end
 end

data/lib/redd/object/user.rb

@@ -0,0 +1,30 @@
+require "redd/thing"
+
+module Redd
+  module Object
+    class User < Redd::Thing
+      attr_reader :created_utc
+      attr_reader :name
+      attr_reader :is_friend
+      attr_reader :link_karma
+      attr_reader :comment_karma
+      attr_reader :gold_creddits
+      attr_reader :gold_expiration
+      attr_reader :is_gold
+      attr_reader :is_mod
+      attr_reader :has_verified_email
+      attr_reader :has_mod_mail
+      attr_reader :has_mail
+
+      alias_method :has_gold, :is_gold
+
+      def created
+        @created ||= Time.at(@attributes[:created])
+      end
+
+      def fullname
+        @fullname ||= "#{kind}_#{id}"
+      end
+    end
+  end
+end

data/lib/redd/rate_limit.rb

@@ -26,20 +26,21 @@ module Redd
     #   @return [String] The time when the last request took place.
     attr_reader :last_request_time
 
-    def initialize
+    # @param [Float, Integer] gap The minimum time between each request.
+    def initialize(gap = 2)
       # Some time ages ago, because we never made a request.
       @last_request_time = Time.at(0)
+      @gap = gap
     end
 
     # Sleep until 2 seconds have passed since the last request and perform the
     # given request.
     #
-    # @param [Float, Integer] gap The minimum time between each request.
     # @yield A block.
     # @return The return value of the block.
-    def after_limit(gap = 2)
+    def after_limit
       seconds_passed = Time.now - @last_request_time
-      wait_time = gap - seconds_passed
+      wait_time = @gap - seconds_passed
       sleep(wait_time) if wait_time > 0
       @last_request_time = Time.now
       yield

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # The main Redd module.
 module Redd
   # The semantic version number for Redd.
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test.rb

@@ -0,0 +1,6 @@
+require "redd"
+
+c = Redd.client
+s = c.get_info(id: "t3_2cfy08")
+
+puts c.get_comments(s)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,12 +163,13 @@ files:
 - .travis.yml
 - .yardopts
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
+- RedditKit.LICENSE.md
+- TODO.md
 - github/redd.png
 - lib/redd.rb
-- lib/redd/RedditKit.LICENSE.md
 - lib/redd/base.rb
 - lib/redd/client/authenticated.rb
 - lib/redd/client/authenticated/account.rb
@@ -188,14 +189,17 @@ files:
 - lib/redd/client/unauthenticated/account.rb
 - lib/redd/client/unauthenticated/links_comments.rb
 - lib/redd/client/unauthenticated/listing.rb
+- lib/redd/client/unauthenticated/live.rb
 - lib/redd/client/unauthenticated/subreddits.rb
 - lib/redd/client/unauthenticated/utilities.rb
 - lib/redd/client/unauthenticated/wiki.rb
 - lib/redd/error.rb
 - lib/redd/object/comment.rb
 - lib/redd/object/listing.rb
+- lib/redd/object/private_message.rb
 - lib/redd/object/submission.rb
 - lib/redd/object/subreddit.rb
+- lib/redd/object/user.rb
 - lib/redd/rate_limit.rb
 - lib/redd/response/parse_json.rb
 - lib/redd/response/raise_error.rb
@@ -204,6 +208,7 @@ files:
 - redd.gemspec
 - spec/redd_spec.rb
 - spec/spec_helper.rb
+- test.rb
 homepage: ''
 licenses:
 - MIT