wordpress-client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTk2MTYzZDY4YWZlNjM1MTdlNTFmN2FmNjM2YmMxOWIyNjE4NDQ2NQ==
+    Y2Y4ZTExNTEwZTYwOGFhYTEyMmFkNGNiNDVmYmIyM2QyM2QwMjZkMw==
   data.tar.gz: !binary |-
-    ZTRiNTI2ZDEyNDUyY2NhMDIyNWRjOTBjMGNmYjYwZmRjZTJkYjFhMA==
+    MzgwMjkyOWQ4OTUxODQ4M2YyMWQ5MzBmZWViZjc3YWU0NjE3OTFkOQ==
 SHA512:
   metadata.gz: !binary |-
-    YjJhOTg1YWQyNDYxOWI3NjA3NmNjOGExMmJlMDJiNGJmNDc2ODQ3ZDFiNjE3
-    OTUzYzUzYzc3NDNhZTI4YjE2NmFlYmZjNjMxOTM4MGNiMGM2MmYzODM1NWE4
-    ODQwZDc2NTFiMDc1MDExZGZlOTFmN2JlYWFhNGMyZmMwYjVmMDM=
+    MTFiZWQxODg0YWNlMzU4NjA0M2ZhYTQ2ZWYyNDFlZmJmM2RhYjMxZDQ2NWUw
+    NjgyNjQ3YTJmOWM2ZDE0ODEwZWFhOGEyNDgxZmY2OGM2NGQ5YjVhYTUwZjlh
+    N2VjZjg0MGU1ODJjNjkyMzhjYTU0NGQxYjMzMTg5ZDQ5YTBmYmI=
   data.tar.gz: !binary |-
-    NDUzYzI3OWE2ZDAyMTkyNTBiNWQwYmRmOTcyNTk0MDY1MWIzYzdiNWUxYjc1
-    ZmQwZWFiZGFiYzY0N2FiNzQ3MDc4NWViNzQ2MDA2NjNjZTUzNDM1OTBmYTZj
-    YzhhN2I4ODI1OWNjN2Q4MWZhYjQ2ZDE3YTEyZWQ2OWJhMWM3MGM=
+    NDRiODQ4ZmQ2NWMzZjQyZDBkNGJkOTQxMDUyMGJlZTJjZTVjMDI3ODA3ZTAy
+    ZDY2ZDI3MzU5NDE2OGEyYzZmZGVlZGI1MzdhYTUwZTI1NjA0NmJkYWIzZjcy
+    MGM2NjVlZjRiNmZjN2I5OTE4ZGYwMDY2NTAzMzBjNGMzM2VjZDQ=

data/README.md

@@ -1,4 +1,57 @@
-wordpress
-=========
+# wordpress-client
 
-Wordpress API Wrapper
+wordpress-client is a [Wordpress Rest API Wrapper](http://developer.wordpress.com/docs/api/).
+
+## Getting started
+
+Add wordpress-client to your `Gemfile` and `bundle install`:
+
+```ruby
+gem 'wordpress-client'
+```
+
+## Usage
+
+```ruby
+require 'wordpress-client'
+
+# Get user by access token
+client = Wordpress.client
+client.access_token = 'YOUR_ACCESS_TOKEN' # if you have any
+user = client.me
+site = user.site
+posts = site.posts
+
+# Get posts of a specific domain without access token
+client = Wordpress::Client.new
+posts = client.get_posts('wordpress-site-domain')
+posts.each do |post|
+  # Do something
+end
+
+# Get all the posts of a specific domain without access token
+client = Wordpress::Client.new
+page = 1
+loop do
+  posts = client.get_posts('wordpress-site-domain', :page => page)
+  posts.each do |post|
+    # Do something
+  end
+  break if posts.size == 0
+  page += 1
+end
+```
+
+## TODO
+- Complete spec test
+- Support all the apis
+- Support create/update/delete from Wordpress::Object
+- Add oauth method
+
+## Contributing
+
+See the [contributing guide](https://github.com/dtaniwaki/wordpress-client/blob/master/CONTRIBUTING.md).
+
+## Copyright
+
+Copyright (c) 2010-2013 Daisuke Taniwaki. See LICENSE for details.

data/lib/wordpress/api.rb

@@ -1,6 +1,7 @@
 require 'wordpress/api/me'
 require 'wordpress/api/sites'
 require 'wordpress/api/posts'
+require 'wordpress/api/comments'
 require 'wordpress/api/tests'
 
 module Wordpress
@@ -10,6 +11,7 @@ module Wordpress
         include Wordpress::API::Me
         include Wordpress::API::Sites
         include Wordpress::API::Posts
+        include Wordpress::API::Comments
         include Wordpress::API::Tests
       end
     end

data/lib/wordpress/api/comments.rb

@@ -2,36 +2,36 @@ require 'wordpress/api/utils'
 
 module Wordpress
   module API
-    module Posts
+    module Comments
       include Wordpress::API::Utils
 
       def get_comments(site, params = {})
-        validate_params! params, [:context, :type, :status], :search
+        validate_params! params, [:context, :type, :status] + default_keys + search_keys
         object_from_response Wordpress::Object::Comments.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/comments", params)
       end
 
       def get_post_comments(site, post_id, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Comments.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/#{post_id}/replies", params)
       end
 
       def get_comment(site, comment_id, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Comment.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/comments/#{comment_id}", params)
       end
 
       def update_comment(site, comment_id, data, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Comment.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/comments/#{comment_id}", params, data)
       end
 
       def create_comment(site, post_id, data, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Comment.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}/replies/new", params, data)
       end
 
       def delete_comment(site, comment_id, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Comment.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/comments/#{comment_id}/delete", params)
       end
     end

data/lib/wordpress/api/me.rb

@@ -6,12 +6,12 @@ module Wordpress
       include Wordpress::API::Utils
 
       def me(params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::Object::User.new(self), Wordpress::Request.new(:get, "/rest/v1/me", params)
       end
 
       def get_my_likes(params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:get, "/rest/v1/me/likes", params)
       end
     end

data/lib/wordpress/api/posts.rb

@@ -6,62 +6,62 @@ module Wordpress
       include Wordpress::API::Utils
 
       def get_posts(site, params = {})
-        validate_params! params, [:context, :tag, :category, :type, :status, :sticky, :author, :search, :meta_key, :meta_value], :search
+        validate_params! params, [:context, :tag, :category, :type, :status, :sticky, :author, :search, :meta_key, :meta_value] + default_keys + search_keys
         object_from_response Wordpress::Object::Posts.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts", params)
       end
 
       def get_post(site, post_id, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Post.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/#{post_id}", params)
       end
 
       def update_post(site, post_id, data, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Post.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}", params, data)
       end
 
       def get_post_by_slug(site, post_slug, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context] + default_keys
         object_from_response Wordpress::Object::Post.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/slug:#{post_slug}", params)
       end
 
       def create_post(site, post_id, data, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context], default_keys
         object_from_response Wordpress::Object::Post.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/new", params, data)
       end
 
       def delete_post(site, post_id, params = {})
-        validate_params! params, [:context]
+        validate_params! params, [:context], default_keys
         object_from_response Wordpress::Object::Post.new(self), Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}/delete", params)
       end
 
       def get_likes(site, post_id, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/#{post_id}/likes", params)
       end
 
       def create_like(site, post_id, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}/likes/new", params)
       end
 
       def delete_like(site, post_id, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}/likes/mine/delete", params)
       end
 
       def get_like_status(site, post_id, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/#{post_id}/likes/mine", params)
       end
 
       def get_reblog_status(site, post_id, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:get, "/rest/v1/sites/#{site}/posts/#{post_id}/reblogs/mine", params)
       end
 
       def create_reblog(site, post_id, data, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::OpenStruct.new, Wordpress::Request.new(:post, "/rest/v1/sites/#{site}/posts/#{post_id}/reblogs/new", params, data)
       end
     end

data/lib/wordpress/api/sites.rb

@@ -6,7 +6,7 @@ module Wordpress
       include Wordpress::API::Utils
 
       def get_site(site, params = {})
-        validate_params! params
+        validate_params! params, default_keys
         object_from_response Wordpress::Object::Site.new(self), Wordpress::Request.new(:get, "/rest/v1/sites/#{site}", params)
       end
     end

data/lib/wordpress/api/tests.rb

@@ -6,14 +6,20 @@ module Wordpress
       include Wordpress::API::Utils
 
       def get_test(id, params = {})
-        validate_params! params, [:id, :default_string, :default_int, :boolean_whitelist_defaults_to_false, :boolean_whitelist_defaults_to_true, :string_whitelist_defaults_to_foo, :url, :datetime], :test
+        validate_params! params, test_keys
         object_from_response Wordpress::Object::Test.new(self), Wordpress::Request.new(:get, "/rest/v1/test/#{id}", params)
       end
 
       def post_test(id, params = {})
-        validate_params! params, [:id, :default_string, :default_int, :boolean_whitelist_defaults_to_false, :boolean_whitelist_defaults_to_true, :string_whitelist_defaults_to_foo, :url, :datetime], :test
+        validate_params! params, test_keys
         object_from_response Wordpress::Object::Test.new(self), Wordpress::Request.new(:post, "/rest/v1/test/#{id}",  params)
       end
+
+      private
+
+      def test_keys
+        [:id, :default_string, :default_int, :boolean_whitelist_defaults_to_false, :boolean_whitelist_defaults_to_true, :string_whitelist_defaults_to_foo, :url, :datetime]
+      end
     end
   end
 end

data/lib/wordpress/api/utils.rb

@@ -26,11 +26,17 @@ module Wordpress
 
       private
 
-      def validate_params!(params, valid_keys = [], type = nil)
-        valid_keys += [:http_envelope, :pretty, :callback] if type != :test
-        valid_keys += [:number, :offset, :page, :order, :order_by, :after, :before] if type == :search
+      def default_keys
+        [:http_envelope, :pretty, :callback]
+      end
+
+      def search_keys
+        [:number, :offset, :page, :order, :order_by, :after, :before]
+      end
+
+      def validate_params!(params, valid_keys = [])
         params.keys.each do |key|
-          raise RuntimeError, "#{key} is not valid for this method." unless valid_keys.include?(key)
+          raise Wordpress::ArgumentError, "#{key} is not valid for this method." unless valid_keys.include?(key)
         end
       end
     end

data/lib/wordpress/client.rb

@@ -27,7 +27,7 @@ module Wordpress
         req.url request.url
         req.params = request.params
         req.body = request.body.to_s
-        if options.delete(:bearer_token_request) && !access_token.nil?
+        if options[:bearer_token_request] && !bearer_auth_header.nil?
           req.headers['Authorization'] = bearer_auth_header
         end
         req.headers['Accept-Encoding'] = 'gzip,deflate'
@@ -44,7 +44,7 @@ module Wordpress
     private
 
     def bearer_auth_header
-      "Bearer #{access_token}"
+      access_token.nil? ? nil : "Bearer #{access_token}"
     end
   end
 end

data/lib/wordpress/errors.rb

@@ -1,14 +1,25 @@
 module Wordpress
-  class ResponseError < StandardError
-    attr_reader :error, :message
+  class Error < ::StandardError
+    attr_reader :message
 
-    def initialize(json = {})
-      @error = json['error'] || 'unknown'
-      @message = json['message']
+    def initialize(message = nil)
+      @message = message
     end
 
     def to_s
       @message
     end
   end
+
+  class ResponseError < Error
+    attr_reader :error
+
+    def initialize(json = {})
+      @error = json['error'] || 'unknown'
+      super json['message']
+    end
+  end
+
+  class ArgumentError < Error
+  end
 end

data/lib/wordpress/ostruct.rb

@@ -2,7 +2,7 @@ require 'wordpress/base'
 
 module Wordpress
   class OpenStruct < Base
-    def_delegators :@hash, :map, :each
+    def_delegators :@hash, :map, :each, :any?, :all?, :size
 
     def initialize(hash = {})
       assign(hash)
@@ -19,7 +19,7 @@ module Wordpress
     end
 
     def to_s
-      "#<#{self.class.name} #{map { |k, v| "#{k}=#{v}" }.join(" ")}>"
+      "#<#{self.class.name} #{@hash.keys.map{ |k| "#{k}=#{send(k).to_s}" }.join(" ")}>"
     end
 
     def [](k)

data/lib/wordpress/version.rb

@@ -2,7 +2,7 @@ module Wordpress
   class Version
     MAJOR = 0 unless defined? Wordpress::Version::MAJOR
     MINOR = 1 unless defined? Wordpress::Version::MINOR
-    PATCH = 3 unless defined? Wordpress::Version::PATCH
+    PATCH = 4 unless defined? Wordpress::Version::PATCH
     PRE = nil unless defined? Wordpress::Version::PRE
 
     class << self

data/spec/wordpress/api_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require 'wordpress/api'
+
+describe Wordpress::API do
+  let :client do
+    Wordpress::Client.new
+  end
+
+  # Get methods
+  {
+    'me' => {:args => [], :method => :get, :url => '/rest/v1/me', :response => Wordpress::Object::User},
+    'get_my_likes' => {:args => [], :method => :get, :url => '/rest/v1/me/likes', :response => Wordpress::OpenStruct},
+    'get_posts' => {:args => ['sitename'], :method => :get, :url => '/rest/v1/sites/sitename/posts', :response => Wordpress::Object::Posts},
+    'get_post' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/1', :response => Wordpress::Object::Post},
+    'get_post_by_slug' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/slug:1', :response => Wordpress::Object::Post},
+    'get_likes' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/1/likes', :response => Wordpress::OpenStruct},
+    'get_like_status' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/1/likes/mine', :response => Wordpress::OpenStruct},
+    'get_reblog_status' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/1/reblogs/mine', :response => Wordpress::OpenStruct},
+    'get_site' => {:args => ['sitename'], :method => :get, :url => '/rest/v1/sites/sitename', :response => Wordpress::Object::Site},
+    'get_comments' => {:args => ['sitename'], :method => :get, :url => '/rest/v1/sites/sitename/comments', :response => Wordpress::Object::Comments},
+    'get_post_comments' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/posts/1/replies', :response => Wordpress::Object::Comments},
+    'get_comment' => {:args => ['sitename', 1], :method => :get, :url => '/rest/v1/sites/sitename/comments/1', :response => Wordpress::Object::Comment},
+    'get_test' => {:args => [1], :method => :get, :url => '/rest/v1/test/1', :response => Wordpress::Object::Test},
+  }.each do |method, params|
+    describe "\##{method}" do
+      it "should return #{params[:response].name}" do
+        request = Wordpress::Request.new(params[:method], params[:url])
+        client.stub(:call).and_return('{}')
+        client.should_receive(:call).with do |*args|
+          req = args.shift
+          req.method.should == request.method
+          req.url.should == request.url
+        end
+        obj = client.send(method, *params[:args])
+        obj.should be_an(params[:response])
+      end
+
+      it "should raise error with invalid parameter" do
+        expect {
+          obj = client.send(method, *params[:args], :invalid_key => 1)
+        }.to raise_error(Wordpress::ArgumentError)
+      end
+    end
+  end
+end

data/spec/wordpress/client_spec.rb

@@ -36,7 +36,7 @@ describe Wordpress::Client do
   end
 
   context "with bearer_token_request option" do
-    it "should call get request" do
+    it "should call get request with Authorization header" do
       req = Faraday::Request.new
       req.stub(:headers).and_return({})
       req.headers.should_receive(:[]=).with('Authorization', 'Bearer something').once
@@ -50,5 +50,18 @@ describe Wordpress::Client do
       client.access_token = 'something'
       client.call(request, :bearer_token_request => true)
     end
+
+    it "should call get request without Authorization header for no access_token" do
+      req = Faraday::Request.new
+      req.stub(:headers).and_return({})
+      req.headers.should_not_receive(:[]=).with('Authorization', 'Bearer something')
+      req.stub(:options).and_return({})
+      req.should_receive(:url).with(anything)
+      req.should_receive(:params=).with(anything)
+      Faraday::Connection.any_instance.should_receive(:get).and_yield(req).and_return(Faraday::Response.new)
+
+      request = Wordpress::Request.new(:get, 'url', {})
+      client.call(request, :bearer_token_request => true)
+    end
   end
 end

data/spec/wordpress/ostruct_spec.rb

@@ -22,6 +22,16 @@ describe Wordpress::OpenStruct do
     o.a.should == 2
   end
 
+  it 'should work with []' do
+    o = Wordpress::OpenStruct.new({:a => 1})
+    o[:a].should == 1
+    o[:a] = 2
+    o[:a].should == 2
+    o['a'].should == 2
+    o['a'] = 3
+    o['a'].should == 3
+  end
+
   it 'should parse hash recursively' do
     o = Wordpress::OpenStruct.new({:a => {:b => {:c => :d}}})
     o.a.should be_an(Wordpress::OpenStruct)
@@ -35,4 +45,14 @@ describe Wordpress::OpenStruct do
     o.assign({:a => 2})
     o.a.should == 2
   end
+
+  it 'should return custom string for to_s method' do
+    o = Wordpress::OpenStruct.new({:a => {:b => 1}})
+    o.to_s.should == "#<Wordpress::OpenStruct a=#<Wordpress::OpenStruct b=1>>"
+  end
+
+  it 'should return original hash' do
+    o = Wordpress::OpenStruct.new({:a => 1})
+    o.to_hash.should == {'a' => 1}
+  end
 end

data/spec/wordpress/request_spec.rb

@@ -2,4 +2,14 @@ require "spec_helper"
 require 'wordpress/request'
 
 describe Wordpress::Request do
+  let :request do
+    Wordpress::Request.new(:get, 'url')
+  end
+
+  it "should deep clone" do
+    new_request = request.dup
+    new_request.should_not equal request
+    new_request.params.should_not equal request.params
+    new_request.body.should_not equal request.body
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordpress-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Daisuke Taniwaki
@@ -102,7 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- CONTRIBUTING
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -135,6 +135,7 @@ files:
 - lib/wordpress/version.rb
 - spec/spec_helper.rb
 - spec/wordpress-client_spec.rb
+- spec/wordpress/api_spec.rb
 - spec/wordpress/base_spec.rb
 - spec/wordpress/client_spec.rb
 - spec/wordpress/object/base_spec.rb
@@ -161,13 +162,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.8
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Wordpress API Wrapper.
 test_files:
 - spec/spec_helper.rb
 - spec/wordpress-client_spec.rb
+- spec/wordpress/api_spec.rb
 - spec/wordpress/base_spec.rb
 - spec/wordpress/client_spec.rb
 - spec/wordpress/object/base_spec.rb