pandadoc-api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 61692462d6fb1acc26ec5e85df32b4ac9e70967180aff6fea6a8a1a0194fe5f1
-  data.tar.gz: d9c88b82dcc3fb14051b0eb736043baf1976b890c7c26fcd5d7a3c05962b32fb
+SHA1:
+  metadata.gz: 10a86d130a08c5c79a6c1b02d152b4f2d754cfc8
+  data.tar.gz: 465fce230f81e9fa134f7e20d09f39987d10371f
 SHA512:
-  metadata.gz: d49e7e155f81b4c6350ef2c904fdefe7bf3d96accfed367f0370992da9dbaf15c74ab2df5c49c3cbec22f37a7b595156be52f4784b0c280f180ef1e8fd73d41d
-  data.tar.gz: 982828af5c1ca819dfe5e877e7b0404350c3d5b028b40d50713ca258dfdfdf68a79cfe5ee0b80d8dae27d0ee4cdc12aa04ad3c72b9a1aa472413e19cc9747ce6
+  metadata.gz: b87a992ae237c8e433defdddb2fea5e2796cab50c6332aad3b63356df51a0d27421eaa841d3e3f14bf26e65e20042067a49bcdfedee8c6af4612da62c07e2c16
+  data.tar.gz: eecc463b78d67bf4d21441eb42b2a06149f0a12df8e58cdf030f0bc37f9403e6a53c079bc84b66e07ca30c16453efdd53fdea1cd1c00b54ad17e4e18b0833c72

data/lib/pandadoc/api.rb

@@ -1,3 +1,5 @@
+require 'pandadoc/api/client'
+require 'pandadoc/api/params_validator'
 require 'pandadoc/api/version'
 require 'pandadoc/api/document'
 require 'pandadoc/api/template'

data/lib/pandadoc/api/client.rb

@@ -0,0 +1,31 @@
+require 'httparty'
+
+module Pandadoc
+  module Api
+    class Client
+      def get(path, token, params = {})
+        uri = build_uri(path)
+        HTTParty.get(uri, headers: default_headers(token), query: params)
+      end
+
+      def post_json(path, token, params = {})
+        uri = build_uri(path)
+        headers = default_headers(token).merge('Content-Type' => 'application/json')
+
+        HTTParty.post(uri, headers: headers, body: params.to_json)
+      end
+
+      private
+
+      def default_headers(token)
+        {
+          'Authorization' => "Bearer #{token}"
+        }
+      end
+
+      def build_uri(path)
+        File.join(Pandadoc::Api::API_ROOT, path)
+      end
+    end
+  end
+end

data/lib/pandadoc/api/document.rb

@@ -1,31 +1,3 @@
-require 'httparty'
-
-class RequiredParameterError < StandardError
-  attr_reader :parameter
-
-  def initialize(message, parameter)
-    # Call the parent's constructor to set the message
-    super(message)
-
-    # Store the action in an instance variable
-    @parameter = parameter
-  end
-end
-
-class ParameterTypeError < StandardError
-  attr_reader :received
-  attr_reader :requested
-
-  def initialize(message, received, requested)
-    # Call the parent's constructor to set the message
-    super(message)
-
-    # Store the action in an instance variable
-    @received = received
-    @requested = requested
-  end
-end
-
 module Pandadoc
   module Api
     class Document
@@ -52,9 +24,7 @@ module Pandadoc
           metadata: { required: false, type: Hash }
         }
 
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/documents",
-                     headers: { 'Authorization' => auth_header(token) },
-                     query: validated_params(params, validations))
+        client.get '/documents', token, validated_params(params, validations)
       end
 
       def create(token, params = {})
@@ -62,25 +32,21 @@ module Pandadoc
           name: { required: true, type: String },
           template_uuid: { required: true, type: String },
           recipients: { required: true, type: Array },
-          tokens: { required: false, type: Hash },
+          tokens: { required: false, type: Array },
           fields: { required: false, type: Hash },
           metadata: { required: false, type: Hash },
           pricing_tables: { required: false, type: Array }
         }
 
-        HTTParty.post("#{Pandadoc::Api::API_ROOT}/documents",
-                      headers: { 'Authorization' => auth_header(token), 'Content-Type': 'application/json' },
-                      body: validated_params(params, validations).to_json)
+        client.post_json '/documents', token, validated_params(params, validations)
       end
 
       def status(token, document_id)
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/documents/#{document_id}",
-                     headers: { 'Authorization' => auth_header(token) })
+        client.get "/documents/#{document_id}", token
       end
 
       def details(token, document_id)
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/documents/#{document_id}/details",
-                     headers: { 'Authorization' => auth_header(token) })
+        client.get "/documents/#{document_id}/details", token
       end
 
       # send is already a Ruby thing, overriding it would be bad
@@ -90,9 +56,7 @@ module Pandadoc
           silent: { required: false, type: [TrueClass, FalseClass] }
         }
 
-        HTTParty.post("#{Pandadoc::Api::API_ROOT}/documents/#{document_id}/send",
-                      headers: { 'Authorization' => auth_header(token), 'Content-Type': 'application/json' },
-                      body: validated_params(params, validations))
+        client.post_json "/documents/#{document_id}/send", token, validated_params(params, validations)
       end
 
       def link(token, document_id, params = {})
@@ -101,9 +65,7 @@ module Pandadoc
           lifetime: { required: false, type: Integer }
         }
 
-        response = HTTParty.post("#{Pandadoc::Api::API_ROOT}/documents/#{document_id}/session",
-                                 headers: { 'Authorization' => auth_header(token), 'Content-Type': 'application/json' },
-                                 body: validated_params(params, validations))
+        response = client.post_json "/documents/#{document_id}/session", token, validated_params(params, validations)
 
         json_response = JSON.parse(response.body, symbolize_names: true)
         session_id = json_response[:id]
@@ -112,30 +74,17 @@ module Pandadoc
       end
 
       def download(token, document_id)
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/documents/#{document_id}/download",
-                     headers: { 'Authorization' => auth_header(token) })
+        client.get "/documents/#{document_id}/download", token
       end
 
-      def auth_header(token)
-        "Bearer #{token}"
+      private
+
+      def client
+        @client ||= Pandadoc::Api::Client.new
       end
 
       def validated_params(params, validations)
-        valid_keys = validations.keys
-        valid_params = params.keep_if { |key| valid_keys.include? key }
-
-        validations.each_pair do |key, validators|
-          if validators[:required] == true && valid_params[key].nil?
-            raise RequiredParameterError.new('Missing required parameter', key)
-          end
-
-          validators_type_array = validators[:type].is_a?(Array) ? validators[:type] : [validators[:type]]
-          if valid_params[key] && !validators_type_array.include?(valid_params[key].class)
-            raise ParameterTypeError.new("Invalid parameter type, received #{valid_params[key].class} requested #{validators[:type]}", valid_params[:key].class, validators[:type])
-          end
-        end
-
-        valid_params
+        Pandadoc::Api::ParamsValidator.validate(params, validations)
       end
     end
   end

data/lib/pandadoc/api/params_validator.rb

@@ -0,0 +1,49 @@
+module Pandadoc
+  module Api
+    class ParamsValidator
+      class RequiredParameterError < StandardError
+        attr_reader :parameter
+
+        def initialize(message, parameter)
+          # Call the parent's constructor to set the message
+          super(message)
+
+          # Store the action in an instance variable
+          @parameter = parameter
+        end
+      end
+
+      class ParameterTypeError < StandardError
+        attr_reader :received
+        attr_reader :requested
+
+        def initialize(message, received, requested)
+          # Call the parent's constructor to set the message
+          super(message)
+
+          # Store the action in an instance variable
+          @received = received
+          @requested = requested
+        end
+      end
+
+      def self.validate(params, validations)
+        valid_keys = validations.keys
+        valid_params = params.keep_if { |key| valid_keys.include? key }
+
+        validations.each_pair do |key, validators|
+          if validators[:required] == true && valid_params[key].nil?
+            raise RequiredParameterError.new('Missing required parameter', key)
+          end
+
+          validators_type_array = validators[:type].is_a?(Array) ? validators[:type] : [validators[:type]]
+          if valid_params[key] && !validators_type_array.include?(valid_params[key].class)
+            raise ParameterTypeError.new("Invalid parameter type, received #{valid_params[key].class} requested #{validators[:type]}", valid_params[:key].class, validators[:type])
+          end
+        end
+
+        valid_params
+      end
+    end
+  end
+end

data/lib/pandadoc/api/template.rb

@@ -1,5 +1,3 @@
-require 'httparty'
-
 module Pandadoc
   module Api
     class Template
@@ -11,36 +9,21 @@ module Pandadoc
           page: { required: false, type: Integer }
         }
 
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/templates",
-                     headers: { 'Authorization' => auth_header(token) },
-                     query: validated_params(params, validations))
+        client.get '/templates', token, validated_params(params, validations)
       end
 
       def details(token, template_id)
-        HTTParty.get("#{Pandadoc::Api::API_ROOT}/templates/#{template_id}/details",
-                     headers: { 'Authorization' => auth_header(token) })
+        client.get "/templates/#{template_id}/details", token
       end
 
-      def auth_header(token)
-        "Bearer #{token}"
-      end
+      private
 
       def validated_params(params, validations)
-        valid_keys = validations.keys
-        valid_params = params.keep_if { |key| valid_keys.include? key }
-
-        validations.each_pair do |key, validators|
-          if validators[:required] == true && valid_params[key].nil?
-            raise RequiredParameterError.new('Missing required parameter', key)
-          end
-
-          validators_type_array = validators[:type].is_a?(Array) ? validators[:type] : [validators[:type]]
-          if valid_params[key] && !validators_type_array.include?(valid_params[key].class)
-            raise ParameterTypeError.new("Invalid parameter type, received #{valid_params[key].class} requested #{validators[:type]}", valid_params[:key].class, validators[:type])
-          end
-        end
+        Pandadoc::Api::ParamsValidator.validate(params, validations)
+      end
 
-        valid_params
+      def client
+        @client ||= Pandadoc::Api::Client.new
       end
     end
   end

data/lib/pandadoc/api/version.rb

@@ -1,5 +1,5 @@
 module Pandadoc
   module Api
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.1.4'.freeze
   end
 end

data/pandadoc-api.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.58'
   spec.add_development_dependency 'webmock', '~> 3.4'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pandadoc-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Michael Carey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby API Wrapper for the PandaDoc API
 email:
 - mike@catchandrelease.com
@@ -114,7 +128,9 @@ files:
 - bin/console
 - bin/setup
 - lib/pandadoc/api.rb
+- lib/pandadoc/api/client.rb
 - lib/pandadoc/api/document.rb
+- lib/pandadoc/api/params_validator.rb
 - lib/pandadoc/api/template.rb
 - lib/pandadoc/api/version.rb
 - pandadoc-api.gemspec
@@ -138,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby API Wrapper for the PandaDoc API