mints 0.0.14 → 0.0.18

data/lib/mints/controllers/base_controller.rb

@@ -24,13 +24,28 @@ 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']
         # 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 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']['contact_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 }
+      @contact_token = id_token
+  end
+
     ##
     # === Mints Contact Logout.
     # Destroy session from mints.cloud and delete local session cookie
@@ -49,10 +64,25 @@ module Mints
     # === Register visit.
     # Call register visit method from the public client and set/renew the cookie mints_contact_id
     def register_visit
+      if @debug
+        puts "REQUEST IN REGISTER VISIT: #{request}"
+        puts "BODY REQUEST: #{request.body}"
+        puts "AUTH REQUEST: #{request.authorization}"
+        puts "LENGTH REQUEST: #{request.content_length}"
+        puts "FORM DATA REQUEST: #{request.form_data?}"
+        puts "FULLPATH REQUEST: #{request.fullpath}"
+        puts "HEADERS REQUEST: #{request.headers}"
+        puts "IP REQUEST: #{request.ip}"
+        puts "REQUEST IP ADRESS: #{request['ip_address']}"
+        puts "REQUEST REMOTE IP: #{request['remote_ip']}"
+      end
       response = @mints_pub.register_visit(request)
-      @contact_token = response['user_token']
+      if @debug
+        puts "RESPONSE IN REGISTER VISIT: #{response}"
+      end
+      @contact_token = response['contact_token']
       @visit_id = response['visit_id']
-      cookies.permanent[:mints_contact_id] = @contact_token
+      cookies.permanent[:mints_contact_id] = { value: @contact_token, secure: true, httponly: true }
     end
 
     ##
@@ -69,7 +99,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 +116,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
 
@@ -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