ncore 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7768ca94332000d27a96d5eef72643b122d592461be7c46bcd46f0d3ac4cfa37
-  data.tar.gz: f247238c94a6a94011df71583b7f85f2a04e30b52edf6bbf3c908b06fc5be9ba
+  metadata.gz: d88aebda2989bb9112e2e0a6a90a0eb4fb6224db0563560df03fa70f602dc03d
+  data.tar.gz: e1933d625a8771f26a6697ad3d4d1bd34cc63c67ae69b07516b935d25389c55b
 SHA512:
-  metadata.gz: 896e527a4b7d5dc140dc9b21c51bbb1755488f505fd4815bed349a739d9de170ebb0773786f156857f6a6cd188adf2999982d519a3d9d53762b1a477dd51186f
-  data.tar.gz: 43f131a9684c8fde7dc088724c0ed5d4ab64e7b3f7f0ed6e150eddcfadf6e97d88f6335e96108d5b341f4051ace9f8fc5dc0b88371a734deb29381a7e55d574d
+  metadata.gz: 29288f675a0ba7efe0a79ece9235bb793258c216a48f3874a0129aa089e4fe59eb82572aaf04a9a4810f6bd57d9bcc98b3abab00d516f3c3511ecd0edf73de07
+  data.tar.gz: 610ae4cdf2d632b06a4938f22c2f95dd7c2904ae9a98a12b721f6113fa99b0e67125c85fd973a346e3d128121e3f7a4324a204acf987e38a2873ede293462286

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+#### 3.7.0
+
+- Allow request params to be or contain ActionController::Parameters
+  Unless MultiJson is present, this changes json generation to use the
+    configured encoder in ActiveSupport::JSON::Encoding.json_encoder instead
+    of directly using ::JSON.
+- Change request header names to lowercase
+- Log 404, 409, 422 responses at :debug instead of :error
+
+#### 3.6.2
+
+- Ensure cache key is stable
+
 #### 3.6.1
 
 - Restore usage of Resource.new(some_attr: 'value')

data/example/lib/my_api/api_config.rb

@@ -27,7 +27,7 @@ module MyApi
 
     self.status_page = 'http://my.api.status.page'
 
-    self.auth_header_prefix = 'X-MyApi'
+    self.auth_header_prefix = 'x-myapi'
 
     # self.bearer_credential_key = :api_key
 

data/lib/ncore/builder.rb

@@ -1,7 +1,7 @@
 module NCore
   module Builder
     extend ActiveSupport::Concern
-    
+
     included do
       class_eval <<-INCL, __FILE__, __LINE__+1
         include NCore::Exceptions
@@ -24,7 +24,7 @@ module NCore
 
         class << self
           def configure(&block)
-            Api.instance_eval &block
+            Api.instance_eval(&block)
           end
         end
       INCL

data/lib/ncore/client.rb

@@ -26,15 +26,15 @@ module NCore
 
         path = URI.parse(url).path
         if [:get, :head, :delete].include? method
-          qs = build_query_string params
+          qs = build_query_string params.as_json
           url += qs
           path += qs
           payload = nil
         else
           if defined? MultiJson
-            payload = MultiJson.encode params
+            payload = MultiJson.encode params.as_json
           else
-            payload = JSON.generate params
+            payload = params.to_json
           end
         end
 
@@ -79,7 +79,7 @@ module NCore
         h = {}
         [default_headers, auth_headers(req_credentials), headers].each do |set|
           set.each do |k,v|
-            k = k.to_s.tr('_','-').gsub(%r{(^|-)\w}){$&.upcase}
+            k = k.to_s.tr('_','-').downcase
             h[k] = v.respond_to?(:call) ? v.call : v
           end
         end
@@ -118,7 +118,7 @@ module NCore
 
       # create a new excon client if necessary
       # keeps a pool of the last 10 urls
-      #   in almost all cases this will be more than enough 
+      #   in almost all cases this will be more than enough
       def excon_client(uri)
         u = URI.parse uri
         u.path = ''
@@ -153,6 +153,7 @@ module NCore
       end
 
       def pool
+        # is actually fiber-local
         Thread.current[:ncore_pool] ||= {}
       end
 
@@ -171,7 +172,6 @@ module NCore
         response = nil
         begin
           ActiveSupport::Notifications.instrument(instrument_key, rest_opts) do
-
             connection = excon_client(rest_opts[:url])
             begin
               tries += 1
