panda_doc 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 002d94c7fb8aeb4356526f31c51616103804cbc5204c6cbd5a9c0139de80e69e
-  data.tar.gz: f256f702257465cb6ab027a0cc327a44bf3c0413565413c44d826845f649dbe1
+  metadata.gz: c4dd2d6ef5bbab06ca01e6f77e93630d0aa88aa56f21a6568ee6039c44fb75aa
+  data.tar.gz: 3046fec26dd0ab07fa5831d5c43081b915bc3b5021a70765c1e05481692d4f95
 SHA512:
-  metadata.gz: e233f412fce3a98634a6a01dc7c410813b63b390e7b51ccfc4ac4c49bbcbafdee637671dbfb64e6f5777add1e68c8e0f102cfdc40200b6654bf04602f3c7cad1
-  data.tar.gz: 58877fbc856fb7c153a12a12300aae02633d12d0e9201bd6eae00daca89628b65421e711b6cc779ef9493187c44636b24bd6ec037e650ea713087055f466175a
+  metadata.gz: 5bcfa0020c545ac0ff332fb532cf27df6cea7b6e645fe67182a4209d89ebcd80a0ca49b3568d43a920657dd2a6ff9c77f808dbe4064349a4752c7b6367653a14
+  data.tar.gz: 72726843bb0d147c50bfb8ada65eba7c45d60f7a0d93790019bb1d2b3fcc18b616c191159caa74752bd6aaa2f98e92847702d5901a567e6d8bedafd449b3c326

data/.travis.yml

@@ -1,14 +1,15 @@
-sudo: false
 language: ruby
+os: linux
+dist: xenial
 
 cache:
   - bundler
 
 rvm:
-  - 2.3
-  - 2.4
   - 2.5
   - 2.6
+  - 2.7
+  - 3.0
 
 env:
   global:

data/CHANGELOG.md

@@ -4,6 +4,32 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.5.0][] (2021-01-06)
+
+New:
+
+- Replace virtus with dry-struct.
+- Drop support for ruby < 2.5.
+- Add support for API-Key authentication.
+  ```ruby
+    PandaDoc.configure do |config|
+      config.api_key = "API Key"
+    end
+  ```
+
+- Add `id`, `expiration_date` and `version` to the response Document Object.
+- Add [Document details](https://developers.pandadoc.com/reference#document-details) endpoint
+  ```ruby
+    document = PandaDoc::Document.details("uuid")
+    document.tokens.first.name
+    => "Token.Name"
+
+    docuemnt.tokens.first.value
+    => "Token Value"
+  ```
+
+- Add ruby 3.0 to test coverage.
+
 ## [0.4.3][] (2019-03-06)
 
 Fixes:
@@ -123,7 +149,8 @@ Fixes:
 
 - Initial release
 
-[Unreleased]: https://github.com/opti/panda_doc/compare/v0.4.3...HEAD
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.5.0...HEAD
+[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
 [0.4.2]: https://github.com/opti/panda_doc/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/opti/panda_doc/compare/v0.4.0...v0.4.1

data/README.md

@@ -25,8 +25,13 @@ Or install it yourself as:
 
 ## Configuration
 
-Please refer to the [Authentication](https://developers.pandadoc.com/#authentication)
-documentation to get the idea how to get an access token.
+Both [API-Key](https://developers.pandadoc.com/reference#api-key-authentication-process) and [oAuth2.0 access token](https://developers.pandadoc.com/reference#authentication-process) authentications are supported.
+
+```ruby
+PandaDoc.configure do |config|
+  config.api_key = "api key"
+end
+```
 
 ```ruby
 PandaDoc.configure do |config|

data/lib/panda_doc.rb

@@ -1,27 +1,38 @@
+# frozen_string_literal: true
+
 require "forwardable"
+require "json"
 
 require "faraday"
 require "faraday_middleware"
-require "virtus"
-require "representable/hash"
+require "dry-struct"
+require "dry-configurable"
 
 require "panda_doc/api_client"
 require "panda_doc/configuration"
+require "panda_doc/coercions"
+require "panda_doc/types"
 require "panda_doc/failure_result"
 require "panda_doc/success_result"
 require "panda_doc/document"
 require "panda_doc/response_factory"
-require "panda_doc/objects/status"
+require "panda_doc/objects/base"
 require "panda_doc/objects/recipient"
+require "panda_doc/objects/token"
 require "panda_doc/objects/document"
 require "panda_doc/objects/error"
 require "panda_doc/objects/session"
-require "panda_doc/responses/document"
-require "panda_doc/responses/error"
-require "panda_doc/responses/session"
 
 require "panda_doc/version"
 
 module PandaDoc
-  # Your code goes here...
+  class << self
+    def configure(&block)
+      Configuration.configure(&block)
+    end
+
+    def configuration
+      Configuration.config
+    end
+  end
 end

data/lib/panda_doc/api_client.rb

@@ -1,15 +1,15 @@
-require "json"
+# frozen_string_literal: true
 
 module PandaDoc
   class ApiClient
 
     class << self
-      def request(verb, path, **data)
+      def request(verb, path, data = {})
         if file = data.delete(:file)
           data = { file: file, data: JSON.generate(data) }
         end
 
-        new(multipart: !!file).public_send(verb, path, data)
+        new(multipart: !!file).public_send(verb, path, **data)
       end
     end
 
@@ -21,7 +21,11 @@ module PandaDoc
     def initialize(multipart: false)
       @url_prefix = "/public/v1"
       @connection = Faraday.new(PandaDoc.configuration.endpoint) do |conn|
-        conn.authorization :Bearer, PandaDoc.configuration.access_token
+        if PandaDoc.configuration.api_key
+          conn.authorization "API-Key", PandaDoc.configuration.api_key
+        else
+          conn.authorization :Bearer, PandaDoc.configuration.access_token
+        end
 
         if multipart
           conn.request     :multipart
@@ -39,12 +43,12 @@ module PandaDoc
       end
     end
 
-    def post(path, **data)
-      connection.post(normalized_path(path), data)
+    def post(path, data = {})
+      connection.post(normalized_path(path), **data)
     end
 
-    def get(path, **data)
-      connection.get(normalized_path(path), data)
+    def get(path, data = {})
+      connection.get(normalized_path(path), **data)
     end
 
     private

data/lib/panda_doc/coercions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Coercions
+    def self.to_splitted_string(value)
+      value.to_s.split(".").last
+    end
+  end
+end

data/lib/panda_doc/configuration.rb

@@ -1,24 +1,13 @@
+# frozen_string_literal: true
+
 module PandaDoc
   class Configuration
-    attr_accessor :access_token
-    attr_accessor :logger
-
-    def endpoint
-      "https://api.pandadoc.com"
-    end
-  end
-
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
+    extend Dry::Configurable
 
-    def configuration=(config)
-      @configuration = config
-    end
+    setting :access_token
+    setting :api_key
+    setting :logger
 
-    def configure
-      yield configuration
-    end
+    setting :endpoint, "https://api.pandadoc.com"
   end
 end

data/lib/panda_doc/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PandaDoc
   module Document
     extend self
@@ -14,6 +16,10 @@ module PandaDoc
       respond(ApiClient.request(:get, "/documents/#{uuid}"))
     end
 
+    def details(uuid)
+      respond(ApiClient.request(:get, "/documents/#{uuid}/details"))
+    end
+
     def session(uuid, **data)
       respond(
         ApiClient.request(:post, "/documents/#{uuid}/session", data),
@@ -31,7 +37,7 @@ module PandaDoc
       failure(response)
 
       SuccessResult.new(
-        ResponseFactory.new(type).build.from_hash(response.body)
+        ResponseFactory.build(type).new(response.body)
       )
     end
 

data/lib/panda_doc/failure_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PandaDoc
   class FailureResult < StandardError
     extend Forwardable
@@ -11,7 +13,7 @@ module PandaDoc
 
     def initialize(response)
       @response = response
-      @error = Responses::Error.new(Objects::Error.new).from_hash(response.body)
+      @error = Objects::Error.new(response.body)
     end
 
     def to_s

data/lib/panda_doc/objects/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    class Base < Dry::Struct
+      transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/panda_doc/objects/document.rb

@@ -1,14 +1,23 @@
+# frozen_string_literal: true
+
 module PandaDoc
   module Objects
-    class Document
-      include Virtus.model
+    class Document < Base
+      attribute :id, Types::String
+      attribute? :uuid, Types::String
+      attribute :status, Types::Custom::DocumentStatus
+      attribute :name, Types::String
+      attribute? :recipients, Types::Array.of(Objects::Recipient)
+      attribute :date_created, Types::Params::DateTime
+      attribute :date_modified, Types::Params::DateTime
+      attribute? :expiration_date, Types::Params::DateTime.optional
+      attribute :version, Types::String.optional
+
+      attribute? :tokens, Types::Array.of(Objects::Token)
 
-      attribute :uuid,       String
-      attribute :status,     Objects::Status
-      attribute :name,       String
-      attribute :recipients, Array[Objects::Recipient]
-      attribute :created_at, DateTime
-      attribute :updated_at, DateTime
+      alias_method :created_at, :date_created
+      alias_method :updated_at, :date_modified
+      alias_method :expires_at, :expiration_date
     end
   end
 end

data/lib/panda_doc/objects/error.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module PandaDoc
   module Objects
-    class Error
-      include Virtus.model
-
-      attribute :type,    String
-      attribute :detail,  String
+    class Error < Base
+      attribute? :type, Types::Coercible::String.optional
+      attribute? :detail, Types::Params::Hash.optional | Types::Coercible::String.optional
     end
   end
 end

data/lib/panda_doc/objects/recipient.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module PandaDoc
   module Objects
-    class Recipient
-      include Virtus.model
-
-      attribute :email,          String
-      attribute :first_name,     String
-      attribute :last_name,      String
-      attribute :recipient_type, String
-      attribute :has_completed,  Axiom::Types::Boolean
+    class Recipient < Base
+      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
     end
   end
 end

data/lib/panda_doc/objects/session.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module PandaDoc
   module Objects
-    class Session
-      include Virtus.model
-
-      attribute :id,         String
-      attribute :expires_at, DateTime
+    class Session < Base
+      attribute :id, Types::Coercible::String
+      attribute :expires_at, Types::Params::DateTime
     end
   end
 end

data/lib/panda_doc/objects/token.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    class Token < Base
+      attribute :name, Types::Coercible::String
+      attribute :value, Types::Coercible::String.optional
+    end
+  end
+end

data/lib/panda_doc/response_factory.rb

@@ -1,28 +1,20 @@
+# frozen_string_literal: true
+
 module PandaDoc
   class ResponseFactory
     attr_reader :type
     private :type
 
+    def self.build(type)
+      new(type).build
+    end
+
     def initialize(type)
       @type = type.capitalize
     end
 
     def build
-      response_class.new(object_class.new)
-    end
-
-    private
-
-    def response_class
-      class_for("Responses")
-    end
-
-    def object_class
-      class_for("Objects")
-    end
-
-    def class_for(namespace)
-      Object.const_get("PandaDoc::#{namespace}::#{type}")
+      PandaDoc::Objects.const_get(type)
     end
   end
 end

data/lib/panda_doc/success_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PandaDoc
   class SuccessResult
     attr_reader :object

data/lib/panda_doc/types.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Types
+    include Dry.Types()
+
+    module Custom
+      DocumentStatus = Dry::Types["nominal.string"].constructor(
+        Coercions.method(:to_splitted_string)
+      )
+    end
+  end
+end

data/lib/panda_doc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PandaDoc
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/panda_doc.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'panda_doc/version'
+# frozen_string_literal: true
+
+require_relative "lib/panda_doc/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "panda_doc"
@@ -16,13 +15,13 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 2.2"
-  spec.add_dependency "faraday", "~> 0.9", ">= 0.9.2"
-  spec.add_dependency "faraday_middleware", "~> 0.10", ">= 0.10.0"
-  spec.add_dependency "virtus", "~> 1.0", ">= 1.0.5"
-  spec.add_dependency "representable", ">= 3.0.0"
+  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"
 end

metadata

@@ -1,89 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Igor Pstyga
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: representable
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.3'
 description: Ruby wrapper for PandaDoc.com API
 email:
 - igor.pstyga@gmail.com
@@ -105,43 +99,42 @@ files:
 - bin/setup
 - lib/panda_doc.rb
 - lib/panda_doc/api_client.rb
+- lib/panda_doc/coercions.rb
 - lib/panda_doc/configuration.rb
 - lib/panda_doc/document.rb
 - lib/panda_doc/failure_result.rb
+- lib/panda_doc/objects/base.rb
 - lib/panda_doc/objects/document.rb
 - lib/panda_doc/objects/error.rb
 - lib/panda_doc/objects/recipient.rb
 - lib/panda_doc/objects/session.rb
-- lib/panda_doc/objects/status.rb
+- lib/panda_doc/objects/token.rb
 - lib/panda_doc/response_factory.rb
-- lib/panda_doc/responses/document.rb
-- lib/panda_doc/responses/error.rb
-- lib/panda_doc/responses/session.rb
 - lib/panda_doc/success_result.rb
+- lib/panda_doc/types.rb
 - lib/panda_doc/version.rb
 - panda_doc.gemspec
 homepage: https://github.com/opti/panda_doc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API
 test_files: []

data/lib/panda_doc/objects/status.rb

@@ -1,9 +0,0 @@
-module PandaDoc
-  module Objects
-    class Status < Virtus::Attribute
-      def coerce(value)
-        value.to_s.split(".").last
-      end
-    end
-  end
-end

data/lib/panda_doc/responses/document.rb

@@ -1,21 +0,0 @@
-module PandaDoc
-  module Responses
-    class Document < Representable::Decorator
-      include Representable::Hash
-
-      property :uuid
-      property :status
-      property :name
-      property :created_at, as: :date_created
-      property :updated_at, as: :date_modified
-
-      collection :recipients, class: PandaDoc::Objects::Recipient do
-        property :email
-        property :first_name
-        property :last_name
-        property :recipient_type
-        property :has_completed
-      end
-    end
-  end
-end

data/lib/panda_doc/responses/error.rb

@@ -1,10 +0,0 @@
-module PandaDoc
-  module Responses
-    class Error < Representable::Decorator
-      include Representable::Hash
-
-      property :type
-      property :detail
-    end
-  end
-end

data/lib/panda_doc/responses/session.rb

@@ -1,10 +0,0 @@
-module PandaDoc
-  module Responses
-    class Session < Representable::Decorator
-      include Representable::Hash
-
-      property :id
-      property :expires_at
-    end
-  end
-end