bubbles-rest-client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f077a290f6996a9d6b17eaed8ad1cb4218dc63d1303ac98dd3ac7100e77a03a
-  data.tar.gz: b6737cdf8435852167b508fe3a3b231ab2c98cb0f87489c1111c498d1eac2af1
+  metadata.gz: 0e98610b1755842e9daf75e52a69e406f76ee3726c5b1d5b7094b519a289a8dd
+  data.tar.gz: eef0efcad84ca786a3e425c3251020f54539015ed199b4ccf00d5aaa7acc8e60
 SHA512:
-  metadata.gz: a899787ccb3ebcca5fc4bc6407e33d9c9fb96c478864f7eaf1b64c75b8d4bfd96ee638c3da6125f30bd1c81cbfd360a14962cbde03b2fd4f9f73c1f51eccb206
-  data.tar.gz: 70e5a4dbf61c052fb0a0af1a6cf8590132aeaea66aee30f30b99d66a968d34a02606c490782d6cdcf0b0fa14f98d3dfaf15ed88b15f00350638a9b8dca810d89
+  metadata.gz: d57f7ef6b948deec157e1109e17912c0fb923d4bc21626d6df2a91d4958c7cb0ac60c377507f27b3c142a88d09bc09e6e391f9ec8c9ebbe08566fca5c9ba76ce
+  data.tar.gz: 6649af7c90e05d2260bc7fd51ba26c43693b09f9a1e38df18483f78873f761e7261ab13f7fe615909e5da66a299b13eb1830dee3663e6f7bdc881265e72ab374

data/bubbles.gemspec

@@ -32,7 +32,7 @@ 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", "~> 2.1.4"
+  spec.add_development_dependency "bundler", "~> 2.2.26"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.1"

data/lib/bubbles/config.rb

@@ -171,12 +171,35 @@ module Bubbles
           if endpoint.authenticated?
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
-                define_method(endpoint_name_as_sym) do |auth_token, uri_params|
-                  RestClientResources.execute_get_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                if endpoint.encode_authorization_header?
+                  define_method(endpoint_name_as_sym) do |username, password, uri_params|
+                    login_data = {
+                      :login => username,
+                      :password => password
+                    }
+                    auth_value = RestClientResources.get_encoded_authorization(endpoint, login_data)
+                    RestClientResources.execute_get_authenticated self, endpoint, :basic, auth_value, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                  end
+                else
+                  define_method(endpoint_name_as_sym) do |auth_token, uri_params|
+                    RestClientResources.execute_get_authenticated self, endpoint, :bearer, auth_token, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                  end
                 end
               else
-                define_method(endpoint_name_as_sym) do |auth_token|
-                  RestClientResources.execute_get_authenticated self, endpoint, auth_token, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                if endpoint.encode_authorization_header?
+                  define_method(endpoint_name_as_sym) do |username, password|
+                    login_data = {
+                      :username => username,
+                      :password => password
+                    }
+                    auth_value = RestClientResources.get_encoded_authorization(endpoint, login_data)
+
+                    RestClientResources.execute_get_authenticated self, endpoint, :basic, auth_value, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                  end
+                else
+                  define_method(endpoint_name_as_sym) do |auth_token|
+                    RestClientResources.execute_get_authenticated self, endpoint, :bearer, auth_token, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                  end
                 end
               end
             end
@@ -194,23 +217,31 @@ module Bubbles
             end
           end
         elsif endpoint.method == :post
-          if endpoint.authenticated?
+          if endpoint.authenticated? and !endpoint.encode_authorization_header?
             Bubbles::RestEnvironment.class_exec do
               define_method(endpoint_name_as_sym) do |auth_token, data|
-                RestClientResources.execute_post_authenticated self, endpoint, auth_token, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                RestClientResources.execute_post_authenticated self, endpoint, :bearer, auth_token, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+              end
+            end
+          elsif endpoint.encode_authorization_header?
+            Bubbles::RestEnvironment.class_exec do
+              define_method(endpoint_name_as_sym) do |username, password, data = {}|
+                login_data = {
+                  :username => username,
+                  :password => password
+                }
+
+                auth_value = RestClientResources.get_encoded_authorization(endpoint, login_data)
+                # composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+                #                                                                   Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
+                #                                                                 })
+                RestClientResources.execute_post_authenticated self, endpoint, :basic, auth_value, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
               end
             end
           else
             Bubbles::RestEnvironment.class_exec do
               define_method(endpoint_name_as_sym) do |data|
                 composite_headers = endpoint.additional_headers
-                if endpoint.encode_authorization_header?
-                  auth_value = RestClientResources.get_encoded_authorization(endpoint, data)
-                  composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
-                                                                                    Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
-                                                                                  })
-                end
-
                 RestClientResources.execute_post_unauthenticated self, endpoint, data, composite_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
               end
             end

data/lib/bubbles/rest_client_resources.rb

@@ -51,7 +51,8 @@ module Bubbles
     #
     # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
-    # @param [String] auth_token The authorization token to use for authentication.
+    # @param [Symbol] auth_type The authorization type to use (Bearer, or Basic)
+    # @param [String] auth_value The authorization token OR encoded value (login/password )to use for authentication.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
     # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
     #        call. Defaults to an empty +Hash+.
@@ -62,10 +63,17 @@ module Bubbles
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the GET call.
     #
-    def self.execute_get_authenticated(env, endpoint, auth_token, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
-      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+    def self.execute_get_authenticated(env, endpoint, auth_type, auth_value, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      if auth_type == :basic
+        composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+          Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
+        })
+        auth_value = nil
+      else
+        composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+      end
 
-      execute_rest_call(env, endpoint, nil, auth_token, composite_headers, uri_params) do |env, url, data, headers|
+      execute_rest_call(env, endpoint, nil, auth_value, composite_headers, uri_params) do |env, url, data, headers|
         next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).get(headers)
       end
     end
@@ -163,10 +171,17 @@ module Bubbles
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the POST call.
     #
-    def self.execute_post_authenticated(env, endpoint, auth_token, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
-      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+    def self.execute_post_authenticated(env, endpoint, auth_type, auth_value, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      if auth_type == :basic
+        composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+          Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
+        })
+        auth_value = nil
+      else
+        composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+      end
 
-      return execute_rest_call(env, endpoint, data, auth_token, composite_headers) do |env, url, data, headers|
+      execute_rest_call(env, endpoint, data, auth_value, composite_headers) do |env, url, data, headers|
         next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).post(data.to_json, headers)
       end
     end

data/lib/bubbles/version.rb

@@ -7,7 +7,7 @@ module Bubbles
     end
 
     def self.version_name
-      '0.6.0'
+      '0.7.0'
     end
 
     def self.version_code

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bubbles-rest-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.26
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: A gem for easily defining client REST interfaces in Ruby