selcom 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ac82861a11c5267af9ac8b8416a596d993450ee
+  data.tar.gz: 3bfe6adee31a931b7ee07d470d7670c4cfaeb3bf
+SHA512:
+  metadata.gz: 96a75b4860e890c7b131562c0e3e5b3e808daf41003f16fe5be2ee3f5c7e5b242cf3da77fd94633b9ba48027d30d394681f54c2b5cf48e663aaa07da78e4f31f
+  data.tar.gz: e04f2d0b8ef464376db3359cbdb92dfc688d065b68e65107948656c9e866a01df23d21d981643a55285e899dd22bd061b586960fd9c384fb8b7953699460ab19

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+Guardfile

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in selcom.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec', require: false
+  gem 'rb-readline'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mawuli Adzoe
+
+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,53 @@
+# Selcom [![Code Climate](https://codeclimate.com/github/wallclockbuilder/selcom/badges/gpa.svg)](https://codeclimate.com/github/wallclockbuilder/selcom)
+
+This gem makes it possible to use the Selcom API without having to deal with XML RPC.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'selcom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install selcom
+
+## Usage
+
+set your API credentials:
+
+```ruby
+require 'selcom'
+Selcom.configure do |config|
+  config.api_key = '...'
+  config.api_signature = '...'
+end
+```
+Send money:
+
+```ruby
+
+selcom = Selcom::SendMoney.new(:mobile_number => "...", :amount => 500, :telco_id => '...')
+if send_money.send!
+  puts selcom.reference
+  puts selcom.sent_amount
+  puts selcom.success
+  puts selcom.status_code
+  puts selcom.status_description
+else
+  puts selcom.response
+end
+
+```
+## Contributing
+
+1. Fork it ( https://github.com/wallclockbuilder/selcom )
+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/selcom.rb

@@ -0,0 +1,149 @@
+require 'active_support'
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'xmlrpc/client'
+require 'nokogiri'
+
+module Selcom
+  include ActiveSupport::Configurable
+  class MalformedRequestError < StandardError
+  end
+
+  class SendMoney
+    attr_accessor(
+      :amount,        :status,
+      :success,       :telco_id,
+      :response,      :reference,
+      :status_code,   :customer_name,
+      :mobile_number, :status_description
+    )
+
+    XMLRPC_URI            = "https://paypoint.selcommobile.com/api/selcom.pos.server.php"
+    XMLRPC_METHOD         = 'SELCOM.utilityPayment'
+
+    SELCOM_UTILITY_CODES  = {
+      :airtel_tz  => 'AMCASHIN',
+      :tigo_tz    => 'TPCASHIN',
+      :vodacom_tz => 'VMCASHIN',
+      :zantel_tz  => 'EZCASHIN'
+    }
+    NUMBER_PREFIXES = {
+      '068'       => :airtel_tz,
+      '078'       => :airtel_tz,
+      '065'       => :tigo_tz,
+      '071'       => :tigo_tz,
+      '075'       => :vodacom_tz,
+      '076'       => :vodacom_tz,
+      '077'       => :zantel_tz
+    }
+
+    def initialize(args)
+      self.telco_id       = args[:telco_id]
+      self.mobile_number  = args[:mobile_number]
+      self.amount         = args[:amount]
+    end
+
+    def send!
+      self.response = make_rpc(self.to_params)
+      parse_response(response)
+
+      return self.success
+    end
+
+    def to_params
+      return HashWithIndifferentAccess.new(
+        :amount         => self.amount,
+        :mobile_number  => self.mobile_number,
+        :telco_id       => self.telco_id,
+        :vendor_id      => Selcom.config.vendor_id,
+        :vendor_pin     => Selcom.config.vendor_pin
+      )
+    end
+
+    private
+
+    def make_rpc(args)
+      request_params  = create_request_params(args)
+      xmlrpc_client   = create_rpc_client()
+      xml_response    = call_rpc_server(xmlrpc_client, request_params)
+
+      return parse_xml_into_hash(xml_response)
+    end
+
+    def parse_response(response)
+      self.reference          = response[:reference]
+      self.status             = response[:result]
+      self.status_code        = response[:resultcode]
+      self.status_description = response[:message]
+      self.success            = ('SUCCESS' == self.status)
+    end
+
+    def create_request_params(args)
+      amount            = args["amount"]
+      receipient_number = args["mobile_number"]
+      telco_id          = NUMBER_PREFIXES[receipient_number[0..2]] || :vodacom_tz
+      utility_code      = SELCOM_UTILITY_CODES[telco_id]
+      unique_token      = SecureRandom.urlsafe_base64(nil, false)
+
+      return {
+        "vendor"      => Selcom.config.vendor_id,
+        "pin"         => Selcom.config.vendor_pin,
+        "utilitycode" => utility_code,
+        "utilityref"  => receipient_number,
+        "amount"      => amount,
+        "transid"     => unique_token,
+        "msisdn"      => receipient_number
+      }
+    end
+
+    def parse_xml_into_hash(xml_from_rpc)
+      xml = extract_xml(xml_from_rpc)
+
+      return convert_xml_to_hash(xml)
+    end
+
+    def extract_xml(xml_rpc_response)
+      xml_doc = Nokogiri::XML(xml_rpc_response)
+      xml_doc_content = xml_doc.xpath('/methodResponse/params/param/value/struct')
+
+      return xml_doc_content.to_xml
+    end
+
+    def convert_xml_to_hash(xml)
+      content_hash  = Hash.from_xml(xml)
+      resultHash    = HashWithIndifferentAccess.new
+      if content_hash
+        content_hash['struct']['member'].map {|member|
+          result.store(
+            member['name'], member['value'].first[1]
+          )
+        }
+        end
+
+      return resultHash
+    end
+
+    def create_rpc_client()
+      client     = XMLRPC::Client.new2(XMLRPC_URI)
+      client.http_header_extra = {
+        'Content-Type'  => 'text/xml; charset=utf-8',
+        'Accept'        => 'text/html'
+      }
+
+      return client
+    end
+
+    def call_rpc_server(xmlrpc_client, request_params)
+      # make call to xmlrpc server at selcom
+      begin
+        xmlrpc_client.call(XMLRPC_METHOD, request_params)
+      rescue RuntimeError => e
+        raise MalformedRequestError, (
+          "Invalid request parameters: #{request_params.inspect}"
+        )
+      end
+
+      return xmlrpc_client.http_last_response.body
+    end
+  end
+end

data/lib/selcom/version.rb

@@ -0,0 +1,3 @@
+module Selcom
+  VERSION = "0.0.2"
+end

data/selcom.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selcom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selcom"
+  spec.version       = Selcom::VERSION
+  spec.authors       = ["Mawuli Adzoe"]
+  spec.email         = ["mawuli.kofi.mawuli@gmail.com"]
+  spec.summary       = %q{Ruby API wrapper for the Selcom XMLRPC API}
+  spec.description   = %q{Use this gem so you don't have to interact with the Selcome XML RPC API directly.}
+  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_dependency 'activesupport'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "nokogiri"
+
+
+
+end

data/spec/send_money_spec.rb

@@ -0,0 +1,118 @@
+require 'Selcom'
+
+
+describe Selcom::SendMoney do
+  subject {
+    Selcom::SendMoney.new({
+      mobile_number: '+255701234567',
+      amount: '543',
+      telco_id: 'abc'
+    })
+  }
+
+  it { expect(subject.telco_id).to        eql('abc') }
+  it { expect(subject.mobile_number).to   eql('+255701234567') }
+  it { expect(subject.amount).to          eql('543') }
+
+  it { should respond_to(:telco_id) }
+  it { should respond_to(:mobile_number) }
+  it { should respond_to(:amount) }
+  it { should respond_to(:response) }
+  it { should respond_to(:reference) }
+  it { should respond_to(:success) }
+  it { should respond_to(:customer_name) }
+  it { should respond_to(:status) }
+  it { should respond_to(:status_description) }
+  it { should respond_to(:status_code) }
+
+  describe 'request params' do
+    before do
+      Selcom.configure do |c|
+        c.vendor_id = 'def'
+        c.vendor_pin = '789'
+      end
+    end
+
+    subject do
+      Selcom::SendMoney.new({
+      amount: '543',
+      mobile_number: '+255701234567',
+      telco_id: 'abc'
+      })
+    end
+
+    it do
+      expect(subject.to_params).to eql(
+        HashWithIndifferentAccess.new(
+          "amount" => '543',
+          "mobile_number" => '+255701234567',
+          "telco_id"   => 'abc',
+          "vendor_id" => 'def',
+          "vendor_pin" => '789'
+        )
+      )
+    end
+
+
+  end
+
+  describe 'sending money' do
+
+    describe "invalid request" do
+      let(:response) do
+        double(
+          HashWithIndifferentAccess.new(
+            :body => {
+              "transid" => "mwliid12345",
+               "reference" => "4655259721",
+                "message" => "Airtel Money Cash-in",
+                 "resultcode" => "000",
+                 "result" => "FAIL"
+               }
+             )
+            )
+      end
+
+      subject { Selcom::SendMoney.new(:amount => 543, :mobile_number => '', :telco_id =>'') }
+      #before{ expect(subject).to receive(:connection).with(subject.to_params).and_return(response) }
+      before { subject.should_receive(:connection).with(subject.to_params).and_return(response) }
+      it 'parses the response and sets accessors' do
+        subject.send!
+        expect(subject.status).to             eql("FAIL")
+        expect(subject.status_code).to        eql("000")
+        expect(subject.status_description).to eql('Airtel Money Cash-in')
+        expect(subject.success).to            eql(false)
+      end
+    end
+
+    describe "success" do
+      let(:response) do
+        double(
+          HashWithIndifferentAccess.new(
+            :body =>
+              {"transid"=>"mwliid12345",
+                 "reference"=>"4655259721",
+                  "message"=>"Airtel Money Cash-in",
+                   "resultcode"=>"000",
+                  "result"=>"SUCCESS"
+                }
+              )
+            )
+      end
+
+      subject { Selcom::SendMoney.new(:amount => 1234, :mobile_number => '+255701234567', :telco_id => 'qwert') }
+      #before{ expect(subject).to receive(:connection).with(subject.to_params).and_return(response) }
+      before { subject.should_receive(:connection).with(subject.to_params).and_return(response) }
+
+      it 'parses the response and sets accessors' do
+        subject.send!
+        expect(subject.reference).to            eql('4655259721')
+        expect(subject.status).to               eql("SUCCESS")
+        expect(subject.status_code).to          eql('000')
+        expect(subject.status_description).to   eql("Airtel Money Cash-in")
+        expect(subject.success).to              eql(true)
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: selcom
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mawuli Adzoe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: '0'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use this gem so you don't have to interact with the Selcome XML RPC API
+  directly.
+email:
+- mawuli.kofi.mawuli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/selcom.rb
+- lib/selcom/version.rb
+- selcom.gemspec
+- spec/send_money_spec.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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby API wrapper for the Selcom XMLRPC API
+test_files:
+- spec/send_money_spec.rb