mints 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cce05094ead82499622fb1f66d7caa52848d7940c484917218563d32defa16
-  data.tar.gz: 88e34ca4adfe1f77097206463f6c24a6479b63f2cfdf92bf3106152c00b8dd5a
+  metadata.gz: 5f269f998c9cc9cb3dc69f3ec70cc2ff4522a97c14a9da0bfb6ca4cba40b0654
+  data.tar.gz: e6b867ce7e3623b05c7aad402462f09b0b1a71a3750549c669407bcff6d2aa2b
 SHA512:
-  metadata.gz: fbd81e5fed7023a5b3d489c66bbcc1efa3304d2fe6a7492aef0f0c72f51ad98c2c77635377858e19df92d61fd5a1c26d7d7758d0fde57c223ee9c9968faf0337
-  data.tar.gz: 6f8672d582a57aa9f2128b73b6fb8133387ea604082557b146eadc321cd9fbcd55a9da4bbba4ac9541cfc3225edcc6826858f314b104abea0bf887bd87bc5a0c
+  metadata.gz: 1128997e3df23340e780e4dcc9bb84389df6062eaae3683dff653b440887a5c4d04059141e8472e3762c3ce856df795c26ef7e376c72c38e494880aef5ab830b
+  data.tar.gz: '09b6774bb218dc40cd0083fc54428225999736f5452911c7b482a22b928d41dea91fe343ecbab96543be6c602393f6f13aaa9d9d1ee489b8e4a697bf61eda20f'

data/lib/client.rb

@@ -246,7 +246,7 @@ module Mints
           "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

data/lib/contact.rb

@@ -15,6 +15,13 @@ module Mints
     # === 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,
@@ -29,7 +36,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 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')
@@ -40,7 +55,22 @@ 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("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,
@@ -55,7 +85,11 @@ module Mints
 
     ##
     # === 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?
@@ -67,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)
@@ -75,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)
@@ -83,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)
@@ -99,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")
@@ -107,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")
@@ -115,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/mints/controllers/base_controller.rb

@@ -84,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

data/lib/pub.rb

@@ -94,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,
@@ -111,6 +120,10 @@ 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
@@ -121,6 +134,10 @@ module Mints
     #
     # ==== Parameters
     # * +slug+ - [String] It's the string identifier of the asset.
+    #
+    # ==== Example
+    #     @mints_pub.get_asset_info("quaerat")
+    #
     def get_asset_info(slug)
       return @client.raw("get", "/content/asset-info/#{slug}")
     end
@@ -131,6 +148,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_stories
+    #
     def get_stories(options = nil)
       return @client.raw("get", "/content/stories", options)
     end
@@ -142,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
@@ -152,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
@@ -163,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
@@ -173,13 +206,24 @@ 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    
 
     ##
     # === Get Content Instances.
-    # Get a collection of 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
@@ -194,6 +238,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_content_instance("bill-gates")
+    #
     def get_content_instance(slug, options = nil)
       return @client.raw("get", "/content/content-instances/#{slug}", options)
     end
@@ -215,6 +263,10 @@ module Mints
     # ==== 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
+    #
+    # ==== 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
@@ -225,6 +277,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_locations
+    #
     def get_locations(options = nil)
       return @client.raw("get", "/ecommerce/locations", options)
     end
@@ -235,6 +291,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_products
+    #
     def get_products(options = nil)
       return @client.raw("get", "/ecommerce/products", options)
     end
@@ -246,6 +306,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_product("batman-shirt")
+    #
     def get_product(slug, options = nil)
       return @client.raw("get", "/ecommerce/products/#{slug}", options)
     end
@@ -256,6 +320,12 @@ 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
+    #     options = {
+    #       "object_type": "stories"
+    #     }
+    #     @mints_pub.get_categories(options)
     def get_categories(options = nil)
       return @client.raw("get", "/config/categories", options)
     end
@@ -267,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
@@ -277,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
@@ -288,6 +369,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_tag("ad-0")
+    #
     def get_tag(slug, options = nil)
       return @client.raw("get", "/config/tags/#{slug}", options)
     end
@@ -298,6 +383,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_taxonomies
+    #
     def get_taxonomies(options = nil)
       return @client.raw("get", "/config/taxonomies", options)
     end
@@ -309,6 +398,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_taxonomy("unit_pricing_measure")
+    #
     def get_taxonomy(slug, options = nil)
       return @client.raw("get", "/config/taxonomies/#{slug}", options)
     end
@@ -319,6 +412,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_attributes
+    #
     def get_attributes(options = nil)
       return @client.raw("get", "/config/attributes", options)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  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-07-19 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json