Add Document.move_to_draft + Document.update (#43)

* feat: Add support for `Document.move_to_draft` + `Document.update`

* fix: Add `metadata` field to Document object

* fix: Update `#update` to return empty response

* fix: Add `PandaDoc::Objects::Empty` object for empty responses

lib/panda_doc.rb

@@ -21,6 +21,7 @@
 require "panda_doc/objects/token"
 require "panda_doc/objects/field"
 require "panda_doc/objects/document"
+require "panda_doc/objects/empty"
 require "panda_doc/objects/error"
 require "panda_doc/objects/session"
 

lib/panda_doc/api_client.rb

@@ -51,6 +51,10 @@ def get(path, data = {})
       connection.get(normalized_path(path), **data)
     end
 
+    def patch(path, data = {})
+      connection.patch(normalized_path(path), **data)
+    end
+
     private
 
     def normalized_path(path)

lib/panda_doc/document.rb

@@ -8,6 +8,13 @@ def create(data)
       respond(ApiClient.request(:post, "/documents", **data))
     end
 
+    def update(uuid, **data)
+      respond(
+        ApiClient.request(:patch, "/documents/#{uuid}", **data),
+        type: :empty
+      )
+    end
+
     def send(uuid, **data)
       respond(ApiClient.request(:post, "/documents/#{uuid}/send", **data))
     end
@@ -20,6 +27,10 @@ def details(uuid)
       respond(ApiClient.request(:get, "/documents/#{uuid}/details"))
     end
 
+    def move_to_draft(uuid)
+      respond(ApiClient.request(:post, "/documents/#{uuid}/draft"))
+    end
+
     def session(uuid, **data)
       respond(
         ApiClient.request(:post, "/documents/#{uuid}/session", **data),

lib/panda_doc/objects/document.rb

@@ -15,6 +15,7 @@ class Document < Base
 
       attribute? :tokens, Types::Array.of(Objects::Token)
       attribute? :fields, Types::Array.of(Objects::Field)
+      attribute? :metadata, Types::Hash
 
       alias_method :created_at, :date_created
       alias_method :updated_at, :date_modified

lib/panda_doc/objects/empty.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    class Empty
+      def initialize(_response_body)
+      end
+    end
+  end
+end

spec/document_spec.rb

@@ -286,4 +286,50 @@
       it_behaves_like "a document object interface"
     end
   end
+
+  describe ".move_to_draft" do
+    subject { described_class.move_to_draft("uuid") }
+
+    before do
+      allow(PandaDoc::ApiClient).to receive(:request)
+        .with(:post, "/documents/uuid/draft")
+        .and_return(response)
+    end
+
+    context "with failed response" do
+      let(:response) { failed_response }
+
+      it_behaves_like "a failure result"
+    end
+
+    context "with successful response" do
+      let(:response) { successful_response }
+      let(:body) { document_body }
+
+      it_behaves_like "a document object interface"
+    end
+  end
+
+  describe ".update" do
+    subject { described_class.update("uuid", metadata: { hello: "world" })}
+
+    before do
+      allow(PandaDoc::ApiClient).to receive(:request)
+        .with(:patch, "/documents/uuid", metadata: { hello: "world" })
+        .and_return(response)
+    end
+
+    context "with failed response" do
+      let(:response) { failed_response }
+
+      it_behaves_like "a failure result"
+    end
+
+    context "with successful response" do
+      let(:response) { successful_response }
+      let(:body) { "" }
+
+      it { expect { subject }.not_to raise_error }
+    end
+  end
 end