Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paymill/paymill-ruby

Ruby wrapper for the Paymill API
https://github.com/paymill/paymill-ruby

Last synced: about 1 month ago
JSON representation

Ruby wrapper for the Paymill API

Awesome Lists containing this project

README 

        
![PAYMILL icon](https://static.paymill.com/r/335f99eb3914d517bf392beb1adaf7cccef786b6/img/logo-download_Light.png)



paymill-ruby

============



Ruby wrapper for PAYMILL API forked from [dkd's paymill-ruby](https://github.com/dkd/paymill-ruby)



[![Build Status](https://travis-ci.org/paymill/paymill-ruby.svg)](https://travis-ci.org/paymill/paymill-ruby) [![Code Climate](https://codeclimate.com/github/paymill/paymill-ruby/badges/gpa.svg)](https://codeclimate.com/github/paymill/paymill-ruby)



Getting started

===============



-	If you are not familiar with PAYMILL, start with the [documentation](https://developers.paymill.com).

-	Install the latest release.

-	Check the API [reference](https://developers.paymill.com/API/).

-	Check the specification examples.

-	Take a look at the [change log](./CHANGELOG.md) for recent updates and improvements.



Installation

============



Add this line to your application's Gemfile:



```ruby

gem 'paymill_ruby', '~> 2.0', require: 'paymill'

```



And then execute:



```

$ bundle

```



The paymill gem is tested on Ruby 2.0.0, 2.1.x and 2.2.x. It requires ruby version 2.0 and up.



Usage

=====



Initialize the library by providing your api key:



```ruby

require 'paymill'



Paymill.api_key = ''

```



or by reading it from the envirounment variables



```ruby

require 'paymill'



Paymill.api_key = ENV['PAYMILL_API_TEST_PRIVATE_KEY']

```



Clients

-------



#### Creating clients



Creating via factory method **create**, which expects an optional hash as arguments. If some of the required attributes are missing the method will throw **ArgumentError**.



With a hash of optional arguments:



```ruby

client = Paymill::Client.create( email: '[email protected]', description: 'Main caracter in First Blood' )

```



Without mandatory arguments:



```ruby

client = Paymill::Client.create

```



#### Find existing client



You can retrieve an object by using the **find** method with an object id:



```ruby

client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )

```



or with the instance itself:



```ruby

client = Paymill::Client.find( client )

```



#### Update client



Update is done by modifying the instance variables of the object. The object itself provides accessor methods only for properties which can be updated.



```ruby

client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )



client.email = '[email protected]'

client.description = 'Main caracter in First Blood II'



client.update

```



#### Deleting client



You may delete objects by calling the its instance method **delete**. The delete method will return nil when the given object is removed successfully.



```ruby

client = Paymill::Client.find( 'client_b54ff8b3811e06c02e14' )

client.delete

```



#### Retrieving lists



To retrieve a list you may simply use the **all** class method



```ruby

clients = Paymill::Client.all

```



You may provide filter, order, offset and count parameters to list method



```ruby

clients = Paymill::Client.all( order: [:email, :created_at_desc], count: 30, offset: 10, filters: [email: '[email protected]', created_at: "#{4.days.ago.to_i}-#{2.days.ago.to_i}"] )

```



Offer

-----



#### Update offer



When you want to update the offer and to apply the new changes to its subscriptions you can pass an additional parameter update_subscriptions set to true to its instance method **update**



```ruby

offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )

offer.amount = 1000



offer.update( update_subscriptions: true )

```



#### Deleting offer



To delete an offer and its corresponding subscriptions call



```ruby

offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )

offer.delete_with_subscriptions()

```



To delete an offer but leave its corresponding subscriptions call



```ruby

offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )

offer.delete_without_subscriptions

```



To delete an offer and its corresponding subscriptions you can call the instance method **delete** with an argument remove_with_subscriptions set to true



```ruby

offer = Offer.find( 'offer_b54ff8b3811e06c02e14' )

offer.delete( remove_with_subscriptions: true )

```



Refund

------



#### Creating refunds



To create a refund you have to pass a transaction, which you want to be refunded.



```ruby

transaction = Transaction.create( token: '098f6bcd4621d373cade4e832627b4f6', amount: 990, currency: 'EUR' )

refund = Refund.create( transaction, amount: 100 )

```



Checksum

--------



For transactions that are started client-side, e.g. PayPal checkout, it is required to first create a checksum on your server and then provide that checksum when starting the transaction in the browser. The checksum needs to contain all data required to subsequently create the actual transaction. In the examples below checksum is created with address, Shopping cart item and fee. Of course you can use all variations from this parameters to fit your needs.



#### Creating plain checksum



```ruby

Checksum.create( checksum_type: 'paypal', amount: 4200, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel' )

```



#### Creating checksum with address



```ruby

billing_address = Address.new( name: 'Primary', street_address: 'Rambo Str.', street_address_addition: '', city: 'Sofia', state: 'Sofia', postal_code: 1234, country: 'BG', phone: '088 41 555 27' )

Checksum.create( checksum_type: 'paypal', amount: 4200, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', billing_address: billing_address )

```



#### Creating checksum with items



```ruby

rambo_poster = ShoppingCartItem.new( name: "Rambo Poster", description: "John J. Rambo", amount: 2200, quantity: 3, item_number: "898-24342-343", url: "http://www.store.com/items/posters/12121-rambo" )

comando_poster = ShoppingCartItem.new( name: "Comando Poster", description: "John Matrix", amount: 3100, quantity: 1, item_number: "898-24342-341", url: "http://www.store.com/items/posters/12121-comando" )

Checksum.create( checksum_type: 'paypal', amount: 9700, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', items: [rambo_poster, comando_poster] )

```



#### Creating checksum with fee



```ruby

Checksum.create( checksum_type: 'paypal', amount: 9700, currency: 'EUR', description: 'Chuck Testa', return_url: 'https://testa.com', cancel_url: 'https://test.com/cancel', fee_amount: 100, fee_payment: 'pay_3af44644dd6d25c820a8', fee_currency: 'EUR', app_id: '8fh98hfd828ej2e09dk0hf9' )

```



Contributing

============



1. [Fork it](https://github.com/paymill/paymill-ruby/fork)

2. Create feature branch

  - `git checkout -b my-new-feature`

3. Setup the project

  - `bundle install`

4. Setup PAYMILL's keys in your environment:

  -	private test key `export PAYMILL_API_TEST_PRIVATE_KEY=""`

  -	public test key `export PAYMILL_API_TEST_PUBLIC_KEY=""`

5. Run the tests

  - all specs: `rspec .`

  - single spec: `rspec ./spec/paymill/models/client_spec.rb`

6. Commit your changes

  - `git commit -am 'Add some feature'`

7. Push your changes

  - `git push origin my-new-feature`

8. Create new Pull Request