mpesa_connect 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df25e1cf7fb4470050aa2cb2396b856f844798cf
-  data.tar.gz: efbef4a6bc5cc851f975f66a288fcf63ad443169
+  metadata.gz: 3a4a20dc87bdebda47d40c9d6a5b39841c9f585e
+  data.tar.gz: bed0265698be8b6c7daab87024d942910e5921a7
 SHA512:
-  metadata.gz: 0310d675bb63970f1c028114078a9be7db1add163a71191eaf69ab356c855b92bd44af4c47fbbfc3e7f3afe2cea0c8c1efd4ab22459841145658553f9de372f7
-  data.tar.gz: 7a6611473c8391c7a2a2d4d5fb850995371a52bb7136e08ab392e09cc79addab8c8d0dc9ab477be8b20401fd29c646bb0e42d2bd92858572107bc0a0ba376ea5
+  metadata.gz: 6e2bb0c34147dad9123649f220b97d6db15df974cee8bfed09bf651c87d60d66660636b83615ce3632bb2248add3cb0989839cf52b0ede3c10f6129b110a1661
+  data.tar.gz: 28942b47292806c5736ec2617370e7f568d13b2eba03cd7593c84a653a50e2ee9980927b8289896a7bc165086ac1ac2f1ce7054d23a6a621d9f0b65abd5d57d9

data/README.md

@@ -1,8 +1,7 @@
 # MpesaConnect
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mpesa_connect`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Gem built as ruby wrapper to handle transactions with with the [Safaricom M-Pesa APIs](https://developer.safaricom.co.ke/docs).
+You will need to have a developer Account on [Safaricom Developer](https://developer.safaricom.co.ke/docs). Portal to run in sandbox environments.
 
 ## Installation
 
@@ -22,7 +21,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  require 'mpesa_connect'
+```
+
+Values you need from your Safaricom app
+
+- `key` and `secret`:  Credentials for an approved app.
+- `security_password`: Generated Encryption Security Credential from the sandbox tool (Shortcode 1).
+
+```ruby
+  client = MpesaConnect::Client.new(key, secret, security_password)
+```
+
+Set the urls that will be used to send response back to your app
+
+- `timeout_url`    :  The callback URL that handles information of timed out transactions
+- `transaction_url`:  The callback URL that handles a successful request and handles responses.
+
+```ruby
+  client.set_urls(timeout_url, transaction_url)
+```
+
+For each of the functions you will need data from Test Credentials:
+
+- `Initiator`     : This is the credential/username used to authenticate the transaction request.
+- `PartyA`        : Short code for party initiating the transaction.
+- `PartyB`        : Organization/MSISDN(phone number) sending the transaction.
+- `Receiver_party`: Identifier types - receiver - identify an M-Pesa transaction’s receiving party as either a shortcode, a till number or a MSISDN (phone number).
+
+### Account Balance
+
+```ruby
+  client.account_balance(initiator, party_a)
+```
+
+### Reversal
+
+```ruby
+  client.reversal(initiator, transaction_id, amount, receiver_party)
+```
+
+### Transaction Status
+
+```ruby
+  client.transaction_status(initiator, party_a, transaction_id)
+```
+
+### B2C Transaction
+
+Salary Payment
+
+```ruby
+  client.b2c_transaction(initiator, amount, party_a, party_b)
+```
 
 ## Development
 
@@ -32,7 +84,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mpesa_connect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mboya/mpesa_connect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +92,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the MpesaConnect project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mpesa_connect/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MpesaConnect project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mboya/mpesa_connect/blob/master/CODE_OF_CONDUCT.md).

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/lib/{access_token.rb → mpesa_connect/access_token.rb}

@@ -1,3 +1,6 @@
+require 'base64'
+require 'redis'
+
 module MpesaConnect
   class AccessToken
     def initialize key, secret

data/lib/mpesa_connect/security_credentials.rb

@@ -0,0 +1,22 @@
+require 'pry'
+require 'pry-nav'
+require 'openssl'
+
+module MpesaConnect
+  class SecurityCredentials
+
+    def initialize security_cred
+      @security_cred = security_cred
+    end
+
+    def encrypt_security_cred
+      byte_array = @security_cred.bytes.to_a.to_s
+      key_file = "lib/pubkey.pem"
+      public_key = File.read(key_file)
+      ssl = OpenSSL::PKey::RSA.new(public_key)
+
+      encrypted_string = Base64.encode64(ssl.public_encrypt(byte_array)).split("\n").join
+    end
+
+  end
+end

