wordpress_client 1.0.1 → 2.0.0

data/Changelog.md

@@ -1,3 +1,7 @@
+# 2.0.0
+
+* Switch from WP REST API plugin to native WP API in Wordpress 4.6+.
+
 # 1.0.1
 
 * Bugfixes for latest Wordpress

data/README.md

@@ -1,6 +1,6 @@
 # WordpressClient
 
-WordpressClient is a very simple client for the Wordpress [WP REST API plugin][api] (version 2 beta 8.0).
+WordpressClient is a very simple client for the Wordpress [REST API][api].
 
 [![Circle CI](https://circleci.com/gh/hemnet/wordpress_client.svg?style=svg)](https://circleci.com/gh/hemnet/wordpress_client) [![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) [![Gem Version](https://badge.fury.io/rb/wordpress_client.svg)](https://badge.fury.io/rb/wordpress_client)[![Dependency Status](https://gemnasium.com/hemnet/wordpress_client.svg)](https://gemnasium.com/hemnet/wordpress_client)
 
@@ -8,17 +8,22 @@ WordpressClient is a very simple client for the Wordpress [WP REST API plugin][a
 
 **[Read the full API documentation][docs]**
 
-Initialize a client with a user name, password and API URL. You can then search for posts.
+Initialize a client with a user name, 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 = 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`.
+You can create posts by calling `create_post`.
 
 ```ruby
 data = {
@@ -29,12 +34,13 @@ data = {
 post = client.create_post(data) # => WordpressClient::Post
 updated_post = client.update_post(post.id, title: "Updated") # => WordpressClient::Post
 
+updated_post.author # => "Name"
 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.
+You need to install Docker and set it up for your machine.
 
 Run tests using the normal `rspec` command after installing all bundles.
 
@@ -42,7 +48,10 @@ Run tests using the normal `rspec` command after installing all bundles.
 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.
+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
@@ -50,23 +59,37 @@ 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.
+The normal `rspec` command will *not* use this filter in case it is ever
+committed accidentally, so CI can catch any problems.
 
 ## Releasing a new version
 
 The normal gem release cycle works using `rake release`.
 
-If you make changes to the docker image, you can release it using `rake docker:release`.
+If you make changes to the docker image, you can release it using `rake
+docker:release`.
 
 ## Copyright & License
 
-Copyright © 2015 Hemnet Service HNS AB
+Copyright © 2015-2017 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:
+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 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.
+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.
 
-[api]: http://v2.wp-api.org/
+[api]: https://developer.wordpress.org/rest-api/
 [docs]: http://www.rubydoc.info/gems/wordpress_client/

data/lib/wordpress_client.rb

@@ -15,9 +15,6 @@ 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
   # Initialize a new client using the provided connection details.
   # You need to provide authentication details, and the user must have +edit+

data/lib/wordpress_client/client.rb

@@ -8,21 +8,20 @@ module WordpressClient
 
     # Find {Post Posts} matching given parameters.
     #
-    # @example Finding 5 posts in the Important category
-    #   posts = client.posts(per_page: 5, category_slug: "important")
+    # @example Finding 5 posts
+    #   posts = client.posts(per_page: 5)
     #
     # @param page [Fixnum] Current page for pagination. Defaults to 1.
     # @param per_page [Fixnum] Posts per page. Defaults to 10.
-    # @param category_slug [String, nil] Find posts belonging to a category with the given slug.
-    # @param tag_slug [String, nil] Find posts belonging to a tag with the given slug.
     #
     # @return {PaginatedCollection[Post]} Paginated collection of the found posts.
-    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
+    def posts(per_page: 10, page: 1)
       connection.get_multiple(
-        Post, "posts", per_page: per_page, page: page, _embed: nil, context: "edit", filter: filter
+        Post,
+        "posts",
+        per_page: per_page,
+        page: page,
+        _embed: nil,
       )
     end
 
@@ -32,23 +31,7 @@ module WordpressClient
     # @raise {NotFoundError}
     # @raise {subclasses of Error} on other unexpected errors
     def find_post(id)
-      connection.get(Post, "posts/#{id.to_i}", _embed: nil, context: "edit")
-    end
-
-    # Find the first {Post} with the given slug, or raises an error if it cannot be found.
-    #
-    # @return {Post}
-    # @raise {NotFoundError}
-    # @raise {subclasses of Error} on other unexpected errors
-    def find_post_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
+      connection.get(Post, "posts/#{id.to_i}", _embed: nil)
     end
 
     # Create a new {Post} with the given attributes in Wordpress and return it.
@@ -73,18 +56,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     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
+      connection.create(Post, "posts", attributes, redirect_params: {_embed: nil})
     end
 
     # Update the {Post} with the given id, setting the supplied attributes in
@@ -116,18 +88,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     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
+      connection.put(Post, "posts/#{id.to_i}", attributes)
     end
 
     # Deletes the {Post} with the given ID.
@@ -147,7 +108,7 @@ module WordpressClient
     #
     # @return {PaginatedCollection[Category]}
     def categories(per_page: 10, page: 1)
-      connection.get_multiple(Category, "terms/category", page: page, per_page: per_page)
+      connection.get_multiple(Category, "categories", page: page, per_page: per_page)
     end
 
     # Find {Category} with the given ID.
@@ -156,7 +117,7 @@ module WordpressClient
     # @raise {NotFoundError}
     # @raise {subclasses of Error} on other unexpected errors
     def find_category(id)
-      connection.get(Category, "terms/category/#{id.to_i}")
+      connection.get(Category, "categories/#{id.to_i}")
     end
 
     # Create a new {Category} with the given attributes.
@@ -172,7 +133,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     def create_category(attributes)
-      connection.create(Category, "terms/category", attributes)
+      connection.create(Category, "categories", attributes)
     end
 
     # Update the {Category} with the given id, setting the supplied attributes.
@@ -189,7 +150,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     def update_category(id, attributes)
-      connection.patch(Category, "terms/category/#{id.to_i}", attributes)
+      connection.put(Category, "categories/#{id.to_i}", attributes)
     end
 
     # @!group Tags
@@ -198,7 +159,7 @@ module WordpressClient
     #
     # @return {PaginatedCollection[Tag]}
     def tags(per_page: 10, page: 1)
-      connection.get_multiple(Tag, "terms/tag", page: page, per_page: per_page)
+      connection.get_multiple(Tag, "tags", page: page, per_page: per_page)
     end
 
     # Find {Tag} with the given ID.
@@ -207,7 +168,7 @@ module WordpressClient
     # @raise {NotFoundError}
     # @raise {subclasses of Error} on other unexpected errors
     def find_tag(id)
-      connection.get(Tag, "terms/tag/#{id.to_i}")
+      connection.get(Tag, "tags/#{id.to_i}")
     end
 
     # Create a new {Tag} with the given attributes.
@@ -223,7 +184,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     def create_tag(attributes)
-      connection.create(Tag, "terms/tag", attributes)
+      connection.create(Tag, "tags", attributes)
     end
 
     # Update the {Tag} with the given id, setting the supplied attributes.
@@ -240,7 +201,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     def update_tag(id, attributes)
-      connection.patch(Tag, "terms/tag/#{id.to_i}", attributes)
+      connection.put(Tag, "tags/#{id.to_i}", attributes)
     end
 
     # @!group Media
@@ -322,7 +283,7 @@ module WordpressClient
     # @raise {ValidationError}
     # @raise {subclasses of Error} on other unexpected errors
     def update_media(id, attributes)
-      connection.patch(Media, "media/#{id.to_i}", attributes)
+      connection.put(Media, "media/#{id.to_i}", attributes)
     end
 
     # @!endgroup
@@ -333,20 +294,5 @@ module WordpressClient
 
     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

@@ -50,14 +50,14 @@ module WordpressClient
       true
     end
 
-    def patch(model, path, attributes)
+    def put(model, path, attributes)
       model.parse(
-        parse_json_response(send_json(path, attributes, method: :patch))
+        parse_json_response(send_json(path, attributes, method: :put))
       )
     end
 
-    def patch_without_response(path, attributes)
-      handle_status_code(send_json(path, attributes, method: :patch))
+    def put_without_response(path, attributes)
+      handle_status_code(send_json(path, attributes, method: :put))
       true
     end
 
@@ -66,9 +66,7 @@ module WordpressClient
       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"}",
+        "Content-Disposition" => 'attachment; filename="' + (filename || "unnamed") + '"',
       })
 
       if response.status == 201 # Created
@@ -89,7 +87,7 @@ module WordpressClient
     end
 
     def setup_network_connection
-      Faraday.new(url: "#{url}/wp/v2") do |conn|
+      Faraday.new(url: File.join(url, "wp/v2")) do |conn|
         conn.request :basic_auth, username, @password
         conn.adapter :net_http
       end
@@ -112,8 +110,9 @@ module WordpressClient
     def get_json_and_response(path, params = {})
       response = net.get(path, params)
       [parse_json_response(response), response]
-    rescue Faraday::TimeoutError
-      raise TimeoutError
+    rescue Faraday::ConnectionFailed => error
+      raise TimeoutError if error.cause.class == Net::OpenTimeout
+      raise
     end
 
     def send_json(path, data, method: :post)

data/lib/wordpress_client/media.rb

@@ -2,11 +2,16 @@ module WordpressClient
   # Represents a media record in Wordpress.
   class Media
     attr_accessor(
-      :id, :slug, :title_html, :description,
+      :id, :slug, :media_type, :title_html, :description,
       :date, :updated_at,
       :guid, :link, :media_details
     )
 
+    # @!attribute [r] media_type
+    #   @return [String] the type of the media
+    #   @example
+    #     media.media_type #=> "image"
+
     # @!attribute [rw] title_html
     #   @return [String] the title of the media, HTML escaped
     #   @example
@@ -45,6 +50,7 @@ module WordpressClient
     def initialize(
       id: nil,
       slug: nil,
+      media_type: nil,
       title_html: nil,
       description: nil,
       date: nil,
@@ -55,6 +61,7 @@ module WordpressClient
     )
       @id = id
       @slug = slug
+      @media_type = media_type
       @title_html = title_html
       @date = date
       @updated_at = updated_at
@@ -65,5 +72,12 @@ module WordpressClient
     end
 
     alias source_url guid
+
+    # Returns the same +Media+ instance if it is an image, else +nil+.
+    def as_image
+      if media_type == "image"
+        self
+      end
+    end
   end
 end

data/lib/wordpress_client/media_parser.rb

@@ -27,6 +27,7 @@ module WordpressClient
 
     def assign_basic(media)
       media.id = data.fetch("id")
+      media.media_type = data.fetch("media_type")
       media.slug = data.fetch("slug")
       media.link = data.fetch("link")
       media.description = data["description"]

data/lib/wordpress_client/post.rb

@@ -9,13 +9,14 @@ module WordpressClient
       :id, :slug, :url, :guid, :status,
       :title_html, :excerpt_html, :content_html,
       :updated_at, :date,
-      :categories, :tags, :meta, :featured_image
+      :categories, :tags, :meta, :featured_media,
+      :tag_ids, :category_ids, :featured_media_id
     )
 
     # @!attribute [rw] title_html
     #   @return [String] the title of the media, HTML escaped
     #   @example
-    #     post.title_html #=> "Fire & diamonds!"
+    #     post.title_html #=> "Fire & diamonds!"
 
     # @!attribute [rw] date
     #   @return [Time, nil] the date of the post, in UTC if available
@@ -42,7 +43,7 @@ module WordpressClient
     #   @return [Array[Tag]] the {Tag Tags} the post belongs to.
     #   @see Tag
 
-    # @!attribute [rw] featured_image
+    # @!attribute [rw] featured_media
     #   @return [Media, nil] the featured image, as an instance of {Media}
     #   @see Media
 
@@ -79,9 +80,10 @@ module WordpressClient
       date: nil,
       categories: [],
       tags: [],
-      featured_image: nil,
-      meta: {},
-      meta_ids: {}
+      category_ids: [],
+      tag_ids: [],
+      featured_media: nil,
+      meta: {}
     )
       @id = id
       @slug = slug
@@ -95,39 +97,17 @@ module WordpressClient
       @date = date
       @categories = categories
       @tags = tags
-      @featured_image = featured_image
+      @category_ids = category_ids
+      @tag_ids = tag_ids
+      @featured_media = featured_media
       @meta = meta
-      @meta_ids = meta_ids
     end
 
-    # A list of all category ids for the post.
-    #
-    # You can pass this list, with IDs added or removed, to
-    # {Client#update_post} to change the category list.
-    #
-    # @return [Array[Fixnum]] the id of every category associated with this post
-    # @see Client#update_post
-    def category_ids() categories.map(&:id) end
-
-    # A list of all tag ids for the post.
-    #
-    # You can pass this list, with IDs added or removed, to
-    # {Client#update_post} to change the tag list.
-    #
-    # @return [Array[Fixnum]] the id of every tag associated with this post
-    # @see Client#update_post
-    def tag_ids() tags.map(&:id) end
-
-    # @return [Fixnum, nil] ID of the featured image associated with the post.
-    def featured_image_id
-      featured_image && featured_image.id
-    end
-
-    # @api private
-    # Used to determine the underlying ID of the different meta keys so they
-    # can be modified by {Client}. You should not use this for anything.
-    def meta_id_for(key)
-      @meta_ids[key] || raise(ArgumentError, "Post does not have meta #{key.inspect}")
+    # Returns the featured media, if the featured media is an image.
+    def featured_image
+      if featured_media
+        featured_media.as_image
+      end
     end
   end
 end