setsuzoku 0.15.5 → 0.15.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d96415c7bf9bbd2ac52f72e9460277d1fceb768f85a504fc786206d823113fdc
-  data.tar.gz: cb0d401f5f761ff2e8b83ab78924bb301e795338728f762bd699d08b8736a968
+  metadata.gz: 2845af66689814f88f37e06cd20516904d7000d8eb5e7b65893db42f93e47e18
+  data.tar.gz: d85e64ea68bf642ce3ac6dda479575d8a34b9896b15e14332072cb35692d65d5
 SHA512:
-  metadata.gz: a4db4159146b7cc977f81d11eb4bf4bf81adfafe5f7de1ac6f25bca74d277658799b068692595ccc7c44e95ab9e089a15413782050cad2c25bd459cd0deed3ea
-  data.tar.gz: c56da6f3d62467b6c23ec698701500823c2ae715bafd7881f4132c5658c6fd95b7cfef44154d577b7bf6a2c14661e7aaca356bad75ecf9a74c1aeb45d6ccf76e
+  metadata.gz: 8409e05401d6ce653ae9704058a6a5874ffb63687d467514cb7fc69fd3c37dfd7c9a1931d843e558f4726f6a5a5355edb6a841dd888384a52959925e570575aa
+  data.tar.gz: d2829f923f90faccaf2afdc7449af20948fc85234a0eb257e6b3d7aece01db815c24e9360cc168c4af45b6bb84cb16e3ba43c972982c8827f02731532ed7cc1e

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7.7', '3.2.2']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    setsuzoku (0.15.5)
-      activesupport (>= 5.0, < 7)
+    setsuzoku (0.15.6)
+      activesupport (>= 5.0, < 8)
       faraday (>= 2.7.10, < 3.0)
+      faraday-multipart (>= 1.0.4, < 2.0)
       nokogiri (>= 1.10, < 2.0)
       sorbet-runtime (>= 0.5, < 1.0)
 
@@ -16,27 +17,35 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     concurrent-ruby (1.2.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.2)
     faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.8.4)
+    mini_portile2 (2.8.5)
     minitest (5.19.0)
+    multipart-post (2.4.0)
     nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    public_suffix (4.0.5)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    public_suffix (5.0.4)
     racc (1.7.1)
-    rake (10.5.0)
+    rake (13.1.0)
+    rexml (3.2.6)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -51,29 +60,31 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.3)
     ruby2_keywords (0.0.5)
-    safe_yaml (1.0.5)
-    sorbet (0.5.10030)
-      sorbet-static (= 0.5.10030)
+    sorbet (0.5.11151)
+      sorbet-static (= 0.5.11151)
     sorbet-runtime (0.5.10972)
-    sorbet-static (0.5.10030-universal-darwin-14)
+    sorbet-static (0.5.11151-universal-darwin)
+    sorbet-static (0.5.11151-x86_64-linux)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webmock (3.8.0)
-      addressable (>= 2.3.6)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.6.11)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  rake (~> 10.0)
+  bundler (~> 2.4.22)
+  rake (~> 13.0)
   rspec (= 3.8)
   setsuzoku!
   sorbet (>= 0.5, < 1.0)
-  webmock (= 3.8)
+  webmock (= 3.19.1)
 
 BUNDLED WITH
-   1.17.2
+   2.4.22

data/lib/setsuzoku/plugin.rb

@@ -87,7 +87,7 @@ module Setsuzoku
       self.registered_instance = options[:registering_instance]
       if context[:service] && context[:service][:type]
         service = AVAILABLE_SERVICES[context[:service][:type]]
-        self.service = service.new(service_config)
+        self.service = service.new(**service_config)
       end
       self.config_context = context.merge(options.except(:registering_instance))
       self

data/lib/setsuzoku/service/web_service/api_strategies/rest_strategy.rb

@@ -4,6 +4,8 @@
 require 'active_support/json'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string/access'
+require 'faraday'
+require 'faraday/multipart'
 
 module Setsuzoku
   module Service
@@ -35,32 +37,49 @@ module Setsuzoku
           #   attachment_urls - 'Array<String>' List of attachment urls to be attached as form files.
           #
           # @return [Hash] the parsed response object.
-          sig { override.params(request: RestAPIRequest, action_details: T::Hash[T.untyped, T.untyped], options: T.untyped).returns(Faraday::Response) }
+          sig do
+            override.params(request: RestAPIRequest, action_details: T::Hash[T.untyped, T.untyped],
+                            options: T.untyped).returns(Faraday::Response)
+          end
           def perform_external_call(request:, action_details:, **options)
