wp-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a72d49b5150ec356d93679a0327a678dfe1cb2a
-  data.tar.gz: ac756f4350f9fce2b2dc42f1b77b631401deb884
+  metadata.gz: cb4a7bec44ae84c2ca08e6cb7dcb6f646c90f3aa
+  data.tar.gz: dfe857f61cd26b4f2310415d0a53d1a97f59506d
 SHA512:
-  metadata.gz: 3f56e888f106c21ac212a0454e90b7836ba5cc9a5d3671b91c4512f7b0dd4fae9ca1038099be7271b7c6e2173864f1e323f46611ab62f798b3cb49b6dc13f424
-  data.tar.gz: d72cdba3386dcffaad68f8375f09e9fa3e29e21ef0b2c8ccdc9139e2a6db2bc65c9d63b158aaac2ee000ff563000e8a9cc72b1c516e85e6af6bbdbdafaf5e6fc
+  metadata.gz: 6001d3d7ebb517b4d79fa29de3c2ec3a28f9a613230cce957e35201534edbc49204c9510f495fa1f1f6aa4d6af6507a27e71c729b62b2c6a6106ee097fc7cc7b
+  data.tar.gz: 853132092fe77cea5bf06004d2a6d8377fa3fa498d4459c01f9942331f99c00950adf2881c877029d5b87ab6ad93a034dd6ef0f04dccde04ce4e1188bb075826

data/README.md

@@ -2,7 +2,7 @@
 
 [![Circle CI](https://circleci.com/gh/colinyoung/wp-api.png?style=badge)](https://circleci.com/gh/colinyoung/wp-api)
 
-Makes it incredibly easy and semantic to access Wordpress blogs that have the new, RESTful WP API plugin installed.
+Makes it incredibly easy and semantic to access Wordpress blogs that have the [WP REST API plugin](http://wp-api.org/) installed (which is planned for full integration into wordpress core soon.)
 
 ## Installation
 
@@ -23,6 +23,16 @@ client.posts
 
 # List all users
 client.users
+
+# List alternate post types
+client.posts(type: 'custom_posts')
+
+# Append paramters
+client.posts(posts_per_page: 1000)
+
+# Use basic auth (used to access post meta)
+client = WP::API::Client.new(host: 'yourwpsite.com', scheme: 'https', user: 'api', password: 'apipassword')
+client.post_meta(1234) # => metadata for post #1234
 ```
 
 ## Author

data/lib/wp/api/client.rb

@@ -10,19 +10,34 @@ module WP::API
 
     attr_accessor :host
 
-    def initialize(host:, scheme: 'http')
+    DIRECT_PARAMS = %w(type context filter)
+
+    def initialize(host:, scheme: 'http', user: nil, password: nil)
       @scheme = scheme
       @host = host
+      @user = user
+      @password = password
+
       fail ':host is required' unless host.is_a?(String) && host.length > 0
     end
 
+    def inspect
+      to_s.sub(/>$/, '') + " @scheme=\"#{@scheme}\" @host=\"#{@host}\" @user=\"#{@user}\" @password=#{@password.present?}>"
+    end
+
     protected
 
     def get(resource, query = {})
       query = ActiveSupport::HashWithIndifferentAccess.new(query)
       path = url_for(resource, query)
-      response = Client.get(path)
-      if response.empty?
+      
+      response = if authenticate?
+        Client.get(path, basic_auth: { username: @user, password: @password })
+      else
+        Client.get(path)
+      end
+
+      if response.code != 200
         raise WP::API::ResourceNotFoundError
       else
         [ response.parsed_response, response.headers ] # Already parsed.
@@ -31,6 +46,10 @@ module WP::API
 
     private
 
+    def authenticate?
+      @user && @password
+    end
+
     def url_for(fragment, query)
       url = "#{@scheme}://#{@host}/wp-json/#{fragment}"
       url << ("?" + params(query)) unless query.empty?
@@ -42,6 +61,7 @@ module WP::API
       uri = Addressable::URI.new
       filter_hash = { page: query.delete('page') || 1 }
       query.each do |key, value|
+        filter_hash[key] = value if DIRECT_PARAMS.include?(key) || key.include?('[')
         filter_hash["filter[#{key}]"] = value
       end
       uri.query_values = filter_hash

data/lib/wp/api/endpoints.rb

@@ -13,6 +13,10 @@ module WP::API
       resource_named('posts', slug)
     end
 
+    def post_meta(id, query = {})
+      resource_subpath('posts', id, 'meta', query).first
+    end
+
     def pages(query = {})
       resources('pages', query)
     end
@@ -38,6 +42,10 @@ module WP::API
       resource_class(res).new *get("#{res}/#{id}", query)
     end
 
+    def resource_subpath(res, id, subpath, query = {})
+      get("#{res}/#{id}/#{subpath}", query).first
+    end
+
     def resource_named(res, slug)
       resources(res, name: slug).first
     end

data/lib/wp/api/resource.rb

@@ -14,6 +14,11 @@ module WP::API
       attributes['ID']
     end
 
+    def meta(client = nil)
+      return super unless client
+      client.post_meta(id)
+    end
+
     protected
 
     def method_missing(key, new_value = nil)

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

@@ -14,6 +14,10 @@ module WP::API
       terms['category'].collect {|cat| WP::API::Category.new(cat) }
     end
 
+    def tags
+      terms['post_tag'].collect {|cat| WP::API::Tag.new(cat) }
+    end
+
     def prev
       item = link_header_items.find {|rel, url| rel == "prev" }
       item.last if item

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

@@ -0,0 +1,7 @@
+module WP::API
+  class Tag < Resource
+    def to_param
+      slug
+    end
+  end
+end

data/lib/wp/api/version.rb

@@ -1,5 +1,5 @@
 module WP
   module API
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wp-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Colin Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -181,6 +181,7 @@ files:
 - lib/wp/api/resources/category.rb
 - lib/wp/api/resources/page.rb
 - lib/wp/api/resources/post.rb
+- lib/wp/api/resources/tag.rb
 - lib/wp/api/version.rb
 - spec/endpoints/post_spec.rb
 - spec/endpoints/posts_spec.rb