data/lib/mpesa_connect/version.rb

@@ -1,3 +1,3 @@
 module MpesaConnect
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/mpesa_connect.rb

@@ -1,15 +1,10 @@
 require "mpesa_connect/version"
-require 'base64'
-require 'redis'
+require 'mpesa_connect/access_token'
 require 'httparty'
-require 'openssl'
-require 'access_token'
-require 'security_credentials'
 
 module MpesaConnect
   class Client
     BASE_URL = "https://sandbox.safaricom.co.ke"
-    BALANCE_URL = "https://sandbox.safaricom.co.ke/mpesa/accountbalance/v1/query"
 
     def initialize key, secret, security_credentials
       @key = key
@@ -152,7 +147,7 @@ module MpesaConnect
 
     private
       def get_token
-        AccessToken.new(@key, @secret).access_token
+        MpesaConnect::AccessToken.new(@key, @secret).access_token
       end
 
       def encrypted_security_password

data/lib/security_credentials.rb

@@ -1,5 +1,6 @@
 require 'pry'
 require 'pry-nav'
+require 'openssl'
 
 module MpesaConnect
   class SecurityCredentials

data/mpesa_connect.gemspec

@@ -30,13 +30,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty"
-  spec.add_dependency "redis-rack"
-  spec.add_dependency "redis-namespace"
+  spec.add_dependency 'httparty', '~> 0.15.6'
+  spec.add_dependency 'redis-rack', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency 'redis-namespace', '~> 1.5', '>= 1.5.3'
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
 end

metadata

@@ -1,57 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: mpesa_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - mboya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.6
 - !ruby/object:Gem::Dependency
   name: redis-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,44 +110,50 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 description: connect to Mpesa API to perform available transactions
 email:
 - mboyaberry@gmail.com
@@ -151,13 +169,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
-- lib/access_token.rb
-- lib/cert.cer
 - lib/mpesa_connect.rb
+- lib/mpesa_connect/access_token.rb
+- lib/mpesa_connect/security_credentials.rb
 - lib/mpesa_connect/version.rb
-- lib/pubkey.pem
 - lib/security_credentials.rb
 - mpesa_connect.gemspec
 homepage: https://mboya.github.io/mpesa_connect/

data/lib/cert.cer

