usaidwat 1.1.1 → 1.2.0

data/features/user.feature

@@ -0,0 +1,33 @@
+Feature: Display user information
+
+  As a Redditor
+  I want to be able to list basic information about another Redditor
+  In order to learn more about them
+
+  Scenario: List user information
+    Given the Reddit service returns information for the user "mipadi"
+    And time is frozen at Sep 15, 2015 3:16 PM
+    When I run `usaidwat info mipadi`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      Created: [A-Z][a-z]{2} \d{2}, \d{4} \d{2}:\d{2} (A|P)M \(over 7 years ago\)
+      Link Karma: 4892
+      Comment Karma: 33440
+      """
+
+  Scenario: List user information for a non-existent user
+    Given the Reddit service does not have a user "testuser"
+    When I run `usaidwat info testuser`
+    Then it should fail with:
+      """
+      No such user: testuser
+      """
+
+  Scenario: Fail to pass a username when querying for information
+    Given the Reddit service returns information for the user "mipadi"
+    When I run `usaidwat info`
+    Then it should fail with:
+      """
+      You must specify a username
+      """

data/lib/usaidwat/application.rb

@@ -1,5 +1,6 @@
 require 'usaidwat/algo'
 require 'usaidwat/client'
+require 'usaidwat/either'
 require 'usaidwat/pager'
 require 'sysexits'
 
@@ -38,11 +39,37 @@ module USaidWat
       end
     end
 
+    class Info < Command
+      def initialize(prog)
+        prog.command(:info) do |c|
+          c.action do |args, options|
+            process(options, args)
+          end
+        end
+        super
+      end
+
+      def process(options, args)
+        raise ArgumentError.new('You must specify a username') if args.empty?
+        username = args.shift
+
+        redditor = client.new(username)
+        created_at = redditor.created_at.strftime("%b %d, %Y %H:%M %p")
+        puts "Created: #{created_at} (#{redditor.age})"
+        printf "Link Karma: %d\n", redditor.link_karma
+        printf "Comment Karma: %d\n", redditor.comment_karma
+      rescue USaidWat::Client::NoSuchUserError
+        quit "No such user: #{username}", :no_such_user
+      end
+    end
+
     class Log < Command
       def initialize(prog)
         prog.command(:log) do |c|
           c.alias :l
+          c.option 'date', '--date FORMAT', 'Show dates in "absolute" or "relative" format'
           c.option 'grep', '--grep STRING', 'Show only comments matching STRING'
+          c.option 'limit', '-n LIMIT', 'Only show n comments'
           c.option 'oneline', '--oneline', 'Output log in a more compact form'
           c.option 'raw', '--raw', 'Print raw comment bodies'
 
@@ -56,31 +83,69 @@ module USaidWat
       def process(options, args)
         raise ArgumentError.new('You must specify a username') if args.empty?
         username = args.shift
-        subreddit = args.shift
+        subreddits = args.join(' ').split(/[ ,\+]/).map { |sr| sr.downcase }
 
         redditor = client.new(username)
         comments = redditor.comments
-        if subreddit
-          comments = comments.group_by { |c| c.subreddit.downcase }
-          comments = comments[subreddit.downcase]
-          quit "No comments by #{redditor.username} for #{subreddit}." if comments.nil?
-        end
-        comments = comments.select { |c| c.body =~ /#{options['grep']}/i } if options['grep']
-        if comments.empty?
-          msg = "#{redditor.username} has no comments"
-          msg = "#{msg} matching /#{options['grep']}/" if options['grep']
-          msg = "#{msg}."
-          quit msg
-        end
-        list_comments(comments, options['grep'], !options['oneline'].nil?, !options['raw'].nil?)
+
+        res = filter_comments(redditor, comments, subreddits) >>
+              lambda { |r| grep_comments(redditor, r.value, options['grep']) } >>
+              lambda { |r| limit_comments(redditor, r.value, options['limit']) } >>
+              lambda { |r| ensure_comments(redditor, r.value) }
+
+        quit res.value if res.left?
+
+        opts = {
+          :date_format => (options['date'] || :relative).to_sym,
+          :oneline => !options['oneline'].nil?,
+          :pattern => options['grep'],
+          :raw => !options['raw'].nil?,
+        }
+        list_comments(res.value, opts)
       rescue USaidWat::Client::NoSuchUserError
         quit "No such user: #{username}", :no_such_user
       end
 
       private
 
-      def list_comments(comments, pattern = nil, oneline = false, raw = false)
-        formatter = (oneline ? USaidWat::CLI::CompactCommentFormatter : USaidWat::CLI::CommentFormatter).new(pattern, raw)
+      def filter_comments(redditor, comments, subreddits)
+        return USaidWat::Right.new(comments) if subreddits.empty?
+        comments = comments.find_all { |c| subreddits.include?(c.subreddit.downcase) }
+        if comments.empty?
+          USaidWat::Left.new("No comments by #{redditor.username} for #{subreddits.join(', ')}.")
+        else
+          USaidWat::Right.new(comments)
+        end
+      end
+
+      def grep_comments(redditor, comments, grep)
+        return USaidWat::Right.new(comments) if grep.nil?
+        comments = comments.select { |c| c.body =~ /#{grep}/i }
+        if comments.empty?
+          msg = "#{redditor.username} has no comments matching /#{grep}/."
+          USaidWat::Left.new(msg)
+        else
+          USaidWat::Right.new(comments)
+        end
+      end
+
+      def limit_comments(redditor, comments, n)
+        return USaidWat::Right.new(comments) if n.nil?
+        comments = comments[0...n.to_i]
+        USaidWat::Right.new(comments)
+      end
+
+      def ensure_comments(redditor, comments)
+        if comments.empty?
+          USaidWat::Left.new("#{redditor.username} has no comments.")
+        else
+          USaidWat::Right.new(comments)
+        end
+      end
+
+      def list_comments(comments, options = {})
+        oneline = options[:oneline]
+        formatter = (oneline ? USaidWat::CLI::CompactCommentFormatter : USaidWat::CLI::CommentFormatter).new(options)
         page
         comments.each { |c| print formatter.format(c) }
       end
@@ -105,7 +170,6 @@ module USaidWat
         username = args.first
 
         redditor = client.new(username)
-        algo_cls = options['count'] ? USaidWat::Algorithms::CountAlgorithm : USaidWat::Algorithms::LexicographicalAlgorithm
         quit "#{redditor.username} has no comments." if redditor.comments.empty?
         # Unfortunately Snooby cannot return comments for a specific
         # user in a specific subreddit, so for now we have to sort them
@@ -117,7 +181,7 @@ module USaidWat
           longest_subreddit = subreddit.length if subreddit.length > longest_subreddit
           buckets[subreddit] += 1
         end
-        algo = algo_cls.new(buckets)
+        algo = algorithm(options['count']).new(buckets)
         subreddits = buckets.keys.sort { |a,b| algo.sort(a, b) }
         subreddits.each do |subreddit|
           tally = buckets[subreddit]
@@ -126,6 +190,12 @@ module USaidWat
       rescue USaidWat::Client::NoSuchUserError
         quit "No such user: #{username}", :no_such_user
       end
+
+      private
+
+      def algorithm(count)
+        count ? USaidWat::Algorithms::CountAlgorithm : USaidWat::Algorithms::LexicographicalAlgorithm
+      end
     end
   end
 end

data/lib/usaidwat/client.rb

@@ -1,5 +1,6 @@
 require 'snooby'
 require 'usaidwat/service'
+require 'usaidwat/ext/time'
 
 module USaidWat
   module Client
@@ -15,16 +16,46 @@ module USaidWat
       end
 
       def comments
-        @service.user(username).comments(100)
+        user.comments(100)
       rescue NoMethodError
         raise NoSuchUserError, username
       rescue TypeError
         raise ReachabilityError, "Reddit unreachable"
       end
 
+      def link_karma
+        about('link_karma')
+      end
+
+      def comment_karma
+        about('comment_karma')
+      end
+
+      def created_at
+        Time.at(about('created_utc'))
+      end
+
+      def age
+        (Time.now - created_at).ago
+      end
+
       def to_s
         "#{username}"
       end
+
+      private
+
+      def user
+        @service.user(username)
+      end
+
+      def about(key)
+        user.about[key]
+      rescue NoMethodError
+        raise NoSuchUserError, username
+      rescue TypeError
+        raise ReachabilityError, "Reddit unreachable"
+      end
     end
 
     class Redditor < BaseRedditor

data/lib/usaidwat/either.rb

@@ -0,0 +1,41 @@
+module USaidWat
+  class Either
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def >>(&block)
+      raise NoMethodError, 'subclasses must define >>'
+    end
+
+    def left?
+      false
+    end
+
+    def right?
+      false
+    end
+  end
+
+  class Left < Either
+    def >>(callable)
+      self
+    end
+
+    def left?
+      true
+    end
+  end
+
+  class Right < Either
+    def >>(callable)
+      callable.call(self)
+    end
+
+    def right?
+      true
+    end
+  end
+end

data/lib/usaidwat/ext/time.rb

@@ -2,9 +2,60 @@ require 'usaidwat/ext/string'
 
 class Time
   def ago
-    case minutes_ago
+    delta.ago
+  end
+
+  def seconds_ago
+    delta.seconds_ago
+  end
+
+  def minutes_ago
+    delta.minutes_ago
+  end
+
+  def hours_ago
+    delta.hours_ago
+  end
+
+  def days_ago
+    delta.days_ago
+  end
+
+  def weeks_ago
+    delta.weeks_ago
+  end
+
+  def months_ago
+    delta.months_ago
+  end
+
+  def years_ago
+    delta.years_ago
+  end
+
+  private
+
+  def delta
+    Time.now - self
+  end
+end
+
+class Numeric
+  def negative?
+    self < 0
+  end
+
+  def positive?
+    self > 0
+  end
+end
+
+class Float
+  def ago
+    raise ArgumentError, "Delta is negative: #{self}" if negative?
+    case minutes_ago.to_i
     when 0..1
-      case seconds_ago
+      case seconds_ago.to_i
       when 0..5   then "less than 5 seconds ago"
       when 6..10  then "less than 10 seconds ago"
       when 11..20 then "less than 20 seconds ago"
@@ -20,12 +71,12 @@ class Time
     when 10081..43220    then "about #{weeks_ago.round} #{"week".pluralize(weeks_ago.round)} ago"
     when 43221..525960   then "about #{months_ago.round} #{"month".pluralize(months_ago.round)} ago"
     when 525960..1051920 then "about a year ago"
-    else                      "over #{years_ago.round} years ago"
+    else                      "over #{years_ago.to_i} years ago"
     end
   end
 
   def seconds_ago
-    Time.now.to_i - to_i
+    self
   end
 
   def minutes_ago

data/lib/usaidwat/formatter.rb

@@ -1,9 +1,9 @@
 require 'date'
 require 'downterm'
-require 'highline'
 require 'rainbow/ext/string'
 require 'redcarpet'
 require 'stringio'
+require 'tty-screen'
 require 'usaidwat/ext/string'
 require 'usaidwat/ext/time'
 
@@ -12,25 +12,36 @@ Rainbow.enabled = true unless ENV['USAIDWAT_ENV'] == 'cucumber'
 module USaidWat
   module CLI
     class BaseFormatter
-      attr_reader :pattern
-
-      def initialize(pattern = nil, raw = false)
-        @pattern = pattern
-        @raw = raw
+      def initialize(options = {})
+        @options = options
         @count = 0
       end
 
+      def pattern
+        @options[:pattern]
+      end
+
       def pattern?
-        !@pattern.nil?
+        !!@options[:pattern]
       end
 
       def raw?
-        @raw
+        !!@options[:raw]
       end
+
+      def relative_dates?
+        @options[:date_format].nil? || @options[:date_format].to_sym != :absolute
+      end
+
+      protected
+
+        def tty
+          @tty || TTY::Screen.new
+        end
     end
 
     class CommentFormatter < BaseFormatter
-      def initialize(pattern = nil, raw = false)
+      def initialize(options = {})
         @markdown = Redcarpet::Markdown.new(Downterm::Render::Terminal, :autolink => true,
                                                                         :strikethrough => true,
                                                                         :superscript => true)
@@ -38,13 +49,15 @@ module USaidWat
       end
 
       def format(comment)
-        cols = HighLine::SystemExtensions.terminal_size[0]
+        cols = tty.width
         out = StringIO.new
         out.write("\n\n") unless @count == 0
         out.write("#{comment.subreddit}\n".color(:green))
         out.write("#{comment_link(comment)}\n".color(:yellow))
         out.write("#{comment.link_title.strip.truncate(cols)}\n".color(:magenta))
-        out.write("#{comment_date(comment)}\n".color(:blue))
+        out.write("#{comment_date(comment)}".color(:blue))
+        out.write(" \u2022 ".color(:cyan))
+        out.write(sprintf("%+d\n", comment_karma(comment)).color(:blue))
         out.write("\n")
         out.write("#{comment_body(comment)}\n")
         @count += 1
@@ -54,7 +67,7 @@ module USaidWat
       
       private
         def comment_body(comment)
-          body = comment.body
+          body = comment.body.strip
           body = @markdown.render(body) unless raw?
           if pattern?
             body.highlight(pattern)
@@ -69,13 +82,24 @@ module USaidWat
         end
 
         def comment_date(comment)
-          DateTime.strptime(comment.created_utc.to_s, "%s").to_time.localtime.ago
+          d = DateTime.strptime(comment.created_utc.to_s, "%s").to_time.localtime
+          if relative_dates?
+            d.ago
+          else
+            d_part = d.strftime("%-d %b %Y")
+            t_part = d.strftime("%l:%M %p").strip
+            "#{d_part} #{t_part}"
+          end
+        end
+
+        def comment_karma(comment)
+          comment.ups - comment.downs
         end
     end
 
     class CompactCommentFormatter < BaseFormatter
       def format(comment)
-        cols = HighLine::SystemExtensions.terminal_size[0]
+        cols = tty.width
         out = StringIO.new
         subreddit = comment.subreddit
         cols -= subreddit.length + 1

data/lib/usaidwat/service.rb

@@ -1,7 +1,7 @@
 module USaidWat
   module Service
     class MockComment
-      attr_reader :subreddit, :body, :id, :link_id, :created_utc, :link_title
+      attr_reader :subreddit, :body, :id, :link_id, :created_utc, :link_title, :ups, :downs
 
       def initialize(dict)
         data = dict['data']
@@ -11,6 +11,8 @@ module USaidWat
         @link_id = data['link_id']
         @created_utc = data['created_utc']
         @link_title = data['link_title']
+        @ups = data['ups']
+        @downs = data['downs']
       end
     end
 
@@ -19,15 +21,21 @@ module USaidWat
         @username = username
       end
 
+      def about
+        load_data("user_#{@username}.json")['data']
+      end
+
       def comments(n)
-        path = File.join(File.dirname(__FILE__), "..", "..", "features", "fixtures", "#{@username}.json")
-        if File.exists?(path)
-          json = IO.read(path)
-          json = JSON.parse(json)
-          json['data']['children'].map { |d| MockComment.new(d) }
-        else
-          raise USaidWat::Client::NoSuchUserError, @username
-        end
+        json = load_data("#{@username}.json")
+        json['data']['children'].map { |d| MockComment.new(d) }
+      end
+
+      private
+
+      def load_data(data_file)
+        path = File.join(File.dirname(__FILE__), "..", "..", "features", "fixtures", data_file)
+        raise USaidWat::Client::NoSuchUserError, @username unless File.exists?(path)
+        JSON.parse(IO.read(path))
       end
     end
 

data/lib/usaidwat/version.rb

@@ -1,3 +1,3 @@
 module USaidWat
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/usaidwat/client_spec.rb

@@ -4,19 +4,19 @@ module USaidWat
   module Client
     describe Client do
       let(:redditor) { Redditor.new("mipadi") }
-      
+
       describe "#username" do
         it "returns the Redditor's username" do
           expect(redditor.username).to eq("mipadi")
         end
       end
-      
+
       describe "#to_s" do
         it "returns a string representing the Redditor" do
           expect("#{redditor}").to eq("mipadi")
         end
       end
-      
+
       context "when Reddit is up" do
         before(:each) do
           WebMock.disable_net_connect!
@@ -24,13 +24,47 @@ module USaidWat
           root = File.expand_path("../../../features/fixtures", __FILE__)
           stub_request(:get, "http://www.reddit.com/user/mipadi/comments.json?after=&limit=100").
             to_return(:body => IO.read(File.join(root, "mipadi.json")))
+          stub_request(:get, "http://www.reddit.com/user/mipadi/about.json").
+            to_return(:body => IO.read(File.join(root, "user_mipadi.json")))
+
+          Timecop.freeze(Time.new(2015, 9, 15, 11, 14, 30, "-07:00"))
         end
-      
+
+        after(:each) do
+          Timecop.return
+        end
+
         describe "#comments" do
           it "retrieves 100 comments" do
             expect(redditor.comments.count).to eq(100)
           end
         end
+
+        describe "#link_karma" do
+          it "returns the user's link karma" do
+            expect(redditor.link_karma).to eq(4892)
+          end
+        end
+
+        describe "#comment_karma" do
+          it "returns the user's comment karma" do
+            expect(redditor.comment_karma).to eq(33440)
+          end
+        end
+
+        describe "#created_at" do
+          it "returns the date the account was created" do
+            expected = Time.new(2008, 3, 31, 15, 55, 26, "-07:00")
+            expect(redditor.created_at).to eq(expected)
+          end
+        end
+
+        describe "#age" do
+          it "returns a string describing the age of the account" do
+            expected = "over 7 years ago"
+            expect(redditor.age).to eq(expected)
+          end
+        end
       end
 
       context "when a Reddit user does not exist" do
@@ -40,6 +74,8 @@ module USaidWat
           root = File.expand_path("../../../features/fixtures", __FILE__)
           stub_request(:get, "http://www.reddit.com/user/testuser/comments.json?after=&limit=100").
             to_return(:status => 404, :body => IO.read(File.join(root, "testuser.json")))
+          stub_request(:get, "http://www.reddit.com/user/testuser/about.json").
+            to_return(:status => 404, :body => IO.read(File.join(root, "user_testuser.json")))
         end
 
         describe "#comments" do
@@ -47,21 +83,71 @@ module USaidWat
             expect { Redditor.new("testuser").comments }.to raise_error(NoSuchUserError, /testuser/)
           end
         end
+
+        describe "#link_karma" do
+          it "raises an exception if the user does not exist" do
+            expect { Redditor.new("testuser").link_karma }.to raise_error(NoSuchUserError, /testuser/)
+          end
+        end
+
+        describe "#comment_karma" do
+          it "raises an exception if the user does not exist" do
+            expect { Redditor.new("testuser").comment_karma }.to raise_error(NoSuchUserError, /testuser/)
+          end
+        end
+
+        describe "#created_at" do
+          it "raises an exception if the user does not exist" do
+            expect { Redditor.new("testuser").created_at }.to raise_error(NoSuchUserError, /testuser/)
+          end
+        end
+
+        describe "#age" do
+          it "raises an exception if the user does not exist" do
+            expect { Redditor.new("testuser").age }.to raise_error(NoSuchUserError, /testuser/)
+          end
+        end
       end
-      
+
       context "when Reddit is down" do
         before(:each) do
           WebMock.disable_net_connect!
           WebMock.reset!
           stub_request(:get, "http://www.reddit.com/user/mipadi/comments.json?after=&limit=100").
             to_return(:status => 500)
+          stub_request(:get, "http://www.reddit.com/user/mipadi/about.json").
+            to_return(:status => 500)
         end
-        
+
         describe "#comments" do
           it "raises 'Reddit unreachable' error" do
             expect { redditor.comments }.to raise_error(ReachabilityError, /Reddit unreachable/)
           end
         end
+
+        describe "#link_karma" do
+          it "raises 'Reddit unreachable' error" do
+            expect { redditor.link_karma }.to raise_error(ReachabilityError, /Reddit unreachable/)
+          end
+        end
+
+        describe "#comment_karma" do
+          it "raises 'Reddit unreachable' error" do
+            expect { redditor.comment_karma }.to raise_error(ReachabilityError, /Reddit unreachable/)
+          end
+        end
+
+        describe "#created_at" do
+          it "raises 'Reddit unreachable' error" do
+            expect { redditor.created_at }.to raise_error(ReachabilityError, /Reddit unreachable/)
+          end
+        end
+
+        describe "#age" do
+          it "raises 'Reddit unreachable' error" do
+            expect { redditor.age }.to raise_error(ReachabilityError, /Reddit unreachable/)
+          end
+        end
       end
     end
   end