fulfil_api 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd7b3a51a8fa0a8f76213567280c36f7c273115f46a6e397bbd3e8aefbc42df
-  data.tar.gz: 854ab5226509922e32fbccfdf7a2b49a7f8a2af25e313776a6a6d4284f4666c4
+  metadata.gz: b08b66a980bb816b1424c5bdf4b6f07bdc652a0dc0838715b6176dd8dd3a52ac
+  data.tar.gz: e659a978bd939c89aafc27bab91d36c3af9daad8c2779f8e87ff7f9dc8203766
 SHA512:
-  metadata.gz: 41e59d1b1d6a746d7fee0286d5af9290a6a38e474c45e3181a2a4ebca24ad5c7e65df00b6e84128763b5d753ba8a7e89bc7be0279de2c12c31c67298a866d610
-  data.tar.gz: d5598d3ae10daf60f75272cba43d185bb8a14cb8070297e9ab560bbca3758728dae40e9639d0bd6123f69cc17a9add6b61ac1a0d6d9113ea5fcd5c6cdf6ccdd4
+  metadata.gz: 1da9f24a29088c2a177717731176b75ba29fcd9db6281ea7834ec2627e76b3b9029fb7f006ab428caba8035e68c39e221f77cf903145058820a2ebbb93e73552
+  data.tar.gz: de48831aca1ac5ebc8aed263e61ccd0bdb25728240504dbf43c6a91c298f253e8d566141a29c7cab7c67b2d8366704b0f1d4b40f436dd9ea005c582df5f4086e

data/lib/fulfil_api/report.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  # The {FulfilApi::Report} class provides an interface for generating reports
+  # (e.g., PDF invoices) via Fulfil's report API. The API returns a temporary
+  # URL where the generated document can be downloaded.
+  #
+  # @example Generate and download an invoice PDF
+  #   report = FulfilApi::Report.generate("account.invoice.html", 3991)
+  #   report.url       # => "https://..."
+  #   report.filename  # => "Invoice.pdf"
+  #   report.mimetype  # => "application/pdf"
+  #
+  #   tempfile = report.download
+  #   tempfile.path    # => "/tmp/fulfil_report20260324-12345.pdf"
+  class Report
+    attr_reader :filename, :mimetype, :url
+
+    # Generates a report for the given record ID.
+    #
+    # @param report_name [String] The report identifier (e.g., "account.invoice.html").
+    # @param id [Integer] The record ID to generate the report for.
+    # @param data [Hash] Optional additional data for the report.
+    # @return [FulfilApi::Report] A report object with filename, mimetype, and url.
+    def self.generate(report_name, id, data: {})
+      response = FulfilApi.client.put("report/#{report_name}", body: { objects: [id], data: data })
+
+      new(
+        filename: response["filename"],
+        mimetype: response["mimetype"],
+        url: response["url"]
+      )
+    end
+
+    # @param filename [String] The filename of the generated report.
+    # @param mimetype [String] The MIME type of the generated report.
+    # @param url [String] The temporary URL to download the generated report.
+    def initialize(filename:, mimetype:, url:)
+      @filename = filename
+      @mimetype = mimetype
+      @url = url
+    end
+
+    # Downloads the report from the temporary URL and returns a {Tempfile}.
+    #
+    # The tempfile preserves the file extension from the report's filename
+    # (e.g., ".pdf") so it can be used directly with file upload APIs.
+    #
+    # @return [Tempfile] A tempfile containing the downloaded report.
+    def download
+      response = Faraday.get(url)
+
+      extension = File.extname(filename)
+      tempfile = Tempfile.new(["fulfil_report", extension])
+      tempfile.binmode
+      tempfile.write(response.body)
+      tempfile.rewind
+      tempfile
+    end
+  end
+end

data/lib/fulfil_api/test_helper.rb

@@ -65,6 +65,26 @@ module FulfilApi
         .and_return(status: status, body: response.to_json, headers: { "Content-Type": "application/json" })
     end
 
+    # Stubs an HTTP PUT request to the Fulfil report API based on the provided parameters.
+    #
+    # @param [Hash] response The response body to return as a JSON object (default is {}).
+    # @param [Integer] status The HTTP status code to return (default is 200).
+    # @param [Hash] options Additional options for the request URL.
+    # @option options [String] :report_name The report identifier
+    #   (e.g., 'account.invoice.html').
+    #
+    # @return [WebMock::RequestStub] The WebMock request stub object.
+    #
+    # @example Stub a report request for a specific report
+    #   stub_fulfil_report_request(report_name: "account.invoice.html", response: { url: "https://..." })
+    #
+    # @example Stub all report requests
+    #   stub_fulfil_report_request(response: { url: "https://..." })
+    def stub_fulfil_report_request(response: {}, status: 200, **options)
+      stubbed_report_request_for(**options)
+        .and_return(status: status, body: response.to_json, headers: { "Content-Type": "application/json" })
+    end
+
     private
 
     # Builds the WebMock request stub for the Fulfil 3PL API based on the provided method and options.
@@ -84,6 +104,22 @@ module FulfilApi
       end
     end
 
+    # Builds the WebMock request stub for the Fulfil report API based on the provided options.
+    #
+    # @param [Hash] options Additional options for the request URL.
+    # @option options [String] :report_name The report identifier
+    #   (e.g., 'account.invoice.html').
+    #
+    # @return [WebMock::RequestStub] The WebMock request stub object.
+    def stubbed_report_request_for(**options)
+      case options.transform_keys(&:to_sym)
+      in { report_name: }
+        stub_request(:put, %r{fulfil.io/api/v\d+/report/#{report_name}(.*)}i)
+      else
+        stub_request(:put, %r{fulfil.io/api/v\d+/report}i)
+      end
+    end
+
     # Builds the WebMock request stub for the Fulfil API based on the provided method and options.
     #
     # @param [String, Symbol] method The HTTP method to be stubbed (e.g., :get, :post).

data/lib/fulfil_api/tpl_client.rb

@@ -127,8 +127,7 @@ module FulfilApi
     # @return [Hash] The HTTP headers for any HTTP request to the 3PL API.
     def request_headers
       {
-        "Authorization" => "Bearer #{auth_token}",
-        "Content-Type" => "application/json"
+        "Authorization" => "Bearer #{auth_token}"
       }
     end
   end

data/lib/fulfil_api/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,6 +91,7 @@ files:
 - lib/fulfil_api/relation/loadable.rb
 - lib/fulfil_api/relation/naming.rb
 - lib/fulfil_api/relation/query_methods.rb
+- lib/fulfil_api/report.rb
 - lib/fulfil_api/resource.rb
 - lib/fulfil_api/resource/attribute_assignable.rb
 - lib/fulfil_api/resource/attribute_type.rb
@@ -111,7 +111,6 @@ metadata:
   source_code_uri: https://www.github.com/codeturebv/fulfil_api
   changelog_uri: https://www.github.com/codeturebv/fulfil_api/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A HTTP client to interact the Fulfil.io API
 test_files: []