-            request_properties = self.get_request_properties(action_name: request.action, action_details: action_details, req_params: request.body)
-            request_options = self.request_options(request_properties[:request_format], action_details[:actions][request.action])
+            request_properties = get_request_properties(action_name: request.action,
+                                                        action_details: action_details, req_params: request.body)
+            request_options = self.request_options(request_properties[:request_format],
+                                                   action_details[:actions][request.action])
             authorization = request_options.delete(:authorization)
-            full_request = self.formulate_request(request_properties, request_options)
-
-            @faraday = Faraday.new(url: request_properties[:formatted_full_url], request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
-              faraday.request(:multipart) if options[:attachment_urls].present?
-              faraday.request(:url_encoded)
-              unless request.without_headers
-                if authorization
-                  # updated authorization with updated faraday
-                  # https://lostisland.github.io/faraday/#/middleware/included/authentication
-                  if authorization.key?(:token)
-                    faraday.request(:authorization, 'Bearer', authorization[:token])
-                  elsif authorization.key?(:basic_auth)
-                    faraday.request(:authorization, :basic, authorization[:basic_auth][:username], authorization[:basic_auth][:password])
-                  end
+            full_request = formulate_request(request_properties, request_options)
+
+            connection = Faraday.new(url: request_properties[:formatted_full_url],
+                                     request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
+              # Request type middle-ware
+              if options[:attachment_urls].present? || request_options.dig(:headers,
+                                                                           :'Content-Type')&.include?('multipart')
+                faraday.request(:multipart)
+              else
+                faraday.request(:url_encoded)
+              end
+
+              # Logging
+              faraday.response :logger, Logger.new($stdout), bodies: true if Rails.env.development?
+
+              if !request.without_headers && authorization
+                # updated authorization with updated faraday
+                # https://lostisland.github.io/faraday/#/middleware/included/authentication
+                if authorization.key?(:token)
+                  faraday.request(:authorization, 'Bearer', authorization[:token])
+                elsif authorization.key?(:basic_auth)
+                  faraday.request(:authorization, :basic, authorization[:basic_auth][:username],
+                                  authorization[:basic_auth][:password])
                 end
               end
+
               faraday.adapter Faraday.default_adapter
             end
+
+            # Attachments URLs
             attachment_urls = options[:attachment_url] || options[:attachment_urls]
             if attachment_urls.present?
-              resp = @faraday.post do |req|
+              resp = connection.post do |req|
                 payload = {}
                 # create an array to just iterate over for 1 or many urls
                 attachment_urls = [attachment_urls] if options[:attachment_url]
@@ -79,24 +98,36 @@ module Setsuzoku
               end
             else
               if request.without_headers
-                @faraday.headers = {}
+                connection.headers = {}
               elsif request_options[:headers]
-                @faraday.headers = (@faraday.headers || {}).merge(request_options[:headers])
+                connection.headers = (connection.headers || {}).merge(request_options[:headers])
+              end
+
+              # TODO: !!!! this is wrong here because multipart is used for images as well not only text/plain
+              # TODO: What if the request params are empty?
+              if connection.builder.app.class <= Faraday::Multipart::Middleware
+                full_request = request_properties[:req_params].transform_values do |v|
+                  Faraday::Multipart::ParamPart.new(v, 'text/plain')
+                end
               end
-              resp = @faraday.send(request_properties[:request_method], request_properties[:formatted_full_url], full_request)
+
+              resp = connection.send(request_properties[:request_method], request_properties[:formatted_full_url],
+                                     full_request)
             end
+
             resp
           end
 
           sig do
             params(
-                action_name: Symbol,
-                for_stub: T::Boolean,
-                req_params: T::Hash[T.untyped, T.untyped],
-                action_details: T::Hash[Symbol, T.untyped]
+              action_name: Symbol,
+              for_stub: T::Boolean,
+              req_params: T::Hash[T.untyped, T.untyped],
+              action_details: T::Hash[Symbol, T.untyped]
             ).returns(T::Hash[Symbol, T.untyped])
           end
-          def get_request_properties(action_name:, for_stub: false, req_params: {}, action_details: { actions: self.plugin.api_actions, url: self.plugin.api_base_url })
+          def get_request_properties(action_name:, for_stub: false, req_params: {},
+                                     action_details: { actions: plugin.api_actions, url: plugin.api_base_url })
             action = action_details[:actions][action_name]
             url = action.has_key?(:request_url) ? action[:request_url] : action_details[:url]
             request_method, endpoint = action.first
@@ -105,15 +136,15 @@ module Setsuzoku
             response_format = action[:response_type]
             stub_data = action[:stub_data] if for_stub
             full_url = url + endpoint
-            formatted_full_url, req_params = self.replace_dynamic_vars(full_url: full_url, req_params: req_params)
+            formatted_full_url, req_params = replace_dynamic_vars(full_url: full_url, req_params: req_params)
             {
-                request_method: request_method,
-                endpoint: endpoint,
-                request_format: request_format,
-                response_format: response_format,
-                formatted_full_url: formatted_full_url,
-                req_params: req_params,
-                stub_data: stub_data,
+              request_method: request_method,
+              endpoint: endpoint,
+              request_format: request_format,
+              response_format: response_format,
+              formatted_full_url: formatted_full_url,
+              req_params: req_params,
+              stub_data: stub_data
             }
           end
 
@@ -138,29 +169,27 @@ module Setsuzoku
               else
                 params # Faraday supports empty hashes for other request types...
               end
-            else
+            elsif request_format.include?('urlencoded')
               # if the header or request format include urlencoded return the body as a hash
-              if request_format.include?('urlencoded')
-                params
-              else
-                # return either xml or json
-                if request_properties[:request_format] == :xml
-                  convert_hash_to_xml(params)
-                else
-                  params.to_json
-                end
-              end
+              params
+            elsif request_properties[:request_format] == :xml
+              # return either xml or json
+              convert_hash_to_xml(params)
+            else
+              params.to_json
             end
           end
 
           def request_options(request_format = nil, action_details = {})
-            request_options = {}
-            (request_options = {})[:headers] = {}
+            request_options = {
+              headers: {}
+            }
             request_options[:headers]
-              .merge!(self.auth_strategy.get_from_context(:auth_headers).except(:authorization))
-              .merge!(self.get_from_context(:api_headers))
+              .merge!(auth_strategy.get_from_context(:auth_headers).except(:authorization))
+              .merge!(get_from_context(:api_headers))
               .merge!(action_details[:request_options] || {})
-            request_options[:authorization] = action_details[:authorization] || self.auth_strategy.get_from_context(:auth_headers)[:authorization]
+            request_options[:authorization] =
+              action_details[:authorization] || auth_strategy.get_from_context(:auth_headers)[:authorization]
 
             content_type = case request_format
                            when :json
@@ -174,7 +203,8 @@ module Setsuzoku
                            when :'x-www-form-urlencoded;charset=UTF-8'
                              'application/x-www-form-urlencoded;charset=UTF-8'
                            else
-                             'application/json'
+                             # allow any format to be passed otherwise default to application/json
+                             request_format || 'application/json'
                            end
             (request_options[:headers] ||= {})[:'Content-Type'] = content_type
             request_options
@@ -187,7 +217,7 @@ module Setsuzoku
             # it in the body and the url, then you should put it in params twice with different names.
             req_params = req_params.dup
             full_url = full_url.dup
-            dynamic_vars = self.plugin.dynamic_url_params.merge(req_params).with_indifferent_access
+            dynamic_vars = plugin.dynamic_url_params.merge(req_params).with_indifferent_access
             full_url.scan(/({{.*?}})/).flatten.each do |var|
               var_name = var.tr('{{ }}', '')
               next unless dynamic_vars[var_name]

data/lib/setsuzoku/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Setsuzoku
-  VERSION = '0.15.5'
-end
+  VERSION = '0.15.7'
+end

data/setsuzoku.gemspec

@@ -36,14 +36,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.4.22"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "3.8"
-  spec.add_development_dependency "webmock", "3.8"
-  spec.add_runtime_dependency "activesupport", ">= 5.0", '< 7'
+  spec.add_development_dependency "webmock", "3.19.1"
+  spec.add_runtime_dependency "activesupport", ">= 5.0", '< 8'
   spec.add_development_dependency "sorbet", ">= 0.5", '< 1.0'
   spec.add_runtime_dependency "sorbet-runtime", ">= 0.5", '< 1.0'
-  #TODO: we should remove httparty if we can just use faraday
   spec.add_runtime_dependency "faraday", ">= 2.7.10", "< 3.0"
+  spec.add_runtime_dependency "faraday-multipart", ">= 1.0.4", "< 2.0"
   spec.add_runtime_dependency "nokogiri", ">= 1.10", "< 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: setsuzoku
 version: !ruby/object:Gem::Version
-  version: 0.15.5
+  version: 0.15.7
 platform: ruby
 authors:
 - Luke Stadtler
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.22
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.22
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.19.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.19.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +196,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -251,7 +272,7 @@ homepage: https://github.com/rocketreferrals/setsuzoku
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,8 +287,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Extensible 3rd-party interface and functionality plugins
 test_files: []