ruby_reddit_api 0.2.5 → 0.2.6

data/README.rdoc

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

data/features/message_group.feature

@@ -0,0 +1,14 @@
+Feature: Message Group
+  I want to be able to mark multiple messages as read or unread
+
+  Scenario: Mark multiple messages read
+    Given I am logged in
+    And I have unread messages
+    When I mark all unread messages read
+    Then I should have no unread messages
+
+  Scenario: Mark multiple messages unread
+    Given I am logged in
+    And I have unread messages
+    When I mark all read messages unread
+    Then I should have no read messages

data/features/step_definitions/message_group_steps.rb

@@ -0,0 +1,30 @@
+Before do
+  load_server_config
+  Reddit::Api.base_uri @address
+  Reddit::MessageGroup.base_uri @address
+  Reddit::Base.instance_variable_set("@throttle_duration", 0)
+  @api = Reddit::Api.new @user, @pass
+  @api.login
+end
+
+When /^I mark all unread messages read$/ do
+  group = Reddit::MessageGroup.new
+  messages = @api.unread_messages
+  result   = group.mark_read messages
+  result.should be true
+end
+
+When /^I mark all read messages unread$/ do
+  group = Reddit::MessageGroup.new
+  messages = @api.received_messages
+  result   = group.mark_unread messages
+  result.should be true
+end
+
+Then /^I should have no unread messages$/ do
+  @api.unread_messages.should == []
+end
+
+Then /^I should have no read messages$/ do
+  @api.received_messages.select{|m| !m.was_comment}.map(&:read?).uniq.should  == [false]
+end

data/lib/ruby_reddit_api.rb

@@ -16,4 +16,5 @@ require "ruby_reddit_api/vote"
 require "ruby_reddit_api/submission"
 require "ruby_reddit_api/comment"
 require "ruby_reddit_api/message"
+require "ruby_reddit_api/message_group"
 

data/lib/ruby_reddit_api/message.rb

@@ -15,6 +15,14 @@ module Reddit
       "#{kind}_#{@id}"
     end
 
+    def unread?
+      @new == true
+    end
+
+    def read?
+      @new == false
+    end
+
     # The author of the message. The data is lazy-loaded and cached on the message
     # @return [Reddit::User]
     def author

data/lib/ruby_reddit_api/message_group.rb

@@ -0,0 +1,39 @@
+# @author James Cook
+module Reddit
+  class MessageGroup < Thing
+    include JsonListing
+    attr_reader :debug
+
+    def initialize
+      @debug = StringIO.new
+    end
+
+    def mark_read(messages)
+      mark messages, "read"
+    end
+
+    def mark_unread(messages)
+      mark messages, "unread"
+    end
+
+    protected
+    def mark(messages, action)
+      ids = ids(messages) 
+      action = action == "read" ? "read_message" : "unread_message"
+      resp = self.class.post("/api/#{action}", {:body => {:id => ids.join(','), :uh => modhash }, :headers => base_headers, :debug_output => @debug })
+      resp.code == 200
+    end
+
+    def ids(messages)
+      if messages.is_a?(Array)
+        if messages.first.is_a?(Reddit::Message)
+          return messages.map{|m| m.id }
+        else
+          return messages # assume array of String
+        end
+      else
+        return [ messages.id ]
+      end
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_reddit_api
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - James Cook
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 -06:00
+date: 2010-11-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -38,6 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -51,6 +54,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -66,35 +70,38 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/ruby_reddit_api/json_listing.rb
-- lib/ruby_reddit_api/comment.rb
+- lib/ruby_reddit_api.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/version.rb
+- lib/ruby_reddit_api/thing.rb
 - lib/ruby_reddit_api/user.rb
+- lib/ruby_reddit_api/comment.rb
 - lib/ruby_reddit_api/message.rb
-- lib/ruby_reddit_api/thing.rb
+- lib/ruby_reddit_api/version.rb
+- lib/ruby_reddit_api/message_group.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/base.rb
-- lib/ruby_reddit_api.rb
 - README.rdoc
 - features/reddit.yml
-- features/search.feature
-- features/api.feature
 - features/submission.feature
-- features/base.feature
 - features/comment.feature
-- features/step_definitions/user_steps.rb
+- features/user.feature
+- features/base.feature
+- features/message.feature
+- features/message_group.feature
+- features/search.feature
+- features/api.feature
+- features/step_definitions/message_steps.rb
+- features/step_definitions/submission_steps.rb
 - features/step_definitions/search_steps.rb
+- features/step_definitions/message_group_steps.rb
 - features/step_definitions/api_steps.rb
-- features/step_definitions/submission_steps.rb
+- features/step_definitions/user_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: []
@@ -109,6 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 57
       segments: 
       - 1
       - 8
@@ -119,6 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -133,18 +142,20 @@ specification_version: 3
 summary: Wrapper for reddit API
 test_files: 
 - features/reddit.yml
-- features/search.feature
-- features/api.feature
 - features/submission.feature
-- features/base.feature
 - features/comment.feature
-- features/step_definitions/user_steps.rb
+- features/user.feature
+- features/base.feature
+- features/message.feature
+- features/message_group.feature
+- features/search.feature
+- features/api.feature
+- features/step_definitions/message_steps.rb
+- features/step_definitions/submission_steps.rb
 - features/step_definitions/search_steps.rb
+- features/step_definitions/message_group_steps.rb
 - features/step_definitions/api_steps.rb
-- features/step_definitions/submission_steps.rb
+- features/step_definitions/user_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