sns_sender 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0005482b6cdf954da73768ce4375bdf5a56ab7e6114ebb64e2d66298dd1012dd'
+  data.tar.gz: a8389fca53500874eb3c1e7293e76f539901a57ea8aaee004e0850823ddd8494
+SHA512:
+  metadata.gz: df2cb70b49129dea51de2d25b15a4cc7faf6954273f4315aaf2e1394d104e0c1e3bcf18a93506f2a548b120de61183f65211f11953dff9479e8c65ff5cca0475
+  data.tar.gz: 9dd59bde7378b1e019b8ae8032baa23a378fbb36dc68b75b4b991afe20484c2b6a21573519ca94d4b97a43bc60744dc617345871ea65ab6c68e92ef987183585

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,119 @@
+# SNS Sender
+
+A Ruby gem that provides a simple interface for publishing messages to AWS SNS topics, which can then be consumed by SQS queues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sns_sender'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sns_sender
+
+## Configuration
+
+Configure the gem with your AWS credentials. In a Rails application, you might want to put this in an initializer:
+
+```ruby
+# config/initializers/sns_sender.rb
+SnsSender.configure do |config|
+  config.aws_region = 'us-east-1'                    # Required
+  config.aws_access_key_id = 'YOUR_ACCESS_KEY'       # Required
+  config.aws_secret_access_key = 'YOUR_SECRET_KEY'   # Required
+  config.default_topic_arn = 'YOUR_DEFAULT_TOPIC_ARN' # Optional
+end
+```
+
+You can also use environment variables for AWS credentials:
+- AWS_REGION
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+
+## Usage
+
+### Basic Usage
+
+```ruby
+# Send a simple message
+SnsSender.publish(
+  topic_arn: 'arn:aws:sns:us-east-1:123456789012:MyTopic',
+  message: 'Hello, World!'
+)
+
+# Send a JSON message
+SnsSender.publish(
+  topic_arn: 'arn:aws:sns:us-east-1:123456789012:MyTopic',
+  message: {
+    event: 'user_created',
+    data: {
+      id: 123,
+      name: 'John Doe',
+      email: 'john@example.com'
+    }
+  }
+)
+
+# Using the default topic (if configured)
+SnsSender.publish(
+  message: 'Hello, World!'
+)
+
+# With message attributes
+SnsSender.publish(
+  topic_arn: 'arn:aws:sns:us-east-1:123456789012:MyTopic',
+  message: 'Hello, World!',
+  message_attributes: {
+    event_type: 'greeting',
+    priority: 'high'
+  }
+)
+```
+
+### Response Format
+
+The `publish` method returns a hash with the following structure:
+
+```ruby
+{
+  success: true,
+  message_id: 'abc123...' # The SNS message ID
+}
+```
+
+### Error Handling
+
+The gem can raise the following errors:
+
+```ruby
+begin
+  SnsSender.publish(topic_arn: 'arn:...', message: 'Hello')
+rescue SnsSender::ConfigurationError => e
+  # Handle missing or invalid AWS configuration
+rescue SnsSender::PublishError => e
+  # Handle SNS publishing errors
+rescue ArgumentError => e
+  # Handle invalid arguments (missing topic_arn or message)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bigbinary/sns_sender.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sns_sender/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "aws-sdk-sns"
+
+module SnsSender
+  class Client
+    attr_reader :sns_client
+
+    def initialize
+      SnsSender.configuration.validate!
+      @sns_client = Aws::SNS::Client.new(
+        region: SnsSender.configuration.aws_region,
+        credentials: Aws::Credentials.new(
+          SnsSender.configuration.aws_access_key_id,
+          SnsSender.configuration.aws_secret_access_key
+        )
+      )
+    end
+
+    def publish(topic_arn:, message:, message_attributes: {})
+      raise ArgumentError, "topic_arn is required" if topic_arn.nil? || topic_arn.empty?
+      raise ArgumentError, "message is required" if message.nil? || message.empty?
+
+      formatted_message = message.is_a?(String) ? message : message.to_json
+      formatted_attributes = format_message_attributes(message_attributes)
+
+      begin
+        response = sns_client.publish(
+          topic_arn: topic_arn,
+          message: formatted_message,
+          message_attributes: formatted_attributes
+        )
+        { success: true, message_id: response.message_id }
+      rescue Aws::SNS::Errors::ServiceError => e
+        raise PublishError, "Failed to publish message: #{e.message}"
+      end
+    end
+
+    private
+
+    def format_message_attributes(attributes)
+      attributes.transform_values do |value|
+        {
+          data_type: value.is_a?(Numeric) ? "Number" : "String",
+          string_value: value.to_s
+        }
+      end
+    end
+  end
+end

data/lib/sns_sender/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SnsSender
+  class Configuration
+    attr_accessor :aws_access_key_id,
+                :aws_secret_access_key,
+                :aws_region,
+                :default_topic_arn
+
+    def initialize
+      @aws_region = ENV["AWS_REGION"]
+      @aws_access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      @aws_secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+    end
+
+    def validate!
+      missing_configs = []
+      missing_configs << "aws_region" unless aws_region
+      missing_configs << "aws_access_key_id" unless aws_access_key_id
+      missing_configs << "aws_secret_access_key" unless aws_secret_access_key
+
+      return true if missing_configs.empty?
+
+      raise ConfigurationError, "Missing required AWS configurations: #{missing_configs.join(", ")}"
+    end
+  end
+end

data/lib/sns_sender/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SnsSender
+  VERSION = "0.1.0"
+end

data/lib/sns_sender.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "sns_sender/version"
+require_relative "sns_sender/configuration"
+require_relative "sns_sender/client"
+
+module SnsSender
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class PublishError < Error; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def publish(topic_arn: nil, message:, message_attributes: {})
+      Client.new.publish(
+        topic_arn: topic_arn || configuration.default_topic_arn,
+        message: message,
+        message_attributes: message_attributes
+      )
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sns_sender
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unnikrishnan KP
+bindir: bin
+cert_chain: []
+date: 2025-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple interface for publishing messages to AWS SNS topics that can
+  be consumed by SQS queues
+email:
+- unnikrishnan.kp@bigbinary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sns_sender.rb
+- lib/sns_sender/client.rb
+- lib/sns_sender/configuration.rb
+- lib/sns_sender/version.rb
+homepage: https://github.com/bigbinary/sns_sender
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bigbinary/sns_sender
+  source_code_uri: https://github.com/bigbinary/sns_sender
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A Ruby gem for publishing messages to AWS SNS topics
+test_files: []