aws-dev-utils 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a8659230582635341c256080cf9799b0a61a1e0b310234f8d86a695460cbba
-  data.tar.gz: 540c636ebcb5c10668575ed17ce64832e9e88932582a89250f85f87db6965900
+  metadata.gz: b8b0b00bc92f14545ee09e8bbcbed7faf6157a65baefd27b7bfc2e0efe4c036e
+  data.tar.gz: 0f4491633cd884b69007d55f44630f866c01d5f186fdb49f88dab43254a4023b
 SHA512:
-  metadata.gz: 8dcd8e2f81e666beed0e3e96cdaea536024f2acd9f6b839bf9086e42b175af4d9e4d2c997484eb4c2c20d5f763d43bac871159fd046c0b071836924b767e7ad1
-  data.tar.gz: 9ec27b077aa93bba943e5d188fb8fab8ecf80dc2b9e7ff8bff226da57496c379d20b8ee4c6961f869b0f690a6017ca6327d8bbc35aca27a83f8ad41f392b1224
+  metadata.gz: e127faa71bf9a1ebbc9cbc61ee21ddb85f50ad939fd9265875bfe78547a3140fe8d585ca9a615251782104c1edf863419eebbafa3d4197da309a6f9b8a3cb35c
+  data.tar.gz: b68e630e50243ce54e219ff4ce460d2f1ea15573a53ae85095bb341e33860f238add531e004caadc87376a797756f84e37386006dbe98faa36b57e916f908135

data/lib/aws-dev-utils/backends/memory.rb

@@ -6,11 +6,16 @@ module AwsDevUtils
         @hash = {}
       end
 
+      # Get the value of key, if not found, returns nil.
       def get key
         clean_cache!
         @hash[key][1]
       end
 
+      # Set key to hold the value and set key to timeout after the a given expiration time(in seconds).
+      # @param key [Object]
+      # @param value [Object]
+      # @param exp [Integer]  - the key-value timeout
       def set key, value, exp
         clean_cache!
         @hash[key] = [Time.now + exp, value]

data/lib/aws-dev-utils/backends/redis.rb

@@ -4,13 +4,13 @@ module AwsDevUtils
   module Backend
     class Redis
       # :nocov:
-      # Initialize a new redis client
-      # @param [String] url - specify redis url connection
+      # Initialize a new redis client.
+      # @params url [String] - specify redis url connection
       def initialize url='redis://localhost:6379'
         @redis = ::Redis.new(url: url)
       end
 
-      # Get the value of key. If not found returns nil
+      # Get the value of key, if not found, returns nil.
       def get key
         @redis.get key
       end

data/lib/aws-dev-utils/cache.rb

@@ -5,7 +5,7 @@ module AwsDevUtils
   class Cache
     include Singleton
 
-    #for testing
+    # Injectable backend. 
     attr_writer :backend
 
     class << self
@@ -13,14 +13,25 @@ module AwsDevUtils
       def_delegators :fetch
     end
 
+    # Returns a value from the cache for the given key.
+    # If the key can't be found, the block will be run and its result returned and be set in the cache.
+    # @param key [Object]
+    # @param exp [Integer]
+    # @param block [block] - called with no arguments, and returns the new value for the cache (if no cached data is found).
+    # @return [Object] the value from the cache or the result of the block
     def fetch key, exp=60, &block
       get(key) or block.().tap {|x| set(key, x, exp)}
     end
 
+    # Get the value of key. If not found, returns nil
     def get key
       deserialize backend.get key.to_s rescue nil
     end
 
+    # Set key to hold the value and set key to timeout after the a given expiration time(in seconds).
+    # @param key [Object]
+    # @param value [Object]
+    # @param expiration [Time,Integer] - the key-value timeout
     def set key, value, expiration
       backend.set key.to_s, serialize(value), expiration rescue nil
     end

data/lib/aws-dev-utils/cache_wrapper.rb

@@ -4,8 +4,7 @@ module AwsDevUtils
   class CacheWrapper
     include AwsDevUtils::Utils
 
-    # Initialize a new CacheWrapper, Internal use only
-    #
+    # Initialize a new CacheWrapper, internal use only.
     # @param client [Aws client, NextTokenWrapper, RetryWrapper]
     # @param exp [Integer] - the key-value timeout
     def initialize client, exp=60

data/lib/aws-dev-utils/client_wrapper.rb

@@ -2,19 +2,28 @@ module AwsDevUtils
   class ClientWrapper
     include AwsDevUtils::Utils
 
+    # Initialize a new ClientWrapper, internal use only
+    # @params [Seahorse::Client::Base] client
+    # @param [Hash] options
+    # @option options [String] next_token max number of requests
+    # @option options [String] retry max number of retries
+    # @option options [String] cache the key-value timeout
     def initialize client, options={}
       @client = client
       @options = options
     end
 
+    # @return ClientWrapper with next_token option
     def with_next_token max=100
       self.class.new(@client, @options.merge(next_token: max))
     end
 
+    # @return ClientWrapper with retry option
     def with_retry max=5
       self.class.new(@client, @options.merge(retry: max))
     end
 
+    # @return ClientWrapper with cache option
     def with_cache exp=60
       self.class.new(@client, @options.merge(cache: exp))
     end

data/lib/aws-dev-utils/next_token_wrapper.rb

@@ -1,10 +1,10 @@
 module AwsDevUtils
   class NextTokenWrapper
 
-    # Initialize a new NextTokenWrapper
-    # @params client - Aws client / CacheWrapper / RetryWrapper
-    # @param [Integer] max - max number of requests
-    def initialize client, max=100 #:nodoc:
+    # Initialize a new NextTokenWrapper, internal use only
+    # @params client [Aws client / NextTokenWrapper / RetryWrapper]
+    # @param max [Integer] - max number of requests
+    def initialize client, max=100
       @client = client
       @max = max
     end

data/lib/aws-dev-utils/retry_wrapper.rb

@@ -1,6 +1,9 @@
 module AwsDevUtils
   class RetryWrapper
 
+    # Initialize a new RetryWrapper, internal use only
+    # @params client [Aws client, NextTokenWrapper, RetryWrapper]
+    # @param max_tries [Integer] - max number of retries
     def initialize client, max_tries=5
       @client = client
       @max_tries = max_tries

data/lib/aws-dev-utils/utils.rb

@@ -3,6 +3,8 @@ module AwsDevUtils
 
     module_function
 
+    # Transforms an object to a nested struct.
+    # @return [OpenStruct]
     def nested_struct obj
       case obj
       when Hash
@@ -22,6 +24,8 @@ module AwsDevUtils
       end
     end
 
+    # Transforms an object to a nested hash.
+    # @return [Hash]
     def nested_hash obj
       if obj.kind_of? Array
         obj.map(&method(__method__))

data/lib/aws-dev-utils/version.rb

@@ -1,3 +1,3 @@
 module AwsDevUtils
-  VERSION = '1.4.4'
+  VERSION = '1.4.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-dev-utils
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Infastructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core