manageiq-api-client 0.3.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dec9fe356657ce4cfd68117c3782600682ad3866f666fd10aabbc88a0c47f3f
-  data.tar.gz: f6b2c0d1515a13b033f23ba73aeb58e691810ebfcef3b1e26640180912f283e7
+  metadata.gz: 3a7891f16b3eae78cc834f589cdd23b17a272a84cc3073ab9e8565a0c5b7bb5c
+  data.tar.gz: 59448475061016e496a8b957c2bfcf6421be156a098cfa6f1ded20a0897905c8
 SHA512:
-  metadata.gz: da5baaedb66406e134675e01036f085b92e1fbf091c938f932ab9c81d5f3ca99e2ace57e12a66cbdead50d8794f095d0359511f1d061c3ebd0ea9cce3d8b86fc
-  data.tar.gz: ff1c57b8ae147f36eed38b0535aa789776b2ed3e8088e37bd729b218e5e50afd6c97099e57fbb7244351fc5991f3595ad6fce8463fda72ec2aa2b4a29c098d0e
+  metadata.gz: f66d9368405b2e33acbc7d7ac30b3d9197855a9df5b592502741e1c5a2f0efbe6fa81cf6d0884e8a81df90a0dae8f8f4964f16d9d66a70b98a8ac52b96de3b77
+  data.tar.gz: dbb2ad769d72f8075a7749754eb6501814bcecc96336e6a4ded66a549c4f56429475fea90ab6bd1c63a09d5e8cf464f64e7e87ac17d19fb31005a1bac76fc03b

data/.codeclimate.yml

@@ -12,5 +12,5 @@ plugins:
   rubocop:
     enabled: true
     config: ".rubocop_cc.yml"
-    channel: rubocop-0-82
+    channel: rubocop-1-56-3
 version: '2'

data/.github/workflows/ci.yaml

@@ -12,17 +12,17 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-        - '2.6'
-        - '2.7'
         - '3.0'
+        - '3.1'
         rails-version:
         - '6.0'
         - '6.1'
+        - '7.0'
     env:
       TEST_RAILS_VERSION: ${{ matrix.rails-version }}
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -34,4 +34,4 @@ jobs:
     - name: Report code coverage
       if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.0' && matrix.rails-version == '6.1' }}
       continue-on-error: true
-      uses: paambaati/codeclimate-action@v3.0.0
+      uses: paambaati/codeclimate-action@v6

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.1] - 2024-03-06
+### Added
+- Drop active_support and more_core_extensions dependency [[#115]](https://github.com/ManageIQ/manageiq-api-client/pull/115)
+- Add rails 7 support [[#114]](https://github.com/ManageIQ/manageiq-api-client/pull/114)
+
+## [0.4.0] - 2023-10-16
+### Added
+- Add Bearer token support [[#113]](https://github.com/ManageIQ/manageiq-api-client/pull/113)
+
 ## [0.3.7] - 2023-05-19
 ### Changed
 - Loosen faraday to 1.x. [[#108]](https://github.com/ManageIQ/manageiq-api-client/pull/108)
@@ -61,7 +70,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Add CHANGELOG.md
 - Update README with simple instructions reflecting the query interface.
 
-[Unreleased]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.3.7...HEAD
+[Unreleased]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.3.7...v0.4.0
 [0.3.7]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.3.6...v0.3.7
 [0.3.6]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.3.5...v0.3.6
 [0.3.5]: https://github.com/ManageIQ/manageiq-api-client/compare/v0.3.4...v0.3.5

data/Gemfile

@@ -7,9 +7,14 @@ gemspec
 dev_gemfile = File.expand_path("Gemfile.dev.rb", __dir__)
 eval_gemfile(dev_gemfile) if File.exist?(dev_gemfile)
 
-case ENV['TEST_RAILS_VERSION']
-when "6.0"
-  gem "activesupport", "~>6.0.4"
-when "6.1"
-  gem "activesupport", "~>6.1.4"
-end
+minimum_version =
+  case ENV['TEST_RAILS_VERSION']
+  when "6.0"
+    "~>6.0.4"
+  when "7.0"
+    "~>7.0.8"
+  else
+    "~>6.1.4"
+  end
+
+gem "activesupport", minimum_version

data/lib/manageiq/api/client/authentication.rb

@@ -6,6 +6,7 @@ module ManageIQ
         attr_reader :password
         attr_reader :token
         attr_reader :miqtoken
+        attr_reader :bearer_token
         attr_reader :group
 
         DEFAULTS = {
@@ -13,26 +14,26 @@ module ManageIQ
           :password => "smartvm"
         }.freeze
 
-        CUSTOM_INSPECT_EXCLUSIONS = [:@password].freeze
+        CUSTOM_INSPECT_EXCLUSIONS = %i[@password @token @miqtoken @bearer_token].freeze
         include CustomInspectMixin
 
         def initialize(options = {})
           @user, @password = fetch_credentials(options)
-          @token, @miqtoken, @group = options.values_at(:token, :miqtoken, :group)
+          @token, @miqtoken, @bearer_token, @group = options.values_at(:token, :miqtoken, :bearer_token, :group)
 
-          unless token || miqtoken
+          unless token || miqtoken || bearer_token
             raise "Must specify both a user and a password" if user.blank? || password.blank?
           end
         end
 
         def self.auth_options_specified?(options)
-          options.slice(:user, :password, :token, :miqtoken, :group).present?
+          options.slice(:user, :password, :token, :miqtoken, :bearer_token, :group).present?
         end
 
         private
 
         def fetch_credentials(options)
-          if options.slice(:user, :password, :token, :miqtoken).blank?
+          if options.slice(:user, :password, :token, :miqtoken, :bearer_token).blank?
             [DEFAULTS[:user], DEFAULTS[:password]]
           else
             [options[:user], options[:password]]

data/lib/manageiq/api/client/client.rb

@@ -1,6 +1,7 @@
 module ManageIQ
   module API
     class Client
+      extend Forwardable
       attr_reader :client_options
       attr_reader :logger
       attr_reader :url
@@ -62,7 +63,7 @@ module ManageIQ
         load_definitions
       end
 
-      delegate :get, :post, :put, :patch, :delete, :options, :error, :to => :connection
+      def_delegators :connection, :get, :post, :put, :patch, :delete, :options, :error
 
       private
 

data/lib/manageiq/api/client/connection.rb

@@ -2,6 +2,8 @@ module ManageIQ
   module API
     class Client
       class Connection
+        extend Forwardable
+
         attr_reader :url
         attr_reader :authentication
         attr_reader :client
@@ -9,7 +11,7 @@ module ManageIQ
         attr_reader :response
         attr_reader :error
 
-        delegate :url, :authentication, :to => :client
+        def_delegators :client, :url, :authentication
 
         API_PREFIX = "/api".freeze
         CONTENT_TYPE = "application/json".freeze
@@ -58,12 +60,12 @@ module ManageIQ
         end
 
         def api_path(path)
-          if path.to_s.starts_with?(url.to_s)
+          if path.to_s.start_with?(url.to_s)
             path.to_s
           elsif path.to_s.blank?
             URI.join(url, API_PREFIX).to_s
           else
-            URI.join(url, path.to_s.starts_with?(API_PREFIX) ? path.to_s : "#{API_PREFIX}/#{path}").to_s
+            URI.join(url, path.to_s.start_with?(API_PREFIX) ? path.to_s : "#{API_PREFIX}/#{path}").to_s
           end
         end
 
@@ -74,10 +76,17 @@ module ManageIQ
             faraday.options.open_timeout = @connection_options[:open_timeout] if @connection_options[:open_timeout]
             faraday.options.timeout      = @connection_options[:timeout]      if @connection_options[:timeout]
             faraday.response(:logger, client.logger)
-            faraday.use FaradayMiddleware::FollowRedirects, :limit => 3, :standards_compliant => true
-            faraday.adapter(Faraday.default_adapter) # make requests with Net::HTTP
-            if authentication.token.blank? && authentication.miqtoken.blank?
-              faraday.basic_auth(authentication.user, authentication.password)
+            faraday.response(:follow_redirects, :limit => 3, :standards_compliant => true)
+            # make requests with Net::HTTP
+            faraday.adapter(Faraday.default_adapter)
+            if authentication.token.blank? && authentication.miqtoken.blank? && authentication.bearer_token.blank?
+              if faraday.respond_to?(:basic_auth)
+                # faraday 1.0
+                faraday.basic_auth(authentication.user, authentication.password)
+              else
+                # faraday 2.0
+                faraday.request(:authorization, :basic, authentication.user, authentication.password)
+              end
             end
           end
         end
@@ -90,6 +99,7 @@ module ManageIQ
             @response = handle.run_request(method.to_sym, api_path(path), nil, nil) do |request|
               request.headers[:content_type]  = CONTENT_TYPE
               request.headers[:accept]        = CONTENT_TYPE
+              request.headers[:authorization] = "Bearer #{authentication.bearer_token}" unless authentication.bearer_token.blank?
               request.headers['X-MIQ-Group']  = authentication.group unless authentication.group.blank?
               request.headers['X-Auth-Token'] = authentication.token unless authentication.token.blank?
               request.headers['X-MIQ-Token']  = authentication.miqtoken unless authentication.miqtoken.blank?
@@ -104,11 +114,11 @@ module ManageIQ
 
         def check_response
           if response.status == 404
-            message = json_response.fetch_path("error", "message") || json_response["error"]
+            message = json_response["error"].kind_of?(String) ? json_response["error"] : json_response.dig("error", "message")
             raise ManageIQ::API::Client::ResourceNotFound, message
           elsif response.status >= 400
             @error = ManageIQ::API::Client::Error.new(response.status, json_response)
-            raise @error.message
+            raise ManageIQ::API::Client::Exception, @error.message || "Empty Response"
           end
         end
       end

data/lib/manageiq/api/client/resource.rb

@@ -2,6 +2,7 @@ module ManageIQ
   module API
     class Client
       class Resource
+        extend Forwardable
         include ActionMixin
 
         CUSTOM_INSPECT_EXCLUSIONS = [:@collection].freeze
@@ -21,7 +22,7 @@ module ManageIQ
         attr_reader :collection
         attr_reader :actions
 
-        delegate :client, :to => :collection
+        def_delegators :collection, :client
 
         def initialize(collection, resource_hash)
           raise "Cannot instantiate a Resource directly" if instance_of?(Resource)

data/lib/manageiq/api/client/version.rb

@@ -1,7 +1,7 @@
 module ManageIQ
   module API
     class Client
-      VERSION = "0.3.7".freeze
+      VERSION = "0.4.1".freeze
     end
   end
 end

data/lib/manageiq/api/client.rb

@@ -1,10 +1,9 @@
 require "active_support"
 require "active_support/core_ext"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
+require 'forwardable'
 require "json"
-require "more_core_extensions/all"
-require "pp"
 require "query_relation"
 
 require "manageiq/api/client/client"

data/manageiq-api-client.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 5.0", "< 7.0"
-  spec.add_dependency "faraday", "~> 1.0"
-  spec.add_dependency "faraday_middleware", "~> 1.0"
+  spec.add_dependency "activesupport", ">= 6.0", "<7.1"
+  spec.add_dependency "faraday", ">= 1.0", "< 3.0"
+  spec.add_dependency "faraday-follow_redirects"
   spec.add_dependency "json", "~> 2.3"
-  spec.add_dependency "more_core_extensions"
   spec.add_dependency "query_relation"
 
   spec.add_development_dependency "bundler"

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-api-client
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.1
 platform: ruby
 authors:
 - Alberto Bellotti
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,48 +17,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -73,20 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: more_core_extensions
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: query_relation
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +225,7 @@ files:
 - lib/manageiq/api/client/version.rb
 - lib/manageiq_api_client.rb
 - manageiq-api-client.gemspec
+- renovate.json
 homepage: http://github.com/ManageIQ/manageiq-api-client
 licenses:
 - MIT
@@ -252,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: ManageIQ API Client