bygpay 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3b0b1367dae236e2bc141447c91ba8da7f045e7d
4
+ data.tar.gz: a96cf9cdf9cc42105f615c8e4b953290ad75f515
5
+ SHA512:
6
+ metadata.gz: 9912006ab0c4f769e526ffe415433c3bc265e6114c9f6c946f046d47fdfb7b2719aa2c64c30237b9e3a00dafe4712a2b4e555b2a9d3ea91bad6cf627aba5f764
7
+ data.tar.gz: eb8b3adca0c3fbff897f1da447eb86a98eb0fb8c82d6917a0f1840ba6fdc39f2c6f6908baed3f1433016f13ed7d6ae7c7af953dcb4d9d624c6c453fd561d19db
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.idea/
3
+ /.yardoc
4
+ /Gemfile.lock
5
+ /_yardoc/
6
+ /coverage/
7
+ /doc/
8
+ /pkg/
9
+ /spec/reports/
10
+ /tmp/
11
+
12
+ # rspec failure tracking
13
+ .rspec_status
14
+ /*.gem
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.6
@@ -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 alfred@encodevlabs.com. 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 BygPay.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Alfred Rowe
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,52 @@
1
+ # Bygpay
2
+
3
+ Ruby wrapper around Bygpay Payment Gateway. Bygpay is a self hosted payment processing gateway which gives merchants / business better flexiblity and control when it comes to payment processing.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'bygpay'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install bygpay
20
+
21
+ ## Usage
22
+
23
+ Setup few configs before use. If you using Rails you can put this in your `initializers` directory eg `initializers/bygpay.rb`
24
+
25
+ ```ruby
26
+ Bygpay.configure do |config|
27
+ config.base_url = 'http://gateway.bygpay-server.com/api'
28
+ config.api_key = '8b4e5a9c-6eba-4cdd-94b6-65e6b514'
29
+
30
+ # Optional Configurations
31
+ # (In case you've changed routes in your Bygpay Installation)
32
+ config.deposits_mobile_path = '/deposits/mobile'
33
+ config.deposits_status_overide_path = '/deposits/status-overide'
34
+ config.deposit_status_path = '/deposits'
35
+ end
36
+ ```
37
+
38
+ ## Development
39
+
40
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
41
+
42
+ 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).
43
+
44
+ ## Contributing
45
+
46
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bygpay. 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.
47
+
48
+
49
+ ## License
50
+
51
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
52
+
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 "bygpay"
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/bygpay.gemspec ADDED
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'bygpay/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "bygpay"
8
+ spec.version = Bygpay::VERSION
9
+ spec.authors = ["Alfred Rowe"]
10
+ spec.email = ["alfred@encodevlabs.com"]
11
+
12
+ spec.summary = "Bygpay Payment Gateway Ruby SDK"
13
+ spec.description = "Ruby Wrapper to process payments via any installed Bygpay Payment Gateway"
14
+ spec.homepage = "http://bygpay.com"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.14"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_runtime_dependency "http", "~> 2.2", ">= 2.2.2"
28
+ end
@@ -0,0 +1,16 @@
1
+ module Bygpay
2
+ class Configuration
3
+ attr_accessor :base_url, :api_key,
4
+ :deposits_mobile_path, :deposits_status_overide_path, :deposit_status_path
5
+
6
+ def initialize
7
+ @base_url = nil
8
+ @api_key = nil
9
+
10
+ # Preset default paths but allow for changes
11
+ @deposits_mobile_path = '/deposits/mobile'
12
+ @deposits_status_overide_path = '/deposits/status-overide'
13
+ @deposit_status_path = '/deposits'
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,23 @@
1
+ module Bygpay
2
+ module Deposit
3
+ class Mobile < Bygpay::Deposits
4
+
5
+ # {
6
+ # "walletno" : "0276967627",
7
+ # "amount": 0.10,
8
+ # "provider": "TIGO",
9
+ # "extrnx_code": null
10
+ # }
11
+ # Perform a mobile deposit request
12
+ def charge(amount, payload ={})
13
+ post(mobile_deposit_endpoint, payload.merge({amount: amount}))
14
+ end
15
+
16
+ # Return deposit transaction status
17
+ def transaction_status(uuid)
18
+ get_status(deposits_status_endpoint,uuid)
19
+ end
20
+
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,6 @@
1
+ module Bygpay
2
+ class Deposits
3
+ include Bygpay::Utils
4
+
5
+ end
6
+ end
@@ -0,0 +1,63 @@
1
+ require 'http'
2
+
3
+ module Bygpay
4
+ module Utils
5
+ extend self
6
+
7
+ attr_accessor :status, :response_text, :transaction_id, :uuid, :result, :response
8
+
9
+ # Mobile Deposit transactions endpoint
10
+ def mobile_deposit_endpoint
11
+ Bygpay.configuration.deposits_mobile_path
12
+ end
13
+
14
+ # Deposit transactions status check endpoint
15
+ def deposits_status_endpoint
16
+ Bygpay.configuration.deposit_status_path
17
+ end
18
+
19
+ # Post payload
20
+ def post(endpoint, payload = {})
21
+ url = "#{Bygpay.configuration.base_url}#{endpoint}"
22
+ result = http_connect.post(url, json: payload)
23
+
24
+ parse_response(result.body)
25
+ end
26
+
27
+ # Get transaction status
28
+ def get_status(endpoint, uuid)
29
+ url = "#{Bygpay.configuration.base_url}#{endpoint}"
30
+ result = http_connect.get("#{url}/#{uuid}")
31
+
32
+ parse_response(result.body)
33
+ end
34
+
35
+ # {
36
+ # "status": "success",
37
+ # "data": {
38
+ # "uuid": "d1f3395e-ea08-4599-b8a5-41f5e7a4",
39
+ # "status": "accepted",
40
+ # "trnx_code": "DTX00000008",
41
+ # "provider_txid": null,
42
+ # "extrnx_code": null,
43
+ # "walletno": "0276967627",
44
+ # "amount": 0.1,
45
+ # "provider": "TIGO"
46
+ # }
47
+ # }
48
+ def parse_response(body)
49
+ result = JSON.parse(body)
50
+ @result = result
51
+ @transaction_id = result['data']['trnx_code']
52
+ @response_text = result['message']
53
+ @uuid = result['data']['uuid']
54
+ @status = result['data']['status']
55
+ @response = result['status'] == 'success'
56
+ end
57
+
58
+ # global Bygpay connect
59
+ def http_connect
60
+ HTTP[Authorization: Bygpay.configuration.api_key]
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,3 @@
1
+ module Bygpay
2
+ VERSION = "0.1.0"
3
+ end
data/lib/bygpay.rb ADDED
@@ -0,0 +1,27 @@
1
+ require 'bygpay/version'
2
+ require 'bygpay/configuration'
3
+ require 'bygpay/utils'
4
+ require 'bygpay/deposits'
5
+ require 'bygpay/deposit/mobile'
6
+
7
+ module Bygpay
8
+ SUCCESS = 'success'
9
+ FAIL = 'fail'
10
+ PENDING = 'pending'
11
+
12
+ class << self
13
+ attr_accessor :configuration
14
+ end
15
+
16
+ def self.configuration
17
+ @configuration ||= Configuration.new
18
+ end
19
+
20
+ def self.reset
21
+ @configuration = Configuration.new
22
+ end
23
+
24
+ def self.configure
25
+ yield(configuration)
26
+ end
27
+ end
metadata ADDED
@@ -0,0 +1,123 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bygpay
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Alfred Rowe
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-05-17 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
+ - !ruby/object:Gem::Dependency
56
+ name: http
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.2'
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: 2.2.2
65
+ type: :runtime
66
+ prerelease: false
67
+ version_requirements: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - "~>"
70
+ - !ruby/object:Gem::Version
71
+ version: '2.2'
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: 2.2.2
75
+ description: Ruby Wrapper to process payments via any installed Bygpay Payment Gateway
76
+ email:
77
+ - alfred@encodevlabs.com
78
+ executables: []
79
+ extensions: []
80
+ extra_rdoc_files: []
81
+ files:
82
+ - ".gitignore"
83
+ - ".rspec"
84
+ - ".travis.yml"
85
+ - CODE_OF_CONDUCT.md
86
+ - Gemfile
87
+ - LICENSE.txt
88
+ - README.md
89
+ - Rakefile
90
+ - bin/console
91
+ - bin/setup
92
+ - bygpay.gemspec
93
+ - lib/bygpay.rb
94
+ - lib/bygpay/configuration.rb
95
+ - lib/bygpay/deposit/mobile.rb
96
+ - lib/bygpay/deposits.rb
97
+ - lib/bygpay/utils.rb
98
+ - lib/bygpay/version.rb
99
+ homepage: http://bygpay.com
100
+ licenses:
101
+ - MIT
102
+ metadata: {}
103
+ post_install_message:
104
+ rdoc_options: []
105
+ require_paths:
106
+ - lib
107
+ required_ruby_version: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ required_rubygems_version: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: '0'
117
+ requirements: []
118
+ rubyforge_project:
119
+ rubygems_version: 2.6.10
120
+ signing_key:
121
+ specification_version: 4
122
+ summary: Bygpay Payment Gateway Ruby SDK
123
+ test_files: []