simplepayNG 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2886b8580d460dde02ec149ff15c1649eb174412
4
+ data.tar.gz: 76a84fc87f5daaa35b07bcf6ac32e82892e03eae
5
+ SHA512:
6
+ metadata.gz: aed65a450f96bd930dfb098681510e8a320077d0450d71df2c5f75a818db370cdb6e24a2a459cb261645ffe5bf08e57733cd557cdfe79b4402993d38f105567b
7
+ data.tar.gz: 11099a1656ab80bd204499b834ea38b832e5e14ab16a1277acd8cbed8dc28b5d62f0e58a82402385a3dc5c16fdfaeeedf9ff1133dd9715248a6f8984dccb39b8
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.14.3
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at patrickoramah@yahoo.co.uk. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in simplepay.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Patrick Oramah
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,202 @@
1
+ # Simplepay
2
+
3
+ A ruby gem for the easy integration of the [Simplepay](https://www.simplepay.ng) payment platform
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'simplepayNG'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install simplepayNG
20
+
21
+ ## Basic Usage
22
+
23
+ How to get started
24
+
25
+ ### The HTML Form
26
+ ```html
27
+ <style>
28
+ body {
29
+ background-color: #efefef;
30
+ }
31
+ </style>
32
+ <div class="container">
33
+ <div class="row">
34
+ <div class="col-md-2"></div>
35
+ <div class="col-md-8" style="background-color: #ffffff; margin: 20px; padding: 20px;">
36
+ <%= simple_form_for('', url: pay_verify_path, html: {id: 'checkout_form'}) do |f| %>
37
+ <%= f.input :sp_token, as: 'hidden', input_html: {id: 'sp_token'} %>
38
+ <%= f.input :sp_amount, as: 'hidden', input_html: {id: 'sp_amount'} %>
39
+ <%= f.input :sp_status, as: 'hidden', input_html: {id: 'sp_status'} %>
40
+ <%= f.input :sp_currency, as: 'hidden', input_html: {id: 'sp_currency', value: 'NGN'} %>
41
+ <%= f.input :transaction_id, as: 'hidden', input_html: {id: 'transaction_id'} %>
42
+ <%= f.input :email, as: 'email', required: false, input_html: {id: 'email'} %>
43
+ <%= f.input :amount, input_html: {id: 'amount'} %>
44
+ <%= f.input :phone, required: false, input_html: {id: 'phone'} %>
45
+ <%= f.submit :submit, class: 'btn btn-primary btn-block', id: 'btn-checkout' %>
46
+ <% end %>
47
+ </div>
48
+ <div class="col-md-2"></div>
49
+ </div>
50
+ </div>
51
+ <script src="https://checkout.simplepay.ng/v2/simplepay.js"></script>
52
+ <script type="text/javascript">
53
+ // Use the "token" to validate the payment
54
+ function processPayment(token, paid) {
55
+ // put token, status, amount and transaction ID to be sent forward
56
+ // token, status and amount need to be passed forward
57
+ $('#sp_token').val(token);
58
+ $('#sp_status').val(paid);
59
+ $('#sp_amount').val(SimplePay.amountToLower($('#amount').val()));
60
+ $('#transaction_id').val('1234TRID');
61
+ $('#checkout_form').submit();
62
+ }
63
+
64
+ var handler = SimplePay.configure({
65
+ token: processPayment,
66
+ key: 'test_pu_demo' // put you public key here
67
+ });
68
+
69
+ $('#btn-checkout').on('click', function (e) {
70
+ e.preventDefault();
71
+ handler.open(SimplePay.CHECKOUT,
72
+ {
73
+ email: 'customer@store.com',
74
+ phone: '+23412345678',
75
+ description: 'My Test Store Checkout 123-456',
76
+ address: '31 Kade St, Abuja, Nigeria',
77
+ postal_code: '110001',
78
+ city: 'Abuja',
79
+ country: 'NG',
80
+ amount: SimplePay.amountToLower($('#amount').val()),
81
+ currency: 'NGN'
82
+ });
83
+ });
84
+ </script>
85
+
86
+ ```
87
+ To start processing payments, first you'd have to declare your simplepay private keys, through
88
+
89
+ #### Environment Variables
90
+ ```ruby
91
+ simple_pay_secret: "test_pr_demo"
92
+ ```
93
+ ### OR
94
+
95
+ #### pass it on every request
96
+
97
+ For Example
98
+ ```ruby
99
+ api_key = 'test_pr_demo'
100
+ token = params['sp_token'] #Token Gotten From Form
101
+ amount = params['sp_amount'] #Amount Gotten From Form
102
+ amount_currency = params['sp_currency'] #Currency your willingg to accept
103
+ status = params['sp_status'] #Payment status
104
+ transaction_id = params['transaction_id'] #Transaction id Gotten From Form
105
+ transaction = Simplepay.new(token, amount, amount_currency, status, api_key: api_key)
106
+ ```
107
+
108
+ ### Accepting payments
109
+
110
+ #### Basic Example
111
+ ```ruby
112
+ token = params['sp_token'] #Token Gotten From Form
113
+ amount = params['sp_amount'] #Amount Gotten From Form
114
+ amount_currency = params['sp_currency'] #Currency your willingg to accept
115
+ status = params['sp_status'] #Payment status
116
+ transaction_id = params['transaction_id'] #Transaction id Gotten From Form
117
+ transaction = Simplepay.new(token, amount, amount_currency, status)
118
+ ```
119
+
120
+ #### Full Example
121
+ ```ruby
122
+ def verify
123
+ token = params['sp_token']
124
+ amount = params['sp_amount']
125
+ amount_currency = params['sp_currency']
126
+ status = params['sp_status']
127
+ transaction_id = params['transaction_id']
128
+ transaction = Simplepay.new(token, amount, amount_currency, status)
129
+ if transaction['success'].eql? true
130
+ respond_to do |format|
131
+ format.html { redirect_to success_path, notice: transaction['message'] }
132
+ end
133
+ else
134
+ respond_to do |format|
135
+ format.html { redirect_to failed_path, alert: transaction['message'] }
136
+ end
137
+ end
138
+ end
139
+ ```
140
+
141
+ ### Transaction Response
142
+ If a transaction is successful the response it sends is the
143
+
144
+ ```ruby
145
+ {response: res, message: 'Payment Completed Successfully', success: true}
146
+ ```
147
+
148
+ 1. Response From Api
149
+
150
+ ``` json
151
+ { "response": {
152
+ "id":"trans_iKdhkLxPZEaGoNodfWoEFW",
153
+ "amount":110000,
154
+ "currency":"NGN",
155
+ "captured":true,
156
+ "created":1455897064,
157
+ "customer":{
158
+ "id": "cus_NpX9DDh5qCP5FYyxobPJk8",
159
+ "email": "customer@simplepay.ng",
160
+ "phone": "+23412345678",
161
+ "address": "31 Kade St, Abuja, Nigeria",
162
+ "address_city": "Nigeria",
163
+ "address_country": "NG",
164
+ "address_state": null,
165
+ "address_postal": "110001"
166
+ },
167
+ "payment_reference": "56297034526707",
168
+ "livemode":true,
169
+ "source":{
170
+ "id":"card_xcgz3en8iyNqjrkUyuispC",
171
+ "object":"card",
172
+ "brand":"VISA",
173
+ "exp_month":12,
174
+ "exp_year":2034,
175
+ "funding":"credit",
176
+ "last4":"1111"
177
+ },
178
+ "response_code":20000
179
+ }
180
+ }
181
+ ```
182
+ 2. message
183
+ 3. Success: true
184
+
185
+ Else if it fails it sends the
186
+
187
+ ```ruby
188
+ {message: 'Payment could not be processed', logs: res, success: false}.to_json
189
+ ```
190
+
191
+ 1. message
192
+ 2. logs (This is to troubleshoot the error the api is sending back)
193
+ 3. success: false
194
+
195
+ ## Contributing
196
+
197
+ Bug reports and pull requests are welcome on GitHub at https://github.com/patrickoramah/simplepayNG. 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.
198
+
199
+
200
+ ## License
201
+
202
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "simplepay"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/simplepay.rb ADDED
@@ -0,0 +1,57 @@
1
+ require "simplepay/version"
2
+ require 'net/https'
3
+ require 'uri'
4
+ require 'json'
5
+
6
+ module Simplepay
7
+ def self.new(token, amount, amount_currency, status, options = {})
8
+ uri = URI.parse('https://checkout.simplepay.ng/v2/payments/card/charge/')
9
+ header = {'Content-Type': 'text/json'}
10
+
11
+ data = {
12
+ 'token': token,
13
+ 'amount': amount,
14
+ 'amount_currency': amount_currency
15
+ }
16
+
17
+ if ENV['simple_pay_secret']
18
+ api_key = ENV['simple_pay_secret']
19
+ else
20
+ if options[:api_key]
21
+ api_key = options[:api_key]
22
+ else
23
+ raise Exception.new('Api Key Missing')
24
+ end
25
+ end
26
+
27
+ begin
28
+ http = Net::HTTP.new(uri.host, uri.port)
29
+ request = Net::HTTP::Post.new(uri.request_uri, header)
30
+ http.use_ssl = true
31
+ http.verify_mode = OpenSSL::SSL::VERIFY_NONE
32
+ request.basic_auth(api_key, '')
33
+ request.set_form_data(data)
34
+
35
+ response = http.request(request)
36
+ res = JSON.parse(response.read_body)
37
+ response_code = res['response_code']
38
+ if response.kind_of? Net::HTTPSuccess
39
+ if response_code.eql? 20000
40
+ @value = {response: res, message: 'Payment Completed Successfully', success: true}.to_json
41
+ return JSON.parse(@value)
42
+ else
43
+ @value = {message: 'Payment could not be processed', logs: res, success: false}.to_json
44
+ return JSON.parse(@value)
45
+ end
46
+ elsif status.eql? true
47
+ @value = {response: res, message: 'Payment Completed Successfully', success: true}.to_json
48
+ return JSON.parse(@value)
49
+ else
50
+ @value = {message: 'Payment could not be processed', logs: res, success: false}.to_json
51
+ return JSON.parse(@value)
52
+ end
53
+ rescue StandardError => e
54
+ raise e
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,3 @@
1
+ module Simplepay
2
+ VERSION = "0.1.1"
3
+ end
data/simplepay.gemspec ADDED
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'simplepay/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "simplepayNG"
8
+ spec.version = Simplepay::VERSION
9
+ spec.authors = ["Patrick Oramah"]
10
+ spec.email = ["patrickoramah@yahoo.co.uk"]
11
+
12
+ spec.summary = %q{Simplepay.ng APi Wrapper for rails}
13
+ spec.description = %q{Integrate payments into your rails app easily without much effort}
14
+ spec.homepage = "https://github.com/patrickoramah/simplepayNG"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against " \
23
+ # "public gem pushes."
24
+ # end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_development_dependency "bundler", "~> 1.14"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: simplepayNG
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Patrick Oramah
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-03-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Integrate payments into your rails app easily without much effort
56
+ email:
57
+ - patrickoramah@yahoo.co.uk
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/simplepay.rb
73
+ - lib/simplepay/version.rb
74
+ - simplepay.gemspec
75
+ homepage: https://github.com/patrickoramah/simplepayNG
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.6.8
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Simplepay.ng APi Wrapper for rails
99
+ test_files: []