rodoo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4659d7f4bf1d0156dc09a4b417310c208ecf83c901b80dbdf99ac84ef80ae703
-  data.tar.gz: b9c048a9136da50585032eed8a1e267bdb6174f5623252b603ba1c188e2f8004
+  metadata.gz: 87923ea6d949a5082fdf435534be6e9785c655b2bc37533784c8389c3288661b
+  data.tar.gz: 33009601846b3655494da2ee9f03c1e1ec87896d964094b03491f9ce692e07d8
 SHA512:
-  metadata.gz: de08af6d3ce14f9848b10598eb788b488e2b9dc5e6021a334cea754b4b50e6a5f00ea6370bc5e35ddb926f663e9b8f9ac57825acca78032d0b737e2854f80231
-  data.tar.gz: 4dfb5a9c3cfe0e281abed50567aeb3cac61a7e605f09ec29a0bbd6471d2b16c5da801521d1d6c1833de44f81c05c7195adddd9923d174a6b28ef7efa14c61b68
+  metadata.gz: 50bf69658ddddcf3f3b8a82f1998ebeda996ec656cfb5647c6a6c9d9e1ef2ba60349b585e861ceb44b4af69ab8b7c01c6050b5f47e58f796c89ffe5ea2074e1a
+  data.tar.gz: 7c0e9f254bc0a0c71474e29b8568fef331f78855cfac1a1956400dfc200914a5dcced7b1f440b167abb73cf646244628238c8a260ed6cf61183b5a6400751dd0

data/.rubocop.yml

@@ -11,6 +11,10 @@ Metrics/MethodLength:
   Exclude:
     - "test/**/*"
 
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"
+
 Metrics/ClassLength:
   Max: 105
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-01-20
+
+- Add PDF attachment support for accounting entries
+- Add Attachment model for ir.attachment API
+
 ## [0.1.0] - 2025-12-24
 
 - Initial release

data/README.md

@@ -149,6 +149,73 @@ contact.destroy
 contact.destroyed?  # => true
 ```
 
+### Attachments
+
+Attach PDF files to accounting entries (invoices, credit notes, journal entries):
+
+```ruby
+invoice = Rodoo::ProviderInvoice.find(42)
+
+# Attach from file path (sets as main attachment by default)
+invoice.attach_pdf("/path/to/invoice.pdf")
+
+# Attach with custom filename
+invoice.attach_pdf("/path/to/document.pdf", filename: "vendor_invoice.pdf")
+
+# Attach without setting as main attachment
+invoice.attach_pdf("/path/to/supporting.pdf", set_as_main: false)
+
+# Attach from base64 data
+invoice.attach_pdf_from_base64(base64_content, filename: "invoice.pdf")
+
+# List attachments
+invoice.attachments
+invoice.attachments(mimetype: "application/pdf")
+
+# Get the main attachment
+invoice.main_attachment
+
+# Set a different attachment as main
+invoice.set_main_attachment(attachment_id)
+```
+
+#### With Rails ActiveStorage
+
+When using ActiveStorage in a Rails application:
+
+```ruby
+# Rails model with ActiveStorage attachment
+class Invoice < ApplicationRecord
+  has_one_attached :pdf_document
+end
+
+# Sync to Odoo
+rails_invoice = Invoice.find(123)
+odoo_invoice = Rodoo::ProviderInvoice.find(42)
+
+rails_invoice.pdf_document.open do |tempfile|
+  odoo_invoice.attach_pdf(tempfile, filename: rails_invoice.pdf_document.filename.to_s)
+end
+```
+
+#### Direct Attachment model usage
+
+```ruby
+# Create attachment for any record
+Rodoo::Attachment.create_for(
+  record, "/path/to/file.pdf", filename: "doc.pdf", mimetype: "application/pdf"
+)
+
+# Create from base64
+Rodoo::Attachment.create_from_base64(
+  record, base64_data, filename: "doc.pdf", mimetype: "application/pdf"
+)
+
+# Find attachments for a record
+Rodoo::Attachment.for_record(record)
+Rodoo::Attachment.for_record(record, mimetype: "application/pdf")
+```
+
 ### Available models
 
 Rodoo includes pre-built models for common Odoo objects:
@@ -159,6 +226,7 @@ Rodoo includes pre-built models for common Odoo objects:
 | `Rodoo::Project` | `project.project` |
 | `Rodoo::AnalyticAccount` | `account.analytic.account` |
 | `Rodoo::AnalyticPlan` | `account.analytic.plan` |
+| `Rodoo::Attachment` | `ir.attachment` |
 | `Rodoo::AccountingEntry` | `account.move` (all types) |
 | `Rodoo::CustomerInvoice` | `account.move` (move_type: out_invoice) |
 | `Rodoo::ProviderInvoice` | `account.move` (move_type: in_invoice) |

data/lib/rodoo/models/accounting_entry.rb

@@ -16,9 +16,16 @@ module Rodoo
   # @example Using the base class to query all types
   #   all_entries = Rodoo::AccountingEntry.where([["date", ">", "2025-01-01"]])
   #
+  # @example Attaching a PDF
+  #   invoice = Rodoo::ProviderInvoice.find(42)
+  #   invoice.attach_pdf("/path/to/invoice.pdf")
+  #
   class AccountingEntry < Model
     model_name "account.move"
 
+    PDF_MIMETYPE = "application/pdf"
+    private_constant :PDF_MIMETYPE
+
     # Subclasses override this to specify their move_type
     #
     # @return [String, nil] The move_type value for this class
@@ -49,5 +56,108 @@ module Rodoo
                      end
       super(scoped_attrs)
     end
+
+    # Attach a PDF file to this record
+    #
+    # @param file_path_or_io [String, IO, #read] File path or IO-like object
+    # @param filename [String, nil] The filename (derived from path if not provided)
+    # @param set_as_main [Boolean] Whether to set this as the main attachment (default: true)
+    # @return [Attachment] The created attachment
+    #
+    # @example Attach from file path (sets as main by default)
+    #   invoice.attach_pdf("/path/to/invoice.pdf")
+    #
+    # @example Attach without setting as main
+    #   invoice.attach_pdf("/path/to/supporting.pdf", set_as_main: false)
+    #
+    def attach_pdf(file_path_or_io, filename: nil, set_as_main: true)
+      resolved_filename = filename || derive_filename(file_path_or_io)
+      attachment = Attachment.create_for(
+        self, file_path_or_io, filename: resolved_filename, mimetype: PDF_MIMETYPE
+      )
+      set_main_attachment(attachment) if set_as_main
+      attachment
+    end
+
+    # Attach a PDF from base64-encoded data
+    #
+    # @param base64_data [String] The base64-encoded PDF data
+    # @param filename [String] The filename for the attachment
+    # @param set_as_main [Boolean] Whether to set this as the main attachment (default: true)
+    # @return [Attachment] The created attachment
+    #
+    # @example
+    #   invoice.attach_pdf_from_base64(base64_content, filename: "invoice.pdf")
+    #
+    def attach_pdf_from_base64(base64_data, filename:, set_as_main: true)
+      attachment = Attachment.create_from_base64(
+        self, base64_data, filename: filename, mimetype: PDF_MIMETYPE
+      )
+      set_main_attachment(attachment) if set_as_main
+      attachment
+    end
+
+    # Set the main attachment for this record (visible in Odoo's side panel)
+    #
+    # @param attachment_or_id [Attachment, Integer] The attachment or its ID
+    # @return [self]
+    #
+    # @example With an Attachment object
+    #   invoice.set_main_attachment(attachment)
+    #
+    # @example With an attachment ID
+    #   invoice.set_main_attachment(123)
+    #
+    # rubocop:disable Naming/AccessorMethodName
+    def set_main_attachment(attachment_or_id)
+      attachment_id = attachment_or_id.is_a?(Attachment) ? attachment_or_id.id : attachment_or_id
+      update(message_main_attachment_id: attachment_id)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    # List attachments for this record
+    #
+    # @param mimetype [String, nil] Optional MIME type filter
+    # @return [Array<Attachment>] Array of attachments
+    #
+    # @example Get all attachments
+    #   invoice.attachments
+    #
+    # @example Get only PDF attachments
+    #   invoice.attachments(mimetype: "application/pdf")
+    #
+    def attachments(mimetype: nil)
+      Attachment.for_record(self, mimetype: mimetype)
+    end
+
+    # Get the main attachment for this record
+    #
+    # @return [Attachment, nil] The main attachment or nil if not set
+    #
+    # @example
+    #   main = invoice.main_attachment
+    #
+    def main_attachment
+      main_id = self[:message_main_attachment_id]
+      return nil unless main_id
+
+      # Odoo returns [id, name] for many2one fields
+      attachment_id = main_id.is_a?(Array) ? main_id.first : main_id
+      return nil unless attachment_id
+
+      Attachment.find(attachment_id)
+    end
+
+    private
+
+    def derive_filename(file_path_or_io)
+      if file_path_or_io.respond_to?(:path)
+        File.basename(file_path_or_io.path)
+      elsif file_path_or_io.is_a?(String)
+        File.basename(file_path_or_io)
+      else
+        "attachment.pdf"
+      end
+    end
   end
 end

data/lib/rodoo/models/attachment.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module Rodoo
+  # Wrapper for Odoo's ir.attachment model.
+  #
+  # Provides methods for creating and querying file attachments linked to Odoo records.
+  #
+  # @example Create an attachment from a file path
+  #   invoice = Rodoo::ProviderInvoice.find(42)
+  #   Rodoo::Attachment.create_for(
+  #     invoice, "/path/to/file.pdf", filename: "invoice.pdf", mimetype: "application/pdf"
+  #   )
+  #
+  # @example Create an attachment from base64 data
+  #   Rodoo::Attachment.create_from_base64(
+  #     invoice, base64_data, filename: "doc.pdf", mimetype: "application/pdf"
+  #   )
+  #
+  # @example List attachments for a record
+  #   Rodoo::Attachment.for_record(invoice)
+  #   Rodoo::Attachment.for_record(invoice, mimetype: "application/pdf")
+  #
+  class Attachment < Model
+    model_name "ir.attachment"
+
+    # Create an attachment for a record from a file path or IO object
+    #
+    # @param record [Model] The Odoo record to attach the file to
+    # @param file_path_or_io [String, IO, #read] File path or IO-like object
+    # @param filename [String] The filename for the attachment
+    # @param mimetype [String] The MIME type of the file
+    # @return [Attachment] The created attachment
+    #
+    # @example From file path
+    #   Rodoo::Attachment.create_for(
+    #     invoice, "/path/to/file.pdf", filename: "invoice.pdf", mimetype: "application/pdf"
+    #   )
+    #
+    # @example From IO object
+    #   File.open("/path/to/file.pdf", "rb") do |f|
+    #     Rodoo::Attachment.create_for(
+    #       invoice, f, filename: "invoice.pdf", mimetype: "application/pdf"
+    #     )
+    #   end
+    #
+    def self.create_for(record, file_path_or_io, filename:, mimetype:)
+      data = read_file_data(file_path_or_io)
+      base64_data = Base64.strict_encode64(data)
+      create_from_base64(record, base64_data, filename: filename, mimetype: mimetype)
+    end
+
+    # Create an attachment for a record from base64-encoded data
+    #
+    # @param record [Model] The Odoo record to attach the file to
+    # @param base64_data [String] The base64-encoded file data
+    # @param filename [String] The filename for the attachment
+    # @param mimetype [String] The MIME type of the file
+    # @return [Attachment] The created attachment
+    #
+    # @example
+    #   Rodoo::Attachment.create_from_base64(
+    #     invoice, base64_content, filename: "doc.pdf", mimetype: "application/pdf"
+    #   )
+    #
+    def self.create_from_base64(record, base64_data, filename:, mimetype:)
+      attrs = {
+        name: filename,
+        type: "binary",
+        datas: base64_data,
+        res_model: record.class.model_name,
+        res_id: record.id,
+        mimetype: mimetype
+      }
+      ids = execute("create", vals_list: [attrs])
+      # Don't call find() - reading ir.attachment fails when Odoo tries to return
+      # the binary datas field. Return an instance with the known attributes.
+      new(attrs.except(:datas).merge(id: ids.first))
+    end
+
+    # Find all attachments for a record
+    #
+    # @param record [Model] The Odoo record to find attachments for
+    # @param mimetype [String, nil] Optional MIME type filter
+    # @return [Array<Attachment>] Array of attachments
+    #
+    # @example Get all attachments
+    #   Rodoo::Attachment.for_record(invoice)
+    #
+    # @example Get only PDF attachments
+    #   Rodoo::Attachment.for_record(invoice, mimetype: "application/pdf")
+    #
+    def self.for_record(record, mimetype: nil)
+      domain = [
+        ["res_model", "=", record.class.model_name],
+        ["res_id", "=", record.id]
+      ]
+      domain << ["mimetype", "=", mimetype] if mimetype
+      where(domain)
+    end
+
+    # Read file data from a path or IO object
+    #
+    # @param file_path_or_io [String, IO, #read] File path or IO-like object
+    # @return [String] Binary file data
+    # @api private
+    def self.read_file_data(file_path_or_io)
+      if file_path_or_io.respond_to?(:read)
+        file_path_or_io.read
+      else
+        File.binread(file_path_or_io)
+      end
+    end
+    private_class_method :read_file_data
+  end
+end

data/lib/rodoo/models/tax.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rodoo
+  class Tax < Model
+    model_name "account.tax"
+  end
+end

data/lib/rodoo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rodoo
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rodoo.rb

@@ -12,6 +12,7 @@ module Rodoo
   autoload :AccountingEntryLine, "rodoo/models/accounting_entry_line"
   autoload :AnalyticAccount, "rodoo/models/analytic_account"
   autoload :AnalyticPlan, "rodoo/models/analytic_plan"
+  autoload :Attachment, "rodoo/models/attachment"
   autoload :CustomerCreditNote, "rodoo/models/customer_credit_note"
   autoload :CustomerInvoice, "rodoo/models/customer_invoice"
   autoload :JournalEntry, "rodoo/models/journal_entry"
@@ -20,6 +21,7 @@ module Rodoo
   autoload :Project, "rodoo/models/project"
   autoload :ProviderCreditNote, "rodoo/models/provider_credit_note"
   autoload :ProviderInvoice, "rodoo/models/provider_invoice"
+  autoload :Tax, "rodoo/models/tax"
 
   @configuration = nil
   @connection = nil

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rodoo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Serrano
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem implements a wrapper to interact with Odoo's API in Ruby. The
   API used is Odoo's 'external JSON-2 API' introduced in Odoo v19.
 email:
@@ -35,6 +49,7 @@ files:
 - lib/rodoo/models/accounting_entry_line.rb
 - lib/rodoo/models/analytic_account.rb
 - lib/rodoo/models/analytic_plan.rb
+- lib/rodoo/models/attachment.rb
 - lib/rodoo/models/contact.rb
 - lib/rodoo/models/customer_credit_note.rb
 - lib/rodoo/models/customer_invoice.rb
@@ -43,6 +58,7 @@ files:
 - lib/rodoo/models/project.rb
 - lib/rodoo/models/provider_credit_note.rb
 - lib/rodoo/models/provider_invoice.rb
+- lib/rodoo/models/tax.rb
 - lib/rodoo/version.rb
 homepage: https://github.com/dekuple/rodoo
 licenses: