panda_doc 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9178f289db10d3bf60e5a5ae645ff003d03826d05a6f5fe70d015beb68e6ecc5
-  data.tar.gz: bac876ff0320cf75eac8fe8ec1c9c37992d9aa30961b257313d307fc5ab0314d
+  metadata.gz: 15388d36657b02a29ab9ab4113517330173b50363488d5570075acfc97fd2644
+  data.tar.gz: cd93797418157b2922fb6bda62452548f03714b4296f92bb50c453e9836ecd86
 SHA512:
-  metadata.gz: d024634cfcb55517bae71a144d8107d9a9d2cb03fa63d022b00c511d5a2f730b86592a0d14a6417db52b895ebea612ec57131e0327268c0167d024f76895a650
-  data.tar.gz: 04144545c90646efe63f32f4c7c02a15b6ed7e00736e5d19b91a01810e886fedffb8036897a2d89f16395c2f3364df38ccb515f306e8a5536594985a6e5ff221
+  metadata.gz: 3edd1e118866f67d64c4d9ba9b46518f3ec786253166e34f3e93c1e975597ab43b90543dc9da6d804bcf6c3b13542e819ac112233b4568c4f77be677c3a273b6
+  data.tar.gz: c8e74fe1e14ef159991fd514f5ac906b51d54a183bbc55996a6dcc6d4dc5b0c330c3545843f231adec953e4f16af107d34406c6318ac88ae5a36fbc2046b0e17

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.1'
+          - '3.0'
+          - '2.7'
+          - '2.6'
+        include:
+          - ruby: '3.1'
+            coverage: '1'
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update rubygems
+        run: |
+          gem update --system
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-use-ruby-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            bundle-use-ruby-${{ matrix.ruby }}-
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        env:
+          SIMPLECOV: ${{ matrix.coverage }}
+        run: |
+          bundle exec rake spec
+      - name: Publish code coverage
+        if: ${{ matrix.coverage == '1' }}
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -4,6 +4,40 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.6.0][] (2022-05-04)
+
+New:
+
+- Add `roles`, `shared_link` and `contact_id` to the recipient in the document details response:
+  ```ruby
+    document = PandaDoc::Document.details("uuid")
+    document.recipients.first.roles
+    => ["Signer", "Reviewer"]
+
+    document.recipients.first.shared_link
+    => "https://app.pandadoc.com/document/b7f11ea3c09d1c11208cc122457d4f3a2829d364"
+
+    document.recipients.first.contact_id
+    => "7kqXgjFejB2toXxjcC5jfZ"
+  ```
+
+Fixes:
+
+- Fixes #11 - make `FailureResult#response` public
+- Fixes #8 - make `Recipient` attributes optional
+
+## [0.5.3][] (2021-11-03)
+
+Fixes:
+
+- Fixes #5 - make `placeholder` attribute optional (@acuster77)
+
+## [0.5.2][] (2021-03-08)
+
+Fixes:
+
+- Fixes #3 - `Dry::Struct::Error` when token.value is not provided.
+
 ## [0.5.1][] (2021-01-08)
 
 New:
@@ -163,7 +197,10 @@ Fixes:
 
 - Initial release
 
-[Unreleased]: https://github.com/opti/panda_doc/compare/v0.5.1...HEAD
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.6.0...HEAD
+[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
 [0.5.1]: https://github.com/opti/panda_doc/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/opti/panda_doc/compare/v0.4.3...v0.5.0
 [0.4.3]: https://github.com/opti/panda_doc/compare/v0.4.2...v0.4.3

data/Gemfile

@@ -9,5 +9,5 @@ gem "rspec",   "~> 3.4"
 gem "byebug"
 
 group :test do
-  gem 'simplecov', require: false
+  gem "simplecov", "~> 0.17.1", require: false
 end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    panda_doc (0.6.0)
+      dry-configurable
+      dry-struct
+      faraday (>= 0.9.2, < 2.0)
+      faraday_middleware (>= 0.10.0, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.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)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      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)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  panda_doc!
+  rake (>= 10.0)
+  rspec (~> 3.4)
+  simplecov (~> 0.17.1)
+
+BUNDLED WITH
+   2.3.13

