mints 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf8cfd66c96475748e1eaa88e97ee51b2c3fc7b2a682fc558f4bb7eda98d31ea
-  data.tar.gz: 5175fb3ceaa8f4c9c607b76d90ff2cec26eec6a11e487f91e7d99645dd36687f
+  metadata.gz: 0d223884b10724746bee9c19bca2cfb4bed7678c48401fa5d5ff06424c81cf76
+  data.tar.gz: 80476fdc59a576a8d13a99176a0b2c91980fce8bb47b2a86d71201d751fe4004
 SHA512:
-  metadata.gz: e4e6b98fa27ba280d9f912b91c4c8f0da3ebd8f1750c2ee8d06429d1983c56dbad0cb34c8f9d3b6595155ebced1af354c8c36a39104e412cb04d2ea9628d5684
-  data.tar.gz: 9f1952c50204dde682a49fc1c9039f3e3f2da84078f711f227f236b8b9969c795cbebf9bba9a0350ba205dee403762789413e9381c3912c107a602494e781d16
+  metadata.gz: 5a948225647c432423b0ed981f3e0ddd0605e0e4d5237fa2fa54836a21561cc63cb4dc77f4f5e368f4943210095265c38f0c94cdc4395c38e236611f5289af54
+  data.tar.gz: 9d2959b4c166326e63de097993a8d06184fc53e3fbee80c3d85357f644ab25873d1e23932880b458765606def346aaaee5dea0ce382a3e014dd852371128c290

data/Gemfile

@@ -2,4 +2,5 @@ source :rubygems
 
 gem 'json'
 gem 'httparty'
-gem 'addressable'
+gem 'addressable'
+gem 'rails-reverse-proxy', '~> 0.9.1'

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,56 @@ con = Mints::User.new(mints_url, api_key)
 con.login(email, password)
 con.get_contacts
 ```
+## Generate mints files
+This command will generate the mints_config.yml file, API controlles and routes to have available the mints endpoints
+```bash
+rails generate mints_files
+```
+## Contact tracking usage
+Your app controller needs to be inherited from Mints::BaseController
+```ruby
+# application_controller.rb
+
+class ApplicationController < Mints::BaseController
+end
+```
+This heritance will make the following class variables available:
+
+| Variable        | Description                                                                          |
+|   ---           |    :---:                                                                             |
+| @host           | Host defined in mints_config.yml file                                                |
+| @api_key        | API key defined in mints_config.yml file                                             |
+| @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                                                |
+| @mints_contact  | An already instanced contact client (not usable until call the contact login method) |
+
+And the following controller methods:
+| Method                    | Parameters     | Return value | Description                                    |
+|   ---                     |   :---:        |   :---:      | :---:                                          |
+| mints_contact_signed_in?  | none           | boolean      | Indicates if the contact has an active session |
+| mints_contact_login       | email, password| void         | Starts a contact session                       |
+| mints_contact_logout      | none           | void         | Ends a contact session                         |
+
+## Admin controller usage
+If want to have a private section where only a mints user can acces and use the private user api is needed to inherit from the AdminBaseController.
+
+```ruby
+# admin_controller.rb
+
+class AdminController < Mints::AdminBaseController
+end
+```
+
+This heritance will make the following class variables available:
+| Variable        | Description                                                                          |
+|   ---           |    :---:                                                                             |
+| @host           | Host defined in mints_config.yml file                                                |
+| @api_key        | API key defined in mints_config.yml file                                             |
+| @mints_user     | An already instanced user client  (not usable until call the user login method)      |
+
+And the following controller methods:
+| Method                    | Parameters     | Return value | Description                                 |
+|   ---                     |   :---:        |   :---:      | :---:                                       |
+| mints_user_login          | email, password| void         | Starts a user session                       |
+| mints_user_logout         | none           | void         | Ends a user session                         |

data/lib/client.rb

@@ -9,21 +9,20 @@ module Mints
       attr_reader :base_url
       attr_accessor :session_token      
 
-      def initialize(host, api_key, scope = nil, session_token = nil)
+      def initialize(host, api_key, scope = nil, session_token = nil, debug = false)
           @host = host
           @api_key = api_key
           @session_token = session_token
+          @debug = debug
           self.set_scope(scope)
       end
 
       def raw(action, url, options = nil, data = nil, base_url = nil)
-        base_url = @base_url if !base_url        
-        
+        base_url = @base_url if !base_url
+        uri = ""
         if (options && options.class == Hash)
           uri = Addressable::URI.new
           uri.query_values = options
-        else
-          uri = ""
         end
 
         full_url = "#{@host}#{base_url}#{url}#{uri}"
@@ -46,7 +45,8 @@ module Mints
         return parsed_response
       end
   
-      def method_missing(name, *args, &block)     
+      def method_missing(name, *args, &block)
+        puts name
         name.to_s.include?("__") ? separator = "__" : separator = "_"        
         # split the name to identify their elements
         name_spplited = name.to_s.split(separator)
@@ -144,16 +144,38 @@ module Mints
       ##### HTTTP CLIENTS ######
       # Simple HTTP GET
       def http_get(url, headers = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+        end
         return headers ? HTTParty.get(url, :headers => headers) : HTTParty.get(url)
       end    
 
       # Simple HTTP POST
       def http_post(url, headers = nil, data = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+          puts "Data:"
+          puts data
+        end
         return headers ? HTTParty.post(url, :headers=> headers, :body => data) : HTTParty.post(url, :body => data)  
       end
 
       # Simple HTTP PUT
       def http_put(url, headers = nil, data = nil)
+        if @debug
+          puts "Url:"
+          puts url
+          puts "Headers:"
+          puts headers
+          puts "Data:"
+          puts data
+        end
         return headers ? HTTParty.put(url, :headers=> headers, :body => data) : HTTParty.put(url, :body => data)
       end
 
@@ -208,7 +230,7 @@ module Mints
         headers = {
           "ApiKey" => @api_key,
           "Accept" => "application/json",
-          "Contet-Type" => "application/json"
+          "Content-Type" => "application/json"
         }
         headers["Authorization"] = "Bearer #{@session_token}" if @session_token
         return self.http_put(url, headers, data)
@@ -216,7 +238,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",
+          "Content-Type" => "application/json",
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -226,7 +253,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",
+          "Content-Type" => "application/json",
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v
@@ -236,7 +268,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", 
+          "Content-Type" => "application/json", 
+          "ApiKey" => @api_key,
+          "ContactToken" => @session_token
+        }
         if headers
           headers.each do |k,v|
             h[k] = v

data/lib/contact.rb

@@ -2,10 +2,18 @@ require_relative "./client.rb"
 module Mints
   class Contact
     attr_reader :client
-    def initialize(host, api_key, session_token = nil)      
-      @client = Mints::Client.new(host, api_key, "contact", session_token)
+    ##
+    # === Initialize.
+    # Class constructor
+    #
+    def initialize(host, api_key, session_token = nil, debug = false)      
+      @client = Mints::Client.new(host, api_key, "contact", session_token, debug)
     end
 
+    ##
+    # === Register.
+    # Register a new contact
+    #
     def register(given_name, last_name, email, password)
       data = {
         given_name: given_name,
@@ -16,6 +24,10 @@ module Mints
       return @client.raw("post", "/contacts/register", nil, {data: data})
     end
 
+    ##
+    # === Login.
+    # Starts a contact session
+    #
     def login(email, password)
       data = {
         email: email,
@@ -28,39 +40,71 @@ module Mints
       return response
     end
 
+    ##
+    # === Logout.
+    # Ends a contact session
+    #
     def logout
       response = @client.raw("post", "/contacts/logout") if session_token?
       if response["success"]
         @client.session_token = nil
-      end
+      end 
       return response
     end
 
+    ##
+    # === Change Password.
+    # Change password
+    #
     def change_password(data)
       return @client.raw("post", "/contacts/change-password", nil, data)
     end
 
+    ##
+    # === Recover Password.
+    # Recover password
+    #
     def recover_password(data)
       return @client.raw("post", "/contacts/recover-password", nil, data)
     end
 
+    ##
+    # === Reset Password.
+    # Reset password
+    #
     def reset_password(data)
       return @client.raw("post", "/contacts/reset-password", nil, data)
     end
 
-    def auth_login(data)
+    ##
+    # === OAuth Login.
+    # Login a contact using oauth
+    #
+    def oauth_login(data)
       return @client.raw("post", "/contacts/oauth-login", nil, data)
     end
 
+    ##
+    # === Me.
+    # Get contact logged info
+    #
     def me
       return @client.raw("get", "/contacts/me")
     end
 
+    ##
+    # === Status.
+    # Get contact logged status
+    #
     def status
       return @client.raw("get", "/contacts/status")
     end
 
-    def update
+    ##
+    # === Update.
+    # Update logged contact attributes
+    #
+    def update(data)
       return @client.raw("put", "/contacts/update", nil, data)
     end
 

data/lib/generators/mints_config.yml

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

data/lib/generators/mints_contact_controller.rb

@@ -0,0 +1,3 @@
+require 'reverse_proxy/client'
+class Api::V1::MintsContactController <  Mints::ContactAPIController
+end

data/lib/generators/mints_files_generator.rb

@@ -0,0 +1,20 @@
+class MintsFilesGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__)))
+    include Rails::Generators::Actions
+    def create_mints_files
+      copy_file 'mints_config.yml', 'mints_config.yml'
+      copy_file 'mints_user_controller.rb', './app/controllers/api/mints_user_controller.rb'
+      copy_file 'mints_contact_controller.rb', './app/controllers/api/v1/mints_contact_controller.rb'
+      copy_file 'mints_public_controller.rb', './app/controllers/api/v1/mints_public_controller.rb'
+      route <<-eos
+        # Mints auto-generated routes (proxy to send request to mints.cloud)
+        namespace :api, defaults: { format: :json } do
+          match '/user/v1/*path' => 'mints_user#index', via: [:get, :post, :put, :patch, :delete]  
+          namespace :v1 do     
+            match '/contacts/*path' => 'mints_contact#index', via: [:get, :post, :put, :patch, :delete]  
+            match '/*path' => 'mints_public#index', via: [:get, :post, :put, :patch, :delete]
+          end
+        end
+      eos
+    end
+end

data/lib/generators/mints_public_controller.rb

@@ -0,0 +1,3 @@
+require 'reverse_proxy/client'
+class Api::V1::MintsPublicController <  Mints::PublicAPIController
+end

data/lib/generators/mints_user_controller.rb

@@ -0,0 +1,3 @@
+require 'reverse_proxy/client'
+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