rubyoverflow 0.5 → 1.0.2

data/lib/rubyoverflow/userTimelineEvent.rb

@@ -0,0 +1,43 @@
+module Rubyoverflow
+  class UserTimelineEvent
+    attr_reader :user_id
+    attr_reader :timeline_type
+    attr_reader :post_id
+    attr_reader :post_type
+    attr_reader :comment_id
+    attr_reader :action
+    attr_reader :creation_date
+    attr_reader :description
+    attr_reader :detail
+  
+    def initialize(hash, request_path = '')
+      dash = UserTimelineEventDash.new hash
+    
+      @user_id = dash.user_id
+      @timeline_type = dash.timeline_type
+      @post_id = dash.post_id
+      @post_type = dash.post_type
+      @comment_id = dash.comment_id
+      @action = dash.action
+      @creation_date = dash.creation_date
+      @description = dash.description
+      @detail = dash.detail
+    end
+  
+  
+  end
+
+  class UserTimelineEventDash < BaseDash
+
+    property :user_id
+    property :timeline_type
+    property :post_id
+    property :post_type
+    property :comment_id
+    property :action
+    property :creation_date
+    property :description
+    property :detail
+  
+  end
+end

data/lib/rubyoverflow/userTimelineEvents.rb

@@ -0,0 +1,35 @@
+module Rubyoverflow
+  class UserTimelineEvents < PagedBase
+    attr_reader :user_timelines
+    def initialize(hash, request_path = '')
+      dash = UserTimelineEventsDash.new hash
+      super(dash, request_path)
+      @user_timelines = Array.new
+      dash.user_timelines.each{|timelineHash| @user_timelines.push(UserTimelineEvent.new timelineHash)}
+    end
+    
+    #Retrieves the next set of UserTimelineEvents using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      UserTimelineEvents.new hash,url
+    end
+  
+    class << self
+      #Retrieves a set of timeline events for a set of user(s) by their id(s)
+      #
+      #id can be an int, string or an array of ints or strings
+      #
+      #Maps to 'users/{id}/timeline
+      def retrieve_by_user(id, parameters = {})
+        id = convert_to_id_list(id)
+        hash, url = request('users/' + id.to_s + '/timeline',parameters)
+        UserTimelineEvents.new hash, url
+      end
+    
+    end
+  end
+
+  class UserTimelineEventsDash < PagedDash
+    property :user_timelines
+  end
+end

data/lib/rubyoverflow/users.rb

@@ -1,24 +1,73 @@
 module Rubyoverflow
-  class Users
-
-    def initialize(client)
-      @client = client
+  class Users < PagedBase
+    attr_reader :users
+  
+    def initialize(hash, request_path = '')
+      dash = UsersDash.new hash
+      super(dash, request_path)
+      @users = Array.new
+    
+      dash.users.each{|userHash| @users.push(User.new userHash)} if dash.users
+      dash.associated_users.each{|userHash| @users.push(User.new userHash)} if dash.associated_users
+      
     end
-
-    def fetch(params = {})
-      ids = params.delete(:id) if params[:id]
-      ids = ids.join(';') if ids and ids.kind_of? Array
-      hash,url = @client.request "users#{"/#{ids}" if ids}", params
-
-      Hashie::Mash.new hash
+    
+    #Retrieves the next set of users using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      Users.new hash,url
+    end
+  
+    class << self
+    
+      #Retieves all users using the parameters provided
+      #
+      #Maps to '/users'
+      def retrieve_all(parameters = {})
+        hash,url = request('users/', parameters)
+        Users.new hash, url
+      end
+    
+      #Retrieves users by id(s) using the parameters provided
+      #
+      #id can be an int, string, or an array of either
+      #
+      #Maps to '/users/{id}'
+      def retrieve_by_id(id, parameters = {})
+        id = convert_to_id_list(id)
+        hash,url = request('users/'+id.to_s, parameters)
+        Users.new hash, url
+      end
+    
+      #Retrieves users that have received badge(s) by badge id(s) using the parameters provided
+      #
+      #id can be an int, string, badge or an array of any of the three
+      #
+      #Maps to '/badges/{id}'
+      def retrieve_by_badge(id, parameters = {})
+        id = convert_to_id_list(id)
+        hash,url = request('badges/'+id.to_s, parameters)
+        Users.new hash, url
+      end
+      
+      #Retrieves moderators for the current site the parameters provided
+      #
+      #Maps to '/users/moderators'
+      def retrieve_moderators(parameters = {})
+        hash,url = request('users/moderators', parameters)
+        Users.new hash, url
+      end
+      
+      def retrieve_associated_accounts(guid)
+        client = Client.stackauth_client(Base.client.api_key)
+        hash,url = client.request('users/' + guid +'/associated',{})
+        Users.new hash,url
+      end
     end
   end
 
-  class Client
-    @users = nil
-
-    def users
-      @users ||= Users.new(self)
-    end
+  class UsersDash < PagedDash
+    property :users
+    property :associated_users
   end
-end
+end

data/test/apiKey.rb

@@ -0,0 +1,5 @@
+class ApiKey
+  def self.api_key
+    'WiNylIPGTkm4DrBH2yYZ3g'
+  end
+end

data/test/helper.rb

@@ -0,0 +1,159 @@
+require 'rubygems'
+require 'test/unit'
+require 'spec'
+require 'apikey'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubyoverflow'
+include Rubyoverflow
+
+class Test::Unit::TestCase
+end
+def set_api_key
+  Rubyoverflow::Client.config do |options|
+    options.api_key = ApiKey.api_key
+  end
+end
+def check_paged_class(paged_class, page_size)
+  paged_class.should respond_to(:total)
+  paged_class.should respond_to(:pagesize)
+  paged_class.should respond_to(:page)
+  paged_class.should respond_to(:request_path)
+  paged_class.should respond_to(:query_parameters)
+  paged_class.pagesize.should == page_size
+end
+
+def single_item_set
+  {:pagesize => 1}
+end
+
+def check_user_set(users, page_size = 1)
+  check_paged_class(users, page_size)
+  users.should respond_to(:users)
+  check_user users.users.first
+end
+
+def check_answer_set(answers, page_size = 1)
+  check_paged_class(answers, page_size)
+  answers.should respond_to(:answers)
+  check_answer answers.answers.first
+end
+
+def check_api_site_set(api_sites, page_size = 1)
+  check_paged_class(api_sites, page_size)
+  api_sites.should respond_to(:api_sites)
+  #check_api_site api_sites.api_sites.first
+end
+
+def check_badge_set(badges)
+  badges.should respond_to(:badges)
+  check_badge badges.badges.first
+end
+
+def check_comment_set(comments, page_size = 1)
+  check_paged_class(comments, page_size)
+  comments.should respond_to(:comments)
+  #check_comment comments.comments.first
+end
+
+def check_post_timeline_event_set(post_timeline_events, page_size = 1)
+  check_paged_class(post_timeline_events, page_size)
+  post_timeline_events.should respond_to(:post_timelines)
+  #check_post_timeline_event post_timeline_events.post_timelines.first
+end
+
+def check_rep_change_set(rep_changes, page_size = 1)
+  check_paged_class(rep_changes, page_size)
+  rep_changes.should respond_to(:rep_changes)
+  #check_rep_change rep_changes.rep_changes.first
+end
+
+def check_revision_set(revisions, page_size = 1)
+  check_paged_class(revisions, page_size)
+  revisions.should respond_to(:revisions)
+  #check_revision revisions.revisions.first
+end
+
+def check_tag_set(tags, page_size = 1)
+  check_paged_class(tags, page_size)
+  tags.should respond_to(:tags)
+  #check_tag tags.tags.first
+end
+
+def check_user_timeline_event_set(user_timeline_events, page_size = 1)
+  check_paged_class(user_timeline_events, page_size)
+  user_timeline_events.should respond_to(:user_timelines)
+  #check_user_timeline_event user_timeline_events.user_timelines.first
+end
+
+def check_question_set(questions, page_size = 1)
+  check_paged_class(questions, page_size)
+  questions.should respond_to(:questions)
+  #check_question questions.questions.first
+end
+
+def check_answer(answer)
+  answer.should respond_to(:answer_id)
+  answer.should respond_to(:accepted)
+  answer.should respond_to(:answer_comments_url)
+  answer.should respond_to(:question_id)
+  answer.should respond_to(:locked_date)
+  answer.should respond_to(:owner)
+  answer.should respond_to(:creation_date)
+  answer.should respond_to(:last_edit_date)
+  answer.should respond_to(:last_activity_date)
+  answer.should respond_to(:up_vote_count)
+  answer.should respond_to(:down_vote_count)
+  answer.should respond_to(:view_count)
+  answer.should respond_to(:score)
+  answer.should respond_to(:community_owned)
+  answer.should respond_to(:title)
+  answer.should respond_to(:body)
+  answer.should respond_to(:comments)
+end
+
+
+def check_badge(badge)
+  badge.should respond_to(:badge_id)
+  badge.should respond_to(:rank)
+  badge.should respond_to(:name)
+  badge.should respond_to(:description)
+  badge.should respond_to(:award_count)
+  badge.should respond_to(:tag_based)
+  badge.should respond_to(:user)
+  badge.should respond_to(:badges_recipients_url)
+end
+
+
+def check_user(user)
+  user.should respond_to(:user_id)
+  user.should respond_to(:user_type)
+  user.should respond_to(:creation_date)
+  user.should respond_to(:display_name)
+  user.should respond_to(:reputation)
+  user.should respond_to(:email_hash)
+  user.should respond_to(:age)
+  user.should respond_to(:last_access_date)
+  user.should respond_to(:website_url)
+  user.should respond_to(:location)
+  user.should respond_to(:about_me)
+  user.should respond_to(:question_count)
+  user.should respond_to(:answer_count)
+  user.should respond_to(:view_count)
+  user.should respond_to(:up_vote_count)
+  user.should respond_to(:down_vote_count)
+  user.should respond_to(:accept_rate)
+  user.should respond_to(:user_questions_url)
+  user.should respond_to(:user_answers_url)
+  user.should respond_to(:user_favorites_url)
+  user.should respond_to(:user_tags_url)
+  user.should respond_to(:user_badges_url)
+  user.should respond_to(:user_timeline_url)
+  user.should respond_to(:user_mentioned_url)
+  user.should respond_to(:user_comments_url)
+  user.should respond_to(:user_reputation_url)
+  user.should respond_to(:badge_counts)
+  user.should respond_to(:timed_penalty_date)
+  user.should respond_to(:association_id)
+  user.should respond_to(:on_site)
+end

data/test/test_answer.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestAnswer < Test::Unit::TestCase
+  describe Answer do
+    before(:all) do
+      #@user = Users.retrieve_by_id(53587, single_item_set).users.first
+      @answer = Answers.retrieve_by_id(952594, single_item_set).answers.first
+      set_api_key
+    end
+    
+    it "check answer" do
+      check_answer @answer
+    end
+    
+    it "get_comments" do
+      check_comment_set @answer.get_comments single_item_set
+    end
+    
+  end
+end

data/test/test_answers.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestAnswers < Test::Unit::TestCase
+  describe Answers do
+    before(:all) do
+      set_api_key
+    end
+    
+    it "retrieve_by_id" do
+      answers = Answers.retrieve_by_id 952594, single_item_set
+      check_answer_set answers
+    end
+    
+    it "retrieve_by_user" do
+      answers = Answers.retrieve_by_user 53587, single_item_set
+      check_answer_set answers
+    end
+    
+    it "retrieve_by_question" do
+      answers = Answers.retrieve_by_question 1104543, single_item_set
+      check_answer_set answers
+    end
+    
+    it "get_next_set" do
+      answers = Answers.retrieve_by_question 1104543, single_item_set
+      answers = answers.get_next_set
+      check_answer_set answers
+      answers.page.should == 2
+    end
+    
+  end
+end

data/test/test_badge.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class TestBadge < Test::Unit::TestCase
+  describe Badge do
+    before(:all) do
+      @badge = Badges.retrieve_all.badges.first
+      set_api_key
+    end
+    
+    it 'check badge' do
+      check_badge @badge
+    end
+    
+    it 'get_recipients' do
+      check_user_set @badge.get_recipients(single_item_set)
+    end
+  end
+end

data/test/test_badges.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestBadges < Test::Unit::TestCase
+  describe Badges do
+    before(:all) do
+      @users = Users.retrieve_all
+      set_api_key
+    end
+    
+    it 'retrieve_all' do
+      badges = Badges.retrieve_all
+      check_badge_set badges
+    end
+    
+    it 'retrieve_all_non_tag_based' do
+      badges = Badges.retrieve_all_non_tag_based
+      check_badge_set badges
+    end
+    
+    it 'retrieve_all_tag_based' do
+      badges = Badges.retrieve_all_tag_based
+      check_badge_set badges
+    end
+    
+    it 'retrieve_by_user' do
+      badges = Badges.retrieve_by_user @users.users.first.user_id
+      check_badge_set badges
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestBase < Test::Unit::TestCase
+  describe Base do
+    
+    it 'find_parse_querystring' do
+      base = Base.new
+      testVal = 'http://api.stackoverflow.com/1.0/users/?order=asc&page=2'
+      url,queryHash = base.find_parse_querystring testVal
+      url.should == 'users/'
+      queryHash.should == {'order'=>'asc','page'=>'2'}
+    end
+    
+    it 'convert_to_id_list int' do
+      Base.convert_to_id_list(1).should == '1'
+    end
+    
+    it 'convert_to_id_list string' do
+      Base.convert_to_id_list('1').should == '1'
+    end
+    
+    it 'convert_to_id_list item' do
+      item = Item.new 1
+      
+      Base.convert_to_id_list(item).should == '1'
+    end
+    
+    it 'convert_to_id_list int[]' do
+      Base.convert_to_id_list([1,2,3]).should == '1;2;3'
+    end
+    
+    it 'convert_to_id_list string[]' do
+      Base.convert_to_id_list(['1','2','3']).should == '1;2;3'
+    end
+    
+    it 'convert_to_id_list item[]' do
+      item1 = Item.new 1
+      item2 = Item.new 2
+      item3 = Item.new 3
+      
+      Base.convert_to_id_list([item1,item2,item3]).should == '1;2;3'
+    end
+    
+    it 'convert_to_id_list mixed[]' do
+      item3 = Item.new 3
+      Base.convert_to_id_list([1,'2',item3]).should == '1;2;3'
+    end
+    
+  end
+end
+
+class Item
+  attr_reader :val
+  
+  def initialize(id)
+    @val = id
+  end
+  
+  def item_id
+    @val
+  end
+  
+end