mints 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327d7dc897b313289564ea62d790eca41f338394b7d3285a54044004d73c4949
-  data.tar.gz: 311fef416ffe4b8009752185f7ca974e6ebe4c887692608c03bee69e7432100c
+  metadata.gz: d5412170b7e05b67da59931e6af7972b56e329d302012392cfc9d97235e0b9de
+  data.tar.gz: ba661a85b759c89e2e6c24b10509bd551a127ec46bf6861855352af474384eb3
 SHA512:
-  metadata.gz: 132622f7ce07aed342c56e2c1bf3bc1a15be585fbf747c603b822e184ef55f7fb914d6216ad5b7e7c33d0831cbf33caf6b2927fa46eace7938e40ede898e86cf
-  data.tar.gz: c5531bb9f2be7d66f8dd2b9951957b90e85b43c3d1e1527b462a3978f05ee9e768177f83aa6313d768d07c3062bee261add211d8dcbc5d5895f4dcf0f8c11ab2
+  metadata.gz: 67cad01ac699e1c98f5498cbb4f50fce4195abb6fadced35326c9d5e6d9564d10a0d3b406873b43f67430e9b908409f93fcbae021f99bf1265d01f931ea83d3f
+  data.tar.gz: d1bea2eac77eda19886a5e97c9c007137131192409036c1c87e36fefd569ccb36e00a40de621749d21f213e77f7899856f2b998187f321518917d9664dfb3899

data/Gemfile

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

data/Readme.md

@@ -6,8 +6,7 @@ This is a library to connect apps built on ruby to Mints.Cloud
 
 Add gem to the Gemfile
 ```bash
-gem 'mints', git: 'https://github.com/rubengomez/mints-ruby-sdk'
-bundle install
+gem 'mints'
 ```
 
 ## Usage
@@ -30,3 +29,56 @@ con = Mints::User.new(mints_url, api_key)
 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
+```bash
+rails generate mints_files
+```
+## Contact tracking usage
+Your app controller needs to be inherited from Mints::BaseController
+```ruby
+# application_controller.rb
+
+class ApplicationController < Mints::BaseController
+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                                             |
+| @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                                                |
+| @mints_contact  | An already instanced contact client (not usable until call the contact login method) |
+
+And the following controller methods:
+| Method                    | Parameters     | Return value | Description                                    |
+|   ---                     |   :---:        |   :---:      | :---:                                          |
+| mints_contact_signed_in?  | none           | boolean      | Indicates if the contact has an active session |
+| mints_contact_login       | email, password| void         | Starts a contact session                       |
+| mints_contact_logout      | none           | void         | Ends a contact session                         |
+
+## Admin controller usage
+If want to have a private section where only a mints user can acces and use the private user api is needed to inherit from the AdminBaseController.
+
+```ruby
+# admin_controller.rb
+
+class AdminController < Mints::AdminBaseController
+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                                             |
+| @mints_user     | An already instanced user client  (not usable until call the user login method)      |
+
+And the following controller methods:
+| Method                    | Parameters     | Return value | Description                                 |
+|   ---                     |   :---:        |   :---:      | :---:                                       |
+| mints_user_login          | email, password| void         | Starts a user session                       |
+| mints_user_logout         | none           | void         | Ends a user session                         |

data/lib/client.rb

@@ -9,26 +9,25 @@ module Mints
       attr_reader :base_url
       attr_accessor :session_token      
 
-      def initialize(host, api_key, scope = nil, session_token = nil)
+      def initialize(host, api_key, scope = nil, session_token = nil, debug = false)
           @host = host
           @api_key = api_key
           @session_token = session_token
+          @debug = debug
           self.set_scope(scope)
       end
 
       def raw(action, url, options = nil, data = nil, base_url = nil)
-        base_url = @base_url if !base_url        
-        
+        base_url = @base_url if !base_url
+        uri = ""
         if (options && options.class == Hash)
           uri = Addressable::URI.new
           uri.query_values = options
-        else
-          uri = ""
         end
 
         full_url = "#{@host}#{base_url}#{url}#{uri}"
-        if action === 'get'          
-          response = self.send("#{@scope}_#{action}", "#{full_url}")
+        if action === 'get'
+            response = self.send("#{@scope}_#{action}", "#{full_url}")
         elsif action === 'create' or action === 'post'
           action = 'post'
           response = self.send("#{@scope}_#{action}", "#{full_url}", data)          
@@ -46,7 +45,8 @@ module Mints
         return parsed_response
       end
   
-      def method_missing(name, *args, &block)     
+      def method_missing(name, *args, &block)
+        puts name
         name.to_s.include?("__") ? separator = "__" : separator = "_"        
         # split the name to identify their elements
         name_spplited = name.to_s.split(separator)
@@ -144,16 +144,38 @@ module Mints
       ##### HTTTP CLIENTS ######
       # Simple HTTP GET
       def http_get(url, headers = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+        end
         return headers ? HTTParty.get(url, :headers => headers) : HTTParty.get(url)
       end    
 
       # Simple HTTP POST
       def http_post(url, headers = nil, data = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+          puts "Data:"
+          puts data
+        end
         return headers ? HTTParty.post(url, :headers=> headers, :body => data) : HTTParty.post(url, :body => data)  
       end
 
       # Simple HTTP PUT
       def http_put(url, headers = nil, data = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+          puts "Data:"
+          puts data
+        end
         return headers ? HTTParty.put(url, :headers=> headers, :body => data) : HTTParty.put(url, :body => data)
       end
 
@@ -161,7 +183,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)
@@ -170,7 +193,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)
@@ -179,7 +203,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)
@@ -208,7 +233,7 @@ module Mints
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "Contet-Type" => "application/json"
+          "Content-Type" => "application/json"
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_put(url, headers, data)
@@ -216,7 +241,12 @@ module Mints
       # End User Context
       
       def public_get(url, headers = nil)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "ApiKey" => @api_key
+        }
+        h["ContactToken"] = @contact_token if @contact_token
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -226,7 +256,12 @@ module Mints
       end
 
       def public_post(url, headers = nil, data)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "ApiKey" => @api_key
+        }
+        h["ContactToken"] = @session_token if @session_token
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -236,7 +271,12 @@ module Mints
       end
 
       def public_put(url, headers = nil, data)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json", 
+          "Content-Type" => "application/json", 
+          "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
@@ -6,22 +7,8 @@ module Mints
     # === Initialize.
     # Class constructor
     #
-    def initialize(host, api_key, session_token = nil)      
-      @client = Mints::Client.new(host, api_key, "contact", session_token)
-    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})
+    def initialize(host, api_key, session_token = nil, debug = false)      
+      @client = Mints::Client.new(host, api_key, "contact", session_token, debug)
     end
 
     ##

data/lib/generators/mints_config.yml

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

data/lib/generators/mints_contact_controller.rb

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

data/lib/generators/mints_files_generator.rb

@@ -0,0 +1,20 @@
+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_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'
+      route <<-eos
+        # Mints auto-generated routes (proxy to send request to mints.cloud)
+        namespace :api, defaults: { format: :json } do
+          match '/user/v1/*path' => 'mints_user#index', via: [:get, :post, :put, :patch, :delete]  
+          namespace :v1 do     
+            match '/contacts/*path' => 'mints_contact#index', via: [:get, :post, :put, :patch, :delete]  
+            match '/*path' => 'mints_public#index', via: [:get, :post, :put, :patch, :delete]
+          end
+        end
+      eos
+    end
+end

data/lib/generators/mints_public_controller.rb

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

data/lib/generators/mints_user_controller.rb

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

data/lib/mints.rb

@@ -1,5 +1,10 @@
 require_relative "./pub.rb"
 require_relative "./contact.rb"
 require_relative "./user.rb"
+require_relative "./mints/controllers/base_controller.rb"
+require_relative "./mints/controllers/admin_base_controller.rb"
+require_relative "./mints/controllers/public_api_controller.rb"
+require_relative "./mints/controllers/contact_api_controller.rb"
+require_relative "./mints/controllers/user_api_controller.rb"
 module Mints
 end

data/lib/mints/controllers/admin_base_controller.rb

@@ -0,0 +1,56 @@
+module Mints
+  class AdminBaseController < ActionController::Base
+    before_action :set_mints_user_client
+
+    # def mints_user_signed_in?
+    #     # Check status in mints
+    #     response = @mints_user.status
+    #     status = response['success'] ? response['success'] : false
+    #     unless status
+    #       # if mints response is negative delete the session cookie
+    #       cookies.delete(:mints_user_session_token)
+    #     end
+    #     return status
+    # end
+
+    ##
+    # === Mints user Login.
+    # Starts a user session in mints.cloud and set a session cookie
+    def mints_user_login(email, password)
+        # Login in mints
+        response = @mints_user.login(email, password)
+        # Get session token from response
+        session_token = response['api_token']
+        # Set a permanent cookie with the session token
+        cookies.permanent[:mints_user_session_token] = session_token
+    end
+
+    ##
+    # === Mints user Logout.
+    # Destroy session from mints.cloud and delete local session cookie
+    def mints_user_logout
+        # Logout from mints
+        # @mints_user.logout
+        # Delete local cookie
+        cookies.delete(:mints_user_session_token)
+    end
+    
+    private
+
+    ##
+    # === 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")
+        @host = config["mints"]["host"]
+        @api_key = config["mints"]["api_key"]
+        @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
+      else
+        raise 'MintsBadCredentialsError'
+      end
+      # Initialize mints user client
+      @mints_user = Mints::User.new(@host, @api_key, nil, @debug)
+    end
+  end
+end

data/lib/mints/controllers/base_controller.rb

@@ -0,0 +1,91 @@
+module Mints
+  class BaseController < ActionController::Base
+    before_action :set_contact_token
+    before_action :set_mints_pub_client
+    before_action :register_visit
+    before_action :set_mints_contact_client
+
+    def mints_contact_signed_in?
+        # Check status in mints
+        response = @mints_contact.status
+        status = response['success'] ? response['success'] : false
+        unless status
+          # if mints response is negative delete the session cookie
+          cookies.delete(:mints_contact_session_token)
+        end
+        return status
+    end
+
+    ##
+    # === Mints Contact Login.
+    # Starts a contact session in mints.cloud and set a session cookie
+    def mints_contact_login(email, password)
+        # Login in 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
+
+    ##
+    # === Mints Contact Logout.
+    # Destroy session from mints.cloud and delete local session cookie
+    def mints_contact_logout
+        # Logout from mints
+        @mints_contact.logout
+        # Delete local cookie
+        cookies.delete(:mints_contact_session_token)
+        cookies.delete(:mints_contact_id)
+        @contact_token = nil
+    end
+    
+    private
+
+    ##
+    # === Register visit.
+    # Call register visit method from the public client and set/renew the cookie mints_contact_id
+    def register_visit
+      response = @mints_pub.register_visit(request)
+      @contact_token = response['user_token']
+      @visit_id = response['visit_id']
+      cookies.permanent[:mints_contact_id] = @contact_token
+    end
+
+    ##
+    # === 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")
+        @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
+      @mints_pub = Mints::Pub.new(@host, @api_key, nil, @debug)
+      # Set contact token from cookie
+      @mints_pub.client.session_token = @contact_token
+    end
+
+    ##
+    # === Set contact token.
+    # Set contact token variable from the mints_contact_id cookie value
+    def set_contact_token
+      @contact_token = cookies[:mints_contact_id]
+    end
+
+    ##
+    # === Set mints contact client.
+    # Initialize the public client and set the contact token
+    def set_mints_contact_client
+      # Initialize mints clontact client
+      @mints_contact = Mints::Contact.new(@host, @api_key, nil, @debug)
+    end
+  end
+end

data/lib/mints/controllers/contact_api_controller.rb

@@ -0,0 +1,42 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class ContactAPIController < ActionController::API
+        include AbstractController::Helpers
+        include ActionController::Cookies
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json'
+            }
+            if cookies[:mints_contact_session_token]
+                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|
+                    # We got a 404!
+                    if code == 404
+                        raise ActionController::RoutingError.new('Not Found')
+                    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")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/mints/controllers/public_api_controller.rb

@@ -0,0 +1,36 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class PublicAPIController < ActionController::API
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json' 
+            }
+            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    
+        
+        private
+
+        def set_config_variables
+            if File.exists?("#{Rails.root}/mints_config.yml")
+                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/mints/controllers/user_api_controller.rb

@@ -0,0 +1,42 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class UserAPIController < ActionController::API
+        include AbstractController::Helpers
+        include ActionController::Cookies
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+        
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json'
+            }
+            if cookies[:mints_contact_session_token]
+                session_token = cookies[:mints_user_session_token]
+                headers["Authorization"] = "Bearer #{session_token}"
+            end            
+            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    
+
+        private
+
+        def set_config_variables
+            if File.exists?("#{Rails.root}/mints_config.yml")
+                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/pub.rb

@@ -1,12 +1,14 @@
+require 'yaml'
 require_relative './client.rb'
 module Mints
-
   ##
   # == Public context API
   # Pub class contains functions that needs only an API key as authentication
   # == Usage example
   # Initialize
   #     pub = Mints::Pub.new(mints_url, api_key)
+  # or if host and api_key are provided by mints_config.yml
+  #     pub = Mints::Pub.new
   # Call any function
   #     pub.get_products
   # == Single resource options
@@ -25,6 +27,7 @@ module Mints
   # * +include+ - [String] include a relationship
   # * +attributes+ - [Boolean] attach attributes to response
   # * +categories+ - [Boolean] attach categories to response
+  # * +taxonomies+ - [Boolean] attach categories to response
   # * +tags+ - [Boolean] attach tags to response
   class Pub
     attr_reader :client
@@ -36,10 +39,11 @@ module Mints
     # ==== Parameters
     # * +host+ - [String] It's the visitor IP
     # * +api_key+ - [String] Mints instance api key
+    # * +contact_token+ - [String] Cookie 'mints_contact_id' value (mints_contact_token)
     # ==== Return
     # Returns a Client object
-    def initialize(host, api_key)
-      @client = Mints::Client.new(host, api_key)
+    def initialize(host, api_key, contact_token = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, contact_token, debug)
     end
     
     ##
@@ -47,16 +51,18 @@ module Mints
     # Register a ghost/contact visit in Mints.Cloud
     #
     # ==== Parameters
+    # * +request+ - [ActionDispatch::Request] request
     # * +ip+ - [String] It's the visitor IP
     # * +user_agent+ - The visitor's browser user agent
     # * +url+ - [String] URL visited
-    def register_visit(ip, user_agent, url)
+    def register_visit(request, ip = nil, user_agent = nil, url = nil)
       data = {
-        ip_address: ip,
-        user_agent: user_agent,
-        url: url
+        ip_address: ip || request.remote_ip,
+        user_agent: user_agent || request.user_agent,
+        url: url || request.fullpath
       }
-      return @client.raw("post", "/register-visit-timer", nil, data)
+      response = @client.raw("post", "/register-visit", nil, data.to_json)
+      return response
     end
 
     ##
@@ -88,7 +94,7 @@ module Mints
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_templates(options = nil)
-      return @client.raw("get", "/content/content-templates")
+      return @client.raw("get", "/content/content-templates", options)
     end
 
     ##
@@ -108,7 +114,7 @@ module Mints
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    def content_instances(options) 
+    def get_content_instances(options) 
       return @client.raw("get", "/content/content-instances", options)
     end
 
@@ -119,7 +125,7 @@ module Mints
     # ==== Parameters
     # * +slug+ - [String] It's the string identifier generated by Mints
     # * +options+ - [Hash] List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter
-    def content_instance(slug, options = nil)
+    def get_content_instance(slug, options = nil)
       return @client.raw("get", "/content/content-instances/#{slug}", options)
     end
 
@@ -146,13 +152,12 @@ module Mints
 
     ##
     # === Get Forms.
-    # Get a collection of forms.
+    # Get a collection of forms
     #
     # ==== Parameters
-    # * +slug+ - [String] It's the string identifier generated by Mints
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
     def get_forms(options = nil)
-      return @client.raw("get", "/content/forms/{slug}", options)
+      return @client.raw("get", "/content/forms", options)
     end
 
     ##
@@ -163,7 +168,7 @@ module Mints
     # * +slug+ - [String] It's the string identifier generated by Mints
     # * +options+ - [Hash] List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter
     def get_form(slug, options = nil)
-      return @client.raw("get", "/content/forms/{slug}", options)
+      return @client.raw("get", "/content/forms/#{slug}", options)
     end
 
     ##
@@ -266,7 +271,7 @@ module Mints
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    def get_tags(options)
+    def get_tags(options = nil)
       return @client.raw("get", "/config/tags", options)
     end
 
@@ -290,5 +295,26 @@ module Mints
     def get_attributes(options = nil)
       return @client.raw("get", "/config/attributes", options)
     end
+
+    ##
+    # === Get Taxonomies.
+    # Get a collection of taxonomies.
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    def get_taxonomies(options = nil)
+      return @client.raw("get", "/config/taxonomies", options)
+    end
+
+    ##
+    # === Get Taxonomy.
+    # Get a single taxonomy
+    #
+    # ==== Parameters
+    # * +slug+ - [String] It's the string identifier generated by Mints
+    # * +options+ - [Hash] List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter
+    def get_taxonomy(slug, options = nil)
+      return @client.raw("get", "/config/taxonomies/#{slug}", options)
+    end
   end
 end

data/lib/user.rb

@@ -1,9 +1,35 @@
 require_relative './client.rb'
 module Mints
+  ##
+  # == User context API
+  # User class contains functions that needs an API key and a session token as authentication
+  # == Usage example
+  # Initialize
+  #     client = Mints::User.new(mints_url, api_key)
+  # Call any function
+  #     client.get_contacts
+  # == Single resource options
+  # * +include+ - [String] include a relationship
+  # * +attributes+ - [Boolean] attach attributes to response
+  # * +categories+ - [Boolean] attach categories to response
+  # * +tags+ - [Boolean] attach tags to response
+  # == Resource collections options 
+  # * +search+ - [String] filter by a search word
+  # * +scopes+ - [String] filter by a scope
+  # * +filters+ - [String] filter by where clauses
+  # * +jfilters+ - [String] filter using complex condition objects
+  # * +catfilters+ - [String] filter by categories
+  # * +fields+ - [String] indicates the columns that will be selected
+  # * +sort+ - [String] indicates the columns that will be selected
+  # * +include+ - [String] include a relationship
+  # * +attributes+ - [Boolean] attach attributes to response
+  # * +categories+ - [Boolean] attach categories to response
+  # * +taxonomies+ - [Boolean] attach categories to response
+  # * +tags+ - [Boolean] attach tags to response
   class User
     attr_reader :client
-    def initialize(host, api_key, session_token = nil)
-      @client = Mints::Client.new(host, api_key, 'user', session_token)
+    def initialize(host, api_key, session_token = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, 'user', session_token, debug)
     end
 
     def login(email, password)
@@ -18,7 +44,12 @@ module Mints
       return response
     end
     ######################################### CRM #########################################
-    ### Contacts ###
+    ##
+    # === Get contacts.
+    # Get a collection of contacts
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_contacts(options = nil)
       return @client.get__crm__contacts(options)
     end
@@ -34,7 +65,12 @@ module Mints
     def update_contact(id, data, options = nil)
       return @client.update__crm__contacts(id, data, options)
     end
-    ### Companies ###
+    
+    # === Get companies.
+    # Get a collection of companies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_companies(options = nil)
       return @client.get__crm__companies(options)
     end
@@ -51,7 +87,11 @@ module Mints
       return @client.update__crm__companies(id, data, options)
     end
 
-    ### Deals ###
+    # === Get deals.
+    # Get a collection of deals
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_deals(options = nil)
       return @client.get__crm__deals(options)
     end
@@ -69,7 +109,11 @@ module Mints
     end
 
     ######################################### Content #########################################
-    ### Stories ###
+    # === Get stories.
+    # Get a collection of stories
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_stories(options = nil)
       return @client.get__content__stories(options)
     end
@@ -86,7 +130,11 @@ module Mints
       return @client.update__content__stories(id, data, options)
     end
 
-    ### Stories templates ###
+    # === Get story templates.
+    # Get a collection of story templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_story_templates(options = nil)
       return @client.get__content__story_templates(options)
     end
@@ -103,7 +151,11 @@ module Mints
       return @client.update__content__story_templates(id, data, options)
     end
 
-    ### Content instances ###
+    # === Get content instances.
+    # Get a collection of content instances
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_instances(options = nil)
       return @client.get__content__instances(options)
     end
@@ -120,7 +172,11 @@ module Mints
       return @client.update__content__instances(id, data, options)
     end
 
-    ### Content pages ###
+    # === Get content pages.
+    # Get a collection of content pages
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_pages(options = nil)
       return @client.get__content__pages(options)
     end
@@ -137,25 +193,32 @@ module Mints
       return @client.update__content__pages(id, data, options)
     end
 
-    ### Content templates ###
+    # === Get content templates.
+    # Get a collection of content templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_templates(options = nil)
       return @client.get__content__templates(options)
     end
 
-    def get_content_page(id, options = nil)
+    def get_content_template(id, options = nil)
       return @client.get__content__templates(id, options)
     end
 
-    def create_content_page(data, options = nil)
+    def create_content_template(data, options = nil)
       return @client.create__content__templates(data, options)
     end
 
-    def update_content_page(id, data, options = nil)
+    def update_content_template(id, data, options = nil)
       return @client.update__content__templates(id, data, options)
     end
 
-    ######################################### Ecommerce #########################################
-    ### Products ###
+    # === Get products.
+    # Get a collection of products
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_products(options = nil)
       return @client.get__ecommerce__products(options)
     end
@@ -172,7 +235,11 @@ module Mints
       return @client.update__ecommerce__products(id, data, options)
     end
 
-    ### SKUs ###
+    # === Get skus.
+    # Get a collection of skus
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_skus(options = nil)
       return @client.get__ecommerce__skus(options)
     end
@@ -189,7 +256,11 @@ module Mints
       return @client.update__ecommerce__skus(id, data, options)
     end
 
-    ### Prices ###
+    # === Get prices.
+    # Get a collection of prices
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_prices(options = nil)
       return @client.get__ecommerce__prices(options)
     end
@@ -206,7 +277,11 @@ module Mints
       return @client.update__ecommerce__prices(id, data, options)
     end
 
-    ### Price lists ###
+    # === Get prece lists.
+    # Get a collection of prece lists
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_price_lists(options = nil)
       return @client.get__ecommerce__price_lists(options)
     end
@@ -223,7 +298,11 @@ module Mints
       return @client.update__ecommerce__price_lists(id, data, options)
     end
 
-    ### Product brands ###
+    # === Get product brands.
+    # Get a collection of product brands
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_brands(options = nil)
       return @client.get__ecommerce__product_brands(options)
     end
@@ -240,7 +319,11 @@ module Mints
       return @client.update__ecommerce__product_brands(id, data, options)
     end
 
-    ### Product types ###
+    # === Get product types.
+    # Get a collection of product types
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_types(options = nil)
       return @client.get__ecommerce__product_types(options)
     end
@@ -257,7 +340,11 @@ module Mints
       return @client.update__ecommerce__product_types(id, data, options)
     end
 
-    ### Product templates ###
+    # === Get product templates.
+    # Get a collection of product templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_templates(options = nil)
       return @client.get__ecommerce__product_templates(options)
     end
@@ -275,7 +362,11 @@ module Mints
     end
 
 
-    ### Locations ###
+    # === Get locations.
+    # Get a collection of locations
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_locations(options = nil)
       return @client.get__ecommerce__locations(options)
     end
@@ -291,5 +382,26 @@ module Mints
     def update_location(id, data, options = nil)
       return @client.update__ecommerce__locations(id, data, options)
     end
-  end
+  
+    # === Get taxonomies.
+    # Get a collection of taxonomies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_taxonomies(options = nil)
+      return @client.get__config__taxonomies(options)
+    end
+
+    def get_taxonomy(id, options = nil)
+      return @client.get__config__taxonomies(id, options)
+    end
+
+    def create_taxonomy(data, options = nil)
+      return @client.create__config__taxonomies(data, options)
+    end
+
+    def update_taxonomy(id, data, options = nil)
+      return @client.update__config__taxonomies(id, data, options)
+    end
+  end  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
-- Ruben Gomez Garcia, Omar Mora
+- Ruben Gomez Garcia, Omar Mora, Luis Payan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -70,6 +70,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: rails-reverse-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: 
 email: 
 executables: []
@@ -80,7 +100,17 @@ files:
 - Readme.md
 - lib/client.rb
 - lib/contact.rb
+- lib/generators/mints_config.yml
+- lib/generators/mints_contact_controller.rb
+- lib/generators/mints_files_generator.rb
+- lib/generators/mints_public_controller.rb
+- lib/generators/mints_user_controller.rb
 - lib/mints.rb
+- lib/mints/controllers/admin_base_controller.rb
+- lib/mints/controllers/base_controller.rb
+- lib/mints/controllers/contact_api_controller.rb
+- lib/mints/controllers/public_api_controller.rb
+- lib/mints/controllers/user_api_controller.rb
 - lib/pub.rb
 - lib/user.rb
 homepage: https://github.com/rubengomez/mints-ruby-sdk
@@ -89,6 +119,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- app
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements: