nitro_pay 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b8e8f5759fc7498db9fe8b9c92c2be99a5ebad1
-  data.tar.gz: 28b5935dd66a713cf61559d9dfd81c225745ad35
+  metadata.gz: 7599ad547e37aee9ee05248a4c2b0d0a3f4a2fcc
+  data.tar.gz: c37529e921e9491a13276368200b0e5edf39bfd0
 SHA512:
-  metadata.gz: 6d15f991d87677c9dd06f43f2d9b7d8d1ca05a55e35a35ff10143ff2902cbf886a8ae4bea10d0a51ae2e329812c528e28d28c0fa686fa107684a62baba0745ab
-  data.tar.gz: cd5b0db7f31aeaf15ef0ebdbf4b8913b76f81d34293937c0ff8ea52ceb9b8c0c4804a978924841a71f604ef0deda2fd27f9922bc1a4b03e1517c0c427e69b5ef
+  metadata.gz: c0bde7dfa82a7fe059d23418390af5dc50eb16ad8c559910a8fcbea1038cd90b445d6bb19ab8b710f477eb5678df415fb493d8e8beeb5986402e7de8822efa58
+  data.tar.gz: eb1e0b6cbe9bc95d25f5cc1afeeb5fcfa6db939ade3e29de7f4c88393fc8ff6c272efb182a9783b887051786d2b787886e348c1ee8b7e8cfd975286a0d5f6ffe

data/.gitignore

@@ -9,7 +9,7 @@ _yardoc
 .idea/
 .idea/*
 /pkg/
-lib/rents/config/proxy.yml
+lib/nitro_pay/config/proxy.yml
 coverage
 coverage/
 coverage/*

data/lib/generators/nitro_pay/install_generator.rb

@@ -0,0 +1,16 @@
+require 'colorize'
+module NitroPay
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      
+      desc 'It automatically create it initializer NitroPay rails app config'
+      
+      def copy_initializer
+        template 'nitro_pay.rb', 'config/initializers/nitro_pay.rb'
+        puts 'Check your config/initializers/nitro_pay.rb & read it comments'.colorize(:light_yellow)
+      end
+      
+    end
+  end
+end

data/lib/generators/templates/nitro_pay.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+# TODO if using Rails 4 or greater use copy and paste on your secret.yml:
+# nitro_pay:
+#   app_id: # TODO your app_id
+#   app_secret_key: # TODO your app_secret_key
+# IMPORTANT: remember that test & development is not necessary if using test_env, but if you want your test app remember to use you test_app id & secret
+
+# It automatic the NitroPay to it TestEnv & ProductionEnv
+if Rails.env.development? || Rails.env.test?
+  # TODO if using Rails 3 or older & not using the TEST_ENV, put here your TEST app_id & your secret_key
+  NitroPay.app_id = ''
+  NitroPay.secret_key = ''
+
+  # TODO: Uncomment test_env if you want to test using NitroPay default & global app
+  # NitroPay.test_env = true
+  # TODO: Uncomment debugger if you have an NitroPay instance on your machine
+  # NitroPay.debug = true
+elsif Rails.env.production?
+  # TODO if using Rails 3 or older, put here your PRODUCTION app_id & your secret_key
+  NitroPay.app_id = ''
+  NitroPay.secret_key = ''
+
+  # For production remember to keep it false or just remove it
+  NitroPay.debug = false
+  NitroPay.test_env = false
+end
+
+# Get your App config if your not using TEST_ENV nor DEBUGGER
+if (NitroPay.test_env.nil? && NitroPay.debug.nil?) || (NitroPay.test_env == false && NitroPay.debug == false)
+  if Rails.version[0].to_i >= 4
+    begin
+      NitroPay.app_id = Rails.application.secrets.NitroPay['app_id']
+      NitroPay.secret_key = Rails.application.secrets.NitroPay['app_secret_key']
+    rescue
+      p 'Check your Secret.yml... Please add on it your Rent$ app_id & app_secret_key'
+    end
+  end
+end

data/lib/nitro_pay.rb

@@ -1,5 +1,93 @@
-require "nitro_pay/version"
+# Libs/Gems or Ruby classes
+require 'json'
+require 'curl'
+require 'yaml'
+require 'rest_client'
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+# Overrides
+require 'nitro_pay/hash'
+require 'nitro_pay/array'
+
+# Gem files
+[:version, :connection, :status, :transaction, :currency, :string].each { |lib| require "nitro_pay/#{lib}" }
 
 module NitroPay
-  # Your code goes here...
-end
+  # Module attr
+  @@enum = nil
+
+  # Production settings
+  @@app_id = nil
+  @@secret_key = nil
+
+  # Tests settings
+  @@proxy_yml = nil
+  @@test_env = nil
+  @@debug = nil
+
+  def self.proxy_yml
+    @@proxy_yml = NitroPay.get_proxy_from_yml if @@proxy_yml.nil?
+    @@proxy_yml
+  end
+
+  def self.proxy
+    return nil if NitroPay.proxy_yml.nil? || NitroPay.proxy_yml.empty?
+    "http://#{NitroPay.proxy_yml[:login]}:#{NitroPay.proxy_yml[:password]}@#{NitroPay.proxy_yml[:host]}:#{NitroPay.proxy_yml[:port]}/"
+  end
+
+  def self.app_id=(app_id)
+    @@app_id = app_id
+  end
+
+  def self.app_id
+    @@app_id
+  end
+
+  def self.secret_key=(secret_key)
+    @@secret_key = secret_key
+  end
+
+  def self.secret_key
+    @@secret_key
+  end
+
+  def self.test_env
+    @@test_env
+  end
+
+  def self.test_env=(test_env)
+    @@test_env = test_env
+  end
+
+  def self.debug
+    @@debug
+  end
+
+  def self.debug=(debug)
+    @@debug = debug
+  end
+
+  def self.get_proxy_from_yml
+    yml = YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'nitro_pay/config/proxy.yml'))
+    !yml.nil? || yml.is_a?(Hash) ? yml.it_keys_to_sym : {} if yml
+  end
+
+  def self.enum
+    enum = {}
+    return @@enum unless @@enum.nil?
+
+    enum = enum.merge load_yml('brands.yml')
+    enum = enum.merge load_yml('currencies.yml')
+    enum = enum.merge load_yml('payment_methods.yml')
+    enum = enum.merge load_yml('recurrence_periods.yml')
+    enum = enum.merge load_yml('transaction_codes.yml')
+
+    enum = enum.it_keys_to_sym
+    @@enum = enum
+  end
+
+  def self.load_yml(file_name)
+    YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'nitro_pay/config/enums/' + file_name))
+  end
+end

data/lib/nitro_pay/array.rb

@@ -0,0 +1,6 @@
+class Array
+  # Convert string keys to symbol keys
+  def it_keys_to_sym
+    self.each_with_index {|element, i| element.is_a?(Hash) ? self[i] = element.it_keys_to_sym : next }
+  end
+end

data/lib/nitro_pay/config/enums/brands.yml

@@ -0,0 +1,45 @@
+brands:
+  # SampleObj
+- id:       0
+  name:     Nil
+  username: nil
+
+  # VISA
+- id:       1
+  name:     VISA
+  username: visa
+
+  # MasterCard
+- id:       2
+  name:     MasterCard
+  username: mastercard
+
+  # Diners Club
+- id:       3
+  name:     Diners Club
+  username: diners
+
+  # Discover
+- id:       4
+  name:     Discover
+  username: discover
+
+  # Elo
+- id:       5
+  name:     Elo
+  username: elo
+
+  # American Express
+- id:      6
+  name:     American Express
+  username: amex
+
+  # JCB
+- id:       7
+  name:     JCB
+  username: jcb
+
+  # Aura
+- id:       8
+  name:     Aura
+  username: aura

data/lib/nitro_pay/config/enums/currencies.yml

@@ -0,0 +1,35 @@
+currencies:
+  # SampleObj
+- id:         0
+  name:       Nil
+  acronym:    nil$
+  iso_code:   NIL
+  iso_number: 000
+
+  # Real
+- id:         1
+  name:       Real
+  acronym:    R$
+  iso_code:   BRL
+  iso_number: 986
+
+  # Euro
+- id:         2
+  name:       Euro
+  acronym:    €
+  iso_code:   EUR
+  iso_number: 978
+
+  # US Dollar
+- id:         3
+  name:       US Dollar
+  acronym:    US$
+  iso_code:   USD
+  iso_number: 840
+
+  # CAD Dollar
+- id:         4
+  name:       CAD Dollar
+  acronym:    CAD$
+  iso_code:   CAD
+  iso_number: 124

data/lib/nitro_pay/config/enums/payment_methods.yml

@@ -0,0 +1,20 @@
+payment_methods:
+  # SampleObj
+- id:   0
+  name: Nil
+
+  # Credit
+- id:   1
+  name: Credit
+
+  # Debit
+- id:   2
+  name: Debit
+
+  # Installments shop
+- id:   3
+  name: Installments shop
+
+  # Installments administrator
+- id:   4
+  name: Installments administrator

data/lib/nitro_pay/config/enums/recurrence_periods.yml

@@ -0,0 +1,18 @@
+recurrence_periods:
+  # Daily
+  daily:      1
+
+  # Weekly
+  weekly:     2
+
+  # Monthly
+  monthly:    3
+
+  # Bimonthly
+  bimonthly:  4
+
+  # Semiannual
+  semiannual: 5
+
+  # Annual
+  annual:     6

data/lib/nitro_pay/config/enums/transaction_codes.yml

@@ -0,0 +1,31 @@
+transaction_code:
+        0:
+          status: pending
+          msg: Transação Criada
+        1:
+          status: pending
+          msg: Transação em Andamento
+        2:
+          status: pending
+          msg: Transação Autenticada
+        3:
+          status: error
+          msg: Transação não Autenticada
+        4:
+          status: pending
+          msg: Transação Autorizada
+        5:
+          status: error
+          msg: Transação não Autorizada
+        6:
+          status: charged
+          msg: Transação Capturada
+        9:
+          status: error
+          msg: Transação Cancelada
+        10:
+          status: pending
+          msg: Transação em Autenticação
+        12:
+          status: pending
+          msg: Transação em Cancelamento

data/lib/nitro_pay/config/proxy.example.yml

@@ -0,0 +1,4 @@
+login:    your_login
+password: your_password
+host:     proxy_host
+port:     proxy_port

data/lib/nitro_pay/connection.rb

@@ -0,0 +1,173 @@
+module NitroPay
+  class Connection
+    # Attrs
+    attr_accessor :auth
+    attr_accessor :path
+    attr_accessor :domain
+    attr_accessor :protocol
+    attr_accessor :end_point
+    attr_accessor :api_version
+    attr_accessor :recurrent_rid
+    attr_accessor :request_params
+    attr_accessor :end_point_versioned
+
+    # Constructor
+    def initialize(params = {})
+      # An work around added to prevent a lot of changes
+      params = params.merge({test_env:true}) if NitroPay.test_env
+      params = params.merge({debug:true}) if NitroPay.debug
+
+      # Static part
+      self.request_params = {transaction:params}
+      setup_config
+      self.domain = 'pay.nitrostart.me'
+
+      # If using test or Debug it is not production
+      if params[:debug] || params[:test]
+        self.protocol = 'http'
+        self.domain = 'pay.dev:4000'
+      else
+        # TODO when add SSL to Production replace http to https
+        self.protocol = 'http'
+        self.domain = 'pay.nitrostart.me'
+      end
+
+      self.api_version = 'v1'
+      self.end_point = "#{self.protocol}://#{self.domain}/api"
+      self.end_point_versioned = "#{self.protocol}://#{self.domain}/api/#{self.api_version}"
+
+      # Dynamic env
+      setup_default_app if params[:test_env]
+      setup_attrs(params)
+      self.recurrent_rid = params[:rid] unless params[:rid].nil?
+    end
+
+    # Full URL for the last request
+    def url_requested
+      "#{self.end_point}/#{self.api_version}/#{self.path}"
+    end
+
+    # GET http
+    def get_request
+      RestClient.get self.url_requested
+    end
+
+    # GET json
+    def get_json_request
+      resp = RestClient.get(self.url_requested)
+      to_hash_with_symbols(resp).it_keys_to_sym
+    end
+
+    # POST http
+    def post_request
+      RestClient.post self.url_requested, self.request_params
+    end
+
+    # POST json
+    def post_json_request
+      resp = RestClient.post(self.url_requested, self.request_params)
+      to_hash_with_symbols(resp)
+    end
+
+    # PUT http
+    def put_request
+      RestClient.put self.url_requested, self.request_params
+    end
+
+    # PUT json
+    def put_json_request
+      resp = RestClient.put(self.url_requested, self.request_params)
+      to_hash_with_symbols(resp)
+    end
+
+    # DELETE http
+    def delete_request
+      auth = self.request_params[:auth]
+      RestClient.delete self.url_requested, app_id:auth[:app_id], secret_key:auth[:secret_key]
+    end
+
+    # DELETE json
+    def delete_json_request
+      auth = self.request_params[:auth]
+      resp = RestClient.delete self.url_requested, auth_app_id:auth[:app_id], auth_secret_key:auth[:secret_key]
+      to_hash_with_symbols(resp)
+    end
+
+    # Callbacks
+    protected
+      # Config Attrs
+      def setup_config
+        self.auth = {app_id:NitroPay.app_id, secret_key:NitroPay.secret_key}
+        self.request_params.merge!(auth:self.auth)
+      end
+
+      # SetUp a default app
+      def setup_default_app
+        # setup test_app path
+        self.path = 'global_app'
+
+        # Get the App & setup config
+        app = get_json_request[:app]
+        NitroPay.app_id = app[:id]
+        NitroPay.secret_key = app[:secret]
+
+        # Get the GlobalRecurrent & setup/config
+        self.path = 'global_subscription'
+        recurrence = get_json_request
+        self.recurrent_rid = recurrence[:rid]
+
+        return puts 'Please run: rails g nitro_pay:install' if NitroPay.app_id.nil? || NitroPay.secret_key.nil?
+        self.auth = {app_id:NitroPay.app_id, secret_key:NitroPay.secret_key}
+        self.request_params.merge!(auth:self.auth)
+      end
+
+      # SetUp all attrs
+      def setup_attrs(params)
+        # Dynamic part
+        params.each do |key, value|
+          next unless key.to_s.index('[]').nil?
+          self.class.__send__(:attr_accessor, :"#{key}")
+          self.__send__("#{key}=", value)
+        end
+      end
+
+      # HTTP requests must have '[]' on it key name to send Array
+      def custom_http_params
+        setup_format_and_validators
+
+        return if self.sold_items.nil?
+        self.sold_items.each_with_index do |sold_item, i|
+          self.request_params[:transaction]["sold_items[#{i}]"] = sold_item
+        end
+      end
+
+      # Validate params to prevent errors like BAD Request & format values like value to Operator format
+      def setup_format_and_validators
+        validate_operator_format
+      end
+
+      # if necessary convert amount to operator value
+      def validate_operator_format
+        # prevent fatal error
+        return if self.amount.nil?
+
+        # aux vars
+        amount_str = self.amount.to_s
+        format_regex = /[.,]/
+
+        # if nil (it is not formatted, so it is not necessary to convert it format)
+        unless amount_str.match(format_regex).nil?
+          return if self.request_params.nil? || self.request_params[:transaction].nil?
+          self.amount = NitroPay::Currency.to_operator_str(self.amount)
+          self.request_params[:transaction][:amount] = self.amount
+        end
+      end
+    
+      # Return the JSON in a Hash with it keys in symbols
+      def to_hash_with_symbols(json)
+        hashed = JSON.parse(json)
+        hashed.is_a?(Array) ? hashed.each_with_index { |hash, i| hashed[i] = hash.it_keys_to_sym } : hashed.it_keys_to_sym
+        hashed
+      end
+  end
+end