mints 0.0.20 → 0.0.21

data/lib/generators/mints_files_generator.rb

@@ -7,6 +7,8 @@ class MintsFilesGenerator < Rails::Generators::Base
       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'
+      copy_file 'short_link_controller.rb', './app/controllers/short_link_controller.rb'
+      copy_file 'mints_link.rb', './config/initializers/mints_link.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]
@@ -18,6 +20,10 @@ class MintsFilesGenerator < Rails::Generators::Base
             match '/*path' => 'mints_public#index', via: [:get, :post, :put, :patch, :delete]
           end
         end
+        # Mints short link
+        get '/sl/visits', to: 'short_link#visits'
+        post '/sl/generate', to: 'short_link#generate'
+        get '/sl/:code', to: 'short_link#redirect'
       eos
     end
 end

data/lib/generators/mints_link.rb

@@ -0,0 +1,61 @@
+class MintsLink
+  def initialize
+    @host = ENV['MONGO_HOST'] || '127.0.0.1'
+    @database = ENV['MONGO_DATABASE'] || 'mints'
+    @port = ENV['MONGO_PORT'] || '27017'
+    @client = Mongo::Client.new([ "#{@host}:#{@port}" ], :database => @database)
+    @short_links = @client[:short_links]
+    @sl_visits = @client[:sl_visits]
+    generate_indexes
+  end
+
+  def generate(url)
+    code = random_string.upcase
+    collection = @short_links
+    doc = {
+      url: url,
+      code: code
+    }
+
+    result = collection.insert_one(doc)
+    if result.n === 1
+      code
+    else
+      false
+    end
+  end
+
+  def get_url(code)
+    collection = @short_links
+    record = collection.find( { 'code' => code } ).first
+    record["url"]
+  end
+
+  def visit(code, url, contact_id, user_agent, ip)
+    collection = @sl_visits
+    doc = {
+      code: code,
+      url: url,
+      contact_id: contact_id,
+      user_agent: user_agent,
+      ip: ip
+    }
+    result = collection.insert_one(doc)
+    result.n === 1
+  end
+
+  def get_visits(filter, page = 1, pageSize = 1000)
+    collection = @sl_visits
+    collection.find(filter).sort( {_id: 1}).skip(page * pageSize - pageSize).limit(pageSize)
+  end
+
+  private
+  def random_string(length = 6)
+    rand(32**length).to_s(32)
+  end
+
+  def generate_indexes
+    collection = @short_links
+    collection.indexes.create_one({ code: 1 }, {unique: true })
+  end
+end

data/lib/generators/short_link_controller.rb

@@ -0,0 +1,41 @@
+class ShortLinkController < Mints::BaseController
+  skip_before_action :verify_authenticity_token
+  def redirect
+    code = params[:code]
+    mints_link = MintsLink.new
+    url = mints_link.get_url(code)
+    contact_id = cookies[:mints_contact_id]
+    user_agent = request.user_agent
+    ip = request.remote_ip
+    mints_link.visit(code, url, contact_id, user_agent, ip)
+    redirect_to url
+  end
+
+  def generate
+    url = params[:url]
+    if url =~ /(https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|www\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9]+\.[^\s]{2,}|www\.[a-zA-Z0-9]+\.[^\s]{2,})/
+      mints_link = MintsLink.new
+      code = mints_link.generate(url)
+      render json: { code: code }
+    else
+      render json: false
+    end
+  end
+
+  def visits
+    code = params[:code]
+    contact_id = params[:contact_id]
+    page = params[:page] ? params[:page].to_i : 1
+    page_size = params[:page_size] ? params[:page_size].to_i : 1000
+    filter = {}
+    if code
+      filter['code'] = code
+    end
+    if contact_id
+      filter['contact_id'] = contact_id
+    end
+    mints_link = MintsLink.new
+    visits = mints_link.get_visits(filter, page, page_size)
+    render json: { data: {visits: visits }}
+  end
+end

data/lib/mints_helper.rb

@@ -10,9 +10,9 @@ module MintsHelper
     #
     def get_query_results(url, options = nil, use_post = true)
         if use_post
-        return @client.raw("post", "#{url}/query", options)
+            return @client.raw("post", "#{url}/query", options)
         else
-        return @client.raw("get", url, options)
+            return @client.raw("get", url, options)
         end
     end
 

data/lib/pub.rb

@@ -103,7 +103,7 @@ module Mints
     #       "user_agent" => "User Agent",
     #       "fullpath" => "https://fullpath/example"
     #     }
-    #     @mints_pub.register_visit(request, request["remote_ip"], request["user_agent"], request["fullpath"])
+    #     @data = @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,
@@ -123,11 +123,13 @@ module Mints
     # time:: (Integer) -- The visitor's browser user agent.
     #
     # ==== Example
-    #     @mints_pub.register_visit_timer("60da2325d29acc7e55684472", 4)
+    #     @data = @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
 
+    ### V1/CONTENT ###
+
     ##
     # === Get Asset Info.
     # Get a description of an Asset.
@@ -136,22 +138,35 @@ module Mints
     # slug:: (String) -- It's the string identifier of the asset.
     #
     # ==== Example
-    #     @mints_pub.get_asset_info("asset_slug")
+    #     @data = @mints_pub.get_asset_info("asset_slug")
     def get_asset_info(slug)
       return @client.raw("get", "/content/asset-info/#{slug}")
     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.
+    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
     #
-    # ==== Example
-    #     @mints_pub.get_stories
-    def get_stories(options = nil)
-      return @client.raw("get", "/content/stories", options)
+    # ==== First Example
+    #     @data = @mints_pub.get_stories
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_pub.get_stories(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_pub.get_stories(options, false)
+    def get_stories(options = nil, use_post = true)
+      return get_query_results("/content/stories", options, use_post)
     end
 
     ##
@@ -162,8 +177,11 @@ module Mints
     # 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("story_slug")
+    # ==== First Example
+    #     @data = @mints_pub.get_story("story_slug")
+    #
+    # ==== Second Example
+    #     @data = @mints_pub.get_story("story_slug", options.to_json)
     def get_story(slug, options = nil)
       return @client.raw("get", "/content/stories/#{slug}", options, nil, nil, nil, true)
     end
@@ -172,13 +190,10 @@ module Mints
     # === Get Forms.
     # Get a collection of forms.
     #
-    # ==== 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)
+    #     @data = @mints_pub.get_forms
+    def get_forms
+      return @client.raw("get", "/content/forms")
     end
 
     ##
@@ -187,12 +202,11 @@ 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("form_slug")
-    def get_form(slug, options = nil)
-      return @client.raw("get", "/content/forms/#{slug}", options, nil, nil, nil, true)
+    #     @data = @mints_pub.get_form("form_slug")
+    def get_form(slug)
+      return @client.raw("get", "/content/forms/#{slug}", nil, nil, nil, nil, true)
     end
 
     ##
@@ -222,7 +236,20 @@ module Mints
     #
     # ==== 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 = nil) 
+    #
+    # ==== First Example
+    #     options = {
+    #       "template": "content_instance_template_slug"
+    #     }
+    #     @data = @mints_pub.get_content_instances(options)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "template": "content_instance_template_slug",
+    #       "sort": "-id"
+    #     }
+    #     @data = @mints_pub.get_content_instances(options)
+    def get_content_instances(options) 
       return @client.raw("get", "/content/content-instances", options)
     end
 
@@ -232,15 +259,14 @@ 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("content_instance_slug")
-    def get_content_instance(slug, options = nil)
-      return @client.raw("get", "/content/content-instances/#{slug}", options)
+    #     @data = @mints_pub.get_content_instance("content_instance_slug")
+    def get_content_instance(slug)
+      return @client.raw("get", "/content/content-instances/#{slug}")
     end
 
-    #TODO: This method is commented for future use
+    #Note: This method is commented for future use
     ##
     # === Get Content Pages.
     # Get all content pages.
@@ -257,38 +283,57 @@ 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_page("test-page")
-    def get_content_page(slug, options = nil)
-      return @client.raw("get", "/content/content-pages/#{slug}", options, nil, nil, nil, true)
+    #     @data = @mints_pub.get_content_page("test-page")
+    def get_content_page(slug)
+      return @client.raw("get", "/content/content-pages/#{slug}", nil, nil, nil, nil, true)
     end
 
+    ### V1/ECOMMERCE ###
+
     ##
     # === 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.
+    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
     #
-    # ==== Example
-    #     @mints_pub.get_locations
-    def get_locations(options = nil)
-      return @client.raw("get", "/ecommerce/locations", options)
+    # ==== First Example
+    #     @data = @mints_pub.get_locations
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_pub.get_locations(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_pub.get_locations(options, false)
+    def get_locations(options = nil, use_post = true)
+      return get_query_results("/ecommerce/locations", options, use_post)
     end
-
+    
     ##
     # === 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.
+    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
     #
-    # ==== Example
-    #     @mints_pub.get_products
-    def get_products(options = nil)
-      return @client.raw("get", "/ecommerce/products", options)
+    # ==== First Example
+    #     @data = @mints_pub.get_products
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_pub.get_products(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_pub.get_products(options, false)
+    def get_products(options = nil, use_post = true)
+      return get_query_results("/ecommerce/products", options, use_post)
     end
 
     ##
@@ -299,43 +344,66 @@ module Mints
     # 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("product_slug")
+    # ==== First Example
+    #     @data = @mints_pub.get_product("product_slug")
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, slug"
+    #     }
+    #     @data = @mints_pub.get_product("lego-set", options)
     def get_product(slug, options = nil)
       return @client.raw("get", "/ecommerce/products/#{slug}", options, nil, nil, nil, true)
     end
 
+    ### V1/CONFIG ###
+
     ##
-    # === Get categories.
-    # Get a collection of categories.
+    # === Get Public Folders.
+    # Get a collection of public folders.
     #
     # ==== Parameters
-    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
+    # options:: (Hash) -- List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter.
     #
-    # ==== Example
+    # ==== First Example
     #     options = {
-    #       "object_type": "stories"
+    #       "object_type": "products"
+    #     }
+    #     @data = @mints_pub.get_public_folders(options)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "object_type": "products",
+    #       "fields": "id",
+    #       "sort": "-id"
     #     }
-    #     @mints_pub.get_categories(options)
-    def get_categories(options = nil)
-      return @client.raw("get", "/config/categories", options)
+    #     @data = @mints_pub.get_public_folders(options)
+    def get_public_folders(options)
+      return @client.raw("get", "/config/public-folders", options)
     end
 
     ##
-    # === Get Category.
-    # Get a single category.
+    # === Get Public Folder.
+    # Get a public folder info.
     #
     # ==== 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
+    # ==== First Example
     #     options = {
-    #       "object_type": "locations"
+    #       "object_type": "products"
     #     }
-    #     @mints_pub.get_category("asset_slug", options)
-    def get_category(slug, options = nil)
-      return @client.raw("get", "/config/categories/#{slug}", options)
+    #     @data = @mints_pub.get_public_folder('yellow', options)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "object_type": "products",
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_pub.get_public_folder('yellow', options)
+    def get_public_folder(slug, options)
+      return @client.raw("get", "/config/public-folders/#{slug}", options)
     end
 
     ##
@@ -345,8 +413,14 @@ 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
+    # ==== First Example
+    #     @data = @mints_pub.get_tags
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, tag"
+    #     }
+    #     @data = @mints_pub.get_tags(options)
     def get_tags(options = nil)
       return @client.raw("get", "/config/tags", options)
     end
@@ -359,23 +433,42 @@ module Mints
     # 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("tag_slug")
+    # ==== First Example
+    #     @data = @mints_pub.get_tag("tag_slug")
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, tag"
+    #     }
+    #     @data = @mints_pub.get_tag("velit-0", options)
     def get_tag(slug, options = nil)
       return @client.raw("get", "/config/tags/#{slug}", 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.
+    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
     #
-    # ==== Example
-    #     @mints_pub.get_taxonomies
-    def get_taxonomies(options = nil)
-      return @client.raw("get", "/config/taxonomies", options)
+    # ==== First Example
+    #     @data = @mints_pub.get_taxonomies
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"      
+    #     }
+    #     @data = @mints_pub.get_taxonomies(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id, title"      
+    #     }
+    #     @data = @mints_pub.get_taxonomies(options, false)
+    def get_taxonomies(options = nil, use_post = true)
+      return get_query_results("/config/taxonomies", options, use_post)
     end
 
     ##
@@ -386,8 +479,14 @@ module Mints
     # 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("taxonomy_slug")
+    # ==== First Example
+    #     @data = @mints_pub.get_taxonomy("taxonomy_slug")
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_pub.get_taxonomy("taxonomy_slug", options)
     def get_taxonomy(slug, options = nil)
       return @client.raw("get", "/config/taxonomies/#{slug}", options)
     end
@@ -396,14 +495,45 @@ module Mints
     # === Get Attributes.
     # Get a collection of attributes.
     #
+    # ==== Example
+    #     @data = @mints_pub.get_attributes
+    def get_attributes
+      return @client.raw("get", "/config/attributes")
+    end
+
+    # Methods deleted
+    ##
+    # === 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
-    #     @mints_pub.get_attributes
-    def get_attributes(options = nil)
-      return @client.raw("get", "/config/attributes", options)
-    end
+    #     options = {
+    #       "object_type": "stories"
+    #     }
+    #     @data = @mints_pub.get_categories(options)
+    #def get_categories(options = nil)
+    #  return @client.raw("get", "/config/categories", options)
+    #end
+
+    ##
+    # === Get Category.
+    # Get a single category.
+    #
+    # ==== 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"
+    #     }
+    #     @data = @mints_pub.get_category("asset_slug", options)
+    #def get_category(slug, options = nil)
+    #  return @client.raw("get", "/config/categories/#{slug}", options)
+    #end
 
     private