@@ -1,38 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIGkzCCBXugAwIBAgIKXfBp5gAAAD+hNjANBgkqhkiG9w0BAQsFADBbMRMwEQYK
-CZImiZPyLGQBGRYDbmV0MRkwFwYKCZImiZPyLGQBGRYJc2FmYXJpY29tMSkwJwYD
-VQQDEyBTYWZhcmljb20gSW50ZXJuYWwgSXNzdWluZyBDQSAwMjAeFw0xNzA0MjUx
-NjA3MjRaFw0xODAzMjExMzIwMTNaMIGNMQswCQYDVQQGEwJLRTEQMA4GA1UECBMH
-TmFpcm9iaTEQMA4GA1UEBxMHTmFpcm9iaTEaMBgGA1UEChMRU2FmYXJpY29tIExp
-bWl0ZWQxEzARBgNVBAsTClRlY2hub2xvZ3kxKTAnBgNVBAMTIGFwaWdlZS5hcGlj
-YWxsZXIuc2FmYXJpY29tLmNvLmtlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
-CgKCAQEAoknIb5Tm1hxOVdFsOejAs6veAai32Zv442BLuOGkFKUeCUM2s0K8XEsU
-t6BP25rQGNlTCTEqfdtRrym6bt5k0fTDscf0yMCoYzaxTh1mejg8rPO6bD8MJB0c
-FWRUeLEyWjMeEPsYVSJFv7T58IdAn7/RhkrpBl1dT7SmIZfNVkIlD35+Cxgab+u7
-+c7dHh6mWguEEoE3NbV7Xjl60zbD/Buvmu6i9EYz+27jNVPI6pRXHvp+ajIzTSsi
-eD8Ztz1eoC9mphErasAGpMbR1sba9bM6hjw4tyTWnJDz7RdQQmnsW1NfFdYdK0qD
-RKUX7SG6rQkBqVhndFve4SDFRq6wvQIDAQABo4IDJDCCAyAwHQYDVR0OBBYEFG2w
-ycrgEBPFzPUZVjh8KoJ3EpuyMB8GA1UdIwQYMBaAFOsy1E9+YJo6mCBjug1evuh5
-TtUkMIIBOwYDVR0fBIIBMjCCAS4wggEqoIIBJqCCASKGgdZsZGFwOi8vL0NOPVNh
-ZmFyaWNvbSUyMEludGVybmFsJTIwSXNzdWluZyUyMENBJTIwMDIsQ049U1ZEVDNJ
-U1NDQTAxLENOPUNEUCxDTj1QdWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2
-aWNlcyxDTj1Db25maWd1cmF0aW9uLERDPXNhZmFyaWNvbSxEQz1uZXQ/Y2VydGlm
-aWNhdGVSZXZvY2F0aW9uTGlzdD9iYXNlP29iamVjdENsYXNzPWNSTERpc3RyaWJ1
-dGlvblBvaW50hkdodHRwOi8vY3JsLnNhZmFyaWNvbS5jby5rZS9TYWZhcmljb20l
-MjBJbnRlcm5hbCUyMElzc3VpbmclMjBDQSUyMDAyLmNybDCCAQkGCCsGAQUFBwEB
-BIH8MIH5MIHJBggrBgEFBQcwAoaBvGxkYXA6Ly8vQ049U2FmYXJpY29tJTIwSW50
-ZXJuYWwlMjBJc3N1aW5nJTIwQ0ElMjAwMixDTj1BSUEsQ049UHVibGljJTIwS2V5
-JTIwU2VydmljZXMsQ049U2VydmljZXMsQ049Q29uZmlndXJhdGlvbixEQz1zYWZh
-cmljb20sREM9bmV0P2NBQ2VydGlmaWNhdGU/YmFzZT9vYmplY3RDbGFzcz1jZXJ0
-aWZpY2F0aW9uQXV0aG9yaXR5MCsGCCsGAQUFBzABhh9odHRwOi8vY3JsLnNhZmFy
-aWNvbS5jby5rZS9vY3NwMAsGA1UdDwQEAwIFoDA9BgkrBgEEAYI3FQcEMDAuBiYr
-BgEEAYI3FQiHz4xWhMLEA4XphTaE3tENhqCICGeGwcdsg7m5awIBZAIBDDAdBgNV
-HSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwJwYJKwYBBAGCNxUKBBowGDAKBggr
-BgEFBQcDAjAKBggrBgEFBQcDATANBgkqhkiG9w0BAQsFAAOCAQEAC/hWx7KTwSYr
-x2SOyyHNLTRmCnCJmqxA/Q+IzpW1mGtw4Sb/8jdsoWrDiYLxoKGkgkvmQmB2J3zU
-ngzJIM2EeU921vbjLqX9sLWStZbNC2Udk5HEecdpe1AN/ltIoE09ntglUNINyCmf
-zChs2maF0Rd/y5hGnMM9bX9ub0sqrkzL3ihfmv4vkXNxYR8k246ZZ8tjQEVsKehE
-dqAmj8WYkYdWIHQlkKFP9ba0RJv7aBKb8/KP+qZ5hJip0I5Ey6JJ3wlEWRWUYUKh
-gYoPHrJ92ToadnFCCpOlLKWc0xVxANofy6fqreOVboPO0qTAYpoXakmgeRNLUiar
-0ah6M/q/KA==
------END CERTIFICATE-----

data/lib/pubkey.pem

@@ -1,9 +0,0 @@
------BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoknIb5Tm1hxOVdFsOejA
-s6veAai32Zv442BLuOGkFKUeCUM2s0K8XEsUt6BP25rQGNlTCTEqfdtRrym6bt5k
-0fTDscf0yMCoYzaxTh1mejg8rPO6bD8MJB0cFWRUeLEyWjMeEPsYVSJFv7T58IdA
-n7/RhkrpBl1dT7SmIZfNVkIlD35+Cxgab+u7+c7dHh6mWguEEoE3NbV7Xjl60zbD
-/Buvmu6i9EYz+27jNVPI6pRXHvp+ajIzTSsieD8Ztz1eoC9mphErasAGpMbR1sba
-9bM6hjw4tyTWnJDz7RdQQmnsW1NfFdYdK0qDRKUX7SG6rQkBqVhndFve4SDFRq6w
-vQIDAQAB
------END PUBLIC KEY-----