Project

gmxcheckout

0.0
No commit activity in last 3 years
No release in over 3 years
gmxcheckoutrainerborene/gmxcheckoutHomepageDocumentationSource CodeBug Tracker
A simple and easy to use library to integrate with gmxCheckout
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,874
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.2.0
Total releases
2
First release
2017-12-15
Latest release
2017-12-15
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-12-15
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.15
minitest
~> 5.0
rake
~> 10.0
vcr
>= 0

Runtime

faraday
>= 0
hashie
>= 0
multi_json
>= 0
 Project Readme

gmxCheckout

Build Status

A simple library to charge your customers in a monthly basis using gmxCheckout payment system.

Installation

Add this line to your application's Gemfile:

gem 'gmxcheckout'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gmxcheckout

Usage

Start by configuring the required api_key in your initializer.

GmxCheckout.configure do |config|
  config.api_key = ENV['GMXCHECKOUT_API_KEY']
end

Now you might want to use this pseudo-code in your User model on after_commit callback.

def charge_credit_card
  gmx = GmxCheckout::API.new

  response = gmx.subscriptions.create \
    amounts: [199_00],
    browser: extras[:browser],
    remote_ip: extras[:remote_ip],
    notification_url: extras[:notification_url],
    description: 'Awesome SaaS',
    invoice_name: 'Awesome SaaS',
    address: subscription.address,
    customer: {
      name: user.full_name,
      email: user.email,
      phone: subscription.phone,
      cpf: CPF.new(subscription.cpf).stripped
    },
    credit_card: subscription.credit_card_params.merge(
      holder_name: user.full_name
    )

  if response.success?
    subscription.code = response.body.subscription_code
    subscription.status = response.body.subscription_status
    subscription.expires_at = 30.days.from_now
    subscription.save
  else
    invalidate_credit_card
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/rainerborene/gmxcheckout.

License

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