mints 0.0.16 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cce05094ead82499622fb1f66d7caa52848d7940c484917218563d32defa16
-  data.tar.gz: 88e34ca4adfe1f77097206463f6c24a6479b63f2cfdf92bf3106152c00b8dd5a
+  metadata.gz: 805f9ad3f355a55e73dfeea6ace38749e32fdb5eb8427f003bd520fcd04204e6
+  data.tar.gz: b5aeb908efaf757a6bb1acb32c57a0330cc597549acdc9b539a048aacf1e3211
 SHA512:
-  metadata.gz: fbd81e5fed7023a5b3d489c66bbcc1efa3304d2fe6a7492aef0f0c72f51ad98c2c77635377858e19df92d61fd5a1c26d7d7758d0fde57c223ee9c9968faf0337
-  data.tar.gz: 6f8672d582a57aa9f2128b73b6fb8133387ea604082557b146eadc321cd9fbcd55a9da4bbba4ac9541cfc3225edcc6826858f314b104abea0bf887bd87bc5a0c
+  metadata.gz: 1d98cb6dd69f6e9e1e56f67ad1a352e865f8b71fea0ce1c4d207a78959ff3a28cdbda7aed3058a0b57f3d26ab9bff459de1cc7256ebd2268046c166e2d9afa22
+  data.tar.gz: 6bef5686332e40cf0c838bb0a7a32db247841864c3ac79e31f5eb0bfd934d13abd2e4061be0fa006f74f7b3ac2302ee613401958789da3b99d79492329b467a6

data/lib/client.rb

@@ -11,16 +11,20 @@ module Mints
       attr_accessor :session_token
       attr_accessor :contact_token_id
 
-      def initialize(host, api_key, scope = nil, session_token = nil, contact_token_id = nil, debug = false)
+      def initialize(host, api_key, scope = nil, session_token = nil, contact_token_id = nil, visit_id = nil, debug = false)
           @host = host
           @api_key = api_key
           @session_token = session_token
           @contact_token_id = contact_token_id
+          @visit_id = visit_id
           @debug = debug
           self.set_scope(scope)
       end
 
-      def raw(action, url, options = nil, data = nil, base_url = nil)
+      def raw(action, url, options = nil, data = nil, base_url = nil, compatibility_options = {}, only_tracking = false)
+        if compatibility_options === nil
+          compatibility_options = {}
+        end
         base_url = @base_url if !base_url
         uri = ""
         if (options && options.class == Hash)
@@ -51,8 +55,18 @@ module Mints
                     if @redis_server.get(full_url)
                       response = @redis_server.get(full_url)
                       result_from_cache = true
-                    else 
-                      response = self.send("#{@scope}_#{action}", "#{full_url}")
+
+                      headers = nil
+                      if only_tracking
+                        headers = {"Only-Tracking" => "true"}
+                      end
+                      #when is already in redis notify to California to register the object usage
+                      cali_response = self.send("#{@scope}_#{action}", "#{full_url}", headers, compatibility_options)
+                      if @debug
+                        puts "CALI RESPONSE: #{cali_response}"
+                      end
+                    else
+                      response = self.send("#{@scope}_#{action}", "#{full_url}", nil, compatibility_options)
                       @redis_server.setex(full_url,time,response)
                     end
                     break
@@ -63,15 +77,18 @@ module Mints
           end
 
           if !url_need_cache
-            response = self.send("#{@scope}_#{action}", "#{full_url}")
+            response = self.send("#{@scope}_#{action}", "#{full_url}", nil, compatibility_options)
           end
 
         elsif action === 'create' or action === 'post'
           action = 'post'
-          response = self.send("#{@scope}_#{action}", "#{full_url}", data)          
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data, compatibility_options)          
         elsif action === 'put' or action === 'patch' or action ==='update'
           action = 'put'
-          response = self.send("#{@scope}_#{action}", "#{full_url}", data)
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data, compatibility_options)
+        elsif action === 'delete' or action === 'destroy'
+          action = 'delete'
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data, compatibility_options)
         end
         if result_from_cache
           return parsed_response = JSON.parse(response)
@@ -85,7 +102,6 @@ module Mints
       end
   
       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)
@@ -93,7 +109,7 @@ module Mints
         name_len = name_spplited.size
         # the action always be the first element
         action = name_spplited.first
-        raise 'NoActionError' unless ['get', 'create', 'post', 'update', 'put'].include?(action)
+        raise 'NoActionError' unless ['get', 'create', 'post', 'update', 'put', 'delete', 'destroy'].include?(action)
         # the object always be the last element
         object = separator == "__" ? name_spplited.last.gsub("_","-") : name_spplited.last
         # get intermediate url elements
@@ -121,7 +137,7 @@ module Mints
             uri.query_values = args[1]
           end
           url = self.get_url(route, object, uri, slug)
-          response = self.send("#{@scope}_#{action}", url)
+          response = self.send("#{@scope}_#{action}", url, nil, compatibility_options)
         elsif action == "post" or action == "create"
           if args[1].class == Hash
             uri.query_values = args[1]
@@ -129,7 +145,7 @@ module Mints
           url = self.get_url(route, object, uri, slug)
           action = 'post'
           data = args[0]
-          response = self.send("#{@scope}_#{action}", url, {data: data})
+          response = self.send("#{@scope}_#{action}", url, {data: data}, compatibility_options)
         elsif action == "put" or action == "update"
            if args.first.class == String or Integer
             slug = args.first
@@ -139,7 +155,7 @@ module Mints
           action = 'put'
           id = args[0]
           data = args[1]
-          response = self.send("#{@scope}_#{action}", "#{url}", {data: data})
+          response = self.send("#{@scope}_#{action}", "#{url}", {data: data}, compatibility_options)
         end
 
         if response.response.code == "404"
@@ -188,6 +204,7 @@ module Mints
           puts url
           puts "Headers:"
           puts headers
+          puts "Method: get"
         end
         return headers ? HTTParty.get(url, :headers => headers) : HTTParty.get(url)
       end    
@@ -201,6 +218,7 @@ module Mints
           puts headers
           puts "Data:"
           puts data
+          puts "Method: post"
         end
         return headers ? HTTParty.post(url, :headers=> headers, :body => data) : HTTParty.post(url, :body => data)  
       end
@@ -214,78 +232,119 @@ module Mints
           puts headers
           puts "Data:"
           puts data
+          puts "Method: put"
         end
         return headers ? HTTParty.put(url, :headers=> headers, :body => data) : HTTParty.put(url, :body => data)
       end
 
