tpaga 0.4.5 → 0.4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d7363879b3c8082ec127ec5f396758890ee83d4
-  data.tar.gz: 45507b1a3250b7c731249e3e6f654f62bd0940a9
+  metadata.gz: af5043cb38385469f6f4cb3e8f4ade696b981ed7
+  data.tar.gz: 2f1af15f7f22902f3bb5f6798d66d162d7085929
 SHA512:
-  metadata.gz: bfbddf2b239c3c94359c1fc891ae50d2ece4f3c760bda2c8ff15aea130c7ca35108b7d68159174492bed3a5e67318e3f7604cf17d20af5c4d0dfcb438d189cb7
-  data.tar.gz: 3a61d89a1c133052d82dd77f48d8ca32b37d3ef19ced625b5407dabe06afd1de63e3185f5f994bf177d268e45673fab224ba49358d002274935e3ad62578f6d3
+  metadata.gz: 9549834f094606535f930006174a12a0d8964745696e25e6ea2a1451cf98453fbe60802dbfcd4a24cde862a9c14d203bfe8b6d2d482006995462ff2312c584c0
+  data.tar.gz: 4fe23c9dd476a7cd37aaca8d97223863f28cbe1f87bfee7851253b4f7cb76e7db91bc875f44d1f4a23c1ecbb74b72bf056d9a5f0f62e764ee969f66c5470a0c9

data/README.md

@@ -0,0 +1,151 @@
+TPaga ruby
+===
+
+TPaga ruby gem provides the functionality to call the multiple services of the TPaga platform.
+
+Installation
+---
+
+To install as a gem in your environment type in your console:
+
+```sh
+gem install tpaga
+```
+
+If you want to use in your rails application, add to your Gemfile:
+
+```ruby
+gem 'tpaga'
+```
+
+And run from your application directory:
+
+```sh
+bundle install
+```
+
+Configuration
+---
+
+If you are going to run tpaga in a rails environment add to the environment file (ex: `environments/development.rb`) the following lines:
+
+```ruby
+  config.tpaga_schema    = 'https'
+  config.tpaga_host      = 'sandbox.tpaga.co'
+  config.tpaga_base_path = '/api'
+  config.tpaga_api_key   = 'd13fr8n7vhvkuch3lq2ds5qhjnd2pdd2'
+```
+
+using the respective api key for your TPaga user account.
+
+Next add the the file `tpaga.rb` to the rails initializers (ex: `initializers/tpaga.rb`) with he following lines:
+
+```ruby
+require 'tpaga'
+
+Tpaga::Swagger.configure do |config|
+  config.scheme        = Rails.application.config.tpaga_schema
+  config.host          = Rails.application.config.tpaga_host
+  config.base_path     = Rails.application.config.tpaga_base_path
+  config.api_key       = Rails.application.config.tpaga_api_key
+  config.inject_format = false
+end
+```
+
+if you are not using rails, just simply initialize the service with the lines in the tpaga initializer before you call any service of the api.
+
+Managing customers
+---
+
+You can create a customer:
+
+```ruby
+# if outside from rails
+require 'tpaga'
+
+# creating a tpaga customer object
+customer = Tpaga::Customer.new(
+  firstName: 'foo',
+  lastName:  'bar',
+  email:     'foo@bar.com',
+  phone:     '0000000000',
+  gender:    'M'
+)
+
+# call of the service to create the customer in the TPaga account
+customer = Tpaga::CustomerApi.create_customer customer
+customer.id # The unique identifier of the customer in the TPaga account
+# if the request cannot be completed, raise a generic error
+```
+
+Get a customer by it's id:
+
+```ruby
+customer = Tpaga::CustomerApi.get_customer_by_id 'id'
+# returns a Tpaga::Customer object, raise error if not
+```
+
+Delete a customer by it's id:
+
+```ruby
+response = Tpaga::CustomerApi.delete_customer_by_id 'customer_id'
+# return nil if success, raise an error if not
+```
+Managing credit cards
+---
+
+You can add a credit card to existing customers:
+
+```ruby
+# build the credit card object to create
+credit_card_create = Tpaga::CreditCardCreate.new(
+  primaryAccountNumber: '4111111111111111',
+  expirationMonth:      '08',
+  expirationYear:       '2019',
+  cardVerificationCode: '789',
+  cardHolderName:       'Jon Snow',
+  billingAddress:       Tpaga::BillingAddress.new
+)
+
+credit_card = Tpaga::CreditCardApi.add_credit_card 'customer_id', credit_card_create
+# returns a Tpaga::CreditCard object, raise error if not
+```
+
+you can get the credit card of customers:
+
+```ruby
+credit_card = Tpaga::CreditCardApi.get_credit_card_by_id 'customer_id', 'credit_card_id'
+# return a Tpaga::CreditCard object, raise error if not
+```
+
+You can delete the credit card of customers:
+
+```ruby
+Tpaga::CreditCardApi.delete_credit_card_by_id 'customer_id', 'credit_card_id'
+# return nil if success, raise error if not
+```
+
+You can charge a credit card:
+
+```ruby
+# build the charge object
+charge = Tpaga::CreditCardCharge.new(
+  amount:       10000,
+  taxAmount:    10000 * 0.1,
+  currency:     'COP',
+  orderId:      'Your identifier for the order',
+  installments: 1,
+  description:  'A new leash for ghost',
+  creditCard:   'credit_card_id'
+)
+
+charge = Tpaga::CreditCardApi.add_credit_card_charge charge
+# return a Tpaga::CreditCardCharge object, raise error if not
+```
+
+Retrieve a charge by it's id:
+
+```ruby
+charge = Tpaga::CreditCardApi.get_credit_card_charge_by_id 'charge_id'
+# return a Tpaga::CreditCardCharge object, raise error if not
+```

data/lib/tpaga/models/credit_card_charge.rb

@@ -1,53 +1,47 @@
 module Tpaga
-  #
+  # 
   class CreditCardCharge < BaseObject
-    attr_accessor :id, :amount, :tax_amount, :currency, :credit_card, :installments, :order_id, :description, :paid, :customer, :payment_transaction, :third_party_id, :error_code, :error_message
+    attr_accessor :id, :amount, :tax_amount, :currency, :credit_card, :installments, :order_id, :description, :paid, :customer, :payment_transaction, :third_party_id
     # attribute mapping from ruby-style variable name to JSON key
     def self.attribute_map
       {
-
-        #
+        
+        # 
         :'id' => :'id',
-
-        #
+        
+        # 
         :'amount' => :'amount',
-
-        #
+        
+        # 
         :'tax_amount' => :'taxAmount',
-
+        
         # 3-letter ISO code for currency.
         :'currency' => :'currency',
-
-        #
+        
+        # 
         :'credit_card' => :'creditCard',
-
+        
         # The amount of payments to divide the charge amount.
         :'installments' => :'installments',
-
-        #
+        
+        # 
         :'order_id' => :'orderId',
-
-        #
+        
+        # 
         :'description' => :'description',
 
         #
         :'third_party_id' => :'thirdPartyId',
 
-        #
+        # 
         :'paid' => :'paid',
-
-        #
+        
+        # 
         :'customer' => :'customer',
-
-        #
-        :'payment_transaction' => :'paymentTransaction',
-
-        #
-        :'error_code' => :'errorCode',
-
-        #
-        :'error_message' => :'errorMessage'
-
+        
+        # 
+        :'payment_transaction' => :'paymentTransaction'
+        
       }
     end
 
@@ -65,10 +59,8 @@ module Tpaga
         :'description' => :'string',
         :'paid' => :'boolean',
         :'customer' => :'string',
-        :'payment_transaction' => :'string',
-        :'error_code' => :'string',
-        :'error_message' => :'string'
-
+        :'payment_transaction' => :'string'
+        
       }
     end
 
@@ -78,31 +70,31 @@ module Tpaga
       # convert string to symbol for hash key
       attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 
-
+      
       if attributes[:'id']
         @id = attributes[:'id']
       end
-
+      
       if attributes[:'amount']
         @amount = attributes[:'amount']
       end
-
+      
       if attributes[:'taxAmount']
         @tax_amount = attributes[:'taxAmount']
       end
-
+      
       if attributes[:'currency']
         @currency = attributes[:'currency']
       end
-
+      
       if attributes[:'creditCard']
         @credit_card = attributes[:'creditCard']
       end
