iyzipay-subscriptions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e89a67851fd68dc371024c471c0c828f5b000d8cea48f8730fdd91f09f23182
+  data.tar.gz: f1f038874f64ca016f541edf22e45050ed73af65c4cc2d0eca3c638e75e59ad3
+SHA512:
+  metadata.gz: 037b90fe08242963d4a08234728d96697c0a965ae3bab108a14eaa70e22983b0af1a57c5729bc5295bf4a6fac249138ed01553f414e4bd908c884a718487b08a
+  data.tar.gz: aaec9508529eeb8cbe3734c4919745a998f565ef3d760c2e20b096c3f166e21efae89f5f1c0171f3d2768ce8de1240055c01184467810cb546e25cb398b7481d

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+tmp/*
+.lock
+.rvmrc
+.vimrc
+.redcar
+.bundle
+.rbx
+.idea/
+Gemfile.lock
+.Gemfile.lock
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+iyzipay

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+deploy:
+  provider: rubygems
+  api_key:
+    secure: oyTMpNUPMM2ExVpmXHCHrMc04aCgMcp0gJwhcDHlTyy7HpJBHZS3abBUCOxQOtBj7RKir7BkMFH+XoQz2OoIt//2+S9yBDTf1Nt15KkcXvJq9fIXSiHgiqnQnnZTuE5M2LE287lqO3mGXcJvTaosxO6Wh9K6K6pA0nSOt7DE4foG53MfjX4no1aazrlIDGqZYO4Ml8cHqph02Kp2U5N/+f5V3EfhYp9QshGa3AeUx+gIcXaIbh2v9fz1mEYA3qPFL4Yi9c36p9tqwhPe62pEYBmo9pDziSShIoGZiWMAKFS8qJXXHlWFAYmt9tFLmSNyiiWl35JPjU7Wz5wC9xQHP/o3ZsIT23/UrI0xBZxtTA0eqoeNRERAUN5kARqhKM4UMWyp4ss7+gA69B6zO58HGu/8ZPVn7zQ6yhSrMSTU03DOl3z05koS5YDNLBDKv903jeNO54j31OMlNXht7ugLTP+DNO35vTitzUvxzvOCpVAGuqoYABfATweVMYRUYf+3m6ypBlEC3k3Z2WLaez2FFEfIZXikhVzjWrxiaKfMdzc2XRgr8Ea3KxPmOeYN4gULGZXQaZJ37xQKTRyAkCbt0G/xi2L4q5bDP9NuvRjeijKGtyarshIpOdb9nTEVm8C43+H3mq2Y9Dwtv9dl5DoNYcJjJMiJv1hbldthlInPTqo=
+  gem: iyzipay
+  on:
+    tags: true
+    repo: iyzico/iyzipay-ruby
+  skip_cleanup: true
+script: rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 - iyzico Ödeme Hizmetleri A.Ş.  (https://iyzico.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,183 @@
+# iyzipay-ruby
+
+[![Build Status](https://travis-ci.org/iyzico/iyzipay-ruby.svg?branch=master)](https://travis-ci.org/iyzico/iyzipay-ruby)
+
+You can sign up for an iyzico account at https://iyzico.com
+
+# Requirements
+
+* Ruby 2.1 or newer
+* rest-client
+
+## Note
+
+Ruby 1.9.3 will not be supported in March 2018 for TLS 1.2 migration. Please upgrade your Ruby version to minimum 2.1.0. If you have any questions, please open an issue on Github or contact us at integration@iyzico.com.
+
+# Installation
+
+    gem install iyzipay
+
+## Bundler
+
+``` ruby
+source 'https://rubygems.org'
+
+gem 'iyzipay'
+
+```
+
+# Usage
+
+```ruby
+
+before :all do
+  @options = Iyzipay::Options.new
+  @options.api_key = 'your api key'
+  @options.secret_key = 'your secret key'
+  @options.base_url = 'https://sandbox-api.iyzipay.com'
+end
+
+it 'should create payment' do
+    payment_card = {
+        cardHolderName: 'John Doe',
+        cardNumber: '5528790000000008',
+        expireYear: '2030',
+        expireMonth: '12',
+        cvc: '123',
+        registerCard: 0
+    }
+    buyer = {
+        id: 'BY789',
+        name: 'John',
+        surname: 'Doe',
+        identityNumber: '74300864791',
+        email: 'email@email.com',
+        gsmNumber: '+905350000000',
+        registrationDate: '2013-04-21 15:12:09',
+        lastLoginDate: '2015-10-05 12:43:35',
+        registrationAddress: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
+        city: 'Istanbul',
+        country: 'Turkey',
+        zipCode: '34732',
+        ip: '85.34.78.112'
+    }
+    address = {
+        address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
+        zipCode: '34732',
+        contactName: 'John Doe',
+        city: 'Istanbul',
+        country: 'Turkey'
+    }
+
+    item1 = {
+        id: 'BI101',
+        name: 'Binocular',
+        category1: 'Collectibles',
+        category2: 'Accessories',
+        itemType: Iyzipay::Model::BasketItemType::PHYSICAL,
+        price: '0.3'
+    }
+    item2 = {
+        id: 'BI102',
+        name: 'Game code',
+        category1: 'Game',
+        category2: 'Online Game Items',
+        itemType: Iyzipay::Model::BasketItemType::VIRTUAL,
+        price: '0.5'
+    }
+    item3 = {
+        id: 'BI103',
+        name: 'Usb',
+        category1: 'Electronics',
+        category2: 'Usb / Cable',
+        itemType: Iyzipay::Model::BasketItemType::PHYSICAL,
+        price: '0.2'
+    }
+    request = {
+        locale: Iyzipay::Model::Locale::TR,
+        conversationId: '123456789',
+        price: '1.0',
+        paidPrice: '1.1',
+        installment: 1,
+        paymentChannel: Iyzipay::Model::PaymentChannel::WEB,
+        basketId: 'B67832',
+        paymentGroup: Iyzipay::Model::PaymentGroup::SUBSCRIPTION,
+        currency: Iyzipay::Model::Currency::TRY,
+        paymentCard: payment_card,
+        buyer: buyer,
+        billingAddress: address,
+        shippingAddress: address,
+        basketItems: [item1, item2, item3]
+    }
+    payment = Iyzipay::Model::Payment.new.create(request, @options)
+    begin
+      $stderr.puts payment.inspect
+    rescue
+      $stderr.puts 'oops'
+      raise
+    end
+  end
+```
+See other samples under iyzipay-ruby/spec module.
+
+Testing
+=======
+
+You can run specs with RSpec under spec module.
+
+### Mock test cards
+
+Test cards that can be used to simulate a *successful* payment:
+
+Card Number      | Bank                       | Card Type
+-----------      | ----                       | ---------
+5890040000000016 | Akbank                     | Master Card (Debit)
+5526080000000006 | Akbank                     | Master Card (Credit)
+4766620000000001 | Denizbank                  | Visa (Debit)
+4603450000000000 | Denizbank                  | Visa (Credit)
+4729150000000005 | Denizbank Bonus            | Visa (Credit)
+4987490000000002 | Finansbank                 | Visa (Debit)
+5311570000000005 | Finansbank                 | Master Card (Credit)
+9792020000000001 | Finansbank                 | Troy (Debit)
+9792030000000000 | Finansbank                 | Troy (Credit)
+5170410000000004 | Garanti Bankası            | Master Card (Debit)
+5400360000000003 | Garanti Bankası            | Master Card (Credit)
+374427000000003  | Garanti Bankası            | American Express
+4475050000000003 | Halkbank                   | Visa (Debit)
+5528790000000008 | Halkbank                   | Master Card (Credit)
+4059030000000009 | HSBC Bank                  | Visa (Debit)
+5504720000000003 | HSBC Bank                  | Master Card (Credit)
+5892830000000000 | Türkiye İş Bankası         | Master Card (Debit)
+4543590000000006 | Türkiye İş Bankası         | Visa (Credit)
+4910050000000006 | Vakıfbank                  | Visa (Debit)
+4157920000000002 | Vakıfbank                  | Visa (Credit)
+5168880000000002 | Yapı ve Kredi Bankası      | Master Card (Debit)
+5451030000000000 | Yapı ve Kredi Bankası      | Master Card (Credit)
+
+*Cross border* test cards:
+
+Card Number      | Country
+-----------      | -------
+4054180000000007 | Non-Turkish (Debit)
+5400010000000004 | Non-Turkish (Credit)
+
+Test cards to get specific *error* codes:
+
+Card Number       | Description
+-----------       | -----------
+5406670000000009  | Success but cannot be cancelled, refund or post auth
+4111111111111129  | Not sufficient funds
+4129111111111111  | Do not honour
+4128111111111112  | Invalid transaction
+4127111111111113  | Lost card
+4126111111111114  | Stolen card
+4125111111111115  | Expired card
+4124111111111116  | Invalid cvc2
+4123111111111117  | Not permitted to card holder
+4122111111111118  | Not permitted to terminal
+4121111111111119  | Fraud suspect
+4120111111111110  | Pickup card
+4130111111111118  | General error
+4131111111111117  | Success but mdStatus is 0
+4141111111111115  | Success but mdStatus is 4
+4151111111111112  | 3dsecure initialize failed

data/Rakefile

@@ -0,0 +1,5 @@
+task default: %w[test]
+
+task :test do
+  puts "@TODO"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.45

data/contributors

@@ -0,0 +1,2 @@
+Yalcin Yenigun
+Nurettin Bakkal

data/examples/options.rb

@@ -0,0 +1,4 @@
+@options = Iyzipay::Options.new
+@options.api_key = 'YOUR_API_KEY'
+@options.secret_key = 'YOUR_SECRET_KEY'
+@options.base_url = 'https://sandbox-api.iyzipay.com' # use https://api.iyzipay.com for production

data/examples/plan.rb

@@ -0,0 +1,36 @@
+require 'iyzipay'
+require_relative 'options.rb'
+
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+# Subscription Plan API end-point
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+plan = Iyzipay::Model::V2::Plan.new
+# Create new plan
+plan_create_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '12341234',
+    productReferenceCode: 'YOUR_PRODUCT_REFERENCE_CODE',
+    name: 'Plan Name',
+    price: 100.00,
+    currencyCode: 'TL',
+    paymentInterval: 'MONTHLY',
+    paymentIntervalCount: 1,
+    trialPeriodDays: 7,
+    planPaymentType: 'RECURRING'
+}
+result = plan.create(plan_create_params, @options)
+puts "Plan create: #{result}"
+
+# Update plan
+plan_update_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '12341234',
+    pricingPlanReferenceCode: 'YOUR_PRICING_PLAN_REFERENCE_CODE',
+    name: 'Update Plan',
+    trialPeriodDays: 3,
+}
+
+result = plan.update(plan_update_params, @options)
+puts "Plan update: #{result}"

data/examples/product.rb

@@ -0,0 +1,32 @@
+require 'iyzipay'
+require_relative 'options.rb'
+
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+# Subscription Product API end-point
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+product = Iyzipay::Model::V2::Product.new
+# List all products
+result = product.list(@options)
+puts "Product list: #{result.inspect}"
+
+# Create new product
+product_create_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '12341234',
+    name: 'New Product',
+    description: 'My Product'
+}
+result = product.create(product_create_params, @options)
+puts "Product create: #{result}"
+
+# Update product
+product_update_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    productReferenceCode: 'YOUR_PRODUCT_REFERENCE_CODE',
+    name: 'Update Product',
+    description: 'My Product'
+}
+result = product.update(product_update_params, @options)
+puts "Product update: #{result}"

data/examples/subscription.rb

@@ -0,0 +1,33 @@
+require 'iyzipay'
+require_relative 'options.rb'
+
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+# Subscription Operations API end-point
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+subscription = Iyzipay::Model::V2::Subscription.new
+
+# Activate
+activate_params = {
+    subscriptionReferenceCode: 'YOUR_CODE',
+}
+response = subscription.activate(activate_params, @options)
+puts "Subscription activate: #{response}"
+
+# Cancel
+cancel_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '1234512345',
+    subscriptionReferenceCode: 'YOUR_CODE'
+}
+response = subscription.cancel(cancel_params, @options)
+puts "Subscription cancel: #{response}"
+
+# Retry
+retry_params = {
+    referenceCode: 'YOUR_CODE'
+}
+
+result = subscription.retry(retry_params, @options)
+puts "Subscription retry: #{result}"

data/examples/subscription_checkout_form_initialize.rb

@@ -0,0 +1,39 @@
+require 'iyzipay'
+require_relative 'options.rb'
+
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+# Subscription Checkout Form API end-point
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+checkout_form = Iyzipay::Model::V2::CheckoutFormInitialize.new
+
+# Address Params
+address = {
+    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
+    zipCode: '34732',
+    contactName: 'John Doe',
+    city: 'Istanbul',
+    country: 'Turkey'
+}
+
+buyer = {
+    name: 'John',
+    surname: 'Doe',
+    email: 'john.doe@gmail.com',
+    gsmNumber: '+905555555555',
+    identityNumber: '16038567668',
+    billingAddress: address,
+    shippingAddress: address
+}
+# Checkout form initialize params
+checkout_form_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '1234512345',
+    callbackUrl: 'YOUR_CALLBACK_URL',
+    pricingPlanReferenceCode: 'YOUR_PRICING_PLAN_REFERENCE_CODE',
+    customer: buyer
+}
+
+result = checkout_form.create(checkout_form_params, @options)
+puts "Result: #{result}"

data/examples/subscription_initialize.rb

@@ -0,0 +1,47 @@
+require 'iyzipay'
+require_relative 'options.rb'
+
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+# Subscription Initialize API end-point
+# -------------------------------------------------------------
+# -------------------------------------------------------------
+subscription = Iyzipay::Model::V2::SubscriptionInitialize.new
+# Address
+address = {
+    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
+    zipCode: '34732',
+    contactName: 'John Doe',
+    city: 'Istanbul',
+    country: 'Turkey'
+}
+
+buyer = {
+    name: 'John',
+    surname: 'Doe',
+    email: 'john.doe@gmail.com',
+    gsmNumber: '+905422073160',
+    identityNumber: '16038567668',
+    billingAddress: address,
+    shippingAddress: address
+}
+# Card
+card = {
+    cardHolderName: 'John Doe',
+    cardNumber: '5528790000000008',
+    expireMonth: '12',
+    expireYear: '2030',
+    cvc: '123',
+    registerConsumerCard: true
+}
+# Create new product
+checkout_form_params = {
+    locale: Iyzipay::Model::Locale::TR,
+    conversationId: '1234512345',
+    callbackUrl: 'https://iyzipay-subscription.herokuapp.com/subscriptions/callback',
+    pricingPlanReferenceCode: 'YOUR_PRICING_PLAN_REFERENCE_CODE',
+    customer: buyer,
+    paymentCard: card
+}
+result = subscription.create(checkout_form_params, @options)
+puts "Subscription create: #{result}"