cpsn 0.4.3 → 0.5.0

data/README.mkd

@@ -0,0 +1,42 @@
+cpsn
+====
+
+cpsn lets you query your friend status on the Playstation Network (tm) via the
+command line interface. You can see friend status (online or offline), which
+game they are playing, and, if available, the game mode and map they are
+playing.
+
+Setup
+=====
+
+Before you can use cpsn, you must first create a settings file for your PSN
+username and password.  Create a ~/.cpsn directory, and inside it, put a settings.yml file like:
+
+    ---
+    :username: my_psn_username
+    :password: my_psn_password
+
+That's it!
+
+Usage
+=====
+
+'cpsn' by itself on the commandline will show you all friends on your friends
+list that are online. You can optionally list one or more friend names to see
+only their status, or provide a group name (see 'Defining Groups' below). You
+can also pass '-o' to see your offline friends as well.
+
+Defining Groups
+===============
+
+If you find yourself looking for the status of a few friends frequently, you can define groups of users in your settings.yml file. Groups go under the ':groups:' section in the settings.yml file, and are the name you want to call them and a list of user names.
+
+For example:
+    
+    ---
+    :username: my_psn_username
+    :password: my_psn_password
+
+    :groups:
+     - mw2: [friend1, friend2, friend3]
+    

data/Rakefile

@@ -6,7 +6,11 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "cpsn"
     gem.summary = %Q{Query PSN friend status from the CLI}
-    gem.description = %Q{Query PSN friend status from the CLI}
+    gem.description = %Q{
+        Query PSN friend status from the CLI. Shows useful information like the
+        game being played, and what mode or map your friend is playing
+        (if available).
+    }
     gem.email = "jbowes@repl.ca"
     gem.homepage = "http://github.com/jbowes/cpsn"
     gem.authors = ["James Bowes"]

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/bin/cpsn

@@ -1,4 +1,9 @@
 #!/usr/bin/ruby
+#
+# cpsn - Query Friend status on the Playstation Network (tm)
+#
+# Author:: James Bowes <jbowes@repl.ca>
+# Copyright:: Copyright (C) 2009 James Bowes
 
 require 'rubygems'
 require 'mechanize'
@@ -8,119 +13,135 @@ require 'optparse'
 require 'logger'
 require 'set'
 
-$login_url = "https://store.playstation.com/external/index.vm?returnURL=https%3a%2f%2fsecureus.playstation.com%2fRegistration%2fPSNL%2fSignInFrame.aspx"
+@login_url = "https://store.playstation.com/external/index.vm?returnURL=https%3a%2f%2fsecureus.playstation.com%2fRegistration%2fPSNL%2fSignInFrame.aspx"
 $friend_url = "http://profiles.us.playstation.com/playstation/psn/profile/friends"
 $json_url = "http://profiles.us.playstation.com/playstation/psn/profile/get_gamer_summary_data?id="
 
 
-$log = Logger.new(STDERR)
-$log.level = Logger::WARN
+class Cpsn
 
-def load_settings()
-    $log.debug("Loading settings")
-    settings = YAML::parse_file(File.expand_path("~/.cpsn/settings.yml"))
-    return settings
-end
+    attr_accessor :settings, :groups
+  
+    def initialize(options)
+        @log = Logger.new(STDERR)
+        @log.level = Logger::WARN
+        if options[:debug]
+            @log.level = Logger::DEBUG
+        end
 
-def load_groups(settings)
-    $log.debug("Loading groups")
-    groups = {}
+        @settings = load_settings()
+        @groups = load_groups(@settings)
 
-    if not settings[:groups]
-        return groups
+        get_agent(@settings[:username].value, @settings[:password].value,
+                  options[:cookie])
     end
 
-    for group in settings[:groups].value
-        name = group.value.keys[0].value
-        vals = group.value[group.value.keys[0]]
-        members = []
-        mem_str = ""
-        for user in vals.value do
-            members << user.value
-            mem_str += user.value 
-            mem_str += " "
-        end
-        $log.debug("Found group #{name} [ #{mem_str}]")
-        groups[name] = members
+    def load_settings()
+        @log.debug("Loading settings")
+        settings = YAML::parse_file(File.expand_path("~/.cpsn/settings.yml"))
+        return settings
     end
-    return groups
-end
+   
+    def load_groups(settings)
+        @log.debug("Loading groups")
+        groups = {}
 
-def get_cookie(agent, username, password)
-    $log.debug("Signing in for new cookie")
-    page = agent.get($login_url)
-    login_form = page.forms.first
-    login_form.loginName = username
-    login_form.password = password
-    page = agent.submit(login_form)
-    link = page.links.first
-
-    if link.text == "Sign In"
-        puts "Error logging in. Did you give the right username and password?"
-        exit
+        if not settings[:groups]
+            return groups
+        end
+
+        for group in settings[:groups].value
+            name = group.value.keys[0].value
+            vals = group.value[group.value.keys[0]]
+            members = []
+            mem_str = ""
+            for user in vals.value do
+                members << user.value
+                mem_str += user.value 
+                mem_str += " "
+            end
+            @log.debug("Found group #{name} [ #{mem_str}]")
+            groups[name] = members
+        end
+        return groups
     end
 
-    page = link.click
-  
-    agent.cookie_jar.save_as File.expand_path("~/.cpsn/cookies.yml")
-end
+    def get_cookie(username, password)
+        @log.debug("Signing in for new cookie")
+        page = @agent.get(@login_url)
+        login_form = page.forms.first
+        login_form.loginName = username
+        login_form.password = password
+        page = @agent.submit(login_form)
+        link = page.links.first
+
+        if link.text == "Sign In"
+            puts "Error logging in. Did you give the right username and password?"
+            exit
+        end
+
+        page = link.click
+      
+        @agent.cookie_jar.save_as File.expand_path("~/.cpsn/cookies.yml")
+    end
 
-def get_agent(username, password, force_cookie)
-    $log.debug("Creating new user agent")
-    agent = WWW::Mechanize.new
-    agent.user_agent_alias = 'Mac FireFox'
-    agent.redirect_ok = true
+    def get_agent(username, password, force_cookie)
+        @log.debug("Creating new user agent")
+        @agent = WWW::Mechanize.new
+        @agent.user_agent_alias = 'Mac FireFox'
+        @agent.redirect_ok = true
 
-    if File.exist? File.expand_path("~/.cpsn/cookies.yml") and not force_cookie
-        agent.cookie_jar.load File.expand_path("~/.cpsn/cookies.yml")
-        return agent
+        if File.exist? File.expand_path("~/.cpsn/cookies.yml") and not force_cookie
+            @agent.cookie_jar.load File.expand_path("~/.cpsn/cookies.yml")
+        else
+            get_cookie(username, password)
+        end
     end
 
-    get_cookie(agent, username, password)
-    return agent
-end
+    def get_friends()
+        @log.debug("Getting friends list")
+        page = @agent.get($friend_url)
+        divs = page.search("div.slotcontent")
 
-def get_friends(agent)
-    $log.debug("Getting friends list")
-    page = agent.get($friend_url)
-    divs = page.search("div.slotcontent")
+        friends = []
+        for div in divs
+            friend = div.attributes["id"]
+            friends << friend
+            @log.debug("Found friend #{friend}")
+        end
 
-    friends = []
-    for div in divs
-        friend = div.attributes["id"]
-        friends << friend
-        $log.debug("Found friend #{friend}")
-    end
+        return friends
+    end 
 
-    return friends
-end 
+    def get_friend_status(friend)
+        @log.debug("Loading friend status for #{friend}")
+        page = @agent.get($json_url + friend)
+        data = JSON.parse(page.body)
 
-def get_friend_status(agent, friend)
-    $log.debug("Loading friend status for #{friend}")
-    page = agent.get($json_url + friend)
-    data = JSON.parse(page.body)
+        @log.debug(data)
 
-    $log.debug(data)
+        friend = {:name => data["userName"]}
 
-    friend = {:name => data["userName"]}
+        if data["onlineStatus"] == nil
+            return nil
+        end
 
-    if data["onlineStatus"] == nil
-        return nil
-    end
+        if data["onlineStatus"]["extensionStatus"] != nil
+           friend[:status] = 'online'
+           friend[:playing] = data["onlineStatus"]["extensionStatus"]["title"]
+           friend[:game_status] = data["onlineStatus"]["extensionStatus"]["status"]
+        else
+           friend[:status] = 'offline'
+           friend[:playing] = ""
+           friend[:game_status] = ""
+        end
 
-    if data["onlineStatus"]["extensionStatus"] != nil
-       friend[:status] = 'online'
-       friend[:playing] = data["onlineStatus"]["extensionStatus"]["title"]
-       friend[:game_status] = data["onlineStatus"]["extensionStatus"]["status"]
-    else
-       friend[:status] = 'offline'
-       friend[:playing] = ""
-       friend[:game_status] = ""
+        return friend
     end
 
-    return friend
 end
 
+
 options = {}
 optparse = OptionParser.new do |opts|
     options[:offline] = false
@@ -128,8 +149,9 @@ optparse = OptionParser.new do |opts|
         options[:offline] = true
     end
 
+    options[:debug] = false
     opts.on('-d', '--debug', 'Show debugging information') do
-        $log.level = Logger::DEBUG
+        options[:debug] = true
     end
 
     options[:cookie] = false
@@ -153,29 +175,25 @@ end
 
 optparse.parse!
 
-settings = load_settings()
-groups = load_groups(settings)
-agent = get_agent(settings[:username].value, settings[:password].value,
-                  options[:cookie])
+cpsn = Cpsn.new(options)
 
 if ARGV.length >= 1
     friend_names = Set.new []
     args = ARGV[0..-1]
     for arg in args
-        if groups.has_key? arg
-            friend_names.merge(groups[arg])
+        if cpsn.groups.has_key? arg
+            friend_names.merge(cpsn.groups[arg])
         else
             friend_names.add(arg)
         end
     end
 else
     begin
-        friend_names = get_friends(agent)
+        friend_names = cpsn.get_friends()
     rescue WWW::Mechanize::ResponseCodeError => response
-        puts response.response_code
         if response.response_code == '403'
-            get_cookie(agent, settings[:username].value,
-                       settings[:password].value)
+            cpsn.get_cookie(cpsn.settings[:username].value,
+                            cpsn.settings[:password].value)
             retry
         end
     end
@@ -183,11 +201,11 @@ end
 
 for friend_name in friend_names
     begin
-        friend = get_friend_status(agent, friend_name)
+        friend = cpsn.get_friend_status(friend_name)
     rescue WWW::Mechanize::ResponseCodeError => response
         if response.response_code == '403'
-            get_cookie(agent, settings[:username].value,
-                       settings[:password].value)
+            cpsn.get_cookie(cpsn.settings[:username].value,
+                            cpsn.settings[:password].value)
             retry
         end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cpsn
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors: 
 - James Bowes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -05:00
+date: 2009-11-22 00:00:00 -05:00
 default_executable: cpsn
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,18 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.7
     version: 
-description: Query PSN friend status from the CLI
+description: "\n        Query PSN friend status from the CLI. Shows useful information like the\n        game being played, and what mode or map your friend is playing\n        (if available).\n    "
 email: jbowes@repl.ca
 executables: 
 - cpsn
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.mkd
+- TODO
 files: 
 - .gitignore
+- README.mkd
 - Rakefile
 - TODO
 - VERSION