mints 0.0.13 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c41c7087845ab6006184ede917cacbd44060204251bf3ca22feba75c3a259833
-  data.tar.gz: 5e9ad370733cb076c6000d5127d979b9727c7c103e56a79095ff881de0249a7f
+  metadata.gz: 5f269f998c9cc9cb3dc69f3ec70cc2ff4522a97c14a9da0bfb6ca4cba40b0654
+  data.tar.gz: e6b867ce7e3623b05c7aad402462f09b0b1a71a3750549c669407bcff6d2aa2b
 SHA512:
-  metadata.gz: aa5b4e5709e9852e34bf9411cc158d75faf35204bd897625106748ed27d00f7217b16fbb844abc28ec935b83dd6ade6ca7708330280d61de6969ca3a498b7425
-  data.tar.gz: 265637b717d062e3c0474b3ad5d1275f7c3329568a4fcc6b181f6198cddd5ef325583cdaa3827c6e6ff752b24b458316c9dda6f068946142577101c16ea3bff3
+  metadata.gz: 1128997e3df23340e780e4dcc9bb84389df6062eaae3683dff653b440887a5c4d04059141e8472e3762c3ce856df795c26ef7e376c72c38e494880aef5ab830b
+  data.tar.gz: '09b6774bb218dc40cd0083fc54428225999736f5452911c7b482a22b928d41dea91fe343ecbab96543be6c602393f6f13aaa9d9d1ee489b8e4a697bf61eda20f'

data/lib/client.rb

@@ -8,12 +8,14 @@ module Mints
       attr_reader :api_key
       attr_reader :scope
       attr_reader :base_url
-      attr_accessor :session_token      
+      attr_accessor :session_token
+      attr_accessor :contact_token_id
 
-      def initialize(host, api_key, scope = nil, session_token = nil, debug = false)
+      def initialize(host, api_key, scope = nil, session_token = nil, contact_token_id = nil, debug = false)
           @host = host
           @api_key = api_key
           @session_token = session_token
+          @contact_token_id = contact_token_id
           @debug = debug
           self.set_scope(scope)
       end
@@ -22,6 +24,9 @@ module Mints
         base_url = @base_url if !base_url
         uri = ""
         if (options && options.class == Hash)
+          if (options[:jfilters] && options[:jfilters].class == Hash)
+            options[:jfilters] = Base64.encode64(JSON.generate(options[:jfilters]))
+          end
           uri = Addressable::URI.new
           uri.query_values = options
         end
@@ -218,7 +223,7 @@ module Mints
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "ContactToken" => @contact_token
+          "ContactToken" => @contact_token_id
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_get(url, headers)
@@ -228,7 +233,7 @@ module Mints
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "ContactToken" => @contact_token
+          "ContactToken" => @contact_token_id
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_post(url, headers, data)
@@ -238,10 +243,10 @@ module Mints
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "ContactToken" => @contact_token
+          "ContactToken" => @contact_token_id
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
-        return self.http_post(url, headers, data)
+        return self.http_put(url, headers, data)
       end
 
       # Start User context
@@ -280,7 +285,7 @@ module Mints
           "Content-Type" => "application/json",
           "ApiKey" => @api_key
         }
-        h["ContactToken"] = @contact_token if @contact_token
+        h["ContactToken"] = @contact_token_id if @contact_token_id
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -310,7 +315,7 @@ module Mints
           "Content-Type" => "application/json", 
           "ApiKey" => @api_key
         }
-        h["ContactToken"] = @contact_token if @contact_token
+        h["ContactToken"] = @contact_token_id if @contact_token_id
         if headers
           headers.each do |k,v|
             h[k] = v

data/lib/contact.rb

@@ -7,14 +7,21 @@ module Mints
     # === Initialize.
     # Class constructor
     #
-    def initialize(host, api_key, session_token = nil, debug = false)      
-      @client = Mints::Client.new(host, api_key, "contact", session_token, debug)
+    def initialize(host, api_key, session_token = nil, contact_token_id = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, "contact", session_token, contact_token_id, debug)
     end
 
     ##
     # === Login.
     # Starts a contact session
     #
+    # ==== Parameters:
+    # * +email+ - [_String_] The email that will be logged.
+    # * +password+ - [_String_] The password of the email.
+    #
+    # ==== Example
+    #     @mints_contact.login("brown.abigail@dubuque.com", "helloword")
+    #
     def login(email, password)
       data = {
         email: email,
@@ -27,9 +34,62 @@ module Mints
       return response
     end
 
+    ##
+    # === Magic Link Login.
+    # Starts a contact session with a token received in the contact email. The token will be received by send_magic_link method.
+    #
+    # ==== Parameters:
+    # * +token+ - [_String_] The email that will be logged.
+    #
+    # ==== Example
+    #     @mints_contact.magic_link_login(
+    #       "d8618c6d-a165-41cb-b3ec-d053cbf30059:zm54HtRdfHED8dpILZpjyqjPIceiaXNLfOklqM92fveBS0nDtyPYBlI4CPlPe3zq"
+    #     )
+    #
+    def magic_link_login(token)
+      response = @client.raw("get", "/contacts/magic-link-login/#{token}", nil, '/api/v1')
+      if response.key? "session_token"
+        @client.session_token = response["session_token"]
+      end
+      return response
+    end
+
+    ##
+    # === Send Magic Link
+    # Send magic link to contact by email. That magic link will be used in magic_link_login method.
+    #
+    # ==== Parameters:
+    # * +email+ - [_String_] Contact's email.
+    # * +template_slug+ - [_String_] Email template's slug to be used in the email.
+    # * +redirectUrl+ - [_String_] Url to be redirected in the implemented page.
+    # * +lifeTime+ - [_Integer_] Maximum time of use in minutes.
+    # * +maxVisits+ - [_Integer_] The maximum number of uses of a token. 
+    #
+    # ==== First Example
+    #     @mints_contact.send_magic_link("brown.abigail@dubuque.com", "")
+    #
+    # ==== Second Example
+    #     @mints_contact.send_magic_link("brown.abigail@dubuque.com", "", "", 1440, 3)
+    #
+    def send_magic_link(email, template_slug, redirectUrl = '', lifeTime = 1440, maxVisits = nil)
+      data = {
+        email: email,
+        lifeTime: lifeTime,
+        maxVisits: maxVisits,
+        redirectUrl: redirectUrl,
+        templateId: template_slug
+      }
+      response = @client.raw("post", "/contacts/magic-link", nil, { data: data }, '/api/v1')
+      return response
+    end
+
     ##
     # === Logout.
-    # Ends a contact session
+    # Ends a contact session previously logged.
+    #
+    # ==== Example
+    #     @mints_contact.login('brown.abigail@dubuque.com', 'helloword')
+    #     @mints_contact.logout
     #
     def logout
       response = @client.raw("post", "/contacts/logout") if session_token?
@@ -41,7 +101,15 @@ module Mints
 
     ##
     # === Change Password.
-    # Change password
+    # Change password without email. To change the password a contact must be logged.
+    #
+    # ==== Parameters:
+    # * +data+ - [] A new password allocated in a data key.
+    #
+    # ==== Example
+    #     @mints_contact.login('brown.abigail@dubuque.com', 'helloword')
+    #     data = { "data": { "password": "123456" } }
+    #     @mints_contact.change_password(data)
     #
     def change_password(data)
       return @client.raw("post", "/contacts/change-password", nil, data)
@@ -49,7 +117,14 @@ module Mints
 
     ##
     # === Recover Password.
-    # Recover password
+    # Send a email that contains a token to a contact. That token will be used in reset_password to establish a new password. 
+    #
+    # ==== Parameters:
+    # * +data+ - [] It's a data key where will be hosted the destination email. 
+    #
+    # ==== Example
+    #     data = { "data": { "email": "brown.abigail@dubuque.com" } }
+    #     @mints_contact.recover_password(data)
     #
     def recover_password(data)
       return @client.raw("post", "/contacts/recover-password", nil, data)
@@ -57,7 +132,19 @@ module Mints
 
     ##
     # === Reset Password.
-    # Reset password
+    # Reset password using a token. The token is obtained by recover_password method.
+    #
+    # ==== Parameters:
+    # * +data+ - [] It's a set of data which contains all the information to reset a contact password.
+    #
+    # ==== Example
+    #     data = { "data": { 
+    #       "email": "brown.abigail@dubuque.com", 
+    #       "password": "helloword", 
+    #       "password_confirmation": "helloword", 
+    #       "token": "644aa3aa0831d782cc42e42b11aedea9a2234389af4f429a8d96651295ecfa09" 
+    #     } }
+    #     @mints_contact.reset_password(data)
     #
     def reset_password(data)
       return @client.raw("post", "/contacts/reset-password", nil, data)
@@ -73,7 +160,10 @@ module Mints
 
     ##
     # === Me.
-    # Get contact logged info
+    # Get contact logged info.
+    #
+    # ==== Example
+    #     @mints_contact.me
     #
     def me
       return @client.raw("get", "/contacts/me")
@@ -81,7 +171,10 @@ module Mints
 
     ##
     # === Status.
-    # Get contact logged status
+    # Get contact logged status.
+    #
+    # ==== Example
+    #     @mints_contact.status
     #
     def status
       return @client.raw("get", "/contacts/status")
@@ -89,12 +182,43 @@ module Mints
 
     ##
     # === Update.
-    # Update logged contact attributes
+    # Update logged contact attributes.
+    #
+    # ==== Parameters:
+    # * +data+ - [] It's the data to update with a session active.
+    #
+    # ==== Example
+    #     @mints_contact.login("brown.abigail@dubuque.com", "helloword")
+    #     data = { "data": { 
+    #       "given_name": "Alonso", 
+    #       "last_name": "Garcia"
+    #     } }
+    #     @mints_contact.update(data)
     #
     def update(data)
       return @client.raw("put", "/contacts/update", nil, data)
     end
 
+    ##
+    # === Register.
+    # Register a contact.
+    #
+    # ==== Parameters:
+    # * +data+ - [] It's the register data.
+    #
+    # ==== Example
+    #     data = { "data": {
+    #       "email": "carlos@mints.cloud",
+    #       "given_name": "Carlos",
+    #       "last_name": "Fernandez",
+    #       "password": "123456"
+    #     } }
+    #     @mints_contact.register(data);
+    #
+    def register(data)
+      return @client.raw("post", "/contacts/register", nil, data)
+    end
+
     private
 
     def session_token?

data/lib/generators/mints_assets_controller.rb

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

data/lib/generators/mints_files_generator.rb

@@ -6,12 +6,15 @@ class MintsFilesGenerator < Rails::Generators::Base
       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'
+      copy_file 'mints_assets_controller.rb', './app/controllers/mints_assets_controller.rb'
       route <<-eos
         # Mints auto-generated routes (proxy to send request to mints.cloud)
+        match '/public-assets/*path' => 'mints_assets#index', via: [:get, :post, :put, :patch, :delete]
         namespace :api, defaults: { format: :json } do
-          match '/user/v1/*path' => 'mints_user#index', via: [:get, :post, :put, :patch, :delete]  
+          match '/user/v1/*path' => 'mints_user#index', via: [:get, :post, :put, :patch, :delete]
+          match '/contact/v1/*path' => 'mints_contact#index', via: [:get, :post, :put, :patch, :delete]  
           namespace :v1 do     
-            match '/contacts/*path' => 'mints_contact#index', via: [:get, :post, :put, :patch, :delete]  
+            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

data/lib/mints/controllers/admin_base_controller.rb

@@ -2,16 +2,16 @@ 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
+    def mints_user_signed_in?
+        # Check status in mints
+        response = @mints_user.me
+        status = response['data'] ? true : 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.
@@ -25,6 +25,21 @@ module Mints
         cookies.permanent[:mints_user_session_token] = session_token
     end
 
+    ##
+    # === Mints user Login.
+    # Starts a user session in mints.cloud and set a session cookie
+    def mints_user_magic_link_login(hash)
+      # Login in mints
+      response = @mints_user.magic_link_login(hash)
+      if response['data'] && response['data']['redirect_url']
+        # Set a cookie with the session token
+        cookies[:mints_user_session_token] = { value: response['data']['api_token'], expires: 1.day }
+        redirect_to response['data']['redirect_url']
+      else
+        redirect_to '/'
+      end
+    end
+
     ##
     # === Mints user Logout.
     # Destroy session from mints.cloud and delete local session cookie
@@ -51,7 +66,8 @@ module Mints
         raise 'MintsBadCredentialsError'
       end
       # Initialize mints user client
-      @mints_user = Mints::User.new(@host, @api_key, nil, @debug)
+      session_token = cookies[:mints_user_session_token] ? cookies[:mints_user_session_token] : nil
+      @mints_user = Mints::User.new(@host, @api_key, session_token, @debug)
     end
   end
 end

data/lib/mints/controllers/base_api_controller.rb

@@ -1,6 +1,6 @@
 module Mints
   class BaseApiController < ActionController::Base
-    before_action :set_mints_pub_client
+    before_action :set_mints_clients
 
     ##
     # === Mints Contact Login.
@@ -15,6 +15,26 @@ module Mints
         cookies.permanent[:mints_contact_session_token] = session_token
         cookies.permanent[:mints_contact_id] = id_token
         @contact_token = id_token
+      end
+      
+    ##
+    # === Mints cotnact Login.
+    # Starts a cotnact session in mints.cloud and set a session cookie
+    def mints_contact_magic_link_login(hash)
+      # Login in mints
+      response = @mints_contact.magic_link_login(hash)
+      if response['data']
+        # Get session token from response
+        session_token = response['data']['session_token']
+        id_token = response['data']['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
+        redirect_to response['data']['redirect_url'] ? response['data']['redirect_url'] : '/'
+      else
+        redirect_to '/'
+      end
     end
 
     ##
@@ -28,26 +48,96 @@ module Mints
         cookies.delete(:mints_contact_id)
         @contact_token = nil
     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 Login.
+    # Starts a user session in mints.cloud and set a session cookie
+    def mints_user_magic_link_login(hash)
+      # Login in mints
+      response = @mints_user.magic_link_login(hash)
+      if response['data']
+        # Set a cookie with the session token
+        cookies[:mints_user_session_token] = { value: response['data']['api_token'], expires: 1.day }
+        redirect_to response['data']['redirect_url'] ? response['data']['redirect_url'] : '/'
+      else
+        redirect_to '/'
+      end
+    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 pub.
-    # Initialize the public client and set the contact token
-    def set_mints_pub_client
+    # === Set mints clients (pub, user and contact)
+    # Initialize all clients from mitns
+    def set_mints_clients
       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
+
+        #public client
+        set_mints_pub_client
+        #contact client
+        set_mints_contact_client
+        #user client
+        set_mints_user_client
       else
         raise 'MintsBadCredentialsError'
       end
+    end
+
+    ##
+    # === Set mints pub.
+    # Initialize the public client and set the contact token
+    def set_mints_pub_client
+      
       # 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
     end
+
+    ##
+    # === Set mints contact client.
+    # Initialize the public client and set the contact token
+    def set_mints_contact_client
+      # Initialize mints clontact client
+      session_token = cookies[:mints_contact_session_token] ? cookies[:mints_contact_session_token] : nil
+      contact_token_id = cookies[:mints_contact_id] ? cookies[:mints_contact_id] : nil
+      @mints_contact = Mints::Contact.new(@host, @api_key, session_token, contact_token_id, @debug)
+    end
+    
+    ##
+    # === Set Mints user client.
+    # Initialize the public client and set the user token
+    def set_mints_user_client
+      # Initialize mints user client
+      session_token = cookies[:mints_user_session_token] ? cookies[:mints_user_session_token] : nil
+      @mints_user = Mints::User.new(@host, @api_key, session_token, @debug)
+    end
   end
 end

data/lib/mints/controllers/base_controller.rb

@@ -31,6 +31,21 @@ module Mints
         @contact_token = id_token
     end
 
+    ##
+    # === Mints Contact Magic Link Login.
+    # Starts a contact session in mints.cloud and set a session cookie
+    def mints_contact_magic_link_login(token)
+      # 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
@@ -69,7 +84,7 @@ module Mints
         raise 'MintsBadCredentialsError'
       end
       # Initialize mints pub client, credentials taken from mints_config.yml.erb file
-      @mints_pub = Mints::Pub.new(@host, @api_key, nil, @debug)
+      @mints_pub = Mints::Pub.new(@host, @api_key, @contact_token, @debug)
       # Set contact token from cookie
       @mints_pub.client.session_token = @contact_token
     end
@@ -86,7 +101,9 @@ module Mints
     # 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)
+      session_token = cookies[:mints_contact_session_token] ? cookies[:mints_contact_session_token] : nil
+      contact_token_id = cookies[:mints_contact_id] ? cookies[:mints_contact_id] : nil
+      @mints_contact = Mints::Contact.new(@host, @api_key, session_token, contact_token_id, @debug)
     end
   end
 end

data/lib/pub.rb

@@ -5,6 +5,10 @@ module Mints
   # == Public context API
   # Pub class contains functions that needs only an API key as authentication
   # == Usage example
+  # === For Mints::BaseController inheritance:
+  # If the controller is inheriting from Mints::BaseController, Only use the class variable *mints_pub*  _Example:_
+  #     @mints_pub.get_stories
+  # === For standalone usage:
   # Initialize
   #     pub = Mints::Pub.new(mints_url, api_key)
   # or if host and api_key are provided by mints_config.yml.erb
@@ -12,23 +16,58 @@ module Mints
   # Call any function
   #     pub.get_products
   # == 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
+  # * +include+ - [_String_] Specify additional information to be included in the results from the objects relations. _Example:_
+  #     { "include": "events" }
+  # * +attributes+ - [_Boolean_] If present, attributes will be returned for each record in the results. _Example:_
+  #     { "attributes": true }
+  # * +categories+ - [_Boolean_] If present, categories will be returned for each record in the results. _Example:_
+  #     { "categories": true }
+  # * +tags+ - [_Boolean_] If present, tags will be returned for each record in the results. _Example:_
+  #     { "tags": true }
+  # * +fields+ - [_String_] Specify the fields that you want to be returned. If empty, all fields are returned. The object index can also be used to specify specific fields from relations. _Example:_
+  #     { "fields": "id, title, slug" }
+  #     { "fields[products]": "id, title, slug" }
+  #
   # == 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
+  # * +search+ - [_String_] If present, it will search for records matching the search string. _Example:_
+  #     { "search": "searchstring" }
+  # * +scopes+ - [_String_] If present, it will apply the specified Model's scopes. _Example:_
+  #     { "scopes": "approved, recent" }
+  # * +filters+ - [_String_] This is a powerful parameter that allows the data to be filtered by any of its fields. Currently only exact matches are supported. _Example:_
+  #     { "filters[title]": "titleToFilter" }
+  # * +jfilters+ - [_String_] A complex filter configuration, as used in segments, in JSON format, base64 encoded and URLencoded. _Example:_
+  #     jfilter = {
+  #       "type":"group",
+  #       "items":[
+  #         {
+  #           "type":"attribute",
+  #           "operator":"==",
+  #           "slug":"title",
+  #           "value":"Action movies"
+  #         }
+  #       ],
+  #       "operator":"or"
+  #     } 
+  #     options = { "jfilters": jfilter }
+  # * +catfilters+ - [_String_] filter by categories. _Example:_
+  #     { "catfilters": "categoryName" }
+  # * +fields+ - [_String_] Specify the fields that you want to be returned. If empty, all fields are returned. The object index can also be used to specify specific fields from relations. _Example:_
+  #     { "fields": "id, title, slug" }
+  #     { "fields[products]": "id, title, slug" }
+  # * +sort+ - [_String_] The name of the field to perform the sort. Prefix the value with a minus sign - for ascending order. _Example:_
+  #     { "sort": "title" }
+  #     { "sort": "-title" }
+  # * +include+ - [_String_] Specify additional information to be included in the results from the objects relations. _Example:_
+  #     { "include": "events" }
+  # * +attributes+ - [_Boolean_] If present, attributes will be returned for each record in the results. _Example:_
+  #     { "attributes": true }
+  # * +categories+ - [_Boolean_] If present, categories will be returned for each record in the results. _Example:_
+  #     { "categories": true }
+  # * +taxonomies+ - [_Boolean_] If present, taxonomies will be returned for each record in the results. _Example:_
+  #     { "taxonomies": true }
+  # * +tags+ - [_Boolean_] If present, tags will be returned for each record in the results. _Example:_
+  #     { "tags": true }
+
   class Pub
     attr_reader :client
 
@@ -42,8 +81,8 @@ module Mints
     # * +contact_token+ - [String] Cookie 'mints_contact_id' value (mints_contact_token)
     # ==== Return
     # Returns a Client object
-    def initialize(host, api_key, contact_token = nil, debug = false)      
-      @client = Mints::Client.new(host, api_key, 'public', contact_token, debug)
+    def initialize(host, api_key, contact_token_id = nil,  debug = false)
+      @client = Mints::Client.new(host, api_key, 'public', nil, contact_token_id, debug)
     end
     
     ##
@@ -55,6 +94,15 @@ module Mints
     # * +ip+ - [String] It's the visitor IP
     # * +user_agent+ - The visitor's browser user agent
     # * +url+ - [String] URL visited
+    #
+    # ==== Example
+    #     request = {
+    #       "remote_ip" => "http://864.401.156.12/",
+    #       "user_agent" => "User Agent",
+    #       "fullpath" => "https://mints.cloud/blog"
+    #     }
+    #     @mints_pub.register_visit(request, request["remote_ip"], request["user_agent"], request["fullpath"])
+    #
     def register_visit(request, ip = nil, user_agent = nil, url = nil)
       data = {
         ip_address: ip || request.remote_ip,
@@ -72,69 +120,38 @@ module Mints
     # ==== Parameters
     # * +visit+ - [String] It's the visitor IP
     # * +time+ - [Integer] The visitor's browser user agent
+    #
+    # ==== Example
+    #     @mints_pub.register_visit_timer("60da2325d29acc7e55684472", 4)
+    #
     def register_visit_timer(visit, time)
       return @client.raw("get", "/register-visit-timer?visit=#{visit}&time=#{time}")
     end
 
     ##
-    # === Get Content Page.
-    # Get a single content page
+    # === Get Asset Info.
+    # Get a description of an Asset
     #
     # ==== Parameters
-    # * +slug+ - [String] It's the slug 
-    # * +options+ - [Hash] List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter
-    def get_content_page(slug, options = nil)
-      return @client.raw("get", "/content/content-pages/#{slug}", options)
-    end
-
-    ##
-    # === Get Content Templates.
-    # Get a collection of content templates
-    #
-    # ==== 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", options)
-    end
-
-    ##
-    # === Get Content Template.
-    # Get a single content template.
+    # * +slug+ - [String] It's the string identifier of the asset.
     #
-    # ==== 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_content_template(slug, options = nil)
-      return @client.raw("get", "/content/content-templates/#{slug}", options)
-    end
-
-    ##
-    # === Get Content Instances.
-    # Get a collection of content instances
+    # ==== Example
+    #     @mints_pub.get_asset_info("quaerat")
     #
-    # ==== 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_instances(options) 
-      return @client.raw("get", "/content/content-instances", options)
+    def get_asset_info(slug)
+      return @client.raw("get", "/content/asset-info/#{slug}")
     end
-
-    ##
-    # === Get Content Instance.
-    # Get a single content instance.
-    #
-    # ==== 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_content_instance(slug, options = nil)
-      return @client.raw("get", "/content/content-instances/#{slug}", options)
-    end
-
+    
     ##
     # === Get Stories.
     # Get a collection of stories
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     @mints_pub.get_stories
+    #
     def get_stories(options = nil)
       return @client.raw("get", "/content/stories", options)
     end
@@ -146,6 +163,10 @@ 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
+    #
+    # ==== Example
+    #     @mints_pub.get_story("getting-ready-for-e3")
+    #
     def get_story(slug, options = nil)
       return @client.raw("get", "/content/stories/#{slug}", options)
     end
@@ -156,6 +177,10 @@ module Mints
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     @mints_pub.get_forms
+    #
     def get_forms(options = nil)
       return @client.raw("get", "/content/forms", options)
     end
@@ -167,6 +192,10 @@ 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
+    #
+    # ==== Example
+    #     @mints_pub.get_form("survey")
+    #
     def get_form(slug, options = nil)
       return @client.raw("get", "/content/forms/#{slug}", options)
     end
@@ -177,79 +206,126 @@ module Mints
     #
     # ==== Parameters
     # * +data+ - [Hash] Data to be submited
+    #
+    # ==== Example
+    #     data_form = {
+    #       "data": {
+    #         'form_slug': 'formulario',
+    #         'email': 'oscar@mints.cloud',
+    #         'ingrese-un-texto': 'hola'
+    #       }
+    #     }
+    #     @mints_pub.submit_form(data_form.to_json)
+    #
     def submit_form(data)
       return @client.raw("post", "/content/forms/submit", nil, data)
-    end
+    end    
 
     ##
-    # === Get Products.
-    # Get a collection of products.
+    # === Get Content Instances.
+    # Get a collection of content instances. _Note:_ Options must be specified. 
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    def get_products(options = nil)
-      return @client.raw("get", "/ecommerce/products", options)
+    def get_content_instances(options = nil) 
+      return @client.raw("get", "/content/content-instances", options)
     end
 
     ##
-    # === Get Product.
-    # Get a single product.
+    # === Get Content Instance.
+    # Get a single content instance.
     #
     # ==== 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_product(slug, options = nil)
-      return @client.raw("get", "/ecommerce/products/#{slug}", options)
+    #
+    # ==== Example
+    #     @mints_pub.get_content_instance("bill-gates")
+    #
+    def get_content_instance(slug, options = nil)
+      return @client.raw("get", "/content/content-instances/#{slug}", options)
     end
 
     ##
-    # === Get Product Brands.
-    # Get a collection of product brands.
+    # === Get Content Pages.
+    # Get all content pages.
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    def get_product_brands(options = nil)
-      return @client.raw("get", "/ecommerce/product-brands", options)
+    def get_content_pages(options = nil)
+      return @client.raw("get", "/content/content-pages", options)
     end
 
     ##
-    # === Get Product Brand.
-    # Get a product brand.
+    # === Get Content Page.
+    # Get a single content page
     #
     # ==== Parameters
-    # * +slug+ - [String] It's the string identifier generated by Mints
+    # * +slug+ - [String] It's the slug 
     # * +options+ - [Hash] List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter
-    def get_product_brand(slug, options = nil)
-      return @client.raw("get", "/ecommerce/product-brands/#{slug}", options)
+    #
+    # ==== Example
+    #     @mints_pub.get_content_page("test-page")
+    #
+    def get_content_page(slug, options = nil)
+      return @client.raw("get", "/content/content-pages/#{slug}", options)
     end
 
     ##
-    # === Get SKUs.
-    # Get a collection of SKUs.
+    # === Get Locations.
+    # Get all locations.
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    def get_skus(options = nil)
-      return @client.raw("get", "/ecommerce/skus", options)
+    #
+    # ==== Example
+    #     @mints_pub.get_locations
+    #
+    def get_locations(options = nil)
+      return @client.raw("get", "/ecommerce/locations", options)
     end
 
     ##
-    # === Get SKU.
-    # Get a single SKU.
+    # === Get Products.
+    # Get a collection of products.
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     @mints_pub.get_products
+    #
+    def get_products(options = nil)
+      return @client.raw("get", "/ecommerce/products", options)
+    end
+
+    ##
+    # === Get Product.
+    # Get a single product.
     #
     # ==== 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_sku(slug, options = nil)
-      return @client.raw("get", "/ecommerce/skus/#{slug}", options)
+    #
+    # ==== Example
+    #     @mints_pub.get_product("batman-shirt")
+    #
+    def get_product(slug, options = nil)
+      return @client.raw("get", "/ecommerce/products/#{slug}", options)
     end
-    
+
     ##
     # === Get categories.
     # Get a collection of categories.
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     options = {
+    #       "object_type": "stories"
+    #     }
+    #     @mints_pub.get_categories(options)
     def get_categories(options = nil)
       return @client.raw("get", "/config/categories", options)
     end
@@ -261,6 +337,13 @@ 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
+    #
+    # ==== Example
+    #     options = {
+    #       "object_type": "locations"
+    #     }
+    #     @mints_pub.get_category("atm", options)
+    #
     def get_category(slug, options = nil)
       return @client.raw("get", "/config/categories/#{slug}", options)
     end
@@ -271,6 +354,10 @@ module Mints
     #
     # ==== Parameters
     # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     @mints_pub.get_tags
+    #
     def get_tags(options = nil)
       return @client.raw("get", "/config/tags", options)
     end
@@ -282,26 +369,24 @@ 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
+    #
+    # ==== Example
+    #     @mints_pub.get_tag("ad-0")
+    #
     def get_tag(slug, options = nil)
       return @client.raw("get", "/config/tags/#{slug}", options)
     end
 
-    ##
-    # === Get Attributes.
-    # Get a collection of attributes.
-    #
-    # ==== Parameters
-    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
-    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
+    #
+    # ==== Example
+    #     @mints_pub.get_taxonomies
+    #
     def get_taxonomies(options = nil)
       return @client.raw("get", "/config/taxonomies", options)
     end
@@ -313,8 +398,26 @@ 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
+    #
+    # ==== Example
+    #     @mints_pub.get_taxonomy("unit_pricing_measure")
+    #
     def get_taxonomy(slug, options = nil)
       return @client.raw("get", "/config/taxonomies/#{slug}", options)
     end
+
+    ##
+    # === Get Attributes.
+    # Get a collection of attributes.
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    #
+    # ==== Example
+    #     @mints_pub.get_attributes
+    #
+    def get_attributes(options = nil)
+      return @client.raw("get", "/config/attributes", options)
+    end
   end
 end

data/lib/user.rb

@@ -29,7 +29,7 @@ module Mints
   class User
     attr_reader :client
     def initialize(host, api_key, session_token = nil, debug = false)
-      @client = Mints::Client.new(host, api_key, 'user', session_token, debug)
+      @client = Mints::Client.new(host, api_key, 'user', session_token, nil, debug)
     end
 
     def login(email, password)
@@ -43,6 +43,31 @@ module Mints
       end
       return response
     end
+
+    def magic_link_login(token)
+      response = @client.raw("get", "/users/magic-link-login/#{token}", nil, nil, '/api/v1')
+      return response
+    end
+
+    ##
+    # === Send magic link to user
+    def send_magic_link(email, redirectUrl = '', lifeTime = 24)
+      data = {
+        email: email,
+        redirectUrl: redirectUrl,
+        lifeTime: lifeTime
+      }
+      response = @client.raw("post", "/users/magic-link", nil, { data: data }, '/api/v1')
+      return response
+    end
+
+    ##
+    # === Me.
+    # Get contact logged info
+    #
+    def me
+      return @client.get__profile__me
+    end
     ######################################### CRM #########################################
     ##
     # === Get contacts.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.17
 platform: ruby
 authors:
-- Ruben Gomez Garcia, Omar Mora, Luis Payan
+- Ruben Gomez Garcia, Omar Mora, Luis Payan, Oscar Castillo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,6 +120,7 @@ files:
 - README.md
 - lib/client.rb
 - lib/contact.rb
+- lib/generators/mints_assets_controller.rb
 - lib/generators/mints_config.yml.erb
 - lib/generators/mints_contact_controller.rb
 - lib/generators/mints_files_generator.rb