panda_doc 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15388d36657b02a29ab9ab4113517330173b50363488d5570075acfc97fd2644
-  data.tar.gz: cd93797418157b2922fb6bda62452548f03714b4296f92bb50c453e9836ecd86
+  metadata.gz: 40c4774251d60005e024d1ae28a5568fd3a1e8c438d83abe3e08f4824e3e67aa
+  data.tar.gz: dd09ac16cf4dc968537462e12fae7483c26d80d3623f388b52ba1c64cac2701b
 SHA512:
-  metadata.gz: 3edd1e118866f67d64c4d9ba9b46518f3ec786253166e34f3e93c1e975597ab43b90543dc9da6d804bcf6c3b13542e819ac112233b4568c4f77be677c3a273b6
-  data.tar.gz: c8e74fe1e14ef159991fd514f5ac906b51d54a183bbc55996a6dcc6d4dc5b0c330c3545843f231adec953e4f16af107d34406c6318ac88ae5a36fbc2046b0e17
+  metadata.gz: 7e8ec163353b05d1d73ffce4dd41114824b06f4ae4d233fa32fafa325e469bb01fca4710cf09aab027a1be9fef9e81ee68c7701a63293205891fee7dce0a452c
+  data.tar.gz: b80b8d50cbbd703dc8ccd4ff2004b5e49307fff5ac1bb43041bbb16ab5f851ab3dfc1577c1df60363ae9945ed5835b11755884488f6bc1346791485bfb82b049

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

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'
-          - '2.6'
         include:
-          - ruby: '3.1'
+          - ruby: '3.3'
             coverage: '1'
     steps:
-      - uses: actions/checkout@v2
+      - 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@v2
+      - 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' }}
-        uses: paambaati/codeclimate-action@v3.0.0
+        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/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '17 0 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.3.4

data/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [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:
+
+- Drop ruby 2.6
+- Update to Faraday 2
+
 ## [0.6.0][] (2022-05-04)
 
 New:
@@ -197,7 +212,9 @@ Fixes:
 
 - Initial release
 
-[Unreleased]: https://github.com/opti/panda_doc/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.8.0...HEAD
+[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
 [0.5.2]: https://github.com/opti/panda_doc/compare/v0.5.1...v0.5.2

data/Gemfile

@@ -5,9 +5,9 @@ gemspec
 
 gem "bundler"
 gem "rake",    ">= 10.0"
-gem "rspec",   "~> 3.4"
+gem "rspec",   "~> 3.13"
 gem "byebug"
 
 group :test do
-  gem "simplecov", "~> 0.17.1", require: false
+  gem "simplecov", "~> 0.22.0", require: false
 end

data/Gemfile.lock

@@ -1,85 +1,77 @@
 PATH
   remote: .
   specs:
-    panda_doc (0.6.0)
+    panda_doc (0.8.0)
       dry-configurable
       dry-struct
-      faraday (>= 0.9.2, < 2.0)
-      faraday_middleware (>= 0.10.0, < 2.0)
+      faraday (>= 2.0.1, < 3.0)
+      faraday-multipart (>= 1.0.0, < 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
+    concurrent-ruby (1.3.3)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    dry-configurable (0.13.0)
+    dry-configurable (1.2.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-container (0.9.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.1.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
-      concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.1)
-    dry-logic (1.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-struct (1.4.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.5)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
       ice_nine (~> 0.11)
-    dry-types (1.5.1)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    faraday (2.10.0)
+      faraday-net_http (>= 2.0, < 3.2)
+      logger
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.1.0)
+      net-http
     ice_nine (0.11.2)
-    json (2.6.1)
-    multipart-post (2.1.1)
-    rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    logger (1.6.0)
+    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.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    ruby2_keywords (0.0.5)
-    simplecov (0.17.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    uri (0.13.0)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   ruby
@@ -89,8 +81,8 @@ DEPENDENCIES
   byebug
   panda_doc!
   rake (>= 10.0)
-  rspec (~> 3.4)
-  simplecov (~> 0.17.1)
+  rspec (~> 3.13)
+  simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.3.13
+   2.5.15

data/README.md

@@ -4,8 +4,8 @@ PandaDoc gem is a simple wrapper for PandaDoc.com API. Please check the official
 API [documenation](https://developers.pandadoc.com) for more details.
 
 [![Build Status](https://github.com/opti/panda_doc/actions/workflows/ci.yml/badge.svg)](https://github.com/opti/panda_doc/actions/workflows/ci.yml)
-[![Code Climate](https://codeclimate.com/github/opti/panda_doc/badges/gpa.svg)](https://codeclimate.com/github/opti/panda_doc)
-[![Test Coverage](https://codeclimate.com/github/opti/panda_doc/badges/coverage.svg)](https://codeclimate.com/github/opti/panda_doc/coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ab0b236ae2c499659214/maintainability)](https://codeclimate.com/github/opti/panda_doc/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ab0b236ae2c499659214/test_coverage)](https://codeclimate.com/github/opti/panda_doc/test_coverage)
 
 ## Installation
 

data/lib/panda_doc/api_client.rb

@@ -51,6 +51,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

@@ -5,11 +5,18 @@ module PandaDoc
     extend self
 
     def create(data)
-      respond(ApiClient.request(:post, "/documents", 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))
+      respond(ApiClient.request(:post, "/documents/#{uuid}/send", **data))
     end
 
     def find(uuid)
@@ -20,9 +27,13 @@ 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),
+        ApiClient.request(:post, "/documents/#{uuid}/session", **data),
         type: :session
       )
     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/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/version.rb

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

data/lib/panda_doc.rb

@@ -4,7 +4,7 @@ require "forwardable"
 require "json"
 
 require "faraday"
-require "faraday_middleware"
+require "faraday/multipart"
 require "dry-struct"
 require "dry-configurable"
 
@@ -21,6 +21,7 @@ require "panda_doc/objects/recipient"
 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"
 

data/panda_doc.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
-  spec.add_dependency "faraday", ">= 0.9.2", "< 2.0"
-  spec.add_dependency "faraday_middleware", ">= 0.10.0", "< 2.0"
+  spec.required_ruby_version = ">= 2.7"
+  spec.add_dependency "faraday", ">= 2.0.1", "< 3.0"
+  spec.add_dependency "faraday-multipart", ">= 1.0.0", "< 2.0"
   spec.add_dependency "dry-configurable"
   spec.add_dependency "dry-struct"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Igor Pstyga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,27 +16,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -85,7 +85,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -107,6 +109,7 @@ files:
 - lib/panda_doc/failure_result.rb
 - lib/panda_doc/objects/base.rb
 - lib/panda_doc/objects/document.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
@@ -129,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API