Class: Mints::Pub

Inherits:
Object
  • Object
show all
Includes:
MintsHelper
Defined in:
lib/pub.rb

Overview

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

pub = Mints::Pub.new

Call any function

pub.get_products

Single resource options

  • 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 }

  • 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 }

  • 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] If present, it will search for records matching the search string. Example:

    { "search": "search string" }

  • 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 }

  • 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" }

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MintsHelper

#correct_json, #data_transform, #get_query_results

Constructor Details

#initialize(host, api_key, contact_token_id = nil, visit_id = nil, debug = false) ⇒ Pub

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 Client object.


76
77
78
 
# File 'lib/pub.rb', line 76

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

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.


61
62
63
 
# File 'lib/pub.rb', line 61

def client
  @client
end

Instance Method Details

#get_asset_info(slug) ⇒ Object

Get Asset Info.

Get a description of an Asset.

Parameters

slug

(String) – It’s the string identifier of the asset.

Example

@data = @mints_pub.get_asset_info("asset_slug")


132
133
134
 
# File 'lib/pub.rb', line 132

def get_asset_info(slug)
  @client.raw('get', "/content/asset-info/#{slug}")
end

#get_attributes ⇒ Object

Get Attributes.

Get a collection of attributes.

Example

@data = @mints_pub.get_attributes


544
545
546
 
# File 'lib/pub.rb', line 544

def get_attributes
  @client.raw('get', '/config/attributes')
end

#get_content_bundle(slug, options = nil) ⇒ Object

Get Content Bundle.

Get a single content bundle.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

Example

@data = @mints_pub.get_content_bundle("test-page")


333
334
335
 
# File 'lib/pub.rb', line 333

def get_content_bundle(slug, options = nil)
  @client.raw('get', "/content/content-bundles/#{slug}", options)
end

#get_content_bundles(options = nil) ⇒ Object

Get Content Pages.

Get all content pages.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.


306
307
308
 
# File 'lib/pub.rb', line 306

def get_content_bundles(options = nil)
  @client.raw('get', '/content/content-bundles', options)
end

#get_content_instance(slug) ⇒ Object

Get Content Instance.

Get a single content instance.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

Example

@data = @mints_pub.get_content_instance("content_instance_slug")


296
297
298
 
# File 'lib/pub.rb', line 296

def get_content_instance(slug)
  @client.raw('get', "/content/content-instances/#{slug}")
end

#get_content_instances(options = nil) ⇒ Object

Get Content Instances.

Get a collection of content instances. Note: Options must be specified.

Parameters

options

(Hash) – List of Resource collection 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)


283
284
285
 
# File 'lib/pub.rb', line 283

def get_content_instances(options = nil)
  @client.raw('get', '/content/content-instances', options)
end

#get_content_page(slug, options = nil) ⇒ Object

Get Content Page.

Get a single content page.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

Example

@data = @mints_pub.get_content_page("test-page")


319
320
321
322
 
# File 'lib/pub.rb', line 319

def get_content_page(slug, options = nil)
  warn '[DEPRECATED] The get_content_page method is deprecated and will be removed in the future, use get_content_bundle instead'
  @client.raw('get', "/content/content-pages/#{slug}", options)
end

#get_form(slug, options = nil) ⇒ Object

Get Form.

Get a single form.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

Example

@data = @mints_pub.get_form("form_slug")


239
240
241
 
# File 'lib/pub.rb', line 239

def get_form(slug, options = nil)
  @client.raw('get', "/content/forms/#{slug}", options)
end

#get_forms(options = nil) ⇒ Object

Get Forms.

Get a collection of forms.

Example

@data = @mints_pub.get_forms


226
227
228
 
# File 'lib/pub.rb', line 226

def get_forms(options = nil)
  @client.raw('get', '/content/forms', options)
end

#get_locations(options = nil, use_post = true) ⇒ Object

Get Locations.

Get all locations.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

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)


357
358
359
 
# File 'lib/pub.rb', line 357

def get_locations(options = nil, use_post = true)
  get_query_results('/ecommerce/locations', options, use_post)
end

#get_product(slug, options = nil) ⇒ Object

Get Product.

Get a single product.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_product("product_slug")

Second Example

options = {
  fields: 'id, slug'
}
@data = @mints_pub.get_product("lego-set", options)


399
400
401
 
# File 'lib/pub.rb', line 399

def get_product(slug, options = nil)
  @client.raw('get', "/ecommerce/products/#{slug}", options)
end

#get_products(options = nil, use_post = true) ⇒ Object

Get Products.

Get a collection of products.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

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)


379
380
381
 
# File 'lib/pub.rb', line 379

def get_products(options = nil, use_post = true)
  get_query_results('/ecommerce/products', options, use_post)
end

#get_public_folder(slug, options) ⇒ Object

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 shown above can be used as parameter.

First Example

options = {
  object_type: "products"
}
@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)


449
450
451
 
# File 'lib/pub.rb', line 449

def get_public_folder(slug, options)
  @client.raw('get', "/config/public-folders/#{slug}", options)
end

#get_public_folders(options = nil) ⇒ Object

Get Public Folders.

Get a collection of public folders.

Parameters

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

options = {
  object_type: "products"
}
@data = @mints_pub.get_public_folders(options)

Second Example

options = {
  object_type: "products",
  fields: "id",
  sort: "-id"
}
@data = @mints_pub.get_public_folders(options)


425
426
427
 
# File 'lib/pub.rb', line 425

def get_public_folders(options = nil)
  @client.raw('get', '/config/public-folders', options)
end

