bubbles-rest-client 0.4.1 → 0.5.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.4.1'
+      '0.5.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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Scott Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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
@@ -159,6 +173,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -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