Merge pull request #5 from l0ck3/master

Adds code samples for the API Reference

.gitignore

@@ -13,3 +13,5 @@
 *.a
 mkmf.log
 spec/cassettes
+
+.DS_Store

samples/authentication/authentication.rb

@@ -0,0 +1 @@
+Paymill.api_key = "<YOUR_PRIVATE_KEY>"

samples/clients/create_new_client.rb

@@ -0,0 +1,4 @@
+Paymill::Client.create(
+    email: 'lovely-client@example.com',
+    description: 'Lovely Client'
+)

samples/clients/export_clients_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/clients/get_client_details.rb

@@ -0,0 +1 @@
+Paymill::Client.find('client_88a388d9dd48f86c3136')

samples/clients/list_clients.rb

@@ -0,0 +1 @@
+Paymill::Client.all

samples/clients/remove_client.rb

@@ -0,0 +1,2 @@
+client = Paymill::Client.find('client_88a388d9dd48f86c3136')
+client.delete

samples/clients/update_client.rb

@@ -0,0 +1,4 @@
+client = Paymill::Client.find('client_88a388d9dd48f86c3136')
+client.email = 'lovely-client@example.com'
+client.description = 'My Lovely Client'
+client.update

samples/offers/create_new_offer.rb

@@ -0,0 +1,7 @@
+Paymill::Offer.create(
+    amount: 4200,
+    currency: 'EUR',
+    interval: '1 MONTH',
+    name: 'Nerd Special',
+    trial_period_days: 0
+)

samples/offers/export_offers_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/offers/get_offer_details.rb

@@ -0,0 +1 @@
+Paymill::Offer.find('offer_40237e20a7d5a231d99b')

samples/offers/list_offers.rb

@@ -0,0 +1 @@
+Paymill::Offer.all()

samples/offers/remove_offer.rb

@@ -0,0 +1,7 @@
+# with subscriptions:
+offer = Paymill::Offer.find('offer_40237e20a7d5a231d99b')
+offer.delete_with_subscriptions()
+
+# without subscriptions:
+offer = Paymill::Offer.find('offer_40237e20a7d5a231d99b')
+offer.delete_without_subscriptions()

samples/offers/update_offer.rb

@@ -0,0 +1,8 @@
+offer = Paymill::Offer.find('offer_40237e20a7d5a231d99b')
+
+offer.name = 'Extended Special'
+offer.interval = '1 MONTH'
+offer.currency = 'USD'
+offer.amount = '3333'
+
+offer.update( update_subscriptions: true )

samples/payments/create_new_credit_card_payment_with_token.rb

@@ -0,0 +1 @@
+Paymill::Payment.create( token: '098f6bcd4621d373cade4e832627b4f6' )

samples/payments/create_new_credit_card_payment_with_token_and_client.rb

@@ -0,0 +1,4 @@
+Paymill::Payment.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    client: 'client_88a388d9dd48f86c3136'
+)

samples/payments/create_new_debit_payment_with_token.rb

@@ -0,0 +1 @@
+Paymill::Payment.create( token: '12a46bcd462sd3r3care4e8336ssb4f5' )

samples/payments/create_new_debit_payment_with_token_and_client.rb

@@ -0,0 +1,4 @@
+Paymill::Payment.create(
+    token: '12a46bcd462sd3r3care4e8336ssb4f5',
+    client: 'client_88a388d9dd48f86c3136'
+)

samples/payments/export_payments_list.rb

@@ -0,0 +1 @@
+# Not yet implemented

samples/payments/get_payment_details.rb

@@ -0,0 +1 @@
+Paymill::Payment.find( 'pay_3af44644dd6d25c820a8' )

samples/payments/list_payments.rb

@@ -0,0 +1 @@
+Paymill::Payment.all

samples/payments/remove_payment.rb

@@ -0,0 +1,2 @@
+payment = Paymill::Payment.find( 'pay_ea98515b29437b046207ea45' )
+payment.delete

samples/preauthorizations/create_new_preauthorization_with_payment.rb

@@ -0,0 +1,8 @@
+payment = Paymill::Payment.create(token: '098f6bcd4621d373cade4e832627b4f6')
+
+Paymill::Preauthorization.create(
+    payment: payment.id,
+    amount: 4200,
+    currency: 'EUR',
+    description: 'description example'
+)

samples/preauthorizations/create_new_preauthorization_with_token.rb

