bubbles-rest-client 0.2.0 → 0.6.0

data/lib/bubbles/rest_environment.rb

@@ -1,6 +1,6 @@
 module Bubbles
   class RestEnvironment
-    attr_accessor :scheme, :host, :port, :api_key
+    attr_accessor :host, :port, :api_key, :api_key_name
 
     ##
     # Construct a new instance of +RestEnvironment+.
@@ -9,17 +9,59 @@ module Bubbles
     # @param [String] host The host to communicate with.
     # @param [Integer] port The port on which the communication channel should operate.
     # @param [String] api_key (Optional) The API key to use to identify your client with the API. Defaults to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header that will specify the API key. Defaults to +"X-API-Key"+.
     #
-    def initialize(scheme='https', host='api.foamfactory.com', port=443, api_key=nil)
+    def initialize(scheme='https', host='api.foamfactory.com', port=443, api_key=nil, api_key_name='X-API-Key')
       @scheme = scheme
       @port = port
 
-      if @scheme == 'http' && @port == 443
+      if @scheme == 'http' && @port == nil
         @port = 80
+      elsif @scheme == 'https' && @port == nil
+        @port = 443
       end
 
       @host = host
       @api_key = api_key
+      @api_key_name = api_key_name
+    end
+
+    ##
+    # Retrieve the name of the API key to be used.
+    #
+    # This will be the "key" portion of the key-value of the API key header.
+    #
+    # @return [String] The API key name, if set; "X-API-Key", otherwise.
+    #
+    def api_key_name
+      @api_key_name
+    end
+
+    ##
+    # Retrieve an API key from this +RestEnvironment+, but only if a specific +Endpoint+ requires it.
+    #
+    # If an +Endpoint+ has +api_key_required+ set to +true+, this method will return the API for the current
+    # +RestEnvironment+. If not, then it will return +nil+, rather than just blindly returning the API key for every
+    # possible retrieval, even if the +Endpoint+ doesn't require it.
+    #
+    # @return [String] The API key for this +RestEnvironment+, if the specified +Endpoint+ requires it; +nil+,
+    #         otherwise.
+    #
+    def get_api_key_if_needed(endpoint)
+      if endpoint.api_key_required?
+        @api_key
+      else
+        nil
+      end
+    end
+
+    ##
+    # Retrieve the scheme of the current +RestEnvironment+, as a +Symbol+.
+    #
+    # @return [Symbol] The scheme of the current +RestEnvironment+, as a +Symbol+.
+    #
+    def scheme
+      @scheme.to_s
     end
   end
 end

data/lib/bubbles/version.rb

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

data/lib/tasks/coverage.rake

@@ -0,0 +1,22 @@
+require 'rspec/core/rake_task'
+require 'simplecov'
+require 'os'
+
+namespace :spec do
+  desc "Create rspec coverage"
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task["spec"].execute
+  end
+
+  namespace :coverage do
+    desc 'View coverage information'
+    task :view => [:coverage] do
+      if OS.mac?
+        `open coverage/index.html`
+      elsif OS.posix?
+        `sensible-browser coverage/index.html`
+      end
+    end
+  end
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,5 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bubbles-rest-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-28 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
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -158,9 +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
@@ -171,6 +188,8 @@ files:
 - lib/bubbles/rest_client_resources.rb
 - lib/bubbles/rest_environment.rb
 - lib/bubbles/version.rb
+- lib/tasks/coverage.rake
+- lib/tasks/spec.rake
 homepage: https://github.com/FoamFactory/bubbles
 licenses:
 - MPL-2.0
@@ -191,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+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,85 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bubbles-rest-client (0.2.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.20180417)
-      unf (>= 0.0.5, < 1.0.0)
-    hashdiff (0.3.4)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    json (2.0.2)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    minitest (5.11.3)
-    minitest-reporters (1.1.19)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    netrc (0.11.0)
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    rest-client (2.0.2)
-      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.4)
-    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.0.1)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bubbles-rest-client!
-  bundler (~> 2.0.0)
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.1)
-  rake (~> 10.0)
-  rspec (~> 3.8)
-  simplecov (~> 0.16)
-  vcr (~> 3.0)
-  webmock (~> 3.0)
-
-BUNDLED WITH
-   2.0.1