wordpress 0.1.4

data/History.txt

@@ -0,0 +1,18 @@
+=== 1.0.3 / 2009-06-05
+
+* 1 major enhancement
+
+  * Stubbed test and refactored code
+
+=== 1.0.1 / 2009-06-05
+
+* 1 major enhancement
+
+  * Added the ability to post and check account properties
+
+=== 1.0.0 / 2009-05-28
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/wordpress
+lib/wordpress.rb
+test/test_wordpress.rb

data/README.txt

@@ -0,0 +1,104 @@
+= wordpress
+
+* http://github.com/jordandobson/wordpress/tree/master
+
+== DESCRIPTION:
+
+The Wordpress gem provides posting to a Wordpress.com blog or a self hosted wordpress by providing your username, password, login url(if you host your blog) and your blog content. With this gem, you have access to add a text entry on Wordpress blog by providing these options: title text, body text, and a tag array. You must include at least title text or body text with your post.
+
+Posting images with posts, posting only images and pulling down your posts will be available very soon.
+
+== FEATURES/PROBLEMS:
+
+* Either Title or Body is optional
+* Adding Images are not yet implemented
+* Posting Only, Reading & Images are not yet included
+* Check if a username and password are valid
+* Check if a provided login_url is valid
+* Get the users blog url
+* This is very throughly tested
+
+== SYNOPSIS:
+
+1. Instantiate your account
+
+    * You can provide just the username and password
+    
+        account = Wordpress::Client.new('username', 'password')
+      
+    * Or you can provide the ID as a string or integer
+
+        account = Wordpress::Client.new('username', 'password', 'http://blog.mysite.com/wp-login.php')
+
+2. Get more info about the user's account if you need it
+
+    * Check if the user is valid
+    
+        account.valid_user?
+      
+    * Check if the specified login page is valid
+    
+        account.valid_login_page?
+      
+    * Get the users blog page url
+    
+        account.blog_url
+      
+    * Get a list of your sites and additional info
+    
+        account.account_info
+
+3. Setup your post
+
+    * You must at least include the title or body
+    
+        account.title           = "My Title"
+        account.body            = "My Body Text"
+        account.tags            = ["Glue", "Posterous", "Ruby", "Made By Squad"]
+
+4. Add your post to Posterous.com
+
+    * Set this to a variable to work with the response
+    
+        response = account.add_post
+
+5. You get a success or error hash back or nil
+
+    * Your response should look something like this if successful
+    
+    response #=> { "rsp" => { "post" => { "title"   => "My Title", "url" => "http://getglue.wordpress.com/2009/06/06/my-title/", "id" => "69" },  "stat" => "ok" } }
+    
+    * See the tests for this gem for failure responses and responses for other methods
+
+== REQUIREMENTS:
+
+* mechanize, & Mocha (For Tests)
+
+== INSTALL:
+
+* sudo gem install wordpress -include-dependencies
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jordan Dobson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/wordpress.rb'
+
+Hoe.new('wordpress', Wordpress::VERSION) do |p|
+  # p.rubyforge_name = 'wordpressx' # if different than lowercase project name
+  p.developer('Jordan Dobson', 'jordan.dobson@madebysquad.com')
+  p.extra_deps = ['mechanize', 'mocha']
+end
+
+# vim: syntax=Ruby

data/bin/wordpress

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/lib/wordpress.rb

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'mechanize'
+
+module Wordpress
+
+  VERSION = '0.1.4'
+
+  class AuthError < StandardError; end
+  class PostError < StandardError; end
+  class HostError < StandardError; end
+
+  class Client
+
+    DEFAULT_URL = 'http://wordpress.com/wp-login.php'
+    LOGIN_FORM  = 'loginform'
+    POST_FORM   = 'post'
+    IS_ADMIN    = 'body.wp-admin'
+    IS_LOGIN    = 'body.login'
+
+    attr_accessor :title, :body
+    attr_reader   :login_url, :username, :password, :tags, :post_url, :agent
+
+    def initialize usr, pwd, login_url = DEFAULT_URL
+      raise   AuthError, "Blank Username or Password or not a string." \
+        if      !usr.is_a?(String) || !pwd.is_a?(String) || usr == '' || pwd == ''
+
+      raise   AuthError, "Url should end with wp-login.php" \
+        unless  login_url =~ /\/wp-login[.]php$/
+
+      @username  = usr
+      @password  = pwd
+      @login_url = login_url
+      @agent     = WWW::Mechanize.new
+      @post_url  = @tags = @title = @body = nil
+    end
+
+    def tags= ary
+      raise TagError, 'Tags must added using an array' if !ary.is_a?(Array)
+      @tags = ary.join(", ")
+    end
+
+    def valid_login_page?
+      !login_page.search("form[name=#{LOGIN_FORM}]").empty?
+    end
+
+    def valid_user?
+      logged_into? dashboard_page
+    end
+
+    def blog_url
+      begin
+        a = dashboard_page.search("#{IS_ADMIN} #wphead h1 a")
+      rescue SocketError
+      end
+      a && a.first && a.first['href'] ? a.first['href'] : nil
+    end
+
+    def add_post
+      raise PostError, "A post requires a title or body."                       unless @title || @body
+      post_form      = dashboard_page.form(POST_FORM)
+      raise HostError, "Missing QuickPress on dashboard page or bad account."   unless post_form
+      post_form      = build_post(post_form)
+      post_response    @agent.submit(post_form, post_form.buttons.last)
+    end
+
+  private
+
+    def login_page
+      @agent.get @login_url
+    end
+
+    def dashboard_page
+      page             = login_page
+      login_form       = page.form(LOGIN_FORM)
+      if login_form
+        login_form.log = @username
+        login_form.pwd = @password
+        page           = @agent.submit login_form
+      end
+      puts page.inspect
+      page
+    end
+
+    def logged_into? page
+      !page.search(IS_ADMIN).empty?
+    end
+
+    def build_post f
+      f.post_title = @title
+      f.content    = @body
+      f.tags_input = @tags
+      f
+    end
+
+    def post_response page
+      a = page.search("div.message p a")
+      if a && a.first && a.last
+        url = a.first['href'] ? a.first['href'].gsub("?preview=1", "")  : nil
+        pid = a.last['href']  ? a.last['href'].sub(/.*post=(\d*)/,'\1') : nil
+        if pid && url
+          return { "rsp" => { "post" => { "title" => "#{@title}", "url" => "#{url}", "id" => "#{pid}" }, "stat" => "ok" }}
+        end
+      end
+      { "rsp" => { "err" => { "msg" => "Post was unsuccessful.", "title" => "#{@title}" }, "stat" => "fail" }}
+    end
+  end
+end

data/test/test_wordpress.rb

@@ -0,0 +1,196 @@
+require "test/unit"
+require "wordpress"
+require "mocha"
+
+######
+# USED TO TEST PRIVATE METHODS
+class Class
+  def private_methods
+    m = self.private_instance_methods
+    self.class_eval { public( *m ) }
+    yield
+    self.class_eval { private( *m ) }
+  end
+end
+
+class TestWordpress < Test::Unit::TestCase
+
+  def setup
+    @u = 'jordandobson'
+    @p = 'password'
+
+    @account                    = Wordpress::Client.new @u, @p
+    @account_bad                = Wordpress::Client.new @u, 'x'
+    @account_invalid_login_page = Wordpress::Client.new @u, @p, 'http://notapage.gd/wp-login.php'
+    @account_hosted_account     = Wordpress::Client.new @u, @p, 'http://blog.getglue.net/wp-login.php'
+
+    login_html   = '<html><body class="login"><form name="loginform"></form></body></html>'
+    admin_html   = '<html><body class="wp-admin"><div id="wphead"><h1><a href="http://getglue.wordpress.com/" title="Visit Site">Get Glue</a></h1></div><form name="post"><input type="text" name="post_title"/><textarea name="content"></textarea><input type="text" name="tags_input"/><input type="submit" name="publish" /></form></body></html>'
+    success_html = '<div class="message"><p><a href="http://success.com/2009/?preview=1">preview</a><a href="http://success.com/wp-admin/post.php?post=99">edit</a></p></div>'
+    fail_html    = '<div class="message"><p></p></div>'
+
+    @login_pg   = setup_mock_mechanize_pg login_html
+    @admin_pg   = setup_mock_mechanize_pg admin_html
+    @success_pg = setup_mock_mechanize_pg success_html
+    @fail_pg    = setup_mock_mechanize_pg fail_html
+
+  end
+
+  def setup_mock_mechanize_pg html
+    WWW::Mechanize::Page.new(nil, {'content-type' => 'text/html'}, html, 200)
+  end
+
+  def test_sets_account_info_on_initialize
+    actual       = Wordpress::Client.new @u, @p 
+    assert_equal   [@u, @p], [actual.username, actual.password]
+  end
+
+  def test_raises_if_username_is_blank
+    assert_raise Wordpress::AuthError do
+      Wordpress::Client.new "", @p 
+    end
+  end
+
+  def test_raises_if_password_is_blank
+    assert_raise Wordpress::AuthError do
+      Wordpress::Client.new @u, ""
+    end
+  end
+
+  def test_raises_if_password_is_not_srting
+    assert_raise Wordpress::AuthError do
+      Wordpress::Client.new @u, 00
+    end
+  end
+
+  def test_raises_if_username_is_not_srting
+    assert_raise Wordpress::AuthError do
+      Wordpress::Client.new 00, @p
+    end
+  end
+
+  def test_login_url_uses_default_if_witheld
+    assert_equal Wordpress::Client::DEFAULT_URL, @account.login_url
+  end
+
+  def test_users_url_does_not_raise
+    assert_equal 'http://notapage.gd/wp-login.php', @account_invalid_login_page.login_url
+  end
+
+  def test_raises_on_bad_login_url
+    assert_raise Wordpress::AuthError do
+      Wordpress::Client.new @u, @p, 'http://bad.login/url.php'
+    end
+  end
+
+  def test_login_page_is_valid
+    actual = Wordpress::Client.new @u, @p
+    actual.stubs(:login_page).returns(@login_pg)
+    assert_equal true, actual.valid_login_page?
+  end
+
+  def test_login_page_is_invalid
+    @account_invalid_login_page.stubs(:login_page).returns(@fail_pg)
+    assert_equal false, @account_invalid_login_page.valid_login_page?
+  end
+
+  def test_is_a_valid_user
+    @account.stubs(:dashboard_page).returns(@admin_pg)
+    assert_equal true, @account.valid_user?
+  end
+
+  def test_is_an_invalid_user
+    @account_bad.stubs(:dashboard_page).returns(@login_pg)
+    assert_equal false, @account_bad.valid_user?
+  end
+
+  def test_is_a_valid_hosted_user
+    @account_hosted_account.stubs(:dashboard_page).returns(@admin_pg)
+    assert_equal true, @account_hosted_account.valid_user?
+  end
+
+  def test_private_logged_in_is_true
+    Wordpress::Client.private_methods {
+      assert_equal  true,  @account.logged_into?(@admin_pg)
+    }
+  end
+
+  def test_private_logged_in_is_false
+    Wordpress::Client.private_methods {
+      assert_equal  false, @account.logged_into?(@login_pg)
+    }
+  end
+
+  def test_returns_blog_url
+    @account_hosted_account.stubs(:dashboard_page).returns(@admin_pg)
+    assert_equal 'http://getglue.wordpress.com/', @account_hosted_account.blog_url
+  end
+
+  def test_returns_blog_url_bad
+    @account_invalid_login_page.stubs(:dashboard_page).raises(SocketError)
+    assert_nil @account_invalid_login_page.blog_url
+  end
+
+  def test_add_post_raises_without_title_or_body
+    assert_raise Wordpress::PostError do
+      @account.add_post
+    end
+  end
+
+  def test_add_post_raises_without_post_form
+    @account_bad.stubs(:dashboard_page).returns(@fail_pg)
+    @account_bad.title = "Fail"
+    assert_raise Wordpress::HostError do
+      @account_bad.add_post
+    end
+  end
+
+  def test_post_response_returns_good_response
+    Wordpress::Client.private_methods {
+      assert_equal "ok", @account.post_response(@success_pg)["rsp"]["stat"]
+    }
+  end
+
+  def test_add_post_returns_fail
+    Wordpress::Client.private_methods {
+      title          = "My Title"
+      @account.title = title
+      res            = @account.post_response(@fail_pg)
+      assert_equal     "fail",                    res["rsp"]["stat"]
+      assert_equal     "Post was unsuccessful.",  res["rsp"]["err"]["msg"]
+      assert_equal     title,                     res["rsp"]["err"]["title"]
+    }
+  end
+
+  def test_add_post_returns_ok
+    @account.stubs(:dashboard_page).returns(@admin_pg)
+    @account.agent.stubs(:submit).returns(@success_pg)
+    title          = "My Title"
+    @account.title = title
+    @account.body  = "Body Text ..."
+    actual         = @account.add_post
+    assert_equal     "ok",                        actual["rsp"]["stat"]
+    assert_equal     title,                       actual["rsp"]["post"]["title"]
+    assert_equal     "99",                        actual["rsp"]["post"]["id"]
+    assert_equal     "http://success.com/2009/",  actual["rsp"]["post"]["url"]
+  end
+
+  def test_add_post_returns_ok_with_only_title
+    @account.stubs(:dashboard_page).returns(@admin_pg)
+    @account.agent.stubs(:submit).returns(@success_pg)
+    title          = "My Title"
+    @account.title = "My Title"
+    actual         = @account.add_post
+    assert_equal     "ok",                        actual["rsp"]["stat"]
+    assert_equal     title,                       actual["rsp"]["post"]["title"]
+  end
+
+  def test_add_post_returns_ok_with_only_body
+    @account.stubs(:dashboard_page).returns(@admin_pg)
+    @account.agent.stubs(:submit).returns(@success_pg)
+    @account.body  = "Body Text ..."
+    actual         = @account.add_post
+    assert_equal     "ok",                        actual["rsp"]["stat"]
+    assert_equal     "",                          actual["rsp"]["post"]["title"]
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: wordpress
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Jordan Dobson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.2
+    version: 
+description: |-
+  The Wordpress gem provides posting to a Wordpress.com blog or a self hosted wordpress by providing your username, password, login url(if you host your blog) and your blog content. With this gem, you have access to add a text entry on Wordpress blog by providing these options: title text, body text, and a tag array. You must include at least title text or body text with your post.
+  
+  Posting images with posts, posting only images and pulling down your posts will be available very soon.
+email: 
+- jordan.dobson@madebysquad.com
+executables: 
+- wordpress
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/wordpress
+- lib/wordpress.rb
+- test/test_wordpress.rb
+has_rdoc: true
+homepage: http://github.com/jordandobson/wordpress/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: wordpress
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: The Wordpress gem provides posting to a Wordpress.com blog or a self hosted wordpress by providing your username, password, login url(if you host your blog) and your blog content
+test_files: 
+- test/test_wordpress.rb