https://github.com/rorkjop/klarna-checkout-ruby
Ruby Wrapper for Klarna Checkout Rest API
https://github.com/rorkjop/klarna-checkout-ruby
gem klarna ruby
Last synced: 4 months ago
JSON representation
Ruby Wrapper for Klarna Checkout Rest API
- Host: GitHub
- URL: https://github.com/rorkjop/klarna-checkout-ruby
- Owner: rorkjop
- License: mit
- Created: 2014-01-31T14:14:47.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2017-11-10T09:51:16.000Z (over 8 years ago)
- Last Synced: 2025-12-11T05:59:40.125Z (5 months ago)
- Topics: gem, klarna, ruby
- Language: Ruby
- Size: 104 KB
- Stars: 8
- Watchers: 6
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/rorkjop/klarna-checkout-ruby)
[](https://codeclimate.com/github/rorkjop/klarna-checkout-ruby)
[](https://codeclimate.com/github/rorkjop/klarna-checkout-ruby/coverage)
[](http://badge.fury.io/rb/klarna-checkout)
# Klarna Checkout
Unofficial Ruby Wrapper for Klarnas Checkout Rest API.
## Installation
Add this line to your application's Gemfile:
gem 'klarna-checkout'
And then execute:
$ bundle
Or install it yourself as:
$ gem install klarna-checkout
## Usage
```ruby
require 'klarna/checkout'
# a) Create a client with shared_secret directly
client = Klarna::Checkout::Client.new({
shared_secret: 'your-shared-secret',
environment: :test # or :production
})
# b) Create a client with shared_secret from module configuration
Klarna::Checkout.configure do |config|
config.shared_secret = 'your-shared-secret'
end
client = Klarna::Checkout::Client.new(environment: :test)
client.shared_secret
# => 'your-shared-secret'
# Initialize an order
order = Klarna::Checkout::Order.new({
purchase_country: 'NO',
purchase_currency: 'NOK',
locale: 'nb-no',
cart: {
items: [{
reference: '1123581220325',
name: 'Widget',
quantity: 1,
unit_price: 666,
tax_rate: 2500
}]
},
merchant: {
id: '1337',
terms_uri: 'http://www.example.com/terms',
checkout_uri: 'http://www.example.com/checkout',
confirmation_uri: 'http://www.example.com/confirmation_uri',
push_uri: 'http://www.example.com/push'
}
})
# Create the order with Klarna
client.create_order(order)
order.id
# => ID of the order (no other attributes are updated)
# Read an order from Klarna
order = client.read_order("1234ABCD")
# Configuring some global variables
Klarna::Checkout.configure do |config|
config.shared_secret = 'your-shared-secret'
config.merchant_id = '12345'
config.default_country = 'NO'
config.default_currency = 'NOK'
end
# Instead of repeating yourself with supplying the same attributes for each
# order you can configure some default attributes
Klarna::Checkout::Order.defaults = {
purchase_country: 'NO',
purchase_currency: 'NOK',
locale: 'nb-no',
merchant: {
id: '1337',
terms_uri: 'http://www.example.com/terms',
checkout_uri: 'http://www.example.com/checkout',
confirmation_uri: 'http://www.example.com/confirmation_uri',
push_uri: 'http://www.example.com/push'
}
}
# All newly created orders will then have these attributes
order = Klarna::Checkout::Order.new
order.purchase_country
# => 'NO'
```
## TODO
* Validation of objects according to documentation
* Respect readonly attributes
## Supported Rubies
* 2.2
* 2.4
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes, don't forget to add tests (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request