icontrol_rest 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fad69ef03119e3b1e0d4b14d2d52bbe2068ac82
-  data.tar.gz: 790fa57a3e23e0681741d22abadb895b41cdb739
+  metadata.gz: 99b9915fe47d60aefe4fe54e3a141b7286d01d59
+  data.tar.gz: 67dbe13f3596cd49ab55e38419e483c230260183
 SHA512:
-  metadata.gz: 498c382ef83d8644cb071dc9bc954f2ef5606ee39b5902ffd8f1ae4dfacff9b1395019b85c4b93836dfafa414dcfea70034f6ba41fdbd815c5be92d7ca4e671c
-  data.tar.gz: b9b73ddf7e16e5598eb773ef4e4a148605df073f192cfadebabf3f31dbdfb08341c9ea6e4714d276d1e5d1857890c9d4ed588a8ba6843155cf64777595f047ed
+  metadata.gz: 750301793adb19dbb71af14bce9129b959ad629338d5b8feb66d586bec70ae6f0dc027804863c850bc6aa9ae05faa07d70ce6242c4857b2232f623a7a0bc2c7f
+  data.tar.gz: 89c2e83e29f0392e8ae1d16ee4e409d62a09d4c499192daed864bbc8a834f440259b00bd807cc7bdf49306e446ae48993d16800304f21cc0c7753e9823031cde

data/README.md

@@ -47,6 +47,30 @@ api.get('/mgmt/tm/sys/dns')
       "description"=>"configured-by-dhcp",
       "nameServers"=>["1.2.3.72", "1.2.3.73"],
       "search"=>["domain.com"]}
+
+# post/put/patch will allow you to specify a body and header with your request
+api.post_transaction(body: {})
+# => {"transId"=>1526674837169915,
+      "state"=>"STARTED",
+      "timeoutSeconds"=>120,
+      "asyncExecution"=>false,
+      "validateOnly"=>false,
+      "executionTimeout"=>300,
+      "executionTime"=>0,
+      "failureReason"=>"",
+      "kind"=>"tm:transactionstate",
+      "selfLink"=>"https://localhost/mgmt/tm/transaction/1526674837169915?ver=12.1.2"}
+
+api.put_sys_dns(body: { nameServers: ['1.2.3.69'] }, headers: { 'X-F5-REST-Coordination-Id' => '1526674837169915' })
+# => {"method": "PUT",
+      "uri": "https://localhost/mgmt/tm/sys/dns",
+      "body": {
+          "nameServers": ["1.2.3.69"]
+      },
+      "evalOrder": 1,
+      "commandId": 1,
+      "kind": "tm:transaction:commandsstate",
+      "selfLink": "https://localhost/mgmt/tm/transaction/1526674837169915/commands/1?ver=12.1.2"
 ```
 
 

data/lib/icontrol_rest.rb

@@ -5,7 +5,7 @@ require 'logger'
 require 'retriable'
 require 'uri'
 
-require 'icontrol_rest/logger'
+require 'icontrol_rest/utils/logging'
 require 'icontrol_rest/client'
 require 'icontrol_rest/version'
 

data/lib/icontrol_rest/client.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module IcontrolRest
   # A iControl REST Client for retrieving data from F5s.
   class Client
+    include Utils::Logging
     include HTTParty
     format :json
 
@@ -44,16 +47,12 @@ module IcontrolRest
     end
     # rubocop:enable Metrics/ParameterLists
 
-    # Public: Returns a set logger. If none exists, a NullLogger is returned for stability.
-    def logger
-      @logger ||= IcontrolRest::Logging::NullLogger.new
-    end
-
-    # Public  - Delete/Get request method.
+    # Public    - Delete/Get request method.
     #
-    # route   - URI to send to server as a string.
+    # route     - URI to send to server as a string.
+    # headers   - Hash of headers to pass with request.
     #
-    # Returns - response from the server as a hash.
+    # Returns   - response from the server as a hash.
     #
     # Examples
     #
@@ -65,22 +64,21 @@ module IcontrolRest
     #         "search"=>["domain.com"]}
     #
     %w[delete get].each do |action|
-      define_method(action.to_s) do |route, _arg = nil|
-        send_request { self.class.send(action, route, @options) }
+      define_method(action.to_s) do |route, headers: {}|
+        send_request(action: action, route: route, headers: headers)
       end
     end
 
-    # Public  - Post/Put request methods.
+    # Public    - Post/Put/Patch request methods.
     #
-    # route   - URI to send to server as a string.
-    # data    - Hash of parameters to pass with request.
+    # route     - URI to send to server as a string.
+    # body      - Hash representing the request body.
+    # headers   - Hash of headers to pass with request.
     #
-    # Returns - response from the server as a hash.
+    # Returns   - response from the server as a hash.
     %w[post put patch].each do |action|
-      define_method(action.to_s) do |route, data|
-        body = {}
-        body[:body] = data.to_json
-        send_request { self.class.send(action, route, body.merge(@options)) }
+      define_method(action.to_s) do |route, body: {}, headers: {}|
+        send_request(action: action, route: route, body: body, headers: headers)
       end
     end
 
@@ -88,14 +86,18 @@ module IcontrolRest
 
     # Private - Handles response and raises error if the response isn't a 200.
     #
-    # block   - Takes block to yield.
+    # action  - The HTTP action being executed.
+    # route   - The route to send the request to.
+    # headers - A Hash representing any headers to be passed with the request.
+    # body    - A Hash representing the request body to be passed with the request.
     #
     # Returns - response from the server as a hash.
     #
     # Raises  - RuntimeError when the server returns a response that isn't a 200
-    def send_request
+    def send_request(action:, route:, headers: {}, body: nil)
       Retriable.retriable on_retry: @retry_handler, tries: @tries do
-        response = yield
+        body = body.to_json unless body.nil?
+        response = self.class.send(action, route, @options.deep_merge(body: body, headers: headers))
         sleep(@sleep) if @sleep.positive?
         return response if response.code == 200
         raise "#{response['code']}: #{response['message']}"
@@ -108,10 +110,10 @@ module IcontrolRest
     # *args       - An array of arguments passed with the method call.
     #
     # Returns     - Response from the method called.
-    def method_missing(method_name, *args)
+    def method_missing(method_name, **args)
       super unless respond_to_missing?(method_name)
       route_chain = method_name.to_s.split('_')
-      send(route_chain[0].downcase, route(route_chain), args.first)
+      send(route_chain[0].downcase, route(route_chain), args)
     end
 
     # Private     - Adds methods prefixed with delete/get/post/put/patch to object.

data/lib/icontrol_rest/utils/logging.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module IcontrolRest
+  module Utils
+    # Module to handle all logging across this gem
+    module Logging
+      def self.included(klass)
+        klass.extend ClassMethods
+        klass.include InstanceMethods
+      end
+
+      def self.logger
+        @logger ||= NullLogger.new
+        @logger.progname = 'IControlRest'
+        @logger
+      end
+
+      def self.use_logger(logger)
+        @logger = logger
+      end
+
+      # Module for instance methods to be included when IcontrolRest::Utils::Logging is included by a class.
+      module InstanceMethods
+        def logger
+          IcontrolRest::Utils::Logging.logger
+        end
+      end
+
+      # Module for class methods to be extended when IcontrolRest::Utils::Logging is included by a class.
+      module ClassMethods
+        def logger
+          IcontrolRest::Utils::Logging.logger
+        end
+      end
+
+      # A stand-in Logger that does nothing when it is written to.
+      #
+      # Examples
+      #
+      #   null_logger = NullLogger.new(STDOUT)
+      #   null_logger.info { 'This message will never get writen' }
+      class NullLogger < Logger
+        # Intentionally do nothing
+        def initialize(*_args); end
+
+        # Intentionally do nothing
+        def add(*_args, &_block); end
+      end
+    end
+  end
+end

data/lib/icontrol_rest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IcontrolRest
-  VERSION = '2.3.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icontrol_rest
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jerrod Carpenter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -54,7 +54,7 @@ files:
 - bin/setup
 - lib/icontrol_rest.rb
 - lib/icontrol_rest/client.rb
-- lib/icontrol_rest/logger.rb
+- lib/icontrol_rest/utils/logging.rb
 - lib/icontrol_rest/version.rb
 homepage: https://github.com/cerner/icontrol_rest.git
 licenses: []

data/lib/icontrol_rest/logger.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module IcontrolRest
-  # Module to handle all logging across our gem
-  module Logging
-    class << self
-      attr_writer :logger
-    end
-
-    # Default logger to be used if logging configuration is not supplied by the user.
-    class NullLogger < Logger
-      def initialize(*)
-        # Intentionally do nothing
-      end
-
-      def add(*)
-        # Intentionally do nothing
-      end
-    end
-
-    def self.logger
-      @logger ||= NullLogger.new
-    end
-
-    def self.use_logger(logger)
-      @logger = logger
-    end
-
-    def logger
-      Logging.logger
-    end
-  end
-end