aws_sms 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9919b56610030d592728da2a1a35be5a5c20c6ea
-  data.tar.gz: 5a4481404dea2e827ebb2265872d23c48f6aa981
+  metadata.gz: 47cdb45a6f10acbce54889a2010dd46e969a99d4
+  data.tar.gz: a537521a71a187db1f3fb8d0c64d4a8fb4c5eb2c
 SHA512:
-  metadata.gz: 7c7f368396fd6d998220db0257d85ae8abbbdc2716e2d9e5ea03562ca35faaf725d256c59e0ceef7ceb21b5afc8fb8144ac0d3f0772117edd9975fb0a66f464c
-  data.tar.gz: 68f38bd47279b5fe34ed951fe8d61a10f394f47ac83df6ef58f82852239ea062f5c3557a0c92fc707e8e2a6bc4a3d541ef62362a068b60448fd6f5c84d85fad5
+  metadata.gz: 7e37431515e656e256942baedd245285b257a16f21ce317cbfc60036f243a16b88addb005bac96a6a0b8c8e4116ff3407036dd79798fbb1ba5a4cebfe6e1fbe8
+  data.tar.gz: bb1c8f17bf8dd3652573832f76568b931db095173bbd2fbfe902df9251906e24fef714fe23d10ed0604198a581bf34486b6814b53cdf7c7d27c32d5d963f6caf

data/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in aws_sms.gemspec
 gemspec
 gem 'aws-sdk'
 gem 'configatron'

data/README.md

@@ -1,8 +1,8 @@
-# AwsSms
+[![CircleCI](https://circleci.com/gh/KidA001/aws-sms.svg?style=shield&circle-token=9a6bd52d0f03294b7f6675c38046c643d096acf8)](https://circleci.com/gh/KidA001/aws-sms)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aws_sms`. To experiment with that code, run `bin/console` for an interactive prompt.
+# AwsSms
 
-TODO: Delete this and the text above, and describe your gem
+This gem acts as a simple wrapper for sending SMS Messages with Amazon SNS. It's as easy as adding your AWS Credentials and calling `AwsSms.new.send(phone_number, message)`
 
 ## Installation
 
@@ -21,21 +21,78 @@ Or install it yourself as:
     $ gem install aws_sms
 
 ## Usage
+You must have an AWS Account Setup with SMS Enabled under your Simple Notification Service. You will need IAM Credentials that have `AmazonSNSFullAccess` permissions. Details below on how to load your credentials.
 
-TODO: Write usage instructions here
+You must follow Amazon's requirements on sending text messages, for instance, you must provide a country code for the phone number you provide (e.g. `12225675309` where `1` is the country code) You can check [Amazon's Documentation](http://docs.aws.amazon.com/sdkforruby/api/Aws/SNS/Errors.html) for details on any errors that are raised.
 
-## Development
+### AWS Credentials
 
-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.
+There are three ways to load your AWS Credentials:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can initialzie `AwsSms` with your credentials as arguments:
+```ruby
+sms = AwsSms.new(
+  aws_default_region: 'us-west 2',
+  aws_access_key_id: 'your access key',
+  aws_secret_access_key: 'your secret key'
+)
+sms.send('15555555555', 'Some great message')
+```
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Brian Vogelgesang/aws_sms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Set them through the config object. If you're using Rails you can store this in an initializer
+```ruby
+# config/initializers/aws_sms.rb
+AwsSms::Config.set_credentials(
+  aws_default_region: 'us-west 2',
+  aws_access_key_id: ACCESS_KEY,
+  aws_secret_access_key: SECRET_KEY
+)
+...
+# somewhere in your application
+sms = AwsSms.new
+sms.send('15555555555', 'Hello!')
+```
+
+
+Or you can securely store the credentials in your environment variables. This gem will search for them as follows:
+```bash
+# .env
+AWS_ACCESS_KEY_ID=123456
+AWS_SECRET_ACCESS_KEY=abc123foobarbaz
+AWS_DEFAULT_REGION=us-east-2
+...
+```
+```ruby
+# somewhere in your application
+
+sms = AwsSms.new
+sms.send('15555555555', 'Foo bar baz!')
+```
+### AWS SMS Attributes
+You can provide Amazon SMS Attributes in a similar way. Attributes default to `{ 'DefaultSMSType' => 'Transactional' }` if none are provided. See Amazon's Documentation on [SMS Attributes](http://docs.aws.amazon.com/sdkforruby/api/Aws/SNS/Client.html#set_sms_attributes-instance_method) to see what options are available to pass
+```ruby
+attributes = { 
+  'DefaultSenderID' => 'SomeSenderId', 'DefaultSMSType' => 'Promotional' 
+}
+sms = AwsSms.new(sms_attributes: attributes)
+sms.send(...)
+```
+or
+```ruby
+AwsSms::Config.set_sms_attributes(
+  { 'MonthlySpendLimit' => '1000', 'DefaultSMSType' => 'Promotional' }
+)
+```
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/KidA001/aws_sms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Code of Conduct
+
+Everyone interacting in the AwsSms project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/aws_sms/blob/master/CODE_OF_CONDUCT.md).

data/aws_sms.gemspec

@@ -14,22 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/KidA001/aws-sms"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/aws_sms.rb

@@ -1,19 +1,16 @@
-require "aws_sms/version"
-require 'aws-sdk'
-require 'configatron'
+require 'aws_sms/version'
 require 'aws_sms/config'
+require 'aws-sdk'
 
 class AwsSms
-  class SNSClientError < StandardError; end
-  class InvalidNumber < StandardError; end
-
-  def initialize(region: nil, access_key_id: nil, secret_key: nil, sms_attributes: nil)
-    @region            = region            || Config.region
-    @access_key_id     = access_key_id     || Config.access_key
-    @secret_key        = secret_key        || Config.secret_key
-    @default_sms_type  = default_sms_type  || Config.sms_type
-    @default_sender_id = default_sender_id || Config.default_sender_id
-    @sms_attributes    = sms_attributes    || Config.sms_attributes
+
+  def initialize(aws_default_region: nil, aws_access_key_id: nil,
+                 aws_secret_access_key: nil, sms_attributes: nil)
+
+    @aws_default_region    = aws_default_region    || Config.region
+    @aws_access_key_id     = aws_access_key_id     || Config.access_key
+    @aws_secret_access_key = aws_secret_access_key || Config.secret_key
+    @sms_attributes        = sms_attributes        || Config.sms_attributes
     validate_args!
     set_config!
   end
@@ -22,35 +19,33 @@ class AwsSms
     client.publish(phone_number: phone_number, message: message)
   end
 
-  private
-  attr_reader :region, :access_key_id, :secret_key, :default_sender_id,
-              :default_sms_type
-
   def client
     @client ||= begin
-      sns = ::Aws::SNS::Client.new()
-      sns.set_sms_attributes({ attributes: {
-        "DefaultSMSType" => default_sms_type,
-        "DefaultSenderID" => default_sender_id
-      }})
+      sns = Aws::SNS::Client.new()
+      sns.set_sms_attributes({ attributes: sms_attributes })
       sns
     end
   end
 
+  private
+  attr_reader :aws_default_region, :aws_access_key_id, :aws_secret_access_key,
+              :sms_attributes
+
   def set_config!
-    ::Aws.config.update({
-      region: region,
-      credentials: Aws::Credentials.new(access_key_id, secret_key)
+    Aws.config.update({
+      aws_default_region: aws_default_region,
+      credentials: Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
     })
   end
 
   def validate_args!
-    if region.nil? || access_key_id.nil? || secret_key.nil?
-      message = 'ERROR: region, access_key_id, and secret_key arguments must '\
-              'be provided. You can explicitly set them when initializing '\
-              'AwsSms, set them in your Environment Variables as: '\
-              'AWS_DEFAULT_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, '\
-              'or use AwsSms::Config.set_credentials'
+    if aws_default_region.nil? || aws_access_key_id.nil? || aws_secret_access_key.nil?
+      message = 'ERROR: aws_default_region, aws_access_key_id, and '\
+                'aws_secret_access_key arguments must be provided. You can '\
+                'explicitly set them when initializing AwsSms, set them in '\
+                'your Environment Variables as: AWS_DEFAULT_REGION, '\
+                'AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or use '\
+                'AwsSms::Config.set_credentials'
       raise ArgumentError, message
     end
   end

data/lib/aws_sms/config.rb

@@ -27,17 +27,9 @@ class AwsSms
 
     def self.sms_attributes
       unless configatron.has_key?(:sms_attributes)
-        configatron.sms_attributes = { "DefaultSMSType" => 'Transactional' }
+        configatron.sms_attributes = { 'DefaultSMSType' => 'Transactional' }
       end
       configatron.sms_attributes
     end
-
-    def self.sms_type
-      configatron.default_sms_type
-    end
-
-    def self.default_sender_id
-      configatron.default_sender_id
-    end
   end
 end

data/lib/aws_sms/version.rb

@@ -1,3 +1,3 @@
 class AwsSms
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_sms
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Brian Vogelgesang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for sending SMS via AWS SNS