fmrest-spyke 0.18.0.rc2 → 0.18.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e542d636795f376392e6da0d5a7177e0c2133a4d1b534d9c52d5dcdc5b808b9
-  data.tar.gz: 870414e64e6a1170ca77d809b89cdb1da9e3279e3dd14f2145f141fd8ff18298
+  metadata.gz: cede78f266ad81e49d80fcd0cbd423a824ebf630fafe562fc44c01544714c8e0
+  data.tar.gz: 5d290aa99e21e9b0c4f538ff6b17078a7de9da1cf34314bf44f9a6e8de988c05
 SHA512:
-  metadata.gz: 7bdb182e4d580b33b1dfccd125d69573c9020de3118e21ae83fce8f7f2ede2e186a2eb5b8bf2b09f9be0569bb9cc3ac812b0d978d993653943c01366aa3ab64b
-  data.tar.gz: 681f99b637ba62caa6a0e57e976302143e2189ae49a4b6843eba7a492f0cabd1363bf2382d3ca15a7df7ed5d6a5eb115cc0aae07491edd71f87b94f6a35b684b
+  metadata.gz: e0b7cd1662a463f3a3a5cc938e9135f668cd137343b1256c128358efa18eb53597da2e96ac0c30616704401d7a1fdd4284bb22f8ec0d432a9221d73c9f856990
+  data.tar.gz: ced9d235187d687d72b799fcc1d2b350ea7e8bb8440e7dece6cc9ff98170dc3aaab9c21dd4f762bfde725b17950a3ae568487bc5a2350c201fe32b9d6a8c37a6

data/CHANGELOG.md

@@ -3,8 +3,11 @@
 ### 0.18.0
 
 * Better support for portals with mismatching field qualifiers
+* Better ergonomics for script execution, improved documentation
 * Defining an attribute on a model that would collide with an existing method
   now raises an error
+* Cleared Faraday deprecation messages on authentication methods
+* Added fmrest-ruby/VERSION to User-Agent headers
 
 ### 0.17.1
 

data/lib/fmrest/spyke/model/orm.rb

@@ -78,18 +78,6 @@ module FmRest
             new(attributes).tap(&:save!)
           end
 
-          # Requests execution of a FileMaker script.
-          #
-          # @param script_name [String] the name of the FileMaker script to
-          #   execute
-          # @param param [String] an optional paramater for the script
-          #
-          def execute_script(script_name, param: nil)
-            params = {}
-            params = {"script.param" => param} unless param.nil?
-            request(:get, FmRest::V1::script_path(layout, script_name), params)
-          end
-
           private
 
           def extend_scope_with_fm_params(scope, prefixed: false)

data/lib/fmrest/spyke/model/script_execution.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    module Model
+      # This module adds and extends various ORM features in Spyke models,
+      # including custom query methods, remote script execution and
+      # exception-raising persistence methods.
+      #
+      module ScriptExecution
+        extend ::ActiveSupport::Concern
+
+        class_methods do
+          # Requests execution of a FileMaker script, returning its result
+          # object.
+          #
+          # @example
+          #   response = MyLayout.execute("Uppercasing Script", "hello")
+          #
+          #   response.result   # => "HELLO"
+          #   response.error    # => "0"
+          #   response.success? # => true
+          #
+          # @param script_name [String] the name of the FileMaker script to
+          #   execute
+          # @param param [String] an optional paramater for the script
+          # @return [FmRest::Spyke::ScriptResult] the script result object
+          #   containing the return value and error code
+          #
+          def execute(script_name, param = nil)
+            # Allow keyword argument format for compatibility with execute_script
+            if param.respond_to?(:has_key?) && param.has_key?(:param)
+              param = param[:param]
+            end
+
+            response = execute_script(script_name, param: param)
+            response.metadata.script.after
+          end
+
+          # Requests execution of a FileMaker script, returning the entire
+          # response object.
+          #
+          # The execution results will be in `response.metadata.script.after`
+          #
+          # In general you'd want to use the simpler `.execute` instead of this
+          # method, as it provides more direct access to the script results.
+          #
+          # @example
+          #   response = MyLayout.execute_script("My Script", param: "hello")
+          #
+          # @param script_name [String] the name of the FileMaker script to
+          #   execute
+          # @param param [String] an optional paramater for the script
+          # @return the complete response object
+          #
+          def execute_script(script_name, param: nil)
+            params = param.nil? ? {} : {"script.param" => param}
+            request(:get, FmRest::V1::script_path(layout, script_name), params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/spyke/model.rb

@@ -11,6 +11,7 @@ require "fmrest/spyke/model/container_fields"
 require "fmrest/spyke/model/global_fields"
 require "fmrest/spyke/model/http"
 require "fmrest/spyke/model/auth"
+require "fmrest/spyke/model/script_execution"
 
 module FmRest
   module Spyke
@@ -28,6 +29,7 @@ module FmRest
       include GlobalFields
       include Http
       include Auth
+      include ScriptExecution
 
       autoload :Rescuable, "fmrest/spyke/model/rescuable"
     end

data/lib/fmrest/spyke/spyke_formatter.rb

@@ -6,7 +6,7 @@ require "ostruct"
 module FmRest
   module Spyke
     # Metadata class to be passed to Spyke::Collection#metadata
-    class Metadata < Struct.new(:messages, :script, :data_info)
+    Metadata = Struct.new(:messages, :script, :data_info) do
       alias_method :scripts, :script
     end
 
@@ -16,6 +16,11 @@ module FmRest
       def returned_count; returnedCount; end
     end
 
+    ScriptResult = Struct.new(:result, :error) do
+      def success?; error == "0"; end
+      def error?; !success?; end
+    end
+
     # Response Faraday middleware for converting FM API's response JSON into
     # Spyke's expected format
     class SpykeFormatter < ::Faraday::Response::Middleware
@@ -119,17 +124,18 @@ module FmRest
 
         [:prerequest, :presort].each do |s|
           if json[:response][:"scriptError.#{s}"]
-            results[s] = OpenStruct.new(
-              result: json[:response][:"scriptResult.#{s}"],
-              error:  json[:response][:"scriptError.#{s}"]
+            results[s] = ScriptResult.new(
+              json[:response][:"scriptResult.#{s}"],
+              json[:response][:"scriptError.#{s}"]
             ).freeze
           end
         end
 
+        # after/default script
         if json[:response][:scriptError]
-          results[:after] = OpenStruct.new(
-            result: json[:response][:scriptResult],
-            error:  json[:response][:scriptError]
+          results[:after] = ScriptResult.new(
+            json[:response][:scriptResult],
+            json[:response][:scriptError]
           ).freeze
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-spyke
 version: !ruby/object:Gem::Version
-  version: 0.18.0.rc2
+  version: 0.18.0.rc3
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fmrest-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.rc2
+        version: 0.18.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.rc2
+        version: 0.18.0.rc3
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +65,7 @@ files:
 - lib/fmrest/spyke/model/orm.rb
 - lib/fmrest/spyke/model/record_id.rb
 - lib/fmrest/spyke/model/rescuable.rb
+- lib/fmrest/spyke/model/script_execution.rb
 - lib/fmrest/spyke/model/serialization.rb
 - lib/fmrest/spyke/model/uri.rb
 - lib/fmrest/spyke/portal.rb