panda_doc 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8849ee8f7c8311a7eb442ff4c1b059c94a6ec87fb039a23cc74b1dd06c0c6873
-  data.tar.gz: 4563201e0b177abf440381dc8f06ccf876603f9c9c45d34a71d54786ae615144
+  metadata.gz: e189a237a7930954bc8a7b2550037a49f8d371411aee0abbebd6463eff3c1806
+  data.tar.gz: 589a8c3207e8eed78061afa341e052287b77f278985047b32b924648cd1f353d
 SHA512:
-  metadata.gz: 74541a952ad1c7f327e220dd197ce0213fd2d9de697fb5e2743f46b72b5a2e1df94e7c801cf5b833406fac61751de1cbc4b2af643b7daa3b4c10f69e25cd34fa
-  data.tar.gz: 04ff0e440faac7e29d5f8b6bfa9ffe9f8bf31f0399eeeab18f6cc9940be1b482d74c47915c21d2b40b396328fca5bce3c1c37f172dcb13adfb1f97a55aece404
+  metadata.gz: 5e213cabf79b1661781d05a7038462022c7853328399dcf128bef59fdce266650f4e5a85db0850241287a8a3e105daadc31fbe185cc0d4d0e53a518f48735be0
+  data.tar.gz: 5b3aba148b0e22c1823bf8d8e6b9536090a1b9c96b9449c6f64316cbb40eea021915329d0686c5cc910beaa6471b04a6708d4268134696dd30b367b79d89cf1e

data/.github/workflows/ci.yml

@@ -13,15 +13,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.3'
           - '3.2'
           - '3.1'
           - '3.0'
-          - '2.7'
         include:
-          - ruby: '3.2'
+          - ruby: '3.3'
             coverage: '1'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - name: Setup Ruby
@@ -31,7 +31,7 @@ jobs:
       - name: Update rubygems
         run: |
           gem update --system
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: bundle-use-ruby-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
@@ -47,7 +47,7 @@ jobs:
         run: |
           bundle exec rake spec
       - name: Publish code coverage
-        if: ${{ matrix.coverage == '1' && github.actor != 'dependabot[bot]' }}
-        uses: paambaati/codeclimate-action@v3.1.1
+        if: ${{ matrix.coverage == '1' && github.actor != 'dependabot[bot]' && github.ref_name == 'main' }}
+        uses: paambaati/codeclimate-action@v8
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.5

data/CHANGELOG.md

