any_sms-backend-aws 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2bcec159b70d4fba5abe670571ac31a458eeaae
+  data.tar.gz: 991da348a4f1988dc6b4175b4eab9fa0c1ba32ad
+SHA512:
+  metadata.gz: 1a58c20681e17fa46351f6a0ebaa04887e75a40197e0658ec44686ada60f9ae97b53105fcc7451fdbd1f669d4ab8d51e0b7e30b2bbff590422b3c97faa20ada2
+  data.tar.gz: c7c11f79c30ec45d3e9bea31a3ecb66a70c4ac0541e04a29433d54cd6a66aee06bed9cf5c68a3ce3bd6cf37ef2f75ac871c7f1f12fbfccb69d87a96e98894f0e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.envrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - "lib/any_sms/backend/aws/version.rb"
+    - "lib/any_sms-backend-aws.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/LineLength:
+  Max: 90
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+
+script:
+  - bundle exec rake
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,22 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Lib files
+  watch(%r{^lib/any_sms.rb$}) { rspec.spec_dir }
+  watch(%r{^lib/(.+)\.rb$}) { |m| rspec.spec.call(m[1]) }
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard "yard" do
+  watch(%r{lib/.+\.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Fedcomp
+
+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,81 @@
+# AnySMS::Backend::AWS
+[![Build Status](https://travis-ci.org/Fedcomp/any_sms-backend-aws.svg?branch=master)](https://travis-ci.org/Fedcomp/any_sms-backend-aws)
+
+AnySMS backend to send sms using [Amazon Web Services](https://aws.amazon.com).
+**At this point gem does not support SenderID**. If you know how to specify it - open issue or make pull request, all contributions are welcome!
+
+## Before installation - obtaining token
+
+Before you can use this gem, you should get tokens from amazon web services (AWS).
+Here are steps to achieve that:
+
+1. Go to [AWS registration page](https://goo.gl/HG8Y9s)
+2. After you registered and logged in, go to [IAM users](https://goo.gl/u4hrzj)
+3. Click "Create new users", enter username of your wish (in my case `testuser`) and then click "Create".
+4. You should see similar picture:
+
+   ![security credentials](screenshot.png)
+
+   save **access key id** and **secret acces key** somwhere.
+5. Now close popup and click on the user.
+6. Click **Permissions** tab. It will look like this
+
+   ![permissions tab](permissions_screenshot.png)
+
+7. Click on **Attach Policy**, then filter by **SNS**.
+8. Check **AmazonSNSFullAccess**, click **Attach Policy** (at the bottom)
+
+This is simple example on how to get them and make things work quick.
+In reality AWS support various access options,
+you may read them [here](https://goo.gl/sajJgL) and configure it more strict or closer to your needs.
+
+## Installation & usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "any_sms-backend-aws"
+```
+
+Then somewhere in your initialization code:
+
+```ruby
+require "any_sms"
+require "any_sms-backend-aws"
+
+AnySMS.configure do |c|
+  c.register_backend(:my_main_backend,
+    AnySMS::Backend::AWS,
+    access_key: ENV["AWS_ACCESS_KEY"],
+    secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
+    region: ENV["AWS_REGION"] # Optional, default will be "us-east-1"
+  )
+
+  c.default_backend = :my_main_backend
+end
+```
+This is an simple example of configuration.
+Before running application you should specify
+`AWS_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`
+environment variables.
+You may change initializer code to suit your needs more,
+just make sure **you never store credentials commited to your codebase**.
+It should be stored separately from application.
+
+Now, whenever you need to send SMS, just do:
+
+```ruby
+# Will immediately send sms
+AnySMS.send_sms("+10000000000", "My sms text")
+```
+
+For more advanced usage please
+go to [AnySMS documentation](https://github.com/Fedcomp/any_sms#real-life-example)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fedcomp/any_sms-backend-aws.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/any_sms-backend-aws.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "any_sms/backend/aws/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "any_sms-backend-aws"
+  spec.version       = AnySMS::Backend::AWS_VERSION
+  spec.authors       = ["Fedcomp"]
+  spec.email         = ["aglergen@gmail.com"]
+
+  spec.summary       = "AnySMS backend for using amazon web services sms delivery"
+  spec.homepage      = "https://github.com/Fedcomp/any_sms-backend-aws"
+  spec.license       = "MIT"
+
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  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_dependency "any_sms"
+  spec.add_dependency "aws-sdk", "~> 2.6"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "guard-yard"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+end

data/lib/any_sms/backend/aws/version.rb

@@ -0,0 +1,5 @@
+module AnySMS
+  module Backend
+    AWS_VERSION = "0.0.2".freeze
+  end
+end

data/lib/any_sms/backend/aws.rb

@@ -0,0 +1,42 @@
+require "aws-sdk"
+require "any_sms"
+require "any_sms/backend/aws/version"
+
+# AnySMS backend class to send sms using amazon web services
+class AnySMS::Backend::AWS < AnySMS::Backend::Base
+  # To use class, you need access key from AWS.
+  # Go to README for instructions on how to obtain them.
+  #
+  # @param access_key [String] AWS access key
+  # @param secret_access_key [String] AWS secret access key
+  # @param region [String] AWS region. Full list: https://goo.gl/Ys5XMi
+  def initialize(access_key:, secret_access_key:, region: "us-east-1")
+    @access_key = access_key
+    @secret_access_key = secret_access_key
+    @region = region
+  end
+
+  # Sends sms using amazon web services
+  #
+  # @phone [String] Phone number in E.164 format
+  # @text  [String] Sms text
+  def send_sms(phone, text)
+    resp = sns_client.publish(phone_number: phone, message: text)
+
+    if resp.error.nil? && resp.message_id
+      respond_with_status :success
+    else
+      respond_with_status :unknown_failure
+    end
+  end
+
+  protected
+
+  def sns_client
+    Aws::SNS::Client.new(
+      access_key_id: @access_key,
+      secret_access_key: @secret_access_key,
+      region: @region
+    )
+  end
+end

data/lib/any_sms-backend-aws.rb

@@ -0,0 +1 @@
+require "any_sms/backend/aws"

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: any_sms-backend-aws
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fedcomp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: any_sms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- aglergen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- any_sms-backend-aws.gemspec
+- lib/any_sms-backend-aws.rb
+- lib/any_sms/backend/aws.rb
+- lib/any_sms/backend/aws/version.rb
+- permissions_screenshot.png
+- screenshot.png
+homepage: https://github.com/Fedcomp/any_sms-backend-aws
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: AnySMS backend for using amazon web services sms delivery
+test_files: []