mints 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cff6a549992ee75536a6696575ef58435328068adcbdd3658fc6633ec0e4fd5
-  data.tar.gz: c2fc848075d8156ba44aadc01c45b0d01c6eeaf5a7a21201d38b51e99ad86d54
+  metadata.gz: eb39e61077ebde851f278b96e82be85962bdacd093158d179cc5107bf3a4c5b2
+  data.tar.gz: f5d84797fc4526b3f8c2164d79062b0035db452c0a3a62d02967e33f1649a78b
 SHA512:
-  metadata.gz: e865b46eb2536dd6f14ad39d0ebe691ec2db0cf98bd3c1861223dd3e9462deb555eee92d3ece5da498cbd4655dc6443774e6ca1ea94c0225f5a8db1977a7b237
-  data.tar.gz: f5203d5ba1b426812abd7f281146c84b58c2761e1be388b0ed004bd74ccd98000964615787d127a275848978fc029f444db2f8647f6a924df918814cf3f3c856
+  metadata.gz: 8c902cadde2d3951e9aecf9e6a81f86f7af47224071a14ff0ea9b72fc4f2607f2c60729d2ce4843dbdf0d9e582135fba51cf84b37ed6d6908227e5438a217e4a
+  data.tar.gz: faed4589390dbe456f973212e9e2deaa759082f2ed02c6aedfea493147b80d3935261a50ce6d9d41b77a2e5b9fd2e9ef456b19e80914118f8e5c49d9a94b3684

data/lib/client.rb

@@ -20,8 +20,8 @@ module Mints
           self.set_scope(scope)
       end
 
-      def raw(action, url, options = nil, data = nil, base_url = nil)
-        base_url = @base_url if !base_url
+      def raw(action, url, options = nil, data = nil, base_url = nil, compatibility_options = {})
+      base_url = @base_url if !base_url
         uri = ""
         if (options && options.class == Hash)
           if (options[:jfilters] && options[:jfilters].class == Hash)
@@ -52,7 +52,7 @@ module Mints
                       response = @redis_server.get(full_url)
                       result_from_cache = true
                     else 
-                      response = self.send("#{@scope}_#{action}", "#{full_url}")
+                      response = self.send("#{@scope}_#{action}", "#{full_url}", compatibility_options)
                       @redis_server.setex(full_url,time,response)
                     end
                     break
@@ -63,18 +63,18 @@ module Mints
           end
 
           if !url_need_cache
-            response = self.send("#{@scope}_#{action}", "#{full_url}")
+            response = self.send("#{@scope}_#{action}", "#{full_url}", 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)
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data, compatibility_options)
         end
         if result_from_cache
           return parsed_response = JSON.parse(response)
@@ -124,7 +124,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, compatibility_options)
         elsif action == "post" or action == "create"
           if args[1].class == Hash
             uri.query_values = args[1]
@@ -132,7 +132,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
@@ -142,7 +142,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"
@@ -239,81 +239,87 @@ module Mints
       end
 
       # Start contact context
-      def contact_get(url)
+      def contact_get(url, 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_get(url, headers)
       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_put(url, headers, data)
       end
 
       # Start User context
-      def user_get(url)
+      def user_get(url, 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_get(url, headers)
       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)
+      def user_delete(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_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
         if headers
           headers.each do |k,v|
@@ -323,12 +329,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|
@@ -338,12 +344,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,27 +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)
     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.
+    # email:: (String) -- The email that will be logged.
+    # password:: (String) -- The password of the email.
     #
     # ==== Example
-    #     @mints_contact.login("brown.abigail@dubuque.com", "helloword")
-    #
+    #     @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
@@ -39,13 +46,12 @@ module Mints
     # 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.
+    # 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"
@@ -59,18 +65,17 @@ module Mints
     # 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. 
+    # 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", "")
+    #     @mints_contact.send_magic_link("email@example.com", "template_slug")
     #
     # ==== Second Example
-    #     @mints_contact.send_magic_link("brown.abigail@dubuque.com", "", "", 1440, 3)
-    #
+    #     @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,
@@ -79,7 +84,7 @@ 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
 
@@ -88,9 +93,8 @@ module Mints
     # Ends a contact session previously logged.
     #
     # ==== Example
-    #     @mints_contact.login('brown.abigail@dubuque.com', 'helloword')
+    #     @mints_contact.login("email@example.com", "password")
     #     @mints_contact.logout
-    #
     def logout
       response = @client.raw("post", "/contacts/logout") if session_token?
       if response["success"]
@@ -104,15 +108,14 @@ module Mints
     # Change password without email. To change the password a contact must be logged.
     #
     # ==== Parameters:
-    # * +data+ - [] A new password allocated in a data key.
+    # data:: (Hash) -- 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)
-    #
+    #     @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
 
     ##
@@ -120,14 +123,13 @@ module Mints
     # 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. 
+    # data:: (Hash) -- It's a data key where will be hosted the destination email.
     #
     # ==== Example
-    #     data = { "data": { "email": "brown.abigail@dubuque.com" } }
+    #     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
 
     ##
@@ -135,25 +137,23 @@ module Mints
     # 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.
+    # data:: (Hash) -- 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", 
+    #     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
@@ -162,11 +162,17 @@ module Mints
     # === Me.
     # Get contact logged info.
     #
-    # ==== Example
+    # ==== 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
 
     ##
@@ -175,7 +181,6 @@ module Mints
     #
     # ==== Example
     #     @mints_contact.status
-    #
     def status
       return @client.raw("get", "/contacts/status")
     end
@@ -185,18 +190,17 @@ module Mints
     # Update logged contact attributes.
     #
     # ==== Parameters:
-    # * +data+ - [] It's the data to update with a session active.
+    # data:: (Hash) -- 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.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
 
     ##
@@ -204,23 +208,24 @@ module Mints
     # Register a contact.
     #
     # ==== Parameters:
-    # * +data+ - [] It's the register data.
+    # data:: (Hash) -- It's the register data.
     #
     # ==== Example
-    #     data = { "data": {
-    #       "email": "carlos@mints.cloud",
-    #       "given_name": "Carlos",
-    #       "last_name": "Fernandez",
-    #       "password": "123456"
-    #     } }
+    #     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)
+      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/base_api_controller.rb

@@ -10,7 +10,7 @@ module Mints
         response = @mints_contact.login(email, password)
         # Get session token from response
         session_token = response['session_token']
-        id_token = response['contact']['contact_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] = { value: session_token, secure: true, httponly: true }
         cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }
@@ -18,15 +18,15 @@ module Mints
       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']['contact_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] = { value: session_token, secure: true, httponly: true }
         cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }

data/lib/mints/controllers/base_controller.rb

@@ -24,7 +24,7 @@ module Mints
         response = @mints_contact.login(email, password)
         # Get session token from response
         session_token = response['session_token']
-        id_token = response['contact']['contact_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] = { value: session_token, secure: true, httponly: true }
         cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }
@@ -39,7 +39,7 @@ module Mints
       response = @mints_contact.login(email, password)
       # Get session token from response
       session_token = response['session_token']
-      id_token = response['contact']['contact_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] = { value: session_token, secure: true, httponly: true }
       cookies.permanent[:mints_contact_id] = { value: id_token, secure: true, httponly: true }
@@ -80,7 +80,7 @@ module Mints
       if @debug
         puts "RESPONSE IN REGISTER VISIT: #{response}"
       end
-      @contact_token = response['contact_token']
+      @contact_token = response['contact_token'] ? response['contact_token'] : response['user_token']
       @visit_id = response['visit_id']
       cookies.permanent[:mints_contact_id] = { value: @contact_token, secure: true, httponly: true }
     end
@@ -115,6 +115,15 @@ module Mints
     # === Set mints contact client.
     # Initialize the public client and set the contact token
     def set_mints_contact_client
+      if File.exists?("#{Rails.root}/mints_config.yml.erb")
+        template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+        config = YAML.load template.result(binding)
+        @host = config["mints"]["host"]
+        @api_key = config["mints"]["api_key"]
+        @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
+      else
+        raise 'MintsBadCredentialsError'
+      end
       # Initialize mints 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

data/lib/mints_helper.rb

@@ -0,0 +1,47 @@
+
+module MintsHelper
+    # === Get query results.
+    # Method used to give the options to make a 'post' or 'get' request.
+    #
+    # ==== Parameters
+    # url:: (String) -- Url to make the request.
+    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter.
+    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+    #
+    def get_query_results(url, options = nil, use_post = true)
+        if use_post
+        return @client.raw("post", "#{url}/query", options)
+        else
+        return @client.raw("get", url, options)
+        end
+    end
+
+    # === Data transform.
+    # Transform a 'data' variable to a standardized 'data' variable.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    def data_transform(data)
+        data = correct_json(data)
+        unless data[:data]
+            data = {data: data}
+        end
+        return data.to_json
+    end
+
+    # === Correct json.
+    # Receives a json data and convert it to a symbolized object.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    def correct_json(data)
+        if data.is_a? String
+            data = JSON.parse(data)
+        end
+        data = data.symbolize_keys
+        return data
+    end
+
+end