tjplurker 1.0

data/lib/tjplurker.rb

@@ -0,0 +1,248 @@
+# :title:TJPlurker API Documentation
+require 'logger'
+require 'json'
+require 'net/http'
+
+$tjpLog = Logger.new(STDOUT)
+$tjpLog.level = Logger::INFO
+$tjpLog.formatter = proc{ |severity, datetime, progname, msg|
+    "#{severity} [#{datetime}] in #{progname} -- #{msg}\n"
+}
+# It's a wrapper of Plurk API.
+# Note that every methods in this class returns a JSON object
+# which was converted from Plurk server's response.
+# All mehtods will retry again when request timeout occurs.
+class TJPlurker
+    # Plurk user ID.
+    attr_reader :user
+    
+    # If +auto_login+ sets +true+, it will autologin while constructing.
+    def initialize api_key, user, passwd, auto_login=true
+        @user, @passwd, @api_key = user, passwd, api_key
+        @cookie = nil
+        @user_channel = nil
+        @id_buffer = nil
+        login if auto_login
+    end
+    
+    # If no_data sets true, the successful login message was simplified as follow:
+    #
+    #  {"success_text": "ok"}
+    #
+    # Otherwise, more details of user's profile were retured.
+    def login no_data=true
+        method = "/API/Users/login"
+        attr = {:username=>@user, :password=>@passwd, :api_key=>@api_key}
+        attr[:no_data] = '1' if no_data
+        api(method, attr)
+    end
+    
+    def plurk_add content, qualifier=':', limited_to=nil, no_comments=nil, lang='tr_ch'
+        method = "/API/Timeline/plurkAdd"
+        attr = {:api_key=>@api_key, :content=>content, :qualifier=>qualifier,:limited_to=>limited_to, :no_comments=>no_comments, :lang=>lang}
+        api(method, attr)
+    end
+    
+    def response_add plurk_id, content, qualifier=':'
+        method = "/API/Responses/responseAdd"
+        attr = {:api_key=>@api_key, :plurk_id=>plurk_id, :content=>content, :qualifier=>qualifier}
+        api(method, attr)
+    end
+    
+    def become_fan fan_id
+        method = "/API/FriendsFans/becomeFan"
+        attr = {:api_key=>@api_key, :fan_id=>fan_id}
+        api(method, attr)
+    end
+    
+    def add_all_as_friends
+        method = "/API/Alerts/addAllAsFriends"
+        attr = {:api_key=>@api_key}
+        api(method, attr)
+    end
+    
+    def get_friends_by_offset user_id, limit=100, offset='0'
+        method = "/API/FriendsFans/getFriendsByOffset"
+        attr = {:api_key=>@api_key, :user_id=>user_id, :offset=>offset, :limit=>limit}
+        api(method, attr)
+    end
+    
+    def get_public_profile user_id
+        method = "/API/Profile/getPublicProfile"
+        attr = {:api_key=>@api_key, :user_id=>user_id}
+        api(method, attr)
+    end
+    
+    # Warning:: It has bugs in offecial Plurk API.
+    def get_plurks limit=nil, offset=nil
+        method = "/API/Polling/getPlurks"
+        attr = {:api_key=>@api_key, :limit=>limit, :offset=>offset}
+        api(method, attr)
+    end
+
+    def get_user_channel
+        method = "/API/Realtime/getUserChannel"
+        attr = {:api_key=>@api_key}
+        api(method, attr)
+    end
+
+    def comet_channel
+        #Assign new channel if @user_channel is nil
+        @user_channel ||= get_user_channel
+        begin
+            res = Net::HTTP.get_response(URI.parse(@user_channel['comet_server']))
+            json = JSON.parse(res.body.sub!(/CometChannel\.scriptCallback\((.*)\);/){|match| $1})
+        rescue Timeout::Error => ex
+            $tjpLog.warn(self.class){"Request timeout, retry."}
+            retry
+        rescue => ex
+            $tjpLog.fatal(self.class){"Unknown error, stop."}
+            puts ex.backtrace
+            exit
+        end
+        #Update the offset
+        @user_channel['comet_server'].sub!(/[\d]+$/, json["new_offset"].to_s)
+        if json['data']
+            json['data'].each{|member|
+                notification = NotificationData.new(member)
+                return if notification.id == @id_buffer
+                $tjpLog.info(self.class){"Notification: #{notification.user_id}: \"#{notification.content}\""}
+                @id_buffer = notification.id
+                yield(notification)
+            }
+        end
+        json
+    end
+    
+    private
+    def api method, attr
+        #Build POST Request
+        req = Net::HTTP::Post.new(method)
+        req.set_form_data(attr)
+        req["Cookie"] = @cookie
+        #Build GET Request
+        #path = method + "?" + URI.encode_www_form(attr)
+        #req2 = Net::HTTP::Get.new(path)
+        #req2["Cookie"] = @cookie
+        
+        #Build HTTP connection
+        http = Net::HTTP.new('www.plurk.com', 80)
+        begin
+            resp = http.start{
+                $tjpLog.info(self.class){"Request: #{method}, #{attr}"}
+                http.request(req)
+            }
+            @cookie ||= resp['set-cookie']
+            json = JSON.parse(resp.body)
+            $tjpLog.debug(self.class){"Response: #{json}"}
+            $tjpLog.error(self.class){json["error_text"]} if json["error_text"]
+        rescue Timeout::Error => ex
+            $tjpLog.warn(self.class){"Request timeout, retrying."}
+            retry
+        rescue JSON::ParserError => ex
+            $tjpLog.error(self.class){"JSON parse error, request failed."}
+        rescue => ex
+            $tjpLog.fatal(self.class){"Unknown error, stop"}
+            puts ex.class, ex.message, ex.backtrace
+            exit
+        end
+        return json
+    end
+    
+    class NotificationData
+        
+        # Can be +new_plurk+ or +new_response+.
+        attr_reader :type
+        attr_reader :response_count
+        attr_reader :plurk_id
+        attr_reader :lang
+        attr_reader :user_id
+        attr_reader :qualifier
+        attr_reader :content
+        # Notification ID.
+        attr_reader :id
+        # Time of the listened post.
+        attr_reader :posted
+        attr_reader :owner_id
+        # The original JSON object from server response.
+        attr_reader :origin
+        
+        def initialize member
+            @type = member['type']
+            @response_count = member['response_count']
+            @plurk_id = member['plurk_id']
+            
+            @lang = @type=="new_plurk" ? member['lang'] : member['response']['lang']
+            @user_id = @type=="new_plurk" ? member['user_id'] : member['response']['user_id']
+            @qualifier = @type=="new_plurk" ? member['qualifier'] : member['response']['qualifier']
+            @content = @type=="new_plurk" ? member['content'] : member['response']['content']
+            @id = @type=="new_plurk" ? member['id'] : member['response']['id']
+            @posted = @type=="new_plurk" ? member['posted'] : member['response']['posted']
+            
+            @owner_id = @type=="new_plurk" ? member['owner_id'] : member['plurk']['owner_id']
+            
+            @origin = member
+        end
+    end
+    
+    class Robot
+        def initialize *params
+            case params.size
+                when 1
+                    @tjplurker = params[0]
+                when 3
+                    api_key, user, passwd = params
+                    @tjplurker = TJPlurker.new(api_key, user, passwd)
+                when 4
+                    api_key, user, passwd, auto_login = params
+                    @tjplurker = TJPlurker.new(api_key, user, passwd, auto_login)
+            end
+            @services = []
+        end
+        
+        def start
+            $tjpLog.info(self.class){"Start robot."}
+            Thread.new{
+                loop{
+                    @tjplurker.add_all_as_friends
+                    sleep(60)
+                }
+            }
+            loop{
+                @tjplurker.comet_channel{|data|
+                    @services.each{|service|
+                        service.serve(@tjplurker, data)
+                    }
+                }
+            }
+        end
+        
+        def add_service service
+            @services << service
+        end
+    end
+    
+    class Service
+        def initialize &proc
+            if block_given?
+                @serve = proc
+            else
+                @serve = Proc.new{|tjplurker, data| p data}
+            end
+        end
+        
+        def serve tjplurker, data
+            @serve[tjplurker, data]
+        end
+    end
+end
+
+if __FILE__ == $0
+    pk = Plurker.new("you api key", "your id", "your password")
+    puts pk.login
+    loop{
+        pk.comet_channel{|date|
+            puts data
+        }
+    }
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: tjplurker
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Tony Jian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-23 00:00:00.000000000 +08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &18468612 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *18468612
+description: description...
+email: tonytonyjan.cs97@g2.nctu.edu.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tjplurker.rb
+has_rdoc: true
+homepage: http://code.google.com/p/tjplurker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A safe Plurk API wrapper based on Ruby and mainly designed for easily making
+  plurk robot.
+test_files: []