@@ -0,0 +1,6 @@
+Paymill::Preauthorization.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    amount: 4200,
+    currency: 'EUR',
+    description: 'description example'
+)

samples/preauthorizations/export_preauthorizations_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/preauthorizations/get_preauthorization_details.rb

@@ -0,0 +1 @@
+Paymill::Preauthorization.find('preauth_31eb90495837447f76b7')

samples/preauthorizations/list_preauthozizations.rb

@@ -0,0 +1 @@
+Paymill::Preauthorization.all()

samples/preauthorizations/remove_preauthorization.rb

@@ -0,0 +1,2 @@
+preauthorization = Paymill::Preauthorization.find('preauth_31eb90495837447f76b7')
+preauthorization.delete

samples/refunds/create_new_refund.rb

@@ -0,0 +1,11 @@
+transaction = Paymill::Transaction.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    amount: 4200,
+    currency: 'USD'
+)
+
+Paymill::Refund.create(
+    transaction,
+    amount: 4200,
+    description: 'Sample Description'
+)

samples/refunds/export_refunds_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/refunds/get_refund_details.rb

@@ -0,0 +1 @@
+Paymill::Refund.find('refund_87bc404a95d5ce616049')

samples/refunds/list_refunds.rb

@@ -0,0 +1 @@
+Paymill::Refund.all()

samples/subscriptions/cancel_subscription.rb

@@ -0,0 +1,2 @@
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.cancel()

samples/subscriptions/create_new_subscription_with_an_offer.rb

@@ -0,0 +1,15 @@
+payment = Paymill::Payment.create(token: '098f6bcd4621d373cade4e832627b4f6')
+offer = Paymill::Offer.create(
+    amount: 3333,
+    currency: 'EUR',
+    interval: '1 WEEK',
+    name: 'Nerd Special',
+    trial_period_days: 30
+    )
+
+Paymill::Subscription.create(
+    payment: payment,
+    offer: offer,
+    period_of_validity: '2 YEAR',
+    start_at: 2.days.from_now
+)

samples/subscriptions/create_new_subscription_with_an_offer_and_different_values.rb

@@ -0,0 +1,19 @@
+payment = Paymill::Payment.create(token: '098f6bcd4621d373cade4e832627b4f6')
+offer = Paymill::Offer.create(
+    amount: 4200,
+    currency: 'EUR',
+    interval: '1 MONTH',
+    name: 'Nerd Special',
+    trial_period_days: 30
+)
+
+Paymill::Subscription.create(
+    payment: payment,
+    offer: offer,
+    amount: 3000,
+    currency: 'EUR',
+    interval: '1 week, monday',
+    name: 'Example Subscription',
+    period_of_validity: '2 YEAR',
+    start_at: 2.days.from_now
+)

samples/subscriptions/create_new_subscription_without_an_offer.rb

@@ -0,0 +1,13 @@
+client = Paymill::Client.create(email: 'client@example.com')
+payment = Paymill::Payment.create(token: '098f6bcd4621d373cade4e832627b4f6', client: client)
+
+Paymill::Subscription.create(
+    payment: payment,
+    client: client,
+    name: 'Example Subscription',
+    amount: 3000,
+    currency: 'EUR',
+    interval: '1 week,monday',
+    period_of_validity: '2 YEAR',
+    start_at: 2.days.from_now
+)

samples/subscriptions/delete_subscription.rb

@@ -0,0 +1,2 @@
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.remove()

samples/subscriptions/export_subscriptions_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/subscriptions/get_subscription_details.rb

@@ -0,0 +1 @@
+Paymill::Subscription.find("sub_dc180b755d10da324864")

samples/subscriptions/list_subscriptions.rb

@@ -0,0 +1 @@
+Paymill::Subscription.all()

samples/subscriptions/pause_subscription.rb

@@ -0,0 +1,7 @@
+#pause:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.pause
+
+#play:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.play

samples/subscriptions/update_subscription.rb

@@ -0,0 +1,12 @@
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.payment = 'pay_95ba26ba2c613ebb0ca8'
+subscription.currency = 'USD'
+subscription.interval = '1 month,friday'
+subscription.name = 'Changed Subscription'
+subscription.trial_end = false
+subscription.update
+
+# for limit / unlimit use
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.unlimit
+subscription.limit('12 MONTH')

samples/subscriptions/update_subscription_amount.rb

@@ -0,0 +1,7 @@
+#amount temporary:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.update_amount_once(1234)
+
+#amount permanently:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+subscription.update_amount_permanently(1234)

samples/subscriptions/update_subscription_offer.rb

@@ -0,0 +1,14 @@
+#offer with no refund and unchanged capture date:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+offer = Offer.create(name: 'Foo', amount: 4990, currency: 'EUR', interval: '2 WEEK')
+subscription.update_offer_without_changes(offer)
+
+#offer with refund and unchanged capture date:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+offer = Offer.create(name: 'Foo', amount: 4990, currency: 'EUR', interval: '2 WEEK')
+subscription.update_offer_with_refund(offer)
+
+#offer with refund and capture date:
+subscription = Paymill::Subscription.find('sub_dea86e5c65b2087202e3')
+offer = Offer.create(name: 'Foo', amount: 4990, currency: 'EUR', interval: '2 WEEK')
+subscription.update_offer_with_refund_and_capture_date(offer)

samples/transactions/create_new_transaction_with_app_fee.rb

@@ -0,0 +1,8 @@
+Paymill::Transaction.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    amount: 4200, currency: 'EUR',
+    description: 'Test Transaction',
+    fee_amount: 4200,
+    fee_payment: 'pay_a818b847db6ce5ff636f',
+    fee_currency: 'EUR'
+)

samples/transactions/create_new_transaction_with_client_and_payment.rb

@@ -0,0 +1,12 @@
+client = Paymill::Client.create(email: 'mail@example.com')
+payment = Paymill::Payment.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    client: client
+)
+
+Paymill::Transaction.create(
+    payment: payment,
+    client: client,
+    amount: 4200,
+    currency: 'EUR'
+)

samples/transactions/create_new_transaction_with_payment.rb

@@ -0,0 +1,7 @@
+payment = Paymill::Payment.create(token: '098f6bcd4621d373cade4e832627b4f6')
+transaction = Paymill::Transaction.create(
+    payment: payment,
+    amount: 4200,
+    currency: 'EUR',
+    description: 'Test Transaction'
+)

samples/transactions/create_new_transaction_with_preauthorization.rb

@@ -0,0 +1,10 @@
+preauthorization = Paymill::Preauthorization.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    amount: 4200,
+    currency: 'EUR'
+)
+transaction = Transaction.create(
+    preauthorization: preauthorization,
+    amount: 4200,
+    currency: 'EUR'
+)

samples/transactions/create_new_transaction_with_token.rb

@@ -0,0 +1,6 @@
+Paymill::Transaction.create(
+    token: '098f6bcd4621d373cade4e832627b4f6',
+    amount: 4200,
+    currency: 'EUR',
+    description: 'Test Transaction'
+)

samples/transactions/export_transactions_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/transactions/get_transaction_details_by_id.rb

@@ -0,0 +1 @@
+Paymill::Transaction.find('tran_023d3b5769321c649435')

samples/transactions/get_transaction_details_by_slv.rb

@@ -0,0 +1 @@
+Paymill::Transaction.find('tran_023d3b5769321c649435')

samples/transactions/list_transactions.rb

@@ -0,0 +1 @@
+Paymill::Transaction.all()

samples/transactions/upate_transaction.rb

@@ -0,0 +1,3 @@
+transaction =  Paymill::Transaction.find('tran_023d3b5769321c649435')
+transaction.description = 'My updated transaction description'
+transaction.update

samples/webhooks/create_new_email_webhook.rb

@@ -0,0 +1,5 @@
+Paymill::Webhook.create(
+    email: 'webhook@example.com',
+    event_types: ['transaction.succeeded', 'transaction.failed'],
+    active: false
+)

samples/webhooks/create_new_url_webhook.rb

@@ -0,0 +1,4 @@
+Paymill::Webhook.create(
+    url: 'http://example.com',
+    event_types: ['transaction.succeeded', 'transaction.failed']
+)

samples/webhooks/export_webhooks_list.rb

@@ -0,0 +1 @@
+# Not implemented yet

samples/webhooks/get_webhook_details.rb

@@ -0,0 +1 @@
+Paymill::Webhook.find('hook_40237e20a7d5a231d99b')

samples/webhooks/remove_webhook.rb

@@ -0,0 +1,2 @@
+webhook = Paymill::Webhook.find(active_webhook_id)
+webhook.delete()

samples/webhooks/update_webhook.rb

@@ -0,0 +1,3 @@
+webhook = Paymill::Webhook.find(active_webhook_id)
+webhook.email = 'mail@example.com'
+webhook.update()