pdfmonkey 0.9.0 → 1.0.0

data/lib/pdfmonkey/resource.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'json'
+
+module Pdfmonkey
+  class Resource
+    extend Forwardable
+
+    module Fetchable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def fetch(id)
+          new(id: id).reload!
+        end
+      end
+
+      def reload!
+        new_attrs = adapter.call(:get, self)
+        update(new_attrs)
+        self
+      end
+    end
+
+    module Creatable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def create(**attrs)
+          new(**attrs).save
+        end
+      end
+
+      def save
+        if attributes[:id] && !is_a?(Updatable)
+          raise Pdfmonkey::Error, "Cannot save an existing #{self.class.name} (updates are not supported)"
+        end
+
+        method = attributes[:id] ? :put : :post
+        new_attrs = adapter.call(method, self)
+        update(new_attrs)
+        self
+      end
+    end
+
+    module Updatable
+      def update!(**new_attrs)
+        previous = {}
+        new_attrs.each_key do |key|
+          sym_key = key.to_sym
+          previous[sym_key] = attributes[sym_key] if self.class::ATTRIBUTES.include?(sym_key)
+        end
+
+        update(new_attrs)
+        response_attrs = adapter.call(:put, self)
+        update(response_attrs)
+        self
+      rescue StandardError
+        update(previous)
+        raise
+      end
+    end
+
+    module Deletable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def delete(id)
+          new(id: id).delete!
+        end
+      end
+
+      def delete!
+        adapter.call(:delete, self)
+      end
+    end
+
+    module Listable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def list(page: 'all', **filters)
+          if const_defined?(:FILTERS, false)
+            unknown = filters.keys - self::FILTERS.keys
+            raise ArgumentError, "Unknown filter(s): #{unknown.join(', ')}" if unknown.any?
+          elsif filters.any?
+            raise ArgumentError, "#{name} does not support filters"
+          end
+
+          adapter = Pdfmonkey.current_adapter || Pdfmonkey::Adapter.new
+          fetch_page(adapter, page: page, **filters)
+        end
+
+        private def fetch_page(adapter, page:, **filters)
+          params = { 'page[number]' => page }
+
+          if const_defined?(:FILTERS, false)
+            self::FILTERS.each do |kwarg, api_param|
+              params[api_param] = filters[kwarg] unless filters[kwarg].nil?
+            end
+          end
+
+          body = adapter.call(:get, self, params: params, extract: :collection)
+
+          collection_key = self::COLLECTION
+          items = body.fetch(collection_key, []).map do |attrs|
+            resource_attrs = attrs.transform_keys(&:to_sym)
+            resource_attrs.delete(:adapter)
+            new(adapter: adapter, **resource_attrs)
+          end
+
+          page_fetcher = lambda do |page_number|
+            fetch_page(adapter, page: page_number, **filters)
+          end
+
+          Collection.new(
+            items: items,
+            meta: body.fetch('meta', {}),
+            page_fetcher: page_fetcher
+          )
+        end
+      end
+    end
+
+    def initialize(adapter: Pdfmonkey.current_adapter || Pdfmonkey::Adapter.new, **attrs)
+      @adapter = adapter
+      @attributes = self.class.attributes_struct.new
+      update(attrs)
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && !attributes[:id].nil? && attributes[:id] == other.send(:attributes)[:id]
+    end
+    alias eql? ==
+
+    def hash
+      [self.class, attributes[:id] || object_id].hash
+    end
+
+    SENSITIVE_ATTRIBUTES = %i[auth_token].freeze
+
+    def inspect
+      attrs = self.class::ATTRIBUTES
+              .filter_map do |key|
+                next if attributes[key].nil?
+
+                value = SENSITIVE_ATTRIBUTES.include?(key) ? '[FILTERED]' : attributes[key].inspect
+                "#{key}: #{value}"
+              end
+              .join(', ')
+
+      "#<#{self.class} #{attrs}>"
+    end
+
+    def to_h
+      attributes.to_h
+    end
+
+    def to_json(state = nil)
+      attrs = attributes.to_h.compact
+      attrs.delete(:errors)
+
+      member = self.class::MEMBER
+      { member => attrs }.to_json(state)
+    end
+
+    ATTRIBUTES_STRUCT_MUTEX = Mutex.new
+    private_constant :ATTRIBUTES_STRUCT_MUTEX
+
+    def self.attributes_struct
+      return @attributes_struct if @attributes_struct
+
+      ATTRIBUTES_STRUCT_MUTEX.synchronize do
+        @attributes_struct ||= Struct.new(*self::ATTRIBUTES, keyword_init: true)
+      end
+    end
+
+    private attr_reader :adapter, :attributes
+
+    private def update(new_attributes)
+      valid_attrs = self.class::ATTRIBUTES
+      new_attributes.each do |key, value|
+        sym_key = key.to_sym
+        attributes[sym_key] = value if valid_attrs.include?(sym_key)
+      end
+    end
+  end
+end

data/lib/pdfmonkey/snippet.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class Snippet < Resource
+    include Fetchable
+    include Creatable
+    include Updatable
+    include Deletable
+    include Listable
+
+    ATTRIBUTES = %i[
+      code
+      created_at
+      creator_name
+      errors
+      id
+      identifier
+      updated_at
+      updater_name
+      workspace_id
+    ].freeze
+
+    COLLECTION = 'snippets'
+    MEMBER = 'snippet'
+
+    def_delegators :attributes, *ATTRIBUTES
+  end
+end

data/lib/pdfmonkey/template.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class Template < Resource
+    include Fetchable
+    include Creatable
+    include Updatable
+    include Deletable
+
+    ATTRIBUTES = %i[
+      app_id
+      auth_token
+      body
+      body_draft
+      checksum
+      created_at
+      deleted_at
+      edition_mode
+      errors
+      id
+      identifier
+      output_type
+      pdf_engine_draft_id
+      pdf_engine_id
+      preview_url
+      sample_data
+      sample_data_draft
+      scss_style
+      scss_style_draft
+      settings
+      settings_draft
+      template_folder_id
+      ttl
+      updated_at
+    ].freeze
+
+    DRAFT_MAPPING = {
+      body: :body_draft,
+      scss_style: :scss_style_draft,
+      settings: :settings_draft,
+      sample_data: :sample_data_draft,
+      pdf_engine_id: :pdf_engine_draft_id
+    }.freeze
+
+    COLLECTION = 'document_templates'
+    MEMBER = 'document_template'
+
+    def_delegators :attributes, *ATTRIBUTES
+
+    def self.create(**attrs)
+      super(**remap_to_draft(attrs))
+    end
+
+    def self.list_cards(**)
+      Pdfmonkey::TemplateCard.list(**)
+    end
+
+    def self.fetch_full(id)
+      fetch(id)
+    end
+
+    def update!(**new_attrs)
+      super(**self.class.send(:remap_to_draft, new_attrs))
+    end
+
+    def publish!
+      DRAFT_MAPPING.each do |published_key, draft_key|
+        attributes[published_key] = attributes[draft_key]
+      end
+
+      response_attrs = adapter.call(:put, self)
+      update(response_attrs)
+      self
+    end
+
+    private_class_method def self.remap_to_draft(attrs)
+      attrs.transform_keys { |k| DRAFT_MAPPING.fetch(k, k) }
+    end
+  end
+end

data/lib/pdfmonkey/template_card.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class TemplateCard < Resource
+    include Listable
+
+    ATTRIBUTES = %i[
+      app_id
+      auth_token
+      created_at
+      edition_mode
+      errors
+      id
+      identifier
+      is_draft
+      output_type
+      pdf_engine_deprecated_on
+      pdf_engine_name
+      template_folder_id
+      template_folder_identifier
+      updated_at
+    ].freeze
+
+    COLLECTION = 'document_template_cards'
+    MEMBER = 'document_template_card'
+
+    FILTERS = {
+      workspace_id: 'q[workspace_id]',
+      folders: 'q[folders]',
+      sort: 'sort'
+    }.freeze
+
+    def_delegators :attributes, *ATTRIBUTES
+
+    def self.list(workspace_id:, **)
+      super
+    end
+
+    def to_template
+      Pdfmonkey::Template.fetch(id)
+    end
+  end
+end

data/lib/pdfmonkey/template_folder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class TemplateFolder < Resource
+    include Fetchable
+    include Creatable
+    include Updatable
+    include Deletable
+    include Listable
+
+    ATTRIBUTES = %i[
+      app_id
+      created_at
+      errors
+      id
+      identifier
+      updated_at
+    ].freeze
+
+    COLLECTION = 'template_folders'
+    MEMBER = 'template_folder'
+
+    def_delegators :attributes, *ATTRIBUTES
+  end
+end

data/lib/pdfmonkey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfmonkey
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

data/lib/pdfmonkey/webhook.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class Webhook < Resource
+    include Creatable
+    include Deletable
+
+    ATTRIBUTES = %i[
+      created_at
+      custom_channel
+      document_template_ids
+      errors
+      event
+      id
+      platform
+      updated_at
+      url
+      workspace_id
+    ].freeze
+
+    COLLECTION = 'rest_hooks'
+    MEMBER = 'rest_hook'
+
+    def_delegators :attributes, *ATTRIBUTES
+  end
+end

data/lib/pdfmonkey/workspace.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfmonkey
+  class Workspace < Resource
+    include Fetchable
+    include Listable
+
+    ATTRIBUTES = %i[
+      errors
+      id
+      identifier
+      invite_token
+    ].freeze
+
+    COLLECTION = 'workspaces'
+    MEMBER = 'workspace'
+
+    def_delegators :attributes, *ATTRIBUTES
+
+    def self.list_cards(**)
+      list(**)
+    end
+  end
+end

data/lib/pdfmonkey.rb

@@ -1,11 +1,57 @@
 # frozen_string_literal: true
 
-require 'pdfmonkey/adapter'
 require 'pdfmonkey/configuration'
-require 'pdfmonkey/document'
 require 'pdfmonkey/version'
 
 module Pdfmonkey
   class Error < StandardError; end
-  # Your code goes here...
+
+  class ConnectionError < Error; end
+  class GenerationError < Error
+    attr_reader :document
+
+    def initialize(message, document:)
+      @document = document
+      super(message)
+    end
+  end
+
+  class ApiError < Error
+    attr_reader :errors, :status_code
+
+    def initialize(message, errors:, status_code:)
+      @errors = errors
+      @status_code = status_code
+      super(message)
+    end
+  end
+
+  ADAPTER_KEY = :pdfmonkey_adapter
+  private_constant :ADAPTER_KEY
+
+  def self.current_adapter
+    Thread.current[ADAPTER_KEY]
+  end
+
+  def self.with_adapter(adapter)
+    previous = Thread.current[ADAPTER_KEY]
+    Thread.current[ADAPTER_KEY] = adapter
+    yield
+  ensure
+    Thread.current[ADAPTER_KEY] = previous
+  end
 end
+
+require 'pdfmonkey/adapter'
+require 'pdfmonkey/collection'
+require 'pdfmonkey/resource'
+require 'pdfmonkey/current_user'
+require 'pdfmonkey/document'
+require 'pdfmonkey/document_card'
+require 'pdfmonkey/engine'
+require 'pdfmonkey/snippet'
+require 'pdfmonkey/template'
+require 'pdfmonkey/template_card'
+require 'pdfmonkey/template_folder'
+require 'pdfmonkey/webhook'
+require 'pdfmonkey/workspace'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pdfmonkey
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Simon Courtois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2026-02-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '1.68'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '1.68'
 description: Generate awesome PDF with web technologies at pdfmonkey.io
 email:
 - scourtois_github@cubyx.fr
@@ -87,30 +73,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/pdfmonkey.rb
 - lib/pdfmonkey/adapter.rb
+- lib/pdfmonkey/collection.rb
 - lib/pdfmonkey/configuration.rb
+- lib/pdfmonkey/current_user.rb
 - lib/pdfmonkey/document.rb
+- lib/pdfmonkey/document_card.rb
+- lib/pdfmonkey/engine.rb
+- lib/pdfmonkey/resource.rb
+- lib/pdfmonkey/snippet.rb
+- lib/pdfmonkey/template.rb
+- lib/pdfmonkey/template_card.rb
+- lib/pdfmonkey/template_folder.rb
 - lib/pdfmonkey/version.rb
-- pdfmonkey.gemspec
+- lib/pdfmonkey/webhook.rb
+- lib/pdfmonkey/workspace.rb
 homepage: https://github.com/pdfmonkeyio/pdfmonkey-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/pdfmonkeyio/pdfmonkey-ruby/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/pdfmonkeyio/pdfmonkey-ruby
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -119,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/dependabot.yml

@@ -1,20 +0,0 @@
-version: 2
-
-updates:
-  - package-ecosystem: bundler
-    directory: /
-    open-pull-requests-limit: 10
-    schedule:
-      interval: weekly
-      day: monday
-      time: '00:00'
-    target-branch: master
-    versioning-strategy: increase-if-necessary
-
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: weekly
-      day: monday
-      time: '00:00'
-    target-branch: master

data/.github/workflows/ci.yml

@@ -1,43 +0,0 @@
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  specs:
-    name: Run specs with Ruby ${{matrix.ruby}}
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - ruby: '2.6'
-            bundler: 2.2.30
-          - ruby: '2.7'
-            bundler: 2.2.30
-          - ruby: '3.0'
-            bundler: 2.2.30
-          - ruby: '3.1'
-            bundler: 2.6.3
-          - ruby: '3.2'
-            bundler: 2.6.3
-          - ruby: '3.3'
-            bundler: 2.6.3
-          - ruby: '3.4'
-            bundler: 2.6.3
-          - ruby: head
-            bundler: 2.6.3
-            experimental: true
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-        bundler: ${{matrix.bundler}}
-        bundler-cache: true
-
-    - name: Install gems
-      run: bundle _${{matrix.bundler}}_ install
-
-    - name: Run specs
-      run: bundle _${{matrix.bundler}}_ exec rspec

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper