bubbles-rest-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ddba0cef2c0e511b7352a6f0bfd2bc2add23a9f
-  data.tar.gz: a09dfa1bea98d9aef9e1e00afc7d5ebfb4c1dd27
+  metadata.gz: 9ad75198eea8a1ae90b920cdaf131f8835eec848
+  data.tar.gz: 2213e42c80108c736a737edf350763b934013056
 SHA512:
-  metadata.gz: 1518179880d79a69e0b55cc33c4e1001ed2d29c4b3ed662b2dbea46337f7f64dca3635e7243b98f129c80331c3597f7bff0a2e60bfaefd0c8ec77200b0509a84
-  data.tar.gz: b3f7724f3ba7a2a1e4ddc8af0a61c9692f8f6473132214d77fbbd782e19deaddfceaf55d4cbe30b1aba4e727343a6a6edb826a0f118ee0a2c69b89caad67e1ce
+  metadata.gz: 3c4cef54a47849f040fc3e1c73978f6408d50690e7ef78a7dc72ffb166fd539427535cd4c7c5456c3837188fa256e44b21b5e5128d449fbaab912341f0aac883
+  data.tar.gz: 7d2a4630c75ba13393f49c262ecccab694ff0e46ba3f574503233057245bc5d91b8ea270bef50e235ec7b01da4bb04769d4459c0eb6f9d98a0d1976172f51127

data/README.md

@@ -29,8 +29,7 @@ _bubbles_ is a Gem that seeks to provide this same behavior.
 Currently, bubbles has a number of limitations that make it likely not suitable for use in a production environment. Each of these is tracked by an issue on our [issues page](https://github.com/FoamFactory/bubbles/issues).
 
   - Passing an API key with a request is restricted to using `X-Api-Key` as a header key (#10).
-  - Some request methods (`PATCH`, `PUT`, `DELETE`) do not currently allow unauthenticated access. In other words, it is not possible to perform a `DELETE` request on your API without passing an authorization token. (#9)
-  - Only three types of environment are currently allowed. Only `local`, `staging` and `production` are recognized as possible environments to connect to for the purposes of using bubbles. You can add any scheme, host, and port to any of these, but the names are currently hardcoded, as is the number of possible hosts. (#4)
+  - Some request methods (specifically `DELETE`) do not currently allow unauthenticated access. In other words, it is not possible to perform a `DELETE` request on your API without passing an authorization token. (#16)
   - Not all possible combinations of `has_uri_params`, `authenticated`, and `api_key_required` are tested. In some cases, such as with `GET` requests, there aren't any tests for possible configuration cases that might cause issues when combined. (#12)
 
 If you're interested in working on any of the issues above, please feel free to submit a pull request and a member of our team will review that pull request within a couple of days.

data/lib/bubbles/config.rb

@@ -218,17 +218,24 @@ module Bubbles
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token, data|
-                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, nil, data
+                  # TODO: Nothing tests this case. We need something to test this case or we run the risk of
+                  #       it having bugs (uri_params was nil previously!)
+                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, {}, data
                 end
               end
             end
           else
-            raise 'Unauthenticated PATCH requests are not implemented'
-            # Bubbles::RestEnvironment.class_exec do
-            # define_method(endpoint_name_as_sym) do
-            #   RestClientResources.execute_delete_unauthenticated self, endpoint
-            # end
-            # end
+            Bubbles::RestEnvironment.class_exec do
+              if endpoint.has_uri_params?
+                define_method(endpoint_name_as_sym) do |uri_params, data|
+                  RestClientResources.execute_patch_unauthenticated self, endpoint, uri_params, data
+                end
+              else
+                define_method(endpoint_name_as_sym) do |data|
+                  RestClientResources.execute_patch_unauthenticated self, endpoint, {}, data
+                end
+              end
+            end
           end
         elsif endpoint.method == :put
           if endpoint.authenticated?
@@ -239,17 +246,25 @@ module Bubbles
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token, data|
-                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, nil, data
+                  # TODO: Nothing tests this case. We need something to test this case or we run the risk of
+                  #       it having bugs (uri_params was nil previously!)
+                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, {}, data
                 end
               end
             end
           else
-            raise 'Unauthenticated PUT requests are not implemented'
-            # Bubbles::RestEnvironment.class_exec do
-            # define_method(endpoint_name_as_sym) do
-            #   RestClientResources.execute_delete_unauthenticated self, endpoint
-            # end
-            # end
+            # raise 'Unauthenticated PUT requests are not implemented'
+            Bubbles::RestEnvironment.class_exec do
+              if endpoint.has_uri_params?
+                define_method(endpoint_name_as_sym) do |uri_params, data|
+                  RestClientResources.execute_put_unauthenticated self, endpoint, uri_params, data
+                end
+              else
+                define_method(endpoint_name_as_sym) do |data|
+                  RestClientResources.execute_put_unauthenticated self, endpoint, {}, data
+                end
+              end
+            end
           end
         elsif endpoint.method == :head
           if endpoint.authenticated?

data/lib/bubbles/rest_client_resources.rb

@@ -194,6 +194,27 @@ module Bubbles
       end
     end
 
+    ##
+    # Execute a PATCH request without authentication.
+    #
+    # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
+    # @param [Endpoint] endpoint The +Endpoint+ which should be requested
+    # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    #
+    # @return [RestClient::Response] The +Response+ resulting from the execution of the PATCH call.
+    #
+    def self.execute_patch_unauthenticated(env, endpoint, uri_params, data)
+      return execute_rest_call(env, endpoint, data, nil, nil, uri_params) do |env, url, data, headers|
+        if env.scheme == 'https'
+          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
+            .patch(data.to_json, headers)
+        else
+          next RestClient.patch(url.to_s, data.to_json, headers)
+        end
+      end
+    end
+
     ##
     # Execute a PUT request with authentication in the form of an authorization token.
     #
@@ -218,6 +239,27 @@ module Bubbles
       end
     end
 
+    ##
+    # Execute a PUT request without authentication.
+    #
+    # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
+    # @param [Endpoint] endpoint The +Endpoint+ which should be requested
+    # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    #
+    # @return [RestClient::Response] The +Response+ resulting from the execution of the PUT call.
+    #
+    def self.execute_put_unauthenticated(env, endpoint, uri_params, data)
+      return execute_rest_call(env, endpoint, data, nil, nil, uri_params) do |env, url, data, headers|
+        if env.scheme == 'https'
+          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
+            .put(data.to_json, headers)
+        else
+          next RestClient.put(url.to_s, data.to_json, headers)
+        end
+      end
+    end
+
     ##
     # Execute a DELETE request with authentication in the form of an authorization token.
     #

data/lib/bubbles/version.rb

@@ -7,7 +7,7 @@ module Bubbles
     end
 
     def self.version_name
-      '0.2.0'
+      '0.3.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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler