wp-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be8b365075e87e981f79e61c1a7e766cd93d078b
+  data.tar.gz: 4c59262402ba39fa3ab8ce90e6d05b24c3b285b7
+SHA512:
+  metadata.gz: f2658d1c1d13e70bcdcaf28858a8c21c8b980b7a3413df509e99683cb8ab6b9a7274d92005cbd4afffb010341575fc34f67fafee91b1a3c80b3c4057939da8bd
+  data.tar.gz: c55d99f6ff6c9fd6aa2d5c0c58d203dbbe664f7a681f5baa0d142464caf94b6e90c92b0cd5dd3745f3e56840df753b79deb25ce711847e2ec01359095c7e1778

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Colin Young
+
+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,24 @@
+# WP::API
+
+Makes it incredibly easy and semantic to access Wordpress blogs that have the new, RESTful WP API plugin installed.
+
+## Installation
+
+    gem 'wp-api'
+    bundle
+
+## Usage
+
+```ruby
+client = WP::API['yourwpsite.com']
+
+# List all posts
+client.posts
+
+# List all users
+client.users
+```
+
+## Author
+
+@colinyoung

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/wp/api.rb

@@ -0,0 +1,15 @@
+require 'wp/api/version'
+require 'wp/api/resource'
+Dir['lib/wp/api/resources/*.rb'].each {|resource| require resource }
+require 'wp/api/client'
+
+require 'httparty'
+require 'yajl'
+
+module WP
+  module API
+    def self.[](host)
+      Client.new(host: host)
+    end
+  end
+end

data/lib/wp/api/client.rb

@@ -0,0 +1,47 @@
+require 'httparty'
+require 'yajl'
+require 'addressable/uri'
+require 'wp/api/endpoints'
+
+module WP::API
+  class Client
+    include HTTParty
+    include Endpoints
+
+    attr_accessor :host
+
+    def initialize(host:, scheme: 'http')
+      @scheme = scheme
+      @host = host
+      fail ':host is required' unless host.is_a?(String) && host.length > 0
+    end
+
+    protected
+
+    def get(resource, query = {})
+      path = url_for(resource, query)
+      body = Client.get(path).body
+      parse(body)
+    end
+
+    private
+
+    def url_for(fragment, query)
+      url = "#{@scheme}://#{@host}/wp-json/#{fragment}"
+      url << ("?" + params(query)) unless query.empty?
+
+      url
+    end
+
+    def params(query)
+      uri = Addressable::URI.new
+      uri.query_values = query
+      uri.query
+    end
+
+    def parse(string)
+      @parser ||= Yajl::Parser.new
+      @parser.parse(string)
+    end
+  end
+end

data/lib/wp/api/endpoints.rb

@@ -0,0 +1,16 @@
+module WP::API
+  module Endpoints
+
+    def posts(query = {})
+      get("posts", query).collect do |hash|
+        Post.new(hash)
+      end
+    end
+
+    def post(id, query = {})
+      hash = get("posts/#{id}", query)
+      Post.new(hash)
+    end
+
+  end
+end

data/lib/wp/api/resource.rb

