sms_portal 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a8b21cfdee4fddaca026e1c834cb39b1c20ddb7
-  data.tar.gz: f7990c0bf6457ceb414e55cb067cad09a6ec4194
+SHA256:
+  metadata.gz: a8a1b432df2ed4f81a595a458a445dee7eb0b2bdc957073fa18ee1903c26b9ae
+  data.tar.gz: d45cc4bcfa6410ee3d370465c93ca7eec043b769db87d3d1e4434751b1815f17
 SHA512:
-  metadata.gz: d853a970da950226ede0347ef4a7b6cda7521688fd47914ae833486463fd5751510ada66ab3dac913392cd5ddcc9c07fcae874122bd38cfbd5c3c714dbbfe10e
-  data.tar.gz: a92fa4e45494e5dfeb9188ea00a11bac5af6e32698c4da5012ea3fd0787db7bf18bdb0a41620a174e1d2b250719baf0714f837dee5108d66ce21c364d3065c21
+  metadata.gz: d5c242adec90dceb5e99a9e165c902c3a04a00a4506ac1124930d4c8ccfd6ecbb4460f24efc9cb55393436218444adc8667fa27dd427c51d1ba505a377586dc3
+  data.tar.gz: f7ab7bcee8c43113434c0bf83a6ad70d5b1d00e421c94ef0d2b8286c07e33062adb8541e2d89baba064d6d0aac91e4744475344673d32722932c1b06be267cb3

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sms_portal.gemspec
 gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -4,15 +4,51 @@ Send SMS messages using [SMSPortal](http://www.smsportal.co.za)
 
 ## Installation
 
-Install the gem:
+Install the latest release
 
-    $ gem install sms_portal
+```
+$ gem install sms_portal
+```
 
-Then set your credentials:
+Or add it to your Gemfile
 
-    $ export SMS_PORTAL_USERNAME=sms_portal_username
-    $ export SMS_PORTAL_PASSWORD=sms_portal_password
+```
+gem 'sms_portal', '0.1.0'
+```
+
+## Configuration
+
+Either set the following environment variables
+
+```
+$ export SMS_PORTAL_USERNAME=sms_portal_username
+$ export SMS_PORTAL_PASSWORD=sms_portal_password
+```
+
+Or in Rails, you can create an initializer
+
+```
+# config/initializers/sms_portal.rb
+
+SmsPortal.configure do |config|
+  config.username = sms_portal_username
+  config.password = sms_portal_password
+end
+```
+
+To intercept messages in testing/development environments there is an extra configuration option to route all messages to that number.
+```
+# as environment variable
+$ export SMS_PORTAL_INTERCEPTOR=phone_number
+
+# or in config/initializers/sms_portal.rb
+SmsPortal.configure do |config|
+  config.interceptor = phone_number
+end
+```
 
 ## Usage
 
-	SmsPortal.deliver('0821234567', 'Your message body here')
+```
+SmsPortal.deliver('0821234567', 'Your message body here')
+```

data/lib/sms_portal/config.rb

@@ -1,10 +1,11 @@
 module SmsPortal
   class Config
-    attr_accessor :username, :password
+    attr_accessor :username, :password, :interceptor
 
     def initialize
       @username = ENV['SMS_PORTAL_USERNAME']
       @password = ENV['SMS_PORTAL_PASSWORD']
+      @interceptor = ENV['SMS_PORTAL_INTERCEPTOR']
     end
   end
 end

data/lib/sms_portal/message.rb

@@ -3,20 +3,21 @@ module SmsPortal
     include HTTParty
     base_uri "http://www.mymobileapi.com"
 
-    def initialize(number, message)
+    def initialize(recipient, message)
       @options = {
         query: {
-          numto:     number,
+          numto:     SmsPortal.config.interceptor || recipient,
           data1:     message,
           type:     'sendparam',
           username:  SmsPortal.config.username,
           password:  SmsPortal.config.password
-        }
+        },
+        format: :xml
       }
     end
 
     def deliver!
-      self.class.get('/api5/http5.aspx', @options)
+      self.class.get('/api5/http5.aspx', @options).parsed_response
     end
   end
 end

data/lib/sms_portal/version.rb

@@ -1,3 +1,3 @@
 module SmsPortal
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/sms_portal.rb

@@ -16,8 +16,8 @@ module SmsPortal
     yield(config)
   end
 
-  def self.deliver(number, message)
-    message = Message.new(number, message)
+  def self.deliver(recipient, message)
+    message = Message.new(recipient, message)
     message.deliver!
   end
 end

data/sms_portal.gemspec

@@ -17,7 +17,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httparty"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_portal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Wiehann Radyn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,35 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: 
+description:
 email:
 - wradyn@gmail.com
 executables: []
@@ -73,7 +45,7 @@ homepage: https://github.com/wiehann/sms_portal
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +60,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Send SMS messages using SMSPortal
 test_files: []