Project

wrxer

0.0
No commit activity in last 3 years
No release in over 3 years
Parse a wordpress WRX export document
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
>= 0
~> 10.0
~> 3.2.0

Runtime

~> 1.6.6
 Project Readme

Wrxer

Build Status

This gem is a simple parser for Wordpress eXtended RSS. At the moment it supports many of the parameters related to posts, it doesn't currenly support page exports.

The document and its attributes can be easily converted to json or a ruby hash by calling #to_hash or #to_json. Collections like PostCollection, PostmetaCollection, and CommentCollection are returned as lazy enuemrables when converting the document to a hash or json, but can be enumerated to retrieve the hash or json objects.

Installation

Add this line to your application's Gemfile:

gem 'wrxer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wrxer

Usage

Wrxer can be user to parse posts from a Wordpress export. Take a look at lib/wrxer/post to see which attributes are supported.

Parse from File

document = Wrxer.parse("dir/to/export.xml")
=> #<Wrxer::Document:0x3fd8091d3488> Attributes: ...

Parse from URI

document = Wrxer.parse_uri("https://raw.githubusercontent.com/bullfight/wrxer/master/spec/fixtures/wrx.xml")
=> #<Wrxer::Document:0x3fd8091d3488> Attributes: ...

Reading a parsed document

document = Wrxer.parse("export.xml")
=> #<Wrxer::Document:0x3fd8091d3488> Attributes: {
  "title": "Wrxer News",
  "link": "https://wrxernews.wordpress.com",
  "description": "The Most Reliable Source For Wrxer News Since 2007.",
  "pub_date": "2015-03-24 21:18:58 +0000",
  "language": "en",
  "wrx_version": null,
  "base_site_url": "http://wordpress.com/",
  "base_blog_url": "https://wrxernews.wordpress.com",
  "author": {
    "login": "wrxernews",
    "email": null,
    "display_name": "Wrxer News",
    "first_name": "",
    "last_name": ""
  },
  "generator": "http://wordpress.com/",
  "image": {
    "url": "https://secure.gravatar.com/blavatar/foobar",
    "title": " ยป Wrxer News",
    "link": "https://wrxernews.wordpress.com"
  },
  "posts": {
    "data": "#<Enumerator::Lazy:0x007fb01303ee20>"
  }
}

post = document.posts.first
=> #<Wrxer::Post:0x3fd4799693ac> Attributes: {
  "title": "Welcome To Wrxer News.",
  "link": "https://wrxernews.wordpress.com/2007/11/17/welcome-to-wrxer-news/",
  "pub_date": "2007-11-17 21:30:51 +0000",
  "creator": "wrxernews",
  "content": "Welcome to <strong>Wrxer News</strong> - The most up-to-date and reliable source for Wrxer news.",
  "excerpt": "Excerpt Text",
  "id": 3,
  "published_at": "2007-11-17 21:30:51 -0800",
  "comment_status": "open",
  "ping_status": "open",
  "name": "welcome-to-wrxer-news",
  "status": "publish",
  "parent": 0,
  "menu_order": 0,
  "type": "post",
  "is_sticky": 0,
  "category": {
    "domain": "category",
    "nicename": "wrxer-news",
    "body": "Wrxer News"
  },
  "postmetas": {
    "data": "#<Enumerator::Lazy:0x007fa8f315a970>"
  },
  "comments": {
    "data": "#<Enumerator::Lazy:0x007fa8f315a3f8>"
  }
}
post.title
=> "Welcome To Wrxer News."

Contributing

  1. Fork it ( https://github.com/[my-github-username]/wrxer/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request