wrxer 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzliM2Y1YTA1YzY4MTY1MDM5OWMwZGFhMjQxMzY2NjVjNDVlODVlOA==
+  data.tar.gz: !binary |-
+    NWU3NDkzNDUxMGI2Njg5NzA5M2ViYTIxMWNlMjc4ZTg3ZDM5MTQ3Nw==
+SHA512:
+  metadata.gz: !binary |-
+    ODVjYTNkYzA3YzdhNTQwMTFhOTlmZjFiMDc2NmM1MzFlZGVkODVmOTU2MjFk
+    MjJhOGQ4NTRiMjVmMTljNzJjMjlkMDBkNGNjMzdkNWFlNDViNDhhYjI0MmY4
+    YTg5MjAwNDAyYTBhMTRmZTVkNWNlYTM1ODlmMTUwOGJjOGYyZDc=
+  data.tar.gz: !binary |-
+    MjY4MTEyNzFmMTk2OTJkMTFmOGQ4N2M3N2QyZTgwNzM0ZTlhNDM0NGNjNGVl
+    NTRmMWUxNzc3ZTQzNmQ4MWE3NjdkZjhmYjE3MDE3Mjc3ZGY0MzRmYzYwZWU0
+    NWVlMWUzYTNmNDE1MTlkOWViZWEwYzExNWY1NGYzNGQ0YTM3OWY=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.2.0
+deploy:
+  provider: rubygems
+  on:
+    tags: true
+  api_key:
+    secure: HVIv1E7b3qrAKtX6wJBU7KXBKWvKZt3lcBt/rxbOA1CLjPfT3cXwgaBViD0h+RRUnlsAvsOBJqRTzkjdoAH9BBnF0UqAHaVc2q1OO/n3MWB78nxYkqINBEIMNeyjA3exGgRoCxpl9zN62ChAeNkULe7shAlBngP2S3HLwrVgIhE=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wrxer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Patrick Schmitz
+
+MIT License
+
+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.md

@@ -0,0 +1,120 @@
+# Wrxer
+
+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:
+
+```ruby
+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
+
+```ruby
+document = Wrxer.parse("dir/to/export.xml")
+=> #<Wrxer::Document:0x3fd8091d3488> Attributes: ...
+```
+
+### Parse from URI
+
+```ruby
+document = Wrxer.parse_uri("https://raw.githubusercontent.com/bullfight/wrxer/master/spec/fixtures/wrx.xml")
+=> #<Wrxer::Document:0x3fd8091d3488> Attributes: ...
+```
+
+### Reading a parsed document
+
+```ruby
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/wrxer.rb

@@ -0,0 +1,36 @@
+require "wrxer/version"
+require 'nokogiri'
+require 'time'
+require 'json'
+require 'open-uri'
+
+
+require 'wrxer/coercion'
+require 'wrxer/attribute'
+require 'wrxer/wrxer_object'
+require 'wrxer/wrxer_collection'
+
+require 'wrxer/category'
+require 'wrxer/postmeta'
+require 'wrxer/postmeta_collection'
+require 'wrxer/comment'
+require 'wrxer/comment_collection'
+
+require 'wrxer/post'
+require 'wrxer/post_collection'
+require 'wrxer/author'
+require 'wrxer/image'
+require 'wrxer/document'
+
+require 'wrxer/parser'
+require 'wrxer/uri_parser'
+
+module Wrxer
+  def self.parse(file)
+    Parser.new(file).call
+  end
+
+  def self.parse_uri(uri)
+    URIParser.new(uri).call
+  end
+end

data/lib/wrxer/attribute.rb

@@ -0,0 +1,7 @@
+module Wrxer
+  class Attribute < Struct.new(:name, :xpath, :coercion)
+    def call(document, params = {})
+      coercion.call(document, { xpath: xpath })
+    end
+  end
+end

data/lib/wrxer/author.rb

@@ -0,0 +1,10 @@
+module Wrxer
+  class Author < WrxerObject
+    xpath 'wp:author'
+    attribute :login, "wp:author_login"
+    attribute :email, "wp:autor_email"
+    attribute :display_name, "wp:author_display_name"
+    attribute :first_name, "wp:author_first_name"
+    attribute :last_name, "wp:author_last_name"
+  end
+end

data/lib/wrxer/category.rb

@@ -0,0 +1,8 @@
+module Wrxer
+  class Category < WrxerObject
+    xpath 'category'
+    attribute :domain, 'domain', ElementAttribute
+    attribute :nicename, 'nicename', ElementAttribute
+    attribute :body, nil, ChildAttribute
+  end
+end

data/lib/wrxer/coercion.rb