@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.9.0][] (2024-07-12)
+
+New:
+
+- Add `Document.list` for [List Documents](https://developers.pandadoc.com/reference/list-documents) endpoint.
+  ```ruby
+  list = PandaDoc::Document.list
+  list.documents.first.name
+  => "Sample Name"
+  ```
+
+## [0.8.0][] (2024-07-12)
+
+New:
+
+- Optional `metadata` field which can be used to store arbitrary data (by @andrewvy)
+- `Document.move_to_draft` -> POST /documents/{id}/draft/ (by @andrewvy)
+- `Document.update` -> PATCH /documents/{id}/ (by @andrewvy)
+
 ## [0.7.0][] (2023-06-07)
 
 New:
@@ -182,7 +201,6 @@ New:
     response.error.detail => {"fields"=>["Field 'foo' does not exist."]}
   ```
 
-
 ## [0.0.2][] (2016-02-13)
 
 New:
@@ -204,7 +222,9 @@ Fixes:
 
 - Initial release
 
-[Unreleased]: https://github.com/opti/panda_doc/compare/v0.7.0...HEAD
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.9.0...HEAD
+[0.9.0]: https://github.com/opti/panda_doc/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/opti/panda_doc/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/opti/panda_doc/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/opti/panda_doc/compare/v0.5.3...v0.6.0
 [0.5.3]: https://github.com/opti/panda_doc/compare/v0.5.2...v0.5.3

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "bundler"
 gem "rake",    ">= 10.0"
-gem "rspec",   "~> 3.12"
+gem "rspec",   "~> 3.13"
 gem "byebug"
 
 group :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    panda_doc (0.7.0)
+    panda_doc (0.9.0)
       dry-configurable
       dry-struct
       faraday (>= 2.0.1, < 3.0)
@@ -10,17 +10,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    dry-configurable (1.0.1)
+    concurrent-ruby (1.3.4)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    dry-configurable (1.2.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    dry-core (1.0.0)
+    dry-core (1.0.2)
       concurrent-ruby (~> 1.0)
+      logger
       zeitwerk (~> 2.6)
-    dry-inflector (1.0.0)
+    dry-inflector (1.1.0)
     dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
@@ -30,42 +32,49 @@ GEM
       dry-types (>= 1.7, < 2)
       ice_nine (~> 0.11)
       zeitwerk (~> 2.6)
-    dry-types (1.7.1)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    faraday (2.7.6)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    faraday (2.12.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      json
+      logger
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.0.2)
+    faraday-net_http (3.3.0)
+      net-http
     ice_nine (0.11.2)
-    multipart-post (2.3.0)
-    rake (13.0.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    json (2.7.5)
+    logger (1.6.1)
+    multipart-post (2.4.1)
+    net-http (0.4.1)
+      uri
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    ruby2_keywords (0.0.5)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    zeitwerk (2.6.8)
+    uri (0.13.1)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   ruby
@@ -75,8 +84,8 @@ DEPENDENCIES
   byebug
   panda_doc!
   rake (>= 10.0)
-  rspec (~> 3.12)
+  rspec (~> 3.13)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.4.13
+   2.5.22

data/lib/panda_doc/api_client.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module PandaDoc
+  # This class is responsible for making HTTP requests to the PandaDoc API.
   class ApiClient
-
     class << self
       def request(verb, path, data = {})
         if file = data.delete(:file)
@@ -13,9 +13,8 @@ module PandaDoc
       end
     end
 
-    attr_reader :connection
+    attr_reader :connection, :url_prefix
 
-    attr_reader :url_prefix
     private :url_prefix
 
     def initialize(multipart: false)
@@ -51,6 +50,10 @@ module PandaDoc
       connection.get(normalized_path(path), **data)
     end
 
+    def patch(path, data = {})
+      connection.patch(normalized_path(path), **data)
+    end
+
     private
 
     def normalized_path(path)

data/lib/panda_doc/document.rb

@@ -4,10 +4,25 @@ module PandaDoc
   module Document
     extend self
 
+    # @param options [Hash]
+    def list(**options)
+      respond(
+        ApiClient.request(:get, "/documents", **options),
+        type: :documents_list
+      )
+    end
+
     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 +35,10 @@ module PandaDoc
       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),
@@ -48,7 +67,7 @@ module PandaDoc
     end
 
     def failure(response)
-      fail FailureResult.new(response) unless response.success?
+      raise FailureResult.new(response) unless response.success?
     end
   end
 end

data/lib/panda_doc/objects/document.rb

@@ -15,6 +15,7 @@ module PandaDoc
 
       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

data/lib/panda_doc/objects/documents_list.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    # Represents a list of documents
+    class DocumentsList < Base
+      attribute :results, Types::Array.of(Objects::Document).default([].freeze)
+
+      alias_method :documents, :results
+    end
+  end
+end

data/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

data/lib/panda_doc/response_factory.rb

@@ -10,7 +10,7 @@ module PandaDoc
     end
 
     def initialize(type)
-      @type = type.capitalize
+      @type = type.to_s.split('_').map(&:capitalize).join
     end
 
     def build

data/lib/panda_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PandaDoc
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/panda_doc.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Igor Pstyga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -109,6 +109,8 @@ files:
 - lib/panda_doc/failure_result.rb
 - lib/panda_doc/objects/base.rb
 - lib/panda_doc/objects/document.rb
+- lib/panda_doc/objects/documents_list.rb
+- lib/panda_doc/objects/empty.rb
 - lib/panda_doc/objects/error.rb
 - lib/panda_doc/objects/field.rb
 - lib/panda_doc/objects/recipient.rb
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API