rubyoverflow 0.5 → 1.0.2

data/lib/rubyoverflow/pagedBase.rb

@@ -0,0 +1,27 @@
+module Rubyoverflow
+  class PagedBase < Base
+    attr_reader :total, :pagesize, :page, :request_path, :query_parameters
+  
+    def initialize(dash, request_path)
+      @total = dash.total
+      @page = dash.page
+      @pagesize = dash.pagesize
+      @request_path,@query_parameters = find_parse_querystring(request_path)
+    end
+    
+    def next_page_parameters()
+      temp = @query_parameters
+      if @page.respond_to?(:to_int)
+        temp['page'] = @page.to_i + 1
+      else
+        temp["page"] = 2
+      end
+      return temp
+    end
+    
+    def perform_next_page_request()
+      request(@request_path,next_page_parameters)
+    end
+    
+  end
+end

data/lib/rubyoverflow/pagedDash.rb

@@ -0,0 +1,7 @@
+module Rubyoverflow
+  class PagedDash < BaseDash
+    property :total
+    property :pagesize
+    property :page
+  end
+end

data/lib/rubyoverflow/postTimelineEvent.rb

@@ -0,0 +1,93 @@
+module Rubyoverflow
+  class PostTimelineEvent < Base
+    attr_reader :timeline_type
+    attr_reader :question_id
+    attr_reader :post_id
+    attr_reader :comment_id
+    attr_reader :revision_guid
+    attr_reader :creation_date
+    attr_reader :user
+    attr_reader :owner
+    attr_reader :action
+    attr_reader :post_revision_url
+    attr_reader :post_url
+    attr_reader :post_comment_url
+  
+    def initialize(hash, request_path = '')
+      dash = PostTimelineEventDash.new hash
+    
+      @timeline_type = dash.timeline_type
+      @post_id = dash.post_id
+      @comment_id = dash.comment_id
+      @question_id = dash.question_id
+      @revision_guid = dash.revision_guid
+      @creation_date = dash.creation_date
+      @user = User.new dash.user if dash.user
+      @owner = User.new dash.owner if dash.owner
+      @action = dash.action
+      @post_revision_url = dash.post_revision_url
+      @post_url = dash.post_url
+      @post_comment_url = dash.post_comment_url
+    end
+    
+    #Gets the post associated with this postTimelineEvent
+    def get_post(parameters={})
+      if @post_url
+        hash,url = request(@post_url, parameters)
+        if @post_url.include? 'question'
+          Questions.new hash, url 
+        elsif @post_url.include? 'answer'
+          Answers.new hash, url
+        end
+      else
+        nil
+      end
+    end
+    
+    #Gets the question that this postTimleineEvent belongs to
+    def get_parent_question(parameters={})
+      if @question_id
+        Questions.retrieve_by_id @question_id
+      else
+        nil
+      end
+    end
+    
+    
+    #Gets the revision associated with this postTimelineEvent
+    def get_post_revision(parameters={})
+      if @post_revision_url
+        hash,url = request(@post_revision_url, parameters) 
+        Revisions.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the comment associated with this postTimelineEvent
+    def get_post_comment(parameters={})
+      if @post_comment_url
+        hash,url = request(@post_comment_url, parameters) 
+        Comments.new hash, url
+      else
+        nil
+      end
+    end
+  
+  end
+
+  class PostTimelineEventDash < BaseDash
+    property :timeline_type
+    property :post_id
+    property :question_id
+    property :comment_id
+    property :revision_guid
+    property :creation_date
+    property :user
+    property :owner
+    property :action
+    property :post_revision_url
+    property :post_url
+    property :post_comment_url
+  end
+end

data/lib/rubyoverflow/postTimelineEvents.rb

@@ -0,0 +1,39 @@
+module Rubyoverflow
+  class PostTimelineEvents < PagedBase
+    attr_reader :post_timelines
+    
+    def initialize(hash, request_path = '')
+      dash = PostTimelineEventsDash.new hash
+      super(dash, request_path)
+    
+      @post_timelines = Array.new
+      dash.post_timelines.each {|postTimeHash| @post_timelines.push(PostTimelineEvent.new postTimeHash)}
+    end
+    
+    #Retrieves the next set of PostTimelineEvents using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      PostTimelineEvents.new hash,url
+    end
+  
+    class << self
+    
+      #Retrieve a set of PostTimelineEvent for a set of question(s) by their id(s)
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'questions/{id}/timeline'
+      def retrieve_by_question(id, parameters = {})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('questions/' + id.to_s + '/timeline', parameters)
+        PostTimelineEvents.new hash, url
+      end
+    end
+  
+  end
+
+  class PostTimelineEventsDash < PagedDash
+    property :post_timelines
+  end
+end

