purest 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c41b5fe331d93426a8a7e3f56f5d765452827522d1122fef6a4d79963b9291
-  data.tar.gz: 10111924a912e812272e6ce29f96279a3bca91b27e02c9e5f34b8df69a60946a
+  metadata.gz: 01b9bc40dfa4b5fa4f92dc47d2aa2baf3cbeffd38b9434a991e662baad326ead
+  data.tar.gz: 73f43e4915de161ed262dcea5726f23591bda7981c55352ffe3775a4d7627166
 SHA512:
-  metadata.gz: 01a855b24f60d9e7ab59aecb66d4d1e9dabb4c40ec5110e9ec3b9e8a5545081c9fef8849e157e29ba8ab5e3ac72efb9c184aa3c9811fc131d7a61e8c63d6e0e7
-  data.tar.gz: 86568cbbc8e91481508a74c5fced2b5e31460e1bd7de0794ddc299e5b3def37702ca7053ebe73a8a421ad1fcc8d0ab991e664d1b2e08ea42829f267fd0c74a0c
+  metadata.gz: 7c507950e26c18e36e6c987015cdf5e274c7dcb7d160d7dccb6d4459696dad65897bf122bac75a9d03362a2c5dc149271e86ce81aa16752b1cfca8c43215f015
+  data.tar.gz: fadd1f0cb52a565eabe0be8e68149d65b1b6643c19453deb321a0c16da68877ae6513e4ccc1a72a2fb311eda887be7f17a5f4b24e658973ad7bcc5ef661e4d42

data/README.md

@@ -3,13 +3,13 @@
 A simple to use library for Ruby, inspired by the WeAreFarmGeek's Diplomat gem (seriously, those guys are awesome), allowing for easy interaction with Pure Storage's FlashArray REST API.
 
 ## Disclaimer
-This started as sort of a labor of love/learning exercise, and sort of blossomed into this. That being said, it means a few things:
+This started as a labor of love/learning exercise, and sort of blossomed into this. That being said, it means a few things:
 
 1) I may have made some stupid mistakes in here, if so..so be it. Raise them in issues or submit PRs, and I'll gladly fix/merge if I feel the code submitted carries the spirit of my little project. Odds are I won't reject a PR unless you try to rewrite everything for some obtuse reason I don't agree with.
 
-2) I am not affiliated with Pure Storage, beyond the fact that my company uses their product.
+2) I am not an employee of Pure Storage, just a random nerd.
 
-3) While all of the classes exist, currently only up to API version 1.12 is 'officially' supported- meaning it may work on newer versions, but I can't verify since I've only been able to develop against versions 1.12 and lower.
+3) While all of the classes exist, currently only up to API version 1.16 is 'officially' supported- meaning it may work on newer versions, but I can't verify since I've only been able to develop against versions 1.16 and lower.
 
 Table of contents
 =================
@@ -17,6 +17,7 @@ Table of contents
 <!--ts-->
    * [Requirements](#requirements)
    * [Installation](#installation)
+   * [Authentication](#authentication)
    * [Configuration](#configuration)
    * [Usage](#usage)
       * [Alerts](#alerts)
@@ -31,6 +32,7 @@ Table of contents
       * [Messages](#messages)
       * [Network](#network)
       * [Physical Arrays](#physical-arrays)
+      * [Pods](#pod)
       * [Ports](#port)
       * [Protection Groups](#protection-groups)
       * [SNMP](#snmp)
@@ -38,11 +40,12 @@ Table of contents
       * [Users](#users)
       * [Volumes](#volumes)
    * [Specs](#specs)
+   * [License](#license)
 <!--te-->
 
 ## Requirements
 
-To be captain obvious, this does require you have access to a Pure Storage array.
+To be captain obvious, this does require you have access to a Pure Storage FlashArray.
 
 This library requires you use Ruby 2.3 or above.
 
@@ -52,7 +55,7 @@ gem install purest
 ```
 
 ## Authentication
-Purest allows you to authenticate using two different methods, either username and password OR using your API key (you don't need both). See "Configration" below for examples.
+Purest allows you to authenticate using two different methods, either username and password OR using your API key (you don't need both). See "Configuration" below for examples. We recommend using the API key method as it is - slightly - more secure.
 
 ## Configuration
 There are now two ways to configure Purest, the first is directly in your ruby code like so:
@@ -61,11 +64,23 @@ require 'purest'
 
 Purest.configure do |config|
   config.api_key = '1234-567-89'
-  config.api_version = '1.14'
+  config.api_version = '1.16'
   config.options = {ssl: { verify: true }}
-  config.password = 'password'
   config.url = "https://purehost.yourdomain.com"
+end
+```
+
+or with the user credentials method:
+
+```rb
+require 'purest'
+
+Purest.configure do |config|
   config.username = 'api-enabled-user'
+  config.password = 'password'
+  config.api_version = '1.16'
+  config.options = {ssl: { verify: true }}
+  config.url = "https://purehost.yourdomain.com"
 end
 ```
 
@@ -73,10 +88,20 @@ The second method is to create a .purest.yaml file in your home directory (~/.pu
 ```yaml
 ---
 api_key: '1234-567-89'
-api_version: '1.14'
-password: 'password'
+api_version: '1.16'
 url: 'https://purehost.yourdomain.com'
+options:
+  ssl:
+    verify: true
+```
+or with the user credentials method:
+
+```yaml
+---
 username: 'api-enabled-user'
+password: 'password'
+api_version: '1.16'
+url: 'https://purehost.yourdomain.com'
 options:
   ssl:
     verify: true
@@ -89,11 +114,11 @@ First: Authentication and session management are handled behind the scenes, you
 
 Second: The various class methods of this gem turn the provided options into HTTP parameters, and are
 named accordingly. For instance, ```Purest::Volume.get({:snap: true})``` translates
-to http://purehost.yourdomain.com/api/1.14/volume?snap=true. For a full list
+to http://purehost.yourdomain.com/api/1.16/volume?snap=true. For a full list
 of options for a given class, Pure provides good documentation at:
 https://purehost.yourdomain.com/static/0/help/rest/.
 
-Below I'll provide a large group of examples, but I won't be detailing every single method call with all of its possible options, for that I will again refer you to Pure's REST API docs.
+Below I'll provide a large group of examples but I won't be detailing every single method call with all of its possible options, for that I will again refer you to Pure's REST API docs.
 
 # Usage
 
@@ -394,6 +419,51 @@ Disconnect the current array from a specified array:
 Purest::PhysicalArray.delete(name: 'purehost2.yourdomain.com')
 ```
 
+## Pod
+Getting attributes or displaying performance metrics for pods
+```ruby
+# Get a list of pods and their details
+Purest::Pod.get
+
+# Show space information for each pod
+Purest::Pod.get(space: true)
+
+# Get a list of attributes for a specific pod
+Purest::Pod.get(name: 'superpod')
+```
+
+Creating a new pod
+```ruby
+# Basic pod creation
+Purest::Pod.create(name: 'superpod2')
+
+# Create a pod with a failover preference
+Purest::Pod.create(name: 'superpod2', failover_preference: ['array1'])
+```
+
+Stretching a pod to a peer array
+```ruby
+Purest::Pod.create(name: 'superpod2', array: 'array1')
+```
+
+Updating a pod
+```ruby
+Purest::Pod.update(name: 'superpod2', failover_preference: ['array2'])
+```
+
+Unstretching a pod from a peer array
+```ruby
+Purest::Pod.delete(name: 'superpod2', array: 'array1')
+```
+
+Deleting a pod
+```ruby
+Purest::Pod.delete(name: 'superpod2')
+
+# Eradicating a pod
+Purest::Pod.delete(name: 'superpod2', eradicate: true)
+```
+
 ## Port
 Getting information about ports, 'cause that's all you get to do
 ```ruby
@@ -628,7 +698,7 @@ url: 'https://yoursuperawesomepurehost.com'
 
 There are a few ways you can execute the integration tests:
 ```
-# This will execute against the latest API version the gem is aware of, right now that is 1.11
+# This will execute against the latest API version the gem is aware of, right now that is 1.16
 rspec -t integration
 
 # This will execute against a specific version
@@ -642,4 +712,7 @@ ALL_VERSIONS=true rspec -t integration
 ```
 
 
-It is worth mentioning, this generates a fair bit of work for your Pure array so...you've been warned. All of that being said, the integration testing is somewhat sparse at the moment
+It is worth mentioning that this generates a fair bit of work for your Pure array so...you've been warned. All of that being said, the integration testing is somewhat sparse at the moment.
+
+## License
+Purest is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/purest.rb

@@ -32,8 +32,8 @@ module Purest
 
   require_libs  'rest', 'api_methods', 'configuration', 'alerts', 'app', 'cert',
                 'directory_service', 'dns', 'drive', 'hardware', 'host',
-                'host_group', 'messages', 'network', 'physical_array', 'port',
-                'protection_group', 'snmp', 'subnet', 'users', 'volume'
+                'host_group', 'messages', 'network', 'physical_array', 'pod',
+                'port', 'protection_group', 'snmp', 'subnet', 'users', 'volume'
 
   self.configuration ||= Purest::Configuration.new
 

data/lib/purest/physical_array.rb

@@ -70,9 +70,9 @@ module Purest
 
     private
 
-    GET_PARAMS.each do |attribute|
-      define_method :"use_#{attribute}" do |options|
-        options ? use_named_parameter(attribute, options[attribute]) : []
+    GET_PARAMS.each do |param|
+      define_method :"use_#{param}" do |options|
+        options ? use_named_parameter(param, options[param]) : []
       end
     end
   end

data/lib/purest/pod.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Purest
+  class Pod < Purest::APIMethods
+    @access_methods = %i[get create update delete]
+
+    GET_PARAMS = %i[action failover_preferance footprint historical
+                    latency mediator names on pending pending_only
+                    space].freeze
+
+    def get(options = nil)
+      super(options, 'pod', GET_PARAMS)
+    end
+
+    def create(options = nil)
+      if options[:array]
+        super(options, 'pod', "array/#{options[:array]}")
+      else
+        super(options, 'pod')
+      end
+    end
+
+    def update(options = nil)
+      super(options, 'pod')
+    end
+
+    def delete(options = nil)
+      if options[:array]
+        super(options, 'pod', "array/#{options[:array]}")
+      else
+        super(options, 'pod')
+      end
+    end
+  end
+end

data/lib/purest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Purest
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purest
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Sean McKinley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2019-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -186,6 +186,7 @@ files:
 - lib/purest/messages.rb
 - lib/purest/network.rb
 - lib/purest/physical_array.rb
+- lib/purest/pod.rb
 - lib/purest/port.rb
 - lib/purest/protection_group.rb
 - lib/purest/rest.rb
@@ -213,8 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A ruby gem for interacting with PURE storage's REST API