mints 0.0.1 → 0.0.6

data/lib/generators/mints_public_controller.rb

@@ -0,0 +1,2 @@
+class Api::V1::MintsPublicController <  Mints::PublicAPIController
+end

data/lib/generators/mints_user_controller.rb

@@ -0,0 +1,2 @@
+class Api::MintsUserController < Mints::UserAPIController
+end

data/lib/mints.rb

@@ -1,5 +1,10 @@
 require_relative "./pub.rb"
 require_relative "./contact.rb"
 require_relative "./user.rb"
+require_relative "./mints/controllers/base_controller.rb"
+require_relative "./mints/controllers/admin_base_controller.rb"
+require_relative "./mints/controllers/public_api_controller.rb"
+require_relative "./mints/controllers/contact_api_controller.rb"
+require_relative "./mints/controllers/user_api_controller.rb"
 module Mints
 end

data/lib/mints/controllers/admin_base_controller.rb

@@ -0,0 +1,56 @@
+module Mints
+  class AdminBaseController < ActionController::Base
+    before_action :set_mints_user_client
+
+    # def mints_user_signed_in?
+    #     # Check status in mints
+    #     response = @mints_user.status
+    #     status = response['success'] ? response['success'] : false
+    #     unless status
+    #       # if mints response is negative delete the session cookie
+    #       cookies.delete(:mints_user_session_token)
+    #     end
+    #     return status
+    # end
+
+    ##
+    # === Mints user Login.
+    # Starts a user session in mints.cloud and set a session cookie
+    def mints_user_login(email, password)
+        # Login in mints
+        response = @mints_user.login(email, password)
+        # Get session token from response
+        session_token = response['api_token']
+        # Set a permanent cookie with the session token
+        cookies.permanent[:mints_user_session_token] = session_token
+    end
+
+    ##
+    # === Mints user Logout.
+    # Destroy session from mints.cloud and delete local session cookie
+    def mints_user_logout
+        # Logout from mints
+        # @mints_user.logout
+        # Delete local cookie
+        cookies.delete(:mints_user_session_token)
+    end
+    
+    private
+
+    ##
+    # === Set Mints user client.
+    # Initialize the public client and set the user token
+    def set_mints_user_client
+      if File.exists?("#{Rails.root}/mints_config.yml")
+        config = YAML.load_file("#{Rails.root}/mints_config.yml")
+        @host = config["mints"]["host"]
+        @api_key = config["mints"]["api_key"]
+        @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
+      else
+        raise 'MintsBadCredentialsError'
+      end
+      # Initialize mints user client
+      @mints_user = Mints::User.new(@host, @api_key, nil, @debug)
+    end
+  end
+end

data/lib/mints/controllers/base_controller.rb

@@ -0,0 +1,86 @@
+module Mints
+  class BaseController < ActionController::Base
+    before_action :set_contact_token
+    before_action :set_mints_pub_client
+    before_action :register_visit
+    before_action :set_mints_contact_client
+
+    def mints_contact_signed_in?
+        # Check status in mints
+        response = @mints_contact.status
+        status = response['success'] ? response['success'] : false
+        unless status
+          # if mints response is negative delete the session cookie
+          cookies.delete(:mints_contact_session_token)
+        end
+        return status
+    end
+
+    ##
+    # === Mints Contact Login.
+    # Starts a contact session in mints.cloud and set a session cookie
+    def mints_contact_login(email, password)
+        # Login in mints
+        response = @mints_contact.login(email, password)
+        # Get session token from response
+        session_token = response['session_token']
+        # Set a permanent cookie with the session token
+        cookies.permanent[:mints_contact_session_token] = session_token
+    end
+
+    ##
+    # === Mints Contact Logout.
+    # Destroy session from mints.cloud and delete local session cookie
+    def mints_contact_logout
+        # Logout from mints
+        @mints_contact.logout
+        # Delete local cookie
+        cookies.delete(:mints_contact_session_token)
+    end
+    
+    private
+
+    ##
+    # === Register visit.
+    # Call register visit method from the public client and set/renew the cookie mints_contact_id
+    def register_visit
+      response = @mints_pub.register_visit(request)
+      @contact_token = response['user_token']
+      @visit_id = response['visit_id']
+      cookies.permanent[:mints_contact_id] = @contact_token
+    end
+
+    ##
+    # === Set mints pub.
+    # Initialize the public client and set the contact token
+    def set_mints_pub_client
+      if File.exists?("#{Rails.root}/mints_config.yml")
+        config = YAML.load_file("#{Rails.root}/mints_config.yml")
+        @host = config["mints"]["host"]
+        @api_key = config["mints"]["api_key"]
+        @debug = config["sdk"]["debug"] ? config["sdk"]["debug"] : false
+      else
+        raise 'MintsBadCredentialsError'
+      end
+      # Initialize mints pub client, credentials taken from mints_config.yml file
+      @mints_pub = Mints::Pub.new(@host, @api_key, nil, @debug)
+      # Set contact token from cookie
+      @mints_pub.client.session_token = @contact_token
+    end
+
+    ##
+    # === Set contact token.
+    # Set contact token variable from the mints_contact_id cookie value
+    def set_contact_token
+      @contact_token = cookies[:mints_contact_id]
+    end
+
+    ##
+    # === Set mints contact client.
+    # 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)
+    end
+  end
+end

data/lib/mints/controllers/contact_api_controller.rb

@@ -0,0 +1,39 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class ContactAPIController < ActionController::API
+        include AbstractController::Helpers
+        include ActionController::Cookies
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json'
+            }
+            if cookies[:mints_contact_session_token]
+                session_token = cookies[:mints_contact_session_token]
+                headers["Authorization"] = "Bearer #{session_token}"
+            end            
+            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                # We got a 404!
+                config.on_missing do |code, response|
+                    raise ActionController::RoutingError.new('Not Found')
+                end
+            end
+        end    
+        
+        private
+
+        def set_config_variables
+            if File.exists?("#{Rails.root}/mints_config.yml")
+                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/mints/controllers/public_api_controller.rb

@@ -0,0 +1,33 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class PublicAPIController < ActionController::API
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json' 
+            }
+            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                # We got a 404!
+                config.on_missing do |code, response|
+                    raise ActionController::RoutingError.new('Not Found')
+                end
+            end
+        end    
+        
+        private
+
+        def set_config_variables
+            if File.exists?("#{Rails.root}/mints_config.yml")
+                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/mints/controllers/user_api_controller.rb

@@ -0,0 +1,39 @@
+require 'reverse_proxy/controller'
+require 'reverse_proxy/client'
+module Mints
+    class UserAPIController < ActionController::API
+        include AbstractController::Helpers
+        include ActionController::Cookies
+        include ReverseProxy::Controller
+        before_action :set_config_variables
+        
+        def index
+            headers = {
+                'host' => "#{@host.gsub('http://', '').gsub('https://', '')}",
+                'ApiKey' => "#{@api_key}", 
+                'Content-Type'=> 'application/json', 
+                'Accept'=> 'application/json'
+            }
+            if cookies[:mints_contact_session_token]
+                session_token = cookies[:mints_user_session_token]
+                headers["Authorization"] = "Bearer #{session_token}"
+            end            
+            reverse_proxy "#{@host}", headers: headers, verify_ssl: false do |config|
+                # We got a 404!
+                config.on_missing do |code, response|
+                    raise ActionController::RoutingError.new('Not Found')
+                end
+            end
+        end    
+
+        private
+
+        def set_config_variables
+            if File.exists?("#{Rails.root}/mints_config.yml")
+                config = YAML.load_file("#{Rails.root}/mints_config.yml")
+                @host = config["mints"]["host"]
+                @api_key = config["mints"]["api_key"]
+            end
+        end
+    end
+end

data/lib/pub.rb

@@ -1,50 +1,320 @@
+require 'yaml'
 require_relative './client.rb'
 module Mints
+  ##
+  # == Public context API
+  # Pub class contains functions that needs only an API key as authentication
+  # == Usage example
+  # Initialize
+  #     pub = Mints::Pub.new(mints_url, api_key)
+  # or if host and api_key are provided by mints_config.yml
+  #     pub = Mints::Pub.new
+  # 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
+  # == 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
   class Pub
     attr_reader :client
-    def initialize(host, api_key)
-      @client = Mints::Client.new(host, api_key)
+
+    ##
+    # === Initialize.
+    # 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)
+    # ==== Return
+    # Returns a Client object
+    def initialize(host, api_key, contact_token = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, contact_token, debug)
     end
     
-    def register_visit(ip, user_agent, url)
+    ##
+    # === Register Visit.
+    # 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
+    def register_visit(request, ip = nil, user_agent = nil, url = nil)
       data = {
-        ip_address: ip,
-        user_agent: user_agent,
-        url: url
+        ip_address: ip || request.remote_ip,
+        user_agent: user_agent || request.user_agent,
+        url: url || request.fullpath
       }
-      return @client.raw("post", "/register-visit-timer", data)
+      response = @client.raw("post", "/register-visit", nil, data)
+      return response
+    end
+
+    ##
+    # === Register Visit timer.
+    # Register a page visit time
+    #
+    # ==== Parameters
+    # * +visit+ - [String] It's the visitor IP
+    # * +time+ - [Integer] The visitor's browser user agent
+    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
+    #
+    # ==== 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.
+    #
+    # ==== 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
+    #
+    # ==== 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)
+    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
+    def get_stories(options = nil)
+      return @client.raw("get", "/content/stories", options)
+    end
+
+    ##
+    # === Get Story.
+    # 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
+    def get_story(slug, options = nil)
+      return @client.raw("get", "/content/stories/#{slug}", options)
     end
 
-    def register_visit_timer
-      return @client.raw("get", "/register-visit-timer")
+    ##
+    # === 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
+    def get_forms(options = nil)
+      return @client.raw("get", "/content/forms", options)
     end
 
-    def get_content_page
-      return @client.raw("get", "/content-pages/#{slug}")
+    ##
+    # === Get Form.
+    # 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
+    def get_form(slug, options = nil)
+      return @client.raw("get", "/content/forms/#{slug}", options)
+    end
+
+    ##
+    # === Submit Form.
+    # Submit a form.
+    #
+    # ==== Parameters
+    # * +data+ - [Hash] Data to be submited
+    def submit_form(data)
+      return @client.raw("post", "/forms/store", nil, data)
+    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
+    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_product(slug, options = nil)
+      return @client.raw("get", "/ecommerce/products/#{slug}", options)
+    end
+
+    ##
+    # === Get Product Brands.
+    # Get a collection of product brands.
+    #
+    # ==== 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)
+    end
+
+    ##
+    # === Get Product Brand.
+    # Get a product brand.
+    #
+    # ==== 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_brand(slug, options = nil)
+      return @client.raw("get", "/ecommerce/product-brands/#{slug}", options)
+    end
+
+    ##
+    # === Get SKUs.
+    # Get a collection of SKUs.
+    #
+    # ==== 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)
+    end
+
+    ##
+    # === Get SKU.
+    # Get a single SKU.
+    #
+    # ==== 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)
+    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
+    def get_categories(options = nil)
+      return @client.raw("get", "/config/categories", options)
     end
 
-    def get_content_template
-      return @client.raw("get", "/content/content-templates/#{slug}")
+    ##
+    # === 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
+    def get_category(slug, options = nil)
+      return @client.raw("get", "/config/categories/#{slug}", options)
     end
 
-    def content_instance 
-      return @client.raw("get", "/content/content-instances/#{slug}")
+    ##
+    # === Get Tags.
+    # 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
+    def get_tags(options = nil)
+      return @client.raw("get", "/config/tags", options)
     end
 
-    def get_stories
-      return @client.raw("get", "/content/stories")
+    ##
+    # === Get 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
+    def get_tag(slug, options = nil)
+      return @client.raw("get", "/config/tags/#{slug}", options)
     end
 
-    def get_story(slug)
-      return @client.raw("get", "/content/stories/#{slug}")
+    ##
+    # === 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
 
-    def get_form
-      return @client.raw("get", "/content/forms/{slug}")
+    ##
+    # === 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
+    def get_taxonomies(options = nil)
+      return @client.raw("get", "/config/taxonomies", options)
     end
 
-    def submit_form
-      return @client.raw("post", "/forms/store", data)
+    ##
+    # === Get 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
+    def get_taxonomy(slug, options = nil)
+      return @client.raw("get", "/config/taxonomies/#{slug}", options)
     end
   end
 end