Oshuma-pingfm 1.0.0 → 1.0.1

data/History.txt

@@ -1,4 +1,8 @@
-== 1.0.0 / 2008-08-30
+== 1.0.1 / 2008-12-26
+
+* Fixed small bug in the command-line script.
+
+== 1.0.0 / 2008-09-25
 
 * first gem release
   * woohoo!

data/bin/pingfm

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# TODO: Eventually add some flags to support all Ping.fm functionality.
 
 # TODO: Move this into a YAML config?
 API_KEY = '5fcb8b7041d5c32c7e1e60dc076989ba'
@@ -9,7 +10,7 @@ require File.expand_path(
 keyloader = ::Pingfm::Keyloader.new
 unless keyloader.has_keys?
   keyloader.api_key = API_KEY
-  puts 'Enter your Ping.fm User API key (http://ping.fm/key/): '
+  print 'Enter your Ping.fm User API key (http://ping.fm/key/): '
   keyloader.app_key = STDIN.gets.chomp
   keyloader.save
 end
@@ -30,8 +31,8 @@ if s['status'] == 'OK'
 
   post_result = pingfm.post(status)
 
-  if s['status'] == 'FAIL'
-    puts s['message']
+  if post_result['status'] == 'FAIL'
+    puts post_result['message']
   else
     puts 'Message sent.'
   end

data/lib/pingfm/client.rb

@@ -29,9 +29,32 @@ module Pingfm
   		end
   	end
 
+    # Return a complete list of supported services
+    # if successful returns:
+    #   {'status' => 'OK', 'services' => [{'id' => 'serviceid', 'name' => 'servicename', 'trigger' => 'servicetrigger', 'url' => 'serviceurl', 'icon' => 'serviceicon'}, ...]}
+    # if unsuccessful returns:
+    #   {'status' => 'FAIL', 'message' => 'message what went wrong'}
+    def system_services
+      response = get_response('system.services')
+      if response.elements['rsp'].attributes['status'] == 'OK'
+        services = status_ok
+        services['services'] = []
+        response.elements.each('rsp/services/service') do |service|
+          services['services'].push({'id'      => service.attributes['id'],
+                                     'name'    => service.attributes['name'],
+                                     'trigger' => service.elements['trigger'].text,
+                                     'url'     => service.elements['url'].text,
+                                     'icon'    => service.elements['icon'].text})
+        end
+        return services
+      else
+        return status_fail(response)
+      end
+    end
+
   	# Returns a list of services the user has set up through Ping.fm
   	# if successful returns:
-  	#   {'status' => 'OK', services = [{'id' => 'serviceid', 'name' => 'servicename', 'methods' => 'status,blog'}, ...]}
+    #   {'status' => 'OK', 'services' => [{'id' => 'serviceid', 'name' => 'servicename', 'trigger' => 'servicetrigger', 'url' => 'serviceurl', 'icon' => 'serviceicon', 'methods' => 'status,blog'}, ...]}
   	# if unsuccessful returns:
   	#   {'status' => 'FAIL', 'message' => 'message what went wrong'}
   	def services
@@ -40,7 +63,12 @@ module Pingfm
   			services = status_ok()
   			services['services'] = []
   			response.elements.each('rsp/services/service') do |service|
-  				services['services'].push({'id' => service.attributes['id'], 'name' => service.attributes['name'], 'methods' => service.elements['methods'].text})
+  				services['services'].push({'id' => service.attributes['id'],
+  											'name' => service.attributes['name'],
+  											'trigger' => service.elements['trigger'].text,
+  											'url' => service.elements['url'].text,
+  											'icon' => service.elements['icon'].text,
+  											'methods' => service.elements['methods'].text})
   			end
   			return services
   		else
@@ -50,7 +78,7 @@ module Pingfm
 
   	# Returns a user's custom triggers
   	# if successful returns:
-  	#   {'status' => 'OK', triggers = [{'id' => 'triggerid', 'method' => 'triggermethod', 'services' => [{'id' => 'serviceid', 'name' => 'servicename'}, ...]}, ...]}
+  	#   {'status' => 'OK', 'triggers' => [{'id' => 'triggerid', 'method' => 'triggermethod', 'services' => [{'id' => 'serviceid', 'name' => 'servicename'}, ...]}, ...]}
   	# if unsuccessful returns:
   	#   {'status' => 'FAIL', 'message' => 'message what went wrong'}
   	def triggers
@@ -96,6 +124,11 @@ module Pingfm
   				else
   					latest['messages'].last['title'] = ''
   				end
+          if message.elements['location'] != nil
+            latest['messages'].last['location'] = message.elements['location'].text
+          else
+            latest['messages'].last['location'] = ''
+          end
   				latest['messages'].last['body'] = message.elements['*/body'].text
   				latest['messages'].last['services'] = []
   				message.elements.each('services/service') do |service|

data/lib/pingfm/keyloader.rb

@@ -16,7 +16,10 @@ module Pingfm
     # ping.fm uses this as the key for the user
     attr_accessor :app_key
 
-    def initialize(keyfile = File.expand_path('~/.pingfm_keys.yml'))
+    KEY_PATH = (RUBY_PLATFORM =~ /mswin32/ ? ENV['HOMEPATH'] : ENV['HOME'])
+    KEY_FILE = '.pingfm_keys.yml'
+
+    def initialize(keyfile = File.expand_path(File.join(KEY_PATH, KEY_FILE)))
       @api_key = nil
       @keyfile = keyfile
 

data/lib/pingfm.rb

@@ -7,7 +7,7 @@ unless defined? Pingfm
 module Pingfm
 
   # :stopdoc:
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/spec/pingfm_spec.rb

@@ -1,8 +1,24 @@
 # $Id$
+# TODO: LOTS of repetition here that can probably be refactored a bit.
+# TODO: Split these specs into a pingfm/ subdirectory, moving the client specs into their own file.
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
-describe Pingfm::Client, " with expected results" do
+describe Pingfm, 'main module' do
+  it 'should return the version string' do
+    Pingfm.version.should be_a_kind_of(String)
+  end
+
+  it 'should return the library path' do
+    Pingfm.libpath.should eql(Pingfm::LIBPATH)
+  end
+
+  it 'should return the path to the library' do
+    Pingfm.path.should eql(Pingfm::PATH)
+  end
+end
+
+describe Pingfm::Client, "with expected results" do
 
   before(:each) do
     @client = Pingfm::Client.new('a','b')
@@ -47,6 +63,26 @@ describe Pingfm::Client, " with expected results" do
     result['services'].first['id'].should eql('twitter')
   end
 
+  it "should list the system services" do
+    init_system_services_response
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.system_services
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+    result['services'].should_not be_nil
+    result['services'].should_not be_empty
+    result['services'].length.should eql(2)
+    result['services'].first['id'].should eql('bebo')
+  end
+
   it "should list the user's custom triggers" do
     init_trigger_response
 
@@ -88,6 +124,7 @@ describe Pingfm::Client, " with expected results" do
     result['messages'].should_not be_empty
     result['messages'].length.should eql(3)
     result['messages'].first['id'].should eql('12345')
+    result['messages'].last['location'].should_not be_empty
   end
 
   it "should post a message to the service" do
@@ -131,7 +168,7 @@ describe Pingfm::Client, " with expected results" do
 
 end
 
-describe Pingfm::Client, " with error messages" do
+describe Pingfm::Client, "with error messages" do
   before(:each) do
     @client = Pingfm::Client.new('a','b')
     @params = {'api_key' => 'a', 'user_app_key' => 'b'}
@@ -154,6 +191,119 @@ describe Pingfm::Client, " with error messages" do
     result['status'].should eql('FAIL')
     result['message'].should_not be_nil
   end
+
+  it "should handle a failed system services cleanly" do
+    init_fail_response 'system.services'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.system_services
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
+
+  it "should handle a failed user's services cleanly" do
+    init_fail_response 'user.services'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.services
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
+
+  it "should handle a failed user's triggers cleanly" do
+    init_fail_response 'user.triggers'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.triggers
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
+
+  it "should handle a failed user's latest messages cleanly" do
+    init_fail_response 'user.latest'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    @params.merge!('order' => 'DESC', 'limit' => 25)
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.latest
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
+
+  it "should handle a failed user post cleanly" do
+    init_fail_response 'user.post'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    @params.merge!({'post_method' => 'default', 'title' => '',
+                    'service' => '', 'body' => 'test message', 'debug' => 0})
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.post('test message')
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
+
+  it "should handle a failed user trigger post cleanly" do
+    init_fail_response 'user.tpost'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+
+    # mock the http call
+    http_resp = mock('response')
+    http_resp.should_receive(:body).and_return(@response)
+    @params.merge!({'title' => '', 'body' => 'test message',
+                    'trigger' => '@trigger', 'debug' => 0})
+    Net::HTTP.should_receive(:post_form).with(uri, @params).and_return(http_resp)
+
+    # call and verify
+    result = @client.tpost('test message', '@trigger')
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('FAIL')
+    result['message'].should_not be_nil
+  end
 end
 
 # EOF

data/spec/spec_helper.rb

@@ -62,6 +62,28 @@ def init_service_response
 EOXML
 end
 
+def init_system_services_response
+  @service_type = 'system.services'
+  @response = <<EOXML
+<rsp status="OK">
+  <transaction>12345</transaction>
+  <method>system.services</method>
+  <services>
+    <service id="bebo" name="Bebo">
+      <trigger>@be</trigger>
+      <url>http://www.bebo.com/</url>
+      <icon>http://p.ping.fm/static/icons/bebo.png</icon>
+    </service>
+    <service id="blogger" name="Blogger">
+      <trigger>@bl</trigger>
+      <url>http://www.blogger.com/</url>
+      <icon>http://p.ping.fm/static/icons/blogger.png</icon>
+    </service>
+  </services>
+</rsp>
+EOXML
+end
+
 def init_trigger_response
   @service_type = 'user.triggers'
   @response = <<EOXML
@@ -121,6 +143,7 @@ def init_latest_response
       <content>
         <body>aXMgdGVzdGluZyBQaW5nLmZtIQ==</body>
       </content>
+      <location>VHVsc2EsIE9L</location>
     </message>
   </messages>
 </rsp>

data/tasks/setup.rb

@@ -66,7 +66,7 @@ PROJ = OpenStruct.new(
   # Rcov
   :rcov => OpenStruct.new(
     :dir => 'coverage',
-    :opts => %w[--sort coverage -T],
+    :opts => %w[--sort coverage -T -x rcov.rb],
     :threshold => 90.0,
     :threshold_exact => false
   ),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Oshuma-pingfm
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Krunoslav Husak