mpesa_stk 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98e4c3a1cb59910334ad8f893a329fc65409a371
+  data.tar.gz: 72fb8592512e4b94bbb9b66210ae03498d39bd5d
+SHA512:
+  metadata.gz: 81237f220cacb76cd23d80209467b687f25ca21bf88090d2ff46e41fadd2ba3601caba8065c3ed7a33eb8e5ef3adbd0c42b91a106af719292e56881edf532b60
+  data.tar.gz: f55930075c931fc4cf98a1d999394ff2f59cef8bc31b0f4a8e68a87ed4fbbefef92408d4b758dac04d45013ecb24daf75f29739a95e85489abf18b606fa348ab

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.env
+.DS_Store
+*.gem

data/.sample.env

@@ -0,0 +1,9 @@
+base_url="https://sandbox.safaricom.co.ke"
+token_generator_url="/oauth/v1/generate?grant_type=client_credentials"
+process_request_url="/mpesa/stkpush/v1/processrequest"
+
+key=""
+secret=""
+business_short_code=""
+business_passkey="
+callback_url="

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mboyaberry@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mpesa_stk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    mpesa_stk (1.0.0)
+      httparty (~> 0.15.6)
+      redis-namespace (~> 1.5, >= 1.5.3)
+      redis-rack (~> 2.0, >= 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    dotenv (2.2.1)
+    hashdiff (0.3.7)
+    httparty (0.15.7)
+      multi_xml (>= 0.5.2)
+    method_source (0.8.2)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    public_suffix (3.0.2)
+    rack (2.0.4)
+    rake (10.5.0)
+    redis (4.0.1)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
+    redis-rack (2.0.4)
+      rack (>= 1.5, < 3)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.4.1)
+      redis (>= 2.2, < 5)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv (= 2.2.1)
+  minitest (~> 5.0)
+  mpesa_stk!
+  pry (~> 0.10.4)
+  pry-nav (~> 0.2.4)
+  rake (~> 10.0)
+  webmock (~> 3.0, >= 3.0.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 mboya
+
+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,85 @@
+# MpesaStk
+Lipa na M-Pesa Online Payment API is used to initiate a M-Pesa transaction on behalf of a customer using STK Push. This is the same technique mySafaricom App uses whenever the app is used to make payments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mpesa_stk'
+```
+
+And then execute:
+
+    $ bundle or $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mpesa_stk
+
+## Version
+ Mpesa_stk is currently at `1.0.0 version`
+
+## Usage
+
+one needs to setup there environment variables, checkout `.sample.env`
+```
+base_url="https://sandbox.safaricom.co.ke"
+token_generator_url="/oauth/v1/generate?grant_type=client_credentials"
+process_request_url="/mpesa/stkpush/v1/processrequest"
+
+key=""
+secret=""
+business_short_code=""
+business_passkey="
+callback_url="
+```
+this can be found in [Test Credentials](https://developer.safaricom.co.ke/test_credentials)
+* `key` and `secret` of your application key.
+* `business_short_code`  and `business_pass_key` from safaricom.
+* `callback_url` the url of your application.
+
+
+### Implementation
+
+This now becomes the easy part. After all the pieces above have been set all you need to do is:
+open your console and add.
+```
+require 'mpesa_stk'
+```
+
+```
+MpesaStk::PushPayment.call("500", "<YOUR PHONE NUMBER: 254711222333>")
+```
+
+### Output
+This is the expected output
+ ![alt tag](./bin/index.jpeg)
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mboya/mpesa_stk.
+
+To Contribute to this gem,
+* Comment on the issue you would like to work on solving.
+* Mark the issue as in progress by adding an `in-progress` label.
+* Fork the project to your github repository (This project only accepts PRs from forks)
+* Submit the PR after the implementation all unfinished PRs for an issue should have a WIP indicated beside it
+* Every PR should have a link to the issue being solved
+* Checkout this [github best practices](https://github.com/skyscreamer/yoga/wiki/GitHub-Best-Practices) for more info.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MpesaStk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mboya/mpesa_stk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mpesa_stk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mpesa_stk.rb

@@ -0,0 +1,4 @@
+require "mpesa_stk/version"
+require 'mpesa_stk/push_payment'
+require 'dotenv/load'
+require 'httparty'

data/lib/mpesa_stk/access_token.rb

@@ -0,0 +1,85 @@
+require 'base64'
+require 'redis'
+
+module MpesaStk
+  class AccessToken
+    class << self
+      def call
+        new.access_token
+      end
+    end
+
+    def initialize
+      @key = ENV['key']
+      @secret = ENV['secret']
+      @redis = Redis.new
+
+      load_from_redis
+    end
+
+    def is_valid?
+      has_token? && !token_expired?
+    end
+
+    def token_expired?
+      expire_time = @timestamp.to_i + @expires_in.to_i
+      return expire_time < Time.now.to_i + 58
+    end
+
+    def has_token?
+      return !@token.nil?
+    end
+
+    def refresh
+      get_new_access_token
+      load_from_redis
+    end
+
+    def load_from_redis
+      data = @redis.get(@key)
+      if (data.nil? || data.empty?)
+        @token = nil
+        @timestamp = nil
+        @expires_in = nil
+      else
+        parsed = JSON.parse(data)
+        @token = parsed['access_token']
+        @timestamp = parsed['time_stamp']
+        @expires_in = parsed['expires_in']
+      end
+    end
+
+    def access_token
+      if is_valid?
+        return @token
+      else
+        refresh
+        return @token
+      end
+    end
+
+    def get_new_access_token
+      response = HTTParty.get(url, headers: headers)
+
+      hash = JSON.parse(response.body).merge(Hash['time_stamp',Time.now.to_i])
+      @redis.set @key, hash.to_json
+    end
+
+    private
+      def url
+        "#{ENV['base_url']}#{ENV['token_generator_url']}"
+      end
+
+      def headers
+        encode = encode_credentials @key, @secret
+        headers = {
+          "Authorization" => "Basic #{encode}"
+        }
+      end
+
+      def encode_credentials key, secret
+        credentials = "#{key}:#{secret}"
+        encoded_credentials = Base64.encode64(credentials).split("\n").join
+      end
+  end
+end

data/lib/mpesa_stk/push_payment.rb

@@ -0,0 +1,70 @@
+require "mpesa_stk/access_token"
+
+module MpesaStk
+  class PushPayment
+    class << self
+      def call(amount, phone_number)
+        new(amount, phone_number).push_payment
+      end
+    end
+
+    attr_reader :token, :amount, :phone_number
+
+    def initialize amount, phone_number
+      @token = MpesaStk::AccessToken.call
+      @amount = amount
+      @phone_number = phone_number
+    end
+
+    def push_payment
+      response = HTTParty.post(url, headers: headers, body: body)
+      JSON.parse(response.body)
+    end
+
+    private
+      def url
+        "#{ENV['base_url']}#{ENV['process_request_url']}"
+      end
+
+      def headers
+        headers = {
+          "Authorization" => "Bearer #{token}",
+          "Content-Type" => "application/json"
+        }
+      end
+
+      def body
+        {
+          BusinessShortCode: "#{ENV['business_short_code']}",
+          Password: generate_password,
+          Timestamp: "#{timestamp}",
+          TransactionType: "CustomerPayBillOnline",
+          Amount: "#{amount}",
+          PartyA: "#{phone_number}",
+          PartyB: "#{ENV['business_short_code']}",
+          PhoneNumber: "#{phone_number}",
+          CallBackURL: "#{ENV['callback_url']}",
+          AccountReference: generate_bill_reference_number(20),
+          TransactionDesc: generate_bill_reference_number(20)
+        }.to_json
+      end
+
+      def generate_bill_reference_number(number)
+        charset = Array('A'..'Z') + Array('a'..'z')
+        Array.new(number) { charset.sample }.join
+      end
+
+      def timestamp
+        DateTime.now.strftime("%Y%m%d%H%M%S").to_i
+      end
+
+      # shortcode
+      # passkey
+      # timestamp
+      def generate_password
+        key = "#{ENV['business_short_code']}#{ENV['business_passkey']}#{timestamp}"
+        Base64.encode64(key).split("\n").join
+      end
+
+  end
+end

data/lib/mpesa_stk/version.rb

@@ -0,0 +1,3 @@
+module MpesaStk
+  VERSION = "1.0.2"
+end

data/mpesa_stk.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mpesa_stk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mpesa_stk"
+  spec.version       = MpesaStk::VERSION
+  spec.authors       = ["mboya", "cess"]
+  spec.email         = ["mboyaberry@gmail.com", "cessmbuguar@gmail.com"]
+
+  spec.summary       = %q{Lipa na M-Pesa Online Payment.}
+  spec.description   = %q{initiate a M-Pesa transaction on behalf of a customer using STK Push.}
+  spec.homepage      = "https://github.com/mboya/mpesa_stk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  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'
+  spec.add_development_dependency "dotenv", "2.2.1"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: mpesa_stk
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- mboya
+- cess
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: 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: 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: 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: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: 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: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+description: initiate a M-Pesa transaction on behalf of a customer using STK Push.
+email:
+- mboyaberry@gmail.com
+- cessmbuguar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".sample.env"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/index.jpeg
+- bin/setup
+- lib/mpesa_stk.rb
+- lib/mpesa_stk/access_token.rb
+- lib/mpesa_stk/push_payment.rb
+- lib/mpesa_stk/version.rb
+- mpesa_stk.gemspec
+homepage: https://github.com/mboya/mpesa_stk
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Lipa na M-Pesa Online Payment.
+test_files: []