mints 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe61a6e467b376dbb5f8b648cbdf40cf8dcb1f0ef8da711e7d19a901ba2c831d
-  data.tar.gz: 3c8f10f1f7cec5dcddaa47a06061c68025350d167045705eefb2b66784849451
+  metadata.gz: ade2308c58baa5c1b9ec010767f715069af50a2204820c3df6d4cb31231ad9de
+  data.tar.gz: 9a4ad29bac5f2a290e7c248619f2994dda26bff74686ee851e5cabd6ba321d6c
 SHA512:
-  metadata.gz: 8e60803a59051e32a64cb1be95aedf06f98d3ea1ee5ddf1c66f3be2532b6dad76a652e5b38198c4f5cf88c30cf5647b84ef21c07d29d9bc8544d784a26042606
-  data.tar.gz: 88f83771ef24027d16ef3b1b145c70ec9e357e9f300522aee58c113522f00d66e8e05a6301c54c6b0a6846bb6a78b5555d1499d10adb8539d0b531f5ef543a15
+  metadata.gz: 345e8d6efdc4c0f114adb3a3f1a0840050d5b447a38d07acf13a0d49a1c839a8cb33d6bbec95fd52f23b490b06947c672650830d0d62f18f3892fccc1d0978d5
+  data.tar.gz: 6b8e8682b9c64126399f105ee562103d95ebd14b6484b3b40a59bcda2c84cff710188514ad83363e8778fa476fba149469a76a16c38a3396b2bb25e16a6a616f

data/Gemfile

@@ -3,4 +3,5 @@ source :rubygems
 gem 'json'
 gem 'httparty'
 gem 'addressable'
-gem 'rails-reverse-proxy', '~> 0.9.1'
+gem 'rails-reverse-proxy', '~> 0.9.1'
+gem 'redis'

data/Readme.md

@@ -30,7 +30,7 @@ con.login(email, password)
 con.get_contacts
 ```
 ## Generate mints files
-This command will generate the mints_config.yml file, API controlles and routes to have available the mints endpoints
+This command will generate the mints_config.yml.erb file, API controlles and routes to have available the mints endpoints
 ```bash
 rails generate mints_files
 ```
@@ -46,8 +46,8 @@ This heritance will make the following class variables available:
 
 | Variable        | Description                                                                          |
 |   ---           |    :---:                                                                             |
-| @host           | Host defined in mints_config.yml file                                                |
-| @api_key        | API key defined in mints_config.yml file                                             |
+| @host           | Host defined in mints_config.yml.erb file                                                |
+| @api_key        | API key defined in mints_config.yml.erb file                                             |
 | @mints_pub      | An already instanced public client                                                   |
 | @contact_token  | A token used by mints to identify the contact                                        |
 | @visit_id       | An identifier of the visit registered                                                |
@@ -73,8 +73,8 @@ end
 This heritance will make the following class variables available:
 | Variable        | Description                                                                          |
 |   ---           |    :---:                                                                             |
-| @host           | Host defined in mints_config.yml file                                                |
-| @api_key        | API key defined in mints_config.yml file                                             |
+| @host           | Host defined in mints_config.yml.erb file                                                |
+| @api_key        | API key defined in mints_config.yml.erb file                                             |
 | @mints_user     | An already instanced user client  (not usable until call the user login method)      |
 
 And the following controller methods:

data/lib/client.rb

@@ -1,6 +1,7 @@
 require "httparty"
 require "json"
 require "addressable"
+require "redis"
 module Mints
   class Client
       attr_reader :host
@@ -24,10 +25,42 @@ module Mints
           uri = Addressable::URI.new
           uri.query_values = options
         end
-
+        
         full_url = "#{@host}#{base_url}#{url}#{uri}"
-        if action === 'get'          
-          response = self.send("#{@scope}_#{action}", "#{full_url}")
+        response = nil
+        if action === 'get'
+
+          template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+          config = YAML.load template.result(binding)
+          url_need_cache = false
+          result_from_cache = false
+          time = 0
+
+          if config['redis_cache']['use_cache']
+            config['redis_cache']['groups'].each do |group|
+              group['urls'].each do |url|
+                  if full_url.match url
+                    time = group['time']
+                    url_need_cache = true
+                    @redis_server = Redis.new(host: config['redis_cache']['redis_host'])
+                    if @redis_server.get(full_url)
+                      response = @redis_server.get(full_url)
+                      result_from_cache = true
+                    else 
+                      response = self.send("#{@scope}_#{action}", "#{full_url}")
+                      @redis_server.setex(full_url,time,response)
+                    end
+                    break
+                  end
+              end
+              break if url_need_cache    
+            end
+          end
+
+          if !url_need_cache
+            response = self.send("#{@scope}_#{action}", "#{full_url}")
+          end
+
         elsif action === 'create' or action === 'post'
           action = 'post'
           response = self.send("#{@scope}_#{action}", "#{full_url}", data)          
@@ -35,14 +68,15 @@ module Mints
           action = 'put'
           response = self.send("#{@scope}_#{action}", "#{full_url}", data)
         end
-        if (response.response.code == "404")
-          raise 'NotFoundError'
-        end
-        parsed_response = JSON.parse(response.body) 
-        if parsed_response.key?('data')
-          return parsed_response['data']
-        end
-        return parsed_response
+        if result_from_cache
+          return parsed_response = JSON.parse(response)
+        else
+          if (response.response.code == "404")
+            raise 'NotFoundError'
+          end
+          parsed_response = JSON.parse(response.body) 
+          return parsed_response
+        end        
       end
   
       def method_missing(name, *args, &block)
@@ -183,7 +217,8 @@ module Mints
       def contact_get(url)
         headers = {
           "ApiKey" => @api_key,
-          "Accept" => "application/json"
+          "Accept" => "application/json",
+          "ContactToken" => @contact_token
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_get(url, headers)
@@ -192,7 +227,8 @@ module Mints
       def contact_post(url, data)
         headers = {
           "ApiKey" => @api_key,
-          "Accept" => "application/json"
+          "Accept" => "application/json",
+          "ContactToken" => @contact_token
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_post(url, headers, data)
@@ -201,7 +237,8 @@ module Mints
       def contact_put(url, data)
         headers = {
           "ApiKey" => @api_key,
-          "Accept" => "application/json"
+          "Accept" => "application/json",
+          "ContactToken" => @contact_token
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_post(url, headers, data)
@@ -241,9 +278,9 @@ module Mints
         h = {
           "Accept" => "application/json",
           "Content-Type" => "application/json",
-          "ApiKey" => @api_key,
-          "ContactToken" => @session_token
+          "ApiKey" => @api_key
         }
+        h["ContactToken"] = @contact_token if @contact_token
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -256,9 +293,9 @@ module Mints
         h = {
           "Accept" => "application/json",
           "Content-Type" => "application/json",
-          "ApiKey" => @api_key,
-          "ContactToken" => @session_token
+          "ApiKey" => @api_key
         }
+        h["ContactToken"] = @session_token if @session_token
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -271,9 +308,9 @@ module Mints
         h = {
           "Accept" => "application/json", 
           "Content-Type" => "application/json", 
-          "ApiKey" => @api_key,
-          "ContactToken" => @session_token
+          "ApiKey" => @api_key
         }
+        h["ContactToken"] = @contact_token if @contact_token
         if headers
           headers.each do |k,v|
             h[k] = v

data/lib/contact.rb

@@ -1,4 +1,5 @@
 require_relative "./client.rb"
+include ActionController::Cookies
 module Mints
   class Contact
     attr_reader :client
@@ -10,20 +11,6 @@ module Mints
       @client = Mints::Client.new(host, api_key, "contact", session_token, debug)
     end
 
-    ##
-    # === Register.
-    # Register a new contact
-    #
-    def register(given_name, last_name, email, password)
-      data = {
-        given_name: given_name,
-        last_name: last_name,
-        email: email,
-        password: password
-      }
-      return @client.raw("post", "/contacts/register", nil, {data: data})
-    end
-
     ##
     # === Login.
     # Starts a contact session

data/lib/generators/mints_config.yml.erb

@@ -0,0 +1,13 @@
+# Mints connection configuration
+mints:
+    host: http://your_host_goes_here.com
+    api_key: your_mints_api_key_goes_here
+redis_cache:
+  use_cache: boolean_value_to_enable_and_disable_cache
+  redis_host: your_redis_host
+  groups:
+    - urls:
+        - group_of_urls
+      time: time_that_will_be_applied_to_urls_in_seconds
+sdk:
+    debug: false

data/lib/generators/mints_contact_controller.rb

@@ -1,2 +1,3 @@
+require 'reverse_proxy/client'
 class Api::V1::MintsContactController <  Mints::ContactAPIController
 end

data/lib/generators/mints_files_generator.rb

@@ -2,7 +2,7 @@ class MintsFilesGenerator < Rails::Generators::Base
     source_root(File.expand_path(File.dirname(__FILE__)))
     include Rails::Generators::Actions
     def create_mints_files
-      copy_file 'mints_config.yml', 'mints_config.yml'
+      copy_file 'mints_config.yml.erb', 'mints_config.yml.erb'
       copy_file 'mints_user_controller.rb', './app/controllers/api/mints_user_controller.rb'
       copy_file 'mints_contact_controller.rb', './app/controllers/api/v1/mints_contact_controller.rb'
       copy_file 'mints_public_controller.rb', './app/controllers/api/v1/mints_public_controller.rb'

data/lib/generators/mints_public_controller.rb

@@ -1,2 +1,3 @@
+require 'reverse_proxy/client'
 class Api::V1::MintsPublicController <  Mints::PublicAPIController
 end

data/lib/generators/mints_user_controller.rb

@@ -1,2 +1,3 @@
+require 'reverse_proxy/client'
 class Api::MintsUserController < Mints::UserAPIController
 end

data/lib/mints/controllers/admin_base_controller.rb

@@ -41,8 +41,9 @@ module Mints
     # === Set Mints user client.
     # Initialize the public client and set the user token
     def set_mints_user_client
-      if File.exists?("#{Rails.root}/mints_config.yml")
-        config = YAML.load_file("#{Rails.root}/mints_config.yml")
+      if File.exists?("#{Rails.root}/mints_config.yml.erb")
+        template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+        config = YAML.load template.result(binding)
         @host = config["mints"]["host"]
         @api_key = config["mints"]["api_key"]
         @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false

data/lib/mints/controllers/base_controller.rb

@@ -24,8 +24,11 @@ module Mints
         response = @mints_contact.login(email, password)
         # Get session token from response
         session_token = response['session_token']
+        id_token = response['contact']['id_token']
         # Set a permanent cookie with the session token
         cookies.permanent[:mints_contact_session_token] = session_token
+        cookies.permanent[:mints_contact_id] = id_token
+        @contact_token = id_token
     end
 
     ##
@@ -36,6 +39,8 @@ module Mints
         @mints_contact.logout
         # Delete local cookie
         cookies.delete(:mints_contact_session_token)
+        cookies.delete(:mints_contact_id)
+        @contact_token = nil
     end
     
     private
@@ -54,15 +59,16 @@ module Mints
     # === Set mints pub.
     # Initialize the public client and set the contact token
     def set_mints_pub_client
-      if File.exists?("#{Rails.root}/mints_config.yml")
-        config = YAML.load_file("#{Rails.root}/mints_config.yml")
+      if File.exists?("#{Rails.root}/mints_config.yml.erb")
+        template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+        config = YAML.load template.result(binding)
         @host = config["mints"]["host"]
         @api_key = config["mints"]["api_key"]
         @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
       else
         raise 'MintsBadCredentialsError'
       end
-      # Initialize mints pub client, credentials taken from mints_config.yml file
+      # Initialize mints pub client, credentials taken from mints_config.yml.erb file
       @mints_pub = Mints::Pub.new(@host, @api_key, nil, @debug)
       # Set contact token from cookie
       @mints_pub.client.session_token = @contact_token

data/lib/mints/controllers/contact_api_controller.rb

@@ -1,4 +1,5 @@
 require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
 module Mints
     class ContactAPIController < ActionController::API
         include AbstractController::Helpers
@@ -17,10 +18,56 @@ module Mints
                 session_token = cookies[:mints_contact_session_token]
                 headers["Authorization"] = "Bearer #{session_token}"
             end            
-            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
-                # We got a 404!
-                config.on_missing do |code, response|
-                    raise ActionController::RoutingError.new('Not Found')
+            
+            url_need_cache = false
+            result_from_cache = false
+            time = 0
+            full_url = request.original_url
+
+            if request.method == "GET"                
+                if @use_cache
+                    @redis_config['groups'].each do |group|
+                        group['urls'].each do |url|
+                            if full_url.match url
+                                time = group['time']
+                                url_need_cache = true
+                                break
+                            end
+                        end
+                        break if url_need_cache  
+                    end
+                end
+            end
+
+            if url_need_cache
+                if @redis_server.get(full_url)
+                    response = @redis_server.get(full_url)
+                    result_from_cache = true
+                    render json: response
+                else
+                    reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                        # Request succeded!
+                        config.on_response do |code, response|
+                            @redis_server.setex(full_url,time,response.body)
+                        end
+                        # Request failed!
+                        config.on_missing do |code, response|
+                            # We got a 404!
+                            if code == 404
+                                raise ActionController::RoutingError.new('Not Found')
+                            end
+                        end
+                    end
+                end
+            else
+                reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                    # Request failed!
+                    config.on_missing do |code, response|
+                        # We got a 404!
+                        if code == 404
+                            raise ActionController::RoutingError.new('Not Found')
+                        end
+                    end
                 end
             end
         end    
@@ -28,10 +75,14 @@ module Mints
         private
 
         def set_config_variables
-            if File.exists?("#{Rails.root}/mints_config.yml")
-                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+            if File.exists?("#{Rails.root}/mints_config.yml.erb")
+                template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+                config = YAML.load template.result(binding)
                 @host = config["mints"]["host"]
-                @api_key = config["mints"]["api_key"]
+                @api_key = config["mints"]["api_key"]     
+                @redis_server = Redis.new(host: config['redis_cache']['redis_host']) if config['redis_cache']['use_cache']
+                @redis_config = config['redis_cache']
+                @use_cache = config['redis_cache']['use_cache'] 
             end
         end
     end

data/lib/mints/controllers/public_api_controller.rb

@@ -1,4 +1,6 @@
 require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+require 'redis'
 module Mints
     class PublicAPIController < ActionController::API
         include ReverseProxy::Controller
@@ -11,21 +13,72 @@ module Mints
                 'Content-Type'=> 'application/json', 
                 'Accept'=> 'application/json' 
             }
-            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
-                # We got a 404!
-                config.on_missing do |code, response|
-                    raise ActionController::RoutingError.new('Not Found')
+            
+            url_need_cache = false
+            result_from_cache = false
+            time = 0
+            full_url = request.original_url
+
+            if request.method == "GET"
+                if @use_cache
+                    @redis_config['groups'].each do |group|
+                        group['urls'].each do |url|
+                            if full_url.match url
+                                time = group['time']
+                                url_need_cache = true
+                                break
+                            end
+                        end
+                        break if url_need_cache  
+                    end
+                end                
+            end
+
+            if url_need_cache
+                if @redis_server.get(full_url)
+                    response = @redis_server.get(full_url)
+                    result_from_cache = true
+                    render json: response
+                else 
+                    reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                        # Request succeded!
+                        config.on_response do |code, response|
+                            @redis_server.setex(full_url,time,response.body)
+                        end
+                        # Request failed!
+                        config.on_missing do |code, response|
+                            # We got a 404!
+                            if code == 404
+                                raise ActionController::RoutingError.new('Not Found')
+                            end
+                        end
+                    end
+                end
+            else
+                reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                    # Request failed!
+                    config.on_missing do |code, response|
+                        # We got a 404!
+                        if code == 404
+                            raise ActionController::RoutingError.new('Not Found')
+                        end
+                    end
                 end
             end
+            
         end    
         
         private
 
         def set_config_variables
-            if File.exists?("#{Rails.root}/mints_config.yml")
-                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+            if File.exists?("#{Rails.root}/mints_config.yml.erb")
+                template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+                config = YAML.load template.result(binding)
                 @host = config["mints"]["host"]
-                @api_key = config["mints"]["api_key"]
+                @api_key = config["mints"]["api_key"]                
+                @redis_server = Redis.new(host: config['redis_cache']['redis_host']) if config['redis_cache']['use_cache']
+                @redis_config = config['redis_cache']
+                @use_cache = config['redis_cache']['use_cache'] 
             end
         end
     end

data/lib/mints/controllers/user_api_controller.rb

@@ -1,4 +1,5 @@
 require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
 module Mints
     class UserAPIController < ActionController::API
         include AbstractController::Helpers
@@ -17,10 +18,56 @@ module Mints
                 session_token = cookies[:mints_user_session_token]
                 headers["Authorization"] = "Bearer #{session_token}"
             end            
-            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
-                # We got a 404!
-                config.on_missing do |code, response|
-                    raise ActionController::RoutingError.new('Not Found')
+            
+            url_need_cache = false
+            result_from_cache = false
+            time = 0
+            full_url = request.original_url
+
+            if request.method == "GET"
+                if url_need_cache
+                    @redis_config['groups'].each do |group|
+                        group['urls'].each do |url|
+                            if full_url.match url
+                                time = group['time']
+                                url_need_cache = true
+                                break
+                            end
+                        end
+                        break if url_need_cache  
+                    end
+                end
+            end
+
+            if url_need_cache
+                if @redis_server.get(full_url)
+                    response = @redis_server.get(full_url)
+                    result_from_cache = true
+                    render json: response
+                else
+                    reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                        # Request succeded!
+                        config.on_response do |code, response|
+                            @redis_server.setex(full_url,time,response.body)
+                        end
+                        # Request failed!
+                        config.on_missing do |code, response|
+                            # We got a 404!
+                            if code == 404
+                                raise ActionController::RoutingError.new('Not Found')
+                            end
+                        end
+                    end
+                end
+            else
+                reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                    # Request failed!
+                    config.on_missing do |code, response|
+                        # We got a 404!
+                        if code == 404
+                            raise ActionController::RoutingError.new('Not Found')
+                        end
+                    end
                 end
             end
         end    
@@ -28,10 +75,14 @@ module Mints
         private
 
         def set_config_variables
-            if File.exists?("#{Rails.root}/mints_config.yml")
-                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+            if File.exists?("#{Rails.root}/mints_config.yml.erb")
+                template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+                config = YAML.load template.result(binding)
                 @host = config["mints"]["host"]
                 @api_key = config["mints"]["api_key"]
+                @redis_server = Redis.new(host: config['redis_cache']['redis_host'])
+                @redis_config = config['redis_cache']
+                @use_cache = config['redis_cache']['use_cache'] if config['redis_cache']['use_cache']
             end
         end
     end

data/lib/pub.rb

@@ -7,7 +7,7 @@ module Mints
   # == Usage example
   # Initialize
   #     pub = Mints::Pub.new(mints_url, api_key)
-  # or if host and api_key are provided by mints_config.yml
+  # or if host and api_key are provided by mints_config.yml.erb
   #     pub = Mints::Pub.new
   # Call any function
   #     pub.get_products
@@ -61,7 +61,7 @@ module Mints
         user_agent: user_agent || request.user_agent,
         url: url || request.fullpath
       }
-      response = @client.raw("post", "/register-visit", nil, data)
+      response = @client.raw("post", "/register-visit", nil, data.to_json)
       return response
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.10
 platform: ruby
 authors:
-- Ruben Gomez Garcia, Omar Mora
+- Ruben Gomez Garcia, Omar Mora, Luis Payan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +120,7 @@ files:
 - Readme.md
 - lib/client.rb
 - lib/contact.rb
-- lib/generators/mints_config.yml
+- lib/generators/mints_config.yml.erb
 - lib/generators/mints_contact_controller.rb
 - lib/generators/mints_files_generator.rb
 - lib/generators/mints_public_controller.rb

data/lib/generators/mints_config.yml

@@ -1,6 +0,0 @@
-# Mints connection configuration
-mints:
-    host: http://your_host_goes_here.com
-    api_key: your_mints_api_key_goes_here
-sdk:
-    debug: false