aws-dev-utils 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b0b00bc92f14545ee09e8bbcbed7faf6157a65baefd27b7bfc2e0efe4c036e
-  data.tar.gz: 0f4491633cd884b69007d55f44630f866c01d5f186fdb49f88dab43254a4023b
+  metadata.gz: 6ab2dec38839d84640e933f6f35f1502e037d72b5957fdca85afeb100225d30e
+  data.tar.gz: d38c4e8f57dfa279dbadea34705a0214cdf1d66579b36e2a0e0a240b2b579c35
 SHA512:
-  metadata.gz: e127faa71bf9a1ebbc9cbc61ee21ddb85f50ad939fd9265875bfe78547a3140fe8d585ca9a615251782104c1edf863419eebbafa3d4197da309a6f9b8a3cb35c
-  data.tar.gz: b68e630e50243ce54e219ff4ce460d2f1ea15573a53ae85095bb341e33860f238add531e004caadc87376a797756f84e37386006dbe98faa36b57e916f908135
+  metadata.gz: 426d59404091399a213f9d20ccd751b7f338a723b35fa355c79590b29a08705be47825abf60f34a91a84be1481ea78dd2b5b3e9543ee956cdd67c81fd7d62aba
+  data.tar.gz: 20b2136f85898598367eb5fdc1ce6cd1d5ba6e8ebb9b78513180b6358eed36fe49e94272a9c7e6bba8200925cc14a65c3e9d4a6f874ee53a9ddb8d5accb9f8ba

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Amobee BI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,167 @@
+# AWS Dev Utilities [![Build Status](https://travis-ci.org/kontera-technologies/aws-dev-utils.svg?branch=master)](https://travis-ci.org/kontera-technologies/aws-dev-utils) [![codecov](https://codecov.io/gh/kontera-technologies/aws-dev-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/kontera-technologies/aws-dev-utils)
+
+This library provides common ruby utilities to working with AWS SDK. It simplifies the work by reducing common boilerplates such as "next_token" pagination and "retry".
+It provides a general API Wrapper with Redis based caching, paging and retry functionalities.
+
+## Installation
+AWS Dev Utilities is available from RubyGems.  
+
+### Option 1: Via Bundler
+Add the following to your application's Gemfile:
+```ruby
+gem 'aws-dev-utils', '~> 1.4'
+```
+And then execute:
+```
+$ bundle install
+```
+### Option 2: Via `gem install`
+Execute the following inside your application directory:
+```
+$ gem install aws-dev-utils -v '~> 1.4'
+```
+## Usage
+Add the following at the top of each Ruby script, or in each module/class you want to use the `with_next_token`, `with_cache` or `with_retry` functions:
+```ruby
+require 'aws-dev-utils'
+using AwsDevUtils::Refinements
+```
+
+## with_next_token
+Many AWS operations limit the number of results returned with each response. To make it easy to get the next page of results, every AWS response object is enumerable.  
+This functionality is rarely needed and causes a lot of boilerplate code.  
+Using the `client.with_next_token` the paged results will be collected for you.
+The AWS client function and its results will be concatenated until either no more results are available or the max number of requests is reached.  
+_`with_next_token` works with APIs that use `next_token`, `next_marker` or `next_continuation_token`._
+
+```ruby
+require 'aws-dev-utils'
+using AwsDevUtils::Refinements
+
+ec2_client = Aws::EC2::Client.new
+# To get the full set of results:
+ec2_client.
+  with_next_token.
+  describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+
+# To get up to 5 pages of results:
+ec2_client.
+  with_next_token(5).
+  describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+```
+
+## with_cache
+In many cases a cache is required due to many processes or different machines querying the AWS api for data.  
+By using the `client.with_cache`, the client functions results will be stored in cache.  
+The default cache is a simple in memory *time based* store - `AwsDevUtils::Backend::Memory`.  
+Incase in-memory cache is not a good solution then there is  also `Redis` based caching (`AwsDevUtils::Backend::Redis`).  
+To use it, start a Redis instance and set it as the global cache backend:
+```ruby
+AwsDevUtils::Cache.instance.backend = AwsDevUtils::Backend::Redis.new("redis-url")
+```
+
+_Note: Data will be restored from the cache only if it is the same request to AWS client, the same filters and the same expiration time ._
+
+- ```ruby
+  # Memory Caching.
+  require 'aws-dev-utils'
+  using AwsDevUtils::Refinements
+
+  ec2_client = Aws::EC2::Client.new
+  ec2_client.
+    with_cache.
+    describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+  ```
+
+- ```ruby
+  # Redis based caching with default experiation time (60 seconds).
+  require 'aws-dev-utils'
+  using AwsDevUtils::Refinements
+
+  AwsDevUtils::Cache.instance.backend = AwsDevUtils::Backend::Redis.new("redis-url")
+  ec2_client.
+   with_cache.
+   describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+  ```
+
+- ```ruby
+  # Redis based caching with custom expiration time (10 minutes).
+  require 'aws-dev-utils'
+  using AwsDevUtils::Refinements
+
+  AwsDevUtils::Cache.instance.backend = AwsDevUtils::Backend::Redis.new("redis-url")
+  ec2_client.
+    with_cache(600).
+    describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+  ```
+
+- ```ruby
+  # Example of different cache keys from requests.
+  require 'aws-dev-utils'
+  using AwsDevUtils::Refinements
+
+  AwsDevUtils::Cache.instance.backend = AwsDevUtils::Backend::Redis.new("redis-url")
+
+  # No cache data so request goes to AWS servers.
+  foo_1_instances = ec2_client.
+    with_cache(600).
+    describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+
+  # Different filters than foo_1_instances so request goes to AWS servers.
+  bar_1_instances = ec2_client.
+    with_cache(600).
+    describe_instances(filters:[{ name: "vpc-id", values: ["vpc-bar"]}])
+
+  # Same filters as bar_1_instances, so result is fetched from cache.
+  bar_2_instances = ec2_client.
+    with_cache(600).
+    describe_instances(filters:[{ name: "vpc-id", values: ["vpc-bar"]}])
+
+  ```
+
+## with_retry
+By using the `client.with_retry`, the client functions will be retried in case of an exception (until the max number of retries is reached - the default is 5).  
+Before each retry the client will sleep for an increasing number of seconds (implements exponential backoff)
+```ruby
+require 'aws-dev-utils'
+using AwsDevUtils::Refinements
+
+ec2_client = Aws::EC2::Client.new
+# Retry 5 times (default):
+ec2_client.
+  with_retry.
+  describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+
+# Custom retries:
+ec2_client.
+  with_retry(3).
+  describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+```
+
+## Combinations of wrappers
+It is possible to combine between each of the wrappers:
+```ruby
+require 'aws-dev-utils'
+using AwsDevUtils::Refinements
+
+ec2_client = Aws::EC2::Client.new
+#To retry 5 times:
+ec2_client.
+  with_retry.
+  with_next_token.
+  with_cache(600)
+  describe_instances(filters:[{ name: "vpc-id", values: ["vpc-foo"]}])
+```
+
+## Contributing
+
+### Releasing a new version
+The `./release-new-version.sh` script will bump the version number. By default it will
+increase by 0.0.1, but you can pass `minor` or `major` to increase it to the next
+minor or major version accordingly.
+
+The script will also create a git commit for the version bump, push it to this
+GitHub repository and upload it to [rubygems.org](https://rubygems.org).
+
+### Bugs and PRs
+Bug reports and pull requests are welcome on GitHub at https://github.com/kontera-technologies/aws-dev-utils

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-dev-utils
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Infastructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -45,6 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/aws-dev-utils.rb
 - lib/aws-dev-utils/backends/memory.rb
 - lib/aws-dev-utils/backends/redis.rb