mints 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327d7dc897b313289564ea62d790eca41f338394b7d3285a54044004d73c4949
-  data.tar.gz: 311fef416ffe4b8009752185f7ca974e6ebe4c887692608c03bee69e7432100c
+  metadata.gz: ef89ee973a9cb2bf2e4b77ad15e3481f7fc02e566f47099c7c44b94bdd3cb757
+  data.tar.gz: d40cf8e0445ce333ad735403f767622cc6428b7ab4f334040a542b0340d4eb49
 SHA512:
-  metadata.gz: 132622f7ce07aed342c56e2c1bf3bc1a15be585fbf747c603b822e184ef55f7fb914d6216ad5b7e7c33d0831cbf33caf6b2927fa46eace7938e40ede898e86cf
-  data.tar.gz: c5531bb9f2be7d66f8dd2b9951957b90e85b43c3d1e1527b462a3978f05ee9e768177f83aa6313d768d07c3062bee261add211d8dcbc5d5895f4dcf0f8c11ab2
+  metadata.gz: d8c404e2894b99bdb95a5db340ca9f47785cfec00fa6c3648b29a9b1c00e65a4a02569ccfdd5086e1911e468c942e93db214d21d2ac11c219934c66d9d3e9478
+  data.tar.gz: 2c24fc60a2cd29d377bd445cee14fbd611ddc728155eb7e3f2c545eec203100a64254b09e981128f28849dc7a95c1bded45bd592ebe67af3ed794f6e0b786809

data/Readme.md

@@ -6,8 +6,7 @@ This is a library to connect apps built on ruby to Mints.Cloud
 
 Add gem to the Gemfile
 ```bash
-gem 'mints', git: 'https://github.com/rubengomez/mints-ruby-sdk'
-bundle install
+gem 'mints'
 ```
 
 ## Usage
@@ -30,3 +29,18 @@ con = Mints::User.new(mints_url, api_key)
 con.login(email, password)
 con.get_contacts
 ```
+## Contact tracking usage
+Your app controller need to be inherited from Mints::BaseController
+```ruby
+# application_controller.rb
+
+class ApplicationController < Mints::BaseController
+end
+```
+This controller will make the following class variables available:
+
+| Variable        | Description                                   |
+|   ---           |    :---:                                      |
+| @mints_pub      | An already instanced public client            |
+| @contact_token  | A token used by mints to identify the contact |
+| @visit_id       | An identifier of the visit registered         |

data/lib/client.rb

@@ -216,7 +216,12 @@ module Mints
       # End User Context
       
       def public_get(url, headers = nil)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json",
+          "Contet-Type" => "application/json",
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -226,7 +231,12 @@ module Mints
       end
 
       def public_post(url, headers = nil, data)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json",
+          "Contet-Type" => "application/json",
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -236,7 +246,12 @@ module Mints
       end
 
       def public_put(url, headers = nil, data)
-        h = {"Accept" => "application/json", "Contet-Type" => "application/json", "ApiKey" => @api_key}
+        h = {
+          "Accept" => "application/json", 
+          "Contet-Type" => "application/json", 
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v

data/lib/generators/mints_config.yml

@@ -0,0 +1,4 @@
+# Mints connection configuration
+mints:
+    host: http://your_host_goes_here.com
+    api_key: your_mints_api_key_goes_here

data/lib/generators/mints_files_generator.rb

@@ -0,0 +1,6 @@
+class MintsFilesGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__)))
+    def create_mints_files
+      copy_file 'mints_config.yml', 'mints_config.yml'
+    end
+end

data/lib/mints.rb

@@ -1,5 +1,6 @@
 require_relative "./pub.rb"
 require_relative "./contact.rb"
 require_relative "./user.rb"
+require_relative "./mints/controllers/mints_base_controller.rb"
 module Mints
 end

data/lib/mints/controllers/mints_base_controller.rb

@@ -0,0 +1,35 @@
+module Mints
+  class BaseController < ActionController::Base
+    before_action :set_contact_token
+    before_action :set_mints_pub
+    before_action :register_visit
+    
+    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
+      # Initialize mints pub client, credentials taken from mints_config.yml file
+      @mints_pub = Mints::Pub.new
+      # 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
+  end
+end

data/lib/pub.rb

@@ -1,12 +1,14 @@
+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
@@ -25,6 +27,7 @@ module Mints
   # * +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
@@ -36,10 +39,20 @@ module Mints
     # ==== 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)
-      @client = Mints::Client.new(host, api_key)
+    def initialize(host=nil, api_key=nil, contact_token=nil)
+      if host === nil and api_key === nil
+        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"]
+        else
+          raise 'MintsBadCredentialsError'
+        end
+      end
+      @client = Mints::Client.new(host, api_key, contact_token)
     end
     
     ##
@@ -47,16 +60,18 @@ module Mints
     # 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(ip, user_agent, url)
+    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", nil, data)
+      response = @client.raw("post", "/register-visit", nil, data)
+      return response
     end
 
     ##
@@ -290,5 +305,26 @@ module Mints
     def get_attributes(options = nil)
       return @client.raw("get", "/config/attributes", 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
+    def get_taxonomies(options = nil)
+      return @client.raw("get", "/config/taxonomies", options)
+    end
+
+    ##
+    # === 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

data/lib/user.rb

@@ -1,5 +1,31 @@
 require_relative './client.rb'
 module Mints
+  ##
+  # == User context API
+  # User class contains functions that needs an API key and a session token as authentication
+  # == Usage example
+  # Initialize
+  #     client = Mints::User.new(mints_url, api_key)
+  # Call any function
+  #     client.get_contacts
+  # == 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 User
     attr_reader :client
     def initialize(host, api_key, session_token = nil)
@@ -18,7 +44,12 @@ module Mints
       return response
     end
     ######################################### CRM #########################################
-    ### Contacts ###
+    ##
+    # === Get contacts.
+    # Get a collection of contacts
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_contacts(options = nil)
       return @client.get__crm__contacts(options)
     end
@@ -34,7 +65,12 @@ module Mints
     def update_contact(id, data, options = nil)
       return @client.update__crm__contacts(id, data, options)
     end
-    ### Companies ###
+    
+    # === Get companies.
+    # Get a collection of companies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_companies(options = nil)
       return @client.get__crm__companies(options)
     end
@@ -51,7 +87,11 @@ module Mints
       return @client.update__crm__companies(id, data, options)
     end
 
-    ### Deals ###
+    # === Get deals.
+    # Get a collection of deals
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_deals(options = nil)
       return @client.get__crm__deals(options)
     end
@@ -69,7 +109,11 @@ module Mints
     end
 
     ######################################### Content #########################################
-    ### Stories ###
+    # === Get stories.
+    # Get a collection of stories
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_stories(options = nil)
       return @client.get__content__stories(options)
     end
@@ -86,7 +130,11 @@ module Mints
       return @client.update__content__stories(id, data, options)
     end
 
-    ### Stories templates ###
+    # === Get story templates.
+    # Get a collection of story templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_story_templates(options = nil)
       return @client.get__content__story_templates(options)
     end
@@ -103,7 +151,11 @@ module Mints
       return @client.update__content__story_templates(id, data, options)
     end
 
-    ### Content instances ###
+    # === Get content instances.
+    # Get a collection of content instances
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_instances(options = nil)
       return @client.get__content__instances(options)
     end
@@ -120,7 +172,11 @@ module Mints
       return @client.update__content__instances(id, data, options)
     end
 
-    ### Content pages ###
+    # === Get content pages.
+    # Get a collection of content pages
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_pages(options = nil)
       return @client.get__content__pages(options)
     end
@@ -137,25 +193,32 @@ module Mints
       return @client.update__content__pages(id, data, options)
     end
 
-    ### Content templates ###
+    # === Get content templates.
+    # Get a collection of content templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_content_templates(options = nil)
       return @client.get__content__templates(options)
     end
 
-    def get_content_page(id, options = nil)
+    def get_content_template(id, options = nil)
       return @client.get__content__templates(id, options)
     end
 
-    def create_content_page(data, options = nil)
+    def create_content_template(data, options = nil)
       return @client.create__content__templates(data, options)
     end
 
-    def update_content_page(id, data, options = nil)
+    def update_content_template(id, data, options = nil)
       return @client.update__content__templates(id, data, options)
     end
 
-    ######################################### Ecommerce #########################################
-    ### Products ###
+    # === Get products.
+    # Get a collection of products
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_products(options = nil)
       return @client.get__ecommerce__products(options)
     end
@@ -172,7 +235,11 @@ module Mints
       return @client.update__ecommerce__products(id, data, options)
     end
 
-    ### SKUs ###
+    # === Get skus.
+    # Get a collection of skus
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_skus(options = nil)
       return @client.get__ecommerce__skus(options)
     end
@@ -189,7 +256,11 @@ module Mints
       return @client.update__ecommerce__skus(id, data, options)
     end
 
-    ### Prices ###
+    # === Get prices.
+    # Get a collection of prices
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_prices(options = nil)
       return @client.get__ecommerce__prices(options)
     end
@@ -206,7 +277,11 @@ module Mints
       return @client.update__ecommerce__prices(id, data, options)
     end
 
-    ### Price lists ###
+    # === Get prece lists.
+    # Get a collection of prece lists
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_price_lists(options = nil)
       return @client.get__ecommerce__price_lists(options)
     end
@@ -223,7 +298,11 @@ module Mints
       return @client.update__ecommerce__price_lists(id, data, options)
     end
 
-    ### Product brands ###
+    # === Get product brands.
+    # Get a collection of product brands
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_brands(options = nil)
       return @client.get__ecommerce__product_brands(options)
     end
@@ -240,7 +319,11 @@ module Mints
       return @client.update__ecommerce__product_brands(id, data, options)
     end
 
-    ### Product types ###
+    # === Get product types.
+    # Get a collection of product types
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_types(options = nil)
       return @client.get__ecommerce__product_types(options)
     end
@@ -257,7 +340,11 @@ module Mints
       return @client.update__ecommerce__product_types(id, data, options)
     end
 
-    ### Product templates ###
+    # === Get product templates.
+    # Get a collection of product templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_product_templates(options = nil)
       return @client.get__ecommerce__product_templates(options)
     end
@@ -275,7 +362,11 @@ module Mints
     end
 
 
-    ### Locations ###
+    # === Get locations.
+    # Get a collection of locations
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
     def get_locations(options = nil)
       return @client.get__ecommerce__locations(options)
     end
@@ -291,5 +382,26 @@ module Mints
     def update_location(id, data, options = nil)
       return @client.update__ecommerce__locations(id, data, options)
     end
-  end
+  
+    # === Get taxonomies.
+    # Get a collection of taxonomies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_taxonomies(options = nil)
+      return @client.get__config__taxonomies(options)
+    end
+
+    def get_taxonomy(id, options = nil)
+      return @client.get__config__taxonomies(id, options)
+    end
+
+    def create_taxonomy(data, options = nil)
+      return @client.create__config__taxonomies(data, options)
+    end
+
+    def update_taxonomy(id, data, options = nil)
+      return @client.update__config__taxonomies(id, data, options)
+    end
+  end  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -80,7 +80,10 @@ files:
 - Readme.md
 - lib/client.rb
 - lib/contact.rb
+- lib/generators/mints_config.yml
+- lib/generators/mints_files_generator.rb
 - lib/mints.rb
+- lib/mints/controllers/mints_base_controller.rb
 - lib/pub.rb
 - lib/user.rb
 homepage: https://github.com/rubengomez/mints-ruby-sdk
@@ -89,6 +92,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- app
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements: