mints 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3deabf302a32fac1452e45f7ab9753ec0a1ee7973535b0371b9c67a25cb60cc7
-  data.tar.gz: 9589dacb58814ad17c5a2826f866b929f862d7ce7ce3fc745dcd3e191c2f19c9
+  metadata.gz: 18200f38cd58f4884a1e3391f28523b15dcad0db6f1a40038d3dd77bbc7b5826
+  data.tar.gz: 1a80da693aa4121af008dfc9d2816f5d09963e84d61f5274824593910786664e
 SHA512:
-  metadata.gz: d1bc7c183bc20b9dbe25f4f5d7770ee0492d0f2e773cdfb6934af7afe0056bf8f38f7277440a821e71f22a4abda51c11f7b8c2dd5f6279e22b9c68c7fe703d82
-  data.tar.gz: 2f7ebc2b2f8977f5009bafc4e42348cc4a7494729fb1aa15ccf69a8e7937c9872120a2bc81711fcd22153fa5cb05e71c462dc0c67645f350c5e5021f1e7a71f9
+  metadata.gz: aa64a73af10be175c08a0833e6178b654ea8cda3713e49e1533fdc12fa89d3c4be51974ac41c558463d11aa5d0c50e621d774a9b77bd61e554c4dda0a7cb0019
+  data.tar.gz: 525ef4e71004bc3705f36eb4d1f165044da08dba2af45eff3185e4686206f746dc4d0072ce97cd811ce1489c9de17f7737354d3a437eddbd9d90ffc164e4c6d2

data/lib/client.rb

@@ -24,6 +24,9 @@ module Mints
         base_url = @base_url if !base_url
         uri = ""
         if (options && options.class == Hash)
+          if (options[:jfilters] && options[:jfilters].class == Hash)
+            options[:jfilters] = Base64.encode64(JSON.generate(options[:jfilters]))
+          end
           uri = Addressable::URI.new
           uri.query_values = options
         end

data/lib/pub.rb

@@ -5,6 +5,10 @@ module Mints
   # == Public context API
   # Pub class contains functions that needs only an API key as authentication
   # == Usage example
+  # === For Mints::BaseController inheritance:
+  # If the controller is inheriting from Mints::BaseController, Only use the class variable *mints_pub*  _Example:_
+  #     @mints_pub.get_stories
+  # === For standalone usage:
   # Initialize
   #     pub = Mints::Pub.new(mints_url, api_key)
   # or if host and api_key are provided by mints_config.yml.erb
@@ -12,23 +16,58 @@ module Mints
   # 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
+  # * +include+ - [_String_] Specify additional information to be included in the results from the objects relations. _Example:_
+  #     { "include": "events" }
+  # * +attributes+ - [_Boolean_] If present, attributes will be returned for each record in the results. _Example:_
+  #     { "attributes": true }
+  # * +categories+ - [_Boolean_] If present, categories will be returned for each record in the results. _Example:_
+  #     { "categories": true }
+  # * +tags+ - [_Boolean_] If present, tags will be returned for each record in the results. _Example:_
+  #     { "tags": true }
+  # * +fields+ - [_String_] Specify the fields that you want to be returned. If empty, all fields are returned. The object index can also be used to specify specific fields from relations. _Example:_
+  #     { "fields": "id, title, slug" }
+  #     { "fields[products]": "id, title, slug" }
+  #
   # == 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
+  # * +search+ - [_String_] If present, it will search for records matching the search string. _Example:_
+  #     { "search": "searchstring" }
+  # * +scopes+ - [_String_] If present, it will apply the specified Model's scopes. _Example:_
+  #     { "scopes": "approved, recent" }
+  # * +filters+ - [_String_] This is a powerful parameter that allows the data to be filtered by any of its fields. Currently only exact matches are supported. _Example:_
+  #     { "filters[title]": "titleToFilter" }
+  # * +jfilters+ - [_String_] A complex filter configuration, as used in segments, in JSON format, base64 encoded and URLencoded. _Example:_
+  #     jfilter = {
+  #       "type":"group",
+  #       "items":[
+  #         {
+  #           "type":"attribute",
+  #           "operator":"==",
+  #           "slug":"title",
+  #           "value":"Action movies"
+  #         }
+  #       ],
+  #       "operator":"or"
+  #     } 
+  #     options = { "jfilters": jfilter }
+  # * +catfilters+ - [_String_] filter by categories. _Example:_
+  #     { "catfilters": "categoryName" }
+  # * +fields+ - [_String_] Specify the fields that you want to be returned. If empty, all fields are returned. The object index can also be used to specify specific fields from relations. _Example:_
+  #     { "fields": "id, title, slug" }
+  #     { "fields[products]": "id, title, slug" }
+  # * +sort+ - [_String_] The name of the field to perform the sort. Prefix the value with a minus sign - for ascending order. _Example:_
+  #     { "sort": "title" }
+  #     { "sort": "-title" }
+  # * +include+ - [_String_] Specify additional information to be included in the results from the objects relations. _Example:_
+  #     { "include": "events" }
+  # * +attributes+ - [_Boolean_] If present, attributes will be returned for each record in the results. _Example:_
+  #     { "attributes": true }
+  # * +categories+ - [_Boolean_] If present, categories will be returned for each record in the results. _Example:_
+  #     { "categories": true }
+  # * +taxonomies+ - [_Boolean_] If present, taxonomies will be returned for each record in the results. _Example:_
+  #     { "taxonomies": true }
+  # * +tags+ - [_Boolean_] If present, tags will be returned for each record in the results. _Example:_
+  #     { "tags": true }
+
   class Pub
     attr_reader :client
 
@@ -77,58 +116,15 @@ module Mints
     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
+    # === Get Asset Info.
+    # Get a description of an Asset
     #
     # ==== 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)
+    # * +slug+ - [String] It's the string identifier of the asset.
+    def get_asset_info(slug)
+      return @client.raw("get", "/content/asset-info/#{slug}")
     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
@@ -179,71 +175,81 @@ module Mints
     # * +data+ - [Hash] Data to be submited
     def submit_form(data)
       return @client.raw("post", "/content/forms/submit", nil, data)
-    end
+    end    
 
     ##
-    # === Get Products.
-    # Get a collection of products.
+    # === 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_products(options = nil)
-      return @client.raw("get", "/ecommerce/products", options)
+    def get_content_instances(options = nil) 
+      return @client.raw("get", "/content/content-instances", options)
     end
 
     ##
-    # === Get Product.
-    # Get a single product.
+    # === 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_product(slug, options = nil)
-      return @client.raw("get", "/ecommerce/products/#{slug}", options)
+    def get_content_instance(slug, options = nil)
+      return @client.raw("get", "/content/content-instances/#{slug}", options)
     end
 
     ##
-    # === Get Product Brands.
-    # Get a collection of product brands.
+    # === Get Content Pages.
+    # Get all content pages.
     #
     # ==== 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)
+    def get_content_pages(options = nil)
+      return @client.raw("get", "/content/content-pages", options)
     end
 
     ##
-    # === Get Product Brand.
-    # Get a product brand.
+    # === Get Content Page.
+    # Get a single content page
     #
     # ==== Parameters
-    # * +slug+ - [String] It's the string identifier generated by Mints
+    # * +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_product_brand(slug, options = nil)
-      return @client.raw("get", "/ecommerce/product-brands/#{slug}", options)
+    def get_content_page(slug, options = nil)
+      return @client.raw("get", "/content/content-pages/#{slug}", options)
+    end
+
+    ##
+    # === Get Locations.
+    # Get all locations.
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter
+    def get_locations(options = nil)
+      return @client.raw("get", "/ecommerce/locations", options)
     end
 
     ##
-    # === Get SKUs.
-    # Get a collection of SKUs.
+    # === 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_skus(options = nil)
-      return @client.raw("get", "/ecommerce/skus", options)
+    def get_products(options = nil)
+      return @client.raw("get", "/ecommerce/products", options)
     end
 
     ##
-    # === Get SKU.
-    # Get a single SKU.
+    # === 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_sku(slug, options = nil)
-      return @client.raw("get", "/ecommerce/skus/#{slug}", options)
+    def get_product(slug, options = nil)
+      return @client.raw("get", "/ecommerce/products/#{slug}", options)
     end
-    
+
     ##
     # === Get categories.
     # Get a collection of categories.
@@ -286,16 +292,6 @@ module Mints
       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
-
     ##
     # === Get Taxonomies.
     # Get a collection of taxonomies.
@@ -316,5 +312,15 @@ module Mints
     def get_taxonomy(slug, options = nil)
       return @client.raw("get", "/config/taxonomies/#{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
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora, Luis Payan