wordpress_client 0.0.1

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wordpress_client.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+group :development do
+  gem 'guard', '~> 2.13'
+  gem 'guard-rspec', '~> 4.6'
+end

data/Guardfile

@@ -0,0 +1,29 @@
+rspec_options = {
+  cmd: 'rspec -f documentation -t focus',
+  failed_mode: :keep,
+  all_after_pass: true,
+  all_on_start: true,
+  run_all: {cmd: 'rspec -f progress -t focus'}
+}
+
+guard :rspec, rspec_options do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch("spec/shared_examples/term_examples.rb") do
+    [
+      "spec/category_spec.rb",
+      "spec/tag_spec.rb",
+    ]
+  end
+
+  # Ruby files
+  watch("lib/wordpress_client.rb") { rspec.spec_dir }
+  dsl.watch_spec_files_for(%r{^lib/wordpress_client/(.*)\.rb$})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hemnet
+
+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,63 @@
+# WordpressClient
+
+WordpressClient is a very simple client to the Wordpress API, version 2 beta 8.0.
+
+**NOTE:** The repository is still named `wpclient` as we're in the middle of a rename. Some references might persist until it's completed.
+
+[![Circle CI](https://circleci.com/gh/hemnet/wpclient.svg?style=svg)](https://circleci.com/gh/hemnet/wpclient) [![Code Climate](https://codeclimate.com/repos/5645938269568041da00cded/badges/5e870b57428f23c1f2ff/gpa.svg)](https://codeclimate.com/repos/5645938269568041da00cded/feed) [![Test Coverage](https://codeclimate.com/repos/5645938269568041da00cded/badges/5e870b57428f23c1f2ff/coverage.svg)](https://codeclimate.com/repos/5645938269568041da00cded/coverage)
+
+## Usage
+
+Initialize a client with a username, password and API URL. You can then search for posts.
+
+```ruby
+client = WordpressClient.new(url: "https://example.com/wp-json/", username: "example", password: "example")
+
+client.posts(per_page: 5) # => [WordpressClient::Post, WordpressClient::Post]
+```
+
+### Creating a post
+
+You can create posts by calling `create_post`. If you supply a ID, the article will be created using `PUT` instead of `POST`.
+
+```ruby
+data = {
+  author: "Name",
+  # ...
+}
+
+post = client.create_post(data) # => WordpressClient::Post
+updated_post = client.update_post(post.id, title: "Updated") # => WordpressClient::Post
+
+updated_post.title_html # => "Updated"
+```
+
+## Running tests
+
+You need to install Docker and set it up for your machine. Note that you need `docker-machine` to run Docker on OS X.
+
+Run tests using the normal `rspec` command after installing all bundles. The first time the integration tests are run, a docker image will be built that hosts a Wordpress installation, but the image will be re-used on subsequent runs.
+
+```
+bundle exec rspec
+```
+
+You can also run `bundle exec guard` to have tests run automatically when you change files in the repo. If you tag your examples with `focus: true`, Guard will only run those tests. This can help when doing very focused coding, but remember to remove the filter before you commit and let the entire suite run.
+
+```ruby
+describe Foo, focus: true do
+  # ...
+end
+```
+
+The normal `rspec` command will *not* use this filter in case it is ever committed accidentally, so CI can catch any problems.
+
+## Copyright & License
+
+Copyright © 2015 Hemnet Service HNS AB
+
+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/Rakefile

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

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  services:
+    - docker

data/lib/wordpress_client.rb

@@ -0,0 +1,25 @@
+require "wordpress_client/version"
+require "wordpress_client/errors"
+
+require "wordpress_client/rest_parser"
+require "wordpress_client/connection"
+require "wordpress_client/client"
+require "wordpress_client/paginated_collection"
+
+require "wordpress_client/term"
+require "wordpress_client/category"
+require "wordpress_client/tag"
+
+require "wordpress_client/post"
+require "wordpress_client/post_parser"
+require "wordpress_client/media"
+require "wordpress_client/media_parser"
+
+require "wordpress_client/replace_terms"
+require "wordpress_client/replace_metadata"
+
+module WordpressClient
+  def self.new(*args)
+    Client.new(Connection.new(*args))
+  end
+end

data/lib/wordpress_client/category.rb

@@ -0,0 +1,4 @@
+module WordpressClient
+  class Category < Term
+  end
+end

data/lib/wordpress_client/client.rb

@@ -0,0 +1,142 @@
+module WordpressClient
+  class Client
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def posts(per_page: 10, page: 1, category_slug: nil, tag_slug: nil)
+      filter = {}
+      filter[:category_name] = category_slug if category_slug
+      filter[:tag] = tag_slug if tag_slug
+      connection.get_multiple(
+        Post, "posts", per_page: per_page, page: page, _embed: nil, context: "edit", filter: filter
+      )
+    end
+
+    def categories(per_page: 10, page: 1)
+      connection.get_multiple(Category, "terms/category", page: page, per_page: per_page)
+    end
+
+    def tags(per_page: 10, page: 1)
+      connection.get_multiple(Tag, "terms/tag", page: page, per_page: per_page)
+    end
+
+    def media(per_page: 10, page: 1)
+      connection.get_multiple(Media, "media", page: page, per_page: per_page)
+    end
+
+    def find_post(id)
+      connection.get(Post, "posts/#{id.to_i}", _embed: nil, context: "edit")
+    end
+
+    def find_by_slug(slug)
+      posts = connection.get_multiple(
+        Post, "posts", per_page: 1, page: 1, filter: {name: slug}, _embed: nil
+      )
+      if posts.size > 0
+        posts.first
+      else
+        raise NotFoundError, "Could not find post with slug #{slug.to_s.inspect}"
+      end
+    end
+
+    def find_category(id)
+      connection.get(Category, "terms/category/#{id.to_i}")
+    end
+
+    def find_tag(id)
+      connection.get(Tag, "terms/tag/#{id.to_i}")
+    end
+
+    def find_media(id)
+      connection.get(Media, "media/#{id.to_i}")
+    end
+
+    def create_post(attributes)
+      post = connection.create(Post, "posts", attributes, redirect_params: {_embed: nil})
+
+      changes = 0
+      changes += assign_meta(post, attributes[:meta])
+      changes += assign_categories(post, attributes[:category_ids])
+      changes += assign_tags(post, attributes[:tag_ids])
+
+      if changes > 0
+        find_post(post.id)
+      else
+        post
+      end
+    end
+
+    def create_category(attributes)
+      connection.create(Category, "terms/category", attributes)
+    end
+
+    def create_tag(attributes)
+      connection.create(Tag, "terms/tag", attributes)
+    end
+
+    def update_post(id, attributes)
+      post = connection.patch(Post, "posts/#{id.to_i}?_embed", attributes)
+
+      changes = 0
+      changes += assign_meta(post, attributes[:meta])
+      changes += assign_categories(post, attributes[:category_ids])
+      changes += assign_tags(post, attributes[:tag_ids])
+
+      if changes > 0
+        find_post(post.id)
+      else
+        post
+      end
+    end
+
+    def update_category(id, attributes)
+      connection.patch(Category, "terms/category/#{id.to_i}", attributes)
+    end
+
+    def update_tag(id, attributes)
+      connection.patch(Tag, "terms/tag/#{id.to_i}", attributes)
+    end
+
+    def update_media(id, attributes)
+      connection.patch(Media, "media/#{id.to_i}", attributes)
+    end
+
+    def upload(io, mime_type:, filename:)
+      connection.upload(Media, "media", io, mime_type: mime_type, filename: filename)
+    end
+
+    def upload_file(filename, mime_type:)
+      path = filename.to_s
+      File.open(path, 'r') do |file|
+        upload(file, mime_type: mime_type, filename: File.basename(path))
+      end
+    end
+
+    def delete_post(id, force: false)
+      connection.delete("posts/#{id.to_i}", {"force" => force})
+    end
+
+    def inspect
+      "#<WordpressClient::Client #{connection.inspect}>"
+    end
+
+    private
+    attr_reader :connection
+
+    def assign_categories(post, ids)
+      return 0 unless ids
+      ReplaceTerms.apply_categories(connection, post, ids)
+    end
+
+    def assign_tags(post, ids)
+      return 0 unless ids
+      ReplaceTerms.apply_tags(connection, post, ids)
+    end
+
+    def assign_meta(post, meta)
+      return 0 unless meta
+      ReplaceMetadata.apply(connection, post, meta)
+    end
+  end
+end

data/lib/wordpress_client/connection.rb

@@ -0,0 +1,186 @@
+require "faraday"
+require "json"
+
+module WordpressClient
+  class Connection
+    attr_reader :url, :username
+
+    def initialize(url:, username:, password:)
+      @url = url
+      @username = username
+      @password = password
+    end
+
+    def get(model, path, params = {})
+      model.parse(get_json(path, params))
+    end
+
+    def get_multiple(model, path, params = {})
+      data, response = get_json_and_response(path, params)
+      models = data.map { |model_data| model.parse(model_data) }
+      wrap_paginated_collection(response, models, params)
+    end
+
+    def create(model, path, attributes, redirect_params: {})
+      response = send_json(path, attributes)
+
+      if response.status == 201 # Created
+        model.parse(get_json(response.headers.fetch("location"), redirect_params))
+      else
+        handle_status_code(response)
+        model.parse(parse_json_response(response))
+      end
+    end
+
+    def create_without_response(path, attributes)
+      response = send_json(path, attributes)
+
+      if response.status == 201 # Created
+        true
+      else
+        handle_status_code(response)
+        true
+      end
+    end
+
+    def delete(path, attributes = {})
+      response = send_json(path, attributes, method: :delete)
+      handle_status_code(response)
+      true
+    end
+
+    def patch(model, path, attributes)
+      model.parse(
+        parse_json_response(send_json(path, attributes, method: :patch))
+      )
+    end
+
+    def patch_without_response(path, attributes)
+      handle_status_code(send_json(path, attributes, method: :patch))
+      true
+    end
+
+    def upload(model, path, io, mime_type:, filename:)
+      body = io.read
+      response = post_data(path, body, {
+        "Content-Length" => body.size.to_s,
+        "Content-Type" => mime_type,
+        # WP API does not parse normal Content-Disposition and instead ops to using their own format
+        # https://github.com/WP-API/WP-API/issues/1744
+        "Content-Disposition" => "filename=#{filename || "unnamed"}",
+      })
+
+      if response.status == 201 # Created
+        model.parse(get_json(response.headers.fetch("location")))
+      else
+        handle_status_code(response)
+        model.parse(parse_json_response(response))
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} #@username @ #@url>"
+    end
+
+    private
+    def net
+      @net ||= setup_network_connection
+    end
+
+    def setup_network_connection
+      Faraday.new(url: "#{url}/wp/v2") do |conn|
+        conn.request :basic_auth, username, @password
+        conn.adapter :net_http
+      end
+    end
+
+    def wrap_paginated_collection(response, entries, params)
+      total = response.headers.fetch("x-wp-total").to_i
+      current_page = params.fetch(:page).to_i
+      per_page = params.fetch(:per_page).to_i
+
+      PaginatedCollection.new(
+        entries, total: total, current_page: current_page, per_page: per_page
+      )
+    end
+
+    def get_json(path, params = {})
+      get_json_and_response(path, params).first
+    end
+
+    def get_json_and_response(path, params = {})
+      response = net.get(path, params)
+      [parse_json_response(response), response]
+    rescue Faraday::TimeoutError
+      raise TimeoutError
+    end
+
+    def send_json(path, data, method: :post)
+      unless %i[get post put patch delete].include? method
+        raise ArgumentError, "Invalid method: #{method.inspect}"
+      end
+
+      net.public_send(method) do |request|
+        json = data.to_json
+        request.url path
+        request.headers["Content-Type"] = "application/json; charset=#{json.encoding}"
+        request.body = json
+      end
+    rescue Faraday::TimeoutError
+      raise TimeoutError
+    end
+
+    def post_data(path, data, headers)
+      net.post do |request|
+        request.url path
+        request.headers = headers
+        request.body = data
+      end
+    rescue Faraday::TimeoutError
+      raise TimeoutError
+    end
+
+    def parse_json_response(response)
+      handle_status_code(response)
+
+      content_type = response.headers["content-type"].split(";").first
+      unless content_type == "application/json"
+        raise ServerError, "Got content type #{content_type}"
+      end
+
+      JSON.parse(response.body)
+
+    rescue JSON::ParserError => error
+      raise ServerError, "Could not parse JSON response: #{error}"
+    end
+
+    def handle_status_code(response)
+      case response.status
+      when 200
+        return
+      when 404
+        raise NotFoundError, "Could not find resource"
+      when 400
+        handle_bad_request(response)
+      else
+        raise ServerError, "Server returned status code #{response.status}: #{response.body}"
+      end
+    end
+
+    def handle_bad_request(response)
+      code, message = bad_request_details(response)
+      if code == "rest_post_invalid_id"
+        raise NotFoundError, "Post ID is not found"
+      else
+        raise ValidationError, message
+      end
+    end
+
+    def bad_request_details(response)
+      details = JSON.parse(response.body)
+      [details["code"], details["message"]]
+    rescue
+      [nil, "Bad Request"]
+    end
+  end
+end