aws-liam 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb56b9b9adaa264e64fd5a8e60171e279c52761f5a00cea30977a96396a47b74
-  data.tar.gz: 86166f8802d24fd4aa93cda51d7606619658470fe3e66580b382acf89beb80f4
+  metadata.gz: 58f7f42c10ec20d554b11e94099448bc7396e9fbeeeabc0908d4b27f3698dd0b
+  data.tar.gz: 615bd7386620f20e4368f2c1d2a98adaf1f3df64cf86debfa9802ef72df29371
 SHA512:
-  metadata.gz: 93f2c7b2277433830e3f37b3630f97040d5b7916efa5954386b3b664dc3b6f6a75124aefc043caa686aa07c733669fae6b912a81fdd9c111441b33f35caf6289
-  data.tar.gz: 4823392801ca44d27bc379286a3e41d7a5b6777b740fb61ef91da7c7bbc07a87513ba1991ef899050f7abdbd0b31c8304eb74fd557983ac9ef2576cc662a962d
+  metadata.gz: f8f61e0cd90d856adff8a55725d6837d768cab00ea7d6df49589b5264ef4a7a3546098fa1f72d1bea72689d4053367f6bab646364ef30d844aa7e70c883b6bb6
+  data.tar.gz: e969558c3ad2edcfd4d606787aafa1145071fb6a29e6db34627ef7862f73978b69052cca2a79ff7ee82b1f5e5c57fda9c0bc8fe063a6ce15af1da5a47a7f8dd4

data/.github/workflows/main.yaml

@@ -1,6 +1,13 @@
 name: Main
 
-on: [pull_request]
+on:
+  workflow_dispatch:
+    inputs:
+      body:
+        default: ""
+      test:
+        default: false
+  pull_request_target:
 
 jobs:
   vm-job:
@@ -10,36 +17,33 @@ jobs:
       max-parallel: 4
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
 
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v1
+    - name: Set up Ruby 2.7.2
+      uses: ruby/setup-ruby@v1
       with:
-        python_version: 3.7
+        ruby-version: 2.7.2
 
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up aws-cli
+      uses: unfor19/install-aws-cli-action@v1
+      id: install-aws-cli
       with:
-        ruby_version: 2.6.3
-
-    - name: Set up pip
-      run: python -m pip install --upgrade pip
+        version: 2
+        run: aws --version
+        shell: bash
 
     - name: Set up LocalStack
       run: |
-        docker-compose -f docker-compose.localstack.yml up -d
-        curl "https://d1vvhvl2y92vvt.cloudfront.net/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
-        unzip -q awscliv2.zip
-        sudo ./aws/install
         cp -avr .aws/ ~/
-        while ! curl -s http://localhost:4575 > /dev/null; do echo waiting for localstack; sleep 3; done;
-        aws --endpoint-url=http://localhost:4575 sns create-topic --name liam_TestProducer
+        docker-compose -f docker-compose.localstack.yml up -d
+        while ! curl -s http://localhost:4566 > /dev/null; do echo waiting for localstack; sleep 3; done;
+        aws --endpoint-url=http://localhost:4566 sns create-topic --name liam_TestProducer
 
     - name: Build
       env:
         RAILS_ENV: test
       run: |
-        gem install bundler -v 2.1.4
+        gem install bundler -v 2.1.4 -N
         bundle _2.1.4_ install --jobs 4 --retry 3
 
     - name: Run tests

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+.idea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws-liam (0.0.7)
+    aws-liam (0.0.9)
       aws-sdk-sns (~> 1.21)
       aws-sdk-sqs (~> 1.23, >= 1.23.1)
 
@@ -10,21 +10,21 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    aws-eventstream (1.0.3)
-    aws-partitions (1.295.0)
-    aws-sdk-core (3.93.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.445.0)
+    aws-sdk-core (3.114.0)
+      aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-sns (1.22.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sns (1.39.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.24.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sqs (1.38.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)

data/README.md

@@ -4,8 +4,6 @@ Liam is how we decided to call the implementation we did for our events based co
 
 We called it Liam in honor to Liam Neeson for so many reasons, being the most important this iconic scene when Bryan (Liam) called Marko and said:
 
-![Liam](https://pmctvline2.files.wordpress.com/2015/09/taken-prequel.jpg)
-
 > *I DONT KNOW WHO YOU ARE, I DON’T KNOW WHAT YOU WANT, BUT I WILL FIND YOU AND I WILL KILL YOU*...
 
 We wrote an [article at Medium](https://medium.com/archdaily-on-technology/microservices-events-aws-our-path-to-improve-communication-between-our-ruby-on-rails-apps-501b65e35fa3) where we explained the whole problem we had when we tried to use plain POST http requests between applications.
@@ -44,7 +42,21 @@ Then execute this little rake tast that will generate some configuration files n
  1. config/liam.yaml
  2. lib/task/liam.rake
 
-Go to the first one an setup your credentials and topics endpoints at AWS. The second rake task should need to be called in Service B (and whenever you want to keep listening from new messages)
+Go to the first one an setup your credentials and topic endpoints at AWS. You'll need to add here all the `events` you want to use later. 
+
+The second file corresponds to a rake task that will be needed only in the Services that want to be listening for new messages. If your Service will only publish messages (aka will be just a producer, not a consumer) then you can forget (or even delete) this rake task.
+
+### Configuration
+Liam will fail early if the key for your environment is missing on `config/liam.yaml`.
+If you'd like to skip sending messages while you finish your setup, you can add the `skip: true` option. 
+
+For example:
+
+```
+staging:
+  <<: *default
+  skip: true
+```
 
 ## Usage
 
@@ -58,6 +70,16 @@ topic_name = 'liam_ArticleCreated'
 Liam::Producer.message(topic: topic_name, message: message)
 ```
 
+Now we have to define what `liam_ArticleCreated` means in terms of SNS. For this, we need to go to the `config/liam.yaml` file that was automatically generated by this gem and add this new event:
+
+```yaml
+...
+events:
+  liam_ArticleCreated: "arn:aws:sns:us-east-1:xxxxxxxx:liam_ArticleCreated"
+```
+
+Of course, you need to create the topic called `liam_ArticleCreated` (and make sure that you have access to publish messages there from your Service A).
+
 ### The Consumer (Service B)
 In the oher hand you will have to create a method in Service B that will consume the message received from Service A. At this point Class names is very important.
 
@@ -90,10 +112,16 @@ And that's it!
 
 ## Testing
 
+You can use the docker-compose.localstack.yml file to leave localstack running if you don't have it installed:
+
+```bash
+$ docker-compose -f docker-compose.localstack.yml up -d
+```
+
 Before running the test suite you must create the topic we use to test the gem functionality:
 
 ```bash
-$ aws --endpoint-url=http://localhost:4575 sns create-topic --name liam_TestProducer
+$ aws --endpoint-url=http://localhost:4566 sns create-topic --name liam_TestProducer
 ```
 
 This is mandatory, otherwise you're going to receive an `Aws::SNS::Errors::NotFound: Topic does not exist` exception.

data/docker-compose.localstack.yml

@@ -4,7 +4,7 @@ services:
   localstack:
     image: localstack/localstack
     ports:
-      - "4567-4597:4567-4597"
+      - "4566:4566"
     environment:
       - SERVICES=sqs,sns
       - DOCKER_HOST=unix:///var/run/docker.sock

data/lib/generators/liam/templates/liam.yml

@@ -1,4 +1,5 @@
 default: &default
+  skip: false
   aws:
     region:
     access_key_id:
@@ -13,3 +14,6 @@ default: &default
 development: *default
 test: *default
 production: *default
+staging:
+  <<: *default
+  skip: true

data/lib/liam.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-
-require 'liam/version'
-require 'liam/consumer'
-require 'liam/processor'
-require 'liam/producer'
-require 'liam/exceptions/uninitialized_message_processor_error'
-require 'liam/exceptions/no_topics_in_config_file_error'
-require 'liam/exceptions/unexpected_message_error'
+Dir["lib/liam/exceptions/*.rb"].each {|file| load file }
 
 module Liam
+  autoload :Consumer, 'liam/consumer'
+  autoload :Processor, 'liam/processor'
+  autoload :Producer, 'liam/producer'
+  autoload :VERSION, 'liam/version'
+
   class << self
     attr_writer :logger
 

data/lib/liam/common.rb

@@ -16,9 +16,7 @@ module Liam
     end
 
     def env_credentials
-      return @env_credentials if defined?(@env_credentials)
-
-      @env_credentials = credentials[ENV['RAILS_ENV']]
+      @env_credentials ||= credentials[ENV['RAILS_ENV']]
     end
 
     def credentials

data/lib/liam/exceptions/no_config_for_env_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Liam
+  class NoConfigForEnvError < StandardError
+    def initialize
+      super('No configuration was found for the environment in the Liam configuration file.')
+    end
+  end
+end

data/lib/liam/producer.rb

@@ -2,26 +2,29 @@
 
 require 'aws-sdk-sns'
 require 'forwardable'
+require 'liam/common'
 
 module Liam
   class Producer
     DEFAULT_SUBJECT = 'liam message'
     UNSUPPORTED_MESSAGE_ERROR = 'Unsupported message argument'
     UNSUPPORTED_TOPIC_ERROR = 'Unsupported topic argument'
+    SKIPPED_MESSAGE = 'The message was skipped by the configuration of the environment'
+
     private_constant :DEFAULT_SUBJECT
 
     include Common
 
     extend Forwardable
 
-    def initialize(message:, options: {}, topic:)
+    def initialize(message:, topic:, options: {})
       @message = message
-      @options = options
       @topic = topic
+      @options = options
     end
 
-    def self.message(*args)
-      new(*args).send(:execute)
+    def self.message(**args)
+      new(**args).send(:execute)
     end
 
     private
@@ -31,6 +34,8 @@ module Liam
     attr_reader :topic, :message, :options
 
     def execute
+      raise NoConfigForEnvError unless valid_config?
+      return SKIPPED_MESSAGE if skipped?
       return UNSUPPORTED_TOPIC_ERROR unless supported_topic?
       return UNSUPPORTED_MESSAGE_ERROR unless message.is_a?(Hash)
 
@@ -57,10 +62,16 @@ module Liam
       topics[topic]
     end
 
-    def topics
-      return @topics if defined?(@topics)
+    def valid_config?
+      env_credentials && !env_credentials.empty?
+    end
+
+    def skipped?
+      !!env_credentials['skip']
+    end
 
-      @topics = env_credentials['events']
+    def topics
+      @topics ||= env_credentials['events']
     end
   end
 end

data/lib/liam/version.rb

@@ -1,3 +1,3 @@
 module Liam
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: aws-liam
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - alexismansilla
 - sebastian-palma
 - luctus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
@@ -127,14 +127,13 @@ files:
 - bin/setup
 - docker-compose.localstack.yml
 - liam.gemspec
-- lib/.DS_Store
 - lib/generators/liam/install_generator.rb
 - lib/generators/liam/templates/liam.rake
 - lib/generators/liam/templates/liam.yml
 - lib/liam.rb
-- lib/liam/.DS_Store
 - lib/liam/common.rb
 - lib/liam/consumer.rb
+- lib/liam/exceptions/no_config_for_env_error.rb
 - lib/liam/exceptions/no_topics_in_config_file_error.rb
 - lib/liam/exceptions/unexpected_message_error.rb
 - lib/liam/exceptions/uninitialized_message_processor_error.rb
@@ -146,7 +145,7 @@ homepage: http://github.com/archdaily/aws-liam
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: AWS SQS+SNS middleware integration between Ruby microservices
 test_files: []