icontrol_rest 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04f7ecf74aee27e247b202b91bfa851831a4887f
+  data.tar.gz: 39f67265927ec920c8e48d56466a4bfc3432d264
+SHA512:
+  metadata.gz: 644b8cbc0279c05ca28b54cd61bc964697391dc1027bad2f7e69ba45f87791310c6c085373c9c99bf4b83ba754fa3200ae973b650376bd238b8fd96ce1b1015b
+  data.tar.gz: '019a150a73271c5515f2efa574fc6aa8e548c03818586bdd88acfacea1dc1e16728ec29fc51a3be2e980124b6e2fd45cc399023a5b9aa653a5be5f6ed79daa99'

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in icontrol.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.11'
+  gem 'pry'
+end
+
+# build-time dependencies
+gem 'rake', '~> 10.0'
+gem 'rspec', '~> 3.4'
+gem 'rubocop', '~> 0.47'
+gem 'simplecov', '~> 0.13'

data/README.md

@@ -0,0 +1,60 @@
+# Icontrol
+
+Gem used to wrap iControl API REST calls to an F5. The intent of this client is to match the iControl API methods and pass the response without modification. It does not contain business logic to scrub a response or prevent certain methods. This logic is to be in your orchestration layer, not in the client.
+
+This has been tested against 11.5.4, but should be compatible with future versions. If this gem isn't compatible with a newer version of BIG-IP, or doesn't have the functionality required to access a certain method, feel free to follow the [guidelines for contributing](.github/CONTRIBUTING.md) and provide an enhancement. When doing so, please follow semantic versioning when considering changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'icontrol_rest'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself:
+
+```
+$ gem install icontrol_rest
+```
+
+
+## Usage
+
+```ruby
+require 'icontrol_rest'
+
+api = IcontrolRest::Client.new(host: '1.2.3.4', user: 'user', pass: 'pass', verify_cert: false)
+# => <IcontrolRest::Client:0x007fb953ab7750 @options={ ... }>
+
+api.get_sys_dns
+# => {"kind"=>"tm:sys:dns:dnsstate",
+      "selfLink"=>"https://localhost/mgmt/tm/sys/dns?ver=11.5.4",
+      "description"=>"configured-by-dhcp",
+      "nameServers"=>["1.2.3.72", "1.2.3.73"],
+      "search"=>["domain.com"]}
+
+# Or you can manually do it:
+api.get('/mgmt/tm/sys/dns')
+# => {"kind"=>"tm:sys:dns:dnsstate",
+      "selfLink"=>"https://localhost/mgmt/tm/sys/dns?ver=11.5.4",
+      "description"=>"configured-by-dhcp",
+      "nameServers"=>["1.2.3.72", "1.2.3.73"],
+      "search"=>["domain.com"]}
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+Please review the [guidelines for contributing](.github/CONTRIBUTING.md) to this repository.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'roll_out/rake_tasks'
+require 'roll_out/jira'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'icontrol_rest'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/icontrol_rest/client.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module IcontrolRest
+  # A iControl REST Client for retrieving data from F5s.
+  class Client
+    include HTTParty
+    format :json
+
+    # A client used to interact with a devices iControl API. Turns method calls into REST commands.
+    #
+    # host        - The ip or hostname of the host we're trying to reach as a string
+    # user        - The username of the account we're connecting with as a string.
+    # pass        - the pass of the account we're connecting with.
+    # verify_cert - Boolean of whether we want to check certificates.
+    # timeout     - Integer of seconds we want the timeout to be set to.
+    # sleep       - Number of seconds to sleep after an icontrol call.
+    #
+    # Examples
+    #
+    #   api = IcontrolRest::Client.new(host: '1.2.3.4', user: 'user', pass: 'pass', verify_cert: false)
+    #   # => #<IcontrolRest::Client:0x007fb953ab7750 @options={ ... }>
+    #
+    #   api.get_sys_dns
+    #   # => {"kind"=>"tm:sys:dns:dnsstate",
+    #         "selfLink"=>"https://localhost/mgmt/tm/sys/dns?ver=11.5.4",
+    #         "description"=>"configured-by-dhcp",
+    #         "nameServers"=>["1.2.3.72", "1.2.3.73"],
+    #         "search"=>["domain.com"]}
+    #
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(host:, pass:, user:, timeout: 100, verify_cert: true, sleep: 0, tries: 1)
+      self.class.base_uri "https://#{host}"
+      @sleep = sleep.to_i
+      @tries = tries.to_i
+      @options = { basic_auth: { username: user, password: pass }, headers: { 'Content-Type' => 'application/json' },
+                   verify: verify_cert, timeout: timeout }
+      @retry_handler = proc do |exception, try, _elapsed_time, _next_interval|
+        logger.error { "#{exception.class}: #{exception.message} - try #{try}" }
+        if exception.class == JSON::ParserError
+          logger.info { "F5 configuration utility not ready to proceed, sleeping '30' seconds." }
+          sleep 30
+        end
+      end
+    end
+    # rubocop:enable Metrics/ParameterList
+
+    # 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.
+    #
+    # route   - URI to send to server as a string.
+    #
+    # Returns - response from the server as a hash.
+    #
+    # Examples
+    #
+    #   api.get('/mgmt/tm/sys/dns')
+    #   # => {"kind"=>"tm:sys:dns:dnsstate",
+    #         "selfLink"=>"https://localhost/mgmt/tm/sys/dns?ver=11.5.4",
+    #         "description"=>"configured-by-dhcp",
+    #         "nameServers"=>["1.2.3.72", "1.2.3.73"],
+    #         "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) }
+      end
+    end
+
+    # Public  - Post/Put request methods.
+    #
+    # route   - URI to send to server as a string.
+    # data    - Hash of parameters to pass with request.
+    #
+    # Returns - response from the server as a hash.
+    %w[post put].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)) }
+      end
+    end
+
+    private
+
+    # Private - Handles response and raises error if the response isn't a 200.
+    #
+    # block   - Takes block to yield.
+    #
+    # Returns - response from the server as a hash.
+    #
+    # Raises  - RuntimeError when the server returns a response that isn't a 200
+    def send_request
+      Retriable.retriable on_retry: @retry_handler, tries: @tries do
+        response = yield
+        sleep(@sleep) if @sleep.positive?
+        return response if response.code == 200
+        raise "#{response['code']}: #{response['message']}"
+      end
+    end
+
+    # Private     - Converts a missing method into a REST request.
+    #
+    # method_name - Symbol of unknown method called.
+    # *args       - An array of arguments passed with the method call.
+    #
+    # Returns     - Response from the method called.
+    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)
+    end
+
+    # Private     - Adds methods prefixed with delete/get/post/put to object.
+    #
+    # method_name - Symbol of unknown method called.
+    #
+    # Returns     - true if the object responds to it, or if delete/get..etc.
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('delete', 'get', 'post', 'put') || super
+    end
+
+    # Private     - Converts the route chain into a uri.
+    #
+    # route_chain - An array of route chain.
+    #
+    # Returns     - A URI as a string.
+    def route(route_chain)
+      raise 'Empty route chain.' if route_chain.length <= 1
+      "/mgmt/tm/#{route_chain[1..route_chain.length].join('/')}"
+    end
+  end
+end

data/lib/icontrol_rest/logger.rb

@@ -0,0 +1,33 @@
+# 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

data/lib/icontrol_rest/version.rb

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

data/lib/icontrol_rest.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'logger'
+require 'retriable'
+require 'uri'
+
+require 'icontrol_rest/logger'
+require 'icontrol_rest/client'
+require 'icontrol_rest/version'
+
+# Module to hold iControl logic.
+module IcontrolRest
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: icontrol_rest
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Jerrod Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Allows user to interact with iControl REST interface.
+email:
+- jscarpenter25@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/icontrol_rest.rb
+- lib/icontrol_rest/client.rb
+- lib/icontrol_rest/logger.rb
+- lib/icontrol_rest/version.rb
+homepage: https://github.com/cerner/icontrol_rest.git
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Allows user to interact with iControl REST interface.
+test_files: []