ct_wordpress-client 0.2.8 → 0.2.10

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTliZDY3OWVjNmJhMTQzOWZmYzA2MGM2ZTFjNWViZTc5YTM1MDcxOA==
+  data.tar.gz: !binary |-
+    ZjYyZWEzMmI4YjNhMDBlY2U1NTdkMjM3ZGJhMGQzOTk1YmE1YzAzZg==
+SHA512:
+  metadata.gz: !binary |-
+    ZTBhNDk4MzRjOWFkM2NiNDI0OTM4ZWRmZGM2ZmFmYjQwMDIyNjU2OTA1NmQ2
+    MmZkOGE1YTA5YmUzZDJkMGY3ODg0ODgzNThlM2UyZmU0NWE3NWU5OTNlZWVh
+    OTJjNWY2NWZhM2Q4OGYzMGFjNDdkMjlmOTlmMGI1MDk1NWI1Zjg=
+  data.tar.gz: !binary |-
+    ZDRhM2VjY2JmZDczMDVlZTM4MjNhYWNhMzFhNjIzNjIxODA5ZmUzNmYzMTA1
+    M2Y3OTZmZTI2ZWNjYmFhYTRmMDFlYTQ3ODE4MmFhYmEwNDE4OTYxYTE1NGQ2
+    ZGFiYWExOWY0YjNkNDAwN2UwNGUwMjMyN2QxYjBhZDNhNjA5MTU=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,24 @@
+.rvmrc
+.rspec
+.bundle
+.config
+
+coverage
+vendor
+log
+tmp
+coverage
+spec/tmp
+spec/reports
+
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*.gem
+*.rbc
+**.orig
+**.org

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+branches:
+  only:
+    - master
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+Contributor Policy
+=================
+
+Commit bit. If you have a commit accepted into the project then you get full git access to the repo. If I don't give you this in a timely manner just send me a message.
+
+Testing
+======
+
+Please don't commit code without tests. You can bootstrap the development environment by running `bundle install`. After that, running `rake` should just work. If it doesn't then file a bug.
+
+Versioning
+=========
+
+Don't bump the version in any changes you make or pull in to the project. I'll maintain rights to push the gem to rubygems.org and make releases when appropriate.
+
+And please keep the README up to date. Thank you!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 dtaniwaki
+
+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,80 @@
+# wordpress-client
+
+[![Gem Version](https://badge.fury.io/rb/wordpress-client.png)](https://rubygems.org/gems/wordpress-client) [![Build Status](https://travis-ci.org/dtaniwaki/wordpress-client.png)](https://travis-ci.org/dtaniwaki/wordpress-client) [![Coverage Status](https://coveralls.io/repos/dtaniwaki/wordpress-client/badge.png)](https://coveralls.io/r/dtaniwaki/wordpress-client)
+
+wordpress-client is a [Wordpress Rest API Wrapper](http://developer.wordpress.com/docs/api/).
+
+## Requirements
+
+I test with ruby 1.9.3 and 2.1.0. Other versions/VMs are untested but might work fine.
+
+## Installation
+
+To your system
+
+```ruby
+gem install wordpress-client
+```
+
+Or add wordpress-client to your `Gemfile` and `bundle install`:
+
+```ruby
+gem 'wordpress-client'
+```
+
+## Usage
+
+Create new client
+
+```ruby
+require 'wordpress-client'
+
+# Shared client
+client = Wordpress.client
+
+# New client
+client = Wordpress::Client.new
+```
+
+Call API without access token
+
+```ruby
+# Get posts of a specific domain without access token
+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
+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
+```
+
+Call API with access token
+
+```ruby
+# Get user by access token
+client.access_token = 'YOUR_ACCESS_TOKEN' # if you have any
+user = client.me
+site = user.site
+posts = site.posts
+```
+
+## TODO
+- 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) 2013-2013 Daisuke Taniwaki. See [LICENSE](https://github.com/dtaniwaki/wordpress-client/blob/master/LICENSE) for details.

data/Rakefile

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

data/lib/faraday_middleware/gzip.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'zlib'
+ 
+module FaradayMiddleware
+  class Gzip < Faraday::Response::Middleware
+ 
+    def on_complete(env)
+      encoding = env[:response_headers]['content-encoding'].to_s.downcase
+      case encoding
+      when 'gzip'
+        env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body]), :encoding => 'ASCII-8BIT').read
+        env[:response_headers].delete('content-encoding')
+      when 'deflate'
+        env[:body] = Zlib::Inflate.inflate(env[:body])
+        env[:response_headers].delete('content-encoding')
+      end
+    end
+ 
+  end
+end
+ 
+Faraday::Response.register_middleware :gzip => FaradayMiddleware::Gzip

data/lib/wordpress-client.rb

@@ -0,0 +1,43 @@
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(relative_path)
+      desired_path = File.expand_path('../' + relative_path.to_str, caller[0])
+      shortest = desired_path
+      $:.each do |path|
+        path += '/'
+        if desired_path.index(path) == 0
+          candidate = desired_path.sub(path, '')
+          shortest = candidate if candidate.size < shortest.size
+        end
+      end
+      require shortest
+    end
+  end
+end
+
+require 'logger'
+require 'wordpress/version'
+require 'wordpress/client'
+
+module Wordpress
+  class << self
+    attr_writer :logger
+
+    def client
+      @client ||= Wordpress::Client.new
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def configure(&block)
+      block.call(configuration)
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/wordpress/api.rb

