isms-ruby 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fe1b7f6c03bd3fb17bfb4b466644c86a769e2c5
+  data.tar.gz: 62724a048a34d6aba997144d4bd7c83ef7b2e45e
+SHA512:
+  metadata.gz: 3cb7cc7595fbc2646b6cedc3b4130c169904dee5784bf3a64b82f9af476fda98d246a21b31080bc6667a91fde15fe7d580a3a7304674ff3f0d2e1077be1ef02a
+  data.tar.gz: d16acea19b2ebfb7a2ae270b4a2cd3403fd9f2f17c974888d9eb8d035d9d615bf3a1e14e8693b1c36f160a8e7b114a4003d784a5f79e075bdc4075dd838a9ba4

data/.gitignore

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

data/.idea/.name

@@ -0,0 +1 @@
+isms-ruby

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.idea/encodings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>

data/.idea/isms-ruby.iml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/lib" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.7.1.pre.3, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faraday (v0.9.1, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multipart-post (v2.0.0, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.2.0, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.2.1, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.2.0, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.2.1, rbenv: 2.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.2.2, rbenv: 2.1.2) [gem]" level="application" />
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.1.2" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/isms-ruby.iml" filepath="$PROJECT_DIR$/.idea/isms-ruby.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="" />
+  </component>
+</project>

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonathan ES Lin
+
+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,57 @@
+## isms-ruby
+
+A wrapper gem for iSMS (Malaysia) API.
+
+Check [www.isms.com.my](www.isms.com.my) for API documentation.
+
+Currently only supports sending SMS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'isms-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install isms-ruby
+
+## Usage
+
+In an initializer file, configure as follows:
+
+    require 'isms'
+
+    ISMS.configure do |config|
+      config.username = ENV['ISMS_USERNAME'] || 'username'
+      config.password = ENV['ISMS_PASSWORD'] || 'password'
+      config.protocol = 'https'
+    end
+
+Then, initialize a client and send an SMS as follows:
+
+    client = ISMS::Client.new
+    response = client.send_sms('Hello world!', '60121231234')
+
+    # => { code: 200, description: 'SUCCESS' }
+    # => { code: -1001, description: 'AUTHENTICATION FAILED' } etc.
+
+Check out other response codes at [http://isms.com.my/response_result.php](http://isms.com.my/response_result.php)
+
+## Contributing
+
+1. Fork it ( https://github.com/ernsheong/isms-ruby/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
+
+To run the specs:
+
+    $ bundle exec rspec

data/Rakefile

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

data/isms-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'isms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "isms-ruby"
+  spec.version       = ISMS::VERSION
+  spec.authors       = ["Jonathan ES Lin"]
+  spec.email         = ["ernsheong@gmail.com"]
+  spec.summary       = %q{An API wrapper gem for iSMS.}
+  spec.description   = %q{A gem to interface with iSMS's API (www.isms.com.my) for SMS sending.}
+  spec.homepage      = "https://github.com/ernsheong/isms-ruby"
+  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_runtime_dependency "faraday", "~> 0.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

data/lib/isms.rb

@@ -0,0 +1,7 @@
+require 'isms/version'
+require 'isms/configuration'
+require 'isms/client'
+
+module ISMS
+  extend Configuration
+end

data/lib/isms/client.rb

@@ -0,0 +1,56 @@
+require 'isms/configuration'
+require 'faraday'
+
+module ISMS
+  class Client
+    SEND_SMS_URL = '/isms_send.php'
+
+    def initialize
+      # Check for username and password
+      raise RuntimeError, "Username and password not provided!" unless ISMS.username && ISMS.password
+    end
+
+    #
+    # Returns Hash of :code and :description
+    # code has the error code number
+    # description is the error description
+    # http://www.isms.com.my/sms_api.php#SendSMS_Response
+    #
+    def send_sms(message_body, phone_no, type = 1)
+      request_body = {}
+      request_body[:un] = ISMS.username
+      request_body[:pwd] = ISMS.password
+      request_body[:dstno] = phone_no
+      request_body[:msg] = message_body
+      request_body[:type] = type
+
+      faraday_response = connection.post do |request|
+        request.url SEND_SMS_URL
+        request.body = request_body
+      end
+
+      parse_response(faraday_response.body)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: ISMS.endpoint_url_with_protocol)
+    end
+
+    def parse_response(body)
+      if body && body.index('=')
+        result_array = body.split('=')
+        {
+            code: result_array.first.strip.to_i,
+            description: result_array.last.strip
+        }
+      else
+        {
+            code: 200,
+            description: 'SUCCESS'
+        }
+      end
+    end
+  end
+end

data/lib/isms/configuration.rb

@@ -0,0 +1,32 @@
+require 'isms/version'
+
+module ISMS
+  module Configuration
+    DEFAULT_PROTOCOL = 'http'
+    DEFAULT_ENDPOINT = 'www.isms.com.my'
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+
+    attr_accessor :username, :password, :protocol, :endpoint
+
+    # When extended, call reset to set variable values to defaults
+    def self.extended(mod)
+      mod.reset
+    end
+
+    def reset
+      self.username = DEFAULT_USERNAME
+      self.password = DEFAULT_PASSWORD
+      self.protocol = DEFAULT_PROTOCOL
+      self.endpoint = DEFAULT_ENDPOINT
+    end
+
+    def endpoint_url_with_protocol
+      "#{protocol}://#{endpoint}"
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/isms/version.rb

@@ -0,0 +1,3 @@
+module ISMS
+  VERSION = "0.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,82 @@
+require 'isms'
+
+describe ISMS::Client do
+  let(:request_stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:test_connection) do
+    Faraday.new do |builder|
+      builder.adapter :test, request_stubs
+    end
+  end
+  let(:client) { ISMS::Client.new }
+
+  describe ".initialize" do
+    it "complains when API key is not configured" do
+      expect { ISMS::Client.new }.to raise_error(RuntimeError)
+    end
+
+    context "with API key" do
+      before do
+        allow(ISMS).to receive(:password).and_return("1234567890")
+        allow(ISMS).to receive(:username).and_return("username")
+      end
+
+      it "should not complain if password and username is given" do
+        expect { ISMS::Client.new }.not_to raise_error
+      end
+    end
+  end
+
+  describe ".send_sms" do
+    let(:send_sms_url) { '/isms_send.php' }
+    before do
+      allow(ISMS).to receive(:password).and_return("1234567890")
+      allow(ISMS).to receive(:username).and_return("username")
+    end
+
+    context 'successful send' do
+      let(:success_response) { "200 = SUCCESS" }
+
+      context "returns 200 = SUCCESS" do
+        before do
+          allow(client).to receive(:connection).and_return(test_connection)
+          request_stubs.post(send_sms_url) { |env| [ 200, {}, success_response ] }
+        end
+
+        it 'sends successfully' do
+          result = client.send_sms('Hi there!', '60121231234')
+          expect(result[:code]).to eq(200)
+          expect(result[:description]).to eq('SUCCESS')
+        end
+      end
+
+      context "returns blank" do
+        before do
+          allow(client).to receive(:connection).and_return(test_connection)
+          request_stubs.post(send_sms_url) { |env| [ 200, {}, '' ] }
+        end
+
+        it 'sends successfully' do
+          result = client.send_sms('Hi there!', '60121231234')
+          expect(result[:code]).to eq(200)
+          expect(result[:description]).to eq('SUCCESS')
+        end
+      end
+    end
+
+    context 'unsuccessful send' do
+      let(:failure_response) { "-1001 = AUTHENTICATION FAILED" }
+
+      before do
+        allow(client).to receive(:connection).and_return(test_connection)
+        request_stubs.post(send_sms_url) { |env| [ 200, {}, failure_response ] }
+      end
+
+      it 'sends successfully' do
+        result = client.send_sms('Hi there!', '60121231234')
+        expect(result[:code]).to eq(-1001)
+        expect(result[:description]).to eq('AUTHENTICATION FAILED')
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: isms-ruby
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jonathan ES Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: A gem to interface with iSMS's API (www.isms.com.my) for SMS sending.
+email:
+- ernsheong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/encodings.xml"
+- ".idea/isms-ruby.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/scopes/scope_settings.xml"
+- ".idea/vcs.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- isms-ruby.gemspec
+- lib/isms.rb
+- lib/isms/client.rb
+- lib/isms/configuration.rb
+- lib/isms/version.rb
+- spec/client_spec.rb
+homepage: https://github.com/ernsheong/isms-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An API wrapper gem for iSMS.
+test_files:
+- spec/client_spec.rb