khipu-api-client 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 921ecdf7f73df0184edab322a2f6a92f9c8f2728
-  data.tar.gz: c789b369dbc547d31bcf3940316271d5c54efe51
+  metadata.gz: 2f3b1dd67d2d2f7fa65933cfe213bc1347b8b74b
+  data.tar.gz: 34800d25548638e9f9b3c540ba5daf23a8448bff
 SHA512:
-  metadata.gz: 216e2b50d3011b2514cdc172e39bf9f28928ffb72ada0c04ae14497dc2f03931fcb1c681efc486ce1c6c3c6c36fe183e0ed1ab249b1ad48e46603f1494bc0c4d
-  data.tar.gz: be0aaee7971a357391de50117f4cd4e656d04a569ba9eaa8136e60097c6f29a2889be56887055995932d7d860bb30f3288fdb4775ab787bf25b3258fe02fc50d
+  metadata.gz: f94742a27a6a1356fa4e2d0de3b23e4009e6648ec66801d0b6aa7d632a8742d72567af1d87d49c51318661418657d4c0c475f27d1f0f27767cf9cfb1a3f49ad2
+  data.tar.gz: 9547c77ce0960fb8b7adb408843f1d9e4819418ba4006ca85dca94b255ab9899b9358abcb4a37cf9b841f28870992b4cf4d98c695b2ac9dc117937648df22f8f

data/README.md

@@ -1,26 +1,81 @@
 ## Installation
 
-```
+```sh
 gem install khipu-api-client
 ```
 
 ## Usage
 
-### Basic usage
+### Basic configuration
 ```ruby
 require 'khipu-api-client'
 
 Khipu.configure do  |c|
-  c.secret = 'abc123'
+  c.secret      = 'abc123'
   c.receiver_id = 1234
 end
+```
+
+### Basic usage
+
+#### Create a new payment
+```ruby
+api       = Khipu::PaymentsApi.new()
+options   = {
+              expires_date: 1.day.from_now.to_datetime, # DateTime.new(2016,1,1)
+              send_email:   true,
+              payer_name:   "payer",
+              payer_email:  "payer@mail.com"
+			}
+response  = api.payments_post("Test de api nueva", "CLP", 1, options)
+
+print response
+ # response keys:
+ #   [:payment_id, :payment_url, :simplified_transfer_url, :transfer_url, :app_url]
+
+```
+
+There are a more params you can send in each request. You might want to consider adding these to the options:
+
+```
+transaction_id  	# transaction id in your system
+return_url 			# after (potential) success, the client will be redirected to this url
+cancel_url			# if the payment is canceled, the client will be redirected to this url
+notify_url 			# khipu will send a notification to this url - the client will not see this request
+notify_api_version 	# "1.3"
+```
+
+#### Ask for payment status
+```
+api    = Khipu::PaymentsApi.new()
+status = api.payments_id_get(response.payment_id)
+print status
+```
+
+
+#### Confirm a payment
+If you send a notification_url when creating the payment or if you have set it up on your account configuration, Khipu will sent you a request with a notification_token and a api_version. You can use the notification_token param to get the payment information from the khipu service.
+
+```
+notification_token = params["notification_token"]
+client    = Khipu::PaymentsApi.new
+response  = client.payments_get(notification_token)
+if response.status == 'done'
+  # order = get_order(response.transaction_id)
+  # if order != nil and is_valid?(order, response)
+  #   setPurchased(order)
+  # end
+end
 
-api = Khipu::PaymentsApi.new()
-r1 = api.payments_post("Test de api nueva", "CLP", 1,
-                       {expires_date: DateTime.new(2016,4,4),
-                        send_email: true, payer_name: "payer",
-                        payer_email: "payer@mail.com"})
-print r1
-r2 = api.payments_id_get(r1.payment_id)
-print r2
+print response
+ # response keys:
+ #   [
+ #     :payment_id, :payment_url, :simplified_transfer_url, :transfer_url,
+ #     :app_url, :ready_for_terminal, :subject, :amount, :currency, :status,
+ #     :status_detail, :body, :picture_url, :receipt_url, :return_url,
+ #     :cancel_url, :notify_url, :notify_api_version, :expires_date,
+ #     :attachment_urls, :bank, :bank_id, :payer_name, :payer_email,
+ #     :personal_identifier, :bank_account_number, :out_of_date_conciliation,
+ #     :transaction_id, :custom, :responsible_user_email, :send_reminders, :send_email
+ #   ]
 ```

data/lib/khipu-api-client/api_client.rb

@@ -24,7 +24,7 @@ module Khipu
     def initialize(host = nil)
       @host = host || Configuration.base_url
       @format = 'json'
-      @user_agent = "khipu-api-ruby-client/#{VERSION}" + "|" + Configuration.platform + "/" + Configuration.platform_version
+      @user_agent = "khipu-api-ruby-client/#{VERSION}" + "|" + (Configuration.platform || '') + "/" + (Configuration.platform_version || '')
       @default_headers = {
         'Content-Type' => "application/#{@format.downcase}",
         'User-Agent' => @user_agent

data/lib/khipu-api-client/version.rb

@@ -1,3 +1,3 @@
 module Khipu
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: khipu-api-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - khipu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus