simnos 0.1.0.beta4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e73c37a3d3496d3566b8f5d6ef17f52cacef62a
-  data.tar.gz: 4a9ae23753a4879f3f0ff2d24560d378a959d31e
+  metadata.gz: 38020c8fa6b7c99e9aa74293b2835ba3c2c1b004
+  data.tar.gz: 5f0d61084dc248763ec1c6704196d7c0b6757710
 SHA512:
-  metadata.gz: 787cc521de2adbdcb594f385f1ea95328c90ee2148a6bc6a74985a001cee7e8fb1fca45192dfeb3f3edc7285353a69bddc83f9193f4a16f52d3353636d23d6fd
-  data.tar.gz: '0989e8dc63a28b094fdd3f1f2b3f484b48143b224f967c7188db5ed4717175b911aadb0555cbcb82a6ed28de546c1740191b2e966c8c8922663c9cc5327ae464'
+  metadata.gz: f849048fb5de7f875206640e220117bd8b8abafb758aa32b8de1f15dc828c9bdec3f15affb0bbdde3b0521536da059baf45cb3ba8b0a75520633574a7e9ca7b6
+  data.tar.gz: 5abcc2a81d5f4ed434ad1d652cf21e0aec9f130dbd3052e3d6ceed1275e0f361d112d8d773c40b1f598fafffa95cf049d7b0b88a93aa7db5a03820943494c332

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 export AWS_ACCESS_KEY_ID='...'
 export AWS_SECRET_ACCESS_KEY='...'
 export AWS_REGION='ap-northeast-1'
-simnos -e -o SNSfile  # export SNS topic
+simnos -e -f SNSfile  # export SNS topic
 vi SNSfile
 simnos -a --dry-run
 simnos -a             # apply `SNSfile` to SNS
@@ -35,8 +35,8 @@ simnos -a             # apply `SNSfile` to SNS
 
 ```
 Usage: simnos [options]
-    -h, --help                       Show help
-    -v, --debug                      Show debug log
+    -h, --help                       show help
+    -v, --debug                      show debug log
     -a, --apply                      apply DSL
     -e, --export                     export to DSL
     -n, --dry-run                    dry run
@@ -44,6 +44,8 @@ Usage: simnos [options]
     -s, --split                      split export DSL file to 1 per topic
         --no-color
                                      no color
+        --with-subscriptions
+                                     manage subscriptions
     -i, --include-names NAMES        include SNS names
     -x, --exclude-names NAMES        exclude SNS names by regex
 ```
@@ -79,6 +81,13 @@ sns "ap-northeast-1" do
           "Resource"=>"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:test-topic",
           "Condition"=>{"StringEquals"=>{"AWS:SourceOwner"=>"XXXXXXXXXXXX"}}}]}
     end
+
+    subscriptions opt_out: false do
+      subscription protocol: "https", endpoint: "https://your.awesome.site/"
+      subscription protocol: "email", endpoint: "simnos@example.com"
+      subscription protocol: "email-json", endpoint: "simnos@example.com"
+      subscription protocol: "sqs", endpoint: "arn:aws:sqs:ap-northeast-1:XXXXXXXXXXXX:test-queue"
+    end
   end
 end
 ```

data/lib/simnos/cli.rb

@@ -35,14 +35,15 @@ module Simnos
     def parser
       @parser ||= OptionParser.new do |opts|
         opts.version = VERSION
-        opts.on('-h', '--help', 'Show help') { @help = true }
-        opts.on('-v', '--debug', 'Show debug log') { Simnos.logger.level = Logger::DEBUG }
+        opts.on('-h', '--help', 'show help') { @help = true }
+        opts.on('-v', '--debug', 'show debug log') { Simnos.logger.level = Logger::DEBUG }
         opts.on('-a', '--apply', 'apply DSL') { @apply = true }
         opts.on('-e', '--export', 'export to DSL') { @export = true }
         opts.on('-n', '--dry-run', 'dry run') { @options[:dry_run] = true }
         opts.on('-f', '--file FILE', 'use selected DSL file') { |v| @filepath = v }
         opts.on('-s', '--split', 'split export DSL file to 1 per topic') { @options[:split] = true }
         opts.on('',   '--no-color', 'no color') { @options[:color] = false }
+        opts.on('',   '--with-subscriptions', 'manage subscriptions') { @options[:with_subscriptions] = true }
         opts.on('-i', '--include-names NAMES', 'include SNS names', Array) { |v| @options[:includes] = v }
         opts.on('-x', '--exclude-names NAMES', 'exclude SNS names by regex', Array) do |v|
           @options[:excludes] = v.map! do |name|

data/lib/simnos/client.rb

@@ -33,6 +33,13 @@ module Simnos
       Simnos.logger.info("Exporting...#{@options[:dry_run] ? ' [dry-run]' : ''}")
 
       topics_by_name = client.topics
+
+      if @options[:with_subscriptions]
+        topics_by_name.each do |name, topic|
+          Simnos.logger.debug("exporting subscriptions of #{topic[:topic].topic_arn}")
+          topic[:subscriptions] = client.subscriptions_by_topic(topic_arn: topic[:topic].topic_arn)
+        end
+      end
       region = client.region
 
       path = Pathname.new(@filepath)
@@ -63,11 +70,43 @@ module Simnos
 
     private
 
+    def traverse_subscriptions(aws_topic, dsl_subscriptions, aws_subscriptions)
+      dsl_sub_by_key = dsl_subscriptions.each_with_object({}) { |dsl_sub, h| h[[dsl_sub.protocol, dsl_sub.endpoint]] = dsl_sub }
+      aws_sub_by_key = aws_subscriptions.each_with_object({}) { |aws_sub, h| h[[aws_sub.protocol, aws_sub.endpoint]] = aws_sub }
+      # create
+      dsl_sub_by_key.reject { |key, _| aws_sub_by_key[key] }.each do |key, dsl_sub|
+        dsl_sub.aws_topic(aws_topic).create
+      end
+
+      dsl_sub_by_key.each do |key, dsl_sub|
+        aws_sub_by_key.delete(key)
+      end
+
+      # delete
+      aws_sub_by_key.each do |key, aws_sub|
+        Simnos.logger.info("Delete Topic(#{aws_topic[:topic].topic_arn.split(':').last}) Subscription. protocol: #{key[0].inspect}, endpoint: #{key[1].inspect}.#{@options[:dry_run] ? ' [dry-run]' : ''}")
+        if aws_sub.subscription_arn.split(':').length < 6
+          Simnos.logger.warn("Can not delete Subscription `#{aws_sub.subscription_arn}`")
+          next
+        end
+        next if @options[:dry_run]
+
+        client.unsubscribe(subscription_arn: aws_sub.subscription_arn)
+      end
+    end
+
     def traverse_topics(dsl_topics_all, aws_topics_by_name)
       dsl_topics = dsl_topics_all.select { |t| target?(t.name) }
       # create
       dsl_topics.reject { |t| aws_topics_by_name[t.name] }.each do |dsl_topic|
-        aws_topics_by_name[dsl_topic.name] = dsl_topic.create
+        aws_topic = dsl_topic.create
+
+        unless @options[:dry_run]
+          aws_topics_by_name[dsl_topic.name] = aws_topic
+        end
+        if @options[:with_subscriptions] && !dsl_topic.opt_out_subscriptions
+          traverse_subscriptions(aws_topic, dsl_topic.subscriptions, [])
+        end
       end
 
       # modify
@@ -75,11 +114,16 @@ module Simnos
         next unless aws_topic = aws_topics_by_name.delete(dsl_topic.name)
 
         dsl_topic.aws(aws_topic).modify
+
+        if @options[:with_subscriptions] && !dsl_topic.opt_out_subscriptions
+          aws_subscriptions = client.subscriptions_by_topic(topic_arn: aws_topic[:topic].topic_arn)
+          traverse_subscriptions(aws_topic, dsl_topic.subscriptions, aws_subscriptions)
+        end
       end
 
       # delete
       aws_topics_by_name.each do |name, aws_topic|
-        Simnos.logger.info("Delete Topic #{name}")
+        Simnos.logger.info("Delete Topic #{name}.#{@options[:dry_run] ? ' [dry-run]' : ''}")
         next if @options[:dry_run]
 
         client.delete_topic(topic_arn: aws_topic[:topic].topic_arn)

data/lib/simnos/client_wrapper.rb

@@ -7,7 +7,7 @@ module Simnos
     extend Forwardable
     include Filterable
 
-    def_delegators :@client, *%i/delete_topic get_topic_attributes create_topic set_topic_attributes set_subscription_attributes/
+    def_delegators :@client, *%i/delete_topic get_topic_attributes create_topic set_topic_attributes set_subscription_attributes subscribe unsubscribe/
 
     def initialize(options)
       @options = options
@@ -40,6 +40,17 @@ module Simnos
       results
     end
 
+    def subscriptions_by_topic(topic_arn: )
+      results = []
+      next_token = nil
+      begin
+        resp = @client.list_subscriptions_by_topic(topic_arn: topic_arn, next_token: next_token)
+        results.concat(resp.subscriptions)
+        next_token = resp.next_token
+      end while next_token
+      results
+    end
+
     def region
       @client.config.region
     end

data/lib/simnos/dsl/subscription.rb

@@ -0,0 +1,41 @@
+require 'simnos/utils'
+
+module Simnos
+  class DSL
+    class Subscription
+      include Simnos::TemplateHelper
+
+      def create
+        Simnos.logger.info("Create Topic(#{@aws_topic[:topic].topic_arn.split(':').last}) Subscription. protocol: #{protocol.inspect}, endpoint: #{endpoint.inspect}#{@options[:dry_run] ? ' [dry-run]' : ''}")
+        return if @options[:dry_run]
+
+        client.subscribe(
+          topic_arn: @aws_topic[:topic].topic_arn,
+          protocol: protocol,
+          endpoint: endpoint,
+        )
+      end
+
+      def aws_topic(aws_topic)
+        @aws_topic = aws_topic
+        self
+      end
+
+      def initialize(context, topic: , protocol: , endpoint: )
+        @context = context
+        @options = @context.options
+        @topic = topic
+        @protocol = protocol
+        @endpoint = endpoint
+      end
+
+      attr_reader :topic, :protocol, :endpoint
+
+      private
+
+      def client
+        @client ||= Simnos::ClientWrapper.new(@context)
+      end
+    end
+  end
+end

data/lib/simnos/dsl/subscriptions.rb

@@ -0,0 +1,27 @@
+require 'simnos/utils'
+require 'simnos/dsl/subscription'
+
+module Simnos
+  class DSL
+    class Subscriptions
+      include Simnos::TemplateHelper
+
+      def initialize(context, topic, &block)
+        @context = context
+        @topic = topic
+
+        @result = []
+
+        instance_eval(&block)
+      end
+
+      attr_reader :result
+
+      private
+
+      def subscription(protocol: , endpoint: )
+        @result << Subscription.new(@context, topic: @topic, protocol: protocol, endpoint: endpoint)
+      end
+    end
+  end
+end

data/lib/simnos/dsl/topic.rb

@@ -1,4 +1,5 @@
 require 'simnos/utils'
+require 'simnos/dsl/subscriptions'
 
 module Simnos
   class DSL
@@ -6,12 +7,13 @@ module Simnos
       include Simnos::TemplateHelper
 
       class Result
-        ATTRIBUTES = %i/name display_name subscriptions_pending subscriptions_confirmed subscriptions_deleted effective_delivery_policy policy/
+        ATTRIBUTES = %i/name display_name subscriptions_pending subscriptions_confirmed subscriptions_deleted effective_delivery_policy policy topic_arn subscriptions aws_topic opt_out_subscriptions/
         attr_accessor *ATTRIBUTES
 
         def initialize(context)
           @context = context
           @options = context.options
+          @subscriptions = []
         end
 
         def to_h
@@ -24,10 +26,12 @@ module Simnos
         end
 
         def create
-          Simnos.logger.info("Create Topic #{name}")
-          return if @options[:dry_run]
+          Simnos.logger.info("Create Topic #{name}.#{@options[:dry_run] ? ' [dry-run]' : ''}")
+          return { topic: Hashie::Mash.new(topic_arn: 'not yet created') } if @options[:dry_run]
 
           resp = client.create_topic(name: name)
+          # save topic_arn
+          topic_arn = resp.topic_arn
           {
             topic: resp,
             attrs: client.topic_attrs(topic_arn: resp.topic_arn)
@@ -68,7 +72,7 @@ module Simnos
           Simnos.logger.debug(@aws_topic[:attrs].attributes.pretty_inspect)
           Simnos.logger.debug('--- dsl ---')
           Simnos.logger.debug(dsl_val)
-          Simnos.logger.info("Modify Topic `#{name}` #{attr_name} attributes")
+          Simnos.logger.info("Modify Topic `#{name}` #{attr_name} attributes.#{@options[:dry_run] ? ' [dry-run]' : ''}")
           dsl_attrs = {
             attribute_name: attr_name,
             attribute_value: dsl_val,
@@ -88,7 +92,7 @@ module Simnos
         def modify_attr_hash(dsl_val, attr_name)
           aws_val = JSON.parse(@aws_topic[:attrs].attributes[attr_name])
           return if dsl_val == aws_val
-          Simnos.logger.info("Modify Topic `#{name}` #{attr_name} attributes")
+          Simnos.logger.info("Modify Topic `#{name}` #{attr_name} attributes.#{@options[:dry_run] ? ' [dry-run]' : ''}")
           dsl_attrs = {
             attribute_name: attr_name,
             attribute_value: dsl_val,
@@ -166,6 +170,14 @@ module Simnos
       def policy
         @result.policy = yield
       end
+
+      def subscriptions(opt_out: false, &block)
+        if opt_out
+          @result.opt_out_subscriptions = true
+          return
+        end
+        @result.subscriptions = Subscriptions.new(@context, self, &block).result
+      end
     end
   end
 end

data/lib/simnos/output_topic.erb

@@ -10,6 +10,14 @@ sns <%= region.inspect %> do
     policy do
 <%= JSON.parse(topic[:attrs].attributes['Policy']).pretty_inspect.gsub(/^/, '      ') -%>
     end
+    <%- if topic[:subscriptions] -%>
+
+    subscriptions do
+    <%- (topic[:subscriptions] || []).each do |subscription| -%>
+      subscription protocol: <%= subscription.protocol.inspect %>, endpoint: <%= subscription.endpoint.inspect %>
+    <%- end -%>
+    end
+    <%- end -%>
   end
   <%- if topics_by_name.keys.last != name -%>
 

data/lib/simnos/version.rb

@@ -1,3 +1,3 @@
 module Simnos
-  VERSION = "0.1.0.beta4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simnos
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta4
+  version: 0.1.0
 platform: ruby
 authors:
 - wata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -161,6 +161,8 @@ files:
 - lib/simnos/converter.rb
 - lib/simnos/dsl.rb
 - lib/simnos/dsl/sns.rb
+- lib/simnos/dsl/subscription.rb
+- lib/simnos/dsl/subscriptions.rb
 - lib/simnos/dsl/topic.rb
 - lib/simnos/filterable.rb
 - lib/simnos/output_topic.erb
@@ -183,12 +185,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Codenize AWS SNS