rubyoverflow 0.5 → 1.0.2

data/lib/rubyoverflow/apiSite.rb

@@ -0,0 +1,32 @@
+module Rubyoverflow
+  class ApiSite
+    attr_reader :name, :logo_url, :api_endpoint, :site_url, :description, :icon_url, :state, :styling, :aliases
+  
+    def initialize(hash,url='')
+      dash = ApiSiteDash.new hash
+    
+      @name = dash.name
+      @logo_url = dash.logo_url
+      @api_endpoint = dash.api_endpoint
+      @site_url = dash.site_url
+      @description = dash.description
+      @icon_url = dash.icon_url
+      @state = dash.state
+      @styling = Styling.new dash.styling if dash.styling
+      @aliases = dash.aliases
+    end
+  
+  end
+
+  class ApiSiteDash < BaseDash
+    property :aliases
+    property :name
+    property :logo_url
+    property :api_endpoint
+    property :site_url
+    property :description
+    property :icon_url 
+    property :state
+    property :styling
+  end
+end

data/lib/rubyoverflow/apiSites.rb

@@ -0,0 +1,25 @@
+module Rubyoverflow
+  class ApiSites < Base
+    attr_reader :api_sites
+    def initialize(hash, url = '')
+      mash = ApiSitesDash.new hash
+      @api_sites = Array.new
+    
+      mash.api_sites.each{|siteHash| @api_sites.push(ApiSite.new siteHash)}
+    end
+  
+    class << self
+      def retrieve_sites()
+        client = Client.stackauth_client(Base.client.api_key)
+      
+        hash,url = client.request('sites',{})
+      
+        ApiSites.new hash,url
+      end
+    end
+  end
+
+  class ApiSitesDash < BaseDash
+    property :api_sites
+  end
+end

data/lib/rubyoverflow/apiVersion.rb

@@ -0,0 +1,6 @@
+module Rubyoverflow
+  class ApiVersion < BaseDash
+    property :version
+    property :revision
+  end
+end

data/lib/rubyoverflow/badge.rb

@@ -0,0 +1,44 @@
+module Rubyoverflow
+  class Badge < Base
+    attr_reader :badge_id, :rank, :name, :description, :award_count, :tag_based, :user, :badges_recipients_url
+  
+    def initialize(hash, request_path = '')
+      dash = BadgeDash.new hash
+    
+      @badge_id = dash.badge_id
+      @rank = dash.rank
+      @name = dash.name
+      @description = dash.description
+      @award_count = dash.award_count
+      @tag_based = dash.tag_based
+      @user = User.new dash.user if dash.user
+      @badges_recipients_url = dash.badges_recipients_url
+    end
+    
+    def item_id
+      @badge_id
+    end
+    
+    #Retrieves all the users that have received the badge
+    def get_recipients(parameters = {})
+      if @badges_recipients_url
+        hash,url =request(@badges_recipients_url, parameters)
+        Users.new hash, url
+      else
+        nil
+      end
+    end
+    
+  end
+
+  class BadgeDash < BaseDash
+    property :badge_id
+    property :rank
+    property :name
+    property :description
+    property :award_count
+    property :tag_based
+    property :user
+    property :badges_recipients_url
+  end
+end

data/lib/rubyoverflow/badgeCounts.rb

@@ -0,0 +1,22 @@
+module Rubyoverflow
+  class BadgeCounts
+  
+    attr_reader :gold
+    attr_reader :silver
+    attr_reader :bronze
+  
+    def initialize(hash, request_path = '')
+      dash = BadgeCountsDash.new hash
+      @gold = dash.gold
+      @silver = dash.silver
+      @bronze = dash.bronze
+    end
+  
+  end
+
+  class BadgeCountsDash < BaseDash
+    property :gold
+    property :silver
+    property :bronze
+  end
+end

data/lib/rubyoverflow/badges.rb

@@ -0,0 +1,59 @@
+module Rubyoverflow
+  class Badges < PagedBase
+  
+    attr_reader :badges
+  
+    def initialize(hash, request_path = '')
+      dash = BadgesDash.new hash
+    
+      @badges = Array.new
+      dash.badges.each{ |badgeHash| @badges.push(Badge.new badgeHash)}
+    
+      super(dash, request_path)
+    end
+    
+    class <<self
+      #Retrieves all badges in alphabetical order
+      #
+      #Maps to '/badges'
+      def retrieve_all
+        hash, url = request('badges')
+        Badges.new hash, url
+      end
+    
+      #Retrieves all standard, non-tag-based badges in alphabetical order
+      #
+      #Maps to '/badges/name'
+      def retrieve_all_non_tag_based
+        hash, url = request('badges/name')
+        Badges.new hash, url
+      end
+    
+      #Retrieves all tag-based badges in alphabetical order
+      #
+      #Maps to '/badges/tags'
+      def retrieve_all_tag_based
+        hash, url = request('badges/tags')
+        Badges.new hash, url
+      end
+    
+      #Retrieves all badges that have been awarded to a set of users by their id(s)
+      #
+      #id can be an int, string or an array of ints or strings
+      #
+      #Maps to '/users/{id}/badges'
+      def retrieve_by_user(id)
+        id = convert_to_id_list(id)
+      
+        hash, url = request('users/'+id.to_s+'/badges')
+        Badges.new hash, url
+      end
+    
+    end
+  
+  end
+
+  class BadgesDash < PagedDash
+    property :badges
+  end
+end

data/lib/rubyoverflow/base.rb

@@ -0,0 +1,76 @@
+module Rubyoverflow
+  class Base
+
+    def request(path, parameters = {})
+      Base.request(path, parameters)
+    end
+  
+    def find_parse_querystring(rawurl)
+      queryHash = {}
+      if rawurl.include? '?'
+      url, querystring = rawurl.split('?')
+      
+      if querystring
+        querystring.split('&').each {|pair|
+          key,value=pair.split('=')
+          queryHash[key]=value 
+        }
+        queryHash
+      end
+      url.sub!(Base.client.host_path,'')
+      return url,queryHash
+      
+      else
+      url = rawurl
+      end
+      url.sub!(Base.client.host_path,'')
+      return url,queryHash
+    end
+    
+    class << self
+      def client 
+        @client ||= Rubyoverflow::Client.config
+      end
+    
+      def request(path, parameters = {})
+        client.request(path, parameters)
+      end
+      
+      def convert_to_id_list(id)
+        id = convert_if_array(id)
+        id = id.item_id if id.respond_to?(:item_id)
+        id.to_s
+      end
+      
+      def convert_if_array(id)
+        new_id_list = Array.new
+        if id.kind_of?(Array)
+          id.each do |item|
+            if item.respond_to? :item_id
+              new_id_list.push item.item_id
+            elsif item.kind_of?(String) || item.kind_of?(Integer)
+              new_id_list.push item
+            end
+          end
+          return new_id_list.join(';')
+        else
+          return id
+        end
+      end
+      
+      def change_end_point(endpoint)
+        Client.change_end_point endpoint
+      end
+    end
+    
+  end
+
+  class BaseDash < Hashie::Dash
+    def initialize(hash={})
+      hash2 = Hash.new
+      hash.each { |key, value| hash2[key.strip] = value  }
+      hash = hash2
+      super(hash)
+    end
+  end
+end

data/lib/rubyoverflow/comment.rb

@@ -0,0 +1,41 @@
+module Rubyoverflow
+  class Comment
+  
+    attr_reader :comment_id
+    attr_reader :creation_date
+    attr_reader :owner
+    attr_reader :reply_to_user
+    attr_reader :post_id
+    attr_reader :post_type
+    attr_reader :score
+    attr_reader :edit_count
+    attr_reader :body
+  
+    def initialize(hash, request_path = '')
+      dash = CommentDash.new hash
+    
+      @comment_id = dash.comment_id
+      @creation_date = dash.creation_date
+      @owner = User.new dash.owner
+      @reply_to_user = User.new dash.reply_to_user if dash.reply_to_user
+      @post_id = dash.post_id
+      @post_type = dash.post_type
+      @score = dash.score
+      @edit_count = dash.edit_count
+      @body = dash.body
+    end
+  
+  end
+
+  class CommentDash < BaseDash
+    property :comment_id
+    property :creation_date
+    property :owner
+    property :reply_to_user
+    property :post_id
+    property :post_type
+    property :score
+    property :edit_count
+    property :body
+  end
+end

data/lib/rubyoverflow/comments.rb

@@ -0,0 +1,115 @@
+module Rubyoverflow
+  class Comments < PagedBase
+  
+    attr_reader :comments
+  
+    def initialize(hash, request_path = '')
+      dash = CommentsDash.new hash
+    
+      @comments = Array.new
+      dash.comments.each{ |commentHash| @comments.push(Comment.new commentHash)}
+    
+      super(dash, request_path)
+    end
+    
+    #Retrieves the next set of comments using the same parameters used to retrieve the current set
+    def get_next_set
+      hash,url = perform_next_page_request
+      Comments.new hash,url
+    end
+  
+    class << self
+    
+      #Retieves a set of comments by a set by their ids
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'comments/{id}
+      def retrieve_by_id(id, parameters = {})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('comments/'+id.to_s, parameters)
+        Comments.new hash, url
+      end
+    
+      #Retrieves a set of comments made by a set of users by their ids
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'users/{id}/comments'
+      def retrieve_by_user(id, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('users/'+id.to_s+"/comments", parameters)
+        Comments.new hash, url
+      end
+    
+      #Retrieves a set of comments made on an answer by the answer's id
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'answers/{id}/comments'
+      def retrieve_by_answer(id, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('answers/'+id.to_s+"/comments", parameters)
+        Comments.new hash, url
+      end
+    
+      #Retrieves a set of comments made on a post by the post's id
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'posts/{id}/comments'
+      def retrieve_by_post(id, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('posts/'+id.to_s+"/comments", parameters)
+        Comments.new hash, url
+      end
+    
+      #Retrieves a set comments made on a question by the post's id
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'question/{id}/comments'
+      def retrieve_by_question(id, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('questions/'+id.to_s+"/comments", parameters)
+        Comments.new hash, url
+      end
+    
+      #Retrieves a set of comments made by a set of users to a user
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #toid must be an int or string
+      #
+      #Maps to 'users/{id}/comments/{toid}'
+      def retrieve_from_user_to_user(id, toid, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('users/'+id.to_s+"/comments/" + toid.to_s, parameters)
+        Comments.new hash, url
+      end
+    
+      #Retieves a set commments directed at a set of users by their ids
+      #
+      #id can be an int, string, or an array of ints or strings
+      #
+      #Maps to 'users/{id}/mentioned'
+      def retrieve_to_user(id, parameters={})
+        id = convert_to_id_list(id)
+      
+        hash, url = request('users/'+id.to_s+"/mentioned", parameters)
+        Comments.new hash, url
+      end
+    end
+  
+  end
+
+  class CommentsDash < PagedDash
+    property :comments
+  end
+end

data/lib/rubyoverflow/errors.rb

@@ -0,0 +1,17 @@
+module Rubyoverflow
+  class Errors < Base
+  
+    class << self
+    
+      #Retrieves errors
+      #
+      #Maps to 'errors/{id}'
+      def retrieve(id)
+        request('errors/'+id.to_s)
+      end
+    
+    end
+  
+  
+  end
+end