rubypress

This implements the WordPress XML RPC API as released in version 3.4.

WARNING: SSL is NOT enabled by default for ease of testing for those running OS X systems without setup SSL certs. If this is important to you, checkout the options for instantiating a new client where you can set :use_ssl to true.

Getting Started

Install the gem

A. To your system

gem install rubypress

B. Or using Bundler

Inside your Gemfile:

gem 'rubypress'

Create a new client

> wp = Rubypress::Client.new(:host => "yourwordpresssite.com", :username => "yourwordpressuser@wordpress.com", :password => "yourwordpresspassword")

Make requests based off of the WordPress XML RPC API Documentation

> wp.getOptions

=> {"software_name"=>{"desc"=>"Software Name", "readonly"=>true, "value"=>"WordPress"}

(just a small excerpt of actual options for the sake of the whole brevity thing)

> wp.newPost(:blog_id => "your_blog_id", :content => { :post_status => "publish", :post_date => Time.now, :post_content => "What an awesome post", :post_title => "Woo Title" })  
=> "24"

(returns a post ID if post was successful)

To make further requests, check out the documentation - this gem should follow the exact format of the WordPress XML RPC API. For even further clarification on what requests are available, take a look in the spec folder.

NOTE: If your xmlrpc.php is not on the host root directory, you need to specify it's path. For example, to connect to myhostedwordpresssite.net/path/to/blog:

wp = Rubypress::Client.new(:host => "myhostedwordpresssite.net",
                           :path => "/path/to/blog/xmlrpc.php",
                           :username => "yourwordpressuser@wordpress.com",
                           :password => "yourwordpresspassword")

Contributing to rubypress

Pull requests welcome.

Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
Fork the project.
Start a feature/bugfix branch.
Commit and push until you are happy with your contribution.
Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
Submit a pull request

Environment Variables

The test suite requires that the following environment variables

WORDPRESS_HOST
WORDPRESS_USERNAME
WORDPRESS_PASSWORD

Optionally, you can create a file in the working directory called .env and add the following to it:

WORDPRESS_HOST=myhostedwordpresssite.net
WORDPRESS_USERNAME=yourwordpressuser@wordpress.com
WORDPRESS_PASSWORD=yourwordpresspassword

When RSpec runs it will set the environment variables for you.

Credits

Zach Feldman @zachfeldman
Dan Collis-Puro @djcp

Contributors

Abdelkader Boudih @seuros (Removed deep_merge monkeypatch if ActiveSupport is defined, small refactors)
Alex Dantas @alexdantas (README edits re: host option)
Pacop @pacop (Added a far easier way to upload files than the default method chain.)
David Muto @pseudomoto (Added ability to use a .env file.)

License

Licensed under the same terms as WordPress itself - GPLv2.