sms_factor 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8196e46faf3a9cda27c4944ee3e4dc31afa0021
+  data.tar.gz: ca31b56daf07212145abfe3a5a72db2ed5f37328
+SHA512:
+  metadata.gz: d590cc2cfc3427cf948aba5c50589891a6dd06703b6c6c3cdf337f7e76271498537a273800d91ec11910aa0b85f13c7a2ff29f9ba58e2e0756a604c59fafb16b
+  data.tar.gz: e08233e3324543fb5f6e6ce8e4a1ac0de57058cab01fd3b2b561095544cde5cf5c9cc7289a5f8a9744d6b12e079114dc3b5004cba70b83936278816bf1f9ca86

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,40 @@
+== SMS Factor
+
+An easy way to use API SMS of http://www.smsfactor.com/ (http://www.smsfactor.com/api-sms/)
+
+== Installation
+
+You can install sms_factor by adding this line in your Gemfile :
+
+  gem 'sms_factor'
+
+And then :
+
+  bundle install 
+
+== Configuration
+
+To use this gem, configure SmsFactor using your API information :
+
+  SmsFactor::Init.configure do |config|
+    config.api_url          = 'http://api.smsfactor.com'
+    config.api_login        = '<your_email@your_company.com>'
+    config.api_password     = '<your_password>'
+    config.api_default_from = '<a_default_sender_name>'
+  end
+
+== Use
+
+To send a SMS :
+
+  r = SmsFactor.sms('Hello World', '336++++++++') # to a single recipient
+  r = SmsFactor.sms('Hello World', ['336++++++++', '336++++++++', '336++++++++']) # to multiple recipients
+  r = SmsFactor.sms('Hello World', '336++++++++', 'Toto') # to override default from
+
+To retrieve your credit after the sms was sent :
+
+  r.credit
+
+== Copyright
+
+Copyright (c) 2015 Julien Séveno

data/lib/sms_factor.rb

@@ -0,0 +1,65 @@
+require 'rest-client'
+require 'nokogiri'
+
+class SmsFactor
+  attr_accessor :message, :recipients, :sender
+  
+  def initialize(message, recipients, sender = nil)
+    raise "The configuration is not complete. Please define api_url, api_login, api_password and api_default_from" unless SmsFactor::Init.configuration.is_valid?
+    
+    @sender      ||= SmsFactor::Init.configuration.api_default_from
+    @recipients    = recipients.kind_of?(Array) ? recipients : [recipients]
+    @message       = message
+  end
+  
+  def build
+    {
+      sms: auth_credentials.merge(
+        message: {text: @message, sender: @sender, pushtype: 'alert'},
+          recipients: {
+            gsm: @recipients.collect{|recipient| {value: recipient}}
+          }
+      )
+    }
+  end
+  
+  def auth_credentials
+    @auth_credentials ||= {
+                            authentication: {
+                              username: SmsFactor::Init.configuration.api_login,
+                              password: SmsFactor::Init.configuration.api_password
+                            }
+                          }
+  end
+  
+  def deliver(delay: :now, check: false)
+    data  =   case delay
+                when nil, :now
+                  build
+                else
+                  build[:sms].merge!({delay: delay})
+                end
+                
+    url   =   "#{SmsFactor::Init.configuration.api_url}/send"
+    url   =   "#{url}/simulate" if check
+    
+    SmsFactor::SmsResponse.new(
+      RestClient.post(
+        url,
+        { data: data.to_json },
+        content_type: :json,
+        accept:       :json,
+        verify_ssl:   false
+      )
+    )
+  end
+  
+  def self.sms(message, recipients, sender = nil)
+    sms = SmsFactor.new(message, recipients, sender)
+    sms.deliver
+  end
+end
+
+require 'sms_factor/configuration'
+require 'sms_factor/init'
+require 'sms_factor/sms_response'

data/lib/sms_factor/configuration.rb

@@ -0,0 +1,7 @@
+class SmsFactor::Configuration
+  attr_accessor :api_url, :api_login, :api_password, :api_default_from
+  
+  def is_valid?
+    !api_url.nil? && !api_login.nil? && !api_password.nil? && !api_default_from.nil?
+  end
+end

data/lib/sms_factor/init.rb

@@ -0,0 +1,11 @@
+class SmsFactor::Init
+  attr_accessor :configuration
+  
+  def self.configuration
+    @configuration ||= SmsFactor::Configuration.new
+  end
+  
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/sms_factor/sms_response.rb

@@ -0,0 +1,20 @@
+class SmsFactor::SmsResponse
+  attr_accessor :response
+  
+  def initialize(response)
+    @response = JSON.parse(response)
+  end
+  
+  def success?
+    @response['status'] == 1
+  end
+  
+  def message
+    @response['message']
+  end
+  
+  def method_missing(m, *args, &block)
+    super unless @response.keys.include?(m.to_s)
+    @response[m.to_s]
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sms_factor
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Julien Séveno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: An easy way to use API SMS of http://www.smsfactor.com/ (http://www.smsfactor.com/api-sms)
+email: jseveno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/sms_factor.rb
+- lib/sms_factor/configuration.rb
+- lib/sms_factor/init.rb
+- lib/sms_factor/sms_response.rb
+homepage: https://github.com/juseveno/sms_factor
+licenses:
+- LGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- rest-client, >= 1.8.0
+- An account on http://www.smsfactor.com/
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An easy way to send SMS through SmsFactor API
+test_files: []