@@ -0,0 +1,50 @@
+require 'active_support/inflector'
+
+module WP::API
+  class Resource
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def id
+      @attributes['ID']
+    end
+
+    protected
+
+    def method_missing(key, new_value = nil)
+      key = key.to_s
+      determinant = key[-1]
+      case determinant
+      when '?' # example: post.sticky?
+        @attributes[key.chomp(determinant)] == true
+      when '!' # unsupported
+        fail NoMethodError.new(key)
+      when '=' # example: post.title = 'my new title'
+        @attributes[key.chomp(determinant)] = new_value
+      else
+        # All other values. Hashes are converted to objects
+        # if a resource for them exists (e.g. Authors)
+        object key, @attributes[key]
+      end
+    end
+
+    private
+
+    def to_s
+      @attributes.to_s
+    end
+
+    def object(key, value)
+      klass = key.classify
+      if value.is_a?(Hash) && WP::API.const_defined?(klass)
+        resource = WP::API.const_get(klass)
+        resource.new(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/wp/api/resources/author.rb

@@ -0,0 +1,4 @@
+module WP::API
+  class Author < Resource
+  end
+end

data/lib/wp/api/resources/post.rb

@@ -0,0 +1,4 @@
+module WP::API
+  class Post < Resource
+  end
+end

data/lib/wp/api/version.rb

@@ -0,0 +1,5 @@
+module WP
+  module API
+    VERSION = "0.0.2"
+  end
+end

data/spec/endpoints/post_spec.rb

@@ -0,0 +1,29 @@
+describe WP::API do
+  context "raw HTTP request" do
+    let(:response) { HTTParty.get('http://wp.example.com/wp-json/posts/1').body }
+    let(:file) { support_file('posts/1.json') }
+    subject { parse_json(response) }
+
+    it { should eq parse_json(file) }
+  end
+
+  context "/wp-json/post/:post" do
+
+    let(:client) { WP::API['wp.example.com'] }
+
+    subject { client.post(1) }
+    
+    it "should be a post" do
+      expect(subject).to be_a WP::API::Post
+    end
+
+    it "should have correct IDs" do
+      expect(subject.id).to eq 1
+    end
+
+    it "should have correct author" do
+      expect(subject.author.id).to eq 2
+    end
+  end
+
+end

data/spec/endpoints/posts_spec.rb

@@ -0,0 +1,60 @@
+require 'pry'
+
+describe WP::API do
+  context "raw HTTP request" do
+    let(:response) { HTTParty.get('http://wp.example.com/wp-json/posts').body }
+    let(:file) { support_file('posts.json') }
+    subject { parse_json(response) }
+
+    it { should eq parse_json(file) }
+  end
+
+  context "/wp-json/posts" do
+
+    let(:client) { WP::API['wp.example.com'] }
+
+    subject { client.posts }
+    
+    it "should have size of 2" do
+      expect(subject.size).to eq 2
+    end
+
+    it "should have correct IDs" do
+      expect(subject.collect(&:id)).to match_array [1, 2]
+    end
+
+    it "should have authors" do
+      expect(subject.collect(&:author).size).to eq 2
+    end
+
+    context "first post" do
+      subject do
+        client.posts.find {|p| p.id == 1 }
+      end
+      
+      it "should have boolean methods" do
+        expect(subject.sticky).to eq true
+        expect(subject.sticky?).to eq true
+      end
+
+      it("should have a title") { expect(subject.title).to eq "First post" }
+
+      context "author" do
+        let(:author) { subject.author }
+
+        it "should be converted to author class" do
+          expect(author).to be_a WP::API::Author
+        end
+      end
+
+      context "meta" do
+        let(:meta) { subject.meta }
+
+        it "should not be converted to a class" do
+          expect(meta).to be_a Hash
+        end
+      end
+    end
+
+  end
+end

data/spec/files/posts.json

@@ -0,0 +1,340 @@
+[{
+  "ID": 1,
+  "title": "First post",
+  "status": "publish",
+  "type": "post",
+  "author": {
+    "ID": 2,
+    "username": "test",
+    "name": "Test Testerson",
+    "first_name": "Test",
+    "last_name": "Testerson",
+    "nickname": "test",
+    "slug": "test",
+    "URL": "",
+    "avatar": "http:\/\/0.gravatar.com\/avatar\/55502f40dc8b7c769880b10874abc9d0?s=96",
+    "description": "",
+    "registered": "2014-09-17T17:06:50+00:00",
+    "meta": {
+      "links": {
+        "self": "http:\/\/wp.example.com\/wp-json\/users\/2",
+        "archives": "http:\/\/wp.example.com\/wp-json\/users\/2\/posts"
+      }
+    }
+  },
+  "content": "<p>This is a fox.</p><p><img src=\"http://i.imgur.com/3cTkRwm.gif\" /></p>\n",
+  "parent": 0,
+  "link": "http:\/\/wp.example.com\/what-does-the-fox-say\/",
+  "date": "2014-08-27T21:16:57+00:00",
+  "modified": "2014-08-27T21:16:57+00:00",
+  "format": "standard",
+  "slug": "what-does-the-fox-say",
+  "guid": "http:\/\/wp.example.com\/?p=1",
+  "excerpt": "<p>This is a fox.</p>\n",
+  "menu_order": 0,
+  "comment_status": "open",
+  "ping_status": "closed",
+  "sticky": true,
+  "date_tz": "UTC",
+  "date_gmt": "2014-08-27T21:16:57+00:00",
+  "modified_tz": "UTC",
+  "modified_gmt": "2014-08-27T21:16:57+00:00",
+  "meta": {
+    "links": {
+      "self": "http:\/\/wp.example.com\/wp-json\/posts\/1",
+      "author": "http:\/\/wp.example.com\/wp-json\/users\/2",
+      "collection": "http:\/\/wp.example.com\/wp-json\/posts",
+      "replies": "http:\/\/wp.example.com\/wp-json\/posts\/1\/comments",
+      "version-history": "http:\/\/wp.example.com\/wp-json\/posts\/1\/revisions"
+    }
+  },
+  "featured_image": {
+    "ID": 1,
+    "title": "cover",
+    "status": "inherit",
+    "type": "attachment",
+    "author": {
+      "ID": 1,
+      "username": "admin",
+      "name": "admin",
+      "first_name": "",
+      "last_name": "",
+      "nickname": "admin",
+      "slug": "admin",
+      "URL": "",
+      "avatar": "http:\/\/1.gravatar.com\/avatar\/fbbf698a470d3ece718ec58380668c6b?s=96",
+      "description": "",
+      "registered": "2014-09-17T16:57:26+00:00",
+      "meta": {
+        "links": {
+          "self": "http:\/\/wp.example.com\/wp-json\/users\/1",
+          "archives": "http:\/\/wp.example.com\/wp-json\/users\/1\/posts"
+        }
+      }
+    },
+    "content": "<p class=\"attachment\"><a href='http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg'><img width=\"300\" height=\"300\" src=\"http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-300x300.jpg\" class=\"attachment-medium\" alt=\"Fox\" \/><\/a><\/p>\n",
+    "parent": 0,
+    "link": "http:\/\/wp.example.com\/?attachment_id=1",
+    "date": "2014-08-23T16:47:02+00:00",
+    "modified": "2014-08-23T16:47:02+00:00",
+    "format": "standard",
+    "slug": "cover-18",
+    "guid": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg",
+    "excerpt": "<p>Fox</p>\n",
+    "menu_order": 0,
+    "comment_status": "open",
+    "ping_status": "closed",
+    "sticky": false,
+    "date_tz": "UTC",
+    "date_gmt": "2014-08-23T16:47:02+00:00",
+    "modified_tz": "UTC",
+    "modified_gmt": "2014-08-23T16:47:02+00:00",
+    "meta": {
+      "links": {
+        "self": "http:\/\/wp.example.com\/wp-json\/media\/1",
+        "author": "http:\/\/wp.example.com\/wp-json\/users\/1",
+        "collection": "http:\/\/wp.example.com\/wp-json\/media",
+        "replies": "http:\/\/wp.example.com\/wp-json\/media\/1\/comments",
+        "version-history": "http:\/\/wp.example.com\/wp-json\/media\/1\/revisions"
+      }
+    },
+    "terms": [],
+    "source": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg",
+    "is_image": true,
+    "attachment_meta": {
+      "width": 700,
+      "height": 700,
+      "file": "2014\/08\/cover.jpg",
+      "sizes": {
+        "thumbnail": {
+          "file": "cover-150x150.jpg",
+          "width": 150,
+          "height": 150,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-150x150.jpg"
+        },
+        "medium": {
+          "file": "cover-300x300.jpg",
+          "width": 300,
+          "height": 300,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-300x300.jpg"
+        },
+        "post-thumbnail": {
+          "file": "cover-672x372.jpg",
+          "width": 672,
+          "height": 372,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-672x372.jpg"
+        },
+        "twentyfourteen-full-width": {
+          "file": "cover-700x576.jpg",
+          "width": 700,
+          "height": 576,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-700x576.jpg"
+        }
+      },
+      "image_meta": {
+        "aperture": 0,
+        "credit": "",
+        "camera": "",
+        "caption": "",
+        "created_timestamp": 0,
+        "copyright": "",
+        "focal_length": 0,
+        "iso": 0,
+        "shutter_speed": 0,
+        "title": "",
+        "orientation": 1
+      }
+    }
+  },
+  "terms": {
+    "post_tag": [{
+      "ID": 1,
+      "name": "animals",
+      "slug": "animals",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/tag\/animals\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/1"
+        }
+      }
+    }]
+  }
+},
+{
+  "ID": 2,
+  "title": "Second post",
+  "status": "publish",
+  "type": "post",
+  "author": {
+    "ID": 3,
+    "username": "other",
+    "name": "Other Author",
+    "first_name": "Other",
+    "last_name": "Author",
+    "nickname": "other",
+    "slug": "other-author",
+    "URL": "",
+    "avatar": "http:\/\/0.gravatar.com\/avatar\/55502f40dc8b7c769880b10874abc9d0?s=96",
+    "description": "",
+    "registered": "2014-09-17T17:06:50+00:00",
+    "meta": {
+      "links": {
+        "self": "http:\/\/wp.example.com\/wp-json\/users\/3",
+        "archives": "http:\/\/wp.example.com\/wp-json\/users\/3\/posts"
+      }
+    }
+  },
+  "content": "<p>This is a car.</p><p><img src=\"http://i.imgur.com/i6DYBd6.gif\" /></p>\n",
+  "parent": 0,
+  "link": "http:\/\/wp.example.com\/car-hit-by-green-shell\/",
+  "date": "2014-08-27T21:16:57+00:00",
+  "modified": "2014-08-27T21:16:57+00:00",
+  "format": "standard",
+  "slug": "car-hit-by-green-shell",
+  "guid": "http:\/\/wp.example.com\/?p=2",
+  "excerpt": "<p>This is a car.</p>\n",
+  "menu_order": 0,
+  "comment_status": "open",
+  "ping_status": "closed",
+  "sticky": false,
+  "date_tz": "UTC",
+  "date_gmt": "2014-08-27T21:16:57+00:00",
+  "modified_tz": "UTC",
+  "modified_gmt": "2014-08-27T21:16:57+00:00",
+  "meta": {
+    "links": {
+      "self": "http:\/\/wp.example.com\/wp-json\/posts\/1",
+      "author": "http:\/\/wp.example.com\/wp-json\/users\/2",
+      "collection": "http:\/\/wp.example.com\/wp-json\/posts",
+      "replies": "http:\/\/wp.example.com\/wp-json\/posts\/1\/comments",
+      "version-history": "http:\/\/wp.example.com\/wp-json\/posts\/1\/revisions"
+    }
+  },
+  "featured_image": {
+    "ID": 1,
+    "title": "cover",
+    "status": "inherit",
+    "type": "attachment",
+    "author": {
+      "ID": 1,
+      "username": "admin",
+      "name": "admin",
+      "first_name": "",
+      "last_name": "",
+      "nickname": "admin",
+      "slug": "admin",
+      "URL": "",
+      "avatar": "http:\/\/1.gravatar.com\/avatar\/fbbf698a470d3ece718ec58380668c6b?s=96",
+      "description": "",
+      "registered": "2014-09-17T16:57:26+00:00",
+      "meta": {
+        "links": {
+          "self": "http:\/\/wp.example.com\/wp-json\/users\/2",
+          "archives": "http:\/\/wp.example.com\/wp-json\/users\/2\/posts"
+        }
+      }
+    },
+    "content": "<p class=\"attachment\"><a href='http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg'><img width=\"300\" height=\"300\" src=\"http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-300x300.jpg\" class=\"attachment-medium\" alt=\"Fox\" \/><\/a><\/p>\n",
+    "parent": 0,
+    "link": "http:\/\/wp.example.com\/?attachment_id=1",
+    "date": "2014-08-23T16:47:02+00:00",
+    "modified": "2014-08-23T16:47:02+00:00",
+    "format": "standard",
+    "slug": "cover-18",
+    "guid": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg",
+    "excerpt": "<p>Fox</p>\n",
+    "menu_order": 0,
+    "comment_status": "open",
+    "ping_status": "closed",
+    "sticky": false,
+    "date_tz": "UTC",
+    "date_gmt": "2014-08-23T16:47:02+00:00",
+    "modified_tz": "UTC",
+    "modified_gmt": "2014-08-23T16:47:02+00:00",
+    "meta": {
+      "links": {
+        "self": "http:\/\/wp.example.com\/wp-json\/media\/1",
+        "author": "http:\/\/wp.example.com\/wp-json\/users\/1",
+        "collection": "http:\/\/wp.example.com\/wp-json\/media",
+        "replies": "http:\/\/wp.example.com\/wp-json\/media\/1\/comments",
+        "version-history": "http:\/\/wp.example.com\/wp-json\/media\/1\/revisions"
+      }
+    },
+    "terms": [],
+    "source": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover.jpg",
+    "is_image": true,
+    "attachment_meta": {
+      "width": 700,
+      "height": 700,
+      "file": "2014\/08\/cover.jpg",
+      "sizes": {
+        "thumbnail": {
+          "file": "cover-150x150.jpg",
+          "width": 150,
+          "height": 150,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-150x150.jpg"
+        },
+        "medium": {
+          "file": "cover-300x300.jpg",
+          "width": 300,
+          "height": 300,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-300x300.jpg"
+        },
+        "post-thumbnail": {
+          "file": "cover-672x372.jpg",
+          "width": 672,
+          "height": 372,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-672x372.jpg"
+        },
+        "twentyfourteen-full-width": {
+          "file": "cover-700x576.jpg",
+          "width": 700,
+          "height": 576,
+          "mime-type": "image\/jpeg",
+          "url": "http:\/\/wp.example.com\/wp-content\/uploads\/2014\/08\/cover-700x576.jpg"
+        }
+      },
+      "image_meta": {
+        "aperture": 0,
+        "credit": "",
+        "camera": "",
+        "caption": "",
+        "created_timestamp": 0,
+        "copyright": "",
+        "focal_length": 0,
+        "iso": 0,
+        "shutter_speed": 0,
+        "title": "",
+        "orientation": 1
+      }
+    }
+  },
+  "terms": {
+    "post_tag": [{
+      "ID": 2,
+      "name": "cars",
+      "slug": "cars",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/tag\/cars\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/2"
+        }
+      }
+    }]
+  }
+}]