data/README.md

@@ -3,7 +3,7 @@
 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://travis-ci.org/opti/panda_doc.svg?branch=master)](http://travis-ci.org/opti/panda_doc)
+[![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)
 

data/lib/panda_doc/api_client.rb

@@ -22,9 +22,9 @@ module PandaDoc
       @url_prefix = "/public/v1"
       @connection = Faraday.new(PandaDoc.configuration.endpoint) do |conn|
         if PandaDoc.configuration.api_key
-          conn.authorization "API-Key", PandaDoc.configuration.api_key
+          conn.request :authorization, "API-Key", PandaDoc.configuration.api_key
         else
-          conn.authorization :Bearer, PandaDoc.configuration.access_token
+          conn.request :authorization, :Bearer, PandaDoc.configuration.access_token
         end
 
         if multipart

data/lib/panda_doc/configuration.rb

@@ -8,6 +8,6 @@ module PandaDoc
     setting :api_key
     setting :logger
 
-    setting :endpoint, "https://api.pandadoc.com"
+    setting :endpoint, default: "https://api.pandadoc.com"
   end
 end

data/lib/panda_doc/failure_result.rb

@@ -9,7 +9,6 @@ module PandaDoc
     attr_reader :error
 
     attr_reader :response
-    private :response
 
     def initialize(response)
       @response = response

data/lib/panda_doc/objects/field.rb

@@ -6,7 +6,7 @@ module PandaDoc
       attribute :uuid, Types::Coercible::String
       attribute :name, Types::Coercible::String.optional
       attribute :title, Types::Coercible::String.optional
-      attribute :placeholder, Types::Coercible::String.optional
+      attribute? :placeholder, Types::Coercible::String.optional
       attribute :value, Types::Nil | Types::Hash | Types::Coercible::String
       attribute? :assigned_to, PandaDoc::Objects::Recipient
     end

data/lib/panda_doc/objects/recipient.rb

@@ -4,13 +4,16 @@ module PandaDoc
   module Objects
     class Recipient < Base
       attribute? :id, Types::Coercible::String.optional
-      attribute :email, Types::Coercible::String
-      attribute :first_name, Types::Coercible::String.optional
-      attribute :last_name, Types::Coercible::String.optional
-      attribute :recipient_type, Types::Coercible::String
-      attribute :has_completed, Types::Params::Bool
+      attribute? :email, Types::Coercible::String
+      attribute? :first_name, Types::Coercible::String.optional
+      attribute? :last_name, Types::Coercible::String.optional
+      attribute? :recipient_type, Types::Coercible::String
+      attribute? :has_completed, Types::Params::Bool
       attribute? :role, Types::Coercible::String.optional
       attribute? :type, Types::Coercible::String.optional
+      attribute? :roles, Types::Array.of(Types::Coercible::String)
+      attribute? :contact_id, Types::Coercible::String.optional
+      attribute? :shared_link, Types::Coercible::String.optional
     end
   end
 end

data/lib/panda_doc/objects/token.rb

@@ -3,8 +3,8 @@
 module PandaDoc
   module Objects
     class Token < Base
-      attribute :name, Types::Coercible::String
-      attribute :value, Types::Coercible::String.optional
+      attribute :name, Types::Coercible::String.optional
+      attribute? :value, Types::Coercible::String.optional
     end
   end
 end

data/lib/panda_doc/version.rb

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

data/panda_doc.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   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.add_dependency "dry-configurable", "~> 0.11"
-  spec.add_dependency "dry-struct", "~> 1.3"
+  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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Igor Pstyga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-09 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -54,30 +54,30 @@ dependencies:
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 description: Ruby wrapper for PandaDoc.com API
 email:
 - igor.pstyga@gmail.com
@@ -85,11 +85,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-os: linux
-dist: xenial
-
-cache:
-  - bundler
-
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=d1d9c0636042863489880dbdf1c8865721b9b70f4199d612d77ee2dcfc803704
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-before_script:
-  - bundle update
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bin/rake
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT