wordpress_client 1.0.1 → 2.0.0

data/lib/wordpress_client/post_parser.rb

@@ -13,16 +13,13 @@ module WordpressClient
     end
 
     def to_post
-      meta, meta_ids = parse_metadata
-      post = Post.new(meta: meta, meta_ids: meta_ids)
-
+      post = Post.new
       assign_basic(post)
       assign_dates(post)
       assign_rendered(post)
       assign_categories(post)
       assign_tags(post)
-      assign_featured_image(post)
-
+      assign_featured_media(post)
       post
     end
 
@@ -34,6 +31,10 @@ module WordpressClient
       post.slug = data["slug"]
       post.url = data["link"]
       post.status = data["status"]
+      post.meta = data["meta"]
+      post.category_ids = data["categories"]
+      post.tag_ids = data["tags"]
+      post.featured_media_id = data["featured_media"]
     end
 
     def assign_dates(post)
@@ -60,32 +61,17 @@ module WordpressClient
       end
     end
 
-    def assign_featured_image(post)
-      featured_id = data["featured_image"]
+    def assign_featured_media(post)
+      featured_id = data["featured_media"]
       if featured_id
         features = (embedded["wp:featuredmedia"] || []).flatten
         media = features.detect { |feature| feature["id"] == featured_id }
         if media
-          post.featured_image = Media.parse(media)
+          post.featured_media = Media.parse(media)
         end
       end
     end
 
-    def parse_metadata
-      embedded_metadata = (embedded["wp:meta"] || []).flatten
-      validate_embedded_metadata(embedded_metadata)
-
-      meta = {}
-      meta_ids = {}
-
-      embedded_metadata.each do |entry|
-        meta[entry.fetch("key")] = entry.fetch("value")
-        meta_ids[entry.fetch("key")] = entry.fetch("id")
-      end
-
-      [meta, meta_ids]
-    end
-
     def embedded_terms(type)
       term_collections = embedded["wp:term"] || embedded["https://api.w.org/term"] || []
 
@@ -96,19 +82,5 @@ module WordpressClient
       } || []
     end
 
-    def validate_embedded_metadata(embedded_metadata)
-      if embedded_metadata.size == 1 && embedded_metadata.first["code"]
-        error = embedded_metadata.first
-        case error["code"]
-        when "rest_forbidden"
-          raise UnauthorizedError, error.fetch(
-            "message", "You are not authorized to see meta for this post."
-          )
-        else
-          raise Error, "Could not retreive meta for this post: " \
-            "#{error["code"]} – #{error["message"]}"
-        end
-      end
-    end
   end
 end

data/lib/wordpress_client/term.rb

@@ -14,7 +14,7 @@ module WordpressClient
     # @!attribute [r] name_html
     #   @return [String] The name of the resource, HTML encoded.
     #   @example
-    #     term.name_html #=> "Father & Daughter stuff"
+    #     term.name_html #=> "Father & Daughter stuff"
 
     # @!attribute [r] slug
     #   @return [String] The slug of the resource in Wordpress.

data/lib/wordpress_client/version.rb

@@ -3,5 +3,5 @@ module WordpressClient
   #
   # @note This only applies if using a released version. A development build
   #       would not correspond to this constant.
-  VERSION = "1.0.1"
+  VERSION = "2.0.0".freeze
 end

data/spec/client_spec.rb

@@ -22,30 +22,6 @@ module WordpressClient
 
         expect(client.posts).to eq []
       end
-
-      it "can filter on category slugs" do
-        expect(connection).to receive(:get_multiple).with(
-          Post, "posts", hash_including(filter: {category_name: "my-cat"})
-        ).and_return []
-
-        expect(client.posts(category_slug: "my-cat")).to eq []
-      end
-
-      it "can filter on tag slugs" do
-        expect(connection).to receive(:get_multiple).with(
-          Post, "posts", hash_including(filter: {tag: "my-cat"})
-        ).and_return []
-
-        expect(client.posts(tag_slug: "my-cat")).to eq []
-      end
-
-      it "can filter on tag and category slugs" do
-        expect(connection).to receive(:get_multiple).with(
-          Post, "posts", hash_including(filter: {tag: "my-cat", category_name: "my-dog"})
-        ).and_return []
-
-        expect(client.posts(tag_slug: "my-cat", category_slug: "my-dog")).to eq []
-      end
     end
 
     describe "fetching a single post" do
@@ -53,31 +29,12 @@ module WordpressClient
         post = instance_double(Post)
 
         expect(connection).to receive(:get).with(
-          Post, "posts/5", _embed: nil, context: "edit"
+          Post, "posts/5", _embed: nil
         ).and_return post
 
         expect(client.find_post(5)).to eq post
       end
 
-      it "can find using a slug" do
-        post = instance_double(Post)
-
-        expect(connection).to receive(:get_multiple).with(
-          Post, "posts", hash_including(filter: {name: "my-slug"})
-        ).and_return [post]
-
-        expect(client.find_post_by_slug("my-slug")).to eq post
-      end
-
-      it "raises NotFoundError when trying to find by slug yields no posts" do
-        expect(connection).to receive(:get_multiple).with(
-          Post, "posts", hash_including(filter: {name: "my-slug"}, per_page: 1)
-        ).and_return []
-
-        expect {
-          client.find_post_by_slug("my-slug")
-        }.to raise_error(NotFoundError, /my-slug/)
-      end
     end
 
     describe "creating a post" do
@@ -93,147 +50,26 @@ module WordpressClient
         # it's also very possible that we need to fetch the post again after
         # doing other things to it.
         allow(connection).to receive(:get).with(
-          Post, "posts/5", hash_including(_embed: nil)
+          Post, "posts/5"
         ).and_return(post)
 
         expect(client.create_post(attributes)).to eq post
       end
 
-      it "adds metadata to the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:create).and_return(post)
-
-        expect(ReplaceMetadata).to receive(:apply).with(
-          connection, post, {"hello" => "world"}
-        ).and_return(0)
-
-        client.create_post(title: "Foo", meta: {"hello" => "world"})
-      end
-
-      it "sets categories of the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:create).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_categories).with(
-          connection, post, [1, 3, 7]
-        ).and_return(0)
-
-        client.create_post(title: "Foo", category_ids: [1, 3, 7])
-      end
-
-      it "sets tags of the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:create).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).with(
-          connection, post, [1, 3, 7]
-        ).and_return(0)
-
-        client.create_post(title: "Foo", tag_ids: [1, 3, 7])
-      end
-
-      it "refreshes the post if terms or categories changed" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:create).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).and_return(1)
-        expect(ReplaceTerms).to receive(:apply_categories).and_return(1)
-        expect(ReplaceMetadata).to receive(:apply).and_return(1)
-
-        expect(connection).to receive(:get).with(
-          Post, "posts/5", hash_including(_embed: nil)
-        ).and_return(post)
-
-        client.create_post(title: "Foo", tag_ids: [], category_ids: [], meta: {})
-      end
-
-      it "does not refresh the post if neither terms nor categories changed" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:create).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).and_return(0)
-        expect(ReplaceTerms).to receive(:apply_categories).and_return(0)
-        expect(ReplaceMetadata).to receive(:apply).and_return(0)
-
-        expect(connection).to_not receive(:get)
-
-        client.create_post(title: "Foo", tag_ids: [], category_ids: [], meta: {})
-      end
     end
 
     describe "updating a post" do
       it "embeds linked resources" do
         post = instance_double(Post)
 
-        expect(connection).to receive(:patch).with(
-          Post, "posts/5?_embed", hash_including(title: "Foo")
+        expect(connection).to receive(:put).with(
+          Post, "posts/5", hash_including(title: "Foo")
         ).and_return(post)
 
         expect(client.update_post(5, title: "Foo")).to eq post
       end
 
-      it "adds metadata to the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:patch).and_return(post)
-
-        expect(ReplaceMetadata).to receive(:apply).with(
-          connection, post, {"hello" => "world"}
-        ).and_return(0)
-
-        client.update_post(5, title: "Foo", meta: {"hello" => "world"})
-      end
-
-      it "changes categories of the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:patch).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_categories).with(
-          connection, post, [1, 3, 7]
-        ).and_return(0)
-
-        client.update_post(5, title: "Foo", category_ids: [1, 3, 7])
-      end
-
-      it "changes tags of the post" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:patch).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).with(
-          connection, post, [1, 3, 7]
-        ).and_return(0)
-
-        client.update_post(5, title: "Foo", tag_ids: [1, 3, 7])
-      end
-
-      it "refreshes the post if terms or categories changed" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:patch).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).and_return(1)
-        expect(ReplaceTerms).to receive(:apply_categories).and_return(1)
-        expect(ReplaceMetadata).to receive(:apply).and_return(1)
-
-        expect(connection).to receive(:get).with(
-          Post, "posts/5", hash_including(_embed: nil)
-        ).and_return(post)
-
-        client.update_post(5, title: "Foo", tag_ids: [], category_ids: [], meta: {})
-      end
-
-      it "does not refresh the post if neither terms nor categories changed" do
-        post = instance_double(Post, id: 5)
-        allow(connection).to receive(:patch).and_return(post)
-
-        expect(ReplaceTerms).to receive(:apply_tags).and_return(0)
-        expect(ReplaceTerms).to receive(:apply_categories).and_return(0)
-        expect(ReplaceMetadata).to receive(:apply).and_return(0)
-
-        expect(connection).to_not receive(:get)
-
-        client.update_post(5, title: "Foo", tag_ids: [], category_ids: [], meta: {})
-      end
     end
-
     describe "deleting posts" do
       it "deletes a post without force by default" do
         expect(connection).to receive(:delete).with(
@@ -263,12 +99,12 @@ module WordpressClient
     describe "categories" do
       it "can be listed" do
         expect(connection).to receive(:get_multiple).with(
-          Category, "terms/category", hash_including(page: 1, per_page: 10)
+          Category, "categories", hash_including(page: 1, per_page: 10)
         )
         client.categories
 
         expect(connection).to receive(:get_multiple).with(
-          Category, "terms/category", hash_including(page: 2, per_page: 60)
+          Category, "categories", hash_including(page: 2, per_page: 60)
         )
         client.categories(page: 2, per_page: 60)
       end
@@ -277,7 +113,7 @@ module WordpressClient
         category = instance_double(Category)
 
         expect(connection).to receive(:get).with(
-          Category, "terms/category/12"
+          Category, "categories/12"
         ).and_return category
 
         expect(client.find_category(12)).to eq category
@@ -287,7 +123,7 @@ module WordpressClient
         category = instance_double(Category)
 
         expect(connection).to receive(:create).with(
-          Category, "terms/category", name: "Foo"
+          Category, "categories", name: "Foo"
         ).and_return category
 
         expect(client.create_category(name: "Foo")).to eq category
@@ -296,8 +132,8 @@ module WordpressClient
       it "can be updated" do
         category = instance_double(Category)
 
-        expect(connection).to receive(:patch).with(
-          Category, "terms/category/45", name: "New"
+        expect(connection).to receive(:put).with(
+          Category, "categories/45", name: "New"
         ).and_return category
 
         expect(client.update_category(45, name: "New")).to eq category
@@ -307,12 +143,12 @@ module WordpressClient
     describe "tags" do
       it "can be listed" do
         expect(connection).to receive(:get_multiple).with(
-          Tag, "terms/tag", hash_including(page: 1, per_page: 10)
+          Tag, "tags", hash_including(page: 1, per_page: 10)
         )
         client.tags
 
         expect(connection).to receive(:get_multiple).with(
-          Tag, "terms/tag", hash_including(page: 2, per_page: 60)
+          Tag, "tags", hash_including(page: 2, per_page: 60)
         )
         client.tags(page: 2, per_page: 60)
       end
@@ -321,7 +157,7 @@ module WordpressClient
         tag = instance_double(Tag)
 
         expect(connection).to receive(:get).with(
-          Tag, "terms/tag/12"
+          Tag, "tags/12"
         ).and_return tag
 
         expect(client.find_tag(12)).to eq tag
@@ -331,7 +167,7 @@ module WordpressClient
         tag = instance_double(Tag)
 
         expect(connection).to receive(:create).with(
-          Tag, "terms/tag", name: "Foo"
+          Tag, "tags", name: "Foo"
         ).and_return tag
 
         expect(client.create_tag(name: "Foo")).to eq tag
@@ -340,8 +176,8 @@ module WordpressClient
       it "can be updated" do
         tag = instance_double(Tag)
 
-        expect(connection).to receive(:patch).with(
-          Tag, "terms/tag/45", name: "New"
+        expect(connection).to receive(:put).with(
+          Tag, "tags/45", name: "New"
         ).and_return tag
 
         expect(client.update_tag(45, name: "New")).to eq tag
@@ -400,7 +236,7 @@ module WordpressClient
       it "can be updated" do
         media = instance_double(Media)
 
-        expect(connection).to receive(:patch).with(
+        expect(connection).to receive(:put).with(
           Media, "media/7", title: "New"
         ).and_return(media)
 

data/spec/connection_spec.rb

@@ -135,31 +135,31 @@ module WordpressClient
           "id" => 1, "title" => "Bar"
         ).and_return(model_instance)
 
-        response = connection.patch(model, "foos/1", title: "Bar")
+        response = connection.put(model, "foos/1", title: "Bar")
         expect(response).to eq model_instance
       end
 
       it "can ignore responses" do
         stub_patch("#{base_url}/foos/1", {title: "Bar"}, returns: {id: 1, title: "Bar"})
-        response = connection.patch_without_response("foos/1", title: "Bar")
+        response = connection.put_without_response("foos/1", title: "Bar")
         expect(response).to be true
       end
 
       it "raises NotFoundError if response is 400 with rest_post_invalid_id as error code" do
         stub_patch(/./, {}, returns: json_fixture("invalid-post-id.json"), status: 400)
-        expect { connection.patch(model, "foo", {}) }.to raise_error(NotFoundError, /post id/i)
-        expect { connection.patch_without_response("foo", {}) }.to raise_error(NotFoundError)
+        expect { connection.put(model, "foo", {}) }.to raise_error(NotFoundError, /post id/i)
+        expect { connection.put_without_response("foo", {}) }.to raise_error(NotFoundError)
       end
 
       it "raises ValidationError on any other 400 responses" do
         stub_patch(/./, {}, returns: json_fixture("validation-error.json"), status: 400)
 
         expect {
-          connection.patch(model, "foo", {})
+          connection.put(model, "foo", {})
         }.to raise_error(ValidationError, /status is not one of/)
 
         expect {
-          connection.patch_without_response("foo", {})
+          connection.put_without_response("foo", {})
         }.to raise_error(ValidationError, /status is not one of/)
       end
     end
@@ -199,10 +199,7 @@ module WordpressClient
           headers: {
             "content-length" => "11",
             "content-type" => "text/plain",
-            # 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=foo.txt',
+            "content-disposition" => 'attachment; filename="foo.txt"',
           },
           body: "hello world",
         ).to_return(
@@ -260,7 +257,7 @@ module WordpressClient
     end
 
     def stub_patch(path, data, returns:, status: 200)
-      stub_request(:patch, path).with(
+      stub_request(:put, path).with(
         basic_auth: ['jane', 'doe'],
         headers: {"content-type" => "application/json; charset=#{"".encoding}"},
         body: data.to_json,