mints 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf8cfd66c96475748e1eaa88e97ee51b2c3fc7b2a682fc558f4bb7eda98d31ea
-  data.tar.gz: 5175fb3ceaa8f4c9c607b76d90ff2cec26eec6a11e487f91e7d99645dd36687f
+  metadata.gz: 327d7dc897b313289564ea62d790eca41f338394b7d3285a54044004d73c4949
+  data.tar.gz: 311fef416ffe4b8009752185f7ca974e6ebe4c887692608c03bee69e7432100c
 SHA512:
-  metadata.gz: e4e6b98fa27ba280d9f912b91c4c8f0da3ebd8f1750c2ee8d06429d1983c56dbad0cb34c8f9d3b6595155ebced1af354c8c36a39104e412cb04d2ea9628d5684
-  data.tar.gz: 9f1952c50204dde682a49fc1c9039f3e3f2da84078f711f227f236b8b9969c795cbebf9bba9a0350ba205dee403762789413e9381c3912c107a602494e781d16
+  metadata.gz: 132622f7ce07aed342c56e2c1bf3bc1a15be585fbf747c603b822e184ef55f7fb914d6216ad5b7e7c33d0831cbf33caf6b2927fa46eace7938e40ede898e86cf
+  data.tar.gz: c5531bb9f2be7d66f8dd2b9951957b90e85b43c3d1e1527b462a3978f05ee9e768177f83aa6313d768d07c3062bee261add211d8dcbc5d5895f4dcf0f8c11ab2

data/lib/contact.rb

@@ -2,10 +2,18 @@ require_relative "./client.rb"
 module Mints
   class Contact
     attr_reader :client
+    ##
+    # === Initialize.
+    # Class constructor
+    #
     def initialize(host, api_key, session_token = nil)      
       @client = Mints::Client.new(host, api_key, "contact", session_token)
     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/pub.rb

@@ -1,11 +1,55 @@
 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)
+  # 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
+  # * +tags+ - [Boolean] attach tags to response
   class Pub
     attr_reader :client
+
+    ##
+    # === Initialize.
+    # Class constructor
+    #
+    # ==== Parameters
+    # * +host+ - [String] It's the visitor IP
+    # * +api_key+ - [String] Mints instance api key
+    # ==== Return
+    # Returns a Client object
     def initialize(host, api_key)
       @client = Mints::Client.new(host, api_key)
     end
     
+    ##
+    # === Register Visit.
+    # Register a ghost/contact visit in Mints.Cloud
+    #
+    # ==== Parameters
+    # * +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)
       data = {
         ip_address: ip,
@@ -15,91 +59,234 @@ module Mints
       return @client.raw("post", "/register-visit-timer", nil, data)
     end
 
-    def register_visit_timer
-      return @client.raw("get", "/register-visit-timer")
+    ##
+    # === 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-pages/#{slug}", options)
+      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")
     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 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 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
 
+    ##
+    # === Get Forms.
+    # Get a collection of forms.
+    #
+    # ==== Parameters
+    # * +slug+ - [String] It's the string identifier generated by Mints
+    # * +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/{slug}", options)
     end
 
+    ##
+    # === 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
 
+    ##
+    # === 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
 
+    ##
+    # === 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)
       return @client.raw("get", "/config/tags", options)
     end
 
+    ##
+    # === 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
 
+    ##
+    # === 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json