mpesarb 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d8b053eedae0cab3d4839a9a618f7b4f520b2deada034c07ab57358d69896b
-  data.tar.gz: da6f1486a2a3e329dc0999b0cb901791b97c4fe87caf1f85e364fdd864cec069
+  metadata.gz: 68d96fb20a2f0f9d3f463f6bb4b0d6d1e520c20d1c11f2d2a938aaf451d4ef4e
+  data.tar.gz: 92017a2a811f1f6de9f233c083be65b892ebb591bbc2c392dd31aeedac9a4212
 SHA512:
-  metadata.gz: d05e129b9e523fc31be44cb452283aa83993086b67b7cb540ce0832db3ba787a000c6baee3617f4529e34d6e7668ad31bbf97b78f5aa2e1fb9de73764ea326a5
-  data.tar.gz: a07ec8dc4b8d383028952722b5785fbba6884d640a0b5333005c6b1905015cba00b6678b30eeebb7cdce5e429cb3b71832a157c7eba149216fae652c5c94577b
+  metadata.gz: 3c23bd5e3eb258bf86062cfbdc5bde0745617c5d6cb8f59da3927333331ab231e1c6c8d6c1296d5b342594b7cc7acb73d4f1c8c6ddc218de39389a79f58e37e6
+  data.tar.gz: ded8afec648b6cd69b45d4d0b4f958c27c43dbe7b2113e939c4c4f83aaeb807dc5e8e7c2091ed609709b32673f8f47c47c28b9e80b1c166049c91ebf0f9cd56e

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    mpesa (0.2.0)
+    mpesarb (0.3.0)
+      activesupport (>= 5.0.0)
       faraday (>= 1.1)
       faraday_middleware (~> 1.1)
       openssl (>= 2.1)
@@ -9,12 +10,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -46,6 +54,8 @@ GEM
     faraday_middleware (1.1.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
     json (2.5.1)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -78,11 +88,14 @@ GEM
     thor (1.1.0)
     tins (1.29.1)
       sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     vcr (6.0.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-19
@@ -93,7 +106,7 @@ DEPENDENCIES
   coveralls
   minitest
   minitest-reporters
-  mpesa!
+  mpesarb!
   pry-byebug
   rake (>= 12.3)
   vcr

data/README.md

@@ -12,7 +12,12 @@ This Gem provides an interface that developers can use to convert JSON to `OpenS
 
 Install via `Gemfile`
 ```
-gem "mpesa", github: "gathuku/mpesa"
+gem 'mpesarb', '~> 0.3.0'
+```
+
+Or
+```
+bundle add mpesarb
 ```
 
 ## Usage
@@ -20,12 +25,24 @@ gem "mpesa", github: "gathuku/mpesa"
 ### Initialization
 
 ```ruby
-client = Mpesa::Client.new(key: "SKKSS" , secret: "SJSKS", env: "sandbox", adapter: )
+client = Mpesa::Client.new(key: 'ZtkRW6ATbVtFpNml5w5SfG26Adfyagn9', secret: 'dosFI1yQ8bvHEVFw', env: 'sandbox')
 
 response = client.auth
 response.access_token # XiKf3D6UrY0J8S2aeOQ7R7w0BuA5
 response.expires_in # 3599
 ```
+__Parameters__
+
+Required
+- `key` - API consumer key - Required
+- `secret` - API consumer secret  - Required
+
+Optional
+- `env` - API environment. Default `production`
+- `adapter` - Faraday HTTP adapter. Default `:net_http`
+- `shortcode` - Mpesa shortcode
+- `pass_key` - LPNMO pass Key( used by STK API)
+
 
 ### Register Urls
 
@@ -33,7 +50,8 @@ Register C2B Urls( confirmation and validation url)
 ```ruby
  response = client.register(
    shortcode: "44445",
-   confirmation_url: 'http://test.com', validation_url: 'http://test.com'
+   confirmation_url: 'http://example.com/confirm',
+   validation_url: 'http://example.com/validate'
  )
  response.OriginatorCoversationID #   "807-15591582-1"
  response.ResponseCode # "0"

data/lib/mpesa/resources/token.rb

@@ -1,7 +1,33 @@
+require 'active_support/cache'
+require 'active_support/cache/memory_store'
+require 'active_support/notifications'
+
 module Mpesa
   class Token < Resource
     def token
+      if cache.exist?('token')
+        expires_at = cache.send(:read_entry, 'token')&.expires_at
+        Object.new({
+                     "access_token": cache.fetch('token'),
+                     "expires_in": expires_at - Time.now.to_f
+                   })
+      else
+        cache_token
+      end
+    end
+
+    def cache_token
+      res = call
+      cache.write('token', res.access_token, expires_in: res.expires_in)
+      res
+    end
+
+    def call
       Object.new get_request(url: 'oauth/v1/generate?grant_type=client_credentials', basic_auth: true).body
     end
+
+    def cache
+      @cache ||= ActiveSupport::Cache::MemoryStore.new
+    end
   end
 end

data/lib/mpesa/version.rb

@@ -1,3 +1,3 @@
 module Mpesa
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/mpesa.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.1.4'
   spec.add_development_dependency 'rake', '>= 12.3'
   # dependancies
+  spec.add_runtime_dependency 'activesupport', '>= 5.0.0'
   spec.add_runtime_dependency 'faraday', '>= 1.1'
   spec.add_runtime_dependency 'faraday_middleware', '~> 1.1'
   spec.add_runtime_dependency 'openssl', '>= 2.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpesarb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Moses Gathuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement