smsone-sms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 614845103b591c2c5aff81ec883ff8387c488404
+  data.tar.gz: 64bf67853fd74794ee7d734fc7a18ef226a1e7ea
+SHA512:
+  metadata.gz: ccaa77dd2bdd027ea3bce749d303417bbef9c17080826611dc832138797b031b99ee3d9333e93bc8359bd407c186a2a558fe9f315b8e821016bb133ae510dc3b
+  data.tar.gz: e8f9fe39860e2313ca30b5f12dd1a89336c1657536fdf81b475f41d1af2643556e615a183f1fc0bba5d38c9a3f57540a4ee6c46e50a3a1f5fe76245653b7cf6c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 miclovich
+
+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,31 @@
+# Smsone::Sms
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smsone-sms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smsone-sms
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/smsone-sms/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/smsone/sms.rb

@@ -0,0 +1,108 @@
+# encoding: UTF-8
+require 'net/http'
+require 'uri'
+require "smsone/sms/version"
+
+module Smsone
+  module Sms
+    #################
+    # status codes
+    success_status_code = 0
+    auth_failure_status_code = 1
+    insufficient_fund_status_code = 2
+    unauthorized_destination_status_code = 3
+
+    def make_http_call call, options={}
+      uri = URI("http://sms.smsone.co.ug:8866/cgi-bin/#{call}")
+      http_obj = Net::HTTP.new uri.host, uri.port
+      request = Net::HTTP::Post.new uri
+
+      response = http_obj.start do |http|
+        post_data = URI.encode_www_form options[:payload]
+        http.request(request, post_data)
+      end
+      response
+    end
+
+    ###################
+    # makes an API call to SMSONE
+    def make_http_call call, options={}
+      uri = URI("http://sms.smsone.co.ug:8866/cgi-bin/#{call}")
+      http_obj = Net::HTTP.new uri.host, uri.port
+      request = Net::HTTP::Post.new uri
+
+      response = http_obj.start do |http|
+        post_data = URI.encode_www_form options[:payload]
+        http.request(request, post_data)
+      end
+      response
+    end
+
+    def send_sms username, password, msidn, from_who, text
+      # Sends a message through a pre-configured short code
+      # Params:
+      # +username+:: username to access system
+      # +password+:: password to access system
+      # +msidn+:: MSIDN refers to the full phone number with country code
+      # +from_who+:: keyword or label that identifies who sent SMS
+      # +text+:: Text is the actual content or message
+
+      response = make_http_call 'sendsms',
+                            :payload => {
+                              'mocean-username' => username,
+                              'mocean-password' => password,
+                              'mocean-to' => msidn,
+                              'mocean-from' => from_who,
+                              'mocean-text' => text
+                            }
+      response
+    end
+
+    def request_balance username, password
+      # Requests the amount of credit or balance left
+      # Params:
+      # +username+:: username to access the bloody system
+      # +password+:: yeah, you need a password to get in
+
+      response = make_http_call 'requestbalance',
+                                  :payload=>{
+                                    "mocean-username" => username,
+                                    "mocean-password" => password
+                                  }
+
+      to_ret = {:response => response, :response_hash => nil}
+
+      if response.body.match /status=0/
+        to_ret[:response_hash] ={
+          body: response.body,
+          success: true,
+          error_message: nil,
+          api_status_code: 0,
+          response_code: response.code
+        }
+      end
+
+      if response.body.match /status=1/
+        to_ret[:response_hash] = {
+          body: response.body,
+          success: false,
+          error_message: "Authorization failed",
+          api_status_code: 1,
+          response_code: response.code
+        }
+      end
+
+      if response.body.match /status=3/
+        to_ret[:response_hash] = {
+          body: response.body,
+          success: false,
+          error_message: "Unauthorized destination status",
+          api_status_code: 3,
+          response_code: response.code
+        }
+      end
+      to_ret
+    end
+
+  end
+end

data/lib/smsone/sms/version.rb

@@ -0,0 +1,5 @@
+module Smsone
+  module Sms
+    VERSION = "0.0.1"
+  end
+end

data/smsone-sms.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smsone/sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smsone-sms"
+  spec.version       = Smsone::Sms::VERSION
+  spec.authors       = ["miclovich"]
+  spec.email         = ["vicmiclovich@gmail.com"]
+  spec.summary       = %q{Interact with the SMSONE API to send SMS or find out about credit balance}
+  spec.description   = %q{Well, this abstracts the hard work to get a message out, right!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0", '>= 3.0.0'
+  spec.add_development_dependency "webmock"
+end

data/spec/sms_spec.rb

@@ -0,0 +1,57 @@
+require './lib/smsone/sms'
+
+
+# TODO
+# Test code for the following scenarios
+# - 3 possible errors (out of numerous ones... get MVP out)
+# - complete request balance test code
+
+class Messaging; include Smsone::Sms; end
+
+describe Messaging do
+  describe 'sending out messages' do
+    before do
+      ResponseObjClass = Struct.new(:username, :password) do
+        def code
+          '202'
+        end
+
+        def body
+          'status=0&msgid=sms0512064727974228'
+        end
+
+        def response
+          nil
+        end
+      end
+
+      resp_obj = ResponseObjClass.new 'username', 'password'
+      resp = {:response => resp_obj}
+
+      expect_any_instance_of(Messaging).to receive(:request_balance).and_return(resp)
+    end
+
+    let(:messaging) { Messaging.new }
+
+    it 'responds to #send_sms' do
+      response = messaging.send_sms 'username',
+                                          'password',
+                                          '256772501811',
+                                          'ensi',
+                                          'hi there'
+      expect(response.code).to eq "202"
+      expect(response.body).to eq 'status=0&msgid=sms0512064727974228'
+    end
+  end
+
+  describe 'checking balance of credits' do
+
+    it 'responds to #request_balance' do
+      response = messaging.request_balance 'username', 'password'
+      expect(response[:response].code).to eq '202'
+      expect(response[:response].body).to eq 'status=0& total_credit_bal=95.000'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'sms'
+require 'webmock/rspec'
+WebMock.disable_net_connect! allow_localhost: true
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:post, /sms.smsone.co.ug/).
+      with(headers: {'Accept' => '*/*', 'User-Agent'=> 'Ruby'}).
+      to_return(status: 200, body: 'stubbed response', headers: {})
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: smsone-sms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- miclovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Well, this abstracts the hard work to get a message out, right!
+email:
+- vicmiclovich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smsone/sms.rb
+- lib/smsone/sms/version.rb
+- smsone-sms.gemspec
+- spec/sms_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Interact with the SMSONE API to send SMS or find out about credit balance
+test_files:
+- spec/sms_spec.rb
+- spec/spec_helper.rb