data/lib/rubyoverflow/question.rb

@@ -0,0 +1,110 @@
+module Rubyoverflow
+  class Question < Base
+    attr_reader :tags, :answer_count, :answers, :accepted_answer_id, :favorite_count, :bounty_closes_date,
+      :bounty_amount, :closed_date, :closed_reason, :question_timeline_url, :question_comments_url,
+      :question_answers_url, :question_id, :locked_date, :owner, :creation_date, :last_edit_date,
+      :last_activity_date, :up_vote_count, :down_vote_count, :view_count, :score, :community_owned,
+      :title, :body, :comments, :migrated, :protected_date
+  
+    def initialize(hash, request_path = '')
+      dash = QuestionDash.new hash
+    
+      @tags = Array.new
+      @comments = Array.new
+      @answers = Array.new
+    
+      dash.tags.each {|tag| @tags.push(tag)} if dash.tags
+      dash.comments.each {|commentHash| @comment.push(Comment.new commentHash)} if dash.comments
+      dash.answers.each {|answerHash| @comment.push(Answer.new answerHash)} if dash.answers
+    
+      @migrated = dash.migrated
+      @answer_count = dash.answer_count
+      @accepted_answer_id = dash.accepted_answer_id
+      @favorite_count = dash.favorite_count
+      @bounty_closes_date = dash.bounty_closes_date
+      @bounty_amount = dash.bounty_amount
+      @closed_date = dash.closed_date
+      @closed_reason = dash.closed_reason
+      @question_timeline_url = dash.question_timeline_url
+      @question_comments_url = dash.question_comments_url
+      @question_answers_url = dash.question_answers_url
+      @question_id = dash.question_id
+      @locked_date = dash.locked_date
+      @owner = User.new dash.owner if dash.owner
+      @creation_date = dash.creation_date
+      @last_edit_date = dash.last_edit_date
+      @last_activity_date = dash.last_activity_date
+      @up_vote_count = dash.up_vote_count
+      @down_vote_count = dash.down_vote_count
+      @view_count = dash.view_count
+      @score = dash.score
+      @community_owned = dash.community_owned
+      @title = dash.title
+      @body = dash.body
+      @protected_date = dash.protected_date
+    end
+    
+    #Gets the comments made on the question
+    def get_comments(parameters = {})
+      if @question_comments_url
+        hash,url =request(@question_comments_url, parameters)
+        Comments.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the answers posted to the question
+    def get_answers(parameters = {})
+      if @question_answers_url
+        hash,url =request(@question_answers_url, parameters)
+        Answers.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the timeline for the question
+    def get_timeline(parameters = {})
+      if @question_timeline_url
+        hash,url =request(@question_timeline_url, parameters)
+        PostTimelineEvents.new hash, url
+      else
+        nil
+      end
+    end
+  
+
+  end
+
+  class QuestionDash < BaseDash
+    property :tags
+    property :answer_count
+    property :answers
+    property :accepted_answer_id
+    property :favorite_count
+    property :bounty_closes_date
+    property :bounty_amount
+    property :closed_date
+    property :closed_reason
+    property :question_timeline_url
+    property :question_comments_url
+    property :question_answers_url
+    property :question_id
+    property :locked_date
+    property :owner
+    property :creation_date
+    property :last_edit_date
+    property :last_activity_date
+    property :up_vote_count
+    property :down_vote_count
+    property :view_count
+    property :score
+    property :community_owned
+    property :title
+    property :body
+    property :comments
+    property :migrated
+    property :protected_date
+  end
+end

data/lib/rubyoverflow/questions.rb

@@ -0,0 +1,104 @@
+module Rubyoverflow
+  class Questions < PagedBase
+    attr_reader :questions
+  
+    def initialize(hash, request_path = '')
+      dash = QuestionsDash.new hash
+    
+      @questions = Array.new
+      dash.questions.each {|questionHash| @questions.push(Question.new questionHash)}
+    
+      super(dash,request_path)
+    end
+    
+    #Retrieves the next set of questions using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      Questions.new hash,url
+    end
+  
+    class << self
+    
+      #Retrieves all questions using the parameters provided
+      #
+      #Maps to '/questions'
+      def retrieve_all(parameters = {})
+        hash, url = request('questions',parameters)
+        Questions.new hash, url
+      end
+    
+      #Retrieves a set of questions by their id(s)
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to '/questions/{id}'
+      def retrieve_by_id(id, parameters = {})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('questions/' + id.to_s, parameters)
+        Questions.new hash, url
+      end
+    
+      #Retrieves a set of questions by their tag(s)
+      #
+      #tag can be a string or an array of strings, tag(s) should be URL Encoded
+      #
+      #Maps to '/questions/tagged/{tags}
+      def retrieve_by_tag(tags, parameters = {})
+        tags = convert_to_id_list(tags)
+        parameters['tagged'] = tags
+        hash, url = request('questions/', parameters)
+        Questions.new hash, url
+      end
+    
+      #Retieves a set of unanswered questions using the parameters provided
+      #
+      #Maps to '/questions/unanswered'
+      def retrieve_unanswered(parameters = {})
+        hash, url = request('questions/unanswered', parameters)
+        Questions.new hash, url
+      end
+    
+      #Retrieves a set of favorite questions for user(s) by the users' id(s)
+      #
+      #user_id can be an int, string, or an array of ints or strings
+      #
+      #Maps to '/users/{id}/favorites
+      def retrieve_favorites(user_id, parameters = {})
+        user_id = convert_to_id_list(user_id)
+      
+        hash, url = request('users/'+user_id.to_s+'/favorites', parameters)
+        Questions.new hash, url
+      end
+    
+      #Retrieve question summary for user(s) by their id(s)
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to '/users/{id}/questions'
+      def retrieve_by_user(id, parameters = {})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('users/'+id.to_s+'/questions', parameters)
+        Questions.new hash, url
+      end
+    
+      #Searches questions. One of intitle, tagged, or nottagged must be set.
+      #
+      #Example: Questions.search({:tagged=>'c%23',:nottagged=>'sql;asp.net'})
+      #
+      #Maps to '/search'
+      def search(parameters = {})
+        hash, url = request('search', parameters)
+        Questions.new hash, url
+      end
+    
+    end
+  
+
+  end
+
+  class QuestionsDash < PagedDash
+    property :questions
+  end
+end

data/lib/rubyoverflow/repChange.rb

@@ -0,0 +1,34 @@
+module Rubyoverflow
+  class RepChange
+    attr_reader :user_id
+    attr_reader :post_id
+    attr_reader :post_type
+    attr_reader :title
+    attr_reader :positive_rep
+    attr_reader :negative_rep
+    attr_reader :on_date
+  
+    def initialize(hash, request_path = '')
+      dash = RepChangeDash.new hash
+    
+      @user_id = dash.user_id
+      @post_id = dash.post_id
+      @post_type = dash.post_type
+      @title = dash.title
+      @positive_rep = dash.positive_rep
+      @negative_rep = dash.negative_rep
+      @on_date = dash.on_date
+    end
+  
+  end
+
+  class RepChangeDash <BaseDash
+    property :user_id
+    property :post_id
+    property :post_type
+    property :title
+    property :positive_rep
+    property :negative_rep
+    property :on_date
+  end
+end

data/lib/rubyoverflow/repChanges.rb

@@ -0,0 +1,41 @@
+module Rubyoverflow
+  class RepChanges < PagedBase
+  
+    attr_reader :rep_changes
+  
+    def initialize(hash, request_path = '')
+      dash = RepChangesDash.new hash
+      super(dash, request_path)
+    
+      @rep_changes = Array.new
+      dash.rep_changes.each{|repHash| @rep_changes.push(RepChange.new repHash)}
+    end
+    
+    #Retrieves the next set of RepChanges using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      RepChanges.new hash,url
+    end
+    
+    class << self
+    
+      #Retrieves all the rep_changes 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}/reputation'
+      def retrieve_by_user(id, parameters={})
+        id = convert_to_id_list(id)
+        hash, url = request('/users/' + id.to_s + '/reputation', parameters)
+        RepChanges.new hash, url
+      end
+    
+    end
+  
+  end
+
+  class RepChangesDash < PagedDash
+    property :rep_changes
+  
+  end
+end