mints 0.0.17 → 0.0.21

data/lib/pub.rb

@@ -1,5 +1,7 @@
 require 'yaml'
 require_relative './client.rb'
+require_relative './mints_helper.rb'
+
 module Mints
   ##
   # == Public context API
@@ -70,39 +72,38 @@ module Mints
 
   class Pub
     attr_reader :client
-
     ##
     # === Initialize.
-    # Class constructor
+    # Class constructor.
     #
     # ==== Parameters
-    # * +host+ - [String] It's the visitor IP
-    # * +api_key+ - [String] Mints instance api key
-    # * +contact_token+ - [String] Cookie 'mints_contact_id' value (mints_contact_token)
+    # 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 Client object
-    def initialize(host, api_key, contact_token_id = nil,  debug = false)
-      @client = Mints::Client.new(host, api_key, 'public', nil, contact_token_id, debug)
+    # Returns a Client object.
+    def initialize(host, api_key, contact_token_id = nil, visit_id = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, 'public', nil, contact_token_id, visit_id, debug)
     end
     
     ##
     # === Register Visit.
-    # Register a ghost/contact visit in Mints.Cloud
+    # Register a ghost/contact visit in Mints.Cloud.
     #
     # ==== Parameters
-    # * +request+ - [ActionDispatch::Request] request
-    # * +ip+ - [String] It's the visitor IP
-    # * +user_agent+ - The visitor's browser user agent
-    # * +url+ - [String] URL visited
+    # request:: (ActionDispatch::Request) -- request.
+    # ip:: (String) -- It's the visitor IP.
+    # user_agent:: (String) -- The visitor's browser user agent.
+    # url:: (String) -- URL visited.
     #
     # ==== Example
     #     request = {
-    #       "remote_ip" => "http://864.401.156.12/",
+    #       "remote_ip" => "http://1.1.1.1/",
     #       "user_agent" => "User Agent",
-    #       "fullpath" => "https://mints.cloud/blog"
+    #       "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,
@@ -115,45 +116,57 @@ module Mints
 
     ##
     # === Register Visit timer.
-    # Register a page visit time
+    # Register a page visit time.
     #
     # ==== Parameters
-    # * +visit+ - [String] It's the visitor IP
-    # * +time+ - [Integer] The visitor's browser user agent
+    # visit:: (String) -- It's the visitor IP.
+    # 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
+    # Get a description of an Asset.
     #
     # ==== Parameters
-    # * +slug+ - [String] It's the string identifier of the asset.
+    # slug:: (String) -- It's the string identifier of the asset.
     #
     # ==== Example
-    #     @mints_pub.get_asset_info("quaerat")
-    #
+    #     @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
+    # 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
+    # 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
+    # ==== First Example
+    #     @data = @mints_pub.get_stories
     #
-    def get_stories(options = nil)
-      return @client.raw("get", "/content/stories", options)
+    # ==== 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
 
     ##
@@ -161,28 +174,26 @@ module Mints
     # Get a single story.
     #
     # ==== 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
+    # 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")
+    # ==== 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)
+      return @client.raw("get", "/content/stories/#{slug}", options, nil, nil, nil, true)
     end
 
     ##
     # === 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
+    # Get a collection of forms.
     #
     # ==== 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
 
     ##
@@ -190,35 +201,33 @@ module Mints
     # Get a single form.
     #
     # ==== 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
+    # slug:: (String) -- It's the string identifier generated by Mints.
     #
     # ==== Example
-    #     @mints_pub.get_form("survey")
-    #
-    def get_form(slug, options = nil)
-      return @client.raw("get", "/content/forms/#{slug}", options)
+    #     @data = @mints_pub.get_form("form_slug")
+    def get_form(slug)
+      return @client.raw("get", "/content/forms/#{slug}", nil, nil, nil, nil, true)
     end
 
     ##
     # === Submit Form.
-    # Submit a form.
+    # Submit a form with data.
     #
     # ==== Parameters
-    # * +data+ - [Hash] Data to be submited
+    # data:: (Hash) -- Data to be submited.
     #
     # ==== Example
-    #     data_form = {
-    #       "data": {
-    #         'form_slug': 'formulario',
-    #         'email': 'oscar@mints.cloud',
-    #         'ingrese-un-texto': 'hola'
-    #       }
+    #     data = {
+    #       'form_slug': 'form_slug',
+    #       'email': 'email@example.com',
+    #       'given_name': 'given_name',
+    #       'f1': 'Field 1 answer',
+    #       'f2': 'Field 2 answer',
+    #       'f3': 'Field 3 answer'
     #     }
-    #     @mints_pub.submit_form(data_form.to_json)
-    #
+    #     @data = @mints_pub.submit_form(data)
     def submit_form(data)
-      return @client.raw("post", "/content/forms/submit", nil, data)
+      return @client.raw("post", "/content/forms/submit", nil, data_transform(data))
     end    
 
     ##
@@ -226,8 +235,21 @@ module Mints
     # 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_content_instances(options = nil) 
+    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
+    #
+    # ==== 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
 
@@ -236,67 +258,82 @@ module Mints
     # 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
+    # slug:: (String) -- It's the string identifier generated by Mints.
     #
     # ==== Example
-    #     @mints_pub.get_content_instance("bill-gates")
-    #
-    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
 
+    #Note: This method is commented for future use
     ##
     # === 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_content_pages(options = nil)
-      return @client.raw("get", "/content/content-pages", options)
-    end
+    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
+    # def get_content_pages(options = nil)
+      #return @client.raw("get", "/content/content-pages", options)
+    #end
 
     ##
     # === Get Content Page.
-    # Get a single content page
+    # Get a single content page.
     #
     # ==== 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
+    # slug:: (String) -- It's the string identifier generated by Mints.
     #
     # ==== Example
-    #     @mints_pub.get_content_page("test-page")
-    #
-    def get_content_page(slug, options = nil)
-      return @client.raw("get", "/content/content-pages/#{slug}", options)
+    #     @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
+    # 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
+    # ==== First Example
+    #     @data = @mints_pub.get_locations
     #
-    def get_locations(options = nil)
-      return @client.raw("get", "/ecommerce/locations", options)
+    # ==== 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
+    # 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
+    # ==== First Example
+    #     @data = @mints_pub.get_products
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_pub.get_products(options)
     #
-    def get_products(options = nil)
-      return @client.raw("get", "/ecommerce/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
 
     ##
@@ -304,48 +341,69 @@ module Mints
     # 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
+    # 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")
+    # ==== 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)
+      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
+    # 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("atm", options)
+    #     @data = @mints_pub.get_public_folder('yellow', options)
     #
-    def get_category(slug, options = nil)
-      return @client.raw("get", "/config/categories/#{slug}", 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
 
     ##
@@ -353,55 +411,82 @@ module Mints
     # Get a collection of tags.
     #
     # ==== 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 {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
 
     ##
     # === Get Tag.
-    # Get a single tag
+    # Get a single tag.
     #
     # ==== 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
+    # 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")
+    # ==== 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
+    # 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
+    # ==== First Example
+    #     @data = @mints_pub.get_taxonomies
     #
-    def get_taxonomies(options = nil)
-      return @client.raw("get", "/config/taxonomies", options)
+    # ==== 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
 
     ##
     # === Get Taxonomy.
-    # Get a single taxonomy
+    # Get a single taxonomy.
     #
     # ==== 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
+    # 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")
+    # ==== 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
@@ -410,14 +495,48 @@ 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
+    # 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
+    #     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.
     #
-    def get_attributes(options = nil)
-      return @client.raw("get", "/config/attributes", options)
-    end
+    # ==== 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
+
+    include MintsHelper
   end
 end