wordpress 0.1.4 → 0.1.5

data/History.txt

@@ -1,16 +1,24 @@
-=== 1.0.3 / 2009-06-05
+=== 0.1.5 / 2009-06-09
+
+* 3 major enhancements
+
+  * Refactored code based on a few suggestions from Ryan Davis 
+  * Changed Wordpress::Client to Wordpress::Post and updated tests accordingly
+  * Added tests for tags method
+  
+=== 0.1.3 / 2009-06-05
 
 * 1 major enhancement
 
   * Stubbed test and refactored code
 
-=== 1.0.1 / 2009-06-05
+=== 0.1.1 / 2009-06-05
 
 * 1 major enhancement
 
   * Added the ability to post and check account properties
 
-=== 1.0.0 / 2009-05-28
+=== 0.0.1 / 2009-05-28
 
 * 1 major enhancement
 

data/README.txt

@@ -20,63 +20,62 @@ Posting images with posts, posting only images and pulling down your posts will
 
 == SYNOPSIS:
 
-1. Instantiate your account
+1. Instantiate your post with your account info
 
-    * You can provide just the username and password
+    * Provide just the username and password as strings
     
-        account = Wordpress::Client.new('username', 'password')
+        user_post = Wordpress::Post.new('username', 'password')
       
-    * Or you can provide the ID as a string or integer
+    * OR Provide the url of your login page if it's self hosted
 
-        account = Wordpress::Client.new('username', 'password', 'http://blog.mysite.com/wp-login.php')
+        user_post = Wordpress::Post.new('username', 'password', 'http://blog.mysite.com/wp-login.php')
 
-2. Get more info about the user's account if you need it
+2. Validate the provided account info and request the users blog url homepage if needed
 
-    * Check if the user is valid
+    * Check if the user is valid. Returns true or false
     
-        account.valid_user?
+        user_post.valid_user?
       
-    * Check if the specified login page is valid
+    * Check if the specified login page is valid. Returns true or false
     
-        account.valid_login_page?
+        user_post.valid_login_page?
       
-    * Get the users blog page url
+    * Get the users blog page url. Returns nil if it can't be found.
     
-        account.blog_url
-      
-    * Get a list of your sites and additional info
-    
-        account.account_info
+        user_post.blog_url
 
 3. Setup your post
 
-    * You must at least include the title or body
+    * You must at least include the title or body. Tags must be an array.
     
-        account.title           = "My Title"
-        account.body            = "My Body Text"
-        account.tags            = ["Glue", "Posterous", "Ruby", "Made By Squad"]
+        user_post.title = "My Title"
+        user_post.body  = "My Body Text"
+        user_post.tags  = ["Glue", "Wordpress", "Ruby", "Made By Squad"]
 
-4. Add your post to Posterous.com
+4. Update your Wordpress Blog with your post
 
     * Set this to a variable to work with the response
     
-        response = account.add_post
+        response = user_post.submit
 
-5. You get a success or error hash back or nil
+5. You get a success or error hash back
 
     * 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" } }
+        response #=> { "rsp" => { "post" => { "title" => "My Title", "url" => "http://getglue.wordpress.com/2009/06/06/my-title/", "id" => "69" },  "stat" => "ok" } }
+    
+    * Your response would look like this if it failed
+    
+        response #=> { "rsp" => { "err" => { "msg" => "Post was unsuccessful.", "title" => "My Title" }, "stat" => "fail" } }
     
-    * See the tests for this gem for failure responses and responses for other methods
 
 == REQUIREMENTS:
 
-* mechanize, & Mocha (For Tests)
+* mechanize, & Mocha (For Testing)
 
 == INSTALL:
 
-* sudo gem install wordpress -include-dependencies
+* sudo gem install wordpress
 
 == LICENSE:
 

data/Rakefile

@@ -5,9 +5,9 @@ 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']
+  p.extra_deps     = ['mechanize']
+  p.extra_dev_deps = ['mocha']
 end
 
 # vim: syntax=Ruby

data/lib/wordpress.rb

@@ -3,13 +3,14 @@ require 'mechanize'
 
 module Wordpress
 
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 
   class AuthError < StandardError; end
   class PostError < StandardError; end
   class HostError < StandardError; end
+  class TagsError < StandardError; end
 
-  class Client
+  class Post
 
     DEFAULT_URL = 'http://wordpress.com/wp-login.php'
     LOGIN_FORM  = 'loginform'
@@ -22,7 +23,7 @@ module Wordpress
 
     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 == ''
+        unless  usr.is_a?(String) && pwd.is_a?(String) && !usr.empty? && !pwd.empty?
 
       raise   AuthError, "Url should end with wp-login.php" \
         unless  login_url =~ /\/wp-login[.]php$/
@@ -35,7 +36,7 @@ module Wordpress
     end
 
     def tags= ary
-      raise TagError, 'Tags must added using an array' if !ary.is_a?(Array)
+      raise TagsError, 'Tags must added using an array' unless ary.is_a?(Array)
       @tags = ary.join(", ")
     end
 
@@ -48,14 +49,10 @@ module Wordpress
     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
+      dashboard_page.search("#{IS_ADMIN} #wphead h1 a").first['href'] rescue nil
     end
 
-    def add_post
+    def submit
       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
@@ -77,7 +74,6 @@ module Wordpress
         login_form.pwd = @password
         page           = @agent.submit login_form
       end
-      puts page.inspect
       page
     end
 
@@ -85,23 +81,23 @@ module Wordpress
       !page.search(IS_ADMIN).empty?
     end
 
