mints 0.0.16 → 0.0.20

data/lib/mints/controllers/base_controller.rb

@@ -24,10 +24,10 @@ 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'] ? response['contact']['contact_token'] : response['contact']['id_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
 
@@ -39,10 +39,10 @@ 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'] ? response['contact']['contact_token'] : response['contact']['id_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
 
@@ -64,10 +64,29 @@ 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 ADDRESS: #{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'] ? response['contact_token'] : response['user_token']
       @visit_id = response['visit_id']
-      cookies.permanent[:mints_contact_id] = @contact_token
+      if @debug
+        puts "VISIT ID: #{@visit_id}"
+      end
+      cookies.permanent[:mints_contact_id] = { value: @contact_token, secure: true, httponly: true }
+      cookies.permanent[:mints_visit_id] = { value: @visit_id, secure: true, httponly: true }
     end
 
     ##
@@ -84,7 +103,8 @@ 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)
+      @visit_id = cookies[:mints_visit_id] ? cookies[:mints_visit_id] : nil
+      @mints_pub = Mints::Pub.new(@host, @api_key, @contact_token, @visit_id, @debug)
       # Set contact token from cookie
       @mints_pub.client.session_token = @contact_token
     end
@@ -100,6 +120,15 @@ module Mints
     # === Set mints contact client.
     # Initialize the public client and set the contact token
     def set_mints_contact_client
+      if File.exists?("#{Rails.root}/mints_config.yml.erb")
+        template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
+        config = YAML.load template.result(binding)
+        @host = config["mints"]["host"]
+        @api_key = config["mints"]["api_key"]
+        @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
+      else
+        raise 'MintsBadCredentialsError'
+      end
       # Initialize mints clontact client
       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

data/lib/mints_helper.rb

@@ -0,0 +1,47 @@
+
+module MintsHelper
+    # === Get query results.
+    # Method used to give the options to make a 'post' or 'get' request.
+    #
+    # ==== Parameters
+    # url:: (String) -- Url to make the request.
+    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::User-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.
+    #
+    def get_query_results(url, options = nil, use_post = true)
+        if use_post
+        return @client.raw("post", "#{url}/query", options)
+        else
+        return @client.raw("get", url, options)
+        end
+    end
+
+    # === Data transform.
+    # Transform a 'data' variable to a standardized 'data' variable.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    def data_transform(data)
+        data = correct_json(data)
+        unless data[:data]
+            data = {data: data}
+        end
+        return data.to_json
+    end
+
+    # === Correct json.
+    # Receives a json data and convert it to a symbolized object.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    def correct_json(data)
+        if data.is_a? String
+            data = JSON.parse(data)
+        end
+        data = data.symbolize_keys
+        return data
+    end
+
+end

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,30 +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://1.1.1.1/",
+    #       "user_agent" => "User Agent",
+    #       "fullpath" => "https://fullpath/example"
+    #     }
+    #     @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,
@@ -106,31 +116,40 @@ 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)
     def register_visit_timer(visit, time)
       return @client.raw("get", "/register-visit-timer?visit=#{visit}&time=#{time}")
     end
 
     ##
     # === 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("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.
+    #
+    # ==== Example
+    #     @mints_pub.get_stories
     def get_stories(options = nil)
       return @client.raw("get", "/content/stories", options)
     end
@@ -140,18 +159,24 @@ 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("story_slug")
     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
+    # 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
+    # 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
@@ -161,28 +186,42 @@ 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.
+    # 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)
+      return @client.raw("get", "/content/forms/#{slug}", options, 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_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)
     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    
 
     ##
     # === 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
+    # 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) 
       return @client.raw("get", "/content/content-instances", options)
     end
@@ -192,31 +231,38 @@ 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.
+    # 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)
     end
 
+    #TODO: 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.
+    # 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)
+      return @client.raw("get", "/content/content-pages/#{slug}", options, nil, nil, nil, true)
     end
 
     ##
@@ -224,7 +270,10 @@ module Mints
     # 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.
+    #
+    # ==== Example
+    #     @mints_pub.get_locations
     def get_locations(options = nil)
       return @client.raw("get", "/ecommerce/locations", options)
     end
@@ -234,7 +283,10 @@ module Mints
     # 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.
+    #
+    # ==== Example
+    #     @mints_pub.get_products
     def get_products(options = nil)
       return @client.raw("get", "/ecommerce/products", options)
     end
@@ -244,10 +296,13 @@ 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("product_slug")
     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
 
     ##
@@ -255,18 +310,30 @@ module Mints
     # 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
+    #     options = {
+    #       "object_type": "stories"
+    #     }
+    #     @mints_pub.get_categories(options)
     def get_categories(options = nil)
       return @client.raw("get", "/config/categories", options)
     end
 
     ##
     # === Get Category.
-    # Get a single 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
+    # 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("asset_slug", options)
     def get_category(slug, options = nil)
       return @client.raw("get", "/config/categories/#{slug}", options)
     end
@@ -276,18 +343,24 @@ 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
     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("tag_slug")
     def get_tag(slug, options = nil)
       return @client.raw("get", "/config/tags/#{slug}", options)
     end
@@ -297,18 +370,24 @@ module Mints
     # 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.
+    #
+    # ==== Example
+    #     @mints_pub.get_taxonomies
     def get_taxonomies(options = nil)
       return @client.raw("get", "/config/taxonomies", options)
     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("taxonomy_slug")
     def get_taxonomy(slug, options = nil)
       return @client.raw("get", "/config/taxonomies/#{slug}", options)
     end
@@ -318,9 +397,16 @@ module Mints
     # 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
+    # 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
+
+    private
+
+    include MintsHelper
   end
 end

data/lib/user/config/api_keys.rb

@@ -0,0 +1,65 @@
+module ApiKeys
+    ##
+    # == Api keys
+    #
+    
+    # === Get api keys.
+    # Get a collection of api keys.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_api_keys
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_api_keys(options)
+    def get_api_keys(options = nil)
+        return @client.raw("get", "/config/api-keys", options)
+    end
+
+    # === Get api key.
+    # Get an api key info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Api key id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_api_key(2)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_api_key(2, options)
+    def get_api_key(id, options = nil)
+        return @client.raw("get", "/config/api-keys/#{id}", options)
+    end
+
+    # === Create api key.
+    # Create an api key with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "description": "New Api Key Description"
+    #     }
+    #     @data = @mints_user.create_api_key(data)
+    def create_api_key(data)
+        return @client.raw("post", "/config/api-keys", nil, data_transform(data))
+    end
+
+    # === Delete api key.
+    # Delete an api key.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Api key id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_api_key(2)
+    def delete_api_key(id)
+        return @client.raw("delete", "/config/api-keys/#{id}")
+    end
+end