ruby_sms 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea160872cb23ddfa9480048f56c90401c1ec78fb
+  data.tar.gz: 07fb92cc9f35ecb64ec76ee4aa834ceb90213386
+SHA512:
+  metadata.gz: 737b03479a6b4f9779c265261ca9e3053437160e5dc73450ada6bb1b955429212d0bf34c53a42c86b468a0a150d1837b151469e7e57e03de9c1a02b59ad928a7
+  data.tar.gz: 7e2af8bec903eab9889c5525e97cc65603b20267bae32b3bd328c63030dba073618a9485256d28c4bcb4f50eb75e99b975b330e022a24ea3a65303afb806946a

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.rubocop.yml

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 carnifun
+
+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,30 @@
+# ruby_sms
+simple way to send sms using sms77 or any other short message api provider  
+A Ruby client library for [Sms77][more to come].
+
+## Getting started
+
+To install **ruby_sms**, run the following command:
+
+```
+  gem install ruby_sms
+```
+
+Or if you are using **bundler**, add
+
+```
+  gem 'ruby-sms', '~>1.0'
+```
+
+to your `Gemfile`, and run `bundle install`
+
+```ruby
+require "ruby_sms"
+sms = RubySms.new(api_key: "1234123", user: "user@email.com")
+response = sms.send(message: "your message", to: "+49178223", delay: false)
+if response.success? 
+  puts "Sms deliverd " 
+else
+  puts response.errors
+end
+```

data/lib/gateway/response.rb

@@ -0,0 +1,50 @@
+module RubySms
+  module Gateway
+    class Response
+      attr_accessor :errors
+      def initialize
+        self.errors = []
+      end
+
+      def success?
+        errors.empty?
+      end
+    end
+
+    class Sms77Response < Response
+      attr_accessor :pin
+      SMS77_ERROR_CODES = {
+        '100' => '100: SMS delivered successfully',
+        '101' => '101: Delivery to at least one recipient failed',
+        '201' => '201: Sender illegal',
+        '202' => '202: Recipient number illegal',
+        '300' => '300: Missing username or password',
+        '301' => '301: Argument "to" missing',
+        '304' => '304: Argument "type" missing',
+        '305' => '305: Argument "text" missing',
+        '306' => '306: Sender number illegal',
+        '307' => '307: Argument "url" missing',
+        '400' => '400: Argument "type" invalid',
+        '401' => '401: Argument "text" too long',
+        '402' => '402: Reload lock - same SMS sent within 90 seconds',
+        '500' => '500: Not enough credits',
+        '600' => '600: Carrier delivery failed',
+        '700' => '700: Unknown error',
+        '801' => '801: Logo file not set',
+        '802' => '802: Logo file does not exist',
+        '803' => '803: Ring tone not set',
+        '900' => '900: Given credentials not valid',
+        '901' => '901: Message ID invalid',
+        '902' => '902: HTTP API not activated for this account',
+        '903' => '903: Server IP invalid',
+        '11' => '11: SMS carrier temporarily not available',
+        '0' => 'Error: Status code does not exist'
+      }.freeze
+
+      def add_error(error_code, _options = {})
+        error_message = SMS77_ERROR_CODES[error_code] || error_code.to_s
+        errors << error_message
+      end
+    end
+  end
+end

data/lib/gateway/sms77.rb

@@ -0,0 +1,73 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module RubySms
+  module Gateway
+    class Sms77
+      attr_accessor :api_key, :user
+
+      SMS77_GATEWAY_URL = 'https://gateway.sms77.io/api/sms'.freeze
+      SUCCESS_CODE	= '100'.freeze
+      DEFAULT_PIN_SIZE	= 4
+
+      def initialize(options)
+        return if options[:user].nil?
+        return if options[:api_key].nil?
+
+        self.user = options[:user]
+        self.api_key = options[:api_key]
+      end
+
+      def send(options)
+        response = Sms77Response.new
+        (response.add_error(:empty_options) && (return response)) if options.nil?
+        code = post_request(options)
+        return response if code == SUCCESS_CODE
+        response.add_error(code)
+        response
+      end
+
+      # generate a simple random 4 digits pin
+      def send_pin(options)
+        response = Sms77Response.new
+        (response.add_error(:empty_options) && (return response)) if options.nil?
+        # we may use SecureRandom.hex(size) if you need a more secure pin
+        response.pin = rand.to_s[2..(DEFAULT_PIN_SIZE + 1)]
+        options[:text].gsub!('%PIN%', response.pin)
+        code = post_request(options)
+        return response if code == SUCCESS_CODE
+        response.add_error(code)
+        response
+      end
+
+      private
+
+      def post_request(options)
+        uri = URI.parse(SMS77_GATEWAY_URL)
+        request = Net::HTTP::Post.new(uri.to_s)
+        request.set_form_data(
+          text:  options[:text].force_encoding('utf-8'),
+          to: 	 options[:to],
+          delay: options[:delay] || 0,
+          debug: 0,
+          utf8:  1,
+          u: user,
+          p: api_key
+        )
+        response = https(uri).request(request)
+        response.body
+      rescue StandardError => e
+        RubySms.logger.error("Error while sending post request => #{e}")
+        :connection_error
+      end
+
+      def https(uri)
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+    end
+  end
+end

data/lib/ruby_sms.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'logger'
+require 'gateway/sms77'
+require 'gateway/response'
+
+module RubySms
+  class << self
+    def logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::ERROR
+      @logger
+    end
+
+    def logger=(log_instance)
+      raise ArgumentError, 'Logger parameter must be a Logger object' unless log_instance.is_a?(Logger)
+      @logger = log_instance
+    end
+
+    def new(options = {})
+      case options[:gw]
+      when :sms99
+        'NOT IMPLEMENTED'
+      else
+        RubySms::Gateway::Sms77.new(options)
+      end
+    end
+  end
+end

data/ruby_sms.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'ruby_sms'
+  s.version     = '1.0.1'
+  s.date        = '2017-07-12'
+  s.summary     = "A simple Sms client "
+  s.description = "simple way to send sms using sms77 or any other short message api provider"
+  s.authors     = ["Mohamed Elassadi"]
+  s.email       = 'mohamed.elassadi@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/carnifun/ruby_sms'
+  s.license     = 'MIT'
+
+end

data/rubysms.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'ruby_sms'
+  s.version     = '1.0.0'
+  s.date        = '2017-07-12'
+  s.summary     = "A simple Sms client "
+  s.description = "simple way to send sms using sms77 or any other short message api provider"
+  s.authors     = ["Mohamed Elassadi"]
+  s.email       = 'mohamed.elassadi@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/carnifun/ruby_sms'
+  s.license     = 'MIT'
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: ruby_sms
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Mohamed Elassadi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies: []
+description: simple way to send sms using sms77 or any other short message api provider
+email: mohamed.elassadi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/gateway/response.rb
+- lib/gateway/sms77.rb
+- lib/ruby_sms.rb
+- ruby_sms.gemspec
+- rubysms.gemspec
+homepage: https://github.com/carnifun/ruby_sms
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A simple Sms client
+test_files: []