epayco 0.0.2

data/lib/epayco/client/customer.rb

@@ -0,0 +1,58 @@
+module EPayCo
+  class Client
+    # Defines methods related to Customers
+    module Customer
+      # Returns all the Customers registered
+      #
+      # @format :json
+      # @return [Array]
+      # @example All the Customers
+      #   [
+      #     {
+      #       "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"
+      #     }
+      #   ]
+      def customer_all(params={})
+        path = "/recurring/v1/customers/#{public_key}"
+        response_options = { return_object: true }
+        get(path, params, response_options)
+      end
+
+      # Creates a new customer
+      #
+      # @format :json
+      # @param options The Customer Attributes
+      # @option options [String] :token_card Token de la tarjeta tokenizada
+      # @option options [String] :name Nombre del cliente al que se asocia la tarjeta
+      # @option options [String] :email Email del cliente al que se asocia la tarjeta
+      # @option options [String] :phone Phone del cliente al que se asocia la tarjeta
+      # @option options [Boolean] :default Define la terjeta con la cobra por default
+      # @return [Hashie::Mash]
+      # @example Success
+      #   {
+      #     "status": "Creado",
+      #     "description": "El cliente ha sido creado con exito para realizar operaciones y enlazarlo use el id: 6eba2u73ZBh49Po7q",
+      #     "customerId": "6eba2u73ZBh49Po7q",
+      #     "token": "ZdTo2WFZEH9r3HC7N"
+      #   }
+      def customer_create(options={})
+        path = "/recurring/v1/customer/create"
+        response_options = { return_object: 'data' }
+        post(path, options.merge(public_key: public_key), response_options)
+      end
+    end
+  end
+end

data/lib/epayco/client/plans.rb

@@ -0,0 +1,115 @@
+module EPayCo
+  class Client
+    # Defines methods related to Plans
+    module Plans
+      # Returns all the Plans registered
+      #
+      # @format :json
+      # @return [Array]
+      # @example All the Plans
+      #   [
+      #     {
+      #       "id_plan": "cursocarpinteria",
+      #       "object": "plan",
+      #       "name": "Curso de carpintería",
+      #       "description": "En este curso aprenderás carpintería",
+      #       "amount": 30000,
+      #       "currency": "cop",
+      #       "interval": "month",
+      #       "status": "active",
+      #       "trialDays": 30,
+      #       "created": "Sep 26, 2016 3:15 PM"
+      #     },
+      #     {
+      #       "id_plan": "cursocarpinteria2",
+      #       "object": "plan",
+      #       "name": "Curso de carpintería2",
+      #       "description": "En este curso aprenderás carpintería2",
+      #       "amount": 30000,
+      #       "currency": "cop",
+      #       "interval": "month",
+      #       "status": "active",
+      #       "trialDays": 30,
+      #       "created": "Sep 26, 2016 3:52 PM"
+      #     }
+      #   ]
+      def plan_all(params={})
+        path = "/recurring/v1/plans/#{public_key}"
+        response_options = { return_object: true }
+        get(path, params, response_options)
+      end
+
+      # Creates a new plan
+      #
+      # @format :json
+      # @param options The Plan Attributes
+      # @option options [String] :id_plan Proporciona un nombre único para identificar el plan
+      # @option options [String] :name Nombre del plan que mostraras a tus clientes
+      # @option options [String] :description Descripción del plan creado que será mostrada a tus clientes
+      # @option options [Integer] :amount Hace referencia al valor que se cobrará en cada periodo
+      # @option options [String] :currency Consta de 3 letras que identifica la moneda en la que harás el cobro segun las normas [ISO code](http://www.xe.com/iso4217.php) currency
+      # @option options [String] :interval Especifica la recurrencia del cobro. 'day', 'week', 'month', o 'year'
+      # @option options [Integer] :interval_count Especifica la cantidad de intervalos por ejemplo si interval = “month” y interval_count es igual a 2 se cobrará cada 2 meses
+      # @option options [Integer] :trial_days Numero de dias que se podrán probar tus servicios antes del cobro, su valor inicial es 0
+      # @return [Hashie::Mash]
+      # @example Success
+      #   {
+      #     "status": "Creado",
+      #     "user": "cdc4654c502f9d320ebet4f6230m669d",
+      #     "id": "test"
+      #   }
+      # @example Fail
+      #   {
+      #     "status": "error",
+      #     "description": "El id del mensaje es existente o ya no esta en uso id: test"
+      #   }
+      def plan_create(options={})
+        path = "/recurring/v1/plan/create"
+        response_options = { return_object: 'data' }
+        post(path, options.merge(public_key: public_key), response_options)
+      end
+
+      # Updates a new plan
+      #
+      # @format :json
+      # @param plan_id [String] Plan ID (nombre único para identificar el plan)
+      # @param fields [Hash] Clave y valor de los campos a editar
+      # @return [Hashie::Mash]
+      # @example Success
+      #   {
+      #     "status": "Actualizado",
+      #     "userId": "4378g0ebb84536876540407bzb04815n",
+      #     "planId": "test"
+      #   }
+      def plan_update(plan_id, fields={})
+        path = "/recurring/v1/plan/edit/#{public_key}/#{plan_id}"
+        response_options = { return_object: 'data' }
+        put(path, fields, response_options)
+      end
+
+      # Returns the details of a plan
+      #
+      # @format :json
+      # @param plan_id [String] Plan ID (nombre único para identificar el plan)
+      # @return [Hash]
+      # @example Plan Details
+      #   {
+      #     "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"
+      #   }
+      def plan_details(plan_id, params={})
+        path = "/recurring/v1/plan/#{public_key}/#{plan_id}"
+        response_options = { return_object: true }
+        get(path, params, response_options)
+      end
+    end
+  end
+end

data/lib/epayco/client/subscription.rb

@@ -0,0 +1,150 @@
+module EPayCo
+  class Client
+    # Defines methods related to Subscription
+    module Subscription
+      # Returns all the Subscriptions registered
+      #
+      # @format :json
+      # @return [Array]
+      # @example All the Subscription
+      #   [
+      #     {
+      #       "_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"
+      #     },
+      #     {
+      #       "_id": "cZHvGKHxJDd8oY72m",
+      #       "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-27T16:49:59.758Z",
+      #       "periodEnd": "2016-11-26T16:49:59.758Z",
+      #       "status": "active",
+      #       "idUser": "5c4773856f296c674685209bbfd11f92",
+      #       "idCustomer": "cus_97dn6u3OFeeeOye",
+      #       "createdAt": "2016-09-27T16:49:59.767Z"
+      #     }
+      #   ]
+      def subscription_all(params={})
+        path = "/recurring/v1/subscriptions/#{public_key}"
+        response_options = { return_object: "plans" }
+        get(path, params, response_options)
+      end
+
+      # Creates a new subscription
+      #
+      # @format :json
+      # @param options The Necessary fields to create a Subscription
+      # @option options [String] :id_plan Id único del plan que se desea asociar al cliente
+      # @option options [String] :token_card Id de la tarjeta tokenizada con la que se efectuara un pago y ha sido asociada a un cliente
+      # @option options [String] :customer Customer ID (Optional)
+      # @return [Hashie::Mash]
+      # @example Success
+      #   {
+      #       "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"
+      #   }
+      def subscription_create(options={})
+        path = "/recurring/v1/subscription/create"
+        post(path, options.merge(public_key: public_key))
+      end
+
+      # Returns the details of a subscription
+      #
+      # @format :json
+      # @return [Hashie::Mash]
+      # @param subscription_id [String] Id único del suscripción que se asocio a un cliente
+      # @example Subscription Details
+      #   {
+      #       "success": true,
+      #       "id": "wAzyX9Sutm3BaLxM2",
+      #       "object": "subscription",
+      #       "created": "2016-09-27T15:59:46.352Z",
+      #       "current_period_start": "Sep 27, 2016 10:59 AM",
+      #       "current_period_end": "Nov 26, 2016 10:59 AM",
+      #       "customer": "6eba2u73ZBh49Po7q",
+      #       "plan": {
+      #           "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"
+      #   }
+      def subscription_details(subscription_id, params={})
+        path = "/recurring/v1/subscription/#{subscription_id}/#{public_key}"
+        get(path, params)
+      end
+
+      # Cancel a subscription
+      #
+      # @format :json
+      # @param subscription_id [String] Id único del suscripción que se asocio a un cliente
+      # @return [Hashie::Mash]
+      # @example Success
+      #   {
+      #     "status": "Actualizado",
+      #     "description": "La suscripción ha sido inhabilidata para el usuario wAzyX9Sutm3BaLxM2"
+      #   }
+      def subscription_cancel(subscription_id)
+        path = "/recurring/v1/subscription/cancel"
+        request_options = { public_key: public_key, id: subscription_id }
+        response_options = { return_object: 'data' }
+        post(path, request_options, response_options)
+      end
+    end
+  end
+end

data/lib/epayco/configuration.rb

@@ -0,0 +1,74 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module EPayCo
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {EPayCo::API}
+    VALID_OPTIONS_KEYS = [
+      :public_key,
+      :private_key,
+      :adapter,
+      :connection_options,
+      :endpoint,
+      :proxy,
+      :user_agent
+    ].freeze
+
+    # By default, don't set a user public key
+    DEFAULT_PUBLIC_KEY = nil
+
+    # By default, don't set a user private key
+    DEFAULT_PRIVATE_KEY = nil
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://api.secure.payco.co/'.freeze
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "EPayCo Ruby Gem #{EPayCo::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.public_key       = DEFAULT_PUBLIC_KEY
+      self.private_key       = DEFAULT_PRIVATE_KEY
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/epayco/connection.rb

@@ -0,0 +1,30 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module EPayCo
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {
+          'Accept' => "application/json; charset=utf-8;",
+          'Content-Type' => "application/json",
+          'User-Agent' => user_agent},
+        :proxy => proxy,
+        :url => endpoint,
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        unless raw
+          connection.use FaradayMiddleware::Mashify 
+          connection.use Faraday::Response::ParseJson
+        end
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/epayco/error.rb

@@ -0,0 +1,31 @@
+module EPayCo
+  # Custom error class for rescuing from all EPayCo errors
+  class Error < StandardError; end
+
+  # Raised when EPayCo returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+
+  # Raised when EPayCo returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
+end