-
+      
       if attributes[:'installments']
         @installments = attributes[:'installments']
       end
-
+      
       if attributes[:'orderId']
         @order_id = attributes[:'orderId']
         end
@@ -110,31 +102,23 @@ module Tpaga
       if attributes[:'thirdPartyId']
         @third_party_id = attributes[:'thirdPartyId']
       end
-
+      
       if attributes[:'description']
         @description = attributes[:'description']
       end
-
+      
       if attributes[:'paid']
         @paid = attributes[:'paid']
       end
-
+      
       if attributes[:'customer']
         @customer = attributes[:'customer']
       end
-
+      
       if attributes[:'paymentTransaction']
         @payment_transaction = attributes[:'paymentTransaction']
       end
-
-      if attributes[:'errorCode']
-        @error_code = attributes[:'errorCode']
-      end
-
-      if attributes[:'errorMessage']
-        @error_message = attributes[:'errorMessage']
-      end
-
+      
     end
   end
 end

data/lib/tpaga/models/customer.rb

@@ -1,32 +1,38 @@
 module Tpaga
-  # 
+  #
   class Customer < BaseObject
-    attr_accessor :id, :first_name, :last_name, :email, :gender, :phone, :address
+    attr_accessor :id, :first_name, :last_name, :email, :gender, :phone, :address, :legal_id_number, :merchant_customer_id
     # attribute mapping from ruby-style variable name to JSON key
     def self.attribute_map
       {
-        
-        # 
+
+        #
         :'id' => :'id',
-        
-        # 
+
+        #
         :'first_name' => :'firstName',
-        
-        # 
+
+        #
         :'last_name' => :'lastName',
-        
-        # 
+
+        #
         :'email' => :'email',
-        
-        # 
+
+        #
         :'gender' => :'gender',
-        
-        # 
+
+        #
         :'phone' => :'phone',
-        
-        # 
+
+        #
+        :'legal_id_number' => :'legalIdNumber',
+
+        #
+        :'merchant_customer_id' => :'merchantCustomerId',
+
+        #
         :'address' => :'address'
-        
+
       }
     end
 
@@ -39,8 +45,10 @@ module Tpaga
         :'email' => :'string',
         :'gender' => :'string',
         :'phone' => :'string',
-        :'address' => :'Address'
-        
+        :'legal_id_number' => :'string',
+        :'merchant_customer_id' => :'string',
+        :'address' => :'Address',
+
       }
     end
 
@@ -50,35 +58,43 @@ module Tpaga
       # convert string to symbol for hash key
       attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 
-      
+
       if attributes[:'id']
         @id = attributes[:'id']
       end
-      
+
       if attributes[:'firstName']
         @first_name = attributes[:'firstName']
       end
-      
+
       if attributes[:'lastName']
         @last_name = attributes[:'lastName']
       end
-      
+
       if attributes[:'email']
         @email = attributes[:'email']
       end
-      
+
       if attributes[:'gender']
         @gender = attributes[:'gender']
       end
-      
+
       if attributes[:'phone']
         @phone = attributes[:'phone']
       end
-      
+
+      if attributes[:'phone']
+        @legal_id_number = attributes[:'legalIdNumber']
+      end
+
+      if attributes[:'merchant_customer_id']
+        @phone = attributes[:'merchantCustomerId']
+      end
+
       if attributes[:'address']
         @address = attributes[:'address']
       end
-      
+
     end
   end
 end

data/lib/tpaga/swagger/version.rb

@@ -1,5 +1,5 @@
 module Tpaga
   module Swagger
-    VERSION = "0.4.5"
+    VERSION = "0.4.6.1"
   end
 end

data/tpaga.gemspec

@@ -4,7 +4,7 @@ require "tpaga/swagger/version"
 
 Gem::Specification.new do |s|
   s.name        = "tpaga"
-  s.date        = "2016-02-15"
+  s.date        = "2016-09-01"
   s.version     = Tpaga::Swagger::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors       = ["Sebastian Ortiz V."]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpaga
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6.1
 platform: ruby
 authors:
 - Sebastian Ortiz V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -82,6 +82,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/tpaga.rb
 - lib/tpaga/api/charge_api.rb
 - lib/tpaga/api/chargeback_api.rb
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: TPaga API Ruby Bindings powered by Swagger