helliomessaging_sms 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83232f131baa32c87143345532d6f48ad373ff91
+  data.tar.gz: 89b866d3aade733cda8b9c16ca7adfce313442c4
+SHA512:
+  metadata.gz: b0cace689c5957282e9f9ad1f2ed89cfc2159fc1bc17ec934d094f2f17b841cbf68becef5265c5f4f2e8af893aa3bcf541fa2e844536de98f10cfc414791aed1
+  data.tar.gz: 4b3a73d4ba186e3f2b737108987683c1d1c8ccbec8b22094003757de02333ff766dc26813548df13633c9c2c1394a9187046759eb7a7262ec793a6a3304312e3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smsgh_sms.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Albert A. Ninyeh
+
+MIT License
+
+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,61 @@
+# helliomessaging_sms
+
+This is a ruby wrapper that abstracts Hellio Messaging SMS API. This gem has extra features and simplicity which makes it seamlessly easy to Send Bulk SMS, Check Balance and Receive delivery report.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'helliomessaging_sms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install helliomessaging_sms
+
+## Usage
+
+Create an Account with Hellio Messaging via https://helliomessaging.com and head to your account settings to generate your API credentials which could be the old Username and Password sort of authentication or using a Consumer Key and an Application Serect.
+
+If you are using the old API (V1) then
+
+	helliomessaging_sms.api_username = "YOUR_USERNAME"
+	helliomessaging_sms.api_password = "YOUR_PASSWORD"
+
+If you are using the new API (V2) then
+
+	helliomessaging_sms.api_consumer_id = "YOUR_CONSUMER_KEY"
+	helliomessaging_sms.api_application_secret = "YOUR_APPLICATION_SECRET"
+	
+Optionally set global Sender ID
+
+	helliomessaging_sms.api_senderid = "YOUR_SENDERID"
+	
+Sending an SMS Message
+
+	helliomessaging_sms.push(:to => 'PHONE-NUMBER', :msg => "Your SMS Message goes here")
+	
+How to override the global SENDER ID config
+
+	helliomessaging_sms.push(:to => 'PHONE-NUMBER', :msg => "Your SMS Message goes here", :from => "SENDERID")
+	
+Sample Results Returned
+
+	{:status=>200, :notice=>"OK: 62357215"}
+	
+Any returned status code other than 200 is a failed response.
+
+## About Hellio Messaing
+
+Hellio Messaing is the premier messaging company in Ghana. Find out more about them at https://helliomessaing.com
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/helliomessaging_sms.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/helliomessaging_sms/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Albert A. Ninyeh"]
+  gem.email         = ["albert@sarayu.co"]
+  gem.description   = %q{This is a ruby wrapper that abstracts Hellio Messaging SMS API. This gem has extra features and simplicity which makes it seamlessly easy to Send Bulk SMS, Check Balance and Receive delivery report.}
+  gem.summary       = %q{Send SMS via Hellio Messaging's API}
+  gem.homepage      = "https://github.com/nukturnal/helliomessaging_sms"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "helliomessaging_sms"
+  gem.require_paths = ["lib"]
+  gem.version       = HellioMessaging::VERSION
+  gem.add_dependency "curb-fu", "~> 0"
+  gem.add_dependency "nokogiri"
+end

data/lib/helliomessaging_sms.rb

@@ -0,0 +1,53 @@
+require "helliomessaging_sms/version"
+require 'cgi'
+require 'curb-fu'
+require 'nokogiri'
+
+module HellioMessaging
+  @@api_username = nil
+  @@api_password = nil
+  @@api_client_id = nil
+  @@api_client_secret = nil
+  @@api_senderid = "HELLIOMESSAGINGAPI"
+
+  # Expects :msg, :to and an optional :from param
+  # The :from param defaults to @@api_senderid when its omitted
+  def self.push(options={})
+
+    sender_id = options[:from].nil? ? @@api_senderid : options[:from]
+    response = nil
+    message = options[:msg]
+
+    raise ArgumentError, ':msg and :to params expected' if message.nil? || options[:to].nil?
+
+    message = Nokogiri::HTML.parse(message).text
+
+    if @@api_username != nil && @@api_password != nil
+      response = CurbFu.get({:host => 'app.helliomessaging.com/api', :path => '/sms?'}, { :from => sender_id, :to => options[:to], :text => message, :username => @@api_username, :password => @@api_password })
+    end
+
+    if @@api_client_id != nil && @@api_client_secret != nil
+      response = CurbFu.get({:host => 'app.helliomessaging.com/api', :path => '/sms?', :protocol => 'http'}, { :From => sender_id, :To => options[:to], :Content => message, :ClientId => @@api_client_id, :ClientSecret => @@api_client_secret })
+    end
+
+    {:status => response.status, :notice => response.body}
+
+  end
+
+
+  def self.api_username=(api_username); @@api_username = api_username; end
+  def self.api_username; @@api_username; end
+
+  def self.api_password=(api_password); @@api_password = api_password; end
+  def self.api_password; @@api_password; end
+
+  def self.api_client_id=(api_client_id); @@api_client_id = api_client_id; end
+  def self.api_client_id; @@api_client_id; end
+
+  def self.api_client_secret=(api_client_secret); @@api_client_secret = api_client_secret; end
+  def self.api_client_secret; @@api_client_secret; end
+
+  def self.api_senderid=(api_senderid); @@api_senderid = api_senderid; end
+  def self.api_senderid; @@api_senderid; end
+
+end

data/lib/helliomessaging_sms/version.rb

@@ -0,0 +1,3 @@
+module HellioMessaging
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: helliomessaging_sms
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Albert A. Ninyeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb-fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a ruby wrapper that abstracts Hellio Messaging SMS API. This
+  gem has extra features and simplicity which makes it seamlessly easy to Send Bulk
+  SMS, Check Balance and Receive delivery report.
+email:
+- albert@sarayu.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- helliomessaging_sms.gemspec
+- lib/helliomessaging_sms.rb
+- lib/helliomessaging_sms/version.rb
+homepage: https://github.com/nukturnal/helliomessaging_sms
+licenses: []
+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: Send SMS via Hellio Messaging's API
+test_files: []