@@ -286,9 +286,9 @@ module NCore
         creds.inject({}) do |h,(k,v)|
           if v.present?
             if k == bearer_credential_key
-              h["Authorization"] = "Bearer #{v}"
+              h['authorization'] = "Bearer #{v}"
             else
-              h["#{auth_header_prefix}-#{k}"] = v 
+              h["#{auth_header_prefix}-#{k}"] = v
             end
           end
           h
@@ -325,6 +325,7 @@ module NCore
 
       def debug_response(response)
         return unless logger.debug?
+        headers = response.headers.transform_keys(&:downcase)
         if defined? MultiJson
           json = MultiJson.load(response.body||'', symbolize_keys: false) rescue response.body
         else
@@ -332,8 +333,8 @@ module NCore
         end
         logger << <<~DBG
           RESPONSE:
-            #{response.headers['Status']} | #{response.headers['Content-Type']} | #{response.body.size} bytes
-            #{response.headers.except('Status', 'Connection', 'Content-Type').map{|h,d| "#{h}: #{d}"}.join("\n  ")}
+            #{response.status} | #{headers['content-type']} | #{response.body.size} bytes
+            #{headers.except('status', 'connection', 'content-length', 'content-type').map{|h,d| "#{h}: #{d}"}.join("\n  ")}
             #{json.pretty_inspect.split("\n").join("\n  ")}
           #{'-=- '*18}
         DBG

data/lib/ncore/client_cache.rb

@@ -37,10 +37,11 @@ module NCore
 
 
       def request_cache_key(url:, headers:)
+        hdrs = headers.reject{|k,v| k=='x-request-id'}.sort
         [ 'ncore',
           url.gsub(/[^a-zA-Z0-9]+/,'-'),
-          Digest::MD5.hexdigest(headers.sort.to_s)
-        ].join ':'
+          Digest::MD5.hexdigest(hdrs.to_s)
+        ].join(':')
       end
 
     end

data/lib/ncore/configuration.rb

@@ -38,7 +38,7 @@ module NCore
         self.status_page = 'the status page'
 
         mattr_accessor :auth_header_prefix
-        self.auth_header_prefix = 'X-Api'
+        self.auth_header_prefix = 'x-api'
 
         mattr_reader :bearer_credential_key
         class_eval <<-MTH

data/lib/ncore/methods/delete_bulk.rb

@@ -7,7 +7,7 @@ module NCore
         raise(module_parent::RecordNotFound, "ids must not be empty") if ids.blank?
         params[:ids] = ids
         params = parse_request_params(params)
-        parsed, creds = request(:delete, resource_path, params)
+        parsed, _creds = request(:delete, resource_path, params)
         if parsed[:errors].any?
           raise module_parent::BulkActionError, parsed[:errors]
         else

data/lib/ncore/methods/update_bulk.rb

@@ -7,7 +7,7 @@ module NCore
         raise(module_parent::RecordNotFound, "ids must not be empty") if ids.blank?
         params = parse_request_params(params, json_root: json_root)
         params[:ids] = ids
-        parsed, creds = request(:put, resource_path, params)
+        parsed, _creds = request(:put, resource_path, params)
         if parsed[:errors].any?
           raise module_parent::BulkActionError, parsed[:errors]
         else

data/lib/ncore/rails/log_subscriber.rb

@@ -26,6 +26,8 @@ module NCore
       end
     end
 
+    DEBUG_STATUSES = (200..299).to_a + [404, 409, 422]
+
     def log_request(event)
       self.class.runtime += event.duration
 
@@ -38,13 +40,14 @@ module NCore
       res = " -> %d (%.1f ms)" % [http_status, event.duration]
 
       msg = color(msg, :yellow)
+        # for rails≤70, must exclude :bold param entirely since a Hash is truthy
       if (200..299).include? http_status
         res = color(res, :green, bold: true)
       else
         res = color(res, :red, bold: true)
       end
 
-      if (200..299).include? http_status
+      if DEBUG_STATUSES.include? http_status
         debug "  #{msg}"
         debug "  #{res}"
       else

data/lib/ncore/util.rb

@@ -53,7 +53,7 @@ module NCore
         klass_name = key.to_s.camelize.singularize
         begin
           "#{module_name}::#{klass_name}".constantize
-        rescue NameError => e
+        rescue NameError
           default_klass
         end
       end

data/lib/ncore/version.rb

@@ -1,3 +1,3 @@
 module NCore
-  VERSION = '3.6.1'
+  VERSION = '3.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncore
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Notioneer Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: NCore - Gem for building REST API clients