-    def build_post f
-      f.post_title = @title
-      f.content    = @body
-      f.tags_input = @tags
-      f
+    def build_post form
+      form.post_title = @title
+      form.content    = @body
+      form.tags_input = @tags
+      form
     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
+      links = page.search("div.message p a")
+      if links.first && links.last
+        url = links.first['href'] ? links.first['href'].gsub("?preview=1", "")  : nil
+        pid = links.last['href']  ? links.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" }}
+      { "rsp" => { "err" => { "msg" => "Post was unsuccessful.", "title" => "#{@title}" }, "stat" => "fail" } }
     end
   end
 end

data/test/test_wordpress.rb

@@ -2,27 +2,24 @@ 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
+class Wordpress::Post
+  public :login_page, :dashboard_page, :logged_into?, :build_post, :post_response
 end
 
+# Need to test these methods
+# * build_post
+# * dashboard_page
+
 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'
+    @account                    = Wordpress::Post.new @u, @p
+    @account_bad                = Wordpress::Post.new @u, 'x'
+    @account_invalid_login_page = Wordpress::Post.new @u, @p, 'http://notapage.gd/wp-login.php'
+    @account_hosted_account     = Wordpress::Post.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>'
@@ -33,7 +30,6 @@ class TestWordpress < Test::Unit::TestCase
     @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
@@ -41,36 +37,36 @@ class TestWordpress < Test::Unit::TestCase
   end
 
   def test_sets_account_info_on_initialize
-    actual       = Wordpress::Client.new @u, @p 
+    actual       = Wordpress::Post.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 
+      Wordpress::Post.new "", @p 
     end
   end
 
   def test_raises_if_password_is_blank
     assert_raise Wordpress::AuthError do
-      Wordpress::Client.new @u, ""
+      Wordpress::Post.new @u, ""
     end
   end
 
   def test_raises_if_password_is_not_srting
     assert_raise Wordpress::AuthError do
-      Wordpress::Client.new @u, 00
+      Wordpress::Post.new @u, 00
     end
   end
 
   def test_raises_if_username_is_not_srting
     assert_raise Wordpress::AuthError do
-      Wordpress::Client.new 00, @p
+      Wordpress::Post.new 00, @p
     end
   end
 
   def test_login_url_uses_default_if_witheld
-    assert_equal Wordpress::Client::DEFAULT_URL, @account.login_url
+    assert_equal Wordpress::Post::DEFAULT_URL, @account.login_url
   end
 
   def test_users_url_does_not_raise
@@ -79,12 +75,12 @@ class TestWordpress < Test::Unit::TestCase
 
   def test_raises_on_bad_login_url
     assert_raise Wordpress::AuthError do
-      Wordpress::Client.new @u, @p, 'http://bad.login/url.php'
+      Wordpress::Post.new @u, @p, 'http://bad.login/url.php'
     end
   end
 
   def test_login_page_is_valid
-    actual = Wordpress::Client.new @u, @p
+    actual = Wordpress::Post.new @u, @p
     actual.stubs(:login_page).returns(@login_pg)
     assert_equal true, actual.valid_login_page?
   end
@@ -110,15 +106,11 @@ class TestWordpress < Test::Unit::TestCase
   end
 
   def test_private_logged_in_is_true
-    Wordpress::Client.private_methods {
-      assert_equal  true,  @account.logged_into?(@admin_pg)
-    }
+    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)
-    }
+    assert_equal  false, @account.logged_into?(@login_pg)
   end
 
   def test_returns_blog_url
@@ -131,65 +123,82 @@ class TestWordpress < Test::Unit::TestCase
     assert_nil @account_invalid_login_page.blog_url
   end
 
-  def test_add_post_raises_without_title_or_body
+  def test_update_raises_without_title_or_body
     assert_raise Wordpress::PostError do
-      @account.add_post
+      @account.submit
     end
   end
 
-  def test_add_post_raises_without_post_form
+  def test_update_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
+      @account_bad.submit
+    end
+  end
+
+  def test_tags_are_added_correctly
+    @account.tags = []
+    assert_equal @account.tags, ""
+  end
+
+  def test_tags_single_is_correctly
+    @account.tags = ["Glue"]
+    assert_equal @account.tags, "Glue"
+  end
+
+  def test_tags_multiple_is_correctly_joined
+    @account.tags = ["Glue", "Wordpress", "Ruby on Rails"]
+    assert_equal @account.tags, "Glue, Wordpress, Ruby on Rails"
+  end
+
+  def test_raises_if_tags_not_set_as_array
+    assert_raise Wordpress::TagsError do
+      @account.tags = "hello, "
     end
   end
 
   def test_post_response_returns_good_response
-    Wordpress::Client.private_methods {
-      assert_equal "ok", @account.post_response(@success_pg)["rsp"]["stat"]
-    }
+    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"]
-    }
+  def test_update_returns_fail
+    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
+  def test_update_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
+    actual         = @account.submit
     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
+  def test_update_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
+    actual         = @account.submit
     assert_equal     "ok",                        actual["rsp"]["stat"]
     assert_equal     title,                       actual["rsp"]["post"]["title"]
   end
 
-  def test_add_post_returns_ok_with_only_body
+  def test_update_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
+    actual         = @account.submit
     assert_equal     "ok",                        actual["rsp"]["stat"]
     assert_equal     "",                          actual["rsp"]["post"]["title"]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wordpress
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Jordan Dobson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-08 00:00:00 -07:00
+date: 2009-06-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: