bubbles-rest-client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f1034be17b96ea4181b77b4ff472b1e10c8b435d3569180a2c2e008286c573
-  data.tar.gz: 1206b4f733335dfc41d4fa02cb6c171840187c105f2967afcb10d62939015f2c
+  metadata.gz: 7f077a290f6996a9d6b17eaed8ad1cb4218dc63d1303ac98dd3ac7100e77a03a
+  data.tar.gz: b6737cdf8435852167b508fe3a3b231ab2c98cb0f87489c1111c498d1eac2af1
 SHA512:
-  metadata.gz: 050ecf0c162ceec1bbbfac219db53b2e33ec509545e6574f67b6a9f685cf10706f9ea314c9b188d96a23c0109ef4538246d5fc7fb4cc5fafb1ccf200ffdcd3cb
-  data.tar.gz: 152a955fc1788a341c2de601b5d8d6eff7a4263e1d9965f64d7f3943fb2d7f218f092716cd13117a873a2422d0f0efac84be72e90aff9c2147bf02b87f44b8fd
+  metadata.gz: a899787ccb3ebcca5fc4bc6407e33d9c9fb96c478864f7eaf1b64c75b8d4bfd96ee638c3da6125f30bd1c81cbfd360a14962cbde03b2fd4f9f73c1f51eccb206
+  data.tar.gz: 70e5a4dbf61c052fb0a0af1a6cf8590132aeaea66aee30f30b99d66a968d34a02606c490782d6cdcf0b0fa14f98d3dfaf15ed88b15f00350638a9b8dca810d89

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jwir3

data/.gitignore

@@ -43,3 +43,6 @@
 
 # Ignore RubyMine files
 .idea/**
+
+# Ignore Gemfile.lock because this is a gem
+Gemfile.lock

data/README.md

@@ -25,15 +25,6 @@ What this does is allow you to focus on your _handling_ of the REST responses, r
 
 _bubbles_ is a Gem that seeks to provide this same behavior.
 
-## :warning: Limitations
-**Please read this section before using!**
-
-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).
-
-  - 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. (FoamFactory/bubbles#16)
-
-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.
-
 ## Usage
 If you're using Rails, it's suggested to have a `config/initializers/bubbles.rb` configuration file where you can easily configure your endpoints and environments. If you're not using Rails, then you can put this configuration just about anywhere, provided it's executed before where you want to use it.
 
@@ -52,15 +43,15 @@ Bubbles.configure do |config|
     }
   ]
 
-  config.environment = {
+  config.environments = [{
     :scheme => 'http',
     :host => '0.0.0.0',
     :port => '1234'
-  }
+  }]
 end
 ```
 
-The `config.endpoints` section is where you configure which endpoints you want to support. The `config.environment` defines an environment, or remote configuration, for accessing the endpoint on a specific remote destination.
+The `config.endpoints` section is where you configure which endpoints you want to support. The `config.environments` defines the environments, or remote configurations, for accessing the endpoint on specific remote destinations.
 
 Now, you can use this endpoint with:
 ```ruby
@@ -79,267 +70,4 @@ end
 ```
 
 ## Detailed Documentation
-There are currently two parts to a bubbles configuration: the _environments_ and the _endpoints_. Bubbles is configured in a _bubbles configuration block_:
-```ruby
-Bubbles.configure do |config|
-  # You can add configuration for Bubbles here using config.endpoints and config.environment
-end
-```
-
-This configuration block can be run at any time, but is typically set up in the initializer section of an app's startup. If desired, configuration can happen separately. That is, you can initialize environments within your initializer file and then initialize endpoints within another section of the application. Just note that when endpoints are defined, it overwrites _all_ endpoints of a configuration, not just the ones you choose to change.
-
-### Environments
-> :construction: Environment names used to be hardcoded into Bubbles. You can now access the current environment using `Bubbles::Resources.new.environment`. This section is left in the documentation for future reference, as we will eventually be adding back named environments (see FoamFactory/bubbles#23 for tracking information).
-
-Three environments are currently available to be set up within bubbles. These are:
-  - `local_environment` : Designed to be used for a local API for development testing.
-  - `staging_environment` : Designed to be used for a remote API for second-stage testing or production-like deployment.
-  - `production_environment` : Designed to be used for a production environment.
-
-While the names are hardcoded, the environments can be used for anything - you could easily use a `local_environment` to store the information for one of your production servers.
-
-#### Configuration of Environments
-Environments are configured as part of the _bubbles configuration block_ and can have the following parameters:
-
-  - `scheme`: The scheme for accessing endpoints on this host. Should be one of `http` or `https`. Defaults to `http`.
-  - `host`: A domain name or IP address for the remote host to access for the environment.  Defaults to `127.0.0.1`.
-  - `port`: The port to use to access the remote host. Defaults to `1234`.
-  - `api_key`: The API key to send along with requests for a given environment, if an API key is required. This is optional, and defaults to `nil`.
-  - `headers`: A `Hash` of key-value pairs that contain additional headers to pass to every call to this endpoint. Defaults to `{}`.
-
-You can configure all three environments at once in the _bubbles configuration block_:
-```ruby
-Bubbles.configure do |config|
-  config.environment = {
-    :scheme => 'http',
-    :host => '0.0.0.0',
-    :port => '1234'
-  }
-
-  # Note: This is deprecated for the time being. See (FoamFactory/bubbles/#23).
-  # config.staging_environment = {
-  #   :scheme => 'http',
-  #   :host => 'stage.api.foamfactory.com',
-  #   :port => '80'
-  # }
-
-  # Note: This is deprecated for the time being. See (FoamFactory/bubbles/#23).
-  # config.production_environment = {
-  #   :scheme => 'https',
-  #   :host => 'api.foamfactory.com',
-  #   :port => '443'
-  # }
-end
-```
-
-If you choose a scheme of `http` and leave off the `port` configuration variable, it will default to `80`. Similarly, `https` will default to a port of `443`.
-
-#### Configuration of Endpoints
-Endpoints are the meat and potatoes of REST interaction. By indicating a _method_, _uri_, _body_, and _headers_, you are effectively making a function call on a remote server.
-
-_Endpoints_ are specified as an array of objects within the _bubbles configuration block_:
-
-```ruby
-config.endpoints = [
-  # Individual endpoint definitions go here
-]
-```
-
-When processing each of these endpoint definitions, a method is created on instances of `RestEnvironment` that allows you to call the method in question. For example, an endpoint defined as:
-```ruby
-{
-  :method => :get,
-  :location => :version,
-  :authenticated => false,
-  :api_key_required => false
-}
-```
-
-will create a method on instances of `RestEnvironment` called `version`, which will execute the appropriate REST call (via `RestClient`) and return a `RestClient::Response` object.
-
-Each _endpoint_ object can have the following attributes:
-
-| Name    | Description         | Required? | Default |
-| :---    | :------------------ | :-------: | :-----: |
-| `method`| The HTTP method to use to access the API for this endpoint. Must be one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, or `HEAD`. | Yes | N/A |
-| `location`| The path to access the endpoint. This is placed after the `host:port` section to build the URI. It may have URI parameters in the form of `{paramName}`. If a URI parameter is specified within the `location`, a `uri_params` hash will be expected to be passed to the calling method to replace the placeholder values. | Yes | N/A |
-| `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` |
-| `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` |
-| `headers` | A `Hash` of key-value pairs specifying additional headers (the `key` specifies the name of the header, and the `value` specifies the value) that should be passed with each call to this `Endpoint`. Defaults to `{}`.
-
-### Examples
-These examples are taken almost directly from our [test suite](https://github.com/FoamFactory/bubbles/blob/master/spec/bubbles/resources_spec.rb). For more detailed examples, please refer to our specifications located in the `/spec` directory.
-
-#### GET the version of the software (unauthenticated, no API key required)
-**Configuration**:
-
-```ruby
-require 'bubbles'
-
-Bubbles.configure do |config|
-  config.endpoints = [
-    {
-      :method => :get,
-      :location => :version,
-      :authenticated => false,
-      :api_key_required => false,
-      :return_type => :body_as_object
-    }
-  ]
-
-  config.environment = {
-    :scheme => 'http',
-    :host => '0.0.0.0',
-    :port => '1234'
-  }
-end
-```
-
-**Usage**:
-```ruby
-it 'should return an object containing the version information from the API' do
-  resources = Bubbles::Resources.new
-  environment = resources.environment
-
-  response = environment.version
-  expect(response).to_not be_nil
-  expect(response.name).to eq('My Sweet API')
-  expect(response.versionName).to eq('0.0.1')
-end
-```
-
-#### GET a specific user by id (authentication required)
-**Configuration**:
-```ruby
-Bubbles.configure do |config|
-  config.endpoints = [
-    {
-      :method => :get,
-      :location => 'users/{id}',
-      :authenticated => true,
-      :name => :get_user,
-      :return_type => :body_as_object
-    }
-  ]
-
-  config.environment = {
-    :scheme => 'http',
-    :host => '127.0.0.1',
-    :port => '9002'
-  }
-end
-```
-
-**Usage**:
-```ruby
-it 'should return an object containing a user with id = 4' do
-  environment = Bubbles::Resources.new.environment
-  user = environment.get_user(@auth_token, {:id => 4})
-  expect(user).to_not be_nil
-
-  expect(user.id).to eq(4)
-end
-```
-
-#### POST a login (i.e. retrieve an authorization token)
-**Configuration**:
-```ruby
-Bubbles.configure do |config|
-  config.endpoints = [
-    {
-      :method => :post,
-      :location => :login,
-      :authenticated => false,
-      :api_key_required => true,
-      :encode_authorization => [:username, :password],
-      :return_type => :body_as_object
-    }
-  ]
-
-  config.environment = {
-    :scheme => 'http',
-    :host => '127.0.0.1',
-    :port => '9002',
-    :api_key => 'someapikey'
-  }
-end
-```
-
-**Usage**:
-```ruby
-it 'should return a user data structure with a valid authorization token' do
-  environment = Bubbles::Resources.new.environment
-
-  data = { :username => 'myusername', :password => 'mypassword' }
-  login_object = environment.login data
-
-  auth_token = login_object.auth_token
-
-  expect(auth_token).to_not be_nil
-end
-```
-
-#### DELETE a user by id
-**Configuration**:
-```ruby
-Bubbles.configure do |config|
-  config.endpoints = [
-    {
-      :method => :delete,
-      :location => 'users/{id}',
-      :authenticated => true,
-      :name => 'delete_user_by_id',
-      :return_type => :body_as_object
-    }
-  ]
-
-  config.environment = {
-    :scheme => 'http',
-    :host => '127.0.0.1',
-    :port => '9002'
-  }
-```
-
-**Usage**:
-```ruby
-it 'should successfully delete the given user' do
-  environment = Bubbles::Resources.new.environment
-  response = environment.delete_user_by_id @auth_token, {:id => 2}
-  expect(response.success).to eq(true)
-end
-```
-
-#### PATCH a user's information by providing a body containing information to update
-**Configuration**:
-```ruby
-Bubbles.configure do |config|
-  config.endpoints = [
-    {
-      :method => :patch,
-      :location => 'users/{id}',
-      :authenticated => true,
-      :name => 'update_user',
-      :return_type => :body_as_object
-    }
-  ]
-
-  config.environment = {
-    :scheme => 'http',
-    :host => '127.0.0.1',
-    :port => '9002'
-  }
-```
-
-**Usage**:
-```ruby
-it 'should update information for the specified user' do
-  environment = Bubbles::Resources.new.environment
-  response = environment.update_user @auth_token, {:id => 4}, {:user => {:email => 'kleinhammer@somewhere.com' } }
-
-  expect(response.id).to eq(4)
-  expect(response.email).to eq('kleinhammer@somewhere.com')
-end
-```
+For more examples and detailed documentation, please see [the Bubbles GitHub page](http://foamfactory.github.io/bubbles).

data/bubbles.gemspec

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

data/lib/bubbles/config.rb

@@ -10,7 +10,7 @@ module Bubbles
   ##
   # Configure the Bubbles instance.
   #
-  # Use this method if you want to configure the Bubbles instance, typically during intialization of your Gem or
+  # Use this method if you want to configure the Bubbles instance, typically during initialization of your Gem or
   # application.
   #
   # @example In app/config/initializers/bubbles.rb
@@ -39,50 +39,84 @@ module Bubbles
   #
   class Configuration
     def initialize
-      @environment_scheme = 'http'
-      @environment_host = '127.0.0.1'
-      @environment_port = '1234'
-      @environment_api_key = nil
-      @environment_api_key_name = 'X-API-Key'
-
+      @environments = Hash.new
       @endpoints = Hash.new
     end
 
     ##
-    # Retrieve the {RestEnvironment} object defined as part of this Configuration.
+    # Retrieve the {RestEnvironment} object defined as part of this Configuration having a specified name.
+    #
+    # @param [String] environment_name The name of the {RestEnvironment} to retrieve.
+    #
+    # The +environment_name+ is +nil+ by default, which will return the default configuration, if only one exists.
     #
-    # Note that this constructs a new +RestEnvironment+ and returns it, rather than returning an existing object.
+    # @return [RestEnvironment] A new +RestEnvironment+ having the configuration that was created with key
+    #         +environment_name+. Note that +RestEnvironment+s are essentially immutable once they are created, so
+    #         an existing object will _never_ be returned.
     #
-    def environment
-      RestEnvironment.new(@environment_scheme, @environment_host, @environment_port, @environment_api_key,
-                          @environment_api_key_name)
+    def environment(environment_name = nil)
+      if environment_name.nil?
+        if @environments.length > 1
+          raise 'You must specify an environment_name parameter because more than one environment is defined'
+        end
+
+        env_hash = @environments[nil]
+      else
+        env_hash = @environments[environment_name]
+      end
+
+      if env_hash.nil?
+        if environment_name.nil?
+          raise 'No default environment specified'
+        end
+
+        raise 'No environment specified having name {}', environment_name
+      end
+
+      RestEnvironment.new(env_hash[:scheme], env_hash[:host], env_hash[:port], env_hash[:api_key],
+                          env_hash[:api_key_name])
     end
 
     ##
-    # Set the current environment.
+    # Set the environments that can be used.
     #
-    # @param [Object] env The environment, as a generic Ruby Object.
+    # @param [Array] environments The environments, as an array with each entry a +Hash+.
+    #
+    # One or more environments may be specified, but if more than one environment is specified, it is required that each
+    # environment have a +:environment_name:+ parameter to differentiate it from other environments.
     #
     # @example In app/config/environments/staging.rb:
     #    Bubbles.configure do |config|
-    #      config.environment = {
+    #      config.environments = [{
     #         :scheme => 'https',
     #         :host => 'stage.api.somehost.com',
     #         :port => '443',
     #         :api_key => 'something',
     #         :api_key_name => 'X-API-Key' # Optional
-    #      }
+    #      }]
     #    end
     #
-    def environment=(env)
-      @environment_scheme = env[:scheme]
-      @environment_host = env[:host]
-      @environment_port = env[:port]
-      @environment_api_key = env[:api_key]
-      if env.has_key? :api_key_name
-        @environment_api_key_name = env[:api_key_name]
-      else
-        @environment_api_key_name = 'X-API-Key'
+    def environments=(environments)
+      default = nil
+      environments.each do |environment|
+        if environments.length > 1 && environment[:environment_name].nil?
+          message = 'More than one environment was specified and at least one of the environments does not have an ' \
+                    ':environment_name field. Verify all environments have an :environment_name.'
+
+          raise message
+        end
+
+        @environments = {}
+        env_api_key = 'X-API-Key'
+        env_api_key = environment[:api_key_name] if environment.key? :api_key_name
+
+        @environments[environment[:environment_name]] = {
+          scheme: environment[:scheme],
+          host: environment[:host],
+          port: environment[:port],
+          api_key: environment[:api_key],
+          api_key_name: env_api_key
+        }
       end
     end
 
@@ -173,8 +207,8 @@ module Bubbles
                 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)
-                  })
+                                                                                    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

data/lib/bubbles/rest_client_resources.rb

@@ -3,8 +3,8 @@ require 'bubbles/rest_environment'
 
 module Bubbles
   class RestClientResources
-    def environment
-      Bubbles.configuration.environment
+    def environment(env_name = nil)
+      Bubbles.configuration.environment(env_name)
     end
 
     ##

data/lib/bubbles/version.rb

@@ -7,7 +7,7 @@ module Bubbles
     end
 
     def self.version_name
-      '0.5.0'
+      '0.6.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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -172,12 +172,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A gem for easily defining client REST interfaces in Ruby

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bubbles-rest-client (0.5.0)
-      addressable (~> 2.5)
-      rest-client (~> 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ansi (1.5.0)
-    builder (3.2.3)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    hashdiff (1.0.0)
-    http-accept (1.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    json (2.0.2)
-    mime-types (3.3)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
-    minitest (5.11.3)
-    minitest-reporters (1.1.19)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    netrc (0.11.0)
-    os (1.0.1)
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.5)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-    vcr (3.0.3)
-    webmock (3.6.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bubbles-rest-client!
-  bundler (~> 2.0.0)
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.1)
-  os
-  rake (~> 10.0)
-  rspec (~> 3.8)
-  simplecov (~> 0.16)
-  vcr (~> 3.0)
-  webmock (~> 3.5)
-
-BUNDLED WITH
-   2.0.2