@@ -0,0 +1,62 @@
+require 'wordpress/errors'
+require 'wordpress/request'
+Dir.glob(File.expand_path('../api/*.rb', __FILE__)) do |path|
+  require path
+end
+
+module Wordpress
+  module API
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.extend(ClassMethods)
+      base.class_eval do
+        include Posts
+        include Comments
+        include Sites
+        include Me
+        include Tests
+        include Follow
+        include Taxonomy
+        include Notifications
+        include FreshlyPressed
+        include Oauth
+        include Media
+      end
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+      def exec_api(request, &response)
+        json = call(request, :bearer_token_request => true)
+
+        if !json['error'].nil?
+          raise Wordpress::ResponseError, json
+        end
+      
+        if response.nil?
+          Wordpress::OpenStruct.new(json)
+        else
+          instance_exec(json, &response)
+        end
+      end
+
+      private
+
+      def validate_keys!(params, valid_keys)
+        params.keys.each do |key|
+          raise Wordpress::ArgumentError, "#{key} is not valid for this method." unless valid_keys.include?(key)
+        end
+      end
+
+      def default_keys
+        [:http_envelope, :pretty, :meta, :callback].freeze
+      end
+  
+      def search_keys
+        [:number, :offset, :page, :order, :order_by, :after, :before].freeze
+      end
+    end
+  end
+end

data/lib/wordpress/api/comments.rb

@@ -0,0 +1,48 @@
+require "wordpress/object/comments"
+require "wordpress/object/comment"
+
+module Wordpress::API
+  module Comments
+    def get_comments(site, params = {})
+      validate_keys! params, [:context, :type, :status] + default_keys + search_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/sites/#{site}/comments", params)) do |json|
+        Wordpress::Object::Comments.new(self, json)
+      end
+    end
+
+    def get_post_comments(site, post_id, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/sites/#{site}/posts/#{post_id}/replies", params)) do |json|
+        Wordpress::Object::Comments.new(self, json)
+      end
+    end
+
+    def get_comment(site, comment_id, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/sites/#{site}/comments/#{comment_id}", params)) do |json|
+        Wordpress::Object::Comment.new(self, json)
+      end
+    end
+
+    def update_comment(site, comment_id, data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/comments/#{comment_id}", params, data)) do |json|
+        Wordpress::Object::Comment.new(self, json)
+      end
+    end
+
+    def create_comment(site, post_id, data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/posts/#{post_id}/replies/new", params, data)) do |json|
+        Wordpress::Object::Comment.new(self, json)
+      end
+    end
+
+    def delete_comment(site, comment_id, data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/comments/#{comment_id}/delete", params, data)) do |json|
+        Wordpress::Object::Comment.new(self, json)
+      end
+    end
+  end
+end

data/lib/wordpress/api/follow.rb

@@ -0,0 +1,20 @@
+require "wordpress/ostruct"
+
+module Wordpress::API
+  module Follow
+    def create_follow(site, data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/follows/new", params, data))
+    end
+
+    def delete_follow(site, data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/follows/mine/delete", params, data))
+    end
+
+    def get_follow(site, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/sites/#{site}/follows/mine", params))
+    end
+  end
+end

data/lib/wordpress/api/freshly_pressed.rb

@@ -0,0 +1,10 @@
+require "wordpress/ostruct"
+
+module Wordpress::API
+  module FreshlyPressed
+    def freshly_pressed(params = {})
+      validate_keys! params, [:number, :after, :before, :content_width, :thumb_width, :thumb_height] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/freshly-pressed", params))
+    end
+  end
+end

data/lib/wordpress/api/me.rb

@@ -0,0 +1,18 @@
+require "wordpress/ostruct"
+require "wordpress/object/user"
+
+module Wordpress::API
+  module Me
+    def me(params = {})
+      validate_keys! params, default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/me", params)) do |json|
+        Wordpress::Object::User.new(self, json)
+      end
+    end
+
+    def get_my_likes(params = {})
+      validate_keys! params, default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/me/likes", params))
+    end
+  end
+end

data/lib/wordpress/api/media.rb

@@ -0,0 +1,15 @@
+require "wordpress/ostruct"
+require "wordpress/object/media"
+module Wordpress::API
+  module Media
+
+    def add_media(site, params = {})
+      validate_keys! params, [:context, :media, :media_urls,:attrs] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/sites/#{site}/media/new",nil, params)) do |json|
+        Wordpress::Object::Media.new( self, json )
+      end
+    end
+
+  end
+end
+

data/lib/wordpress/api/notifications.rb

@@ -0,0 +1,25 @@
+require "wordpress/ostruct"
+
+module Wordpress::API
+  module Notifications
+    def get_notifications(params = {})
+      validate_keys! params, [:ids, :fields, :type, :unread, :read, :number, :since, :before, :num_note_items, :trap] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/notifications", params))
+    end
+
+    def get_notification(note_id, params = {})
+      validate_keys! params, [:context, :fields, :num_note_items] + default_keys
+      exec_api(Wordpress::Request.new(:get, "/rest/v1.1/notifications/#{note_id}", params))
+    end
+
+    def see_notifications(data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/notifications/seen", params, data))
+    end
+
+    def read_notifications(data, params = {})
+      validate_keys! params, [:context] + default_keys
+      exec_api(Wordpress::Request.new(:post, "/rest/v1.1/notifications/read", params, data))
+    end
+  end
+end