bubbles-rest-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3db39174193ea887659c8e1d859048526b0c5335
-  data.tar.gz: 8254a56110041009e0e03c32aae4b1a1de08b914
+  metadata.gz: 9ddba0cef2c0e511b7352a6f0bfd2bc2add23a9f
+  data.tar.gz: a09dfa1bea98d9aef9e1e00afc7d5ebfb4c1dd27
 SHA512:
-  metadata.gz: 8c0f6e722b868cf82d60f0a12e17b3ea24cc59f65ea756e93bf07d906670b49dd700a44f2f2631b0d1ef6ff264bfa0c13d1c74dfaf2e26e7944f1d3ae175924e
-  data.tar.gz: 3211a7eda8805bdba2678c551f73dd8212d188ce371a4a3a526010b8a6507071f5ba41d41ef93a253afa37bf99b5a3f955f9098f963d0b3f83dfbc79078744a7
+  metadata.gz: 1518179880d79a69e0b55cc33c4e1001ed2d29c4b3ed662b2dbea46337f7f64dca3635e7243b98f129c80331c3597f7bff0a2e60bfaefd0c8ec77200b0509a84
+  data.tar.gz: b3f7724f3ba7a2a1e4ddc8af0a61c9692f8f6473132214d77fbbd782e19deaddfceaf55d4cbe30b1aba4e727343a6a6edb826a0f118ee0a2c69b89caad67e1ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bubbles-rest-client (0.1.0)
+    bubbles-rest-client (0.2.0)
       addressable (~> 2.5)
       rest-client (~> 2.0)
 
@@ -24,7 +24,7 @@ GEM
     json (2.0.2)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     minitest (5.11.3)
     minitest-reporters (1.1.19)
       ansi
@@ -60,7 +60,7 @@ GEM
     simplecov-html (0.10.2)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     vcr (3.0.3)
     webmock (3.0.1)
       addressable (>= 2.3.6)
@@ -72,7 +72,7 @@ PLATFORMS
 
 DEPENDENCIES
   bubbles-rest-client!
-  bundler (~> 1.14)
+  bundler (~> 2.0.0)
   minitest (~> 5.0)
   minitest-reporters (~> 1.1)
   rake (~> 10.0)
@@ -82,4 +82,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   1.14.3
+   2.0.1

data/README.md

@@ -32,7 +32,6 @@ Currently, bubbles has a number of limitations that make it likely not suitable
   - 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)
   - 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)
-  - Usage of the `expect_json` configuration parameter is not intuitive. You should think of this as more of a "I want an object back from the API", rather than how it's worded. (#11)
 
 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.
 
@@ -164,7 +163,7 @@ Each _endpoint_ object can have the following attributes:
 | `name` | The name to give the method created to make this REST call. | No | The value of the `location` parameter, with slashes (`/`) replaced with underscores (`_`). |
 | `authorization` | Whether or not this endpoint requires authentication prior to executing the call. If true, then an `authorization_token` will be added to the method as a parameter to be passed when the method is called. This parameter will be placed in an `Authorization` header when the REST call is executed. | No | `false` |
 | `api_key_required` | Whether or not an API key is required. If `true`, a parameter will be added to the method created to execute the REST API call named `api_key`. The value of this parameter will be set as the value of the `X-Api-Key` header when making the REST API call. | No | `false` |
-| `expect_json` | Whether or not JSON is expected as the format of the `body` of both the Request and Response. Additionally, specifying `true` for this option will cause methods executing REST requests to return `OpenStruct` objects representing the fully-parsed JSON response (on success). See note under "Limitations", above, on using this parameter. | No | `false` |
+| `return_type` | Must be one of: `[full_response, body_as_object, body_as_string]`. This specifies what type of response is expected from the `Endpoint`. A value of `full_response` will return the full `RestClient::Response` object to the client. A value of `body_as_string` will return the `RestClient::Response.body` value as a `String`. A value of `body_as_object` will take the `RestClient::Response.body` parameter and parse it as an `OpenStruct` object, and return the result of this parsing operation. | No | `body_as_string` |
 | `encode_authorization` | Whether the `data` passed as part of the request should be re-encoded as an `Authorization: Basic` header (and Base64 encoded). Typically, this is only used for initial username/password authentication. | No | `false` |
 
 ### Examples

data/bubbles.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = Bubbles::VersionInformation.package_name
   spec.version       = Bubbles::VersionInformation.version_name
   spec.date        = Date.today.strftime("%Y-%m-%d")
-  spec.summary     = 'FoamFactory REST Client'
+  spec.summary     = 'Bubbles REST Client'
   spec.homepage    = 'https://github.com/FoamFactory/bubbles'
   spec.authors     = ['Scott Johnson']
   spec.email       = 'jaywir3@gmail.com'
@@ -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", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.0.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.1"

data/lib/bubbles/config.rb

@@ -39,106 +39,42 @@ module Bubbles
   #
   class Configuration
     def initialize
-      @local_environment_scheme = 'http'
-      @local_environment_host = '127.0.0.1'
-      @local_environment_port = '1234'
-      @local_environment_api_key = nil
-
-      @staging_environment_scheme = 'http'
-      @staging_environment_host = '127.0.0.1'
-      @staging_environment_port = '1234'
-      @staging_environment_api_key = nil
-
-      @production_environment_scheme = 'http'
-      @production_environment_host = '127.0.0.1'
-      @production_environment_port = '1234'
-      @production_environment_api_key = nil
+      @environment_scheme = 'http'
+      @environment_host = '127.0.0.1'
+      @environment_port = '1234'
+      @environment_api_key = nil
 
       @endpoints = Hash.new
     end
 
     ##
-    # Retrieve the local {RestEnvironment} object defined as part of this Configuration.
-    #
-    def local_environment
-      RestEnvironment.new(@local_environment_scheme, @local_environment_host, @local_environment_port, @local_environment_api_key)
-    end
-
-    ##
-    # Set the local environment.
-    #
-    # @param [Object] env The environment, as a generic Ruby Object.
+    # Retrieve the {RestEnvironment} object defined as part of this Configuration.
     #
-    # @example In app/config/initializers/bubbles.rb
-    #    Bubbles.configure do |config|
-    #      config.local_environment = {
-    #         :scheme => 'https',
-    #         :host => 'api.somehost.com',
-    #         :port => '443'
-    #      }
-    #    end
-    #
-    def local_environment=(env)
-      @local_environment_scheme = env[:scheme]
-      @local_environment_host = env[:host]
-      @local_environment_port = env[:port]
-      @local_environment_api_key = env[:api_key]
-    end
-
-    ##
-    # Retrieve the staging {RestEnvironment} object defined as part of this Configuration.
+    # Note that this constructs a new +RestEnvironment+ and returns it, rather than returning an existing object.
     #
-    def staging_environment
-      RestEnvironment.new(@staging_environment_scheme, @staging_environment_host, @staging_environment_port, @staging_environment_api_key)
+    def environment
+      RestEnvironment.new(@environment_scheme, @environment_host, @environment_port, @environment_api_key)
     end
 
     ##
-    # Set the staging environment.
+    # Set the current environment.
     #
     # @param [Object] env The environment, as a generic Ruby Object.
     #
-    # @example In app/config/initializers/bubbles.rb
+    # @example In app/config/environments/staging.rb:
     #    Bubbles.configure do |config|
-    #      config.staging_environment = {
+    #      config.environment = {
     #         :scheme => 'https',
-    #         :host => 'api.somehost.com',
+    #         :host => 'stage.api.somehost.com',
     #         :port => '443'
     #      }
     #    end
     #
-    def staging_environment=(env)
-      @staging_environment_scheme = env[:scheme]
-      @staging_environment_host = env[:host]
-      @staging_environment_port = env[:port]
-      @staging_environment_api_key = env[:api_key]
-    end
-
-    ##
-    # Retrieve the production {RestEnvironment} object defined as part of this Configuration.
-    #
-    def production_environment
-      RestEnvironment.new(@production_environment_scheme, @production_environment_host, @production_environment_port, @production_environment_api_key)
-    end
-
-    ##
-    # Set the production environment.
-    #
-    # @param [Object] env The environment, as a generic Ruby Object.
-    #
-    # @example In app/config/initializers/bubbles.rb
-    #    Bubbles.configure do |config|
-    #      config.production_environment = {
-    #         :scheme => 'https',
-    #         :host => 'api.somehost.com',
-    #         :port => '443',
-    #      }
-    #    end
-    #
-    def production_environment=(env)
-      @production_environment_scheme = env[:scheme]
-      @production_environment_host = env[:host]
-      @production_environment_port = env[:port]
-      @production_environment_api_key = env[:api_key]
+    def environment=(env)
+      @environment_scheme = env[:scheme]
+      @environment_host = env[:host]
+      @environment_port = env[:port]
+      @environment_api_key = env[:api_key]
     end
 
     ##
