unisms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c43cf4f6526a63197dc40f75b6c37e256238ee39
+  data.tar.gz: c8be0d31e4a247d457f64ad0134bd7978f85503c
+SHA512:
+  metadata.gz: 88d030f59913b995231e0add0cc19ddaacd05645d5fca1ccd850eb1c282199ed1476e1c6a3b5b9d5df17782f82475bac47f4b103119157c4a563570aad673733
+  data.tar.gz: 222feea03705c1d9bff429c29cbd2f043fadae474a2e1685f00764b4e7ab2b2aa3f10b1815b369d7bc25c8a51f447542524b64e140d57ebd626133bf35237a6b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unisms.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 CrBoy
+
+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,93 @@
+# Unisms
+
+This gem provides a unified interface to let users dealing with SMS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unisms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unisms
+
+## Usage
+
+Basic example: Print the SMS to STDOUT
+```ruby
+sms = Unisms.new
+phone_number = '+886999999999' # the phone number should be international format
+sms.deliver 'hello', to: phone_number
+```
+
+Using Nexmo to send SMS
+```ruby
+nexmo_adapter = Unisms::Adapter::Nexmo.new 'nexmo-api-key', 'nexmo-api-secret'
+sms = Unisms.new nexmo_adapter
+phone_number = '+886999999999' # the phone number should be international format
+sms.deliver 'hello', to: phone_number, from: 'unisms'
+```
+
+Using Kotsms to send SMS
+```ruby
+kotsms_adapter = Unisms::Adapter::Kotsms.new 'kotsms-username', 'kotsms-password'
+sms = Unisms.new kotsms_adapter
+phone_number = '+886999999999'
+sms.deliver 'hello', to: phone_number
+```
+
+Sending message randomly by Nexmo or Kotsms
+```ruby
+nexmo_adapter = Unisms::Adapter::Nexmo.new 'nexmo-api-key', 'nexmo-api-secret'
+kotsms_adapter = Unisms::Adapter::Kotsms.new 'kotsms-username', 'kotsms-password'
+random_router = Unisms::Router::Random.new [nexmo_adapter, kotsms_adapter]
+sms = Unisms.new random_router
+phone_number = '+886999999999'
+sms.deliver 'hello', to: phone_number, from: 'unisms'
+```
+
+Sending message: to Taiwan by Kotsms, and else by Nexmo using custom router
+```ruby
+class TaiwanOptimizedRouter < Unisms::Router::Base
+	def initialize
+		@nexmo_adapter = Unisms::Adapter::Nexmo.new 'nexmo-api-key', 'nexmo-api-secret'
+		@kotsms_adapter = Unisms::Adapter::Kotsms.new 'kotsms-username', 'kotsms-password'
+	end
+
+	def route(message, to: nil, from: nil)
+		if /\+886.*/ === to
+			@kotsms_adapter
+		else
+			@nexmo_adapter
+		end
+	end
+end
+
+router = TaiwanOptimizedRouter.new
+sms = Unisms.new router
+sms.deliver '哈囉! Taiwan NO.1!', to: '+886999999999', from: 'unisms'
+sms.deliver 'hello', to: '+1999999999', from: 'unisms' # I don't know the format of US
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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`. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CrBoy/unisms.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unisms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/unisms.rb

@@ -0,0 +1,15 @@
+require "unisms/version"
+require "unisms/adapter"
+require "unisms/router"
+require "unisms/logger"
+require "unisms/sms"
+
+module Unisms
+	def self.new(adapter = nil)
+		Sms.new(adapter)
+	end
+
+	def self.default_adapter=(adapter)
+		Sms.default_adapter = adapter
+	end
+end

data/lib/unisms/adapter.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/adapter/*.rb'].each {|file| require file }

data/lib/unisms/adapter/base.rb

@@ -0,0 +1,4 @@
+module Unisms::Adapter
+	class Base
+	end
+end

data/lib/unisms/adapter/kotsms.rb

@@ -0,0 +1,23 @@
+require "kotsms"
+require_relative "base"
+
+module Unisms::Adapter
+	class Kotsms < Base
+		def initialize(username, password, options = {})
+			@kotsms = ::Kotsms.new username, password
+			@kotsms_options = options
+		end
+
+		def deliver(message, to: nil, from: nil)
+			raise ArgumentError.new("phone number should start with '+'") unless /\A\+.*\z/ === to
+			@kotsms.deliver to[1..-1], message, @kotsms_options
+			true
+		rescue ArgumentError => e
+			Unisms.logger.error "ArgumentError: #{e}"
+		rescue SocketError => e
+			Unisms.logger.error "Failed to send message to #{to}"
+			false
+		end
+	end
+end
+

data/lib/unisms/adapter/nexmo.rb

@@ -0,0 +1,24 @@
+require "nexmo"
+require_relative "base"
+
+module Unisms::Adapter
+	class Nexmo < Base
+		def initialize(key, secret)
+			@nexmo = ::Nexmo::Client.new key: key, secret: secret
+		end
+
+		def deliver(message, to: nil, from: nil)
+			raise ArgumentError.new "'from' is required in Nexmo" if from.nil?
+			response = @nexmo.send_message(text: message, to: to, from: from, type: 'unicode')
+			Unisms.logger.debug response
+			true
+		rescue ArgumentError => e
+			Unisms.logger.error "ArgumentError: #{e}"
+			false
+		rescue SocketError => e
+			Unisms.logger.error "Failed to send message to #{to}"
+			false
+		end
+	end
+end
+

data/lib/unisms/adapter/stdout.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module Unisms::Adapter
+	class Stdout < Base
+		def deliver(message, to: nil, from: nil)
+			puts ["Sending message '#{message}'", to && " to '#{to}'", from && " from '#{from}'", "."].compact.join
+			true
+		end
+	end
+end
+

data/lib/unisms/logger.rb

@@ -0,0 +1,11 @@
+require "logger"
+
+Dir[File.dirname(__FILE__) + '/logger/*.rb'].each {|file| require file }
+
+module Unisms
+	@logger = Logger.new STDOUT
+
+	class << self
+		attr_accessor :logger
+	end
+end

data/lib/unisms/router.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/router/*.rb'].each {|file| require file }

data/lib/unisms/router/base.rb

@@ -0,0 +1,7 @@
+module Unisms::Router
+	class Base
+		def deliver(message, to: nil, from: nil)
+			route(message, to: to, from: from).deliver(message, to: to, from: from)
+		end
+	end
+end

data/lib/unisms/router/random.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+
+module Unisms::Router
+	class Random < Base
+		attr_accessor :adapters
+
+		def initialize(adapters = nil)
+			@adapters = adapters.is_a?(Array) ? adapters : [adapters].compact
+		end
+
+		def route
+			@adapters.sample
+		end
+	end
+end
+
+module Unisms::Router
+	class Random < Base
+		def load_internal_adapters
+			adapter_module = Unisms::Adapter
+			klasses = adapter_module.constants.reject{ |c| c == :Base }.select { |c| adapter_module.const_get(c).is_a? Class }.map {|c| adapter_module.const_get c }
+			@adapters = klasses.map { |klass| klass.new rescue nil }.compact
+		end
+	end
+end

data/lib/unisms/sms.rb

@@ -0,0 +1,19 @@
+module Unisms
+	class Sms
+		@default_adapter = Unisms::Adapter::Stdout.new
+		class << self
+			attr_accessor :default_adapter
+		end
+
+		attr_accessor :adapter
+
+		def initialize(adapter = nil)
+			@adapter = adapter || self.class.default_adapter
+		end
+
+		def deliver(message, to: nil, from: nil)
+			Unisms.logger.info "Using #{@adapter} to send message to #{to}"
+			@adapter.deliver(message, to: to, from: from)
+		end
+	end
+end

data/lib/unisms/version.rb

@@ -0,0 +1,3 @@
+module Unisms
+  VERSION = "0.1.0"
+end

data/unisms.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unisms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unisms"
+  spec.version       = Unisms::VERSION
+  spec.authors       = ["CrBoy"]
+  spec.email         = ["crboy@crboy.net"]
+
+  spec.summary       = %q{Unified interface for dealing with SMS}
+  spec.homepage      = "http://github.com/CrBoy/unisms"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: unisms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CrBoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email:
+- crboy@crboy.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/unisms.rb
+- lib/unisms/adapter.rb
+- lib/unisms/adapter/base.rb
+- lib/unisms/adapter/kotsms.rb
+- lib/unisms/adapter/nexmo.rb
+- lib/unisms/adapter/stdout.rb
+- lib/unisms/logger.rb
+- lib/unisms/router.rb
+- lib/unisms/router/base.rb
+- lib/unisms/router/random.rb
+- lib/unisms/sms.rb
+- lib/unisms/version.rb
+- unisms.gemspec
+homepage: http://github.com/CrBoy/unisms
+licenses:
+- MIT
+metadata: {}
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Unified interface for dealing with SMS
+test_files: []