@@ -0,0 +1,60 @@
+module Wrxer
+  class Coercion
+    def self.xpath(value)
+      @xpath = value
+    end
+
+    def self.call(document, params = {})
+      root = @xpath || params[:xpath]
+      unless document.name == root
+        document = document.at_xpath(root)
+      end
+
+      document.nil? ? nil : self.coerce(document)
+    end
+
+    def self.coerce(document)
+      self.new(document)
+    end
+  end
+
+  class TextAttribute < Coercion
+    def self.coerce(document)
+      document.text
+    end
+  end
+
+  class IntegerAttribute < Coercion
+    def self.coerce(document)
+      Integer(document.text)
+    end
+  end
+
+  class TimeAttribute < Coercion
+    def self.coerce(document)
+      Time.parse(document.text)
+    end
+  end
+
+  class ElementAttribute < Coercion
+    def self.call(document, params = {})
+      element = document.attributes[params[:xpath].to_s]
+      element.nil? ? nil : self.coerce(element)
+    end
+
+    def self.coerce(document)
+      document.value
+    end
+  end
+
+  class ChildAttribute < Coercion
+    def self.call(document, params = {})
+      child = document.children
+      child.empty? ? nil : self.coerce(child)
+    end
+
+    def self.coerce(document)
+      document.text
+    end
+  end
+end

data/lib/wrxer/comment.rb

@@ -0,0 +1,16 @@
+module Wrxer
+  class Comment < WrxerObject
+    xpath 'comment'
+    attribute :id, IntegerAttribute
+    attribute :author, "wp:comment_author"
+    attribute :email, "wp:author_email"
+    attribute :url, "wp:author_url"
+    attribute :ip, "wp:author_ip"
+    attribute :published_at, "wp:comment_date_gmt", TimeAttribute
+    attribute :content, "wp:comment_content"
+    attribute :approved, "wp:comment_approved", IntegerAttribute
+    attribute :type, "wp:comment_type"
+    attribute :parent, "wp:comment_parent", IntegerAttribute
+    attribute :user_id, "wp:comment_user_id", IntegerAttribute
+  end
+end

data/lib/wrxer/comment_collection.rb

@@ -0,0 +1,7 @@
+module Wrxer
+  class CommentCollection < WrxerCollection
+    xpath "item"
+    collection :comments, "//wp:comment", Comment
+  end
+end
+

data/lib/wrxer/document.rb

@@ -0,0 +1,17 @@
+module Wrxer
+  class Document < WrxerObject
+    xpath '//channel'
+    attribute :title
+    attribute :link
+    attribute :description
+    attribute :pub_date, "pubDate", TimeAttribute
+    attribute :language
+    attribute :wrx_version, "wp:wrx_version"
+    attribute :base_site_url, "wp:base_site_url"
+    attribute :base_blog_url, "wp:base_blog_url"
+    attribute :author, "wp:author", Author
+    attribute :generator
+    attribute :image, "image", Image
+    attribute :posts, "item", PostCollection
+  end
+end

data/lib/wrxer/image.rb

@@ -0,0 +1,8 @@
+module Wrxer
+  class Image < WrxerObject
+    xpath 'image'
+    attribute :url
+    attribute :title
+    attribute :link
+  end
+end

data/lib/wrxer/parser.rb

@@ -0,0 +1,20 @@
+module Wrxer
+  class Parser
+    attr_reader :filename, :xml_document, :document
+    def initialize(filename)
+      @filename = filename
+
+      File.open(filename) do |file|
+        @xml_document = Nokogiri::XML(file)
+      end
+    end
+
+    def call
+      @document ||= Document.call(@xml_document)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}> { filename: #{@filename.to_path}, xml_document: #{@xml_document.class} }"
+    end
+  end
+end

data/lib/wrxer/post.rb

@@ -0,0 +1,24 @@
+module Wrxer
+  class Post < WrxerObject
+    xpath "item"
+    attribute :title
+    attribute :link
+    attribute :pub_date, "pubDate", TimeAttribute
+    attribute :creator, "dc:creator"
+    attribute :content, "content:encoded"
+    attribute :excerpt, "excerpt:encoded"
+    attribute :id, "wp:post_id", IntegerAttribute
+    attribute :published_at, 'wp:post_date_gmt', TimeAttribute
+    attribute :comment_status, "wp:comment_status"
+    attribute :ping_status, "wp:ping_status"
+    attribute :name, 'wp:post_name'
+    attribute :status, "wp:status"
+    attribute :parent, "wp:post_parent", IntegerAttribute
+    attribute :menu_order, "wp:menu_order", IntegerAttribute
+    attribute :type, "wp:post_type"
+    attribute :is_sticky, "wp:is_sticky", IntegerAttribute
+    attribute :category, "category", Category
+    attribute :postmetas, 'item', PostmetaCollection
+    attribute :comments, 'item', CommentCollection
+  end
+end

data/lib/wrxer/post_collection.rb

@@ -0,0 +1,6 @@
+module Wrxer
+  class PostCollection < WrxerCollection
+    xpath "//channel"
+    collection :posts, "//item", Post
+  end
+end

data/lib/wrxer/postmeta.rb

@@ -0,0 +1,7 @@
+module Wrxer
+  class Postmeta < WrxerObject
+    xpath 'postmeta'
+    attribute :key, "wp:meta_key"
+    attribute :value, "wp:meta_value", IntegerAttribute
+  end
+end