mints 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74526a6438b7de0c89f91b1d7c14b8e34a77c139f911783cfe37437eb6c32b20
-  data.tar.gz: cef5273897e15545fe8a1f831fbbe1069cb1c4c2a14486221bdea94f3f70e6bb
+  metadata.gz: 2df25d921d402fcd499d478e74ff9aabcd88c6bd80570eb02dff24db03bfc10d
+  data.tar.gz: 85d5e0a2bec7138f2c9f878e3a4f7399581113071a83387615957f58a7c79486
 SHA512:
-  metadata.gz: f7da303e2dd55c10fb990d17a49628a99d95c8a3e06985cecc4e80d23784abe4c131afd6a16ff4780d639813ccbb0c0e5c6f75732b294f5a4a8cc9f607378d44
-  data.tar.gz: f521865904561b3c73e82ae099ca39dfdd9af23e424faf9cb4a1e219676e8d5eeb43426a6a1623a7f44e4bac88dbcf9603a786953f9d56c7a0a0527c6f41fc29
+  metadata.gz: 2835d608df2fd2156b7b58c7930ffc359b4dddb9994a32a3e77bd84eeab1425ee7224afa936f7758d684aba2a6920f2b4aa93e1237da50c415bf950971d74273
+  data.tar.gz: 1b3e7fe4d5a7611b21a9f86970a774ab1935395f3efa61b442bb0d56cf34c7f7408ce405d19b9846693102cc49faca4d50232b954bcd3d9bc01936b4ec671809

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,25 +9,31 @@ 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, data = nil, base_url = nil)
-        base_url = @base_url if !base_url        
-        full_url = "#{@host}#{base_url}#{url}"
-        p full_url
+      def raw(action, url, options = nil, data = nil, base_url = nil)
+        base_url = @base_url if !base_url
+        uri = ""
+        if (options && options.class == Hash)
+          uri = Addressable::URI.new
+          uri.query_values = options
+        end
+
+        full_url = "#{@host}#{base_url}#{url}#{uri}"
         if action === 'get'          
-          response = self.send("#{@scope}_#{action}", full_url)
+          response = self.send("#{@scope}_#{action}", "#{full_url}")
         elsif action === 'create' or action === 'post'
           action = 'post'
-          response = self.send("#{@scope}_#{action}", full_url, data)          
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data)          
         elsif action === 'put' or action === 'patch' or action ==='update'
           action = 'put'
-          response = self.send("#{@scope}_#{action}", full_url, data)
+          response = self.send("#{@scope}_#{action}", "#{full_url}", data)
         end
         if (response.response.code == "404")
           raise 'NotFoundError'
@@ -39,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)
@@ -63,37 +70,54 @@ module Mints
             route_array.push n
         end
         route = route_array.join("/")
-        if args.first.class == Hash
-          uri = Addressable::URI.new
-          uri.query_values = args.first if action === 'get'
-        elsif args.first.class == String or Integer
-          slug = args.first
-          uri = Addressable::URI.new
-          uri.query_values = args[1] if action === 'get'
-        end
-        if (slug)
-          url = "#{@host}#{@base_url}/#{route}/#{object}/#{slug}#{uri}"
-        else
-          url = "#{@host}#{@base_url}/#{route}/#{object}#{uri}"
-        end
-        if action === 'get'          
+        
+        
+        slug = nil
+        uri = Addressable::URI.new
+        if action == "get"
+          if args.first.class == Hash
+            uri.query_values = args.first
+          elsif args.first.class == String or Integer
+            slug = args.first
+            uri.query_values = args[1]
+          end
+          url = self.get_url(route, object, uri, slug)
           response = self.send("#{@scope}_#{action}", url)
-        elsif action === 'post' or action === 'create'
+        elsif action == "post" or action == "create"
+          if args[1].class == Hash
+            uri.query_values = args[1]
+          end
+          url = self.get_url(route, object, uri, slug)
           action = 'post'
           data = args[0]
           response = self.send("#{@scope}_#{action}", url, {data: data})
-        elsif action === 'put' or action === 'update'
+        elsif action == "put" or action == "update"
+           if args.first.class == String or Integer
+            slug = args.first
+            uri.query_values = args[2]
+          end
+          url = self.get_url(route, object, uri, slug)
           action = 'put'
           id = args[0]
           data = args[1]
-          response = self.send("#{@scope}_#{action}", "#{url}", data)
+          response = self.send("#{@scope}_#{action}", "#{url}", {data: data})
         end
-        p url
-        if (response.response.code == "404")
-            raise 'NotFoundError'
+
+        if response.response.code == "404"
+          raise 'NotFoundError'
+        elsif response.response.code == "500"
+          raise 'InternalServerError'  
         end
         return JSON.parse(response.body)        
       end
+
+      def get_url(route, object, uri, slug = nil)
+        if (slug)
+          return "#{@host}#{@base_url}/#{route}/#{object}/#{slug}#{uri}"
+        else
+          return "#{@host}#{@base_url}/#{route}/#{object}#{uri}"
+        end
+      end
       
       def replacements
         return [
@@ -120,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
 
@@ -184,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)
@@ -192,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
@@ -202,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
@@ -212,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,
@@ -13,55 +21,91 @@ module Mints
         email: email,
         password: password
       }
-      return @client.raw("post", "/contacts/register", {data: data})
+      return @client.raw("post", "/contacts/register", nil, {data: data})
     end
 
+    ##
+    # === Login.
+    # Starts a contact session
+    #
     def login(email, password)
       data = {
         email: email,
         password: password
       }
-      response = @client.raw("post", "/contacts/login", {data: data})
+      response = @client.raw("post", "/contacts/login", nil, {data: data})
       if response.key? "session_token"
         @client.session_token = response["session_token"]
       end
       return response
     end
 
+    ##
+    # === Logout.
+    # Ends a contact session
+    #
     def logout
-      response = @client.raw("post", "/contacts/logout", nil) if session_token?
+      response = @client.raw("post", "/contacts/logout") if session_token?
       if response["success"]
         @client.session_token = nil
-      end
+      end 
       return response
     end
 
-    def change_password
-      return @client.raw("post", "/contacts/change-password", data)
+    ##
+    # === Change Password.
+    # Change password
+    #
+    def change_password(data)
+      return @client.raw("post", "/contacts/change-password", nil, data)
     end
 
-    def recover_password
-      return @client.raw("post", "/contacts/recover-password", data)
+    ##
+    # === Recover Password.
+    # Recover password
+    #
+    def recover_password(data)
+      return @client.raw("post", "/contacts/recover-password", nil, data)
     end
 
-    def reset_password
-      return @client.raw("post", "/contacts/reset-password", data)
+    ##
+    # === Reset Password.
+    # Reset password
+    #
+    def reset_password(data)
+      return @client.raw("post", "/contacts/reset-password", nil, data)
     end
 
-    def auth_login
-      return @client.raw("post", "/contacts/oauth-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
-      return @client.raw("put", "/contacts/update", data)
+    ##
+    # === Update.
+    # Update logged contact attributes
+    #
+    def update(data)
+      return @client.raw("put", "/contacts/update", nil, data)
     end
 
     private

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,2 @@
+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