Giter VIP home page Giter VIP logo

khalti-ruby's Introduction

Build Status codecov Gem Version Open Source Love MIT Licence

Khalti

Welcome to the khalti ruby gem. It is an API wrapper for Khalti payment gateway. For more info visit Khalti Gateway Docs.

Installation

Add this line to your application's Gemfile:

gem 'khalti'

And then execute:

$ bundle

Or install it yourself as:

$ gem install khalti

Usage

export KHALTI_SECRET_KEY=your_secret_key

It supports server side verification and transaction list/ find

Verification:

Khalti::Verification.verify('token', 'amount')

Transaction:

Khalti::Transaction.all
Khalti::Transaction.find(idx)

Development

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bajratech/khalti-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Khalti project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

khalti-ruby's People

Contributors

degendra avatar dependabot[bot] avatar nkarki avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

khalti-ruby's Issues

Reddit suggestions

https://www.reddit.com/r/ruby/comments/88jvt9/my_first_contribution_to_the_open_source_ruby_gem/

Most importantly: don't copy code unless you understand what is does.

Read the documentation for Net::HTTP. You're not closing your file descriptors. A long running process may runout of them and error.

JSON.parse(request.body) || {}. Under what circumstances will {} be returned?

Check HTTP response content type before parsing is as JSON. What if HTML is returned?

You should move the request/response lines into get(path), post(path, params) methods.

Create an exception class (or several), catch the various exceptions that can be raised by your HTTP and JSON code, and raise a meaningful exception using your class.

No need to use interpolation when the variable is already a String.

Error handling

  1. What if the server doesn't respond?
  2. What if the API key is invalid?
  3. What if the connection times out?
  4. What if the server returns a response you don't expect?

Create support for multiple khalti account

Instead of exporting KHALTI_SECRET_KEY, maybe we can create a class to instantiate a khalti object using a KHALTI_SECRET_KEY as a constructor to support multiple khalti accounts.

Update Readme

Update readme to answer the following questions.

  1. How to run rspec test?
  2. What is the valid token format?

Raise meaningful exception

Create an exception class (or several), catch the various exceptions that can be raised by your HTTP and JSON code, and raise a meaningful exception using your class.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.