epayco 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59c1d40737d331f1db43c7b2ebdcc5ae8425dc4d
+  data.tar.gz: 973e398e92b645039f094fc09d06102fe8e9108d
+SHA512:
+  metadata.gz: 97fe3572f5af14e5ba2e85f29e3c442fe56a74f87d5829e44844b323dbedfd88b2c6c48be71ca8426e9363f1ae0c6678877f7c2f30e898f7dc61fbe7400274c4
+  data.tar.gz: cceabb52c2cf7cceadfff83e0ea61af12efed71bcaabc6587d23378167678dca72689e4c927d9bccfa6effe00bd89046c9b5a4f9361f7842775206b7c186e269

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+.bundle
+vendor/bundle
+.ruby-version
+.rbenv-vars
+spec/reports
+Gemfile.lock
+log/*
+.yardoc
+doc/*
+certs/
+coverage/
+.todo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,10 @@
+bundler_args: --without development
+language: ruby
+
+before_install:
+  - rvm get head
+
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.3

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--markup markdown
+-
+README.md

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'bundler', '~> 1.3'
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+  gem 'byebug'
+end
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'webmock'
+end
+
+gemspec

data/README.md

@@ -0,0 +1,258 @@
+# EPayCo
+A Gem to interact with [epayco.co](https://epayco.co/) API
+
+[![Gem Version](https://badge.fury.io/rb/epayco.png)](http://badge.fury.io/rb/epayco)
+[![Code Climate](https://codeclimate.com/github/moisesnarvaez/epayco.png)](https://codeclimate.com/github/moisesnarvaez/epayco)
+[![Dependency Status](https://gemnasium.com/moisesnarvaez/epayco.png)](https://gemnasium.com/moisesnarvaez/epayco)
+[![Build Status](https://travis-ci.org/moisesnarvaez/epayco.png)](https://travis-ci.org/moisesnarvaez/epayco)
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'epayco'
+
+And then execute:
+
+    bundle install
+
+## Configuration
+
+Set the Api Keys:
+
+Make sure to set `EPAYCO_PUBLIC_KEY` and `EPAYCO_PRIVATE_KEY` in your environement variables. You can get your API keys in your [configuration page](https://dashboard.epayco.co/clientes/configuracion).
+
+```ruby
+EPayCo.public_key = ENV['EPAYCO_PUBLIC_KEY']
+EPayCo.private_key = ENV['EPAYCO_PRIVATE_KEY']
+```
+
+Multiple tokens or multithreaded usage:
+
+```ruby
+settings = { public_key: ENV['EPAYCO_PUBLIC_KEY'], private_key: ENV['EPAYCO_PRIVATE_KEY'] }
+epayco_client = EPayCo::Client.new(settings)
+epayco_client.plan_all
+```
+
+## Usage
+
+### Plans
+
+```ruby
+# Creating a Plan
+plan_params = {
+  id_plan: "test",
+  name: "Test",
+  description: "Plan de prueba",
+  amount: 30,
+  currency: "USD",
+  interval: "year",
+  interval_count: 1,
+  trial_days: 0
+}
+response = EPayCo.plan_create(plan_params)
+=> {"status"=>"Creado", "user"=>"e54cd3e4f2a9d6be230cc50500cc69dc4672350", "id"=>"test"}
+
+# Listing all Plans
+plans = EPayCo.plan_all
+=> [{"id_plan"=>"test",
+  "object"=>"plan",
+  "name"=>"Test",
+  "description"=>"Plan de prueba",
+  "amount"=>30,
+  "currency"=>"usd",
+  "interval"=>"year",
+  "status"=>"active",
+  "trialDays"=>0,
+  "created"=>"19-02-2017"}]
+
+# Udating a Plan
+response = EPayCo.plan_update(plan_params)
+=> {"status"=>"Actualizado", "userId"=>"5c4773856f296c674685209bbfd11f92", "planId"=>"test"}
+```
+
+### Customers
+
+```ruby
+# Creating a Customer
+customer_params = {
+  token_card: "ZdTo2WFZEH9r3HC7N",
+  name: "Joe Doe",
+  email: "joe@payco.co",
+  phone: "3005234321",
+  default: true
+}
+response = EPayCo.customer_create(customer_params)
+=> {"status"=>"Creado",
+ "description"=>"El cliente ha sido creado con exito para realizar operaciones y enlazarlo use el id: q2u73ZB6eba49Po7h",
+ "customerId"=>"q2u73ZB6eba49Po7h",
+ "token"=>"F3HZdToH9r7N2WCZE"}
+
+# Listing all Customers
+customers = EPayCo.customer_all
+=> [{"id_customer"=>"PKEMb9wfxQjttGeP",
+  "object"=>"customer",
+  "name"=>"Juan Fernando",
+  "email"=>"cliente1@epayco.com",
+  "phone"=>"3333333",
+  "created"=>"21-10-2016"},
+ {"id_customer"=>"qRTGGssNKXZo2Q6pL",
+  "object"=>"customer",
+  "name"=>"Pedro Jaramillo",
+  "email"=>"cliente2@epayco.com",
+  "phone"=>"3333333",
+  "created"=>"21-10-2016"}]
+```
+
+### Subscription
+```ruby
+# Creating a Subscription
+subscription_params = {
+  id_plan: "cursocarpinteria",
+  customer: "6eba2u73ZBh49Po7q",
+  token_card: "ZdTo2WFZEH9r3HC7N"
+}
+response = EPayCo.subscription_create(subscription_params)
+=> {"success"=>true,
+ "object"=>"subscription",
+ "id"=>"wAzyX9Sutm3BaLxM2",
+ "created"=>"Sep 27, 2016 10:59 AM",
+ "current_period_start"=>"Sep 27, 2016 10:59 AM",
+ "current_period_end"=>"Nov 26, 2016 10:59 AM",
+ "customer"=>"6eba2u73ZBh49Po7q",
+ "message"=>"Suscripción creada",
+ "data"=>
+  {"id_plan"=>"cursocarpinteria2",
+   "name"=>"Curso de carpintería2",
+   "description"=>"En este curso aprenderás carpintería2",
+   "amount"=>30000,
+   "currency"=>"cop",
+   "interval"=>"month",
+   "status"=>"active",
+   "trialDays"=>30,
+   "createdAt"=>"Sep 27, 2016 10:59 AM"},
+ "status"=>"active"}
+
+# Listing all Subscriptions
+subscriptions = EPayCo.subscription_all
+=> [{"_id"=>"wAzyX9Sutm3BaLxM2",
+  "idPlan"=>"cursocarpinteria2",
+  "data"=>
+   {"_id"=>"LS5L9cRaJSWA4ykeM",
+    "idClient"=>"cursocarpinteria2",
+    "name"=>"Curso de carpintería2",
+    "description"=>"En este curso aprenderás carpintería2",
+    "amount"=>30000,
+    "currency"=>"cop",
+    "interval"=>"month",
+    "clientId"=>"5c4773856f296c674685209bbfd11f92",
+    "status"=>"active",
+    "trialDays"=>30,
+    "createdAt"=>"2016-09-27T15:29:38.772Z"},
+  "periodStart"=>"2016-09-27T15:59:46.339Z",
+  "periodEnd"=>"2016-11-26T15:59:46.339Z",
+  "status"=>"active",
+  "idUser"=>"5c4773856f296c674685209bbfd11f92",
+  "idCustomer"=>"6eba2u73ZBh49Po7q",
+  "createdAt"=>"2016-09-27T15:59:46.352Z"}]
+
+# Getting a Subscription Details
+subscription = EPayCo.subscription_details
+=> {"success"=>true,
+ "object"=>"subscription",
+ "id"=>"wAzyX9Sutm3BaLxM2",
+ "created"=>"Sep 27, 2016 10:59 AM",
+ "current_period_start"=>"Sep 27, 2016 10:59 AM",
+ "current_period_end"=>"Nov 26, 2016 10:59 AM",
+ "customer"=>"6eba2u73ZBh49Po7q",
+ "message"=>"Suscripción creada",
+ "data"=>
+  {"id_plan"=>"cursocarpinteria2",
+   "name"=>"Curso de carpintería2",
+   "description"=>"En este curso aprenderás carpintería2",
+   "amount"=>30000,
+   "currency"=>"cop",
+   "interval"=>"month",
+   "status"=>"active",
+   "trialDays"=>30,
+   "createdAt"=>"Sep 27, 2016 10:59 AM"},
+ "status"=>"active"}
+
+# Canceling a Subscription Details
+subscription_id = "wAzyX9Sutm3BaLxM2"
+response = EPayCo.subscription_cancel(subscription_id)
+=> {"status"=>"Actualizado", "description"=>"La suscripción ha sido inhabilidata para el usuario wAzyX9Sutm3BaLxM2"}
+```
+
+### Charge
+
+```ruby
+# Creating a Charge
+charge_params = {
+  token_card: "hMsDAjwD7KLsgZQ54",
+  customer_id: "6eba2u73ZBh49Po7q",
+  plan_id: "cursocarpinteria",
+  doc_type: "CC",
+  doc_number: "1035851980",
+  name: "John",
+  last_name: "Doe",
+  email: "example@email.com",
+  ip: "192.198.2.114",
+  bill: "OR-1234",
+  description: "Test Payment",
+  value: "116000",
+  tax: "16000",
+  tax_base: "100000",
+  currency: "COP",
+  dues: "12"
+}
+response = EPayCo.charge_create(charge_params)
+=> {"status"=>"Creado", "description"=>"El charge ha sido creado con exito", "customerId"=>"6eba2u73ZBh49Po7q", "token"=>"ZdTo2WFZEH9r3HC7N"}
+```
+
+## Contributing
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/Instagram/instagram-ruby-gem/issues)
+* by reviewing patches
+
+
+## Submitting a Pull Request
+
+1. Fork it
+2. [Create a topic branch](http://learn.github.com/p/branching.html)
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run rake `doc:yard`. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run `bundle exec rspec`. If your changes are not 100% covered, go back to step 6.
+8. Commit your changes and push
+9. [Submit a pull request](http://help.github.com/send-pull-requests/). Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+## Inspiration
+* [Mercury Parser Gem](https://github.com/moisesnarvaez/mercury_parser)
+* [The Instagram Ruby Gem](https://github.com/facebookarchive/instagram-ruby-gem)
+
+## Author
+[Moises Narvaez](http://www.moisesnarvaez.com)
+
+## Copyright
+Copyright (c) 2017 Moises Narvaez
+
+## License
+MIT License
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/epayco.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/epayco/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'epayco'
+  s.version     = EPayCo::VERSION
+  s.date        = '2017-02-17'
+  s.summary     = "%q{A Gem to interact with epayco.co API}"
+  s.description = "%q{The EPayCo Gem provides methods to create, process and manage payment.}"
+  s.authors     = ["Moises Narvaez"]
+  s.email       = 'MoisesNarvaez@gmail.com'
+  s.homepage    = 'https://github.com/moisesnarvaez/epayco'
+  s.license     = 'MIT'
+  
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.cert_chain  = ['certs/gem-public_cert.pem']
+  s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+
+  s.add_runtime_dependency('faraday', '~> 0.11.0')
+  s.add_runtime_dependency('faraday_middleware', '~> 0.11.0.1')
+  s.add_runtime_dependency('multi_json', '~> 1.12')
+  s.add_runtime_dependency('hashie', '~> 3.5')
+end

data/lib/epayco.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../epayco/error', __FILE__)
+require File.expand_path('../epayco/configuration', __FILE__)
+require File.expand_path('../epayco/api', __FILE__)
+require File.expand_path('../epayco/client', __FILE__)
+require File.expand_path('../epayco/response', __FILE__)
+
+module EPayCo
+  extend Configuration
+
+  class << self
+    # Alias for EPayCo::Client.new
+    #
+    # @return [EPayCo::Client]
+    def client(options={})
+      EPayCo::Client.new(options)
+    end
+
+    # Delegate to EPayCo::Client
+    def method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
+
+    # Delegate to EPayCo::Client
+    def respond_to?(method, include_all=false)
+      return client.respond_to?(method, include_all) || super
+    end
+  end
+end # EPayCo

data/lib/epayco/api.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module EPayCo
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = EPayCo.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/epayco/client.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../api', __FILE__)
+
+module EPayCo
+  # Wrapper for the EPayCo REST API
+  #
+  # @note All methods have been separated into modules
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include EPayCo::Client::Plans
+    include EPayCo::Client::Subscription
+    include EPayCo::Client::Customer
+    include EPayCo::Client::Charge
+  end
+end

data/lib/epayco/client/charge.rb

@@ -0,0 +1,36 @@
+module EPayCo
+  class Client
+    # Defines methods related to Charges
+    module Charge
+
+      # Creates a new charge
+      #
+      # @format :json
+      # @param options The Charge Attributes
+      # @option options [String] :token_card  Token de la tarjeta tokenizada
+      # @option options [String] :customer_id Id del usuario al que se asocio la tarjeta
+      # @option options [String] :plan_id  Id del plan si se quiere agregar agregar una suscripción
+      # @option options [String] :doc_type  Tipo de documento del cliente
+      # @option options [String] :doc_number  Número de cocumento del cliente
+      # @option options [String] :name  Nombre del cliente que realiza el pago
+      # @option options [String] :last_name Apellidos del usuario que realiza el pago
+      # @option options [String] :email Email del usuario que realiza el pago
+      # @option options [String] :ip  Ip del cliente al momento de la transacción
+      # @option options [String] :bill  Número de factura de la compra
+      # @option options [String] :description Descripción de la compra que hace el usuario
+      # @option options [String] :value Valor total a pagar del producto o servicio
+      # @option options [String] :tax  Impuesto que se cobra sobre el valor total
+      # @option options [String] :tax_base Base del valor total con el impuesto discriminado
+      # @option options [String] :currency  Moneda en la que se ejecuta la transacción
+      # @option options [String] :dues  Cantidad de cuotas que se difiere el pago
+      # @return [Hashie::Mash]
+      # @example Success
+      #   
+      def charge_create(options={})
+        path = "/recurring/v1/charge/create"
+        response_options = { return_object: 'data' }
+        post(path, options.merge(public_key: public_key), response_options)
+      end
+    end
+  end
+end