contentstack 0.6.3 → 0.7.0

data/lib/contentstack/client.rb

@@ -1,92 +1,123 @@
-require 'contentstack/api'
-require 'contentstack/content_type'
-require 'contentstack/asset_collection'
-require 'contentstack/sync_result'
-require 'util'
-require 'contentstack/error'
-module Contentstack
-  class Client
-    using Utility
-    attr_reader :region, :host
-    # Initialize "Contentstack" Client instance
-    def initialize(api_key, delivery_token, environment, options={})
-      raise Contentstack::Error.new("Api Key is not valid") if api_key.class != String
-      raise Contentstack::Error.new("Api Key Field Should not be Empty") if api_key.empty?
-      raise Contentstack::Error.new("Delivery Token is not valid") if delivery_token.class != String
-      raise Contentstack::Error.new("Delivery Token Field Should not be Empty") if delivery_token.empty?
-      raise Contentstack::Error.new("Envirnoment Field is not valid") if environment.class != String
-      raise Contentstack::Error.new("Envirnoment Field Should not be Empty") if environment.empty?
-      @region = options[:region].nil? ? Contentstack::Region::US : options[:region]
-      @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host]
-      @live_preview = !options.key?(:live_preview) ? {} : options[:live_preview]
-      @branch = options[:branch].nil? ? "" : options[:branch]
-      @proxy_details = options[:proxy].nil? ? "" : options[:proxy]
-      @timeout = options[:timeout].nil? ? 3000 : options[:timeout]
-      @retryDelay = options[:retryDelay].nil? ? 3000 : options[:retryDelay]
-      @retryLimit = options[:retryLimit].nil? ? 5 : options[:retryLimit]
-      @errorRetry = options[:errorRetry].nil? ? [408, 429] : options[:errorRetry]
-      retry_options = {
-        "timeout" =>  @timeout.to_s,
-        "retryDelay"=>  @retryDelay,
-        "retryLimit"=> @retryLimit,
-        "errorRetry" => @errorRetry
-      }
-      raise Contentstack::Error.new("Proxy URL Should not be Empty") if @proxy_details.present? && @proxy_details[:url].empty?
-      raise Contentstack::Error.new("Proxy Port Should not be Empty") if @proxy_details.present? && @proxy_details[:port].empty?
-      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview, @proxy_details, retry_options)
-    end
-    
-    def content_types
-      ContentType.all
-    end
-
-    def content_type(uid)
-      ContentType.new({uid: uid})
-    end
-
-    def assets
-      AssetCollection.new
-    end
-
-    def asset(uid)
-      Asset.new(uid)
-    end
-
-    def live_preview_query(query={})
-      API.live_preview_query(query)
-    end
-    
-    # Syncs your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates
-    # 
-    #   Stack.sync({'init': true})        // For initializing sync
-    # 
-    #   Stack.sync({'init': true, 'locale': 'en-us'})     //For initializing sync with entries of a specific locale
-    # 
-    #   Stack.sync({'init': true, 'start_date': '2018-10-22'})    //For initializing sync with entries published after a specific date
-    # 
-    #   Stack.sync({'init': true, 'content_type_uid': 'session'})   //For initializing sync with entries of a specific content type
-    # 
-    #   Stack.sync({'init': true, 'type': 'entry_published'})   // Use the type parameter to get a specific type of content.Supports 'asset_published', 'entry_published', 'asset_unpublished', 'entry_unpublished', 'asset_deleted', 'entry_deleted', 'content_type_deleted'.
-    # 
-    #   Stack.sync({'pagination_token': '<pagination>'})    // For fetching the next batch of entries using pagination token
-    # 
-    #   Stack.sync({'sync_token': '<sync>'})    // For performing subsequent sync after initial sync
-    #
-    # @param params [Hash] params is an object that supports ‘locale’, ‘start_date’, ‘content_type_uid’, and ‘type’ queries.
-    def sync(params)
-      sync_result = API.get_sync_items(params)
-      SyncResult.new(sync_result)
-    end
-
-    private
-    def get_default_region_hosts(region='us')
-      case region
-      when "us"
-        host = "https://cdn.contentstack.io"
-      when "eu"
-        host = "https://eu-cdn.contentstack.com"
-      end
-      host
-    end
-  end
+require 'contentstack/api'
+require 'contentstack/content_type'
+require 'contentstack/asset_collection'
+require 'contentstack/sync_result'
+require 'util'
+require 'contentstack/error'
+module Contentstack
+  class Client
+    using Utility
+    attr_reader :region, :host
+    # Initialize "Contentstack" Client instance
+    def initialize(api_key, delivery_token, environment, options={})
+      raise Contentstack::Error.new("Api Key is not valid") if api_key.class != String
+      raise Contentstack::Error.new("Api Key Field Should not be Empty") if api_key.empty?
+      raise Contentstack::Error.new("Delivery Token is not valid") if delivery_token.class != String
+      raise Contentstack::Error.new("Delivery Token Field Should not be Empty") if delivery_token.empty?
+      raise Contentstack::Error.new("Envirnoment Field is not valid") if environment.class != String
+      raise Contentstack::Error.new("Envirnoment Field Should not be Empty") if environment.empty?
+      @region = options[:region].nil? ? Contentstack::Region::US : options[:region]
+      # @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host] #removed for not supporting custom host with regions
+      @host = get_host_by_region(@region, options) # Added new method for custom host support with different regions
+      @live_preview = !options.key?(:live_preview) ? {} : options[:live_preview]
+      @branch = options[:branch].nil? ? "" : options[:branch]
+      @proxy_details = options[:proxy].nil? ? "" : options[:proxy]
+      @timeout = options[:timeout].nil? ? 3000 : options[:timeout]
+      @retryDelay = options[:retryDelay].nil? ? 3000 : options[:retryDelay]
+      @retryLimit = options[:retryLimit].nil? ? 5 : options[:retryLimit]
+      @errorRetry = options[:errorRetry].nil? ? [408, 429] : options[:errorRetry]
+      retry_options = {
+        "timeout" =>  @timeout.to_s,
+        "retryDelay"=>  @retryDelay,
+        "retryLimit"=> @retryLimit,
+        "errorRetry" => @errorRetry
+      }
+      raise Contentstack::Error.new("Proxy URL Should not be Empty") if @proxy_details.present? && @proxy_details[:url].empty?
+      raise Contentstack::Error.new("Proxy Port Should not be Empty") if @proxy_details.present? && @proxy_details[:port].empty?
+      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview, @proxy_details, retry_options)
+    end
+    
+    def content_types
+      ContentType.all
+    end
+
+    def content_type(uid)
+      ContentType.new({uid: uid})
+    end
+
+    def assets
+      AssetCollection.new
+    end
+
+    def asset(uid)
+      Asset.new(uid)
+    end
+
+    def live_preview_query(query={})
+      API.live_preview_query(query)
+    end
+    
+    # Syncs your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates
+    # 
+    #   Stack.sync({'init': true})        // For initializing sync
+    # 
+    #   Stack.sync({'init': true, 'locale': 'en-us'})     //For initializing sync with entries of a specific locale
+    # 
+    #   Stack.sync({'init': true, 'start_date': '2018-10-22'})    //For initializing sync with entries published after a specific date
+    # 
+    #   Stack.sync({'init': true, 'content_type_uid': 'session'})   //For initializing sync with entries of a specific content type
+    # 
+    #   Stack.sync({'init': true, 'type': 'entry_published'})   // Use the type parameter to get a specific type of content.Supports 'asset_published', 'entry_published', 'asset_unpublished', 'entry_unpublished', 'asset_deleted', 'entry_deleted', 'content_type_deleted'.
+    # 
+    #   Stack.sync({'pagination_token': '<pagination>'})    // For fetching the next batch of entries using pagination token
+    # 
+    #   Stack.sync({'sync_token': '<sync>'})    // For performing subsequent sync after initial sync
+    #
+    # @param params [Hash] params is an object that supports ‘locale’, ‘start_date’, ‘content_type_uid’, and ‘type’ queries.
+    def sync(params)
+      sync_result = API.get_sync_items(params)
+      SyncResult.new(sync_result)
+    end
+
+    private
+    def get_default_region_hosts(region='us')
+      host = "#{Contentstack::Host::PROTOCOL}#{Contentstack::Host::DEFAULT_HOST}" #set default host if region is nil
+      case region
+      when "us"
+        host = "#{Contentstack::Host::PROTOCOL}#{Contentstack::Host::DEFAULT_HOST}"
+      when "eu"
+        host = "#{Contentstack::Host::PROTOCOL}eu-cdn.#{Contentstack::Host::HOST}"
+      when "azure-na"
+        host = "#{Contentstack::Host::PROTOCOL}azure-na-cdn.#{Contentstack::Host::HOST}"
+      when "azure-eu"
+        host = "#{Contentstack::Host::PROTOCOL}azure-eu-cdn.#{Contentstack::Host::HOST}"
+      end
+      host
+    end
+
+    def get_host_by_region(region, options)
+      if options[:host].nil? && region.present?
+        host = get_default_region_hosts(region)
+      elsif options[:host].present? && region.present?
+        custom_host = options[:host]
+        case region
+        when "us"
+        host = "#{Contentstack::Host::PROTOCOL}cdn.#{custom_host}"
+        when "eu"
+          host = "#{Contentstack::Host::PROTOCOL}eu-cdn.#{custom_host}"
+        when "azure-na"
+          host = "#{Contentstack::Host::PROTOCOL}azure-na-cdn.#{custom_host}"
+        when "azure-eu"
+          host = "#{Contentstack::Host::PROTOCOL}azure-eu-cdn.#{custom_host}"
+        end
+      elsif options[:host].present? && region.empty?
+        custom_host = options[:host]
+        host = "#{Contentstack::Host::PROTOCOL}cdn.#{custom_host}"
+      else
+        host = "#{Contentstack::Host::PROTOCOL}#{Contentstack::Host::DEFAULT_HOST}" #set default host if region and host is empty  
+      end
+      host
+    end
+
+  end
 end

data/lib/contentstack/content_type.rb

@@ -1,54 +1,54 @@
-require 'contentstack/query'
-require 'util'
-
-module Contentstack
-  class ContentType
-    using Utility
-    [:title, :uid, :created_at, :updated_at, :attributes].each do |method_name|
-      if [:created_at, :updated_at].include?(method_name)
-        define_method method_name do
-          return Time.parse(@attributes[method_name]) if @attributes[method_name] && !@attributes[method_name].nil?
-        end
-      elsif :attributes == method_name
-        define_method :attributes do
-          {
-            title: self.title,
-            uid: self.uid,
-            created_at: self.created_at,
-            updated_at: self.updated_at,
-            schema: @attributes[:schema]
-          }
-        end 
-      else
-        define_method method_name do
-          return @attributes[method_name]
-        end
-      end
-    end
-
-    def initialize(object)
-      @attributes = object.symbolize_keys
-    end
-
-    def query
-      Query.new(self.uid)
-    end
-
-    def entry(entry_uid)
-      Entry.new({uid: entry_uid}, self.uid)
-    end
-
-
-    def self.all
-      content_types = API.fetch_content_types["content_types"]
-      content_types.map do |content_type|
-        ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
-      end
-    end
-
-    def fetch
-      content_type = API.fetch_content_types(uid)["content_type"]
-      ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
-    end
-  end
+require 'contentstack/query'
+require 'util'
+
+module Contentstack
+  class ContentType
+    using Utility
+    [:title, :uid, :created_at, :updated_at, :attributes].each do |method_name|
+      if [:created_at, :updated_at].include?(method_name)
+        define_method method_name do
+          return Time.parse(@attributes[method_name]) if @attributes[method_name] && !@attributes[method_name].nil?
+        end
+      elsif :attributes == method_name
+        define_method :attributes do
+          {
+            title: self.title,
+            uid: self.uid,
+            created_at: self.created_at,
+            updated_at: self.updated_at,
+            schema: @attributes[:schema]
+          }
+        end 
+      else
+        define_method method_name do
+          return @attributes[method_name]
+        end
+      end
+    end
+
+    def initialize(object)
+      @attributes = object.symbolize_keys
+    end
+
+    def query
+      Query.new(self.uid)
+    end
+
+    def entry(entry_uid)
+      Entry.new({uid: entry_uid}, self.uid)
+    end
+
+
+    def self.all
+      content_types = API.fetch_content_types["content_types"]
+      content_types.map do |content_type|
+        ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
+      end
+    end
+
+    def fetch
+      content_type = API.fetch_content_types(uid)["content_type"]
+      ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
+    end
+  end
 end