ruby_reddit_api 0.2.4 → 0.2.5

data/README.rdoc

@@ -1,4 +1,4 @@
-== Ruby Reddit Client v0.2.3
+== Ruby Reddit Client v0.2.5
 Tested with ruby 1.8.7 & 1.9.2
 
 == Usage

data/features/message.feature

@@ -1,5 +1,19 @@
 Feature: Messaging
+
   Scenario: I want to be able to read my sent messages
     Given I am logged in
     When I go to the sent messages page
     Then I should see a listing of messages
+
+  Scenario: I want to change message read status
+    Given I am logged in
+    And I have received messages
+    When I go to the received messages page
+    Then I should be able to mark them as unread
+    And I should be able to mark them as read
+
+  Scenario: I want to be able to read my unread messages
+    Given I am logged in
+    And I have unread messages
+    When I go to the unread messages page
+    Then I should see a listing of messages

data/features/step_definitions/message_steps.rb

@@ -2,6 +2,7 @@ Before do
   load_server_config
   Reddit::Api.base_uri @address
   Reddit::Message.base_uri @address
+  Reddit::Base.instance_variable_set("@throttle_duration", 0)
 end
 
 Given /^I am logged in$/ do
@@ -13,6 +14,55 @@ When /^I go to the sent messages page$/ do
   @result = @api.sent_messages
 end
 
+When /^I go to the unread messages page$/ do
+  @result = @api.unread_messages
+end
+
+When /^I go to the received messages page$/ do
+  @result = @api.received_messages
+end
+
 Then /^I should see a listing of messages$/ do
   @result.any?{|r| r.is_a?(Reddit::Message) == false}.should be false
 end
+
+Given /^I have received messages$/ do
+  @api.received_messages.size.should be > 0
+end
+
+Given /^I have unread messages$/ do
+  unread = @api.unread_messages
+  unless unread.size > 0
+    @api.received_messages[0].mark_unread
+  end
+end
+
+Then /^I should be able to mark them as unread/ do
+  unread = @api.unread_messages
+  unread.each do |m|
+    m.mark_read
+  end
+
+  received = @api.received_messages
+  received[0].mark_unread
+
+  r = @api.unread_messages
+  r.size.should == 1
+end
+
+Then /^I should be able to mark them as read$/ do
+  received = @api.received_messages
+  received.each do |m|
+    m.mark_unread
+  end
+  unread = @api.unread_messages
+
+  unread.size.should be > 0
+
+  unread.each do |m|
+    m.mark_read
+  end
+  
+  r = @api.unread_messages
+  r.size.should == 0
+end

data/features/step_definitions/search_steps.rb

@@ -1,5 +1,4 @@
 Given /^I search '([^']+)' with '([^']+)'$/ do |subreddit, terms|
-  # FIXME searching isnt working for me by default in the reddit vm
   Reddit::Base.base_uri "reddit.com"
   Reddit::Api.base_uri "reddit.com"
   @api       = Reddit::Api.new

data/lib/ruby_reddit_api.rb

@@ -9,6 +9,7 @@ require "ruby_reddit_api/version"
 require "ruby_reddit_api/json_listing"
 require "ruby_reddit_api/base"
 require "ruby_reddit_api/thing"
+require "ruby_reddit_api/voteable"
 require "ruby_reddit_api/api"
 require "ruby_reddit_api/user"
 require "ruby_reddit_api/vote"

data/lib/ruby_reddit_api/api.rb

@@ -61,6 +61,12 @@ module Reddit
       messages :inbox
     end
 
+    #Read unread messages
+    # @return [Array<Reddit::Message>]
+    def unread_messages
+      messages :unread
+    end
+
     # Read received comments
     # @return [Array<Reddit::Message>]
     def comments

data/lib/ruby_reddit_api/base.rb

@@ -7,7 +7,9 @@ module Reddit
 
     attr_reader :last_action, :debug
     base_uri "www.reddit.com"
-    class << self; attr_reader :cookie, :modhash, :user_id, :user end
+    class << self; attr_reader :cookie, :modhash, :user_id, :user, :throttle_duration end
+
+    @throttle_duration = 1.0
 
     def initialize(options={})
       @debug    = StringIO.new
@@ -108,7 +110,7 @@ module Reddit
     end
 
     def throttled?
-      @last_action && ( ( Time.now - @last_action ) < 1.0 )
+      @last_action && ( ( Time.now - @last_action ) < Reddit::Base.throttle_duration )
     end
 
     def sanitize_subreddit(subreddit)

data/lib/ruby_reddit_api/comment.rb

@@ -1,8 +1,9 @@
 module Reddit
   # @author James Cook
   class Comment < Thing
-
+    include Voteable
     include JsonListing
+
     attr_reader :body, :subreddit_id, :name, :created, :downs, :author, :created_utc, :body_html, :link_id, :parent_id, :likes, :num_comments, :subreddit, :ups, :debug, :kind, :replies
     def initialize(json, options={})
       mode = options.fetch(:mode){ :json }

data/lib/ruby_reddit_api/message.rb

@@ -1,6 +1,6 @@
 # @author James Cook
 module Reddit
-  class Message < Base
+  class Message < Thing
     include JsonListing
 
     attr_reader :body, :was_comment, :kind, :first_message, :name, :created, :dest, :created_utc, :body_html, :subreddit, :parent_id, :context, :replies, :subject, :debug
@@ -21,6 +21,23 @@ module Reddit
       @author_data ||= read("/user/#{@author}/about.json", :handler => "User")
     end
 
+    # Reply to this message
+    # @return [true,false]
+    def reply(text)
+      resp = self.class.post("/api/comment", {:body => {:thing_id => id, :text => text, :uh => modhash, :r => subreddit }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def mark_unread
+      resp = self.class.post("/api/unread_message", {:body => {:id => id, :uh => modhash}, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def mark_read
+      resp = self.class.post("/api/read_message", {:body => {:id => id, :uh => modhash }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
     def inspect
       "<Reddit::Message '#{short_body}'>"
     end

data/lib/ruby_reddit_api/submission.rb

@@ -2,6 +2,8 @@
 module Reddit
   class Submission < Thing
     include JsonListing
+    include Voteable
+
     attr_reader :domain, :media_embed, :subreddit, :selftext_html, :selftext, :likes, :saved, :clicked, :media, :score, :over_18, :hidden, :thumbnail, :subreddit_id, :downs, :is_self, :permalink, :name, :created, :url, :title, :created_utc, :num_comments, :ups, :kind, :last_comment_id
 
     def inspect

data/lib/ruby_reddit_api/thing.rb

@@ -21,18 +21,6 @@ module Reddit
       @author_data ||= response[0] if response
     end
 
-    # Upvote thing
-    # @return [true,false]
-    def upvote
-      Reddit::Vote.new(self).up
-    end
-
-    # Downvote thing
-    # @return [true,false]
-    def downvote
-      Reddit::Vote.new(self).down
-    end
-
     # Report thing
     # @return [true,false]
     def report

data/lib/ruby_reddit_api/voteable.rb

@@ -0,0 +1,22 @@
+module Reddit
+  # @author Joe Bauser
+  module Voteable
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      # Upvote thing
+      # @return [true,false]
+      def upvote
+        Reddit::Vote.new(self).up
+      end
+
+      # Downvote thing
+      # @return [true,false]
+      def downvote
+        Reddit::Vote.new(self).down
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - James Cook
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 -04:00
+date: 2010-11-19 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,34 +66,35 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/ruby_reddit_api.rb
-- lib/ruby_reddit_api/thing.rb
-- lib/ruby_reddit_api/user.rb
+- lib/ruby_reddit_api/json_listing.rb
 - lib/ruby_reddit_api/comment.rb
-- lib/ruby_reddit_api/message.rb
-- lib/ruby_reddit_api/version.rb
+- lib/ruby_reddit_api/voteable.rb
+- lib/ruby_reddit_api/api.rb
 - lib/ruby_reddit_api/vote.rb
 - lib/ruby_reddit_api/submission.rb
-- lib/ruby_reddit_api/api.rb
-- lib/ruby_reddit_api/json_listing.rb
+- lib/ruby_reddit_api/version.rb
+- lib/ruby_reddit_api/user.rb
+- lib/ruby_reddit_api/message.rb
+- lib/ruby_reddit_api/thing.rb
 - lib/ruby_reddit_api/base.rb
+- lib/ruby_reddit_api.rb
 - README.rdoc
 - features/reddit.yml
-- features/submission.feature
-- features/comment.feature
-- features/user.feature
-- features/base.feature
-- features/message.feature
 - features/search.feature
 - features/api.feature
-- features/step_definitions/message_steps.rb
-- features/step_definitions/submission_steps.rb
+- features/submission.feature
+- features/base.feature
+- features/comment.feature
+- features/step_definitions/user_steps.rb
 - features/step_definitions/search_steps.rb
 - features/step_definitions/api_steps.rb
-- features/step_definitions/user_steps.rb
+- features/step_definitions/submission_steps.rb
 - features/step_definitions/comment_steps.rb
+- features/step_definitions/message_steps.rb
 - features/step_definitions/base_steps.rb
+- features/message.feature
 - features/support/base_helpers.rb
+- features/user.feature
 has_rdoc: yard
 homepage: http://github.com/jamescook/RubyRedditAPI
 licenses: []
@@ -132,18 +133,18 @@ specification_version: 3
 summary: Wrapper for reddit API
 test_files: 
 - features/reddit.yml
-- features/submission.feature
-- features/comment.feature
-- features/user.feature
-- features/base.feature
-- features/message.feature
 - features/search.feature
 - features/api.feature
-- features/step_definitions/message_steps.rb
-- features/step_definitions/submission_steps.rb
+- features/submission.feature
+- features/base.feature
+- features/comment.feature
+- features/step_definitions/user_steps.rb
 - features/step_definitions/search_steps.rb
 - features/step_definitions/api_steps.rb
-- features/step_definitions/user_steps.rb
+- features/step_definitions/submission_steps.rb
 - features/step_definitions/comment_steps.rb
+- features/step_definitions/message_steps.rb
 - features/step_definitions/base_steps.rb
+- features/message.feature
 - features/support/base_helpers.rb
+- features/user.feature