any_sms-backend-smsru 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54b4bd48dc806b731a2a3008662c80ee9421aac4
+  data.tar.gz: 33e93b11df8caa71d2c18574ffdd7d52bb86e919
+SHA512:
+  metadata.gz: 0d901d3eed5acd66bf49f6bdef10aacb4bcd8f4158d400a05ce15c6f0527122976ab02de0a92556124d10466ebda754007f299ac50a06af540541cfecb108aca
+  data.tar.gz: 8cf3e4f9e369796bd9ecab00226d46a508c725dab4492d239291c42c84fca43c4398ed805f7936b7f5b977a1ed123eba5b3236ccc12eaed5d577464227faa8c3

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - "lib/any_sms-backend-smsru.rb"
+
+Metrics/BlockLength:
+  Exclude:
+      - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Metrics/LineLength:
+  Max: 90
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

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

data/Guardfile

@@ -0,0 +1,14 @@
+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)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+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,69 @@
+# AnySMS sms.ru backend
+
+[![Build Status](https://travis-ci.org/Fedcomp/any_sms-backend-smsru.svg?branch=master)](https://travis-ci.org/Fedcomp/any_sms-backend-smsru)
+[![Gem Version](https://badge.fury.io/rb/any_sms-backend-smsru.svg)](https://badge.fury.io/rb/any_sms-backend-smsru)
+
+backend for [AnySMS](https://github.com/Fedcomp/any_sms) to work with [sms.ru](https://sms.ru)
+
+## Installation and usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "any_sms-backend-smsru", "~> 0.1.0"
+```
+
+Then somewhere in your initialization code:
+
+```ruby
+require "any_sms-backend-smsru"
+
+AnySMS.configure do |c|
+  c.register_backend :my_main_backend,
+                     AnySMS::Backend::Smsru,
+                     api_id: ENV["SMSRU_TOKEN"]
+
+  c.default_backend = :my_main_backend
+end
+```
+
+Now, whenever you need to send SMS, just do:
+
+```ruby
+phone = "799999999"
+text = "My sms text"
+
+# Should actually send sms
+AnySMS.send_sms("79999999999", "text")
+```
+
+For more advanced usage please
+go to [AnySMS documentation](https://github.com/Fedcomp/any_sms#real-life-example)
+
+**Don't forget**, you need to put real *api_id* in SMSRU_TOKEN environment variable.
+In bash you would do it like that:
+```bash
+export SMSRU_TOKEN "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+```
+Read below how to receive own token to work with sms.ru.
+
+# Receiving api_id from sms.ru
+
+First of all, you should register on https://sms.ru/ .
+Then, when you are registered, make sure you have
+some small amount of balance to actually send sms.
+On your main page (when you are logged)
+you should see:
+
+![api_id block at the right](screenshot.png)
+
+instead of XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX you should see your actual api_id key.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/Fedcomp/any_sms-backend-smsru
+
+## 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-smsru.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "any_sms/backend/smsru/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "any_sms-backend-smsru"
+  spec.version       = AnySMS::Backend::SMSRU_VERSION
+  spec.authors       = ["Fedcomp"]
+  spec.email         = ["aglergen@gmail.com"]
+
+  spec.summary       = "AnySMS backend for sms.ru service"
+  spec.homepage      = "https://github.com/Fedcomp/any_sms-backend-smsru"
+  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 { |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_dependency "any_sms", "~> 0.4.0"
+
+  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 "webmock", "~> 2.1"
+
+  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
+# rubocop:enable Metrics/BlockLength

data/example/.gitignore

@@ -0,0 +1 @@
+.envrc

data/example/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "any_sms-backend-smsru", path: "../../"

data/example/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: ../..
+  specs:
+    any_sms (0.4.0)
+    any_sms-backend-smsru (0.1.0)
+      any_sms (~> 0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  any_sms-backend-smsru!
+
+BUNDLED WITH
+   1.16.1

data/example/README.md

@@ -0,0 +1,22 @@
+# Simple sending script example
+
+I use it for acceptance testing of this gem. This code should be always working, if not, please open an issue.
+
+# Setup
+You need to set these enviroment variables before using it:
+```sh
+export SMSRU_TOKEN=XXXXXXXXXXXXXXXXXXXX
+export MY_PHONE_NUMBER=+10000000000 # Set your phone number
+```
+
+Check gem readme on how to get `SMSRU_TOKEN`.
+
+# Running
+Install gem deps,
+then just add execution permission to the script and run it:
+
+```sh
+$ bundle install
+$ chmod +x send.rb
+$ ./send.rb
+```

data/example/send.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+require "any_sms-backend-smsru"
+
+# Initializer code
+AnySMS.configure do |c|
+  c.register_backend :my_main_backend,
+                     AnySMS::Backend::Smsru,
+                     api_id: ENV["SMSRU_TOKEN"]
+
+  c.default_backend = :my_main_backend
+end
+
+# Anywhere in your app
+text = "some sms text"
+resp = AnySMS.send_sms(ENV["MY_PHONE_NUMBER"], text)
+
+# immediate response check
+if resp.success?
+  puts "Sms should be sent to #{ENV['MY_PHONE_NUMBER']} with text: #{text.inspect}"
+else
+  puts "There was error sending sms (#{resp.status}): "
+  raise resp.meta[:error]
+end

data/lib/any_sms-backend-smsru.rb

@@ -0,0 +1,2 @@
+# missing file for gem to work with autoloading
+require "any_sms/backend/smsru"

data/lib/any_sms/backend/smsru.rb

@@ -0,0 +1,55 @@
+require "net/http"
+require "bigdecimal"
+require "bigdecimal/util"
+require "any_sms"
+
+class AnySMS::Backend::Smsru < AnySMS::Backend::Base
+  API_URL = "http://sms.ru/sms/send".freeze
+  API_STATUS_CODE = {
+    success: 100
+  }.freeze
+
+  def initialize(api_id:)
+    @api_id = api_id
+    validate_api_id
+  end
+
+  def send_sms(phone, sms_text, _args = {})
+    data = parse(request_api(to: phone, text: sms_text))
+
+    case data[:status]
+    when API_STATUS_CODE[:success]
+      respond_with_status :success
+    else
+      respond_with_status "unhandled_status_#{data[:status]}".to_sym,
+                          meta: { error: "Error, code: #{data[:status]}" }
+    end
+  rescue StandardError => e
+    respond_with_status :runtime_error, meta: { error: e }
+  end
+
+  private
+
+  def validate_api_id
+    raise ArgumentError, "Your api_id is not set" if @api_id.nil?
+
+    return if @api_id =~ /\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/
+    raise ArgumentError, "Your api_id has invalid format"
+  end
+
+  def request_api(params = {})
+    params = params.merge(api_id: @api_id)
+    Net::HTTP.post_form(URI.parse(API_URL), params).body
+  end
+
+  def parse(response)
+    status, sms_id, balance = response.strip.split("\n")
+    status = status.to_i
+    balance = balance.split("=").last.to_d if balance
+
+    response = { status: status }
+    response[:balance] = balance if balance
+    response[:sms_id]  = sms_id if sms_id
+    response
+  end
+end

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

@@ -0,0 +1,7 @@
+# rubocop:disable Style/ClassAndModuleChildren
+module AnySMS
+  module Backend
+    SMSRU_VERSION = "0.1.0".freeze
+  end
+end
+# rubocop:enable Style/ClassAndModuleChildren

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: any_sms-backend-smsru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fedcomp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-01 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.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !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: 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: 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: 
+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-smsru.gemspec
+- example/.gitignore
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/send.rb
+- lib/any_sms-backend-smsru.rb
+- lib/any_sms/backend/smsru.rb
+- lib/any_sms/backend/smsru/version.rb
+- screenshot.png
+homepage: https://github.com/Fedcomp/any_sms-backend-smsru
+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.14
+signing_key: 
+specification_version: 4
+summary: AnySMS backend for sms.ru service
+test_files: []