rubyoverflow 0.5 → 1.0.2

data/lib/rubyoverflow/revision.rb

@@ -0,0 +1,62 @@
+module Rubyoverflow
+  class Revision
+    attr_reader :body
+    attr_reader :comment
+    attr_reader :creation_date
+    attr_reader :is_question
+    attr_reader :is_rollback
+    attr_reader :last_body
+    attr_reader :last_title
+    attr_reader :last_tags
+    attr_reader :revision_guid
+    attr_reader :revision_number
+    attr_reader :tags
+    attr_reader :title
+    attr_reader :revision_type
+    attr_reader :set_community_wiki
+    attr_reader :user
+    attr_reader :post_id
+  
+    def initialize(hash, request_path = '')
+      dash = RevisionDash.new hash
+    
+      @body = dash.body
+      @comment = dash.comment
+      @creation_date = dash.creation_date
+      @is_question = dash.is_question
+      @is_rollback = dash.is_rollback
+      @last_body = dash.last_body
+      @last_title = dash.last_title
+      @last_tags = dash.last_tags
+      @revision_guid = dash.revision_guid
+      @revision_number = dash.revision_number
+      @tags = dash.tags
+      @title = dash.title
+      @revision_type = dash.revision_type
+      @set_community_wiki = dash.set_community_wiki
+      @user = User.new dash.user if dash.user
+      @post_id = dash.post_id
+    end
+  
+  
+  end
+
+  class RevisionDash < BaseDash
+    property :body
+    property :comment
+    property :creation_date
+    property :is_question
+    property :is_rollback
+    property :last_body
+    property :last_title
+    property :last_tags
+    property :revision_guid
+    property :revision_number
+    property :tags
+    property :title
+    property :revision_type
+    property :set_community_wiki
+    property :user
+    property :post_id 
+  end
+end

data/lib/rubyoverflow/revisions.rb

@@ -0,0 +1,52 @@
+module Rubyoverflow
+  class Revisions < PagedBase
+    attr_reader :revisions
+  
+    def initialize(hash, request_path = '')
+      dash = RevisionsDash.new hash
+      super(dash, request_path)
+    
+      @revisions = Array.new
+      dash.revisions.each{|revisionHash| @revisions.push(Revision.new revisionHash)}
+    end
+    
+    #Retrieves the next set of revisions using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      Revisions.new hash,url
+    end
+  
+    class << self
+    
+      #Retrieves the post history of a set of post(s) by their id(s)
+      #
+      #id can be an int, string or an array of ints or strings
+      #
+      #Maps to 'revisions/{id}'
+      def retrieve_by_post(id, parameters = {})
+        id = convert_to_id_list(id)
+        hash, url = request('/revisions/'+id.to_s, parameters)
+        Revisions.new hash, url
+      end
+    
+      #Retrieves a specific post revision by post id and revision guid
+      #
+      #id can be an int, string or an array of ints or strings
+      #
+      #revisionguid must be a string in 8-4-4-4-12 format
+      #
+      #Maps to 'revisions/{id}'
+      def retrieve_post_revision(id, revisionguid, parameters = {})
+        id = convert_to_id_list(id)
+        hash, url = request('/revisions/'+id.to_s + '/' + revisionguid, parameters)
+        Revisions.new hash, url
+      end
+    
+    end
+  
+  end
+
+  class RevisionsDash < PagedDash
+    property :revisions
+  end
+end

data/lib/rubyoverflow/statistics.rb

@@ -0,0 +1,57 @@
+module Rubyoverflow
+  class Statistics < Base
+  
+    attr_reader :total_questions, :total_badges, :total_unanswered, :total_votes, :total_comments, :total_answers, :site,
+      :total_users, :questions_per_minute, :answers_per_minute, :badges_per_minute, :views_per_day, :api_version, :total_accepted
+
+    def initialize(hash, request_path = '')
+      dash = StatisticsDash.new hash
+    
+      @total_questions = dash.total_questions
+      @total_accepted = dash.total_accepted
+      @total_badges = dash.total_badges
+      @total_unanswered = dash.total_unanswered
+      @total_votes = dash.total_votes
+      @total_comments = dash.total_comments
+      @total_answers = dash.total_answers
+      @total_users = dash.total_users
+      @questions_per_minute = dash.questions_per_minute
+      @answers_per_minute = dash.answers_per_minute
+      @badges_per_minute = dash.badges_per_minute
+      @views_per_day = dash.views_per_day
+      @site = ApiSite.new dash.site
+      @api_version = ApiVersion.new dash.api_version
+    end
+
+  
+    class << self
+    
+      #Retrieves the stats for the domain
+      #
+      #Maps to 'stats'
+      def retrieve
+        hash, url = request('stats')
+        Statistics.new hash['statistics'].first, url
+      end
+    end
+
+  
+  end
+
+  class StatisticsDash < BaseDash
+    property :total_questions
+    property :total_badges
+    property :total_unanswered
+    property :total_votes
+    property :total_comments
+    property :total_answers
+    property :total_users
+    property :total_accepted
+    property :questions_per_minute
+    property :answers_per_minute
+    property :badges_per_minute
+    property :views_per_day
+    property :api_version
+    property :site
+  end
+end

data/lib/rubyoverflow/styling.rb

@@ -0,0 +1,19 @@
+module Rubyoverflow
+  class Styling
+    attr_reader :link_color, :tag_foreground_color ,:tag_background_color
+    
+    def initialize(hash)
+      dash = StylingDash.new hash
+      @link_color = dash.link_color
+      @tag_background_color = dash.tag_background_color
+      @tag_foreground_color = dash.tag_foreground_color
+    end
+    
+  end
+  
+  class StylingDash < BaseDash
+    property :link_color
+    property :tag_foreground_color
+    property :tag_background_color
+  end
+end

data/lib/rubyoverflow/tag.rb

@@ -0,0 +1,27 @@
+module Rubyoverflow
+  class Tag
+    attr_reader :name
+    attr_reader :count
+    attr_reader :restricted_to
+    attr_reader :fulfills_required
+    attr_reader :user_id
+  
+    def initialize(hash, request_path = '')
+      dash = TagDash.new hash
+      @name = dash.name
+      @count = dash.count
+      @restricted_to = dash.restricted_to
+      @fulfills_required = dash.fulfills_required
+      @user_id = dash.user_id
+    end
+  
+  end
+
+  class TagDash < BaseDash
+    property :name
+    property :count
+    property :restricted_to
+    property :fulfills_required
+    property :user_id
+  end
+end

data/lib/rubyoverflow/tags.rb

@@ -0,0 +1,46 @@
+module Rubyoverflow
+  class Tags < PagedBase
+  
+    attr_reader :tags
+  
+    def initialize(hash, request_path = '')
+      dash = TagsDash.new hash
+      @tags = Array.new
+      dash.tags.each{ |tagHash| @tags.push(Tag.new tagHash)}
+    
+      super(dash, request_path)
+    end
+    
+    #Retrieves the next set of tags using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      Tags.new hash,url
+    end
+  
+    class << self
+      #Retrieves all of the tags
+      #
+      #Maps to '/tags/
+      def retrieve_all(parameters = {})
+        hash, url = request('tags', parameters)
+        Tags.new hash, url
+      end
+    
+      #Retieves all of the tags assign to a set of users by their ids
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'users/{id}/tags'
+      def retrieve_by_user(id, parameters = {})
+        id = convert_to_id_list(id)
+        hash, url = request('users/'+id.to_s+'/tags',parameters)
+        Tags.new hash, url
+      end
+    end
+  end
+
+  class TagsDash < PagedDash
+    property :tags
+  
+  end
+end

data/lib/rubyoverflow/user.rb