@@ -167,7 +103,7 @@ module Bubbles
     def endpoints=(endpoints)
       new_endpoints = Hash.new
       endpoints.each do |ep|
-        endpoint_object = Endpoint.new ep[:method], ep[:location].to_s, ep[:authenticated], ep[:api_key_required], ep[:name], ep[:expect_json], ep[:encode_authorization]
+        endpoint_object = Endpoint.new ep[:method], ep[:location].to_s, ep[:authenticated], ep[:api_key_required], ep[:name], ep[:return_type], ep[:encode_authorization]
 
         new_endpoints[endpoint_object.get_key_string] = endpoint_object
       end
@@ -182,7 +118,7 @@ module Bubbles
           endpoint_name_as_sym = endpoint.get_location_string.to_sym
         end
 
-        if Bubbles::RestEnvironment.instance_methods(false).include? (endpoint_name_as_sym)
+        if Bubbles::RestEnvironment.instance_methods(false).include?(endpoint_name_as_sym)
           Bubbles::RestEnvironment.class_exec do
             remove_method endpoint_name_as_sym
           end

data/lib/bubbles/endpoint.rb

@@ -11,7 +11,8 @@ module Bubbles
   class Endpoint
     ##
     # Controls the method used to access the endpoint. Must be one of {Endpoint::Methods}.
-    # @return [Symbol] the method used to access the endpoint. Will always be one of the symbols defined in {Endpoint::METHODS}.
+    # @return [Symbol] the method used to access the endpoint. Will always be one of the symbols defined in
+    #         {Endpoint::METHODS}.
     attr_accessor :method
 
     ##
@@ -30,9 +31,10 @@ module Bubbles
     attr_accessor :api_key_required
 
     ##
-    # Controls whether JSON is the expected form of output from this +Endpoint+.
-    # @return [Boolean] true, if JSON is the expected form of output from this +Endpoint+; false, otherwise.
-    attr_accessor :expect_json
+    # Controls what type of object will be returned from the REST API call on success. Must be one of the symbols
+    # defined in {Endpoint::RETURN_TYPES}.
+    #
+    attr_accessor :return_type
 
     ##
     # Controls which data values should be encoded as part of an Authorization header. They will be separated with a
@@ -51,14 +53,17 @@ module Bubbles
     ## A template for specifying the complete URL for endpoints, with a port attached to the host.
     API_URL_WITH_PORT = ::Addressable::Template.new("{scheme}://{host}:{port}/{endpoint}")
 
-
     ## The HTTP methods supported by a rest client utilizing Bubbles.
     METHODS = %w[get post patch put delete head].freeze
 
+    ## The possible return types for successful REST calls. Defaults to :body_as_string.
+    RETURN_TYPES = %w[full_response body_as_string body_as_object].freeze
+
     ##
     # Construct a new instance of an Endpoint.
     #
-    # @param [Symbol] method The type of the new Endpoint to create. Must be one of the methods in {Endpoint::METHODS}.
+    # @param [Symbol] method The type of the new Endpoint to create. Must be one of the methods in
+    #        {Endpoint::METHODS}.
     # @param [String] location The location, relative to the root of the host, at which the endpoint resides.
     # @param [Boolean] auth_required If true, then authorization/authentication is required to access this endpoint.
     #        Defaults to +false+.
@@ -66,16 +71,23 @@ module Bubbles
     #        +false+.
     # @param [String] name An optional name which will be given to the method that will execute this {Endpoint} within
     #        the context of a {RestClientResources} object.
-    # @param [Boolean] expect_json Whether or not to expect a JSON response from this +Endpoint+. Defaults to +false+.
+    # @param [Array<Symbol>] encode_authorization Parameters that should be treated as authorization parameters and
+    #        encoded using a Base64 encoding.
     #
-    def initialize(method, location, auth_required = false, api_key_required = false, name = nil, expect_json = false, encode_authorization = {})
+    def initialize(method, location, auth_required = false, api_key_required = false, name = nil, return_type = :body_as_string, encode_authorization = {})
       @method = method
       @location = location
       @auth_required = auth_required
       @api_key_required = api_key_required
       @name = name
-      @expect_json = expect_json
       @encode_authorization = encode_authorization
+
+      unless Endpoint::RETURN_TYPES.include? return_type.to_s
+        return_type = :body_as_string
+      end
+
+      @return_type = return_type
+
       @uri_params = []
 
       # Strip the leading slash from the endpoint location, if it's there
@@ -233,7 +245,24 @@ module Bubbles
     #         Authorization header; false, otherwise.
     #
     def encode_authorization_header?
-      @encode_authorization.length > 0
+      !@encode_authorization.nil? and @encode_authorization.length > 0
+    end
+
+    ##
+    # Retrieve the return type of this REST endpoint.
+    #
+    # This will always be one of:
+    #
+    # - +full_response+ : Indicates that the full +Response+ object should be returned so that headers and
+    #   return code can be used.
+    # - +body_as_object+ : Indicates that the body of the +Response+ should be parsed as a full +OpenStruct+
+    #   object and returned.
+    # - +body_as_string+ : Indicates that only the body of the +Response+ object should be returned, as a +String+.
+    #
+    # By default, if this is not specified, it will be +body_as+string+.
+    #
+    def return_type
+      @return_type
     end
 
     def has_uri_params?

data/lib/bubbles/rest_client_resources.rb

@@ -3,16 +3,8 @@ require 'bubbles/rest_environment'
 
 module Bubbles
   class RestClientResources
-    def local_environment
-      Bubbles.configuration.local_environment
-    end
-
-    def staging_environment
-      Bubbles.configuration.staging_environment
-    end
-
-    def production_environment
-      Bubbles.configuration.production_environment
+    def environment
+      Bubbles.configuration.environment
     end
 
     ##
@@ -256,16 +248,16 @@ module Bubbles
     #
     # @return [RestEnvironment] The {RestEnvironment} corresponding to the given {Symbol}.
     #
-    def get_environment(environment)
-      if !environment || environment == :production
-        return self.production_environment
-      elsif environment == :staging
-        return self.staging_environment
-      end
-
-
-      self.local_environment
-    end
+    # def get_environment(environment)
+    #   if !environment || environment == :production
+    #     return self.production_environment
+    #   elsif environment == :staging
+    #     return self.staging_environment
+    #   end
+    #
+    #
+    #   self.local_environment
+    # end
 
     private
 
@@ -311,20 +303,20 @@ module Bubbles
           headers[:authorization] = 'Bearer ' + auth_token
         end
 
-        if endpoint.expect_json
-          headers[:accept] = :json
-        end
+        headers[:accept] = :json
 
         response = block.call(env, url, data, headers)
       rescue Errno::ECONNREFUSED
         response = { :error => 'Unable to connect to host ' + env.host.to_s + ':' + env.port.to_s }.to_json
       end
 
-      unless endpoint.expect_json or endpoint.method != :head
-        return response
+      if endpoint.return_type == :body_as_object and endpoint.method != :head
+          return JSON.parse(response, object_class: OpenStruct)
+      elsif endpoint.return_type == :body_as_string and endpoint.method != :head
+        return response.body
       end
 
-      JSON.parse(response, object_class: OpenStruct)
+      response
     end
   end
 end

data/lib/bubbles/rest_environment.rb

@@ -1,5 +1,3 @@
-require 'addressable/template'
-
 module Bubbles
   class RestEnvironment
     attr_accessor :scheme, :host, :port, :api_key

data/lib/bubbles/version.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Bubbles
   class VersionInformation
     def self.package_name
@@ -5,7 +7,7 @@ module Bubbles
     end
 
     def self.version_name
-      '0.1.0'
+      '0.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-21 00:00:00.000000000 Z
+date: 2019-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A gem for easily defining client REST interfaces in Ruby