#get_stories(options = nil, use_post = true) ⇒ Object

Get Stories.

Get a collection of stories.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @mints_pub.get_stories

Second Example

options = { fields: 'id, slug' }
@data = @mints_pub.get_stories(options)

Third Example

options = {
  fields: 'id, slug'
}
@data = @mints_pub.get_stories(options, false)


156
157
158
 
# File 'lib/pub.rb', line 156

def get_stories(options = nil, use_post = true)
  get_query_results('/content/stories', options, use_post)
end

#get_story(slug, options = nil) ⇒ Object

Get Story.

Get a single story.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_story("story_slug")

Second Example

@data = @mints_pub.get_story("story_slug", options.to_json)


173
174
175
 
# File 'lib/pub.rb', line 173

def get_story(slug, options = nil)
  @client.raw('get', "/content/stories/#{slug}", options)
end

#get_story_version(slug, options = nil) ⇒ Object

Get Story Version.

Get a single story version.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_story_version("story_slug")

Second Example

@data = @mints_pub.get_story_version("story_slug", options.to_json)


216
217
218
 
# File 'lib/pub.rb', line 216

def get_story_version(slug, options = nil)
  @client.raw('get', "/content/story-versions/#{slug}", options)
end

#get_story_versions(options = nil, use_post = true) ⇒ Object

Get Story Versions.

Get a collection of story version.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @mints_pub.get_story_versions

Second Example

options = {
  fields: 'id, title'
}
@data = @mints_pub.get_story_versions(options)

Third Example

options = {
  fields: 'id, title'
}
@data = @mints_pub.get_story_versions(options, false)


199
200
201
 
# File 'lib/pub.rb', line 199

def get_story_versions(options = nil, use_post = true)
  get_query_results('/content/story-versions', options, use_post)
end

#get_tag(slug, options = nil) ⇒ Object

Get Tag.

Get a single tag.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_tag("tag_slug")

Second Example

options = {
  fields: "id, tag"
}
@data = @mints_pub.get_tag("tag-example", options)


488
489
490
 
# File 'lib/pub.rb', line 488

def get_tag(slug, options = nil)
  @client.raw('get', "/config/tags/#{slug}", options)
end

#get_tags(options = nil) ⇒ Object

Get Tags.

Get a collection of tags.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_tags

Second Example

options = {
  fields: "id, tag"
}
@data = @mints_pub.get_tags(options)


468
469
470
 
# File 'lib/pub.rb', line 468

def get_tags(options = nil)
  @client.raw('get', '/config/tags', options)
end

#get_taxonomies(options = nil, use_post = true) ⇒ Object

Get Taxonomies.

Get a collection of taxonomies.

Parameters

options

(Hash) – List of Resource collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

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)


514
515
516
 
# File 'lib/pub.rb', line 514

def get_taxonomies(options = nil, use_post = true)
  get_query_results('/config/taxonomies', options, use_post)
end

#get_taxonomy(slug, options = nil) ⇒ Object

Get Taxonomy.

Get a single taxonomy.

Parameters

slug

(String) – It’s the string identifier generated by Mints.

options

(Hash) – List of Single Resource Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_taxonomy('taxonomy_slug')

Second Example

options = {
  fields: 'title'
}
@data = @mints_pub.get_taxonomy('taxonomy_slug', options)


534
535
536
 
# File 'lib/pub.rb', line 534

def get_taxonomy(slug, options = nil)
  @client.raw('get', "/config/taxonomies/#{slug}", options)
end

#register_visit(request, ip = nil, user_agent = nil, url = nil) ⇒ Object

Register Visit.

Register a ghost/contact visit in Mints.Cloud.

Parameters

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://1.1.1.1/",
  "user_agent" => "User Agent",
  "fullpath" => "https://fullpath/example"
}
@data = @mints_pub.register_visit(request, request["remote_ip"], request["user_agent"], request["fullpath"])


97
98
99
100
101
102
103
104
105
 
# File 'lib/pub.rb', line 97

def register_visit(request, ip = nil, user_agent = nil, url = nil)
  data = {
    ip_address: ip || request.remote_ip,
    user_agent: user_agent || request.user_agent,
    url: url || request.fullpath
  }

  @client.raw('post', '/register-visit', nil, data.to_json)
end

#register_visit_timer(visit, time) ⇒ Object

Register Visit timer.

Register a page visit time.

Parameters

visit

(String) – It’s the visitor IP.

time

(Integer) – The visitor’s browser user agent.

Example

@data = @mints_pub.register_visit_timer("60da2325d29acc7e55684472", 4)


117
118
119
 
# File 'lib/pub.rb', line 117

def register_visit_timer(visit, time)
  @client.raw('get', "/register-visit-timer?visit=#{visit}&time=#{time}")
end

#send_user_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email') ⇒ Object 


548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/pub.rb', line 548

def send_user_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email')
  data = {
    driver: driver,
    lifeTime: life_time,
    maxVisits: max_visits,
    redirectUrl: redirect_url,
    templateId: template_slug
  }

  key = %w[sms whatsapp].include? driver ? 'phone' : 'email'
  data[key] = email_or_phone
  @client.raw('post', '/users/magic-link', nil, { data: data }.to_json, '/api/v1')
end

#submit_form(data) ⇒ Object

Submit Form.

Submit a form with data.

Parameters

data

(Hash) – Data to be submitted.

Example

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'
}
@data = @mints_pub.submit_form(data)


260
261
262
 
# File 'lib/pub.rb', line 260

def submit_form(data)
  @client.raw('post', '/content/forms/submit', nil, data_transform(data))
end