wordpress-xmlrpc 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle
+wordpress
+webrat.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem "mysql",			"2.8.1"
+gem "rspec",			"1.3.0"
+gem "cucumber",			"0.8.3"
+gem "capybara",			"0.3.9"
+gem "selenium-webdriver", 	"0.0.27"
+gem "jeweler",			"1.4.0"
+gem "log4r",			"1.1.8"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alexander Naumenko
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= wordpress-xmlrpc
+
+This gem is very fresh and under hard development. Please contact me directly before forking it ;)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Alexander Naumenko. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = "wordpress-xmlrpc"
+    gem.summary = %Q{This gem is supposed to simplify wordpress xmlrpc interaction}
+    gem.description = %Q{Please do not fork it before directly contacint}
+    gem.email = "alecnmk@gmail.com"
+    gem.homepage = "http://github.com/alecnmk/wordpress-xmlrpc"
+    gem.authors = ["Alexander Naumenko"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wordpress-xmlrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/features/publish.feature

@@ -0,0 +1,18 @@
+Feature: Publish post
+  In order to make a posts
+  I will need to call my client on blog API
+
+  Background:
+  Given I have a blog control
+  And all posts and comments cleaned out
+
+  Scenario: Load wordpress home page
+    When I go to wordpress "home" page
+    Then I should see "wordpress"
+    When make following post:
+    | title  | content               | publish_date |
+    | hey ho | this is my first post |   01.08.2010 |
+    And I go to wordpress "home" page
+    Then I should see "hey ho"
+    And I should see "this is my first post"
+    And I should see "Posted on August 1, 2010 by admin"

data/features/step_definitions/basic_steps.rb

@@ -0,0 +1,28 @@
+When /^I go to wordpress "([^\"]*)" page$/ do |page|
+  case page
+  when "home"
+    visit("/")
+  else
+    raise "Undefined page #{page}"
+  end
+end
+
+When /^I wait for (\d+) seconds+$/ do |seconds|
+  sleep(seconds.to_i)
+end
+
+Then /^I should see "([^\"]*)"$/ do |expected_content|
+  page.should have_content(expected_content)
+end
+
+Given /^I have a blog control$/ do
+  @blog = Wordpress::Blog.new(:host => "http://localhost", :user => "admin", :password => "wordpress-xmlrpc")
+end
+
+When /^make following post:$/ do |table|
+  table.hashes.each do |hash|
+    hash['publish_date'] = Date.parse(hash.delete('publish_date')) if hash['publish_date']
+    post = Wordpress::Post.new(hash)
+    @blog.publish(post)
+  end
+end

data/features/step_definitions/mysql_steps.rb

@@ -0,0 +1,7 @@
+Given /^all posts and comments cleaned out$/ do
+  mysql = Mysql.new("localhost", "root", "", "wordpress_xmlrpc")
+  mysql.query("delete from wp_posts")
+  mysql.query("delete from wp_postmeta")
+  mysql.query("delete from wp_comments")
+  mysql.query("delete from wp_commentmeta")
+end

data/features/support/env.rb

@@ -0,0 +1,14 @@
+require 'capybara/cucumber'
+require 'selenium/webdriver'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'wordpress-xmlrpc'
+
+require 'mysql'
+
+Capybara.default_driver = :selenium
+Capybara.app_host = "http://localhost"
+Capybara.default_selector = :css
+Capybara.default_wait_time = 3
+Capybara.ignore_hidden_elements = true
+

data/lib/blog.rb

@@ -0,0 +1,61 @@
+require 'xmlrpc/client'
+require 'params_check'
+
+module Wordpress
+  class Blog
+    include ParamsCheck
+    include Loggable
+
+    def initialize(params = {})
+      @blog_uri = URI.parse(check_param(params, :blog_uri))
+
+      @xmlrpc_path = params[:xmlrpc_path] || "xmlrpc"
+
+      @id = params[:blog_id] || 0
+
+      @user = check_param(params, :user)
+
+      @password = check_param(params, :password)
+
+      @client = XMLRPC::Client.new2(URI.join(@blog_uri.to_s, @xmlrpc_path).to_s)
+    end #initialize
+
+    def get_post(post_id)
+      Post.new(api_call("metaWeblog.getPost", post_id, @user, @password))
+    end #get_post
+
+    def recent_posts(number_of_posts)
+      blog_api_call("metaWeblog.getRecentPosts", number_of_posts).collect do |struct|
+        Post.from_struct(struct)
+      end
+    end #recent_posts
+
+    def publish(post)
+      post.id = blog_api_call("metaWeblog.newPost", post.to_struct, true).to_i
+      post.published = true
+    end #publish
+
+    def update_post(post)
+      return api_call("metaWeblog.editPost", post.id, @user, @password, post.to_struct, post.published)
+    end #update_post
+
+    private
+    def api_call(method_name, *args)
+      begin
+        return @client.call(method_name, *args)
+      rescue XMLRPC::FaultException
+        log.log_exception "Error while calling #{method_name}", $!
+        raise APICallException, "Error while calling #{method_name}"
+      end
+    end #api_call
+
+    def blog_api_call(method_name, *args)
+      begin
+        return @client.call(method_name, @id, @user, @password, *args)
+      rescue XMLRPC::FaultException
+        log.log_exception "Error while calling #{method_name}", $!
+        raise APICallException, "Error while calling #{method_name}"
+      end
+    end #call_client
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,3 @@
+module Wordpress
+  class APICallException < StandardError; end
+end

data/lib/loggable.rb

@@ -0,0 +1,20 @@
+require 'log4r'
+require 'pp'
+
+module Loggable
+  Log4r::Logger.class_eval do
+    define_method :log_exception do |message, exception|
+      error {"#{message} (#{exception.message})"}
+      debug {exception.backtrace.pretty_inspect}
+    end
+  end
+
+  def self.included(mod)
+    @@log = Log4r::Logger.new mod.name
+    @@log.outputters = Log4r::Outputter.stdout
+  end #included
+
+  def log
+    @@log
+  end #log
+end

data/lib/params_check.rb

@@ -0,0 +1,6 @@
+module ParamsCheck
+  def check_param(params, param)
+    raise ArgumentError, ":#{param} param is required" unless params[param]
+    params[param]
+  end #check_and_assign
+end

data/lib/post.rb

@@ -0,0 +1,58 @@
+module Wordpress
+  class Post
+    ATTRIBUTE_MATCHES = {
+      :title => :title,
+      :content => :description,
+      :excerpt => :mt_excerpt,
+      :creation_date => :dateCreated,
+      :id => :postid
+    }
+
+    attr_accessor(
+                  :id,
+                  :title,
+                  :content,
+                  :excerpt,
+                  :creation_date,
+                  :published
+                  )
+
+    def initialize(attributes = {})
+      attributes.each do |attribute, value|
+        accessor_name = "#{attribute}="
+        send(accessor_name, value) if respond_to?(accessor_name)
+      end
+    end #initialize
+
+    def self.from_struct(struct)
+      post = Post.new
+      ATTRIBUTE_MATCHES.each do |post_attribute, struct_attribute|
+        post.send("#{post_attribute}=", struct[struct_attribute])
+      end
+      post.published = struct[:post_state] == "publish"
+      post
+    end #self.from_struct
+
+    def to_struct
+      struct = {}
+      ATTRIBUTE_MATCHES.each do |post_attribute, struct_attribute|
+        value = self.send(post_attribute)
+        struct[struct_attribute] = value if value
+      end
+      struct
+    end #to_struct
+
+    def creation_date=(value)
+      case value
+      when String
+        @creation_date = Date.parse(value)
+      when Date
+        @creation_date = value
+      when nil
+        @creation_date = value
+      else
+        raise ArgumentError, "Date or String expected instead of #{value.class.name}"
+      end
+    end #publish_date=
+  end
+end

data/lib/wordpress-xmlrpc.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'loggable'
+
+require 'exceptions'
+require 'blog'
+require 'post'
+
+
+

data/spec/blog_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Wordpress::Blog do
+  describe "initialize" do
+    before(:each) do
+      @valid_params = {
+        :blog_uri => "http://localhost",
+        :user => "admin",
+        :password => "password"
+      }
+    end
+
+    it "should require error without host param provided" do
+      @valid_params.delete :blog_uri
+      lambda{
+        Wordpress::Blog.new(@valid_params)
+      }.should raise_error ArgumentError, ":blog_uri param is required"
+    end
+
+    it "should raise error without user param provided" do
+      @valid_params.delete :user
+      lambda{
+        Wordpress::Blog.new(@valid_params)
+      }.should raise_error ArgumentError, ":user param is required"
+    end
+
+    it "should raise error without password param provided" do
+      @valid_params.delete :password
+      lambda{
+        Wordpress::Blog.new(@valid_params)
+      }.should raise_error ArgumentError, ":password param is required"
+    end
+
+    it "should require valid blog URI" do
+      lambda{
+        Wordpress::Blog.new(:blog_uri => "invalid uri")
+      }.should raise_error URI::InvalidURIError
+    end
+
+    it "should create new blog instance with valid host param provided" do
+      blog = Wordpress::Blog.new(@valid_params)
+      blog.should_not be_nil
+    end
+  end
+
+  describe "api calls" do
+    before(:each) do
+      @client_mock = mock("client")
+      XMLRPC::Client.should_receive(:new2).with("http://localhost/xmlrpc").and_return(@client_mock)
+
+      @blog = Wordpress::Blog.new(
+                                   :blog_uri => "http://localhost",
+                                   :user => "admin",
+                                   :password => "wordpress-xmlrpc",
+                                   :blog_id => 0
+                                   )
+    end
+
+    describe "publish" do
+      it "should make appropriate call to xmlrpc api" do
+
+        post = Wordpress::Post.new(
+                                   :title => "Hey ho",
+                                   :content => "Content",
+                                   :excerpt => "Excerpt",
+                                   :publish_date => Date.parse("01.08.2010"))
+
+        @client_mock.should_receive(:call).with("metaWeblog.newPost", 0, "admin", "wordpress-xmlrpc", post.to_struct, true).and_return("123")
+
+        @blog.publish(post).should be_true
+        post.id.should == 123
+        post.published.should be_true
+      end
+    end
+
+    describe "recent_posts" do
+      it "should make appropriate call to xmlrpc api and return list of posts" do
+        post_structs = (1..10).collect do |index|
+          {
+            :title => "Post #{index}"
+          }
+        end
+
+        @client_mock.should_receive(:call).with("metaWeblog.getRecentPosts", 0, "admin", "wordpress-xmlrpc", 10).and_return(post_structs)
+
+        recent_posts = @blog.recent_posts(10)
+        recent_posts.size.should == 10
+        recent_posts[0].title.should == "Post 1"
+      end
+    end
+
+    describe "get_post" do
+      it "should return post for provided post_id" do
+        post_struct = {
+          :title => "Post title"
+        }
+        @client_mock.should_receive(:call).with("metaWeblog.getPost", 54, "admin", "wordpress-xmlrpc").and_return(post_struct)
+        post = @blog.get_post(54)
+        post.should_not be_nil
+        post.title.should == "Post title"
+      end
+    end
+
+    describe "update_post" do
+      it "should submit post update" do
+        post = Wordpress::Post.new(:id => 54, :title => "Updated post", :published => true)
+        @client_mock.should_receive(:call).with("metaWeblog.editPost", 54, "admin", "wordpress-xmlrpc", post.to_struct, true).and_return(true)
+        @blog.update_post(post).should be_true
+      end
+    end
+  end
+end
+

data/spec/post_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Wordpress::Post do
+  describe "initialize" do
+    it "should populate title from params" do
+      post = Wordpress::Post.new(:title => "Hey ho")
+      post.title.should == "Hey ho"
+    end
+    it "should populate content from params" do
+      post = Wordpress::Post.new(:content => "This is a content")
+      post.content.should == "This is a content"
+    end
+  end
+
+  describe "to_struct" do
+    it "should return struct hash reflecting all post params" do
+      post = Wordpress::Post.new(
+                                 :id => 99,
+                                 :title => "Post title",
+                                 :content => "Post content",
+                                 :excerpt => "Post excerpt",
+                                 :creation_date => Date.parse("01.08.2010")
+                                 )
+      post.to_struct.should == {
+        :postid => 99,
+        :title => "Post title",
+        :description => "Post content",
+        :mt_excerpt => "Post excerpt",
+        :dateCreated => Date.parse("01.08.2010")
+      }
+    end
+    it "should return incomplete struct for params without params that are nil" do
+      post = Wordpress::Post.new(:title => "Post title")
+      post.to_struct.should == {
+        :title => "Post title"
+      }
+    end
+  end
+
+  describe "from_struct" do
+    it "should create post from RPC struct" do
+      post = Wordpress::Post.from_struct({
+                                           :postid => 99,
+                                           :title => "Post title",
+                                           :description => "Post content",
+                                           :mt_excerpt => "Post excerpt",
+                                           :dateCreated => "01.08.2010",
+                                           :post_state => "publish"
+                                         })
+      post.id.should == 99
+      post.title.should == "Post title"
+      post.content.should == "Post content"
+      post.excerpt.should == "Post excerpt"
+      post.creation_date.should == Date.parse("01.08.2010")
+      post.published.should be_true
+    end
+  end
+
+  describe "creation_date=" do
+    before(:each) do
+      @post = Wordpress::Post.new
+    end
+
+    it "should convert string to date" do
+      @post.creation_date = "01.08.2010"
+      @post.creation_date.should == Date.parse("01.08.2010")
+    end
+
+    it "should assign date as is if kind_of? Date provided" do
+      date = Date.parse("01.08.2010")
+      @post.creation_date = date
+      @post.creation_date.should == date
+    end
+
+    it "should raise error if string could not be parsed to date" do
+      lambda{
+        @post.creation_date = "abracadabra"
+      }.should raise_error ArgumentError, "invalid date"
+    end
+
+    it "should raise exception if object is not a string and not a date" do
+      lambda{
+        @post.creation_date = Integer(10)
+      }.should raise_error ArgumentError, "Date or String expected instead of Fixnum"
+    end
+  end
+
+
+
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# to avoid logging while executing tests we need to preload bundled gems
+# and set log level to FATAL
+require 'rubygems'
+require 'bundler/setup'
+require 'log4r'
+# Log4r::Logger.root.level = Log4r::FATAL
+
+require 'spec'
+require 'spec/autorun'
+
+require 'wordpress-xmlrpc'
+
+Spec::Runner.configure do |config|
+
+end

data/wordpress-xmlrpc.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wordpress-xmlrpc}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Naumenko"]
+  s.date = %q{2010-09-15}
+  s.description = %q{Please do not fork it before directly contacint}
+  s.email = %q{alecnmk@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/publish.feature",
+     "features/step_definitions/basic_steps.rb",
+     "features/step_definitions/mysql_steps.rb",
+     "features/support/env.rb",
+     "lib/blog.rb",
+     "lib/exceptions.rb",
+     "lib/loggable.rb",
+     "lib/params_check.rb",
+     "lib/post.rb",
+     "lib/wordpress-xmlrpc.rb",
+     "spec/blog_spec.rb",
+     "spec/post_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "wordpress-xmlrpc.gemspec"
+  ]
+  s.homepage = %q{http://github.com/alecnmk/wordpress-xmlrpc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{This gem is supposed to simplify wordpress xmlrpc interaction}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/blog_spec.rb",
+     "spec/post_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: wordpress-xmlrpc
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Naumenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-15 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Please do not fork it before directly contacint
+email: alecnmk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/publish.feature
+- features/step_definitions/basic_steps.rb
+- features/step_definitions/mysql_steps.rb
+- features/support/env.rb
+- lib/blog.rb
+- lib/exceptions.rb
+- lib/loggable.rb
+- lib/params_check.rb
+- lib/post.rb
+- lib/wordpress-xmlrpc.rb
+- spec/blog_spec.rb
+- spec/post_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- wordpress-xmlrpc.gemspec
+has_rdoc: true
+homepage: http://github.com/alecnmk/wordpress-xmlrpc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem is supposed to simplify wordpress xmlrpc interaction
+test_files: 
+- spec/spec_helper.rb
+- spec/blog_spec.rb
+- spec/post_spec.rb