+      # Simple HTTP DELETE
+      def http_delete(url, headers = nil, data = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+          puts "Data:"
+          puts data
+          puts "Method: delete"
+        end
+        return headers ? HTTParty.delete(url, :headers=> headers, :body => data) : HTTParty.delete(url, :body => data)  
+      end
+
       # Start contact context
-      def contact_get(url)
-        headers = {
+      def contact_get(url, headers = nil, compatibility_options)
+        h = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
           "ContactToken" => @contact_token_id
         }
-        headers["Authorization"] = "Bearer #{@session_token}" if @session_token
-        return self.http_get(url, headers)
+        h["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
+        h["Authorization"] = "Bearer #{@session_token}" if @session_token
+        if headers
+          headers.each do |k,v|
+            h[k] = v
+          end
+        end
+        return self.http_get(url, h)
       end
 
-      def contact_post(url, data)
+      def contact_post(url, data, compatibility_options)
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
           "ContactToken" => @contact_token_id
         }
+        headers["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_post(url, headers, data)
       end
 
-      def contact_put(url, data)
+      def contact_put(url, data, compatibility_options)
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
           "ContactToken" => @contact_token_id
         }
+        headers["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         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
-      def user_get(url)
-        headers = {
-          "ApiKey" => @api_key,
-          "Accept" => "application/json"
+      def user_get(url, headers = nil, compatibility_options)
+        h = {
+          "Accept" => "application/json",
+          "ApiKey" => @api_key
         }
-        headers["Authorization"] = "Bearer #{@session_token}" if @session_token
-        return self.http_get(url, headers)
+        h["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
+        h["Authorization"] = "Bearer #{@session_token}" if @session_token
+        if headers
+          headers.each do |k,v|
+            h[k] = v
+          end
+        end
+        return self.http_get(url, h)
       end
 
-      def user_post(url, data)
+      def user_post(url, data, compatibility_options)
         headers = {
-          "ApiKey" => @api_key,
-          "Accept" => "application/json"
+          "Accept" => "application/json",
+          "ApiKey" => @api_key
         }
+        headers["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_post(url, headers, data)
       end
 
-      def user_put(url, data)
+      def user_put(url, data, compatibility_options)
         headers = {
-          "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "Content-Type" => "application/json"
+          "ApiKey" => @api_key
         }
+        headers["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_put(url, headers, data)
       end
+
+      def user_delete(url, data, compatibility_options)
+        headers = {
+          "Accept" => "application/json",
+          "ApiKey" => @api_key
+        }
+        headers["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
+        headers["Authorization"] = "Bearer #{@session_token}" if @session_token
+        return self.http_delete(url, headers, data)
+      end
       # End User Context
       
-      def public_get(url, headers = nil)
+      def public_get(url, headers = nil, compatibility_options)
         h = {
           "Accept" => "application/json",
-          "Content-Type" => "application/json",
           "ApiKey" => @api_key
         }
+        h["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         h["ContactToken"] = @contact_token_id if @contact_token_id
+        h["Visit-Id"] = @visit_id if @visit_id
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -294,12 +353,12 @@ module Mints
         self.http_get(url, h)
       end
 
-      def public_post(url, headers = nil, data)
+      def public_post(url, headers = nil, data, compatibility_options)
         h = {
           "Accept" => "application/json",
-          "Content-Type" => "application/json",
           "ApiKey" => @api_key
         }
+        h["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         h["ContactToken"] = @session_token if @session_token
         if headers
           headers.each do |k,v|
@@ -309,12 +368,12 @@ module Mints
         self.http_post(url, h, data)
       end
 
-      def public_put(url, headers = nil, data)
+      def public_put(url, headers = nil, data, compatibility_options)
         h = {
-          "Accept" => "application/json", 
-          "Content-Type" => "application/json", 
+          "Accept" => "application/json",
           "ApiKey" => @api_key
         }
+        h["Content-Type"] = "application/json" unless compatibility_options['no_content_type']
         h["ContactToken"] = @contact_token_id if @contact_token_id
         if headers
           headers.each do |k,v|

data/lib/contact.rb

@@ -1,4 +1,5 @@
 require_relative "./client.rb"
+require_relative "./mints_helper.rb"
 include ActionController::Cookies
 module Mints
   class Contact
@@ -7,20 +8,33 @@ module Mints
     # === Initialize.
     # Class constructor
     #
+    # ==== Parameters
+    # host:: (String) -- It's the visitor IP.
+    # api_key:: (String) -- Mints instance api key.
+    # contact_token_id:: (Integer) --  Cookie 'mints_contact_id' value (mints_contact_token).
+    #
+    # ==== Return
+    # Returns a Contact object
     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)
+      @client = Mints::Client.new(host, api_key, "contact", session_token, contact_token_id, nil, debug)
     end
 
     ##
     # === Login.
-    # Starts a contact session
+    # Starts a contact session.
+    #
+    # ==== Parameters:
+    # email:: (String) -- The email that will be logged.
+    # password:: (String) -- The password of the email.
     #
+    # ==== Example
+    #     @mints_contact.login("email@example.com", "password")
     def login(email, password)
       data = {
         email: email,
         password: password
       }
-      response = @client.raw("post", "/contacts/login", nil, {data: data})
+      response = @client.raw("post", "/contacts/login", nil, {data: data}.to_json)
       if response.key? "session_token"
         @client.session_token = response["session_token"]
       end
@@ -29,8 +43,15 @@ module Mints
 
     ##
     # === Magic Link Login.
-    # Starts a contact session
+    # 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 token that will be used to log in.
     #
+    # ==== 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"
@@ -40,7 +61,21 @@ module Mints
     end
 
     ##
-    # === Send magic link to contact
+    # === 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("email@example.com", "template_slug")
+    #
+    # ==== Second Example
+    #     @mints_contact.send_magic_link("email@example.com", "template_slug", "", 1440, 3)
     def send_magic_link(email, template_slug, redirectUrl = '', lifeTime = 1440, maxVisits = nil)
       data = {
         email: email,
@@ -49,14 +84,17 @@ module Mints
         redirectUrl: redirectUrl,
         templateId: template_slug
       }
-      response = @client.raw("post", "/contacts/magic-link", nil, { data: data }, '/api/v1')
+      response = @client.raw("post", "/contacts/magic-link", nil, { data: data }.to_json, '/api/v1')
       return response
     end
 
     ##
     # === Logout.
-    # Ends a contact session
+    # Ends a contact session previously logged.
     #
+    # ==== Example
+    #     @mints_contact.login("email@example.com", "password")
+    #     @mints_contact.logout
     def logout
       response = @client.raw("post", "/contacts/logout") if session_token?
       if response["success"]
@@ -67,62 +105,127 @@ module Mints
 
     ##
     # === Change Password.
-    # Change password
+    # Change password without email. To change the password a contact must be logged.
+    #
+    # ==== Parameters:
+    # data:: (Hash) -- A new password allocated in a data key.
     #
+    # ==== Example
+    #     @mints_contact.login("email@example.com", "password")
+    #     data = { "password": "123456" }
+    #     @data = @mints_contact.change_password(data)
     def change_password(data)
-      return @client.raw("post", "/contacts/change-password", nil, data)
+      return @client.raw("post", "/contacts/change-password", nil, data_transform(data))
     end
 
     ##
     # === 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:: (Hash) -- It's a data key where will be hosted the destination email.
+    #
+    # ==== Example
+    #     data = { "email": "email@example.com" }
+    #     @mints_contact.recover_password(data)
     def recover_password(data)
-      return @client.raw("post", "/contacts/recover-password", nil, data)
+      return @client.raw("post", "/contacts/recover-password", nil, data_transform(data))
     end
 
     ##
     # === Reset Password.
-    # Reset password
+    # Reset password using a token. The token is obtained by recover_password method.
+    #
+    # ==== Parameters:
+    # data:: (Hash) -- It's a set of data which contains all the information to reset a contact password.
     #
+    # ==== Example
+    #     data = { 
+    #       "email": "email@example.com", 
+    #       "password": "password", 
+    #       "password_confirmation": "password", 
+    #       "token": "644aa3aa0831d782cc42e42b11aedea9a2234389af4f429a8d96651295ecfa09" 
+    #     }
+    #     @mints_contact.reset_password(data)
     def reset_password(data)
-      return @client.raw("post", "/contacts/reset-password", nil, data)
+      return @client.raw("post", "/contacts/reset-password", nil, data_transform(data))
     end
 
     ##
     # === OAuth Login.
-    # Login a contact using oauth
-    #
+    # Login a contact using oauth.
     def oauth_login(data)
       return @client.raw("post", "/contacts/oauth-login", nil, data)
     end
 
     ##
     # === Me.
-    # Get contact logged info
+    # Get contact logged info.
+    #
+    # ==== First Example
+    #     @mints_contact.me
     #
-    def me
-      return @client.raw("get", "/contacts/me")
+    # ==== Second Example
+    #     options = { 
+    #       "attributes": true,
+    #       "taxonomies": true
+    #     } 
+    #     @data = @mints_contact.me(options)
+    def me(options = nil)
+      return @client.raw("get", "/contacts/me", options)
     end
 
     ##
     # === Status.
-    # Get contact logged status
+    # Get contact logged status.
     #
+    # ==== Example
+    #     @mints_contact.status
     def status
       return @client.raw("get", "/contacts/status")
     end
 
     ##
     # === Update.
-    # Update logged contact attributes
+    # Update logged contact attributes.
+    #
+    # ==== Parameters:
+    # data:: (Hash) -- It's the data to update with a session active.
     #
+    # ==== Example
+    #     @mints_contact.login("email@example.com", "password")
+    #     data = {
+    #       "given_name": "Given Name", 
+    #       "last_name": "Last Name"
+    #     }
+    #     @mints_contact.update(data)
     def update(data)
-      return @client.raw("put", "/contacts/update", nil, data)
+      return @client.raw("put", "/contacts/update", nil, data_transform(data))
+    end
+
+    ##
+    # === Register.
+    # Register a contact.
+    #
+    # ==== Parameters:
+    # data:: (Hash) -- It's the register data.
+    #
+    # ==== Example
+    #     data = {
+    #       "email": "email@example.com",
+    #       "given_name": "Given Name",
+    #       "last_name": "Last Name",
+    #       "password": "password"
+    #     }
+    #     @mints_contact.register(data);
+    def register(data)
+      return @client.raw("post", "/contacts/register", nil, data_transform(data))
     end
 
     private
 
+    include MintsHelper
+
     def session_token?
       if @client.session_token
         return true

data/lib/mints/controllers/admin_base_controller.rb

@@ -22,7 +22,7 @@ module Mints
         # 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
+        cookies[:mints_user_session_token] = { value: session_token, secure: true, httponly: true, expires: 1.day }
     end
 
     ##
@@ -33,7 +33,7 @@ module 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 }
+        cookies[:mints_user_session_token] = { value: response['data']['api_token'], expires: 1.day, secure: true, httponly: true }
         redirect_to response['data']['redirect_url']
       else
         redirect_to '/'

data/lib/mints/controllers/base_api_controller.rb

@@ -10,26 +10,26 @@ module Mints
         response = @mints_contact.login(email, password)
         # Get session token from response
         session_token = response['session_token']
-        id_token = response['contact']['id_token']
+        id_token = response['contact']['contact_token'] ? response['contact']['contact_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
+        cookies.permanent[:mints_contact_session_token] = { value: session_token, secure: true, httponly: true }
+        cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }
         @contact_token = id_token
       end
       
     ##
-    # === Mints cotnact Login.
-    # Starts a cotnact session in mints.cloud and set a session cookie
+    # === Mints contact Login.
+    # Starts a contact 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']
+        id_token = response['data']['contact']['contact_token'] ? response['data']['contact']['contact_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
+        cookies.permanent[:mints_contact_session_token] = { value: session_token, secure: true, httponly: true }
+        cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }
         @contact_token = id_token
         redirect_to response['data']['redirect_url'] ? response['data']['redirect_url'] : '/'
       else
@@ -58,7 +58,7 @@ module Mints
       # 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
+      cookies[:mints_user_session_token] = { value: session_token, secure: true, httponly: true, expires: 1.day }
     end
 
     ##
@@ -69,7 +69,7 @@ module 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 }
+        cookies[:mints_user_session_token] = { value: response['data']['api_token'], secure: true, httponly: true,  expires: 1.day }
         redirect_to response['data']['redirect_url'] ? response['data']['redirect_url'] : '/'
       else
         redirect_to '/'
@@ -116,7 +116,8 @@ module Mints
     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)
+      @visit_id = cookies[:mints_visit_id] ? cookies[:mints_visit_id] : nil
+      @mints_pub = Mints::Pub.new(@host, @api_key, nil, @visit_id, @debug)
       # Set contact token from cookie
       @mints_pub.client.session_token = @contact_token
     end