active_sms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8d1dd6ad22373355ea92034148d7c7372236d84
+  data.tar.gz: 4efc65029b7a1ea4692ce9d89184e6c3f02cae5c
+SHA512:
+  metadata.gz: 793130b952a78ed1c5fe860aa3c1c35820ca5e0f65dc1bb6dca2a90dc91d2553e1f4fa606353054c5fbb69819934fac62e3672d2e8fe3219ab8af9f666689006
+  data.tar.gz: e7cbb4c1f177f929fbd64f31071686adf4df787df3d99d09a9b22566264c5710854c52a5d77b88302fb80fa40134fb8d78c03ce05989c64fad527ce58b4c1d54

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Metrics/LineLength:
+  Max: 90
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# I need to use singleton so gem stays simple
+Style/ClassVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm: 2.3.1
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake
+  - bundle exec rubocop

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+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/active_sms.rb$}) { rspec.spec_dir }
+  watch(%r{^lib/(.+)\.rb$}) { |m| rspec.spec.call(m[1]) }
+  watch(%r{^spec/support/(.+)\.rb$}) { |m| rspec.spec.call(m[1]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,35 @@
+# ActiveSMS
+
+[![Build Status](https://travis-ci.org/Fedcomp/active_sms.svg?branch=master)](https://travis-ci.org/Fedcomp/active_sms)
+
+Easily send sms using various sms backends!
+The gem is work in progress now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_sms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_sms
+
+## Usage
+
+To be done.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fedcomp/active_sms.
+
+
+## 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/active_sms.gemspec

@@ -0,0 +1,53 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_sms/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_sms"
+  spec.version       = ActiveSMS::VERSION
+  spec.authors       = ["Fedcomp"]
+  spec.email         = ["aglergen@gmail.com"]
+
+  spec.summary       = "Easily send sms using various sms backends!"
+  spec.description   = <<-DESCRIPTION
+                          Say you want to send sms in your app.
+                          You think it's simple.
+                          What (most likely) you do?
+                          you create simple class to do it.
+                          Then you need to mock it in tests,
+                          and need to use different backend
+                          in different environments, or even
+                          use multiple backends in single environment.
+                          This gems aims at solving most common cases
+                          for sending sms in your app
+                        DESCRIPTION
+
+  spec.homepage      = "https://github.com/Fedcomp/active_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"] = "https://rubygems.org"
+  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 { |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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "rubocop"
+end

data/lib/active_sms.rb

@@ -0,0 +1,10 @@
+require "active_sms/version"
+require "active_sms/backend/base"
+require "active_sms/backend/null_sender"
+require "active_sms/configuration"
+require "active_sms/response"
+require "active_sms/sending"
+
+# rubocop:ignore Style/Documentation
+module ActiveSMS
+end

data/lib/active_sms/backend/base.rb

@@ -0,0 +1,19 @@
+module ActiveSMS::Backend
+  # TODO: Documentation
+  # rubocop:ignore Style/Documentation
+  class Base
+    def initialize(params = {})
+    end
+
+    def send_sms(_phone, _text)
+      raise NotImplementedError,
+            "You should create your own class for every sms service you use"
+    end
+
+    protected
+
+    def respond_with_status(status)
+      ActiveSMS::Response.new(status: status)
+    end
+  end
+end

data/lib/active_sms/backend/null_sender.rb

@@ -0,0 +1,7 @@
+# Sms backend to not send anything.
+# Purely for usage in tests
+class ActiveSMS::Backend::NullSender < ActiveSMS::Backend::Base
+  def send_sms(_phone, _text)
+    respond_with_status :success
+  end
+end

data/lib/active_sms/configuration.rb

@@ -0,0 +1,69 @@
+# rubocop:ignore Style/Documentation
+module ActiveSMS
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.reset!
+    @@config = nil
+  end
+
+  # TODO: Documentation
+  # rubocop:ignore Style/Documentation
+  class Configuration
+    attr_reader :default_backend
+    attr_reader :backends
+
+    def initialize
+      register_backend :null_sender, ActiveSMS::Backend::NullSender
+      self.default_backend = :null_sender
+    end
+
+    def default_backend=(value)
+      raise ArgumentError, "default_backend must be a symbol!" unless value.is_a? Symbol
+
+      unless @backends.keys.include? value
+        raise ArgumentError, "Unregistered backend cannot be set as default!"
+      end
+
+      @default_backend = value
+    end
+
+    def register_backend(key, classname, params = {})
+      raise ArgumentError, "backend key must be a symbol!" unless key.is_a? Symbol
+
+      unless classname.class == Class
+        raise ArgumentError, "backend class must be class (not instance or string)"
+      end
+
+      unless classname.method_defined? :send_sms
+        raise ArgumentError, "backend must provide method send_sms"
+      end
+
+      define_backend(key, classname, params)
+    end
+
+    def remove_backend(key)
+      if key == default_backend
+        raise ArgumentError, "Removing default_backend is prohibited"
+      end
+
+      @backends.delete key
+      true
+    end
+
+    private
+
+    def define_backend(key, classname, params)
+      @backends ||= {}
+      @backends[key] = {
+        class: classname,
+        params: params
+      }
+    end
+  end
+end

data/lib/active_sms/response.rb

@@ -0,0 +1,16 @@
+# rubocop:ignore Style/Documentation
+class ActiveSMS::Response
+  attr_reader :status
+
+  def initialize(args = {})
+    @status = args.delete(:status)
+  end
+
+  def success?
+    @status == :success
+  end
+
+  def failed?
+    !success?
+  end
+end

data/lib/active_sms/sending.rb

@@ -0,0 +1,19 @@
+# rubocop:ignore Style/Documentation
+module ActiveSMS
+  class << self
+    def send_sms(phone, text)
+      current_backend.new(current_backend_params)
+                     .send_sms(phone, text)
+    end
+
+    def current_backend
+      ActiveSMS.config.backends[ActiveSMS.config.default_backend][:class]
+    end
+
+    private
+
+    def current_backend_params
+      ActiveSMS.config.backends[ActiveSMS.config.default_backend][:params]
+    end
+  end
+end

data/lib/active_sms/version.rb

@@ -0,0 +1,3 @@
+module ActiveSMS
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: active_sms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fedcomp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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'
+- !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'
+description: |2
+                            Say you want to send sms in your app.
+                            You think it's simple.
+                            What (most likely) you do?
+                            you create simple class to do it.
+                            Then you need to mock it in tests,
+                            and need to use different backend
+                            in different environments, or even
+                            use multiple backends in single environment.
+                            This gems aims at solving most common cases
+                            for sending sms in your app
+email:
+- aglergen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_sms.gemspec
+- lib/active_sms.rb
+- lib/active_sms/backend/base.rb
+- lib/active_sms/backend/null_sender.rb
+- lib/active_sms/configuration.rb
+- lib/active_sms/response.rb
+- lib/active_sms/sending.rb
+- lib/active_sms/version.rb
+homepage: https://github.com/Fedcomp/active_sms
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easily send sms using various sms backends!
+test_files: []