purest 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39e177ed2d3cf0ba903e3fb03b415ec27e010df415a1a967257f1af13b9f007e
-  data.tar.gz: 4e8a9a979354ed87f239c7185fffed070d9c548a568f4e2436f95ec63b1faf75
+  metadata.gz: a5c41b5fe331d93426a8a7e3f56f5d765452827522d1122fef6a4d79963b9291
+  data.tar.gz: 10111924a912e812272e6ce29f96279a3bca91b27e02c9e5f34b8df69a60946a
 SHA512:
-  metadata.gz: 7143346aa454306f0e471e0eb0cb6b55dc1f4742d2d15b8873f68b029aaf740e8097dae0e8c9b4e4e08a430357e2785870867cfbe6989c770e841bb44840b497
-  data.tar.gz: 87de96a184585d1d533baa7ed77792081f2ff886e1a7125ab21d8c4bc58dd2b0e1b721f3d630161bc35ec2c4b195265a776259e1d959882a0e7511595d1eedfb
+  metadata.gz: 01a855b24f60d9e7ab59aecb66d4d1e9dabb4c40ec5110e9ec3b9e8a5545081c9fef8849e157e29ba8ab5e3ac72efb9c184aa3c9811fc131d7a61e8c63d6e0e7
+  data.tar.gz: 86568cbbc8e91481508a74c5fced2b5e31460e1bd7de0794ddc299e5b3def37702ca7053ebe73a8a421ad1fcc8d0ab991e664d1b2e08ea42829f267fd0c74a0c

data/README.md

@@ -1,6 +1,6 @@
-# Purest (or Pure Rest, if you will) -- a simple gem for interacting with Pure Storage's REST API
+# Purest (or Pure Rest, if you will) -- a simple gem for interacting with Pure Storage's FlashArray REST API
 
-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 REST API.
+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:
@@ -51,25 +51,45 @@ This library requires you use Ruby 2.3 or above.
 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.
+
 ## Configuration
+There are now two ways to configure Purest, the first is directly in your ruby code like so:
 ```rb
 require 'purest'
 
 Purest.configure do |config|
-  config.url = "https://purehost.yourdomain.com"
+  config.api_key = '1234-567-89'
+  config.api_version = '1.14'
   config.options = {ssl: { verify: true }}
-  config.api_version = '1.11'
-  config.username = 'api-enabled-user'
   config.password = 'password'
+  config.url = "https://purehost.yourdomain.com"
+  config.username = 'api-enabled-user'
 end
 ```
 
+The second method is to create a .purest.yaml file in your home directory (~/.purest.yaml) that looks like this:
+```yaml
+---
+api_key: '1234-567-89'
+api_version: '1.14'
+password: 'password'
+url: 'https://purehost.yourdomain.com'
+username: 'api-enabled-user'
+options:
+  ssl:
+    verify: true
+```
+
+This yaml file is loaded in when your code is executed and the values can be individually or wholesale overridden during runtime by using the first configuration method, if you so desire.
+
 ## API options
-First: Authentication and session management are handled behind the scenes, you just need to supply your username/password in the configuration block (as shown in the example above). That's it.
+First: Authentication and session management are handled behind the scenes, you just need to supply your username/password or API key in the configuration block or YAML file (as shown in the example above). That's it.
 
 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.11/volume?snap=true. For a full list
+to http://purehost.yourdomain.com/api/1.14/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/.
 

data/lib/purest/configuration.rb

@@ -3,7 +3,7 @@
 module Purest
   # Methods for configuring Purest
   class Configuration
-    attr_accessor :api_version, :url, :username, :password, :options
+    attr_accessor :api_key, :api_version, :url, :username, :password, :options
 
     # Override defaults for configuration
     # @param api_version [String] the API version to interact with
@@ -11,12 +11,31 @@ module Purest
     # @param username [String] username to authenticate with
     # @param password [String] password to authenticate with
     # @param options [Hash] extra options to configure Faraday::Connection
-    def initialize(api_version = '1.11', url = nil, username = nil, password = nil, options = {})
-      @api_version = api_version
-      @url = url
-      @username = username
-      @password = password
-      @options = options
+    def initialize(api_key = nil, api_version = nil, url = nil, username = nil, password = nil, options = {})
+      load_yaml
+      if load_yaml
+        @api_key     = load_yaml['api_key']
+        @api_version = load_yaml['api_version']
+        @options     = load_yaml['options']
+        @password    = load_yaml['password']
+        @url         = load_yaml['url']
+        @username    = load_yaml['username']
+      else
+        @api_key     = api_key
+        @api_version = api_version
+        @options     = options
+        @password    = password
+        @url         = url
+        @username    = username
+      end
+    end
+
+    def load_yaml
+      begin
+        Psych.load_file(ENV['HOME'] + '/.purest.yaml')
+      rescue Errno::ENOENT
+        false
+      end
     end
   end
 end

data/lib/purest/rest.rb

@@ -86,10 +86,11 @@ module Purest
     end
 
     def create_session
+      token = Purest.configuration.api_key || get_token
       raw_resp = @conn.post do |req|
         req.url "/api/#{Purest.configuration.api_version}/auth/session"
         req.params = {
-          "api_token": get_token
+          "api_token": token
         }
       end
 

data/lib/purest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purest
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Sean McKinley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber