Giter Club home page Giter Club logo

razorpay-ruby's Introduction

Razorpay Ruby bindings

Build Status Gem Version Coverage Status License

This is the base ruby gem for interacting with the Razorpay API. This is primarily meant for users who wish to perform interactions with the Razorpay API programatically.

Installation

Add this line to your application's Gemfile:

gem 'razorpay'

And then execute:

$ bundle

Or install it yourself as:

$ gem install razorpay

Requirements

Ruby 2.6.8 or later

Usage

Remember to require 'razorpay' before anything else.

Next, you need to setup your key and secret using the following:

Razorpay.setup('key_id', 'key_secret')

You can set customer headers for your requests using the following:

Razorpay.headers = {"CUSTOM_APP_HEADER" => "CUSTOM_VALUE"}

You can find your API keys at https://dashboard.razorpay.com/#/app/keys.

If you are using rails, the right place to do this might be config/initializers/razorpay.rb.

Supported Resources

Development

  • Everything is namespaced under the Razorpay module
  • We use rubocop for checking style guidelines
  • Rake + MiniTest is using as the testrunner
  • Webmock is used as the request mock framework
  • HTTParty is used for making requests
  • Travis is used for CI
  • Coveralls is used for coverage reports

Contributing

  1. Fork it ( https://github.com/razorpay/razorpay-ruby/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Run rake and rubocop after making your changes to make sure you didn't break anything
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Release

Steps to follow for a release:

  1. Merge the branch with the new code to master.
  2. Bump the Version in lib/razorpay/constants.rb
  3. Rename Unreleased to the new tag in CHANGELOG
  4. Fix links at bottom in CHANGELOG
  5. Commit (message should include version number)
  6. Tag the release and push to GitHub. Get the tag signed using Razorpay GPG key.
  7. Create a release on GitHub using the website with more details about the release
  8. Run gem build razorpay-ruby.gemspec
  9. Run gem push razorpay-{version}.gem

gem push will ask you for credentials, if you are not logged in already.

razorpay-ruby's People

Contributors

ankitdas13 avatar harman28 avatar captn3m0 avatar akshaybhalotia avatar abizerlokhandwala avatar chandansunag avatar dharshan avatar dhavalkapil avatar harshilmathur avatar pikender avatar shobhitic avatar varun-raj avatar dependabot-preview[bot] avatar prem-razorpay avatar

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.