stacked 0.5.0

data/spec/stacked/reputation_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stacked::Reputation do
+  # Being very particular about what Reputation we mean...
+  subject { Stacked::User.find(22656).reputations(:fromdate => 1270132345, :todate => 1270132348).first }
+
+  it "should be able to find the related post" do
+    subject.post.should be_is_a(Stacked::Answer)
+  end
+
+  it "should be able to work out the score of a reputation" do
+    # Yeah right, like anyone would ever vote down a Jon Skeet answer and live.
+    subject.stub!(:negative_rep => 15)
+    subject.score.should eql(0)
+  end
+
+
+end

data/spec/stacked/tag_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stacked::Tag do
+  subject { Stacked::Tag }
+  it "finds all the tags" do
+    subject.all(:pagesize => 1).first.name.should eql("c#")
+  end
+
+  it "finds the popular tags" do
+    subject.popular(:pagesize => 2).should be_sorted_by(:count, :desc)
+  end
+
+  it "finds the tags ordered by name" do
+    subject.name(:pagesize => 2).should be_sorted_by(:name, :asc)
+  end
+
+  it "finds the tags used recently" do
+    subject.recent(:pagesize => 2).size.should eql(2)
+  end
+
+end

data/spec/stacked/user_spec.rb

@@ -0,0 +1,187 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stacked::User do
+  subject { Stacked::User }
+  context "class methods" do
+
+    it "gathers the newest user" do
+      subject.newest(:pagesize => 1).first.creation_date.should be_within(1.day)
+    end
+
+    it "gathers the oldest user" do
+      subject.oldest(:pagesize => 1).first.name.should eql("Community")
+    end
+
+    it "gathers the users by name" do
+      subject.name(:pagesize => 1).first.name.should eql("[ebarrera]")
+    end
+
+    it "gathers users by reputation" do
+      subject.reputation(:pagesize => 1).first.name.should eql("Jon Skeet")
+    end
+
+    it "gathers all the Ryan Bigg users" do
+      # Limited to 1 result in case other people want to steal my name.
+      subject.filter("Ryan Bigg", :pagesize => 1).first.name.should eql("Ryan Bigg")
+    end
+  end
+
+  context "instance methods" do
+    subject { Stacked::User.find(22656) }
+
+    aliases(
+            :created_at   => :creation_date,
+            :display_name => :name,
+            :down_votes   => :down_vote_count,
+            :gravatar     => :email_hash,
+            :up_votes     => :up_vote_count,
+            :user_id      => :id,
+            :user_type    => :type,
+            :views        => :view_count
+            )
+
+    context "answers" do
+      it "finds the user's answers" do
+        subject.answers.should_not be_empty
+        subject.answers.first.should be_is_a(Stacked::Answer)
+      end
+
+      it "finds the user's most recent answers" do
+        pending("Waiting for last_activity_date to be implemented.")
+        subject.recent_answers(:pagesize => 2).should be_sorted_by(:last_edit_date, :desc)
+      end
+      
+      it "finds the user's newest answers" do
+        subject.newest_answers(:pagesize => 2).should be_sorted_by(:creation_date, :desc)
+      end
+      
+      it "finds the user's most popular answers" do
+        subject.answers_by_votes(:pagesize => 2).should be_sorted_by(:score, :desc)
+      end
+      
+      it "finds the user's most viewed answers" do
+        subject.answers_by_views(:pagesize => 2).should be_sorted_by(:views, :desc)
+      end
+    end
+
+    context "comments" do
+      it "finds some of the user's comments" do
+        subject.comments.should_not be_empty
+        subject.comments.first.should be_is_a(Stacked::Comment)
+      end
+
+      it "finds the user's recent comments" do
+        subject.recent_comments.should be_sorted_by(:creation_date, :desc)
+      end
+
+      it "finds the user's most awesome comments" do
+        subject.popular_comments.should be_sorted_by(:score, :desc)
+      end
+
+      it "finds all comments directed at a user" do
+        # The "magic" numbers for the date range are "around" comment #2561833.
+        # This method is a bit funny, why would you want this time-boxed?
+        subject.directed_at(133566, :fromdate => 1270107600, :todate => 1270107700).first.should be_is_a(Stacked::Comment)
+      end
+      
+      it "finds all comments directed at a user recently" do
+        subject.directed_at_by_date(133566, :fromdate => 1270107600, :todate => 1270107700).first.should be_is_a(Stacked::Comment)
+      end
+      
+      it "finds all comments directed at a user by score" do
+        subject.directed_at_by_score(133566, :fromdate => 1270107600, :todate => 1270107700).first.should be_is_a(Stacked::Comment)
+      end
+    end
+
+    context "favourites" do
+
+      # Yes I'm using "favourites" and not "favorites"
+      # This has the intended side-effect of testing the existance of
+      # the alias as well as the real method
+      it "finds the user's favourite questions" do
+        subject.favourites.should_not be_empty
+        subject.favourites.first.should be_is_a(Stacked::Question)
+      end
+
+      it "can pass options to favourites" do
+        subject.favourites.size.should eql(19)
+        subject.favourites(:pagesize => 1).size.should eql(1)
+      end
+
+      it "finds the most recent favourites" do
+        subject.recent_favourites(:pagesize => 2).should be_sorted_by(:last_activity_date, :desc)
+      end
+
+      it "finds the most viewed favourites" do
+        subject.favourites_by_views(:pagesize => 2).should be_sorted_by(:view_count, :desc)
+      end
+
+      it "finds the newest favourites" do
+        subject.newest_favourites(:pagesize => 2).should be_sorted_by(:creation_date, :desc)
+      end
+
+      it "finds the favourites in the order they were made favourite" do
+        # How the devil do you test this?
+        subject.added_favourites(:pagesize => 1).first.should be_is_a(Stacked::Question)
+      end
+
+    end
+
+    context "questions" do
+
+      it "finds the user's questions" do
+        question = subject.questions.first
+        question.should be_is_a(Stacked::Question)
+        question.owner_user_id.should eql(subject.id)
+      end
+
+      it "can pass options to questions" do
+        subject.questions.size.should eql(22)
+        subject.questions(:pagesize => 1).size.should eql(1)
+      end
+
+      it "finds the user's recent questions" do
+        questions = subject.recent_questions(:pagesize => 2)
+        questions.should be_sorted_by(:last_activity_date, :desc)
+      end
+
+      it "finds the user's most viewed questions" do
+        questions = subject.questions_by_views(:pagesize => 2)
+        questions.should be_sorted_by(:view_count, :desc)
+      end
+
+      it "finds the user's newest questions" do
+        questions = subject.newest_questions(:pagesize => 2)
+        questions.should be_sorted_by(:creation_date, :desc)
+      end
+
+      it "finds the user's most popular questions" do
+        questions = subject.popular_questions(:pagesize => 2)
+        questions.should be_sorted_by(:score, :desc)
+      end
+    end
+
+    it "reputations" do
+      reputation = subject.reputations(:pagesize => 1).first
+      reputation.should be_is_a(Stacked::Reputation)
+    end
+
+    it "mentioned / mentions" do
+      # Testing the mentioned method by way of aliases.
+      subject.mentions(:pagesize => 1).first.should be_is_a(Stacked::Comment)
+    end
+
+    it "timeline" do
+      subject.timeline(:pagesize => 1).first.should be_is_a(Stacked::Usertimeline)
+    end
+
+    it "tags" do
+      subject.tags(:pagesize => 1).first.should be_is_a(Stacked::Tag)
+    end
+
+    it "badges" do
+      subject.badges(:pagesize => 1).first.name.should eql(".net")
+    end
+
+  end
+end

data/spec/stacked/usertimeline_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stacked::Usertimeline do
+
+end

data/spec/support/aliases.rb

@@ -0,0 +1,7 @@
+def aliases(methods)
+  methods.each do |original, new|
+    it "#{original} is available as #{new}" do
+      subject.send(original).should eql(subject.send(new))
+    end
+  end
+end

data/spec/support/sorted_by.rb

@@ -0,0 +1,31 @@
+module Spec
+  module Matchers
+    class Sortedby #:nodoc:
+      def initialize(field=nil, direction=:asc)
+        @field = field
+        @direction = direction
+        @pretty_direction = direction == :desc ? "descending" : "ascending"
+        # Placeholder
+      end
+
+      def matches?(receiver)
+        if @direction.to_sym == :desc
+          receiver[0].send(@field) > receiver[1].send(@field)
+        elsif @direction.to_sym == :asc
+          receiver[0].send(@field) < receiver[1].send(@field)
+        else
+          raise "direction must be either :desc or :asc or their String counterparts"
+        end
+      end
+
+      def failure_message
+        "Expected result set to be sorted by #{@field} in #{@pretty_direction} order, but was not."
+      end
+
+    end
+
+    def be_sorted_by(field=nil, direction=:asc)
+      Spec::Matchers::Sortedby.new(field, direction)
+    end
+  end
+end

data/spec/support/within.rb

@@ -0,0 +1,24 @@
+module Spec
+  module Matchers
+    class Within #:nodoc:
+      def initialize(receiver=nil, &block)
+        @receiver = receiver
+        # Placeholder
+      end
+
+      def matches?(time)
+        time = Time.at(time) if time.is_a?(Numeric)
+        @receiver.ago < time
+      end
+
+      def failure_message
+        "Expected time to be within #{@receiver.inspect}, but was not."
+      end
+
+    end
+
+    def be_within(receiver=nil)
+      Spec::Matchers::Within.new(receiver)
+    end
+  end
+end

data/spec/within_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Spec::Matchers::Within do
+  it "is within one day" do
+    time = Time.now - 5.minutes
+    time.should be_within(1.day)
+  end
+
+  it "is fine with integers" do
+    time = Time.now.to_i
+    time.should be_within(1.day)
+  end
+
+  it "fails with an understandable error message" do
+    time = Time.now - 5.days
+    lambda { time.should be_within(5.seconds) }.should raise_error("Expected time to be within 5 seconds, but was not.")
+  end
+
+end

data/stacked.gemspec

@@ -0,0 +1,115 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stacked}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bigg"]
+  s.date = %q{2010-04-04}
+  s.description = %q{Ruby wrapper for the Stack Overflow API}
+  s.email = %q{ryan@getup.org.au}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.markdown",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cleaner.rb",
+     "doc/Stacked.html",
+     "doc/Stacked/Answer.html",
+     "doc/Stacked/Badge.html",
+     "doc/Stacked/Base.html",
+     "doc/Stacked/Comment.html",
+     "doc/Stacked/NotImplemented.html",
+     "doc/Stacked/Posttimeline.html",
+     "doc/Stacked/Question.html",
+     "doc/Stacked/Reputation.html",
+     "doc/Stacked/Tag.html",
+     "doc/Stacked/User.html",
+     "doc/Stacked/Usertimeline.html",
+     "doc/_index.html",
+     "doc/file.README.html",
+     "doc/index.html",
+     "doc/method_list.html",
+     "doc/top-level-namespace.html",
+     "genddoc.sh",
+     "lib/stacked.rb",
+     "lib/stacked/answer.rb",
+     "lib/stacked/badge.rb",
+     "lib/stacked/base.rb",
+     "lib/stacked/comment.rb",
+     "lib/stacked/posttimeline.rb",
+     "lib/stacked/question.rb",
+     "lib/stacked/reputation.rb",
+     "lib/stacked/tag.rb",
+     "lib/stacked/user.rb",
+     "lib/stacked/usertimeline.rb",
+     "spec/sorted_by_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/stacked/answer_spec.rb",
+     "spec/stacked/badge_spec.rb",
+     "spec/stacked/base_spec.rb",
+     "spec/stacked/comment_spec.rb",
+     "spec/stacked/question_spec.rb",
+     "spec/stacked/reputation_spec.rb",
+     "spec/stacked/tag_spec.rb",
+     "spec/stacked/user_spec.rb",
+     "spec/stacked/usertimeline_spec.rb",
+     "spec/support/aliases.rb",
+     "spec/support/sorted_by.rb",
+     "spec/support/within.rb",
+     "spec/within_spec.rb",
+     "stacked.gemspec",
+     "stylesheet.css"
+  ]
+  s.homepage = %q{http://github.com/radar/stacked}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby wrapper for the Stack Overflow API}
+  s.test_files = [
+    "spec/sorted_by_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/stacked/answer_spec.rb",
+     "spec/stacked/badge_spec.rb",
+     "spec/stacked/base_spec.rb",
+     "spec/stacked/comment_spec.rb",
+     "spec/stacked/question_spec.rb",
+     "spec/stacked/reputation_spec.rb",
+     "spec/stacked/tag_spec.rb",
+     "spec/stacked/user_spec.rb",
+     "spec/stacked/usertimeline_spec.rb",
+     "spec/support/aliases.rb",
+     "spec/support/sorted_by.rb",
+     "spec/support/within.rb",
+     "spec/within_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.4.5"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+  end
+end

data/stylesheet.css

@@ -0,0 +1,41 @@
+body {
+  font:12pt "Myriad Pro";
+  margin: 5;
+}
+
+a {
+  color: white;
+}
+
+h1 a {
+  color: black;
+}
+
+h3 {
+  background: #DB9C39;
+  color: white;
+  padding: 20px;
+  margin: 0;
+  border-bottom: 3px solid #343434;
+}
+
+section {
+  display: block;
+  border: 3px solid #343434;
+  margin-bottom: 10px;
+  -moz-border-radius: 10px;
+}
+
+section div {
+  margin-top: 10px;
+  padding: 20px;
+}
+
+pre, code {
+  background: #DECAAB;
+  padding: 3px;
+}
+/*
+.hidden {
+  display: none;
+}*/