@@ -0,0 +1,181 @@
+module Rubyoverflow
+  class User < Base
+  
+    attr_reader :user_id, :user_type, :creation_date, :display_name, :reputation, :email_hash, :age,
+      :last_access_date, :website_url, :location, :about_me, :question_count, :answer_count, :view_count,
+      :up_vote_count, :down_vote_count, :accept_rate, :user_questions_url, :user_answers_url, :user_favorites_url,
+      :user_tags_url, :user_badges_url, :user_timeline_url, :user_mentioned_url, :user_comments_url,
+      :user_reputation_url, :badge_counts, :timed_penalty_date, :association_id, :on_site
+  
+    def initialize(hash, request_path = '')
+      dash = UserDash.new hash
+    
+      @user_id = dash.user_id
+      @user_type = dash.user_type
+      @creation_date = dash.creation_date
+      @display_name = dash.display_name
+      @reputation = dash.reputation
+      @email_hash = dash.email_hash
+      @age = dash.age
+      @last_access_date = dash.last_access_date
+      @website_url = dash.website_url
+      @location = dash.location
+      @about_me = dash.about_me
+      @question_count = dash.question_count
+      @answer_count = dash.answer_count
+      @view_count = dash.view_count
+      @up_vote_count = dash.up_vote_count
+      @down_vote_count = dash.down_vote_count
+      @accept_rate = dash.accept_rate
+      @user_questions_url = dash.user_questions_url
+      @user_answers_url = dash.user_answers_url
+      @user_favorites_url = dash.user_favorites_url
+      @user_tags_url = dash.user_tags_url
+      @user_badges_url = dash.user_badges_url
+      @user_timeline_url = dash.user_timeline_url
+      @user_mentioned_url = dash.user_mentioned_url
+      @user_comments_url = dash.user_comments_url
+      @user_reputation_url = dash.user_reputation_url
+      @badge_counts = BadgeCounts.new dash.badge_counts if dash.badge_counts
+      @timed_penalty_date = dash.timed_penalty_date
+      @association_id = dash.association_id
+      @on_site = ApiSite.new dash.on_site if dash.on_site
+    end
+    
+    def item_id
+      @user_id
+    end
+  
+    #Gets the questions by the user
+    def get_questions(parameters = {})
+      if @user_questions_url
+        hash,url =request(@user_questions_url, parameters)
+        Questions.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the answers from the user
+    def get_answers(parameters = {})
+      if @user_answers_url
+        hash,url =request(@user_answers_url, parameters)
+        Answers.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the questions favorited by the user
+    def get_favorites(parameters = {})
+      if @user_favorites_url
+        hash,url =request(@user_favorites_url, parameters)
+        Questions.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the tags the user has participated in
+    def get_tags(parameters = {})
+      if @user_tags_url
+        hash,url =request(@user_tags_url, parameters)
+        Tags.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the badges awared to the user
+    def get_badges
+      if @user_badges_url
+        hash,url =request(@user_badges_url,{})
+        Badges.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the user's timeline
+    def get_timeline(parameters = {})
+      if @user_timeline_url
+        hash,url =request(@user_timeline_url, parameters)
+        UserTimelineEvents.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the comments that mention the user
+    def get_mentioned(parameters = {})
+      if @user_mentioned_url
+        hash,url =request(@user_mentioned_url, parameters)
+        Comments.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the comments by the user
+    def get_comments(parameters = {})
+      if @user_comments_url
+        hash,url =request(@user_comments_url, parameters)
+        Comments.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the user's reputation
+    def get_reputation(parameters = {})
+      if @user_reputation_url
+        hash,url =request(@user_reputation_url, parameters)
+        RepChanges.new hash, url
+      else
+        nil
+      end
+    end
+    
+    #Gets the user's other accounts
+    def retrieve_associated_accounts
+      if @association_id
+        Users.retrieve_associated_accounts @association_id
+      else
+        nil
+      end
+    end
+  end
+
+  class UserDash < BaseDash
+    property :user_id
+    property :user_type
+    property :creation_date
+    property :display_name
+    property :reputation
+    property :email_hash
+    property :age
+    property :last_access_date
+    property :website_url
+    property :location
+    property :about_me
+    property :question_count
+    property :answer_count
+    property :view_count
+    property :up_vote_count
+    property :down_vote_count
+    property :accept_rate
+    property :user_questions_url
+    property :user_answers_url
+    property :user_favorites_url
+    property :user_tags_url
+    property :user_badges_url
+    property :user_timeline_url
+    property :user_mentioned_url
+    property :user_comments_url
+    property :user_reputation_url
+    property :badge_counts
+    property :timed_penalty_date
+    property :association_id
+    property :on_site
+  end
+end