fulfil_api 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10fcad8a31843f9c7c15e2c0d7e9ed00331fbc665091f088f6fd7794fae7159a
-  data.tar.gz: 367ed1508c804dc8fffc4da5089683702ca18d35433c5d6ae8744a06fae7bde7
+  metadata.gz: 6f8ba18240c4cbc9a772505388ca2cc1c86a5afbe6b68e28c2244d622cc2d827
+  data.tar.gz: a6c6864e7b9753cfb0e92c72940effc3b6b9d14845616941e63ea909c2ffe042
 SHA512:
-  metadata.gz: 84f5db4b17bb3c6e0011f30dd5b9a8d9472199a49f2562ad1e2646540e0d08f1d89372e42fc3f4492731c6df52e4343cda4547b20dbdcafc48c388aa176780f1
-  data.tar.gz: fa251dcc692380fa34543b6ae0d82338cc09b9cadd5d2d8875d02a02ee6c49168017808607a7508996f61ab10dc1d389b5915c7269b24792997ba65113071c44
+  metadata.gz: 1a6942e7212111fc5a0f62aed933a9b290c21d495588894487271623f6f2fcb767fbaaf5ccca4aa941063903934d676207af00b56ea705c32c2ee59d542f5e68
+  data.tar.gz: 94a91fc36310e2ad898605972262f94762c075754c74c3711762fc83400ba111b19585bd97c655dc9092dd5ab1e9d6bce6c6d465d882cbc308c20af1d0818895

data/README.md

@@ -60,6 +60,8 @@ The following configuration options are (currently) available throught both conf
 
 - `merchant_id` (`String`): The `merchant_id` is the subdomain that the Fulfil instance is hosted on. This configuration option is required to be able to query Fulfil's API endpoints.
 
+- `request_options` (`Hash`): The `request_options` are the configuration options for the HTTP client. See [https://lostisland.github.io/faraday/#/customization/request-options](https://lostisland.github.io/faraday/#/customization/request-options) in `faraday`.
+
 ### Querying the Fulfil API
 
 > **NOTE:** Currently, the gem is under heavy development. The querying interface of the gem is really basic at the moment. In the future, we will closer match the querying interface of `ActiveRecord`.

data/lib/fulfil_api/client.rb

@@ -58,8 +58,11 @@ module FulfilApi
 
     # @return [Faraday::Connection]
     def connection
-      # TODO: Allow passing configuration options for the request
-      @connection ||= Faraday.new(headers: request_headers, url: api_endpoint) do |connection|
+      @connection ||= Faraday.new(
+        headers: request_headers,
+        url: api_endpoint,
+        request: configuration.request_options
+      ) do |connection|
         connection.adapter :net_http_persistent # TODO: Allow passing configuration options
 
         # Configuration of the request middleware

data/lib/fulfil_api/configuration.rb

@@ -6,7 +6,10 @@ module FulfilApi
   # This model holds configuration settings and provides thread-safe access
   #   to these settings.
   class Configuration
-    attr_accessor :access_token, :api_version, :merchant_id
+    attr_accessor :access_token, :api_version, :merchant_id, :request_options
+
+    DEFAULT_API_VERSION = "v2"
+    DEFAULT_REQUEST_OPTIONS = { open_timeout: 1, read_timeout: 5, write_timeout: 5, timeout: 5 }.freeze
 
     # Initializes the configuration with optional settings.
     #
@@ -52,7 +55,8 @@ module FulfilApi
     #
     # @return [void]
     def set_default_options
-      self.api_version = "v2" if api_version.nil?
+      self.api_version = DEFAULT_API_VERSION if api_version.nil?
+      self.request_options = DEFAULT_REQUEST_OPTIONS if request_options.nil?
     end
   end
 

data/lib/fulfil_api/resource/persistable.rb

@@ -12,18 +12,49 @@ module FulfilApi
       extend ActiveSupport::Concern
 
       class_methods do
+        # Creates a new resource on the model name.
+        #
+        # @param model_name [String] The name of the model to which the resource belongs.
+        # @params attributes [Hash] The attributes to create the resource with.
+        # @return [FulfilApi::Resource, false] The created resource.
+        #
+        # @example Creating a resource
+        #   FulfilApi::Resource.create(model_name: "sale.sale", reference: "MK123")
+        def create(model_name:, **attributes)
+          resource = new(model_name: model_name)
+          resource.create(attributes)
+        rescue FulfilApi::Error
+          false
+        end
+
+        # Creates a new resource on the model name, raising an error if the create fails.
+        #
+        # @param model_name [String] The name of the model to which the resource belongs.
+        # @params attributes [Hash] The attributes to create the resource with.
+        # @return [FulfilApi::Resource] The created resource.
+        # @raise [FulfilApi::Error] If the create fails.
+        #
+        # @example Creating a resource
+        #   FulfilApi::Resource.create!(model_name: "sale.sale", reference: "MK123")
+        def create!(model_name:, **attributes)
+          resource = new(model_name: model_name)
+          resource.create!(attributes)
+        end
+
         # Updates a resource by its ID and model name.
         #
         # @param id [String, Integer] The ID of the resource to update.
         # @param model_name [String] The name of the model to which the resource belongs.
         # @param attributes [Hash] The attributes to update on the resource.
-        # @return [FulfilApi::Resource] The updated resource.
+        # @return [FulfilApi::Resource, false] The updated resource.
         #
         # @example Updating a resource
         #   FulfilApi::Resource.update(id: 123, model_name: "sale.sale", reference: "MK123")
         def update(id:, model_name:, **attributes)
           resource = new(id: id, model_name: model_name)
           resource.update(attributes)
+        rescue FulfilApi::Error
+          false
         end
 
         # Updates a resource by its ID and model name, raising an error if the update fails.
@@ -42,6 +73,31 @@ module FulfilApi
         end
       end
 
+      # Creates a resource with the given attributes and saves it.
+      #
+      # @param attributes [Hash] The attributes to assign to the resource.
+      # @return [FulfilApi::Resource] The created resource.
+      #
+      # @example Creating a resource
+      #   resource.create(reference: "MK123")
+      def create(attributes)
+        assign_attributes(attributes)
+        save
+      end
+
+      # Creates a resource with the given attributes and saves it, raising an error if saving fails.
+      #
+      # @param attributes [Hash] The attributes to assign to the resource.
+      # @return [FulfilApi::Resource] The created resource.
+      # @raise [FulfilApi::Error] If an error occurs during the create.
+      #
+      # @example Creating a resource with error raising
+      #   resource.create(reference: "MK123")
+      def create!(attributes)
+        assign_attributes(attributes)
+        save!
+      end
+
       # Saves the current resource, rescuing any errors that occur and handling them based on error type.
       #
       # @return [FulfilApi::Resource, nil] Returns the resource if saved successfully, otherwise nil.
@@ -67,8 +123,8 @@ module FulfilApi
 
         if id.present?
           FulfilApi.client.put("/model/#{model_name}/#{id}", body: to_h)
-        else # rubocop:disable Style/EmptyElse
-          # TODO: Implement the {#create} and {#create!} methods to save a new resource
+        else
+          FulfilApi.client.post("/model/#{model_name}", body: to_h)
         end
 
         self

data/lib/fulfil_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A HTTP client to interact the Fulfil.io API