Oshuma-pingfm 1.0.0

data/spec/pingfm_spec.rb

@@ -0,0 +1,159 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Pingfm::Client, " with expected results" do
+
+  before(:each) do
+    @client = Pingfm::Client.new('a','b')
+    @params = {'api_key' => 'a', 'user_app_key' => 'b'}
+  end
+
+  it "should validate keys successfully" do
+    init_ok_response 'user.validate'
+
+    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.validate
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+  end
+
+  it "should list the user's services properly" do
+    init_service_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.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('twitter')
+  end
+
+  it "should list the user's custom triggers" do
+    init_trigger_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.triggers
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+    result['triggers'].should_not be_nil
+    result['triggers'].should_not be_empty
+    result['triggers'].length.should eql(2)
+    result['triggers'].first['id'].should eql('twt')
+  end
+
+  it "should list the user's recent posts" do
+    init_latest_response
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+    @params.merge!('limit'=>5,'order'=>'DESC')
+
+    # 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.latest(5)
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+    result['messages'].should_not be_nil
+    result['messages'].should_not be_empty
+    result['messages'].length.should eql(3)
+    result['messages'].first['id'].should eql('12345')
+  end
+
+  it "should post a message to the service" do
+    init_ok_response 'user.post'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+    @params.merge!('body' => 'foo', 'title' => '',
+    'post_method' => 'default', 'service' => '',
+    'debug' => 0)
+
+    # 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.post('foo')
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+  end
+
+  it "should post a message to the service using a trigger" do
+    init_ok_response 'user.tpost'
+
+    uri = URI.parse "#{Pingfm::API_URL}/#{@service_type}"
+    @params.merge!('body' => 'foo', 'title' => '',
+    'trigger' => 'twt', 'debug' => 0)
+
+    # 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.tpost('foo','twt')
+    result.should_not be_empty
+    result['status'].should_not be_nil
+    result['status'].should eql('OK')
+  end
+
+end
+
+describe Pingfm::Client, " with error messages" do
+  before(:each) do
+    @client = Pingfm::Client.new('a','b')
+    @params = {'api_key' => 'a', 'user_app_key' => 'b'}
+  end
+
+  it "should handle a failed validate cleanly" do
+    init_fail_response 'user.validate'
+
+    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.validate
+    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

@@ -0,0 +1,130 @@
+# $Id$
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib pingfm]))
+
+# Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+# end
+
+def init_ok_response(service_type)
+  @service_type = service_type
+  @response = <<EOXML
+<?xml version="1.0"?>
+<rsp status="OK">
+<transaction>12345</transaction>
+<method>#{@service_type}</method>
+</rsp>
+EOXML
+end
+
+def init_fail_response(service_type)
+  @service_type = service_type
+  @response = <<EOXML
+<?xml version="1.0"?>
+<rsp status="FAIL">
+  <transaction>12345</transaction>
+  <method>#{@service_type}</method>
+  <message>You suck</message>
+</rsp>
+EOXML
+end
+
+def init_service_response
+  @service_type = 'user.services'
+  @response = <<EOXML
+<?xml version="1.0"?>
+<rsp status="OK">
+  <transaction>12345</transaction>
+  <method>user.services</method>
+  <services>
+    <service id="twitter" name="Twitter">
+      <trigger>@tt</trigger>
+      <url>http://twitter.com/</url>
+      <icon>http://p.ping.fm/static/icons/twitter.png</icon>
+      <methods>microblog,status</methods>
+    </service>
+    <service id="facebook" name="Facebook">
+      <trigger>@fb</trigger>
+      <url>http://www.facebook.com/</url>
+      <icon>http://p.ping.fm/static/icons/facebook.png</icon>
+      <methods>status</methods>
+    </service>
+  </services>
+</rsp>
+EOXML
+end
+
+def init_trigger_response
+  @service_type = 'user.triggers'
+  @response = <<EOXML
+<?xml version="1.0"?>
+<rsp status="OK">
+  <transaction>12345</transaction>
+  <method>user.triggers</method>
+  <triggers>
+    <trigger id="twt" method="microblog">
+      <services>
+        <service id="twitter" name="Twitter"/>
+      </services>
+    </trigger>
+    <trigger id="fb" method="status">
+      <services>
+        <service id="facebook" name="Facebook"/>
+      </services>
+    </trigger>
+  </triggers>
+</rsp>
+EOXML
+end
+
+def init_latest_response
+  @service_type = 'user.latest'
+  @response = <<EOXML
+  <?xml version="1.0"?>
+<rsp status="OK">
+  <transaction>12345</transaction>
+  <method>user.latest</method>
+  <messages>
+    <message id="12345" method="blog">
+      <date rfc="Tue, 15 Apr 2008 13:56:18 -0500" unix="1234567890" />
+      <services>
+        <service id="blogger" name="Blogger"/>
+      </services>
+      <content>
+        <title>SnVzdCBoYW5naW4nIG91dCE=</title>
+        <body>R29pbmcgdG8gdGhlIHN0b3JlLg==</body>
+      </content>
+    </message>
+    <message id="12345" method="microblog">
+      <date rfc="Tue, 15 Apr 2008 13:56:18 -0500" unix="1234567890" />
+      <services>
+        <service id="twitter" name="Twitter"/>
+      </services>
+      <content>
+        <body>R29pbmcgdG8gdGhlIHN0b3JlLg==</body>
+      </content>
+    </message>
+    <message id="12345" method="status">
+      <date rfc="Tue, 15 Apr 2008 13:56:18 -0500" unix="1234567890" />
+      <services>
+        <service id="twitter" name="Twitter"/>
+        <service id="facebook" name="Facebook"/>
+      </services>
+      <content>
+        <body>aXMgdGVzdGluZyBQaW5nLmZtIQ==</body>
+      </content>
+    </message>
+  </messages>
+</rsp>
+EOXML
+end
+
+# EOF

data/tasks/ann.rake

@@ -0,0 +1,81 @@
+# $Id$
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,21 @@
+# $Id$
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,126 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+    pkg.package_files += PROJ.gem._spec.files
+  end
+  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
+
+  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
+      "#{pkg.package_name}.gem"
+    else
+      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
+    end
+
+  desc "Build the gem file #{gem_file}"
+  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
+
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
+    when_writing("Creating GEM") {
+      Gem::Builder.new(PROJ.gem._spec).build
+      verbose(true) {
+        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
+      }
+    }
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+remove_desc_for_task %w(gem:clobber_package)
+
+# EOF

data/tasks/git.rake

@@ -0,0 +1,41 @@
+# $Id$
+
+if HAVE_GIT
+
+namespace :git do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the Git repository'
+  task :show_tags => 'git:prereqs' do |t|
+    puts %x/git tag/
+  end
+
+  desc 'Create a new tag in the Git repository'
+  task :create_tag => 'git:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating Git tag '#{tag}'"
+    unless system "git tag -a -m '#{msg}' #{tag}"
+      abort "Tag creation failed"
+    end
+
+    if %x/git remote/ =~ %r/^origin\s*$/
+      unless system "git push origin #{tag}"
+        abort "Could not push tag to remote Git repository"
+      end
+    end
+  end
+
+end  # namespace :git
+
+task 'gem:release' => 'git:create_tag'
+
+end  # if HAVE_GIT
+
+# EOF

data/tasks/manifest.rake

@@ -0,0 +1,49 @@
+# $Id$
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manifest'
+  task :check do
+    fn = PROJ.manifest_file + '.tmp'
+    files = manifest_files
+
+    File.open(fn, 'w') {|fp| fp.puts files}
+    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
+    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
+      lines.map! do |line|
+        case line
+        when %r/^(-{3}|\+{3})/; nil
+        when %r/^@/; Console::ANSICode.blue line
+        when %r/^\+/; Console::ANSICode.green line
+        when %r/^\-/; Console::ANSICode.red line
+        else line end
+      end
+    end
+    puts lines.compact
+    rm fn rescue nil
+  end
+
+  desc 'Create a new manifest'
+  task :create do
+    files = manifest_files
+    unless test(?f, PROJ.manifest_file)
+      files << PROJ.manifest_file
+      files.sort!
+    end
+    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
+  end
+
+  task :assert do
+    files = manifest_files
+    manifest = File.read(PROJ.manifest_file).split($/)
+    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
+  end
+
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
+
+# EOF

data/tasks/notes.rake

@@ -0,0 +1,28 @@
+# $Id$
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if t.application.top_level_tasks.length > 1
+    t.application.top_level_tasks.slice!(1..-1).join(' ')
+  end
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+  PROJ.notes.tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do |t|
+      id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+      end
+      Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
+    end
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/post_load.rake

@@ -0,0 +1,39 @@
+# $Id$
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
+PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.rdoc.dir)}/",
+                 "^#{Regexp.escape(PROJ.rcov.dir)}/"]
+
+flatten_arrays = lambda do |this,os|
+    os.instance_variable_get(:@table).each do |key,val|
+      next if key == :dependencies
+      case val
+      when Array; val.flatten!
+      when OpenStruct; this.call(this,val)
+      end
+    end
+  end
+flatten_arrays.call(flatten_arrays,PROJ)
+
+PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
+
+PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
+
+PROJ.summary ||= PROJ.description.split("\n\n").first
+
+PROJ.gem.files ||=
+  if test(?f, PROJ.manifest_file)
+    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
+    files.delete ''
+    files
+  else [] end
+
+PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
+
+PROJ.rdoc.main ||= PROJ.readme_file
+
+# EOF