contentstack 0.0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ee5dd72d68bfd14e2292a7dd9bd18f0f11fe6091
-  data.tar.gz: 9903cbb89a02c2775a24a238727203c4d9ec9e10
+SHA256:
+  metadata.gz: 71f7d4a812c67dc37dba0ef98229566ea5b4d340b87f0389e45cfe041c173400
+  data.tar.gz: c49301d479315648103c8eb84771558a7475579e9d277d857ff700927ac87f3d
 SHA512:
-  metadata.gz: df87832f6264b3ac38745dd5cd4364e89c61c50f817f1321c979fae7f9d38d1b32a560784abfaf2ceaf9e558b30ebe033290d778b1eeae4bae408e5b03a609aa
-  data.tar.gz: 9d98b68aae934eef4b344e1d19022d3c2b0ed795013f1023a322182588478d40f73fd6387d3b5887e22921d2620aceb5960b54bf4e9dff1e5caac6c9e32b7b4b
+  metadata.gz: b3f188fe61e9d35a1c9626b8f2fd15a1196abd1b547eacef2c24147ab7369d75c0d1c09b0f9e288ad94bb89068948e72dadf15a540539f5605d011cbcccfeaf5
+  data.tar.gz: 040c5271bda413fa05a96c9bba8fa1a399c4fd74ce0b83aaff610830e1aa586093e269e03c4be089e0f8717d405dcc85bec9b1e1ac7eba2d20b77ae1fd78344a

data/.gitignore

@@ -5,3 +5,6 @@ doc
 spec-integration
 coverage
 \.yardoc
+.DS_Store
+.bundle/
+*/rspec_results.html

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+## CHANGELOG
+------------------------------------------------
+
+## Version 0.2.0
+
+ ### New Features
+  - Entry 
+    - locale - function for passing locale is added
+    - only - function for getting only specified field
+    - except - function for getting field except specified field
+    - include_reference - function for including reference in entry
+    - include_schema - function for including schema along with entry added
+    - include_content_type - function for including content type details along with entry added
+    - include_owner - function for getting owner of entry
+    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
+
+  - Query 
+    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
+
+
+------------------------------------------------
+
+## Version 0.1.0
+
+ ### Bug
+  - Stack Tokens Moved to Headers
+
+------------------------------------------------
+
+## Version 0.0.4
+
+ ### Enhancement
+  - Region support added
+
+------------------------------------------------
+
+## Version 0.0.3
+
+ ### Enhancement
+  - Query - function for passing locale is added.
+
+------------------------------------------------
+
+## Version 0.0.1
+
+ - Initial release 
+
+------------------------------------------------

data/CODE_OF_CONDUCT.md

@@ -22,8 +22,7 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic

data/Gemfile

@@ -0,0 +1,8 @@
+# Gemfile
+source "https://rubygems.org"
+
+gem "rspec"
+gem "webmock"
+gem "simplecov"
+gem "activesupport"
+gem "yard"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    hashdiff (1.0.1)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    public_suffix (4.0.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rspec
+  simplecov
+  webmock
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 amite
+Copyright (c) 2012-2019 Contentstack. All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,134 @@
+# **Ruby SDK for Contentstack**
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/). 
+
+Contentstack provides Ruby SDK to build application on top of Ruby on Rails. Given below is the detailed guide and helpful resources to get started with our Ruby SDK.
+
+## **Prerequisite**
+
+You need ruby v2.0 or later installed to use the Contentstack Ruby SDK.
+
+## **Setup and Installation**
+
+Add the following code to your application's Gemfile and bundle:
+
+    gem 'contentstack'
+
+Or you can run this command in your terminal (you might need administrator privileges to perform this installation):
+
+    gem install contentstack
+
+To start using the SDK in your application, you will need to initialize the stack by providing the values for the keys given in the code snippet below.
+
+    # with default region
+    client = Contentstack::Client.new("api_key", "delivery_token", "enviroment_name")
+    
+    # with specific region
+    client = Contentstack::Client.new("api_key", "delivery_token", "enviroment_name",{"region": Contentstack::Region::EU})
+    
+    # with custom host
+    client = Contentstack::Client.new("api_key", "delivery_token", "enviroment_name",{"host": "https://custom-cdn.contentstack.com"})
+
+## **Key Concepts for using Contentstack**
+
+### **Stack**
+
+A stack is like a container that holds the content of your app. Learn more about [stacks](https://www.contentstack.com/docs/guide/stack).
+
+### **Content Type**
+
+Content type lets you define the structure or blueprint of a page or a section of your digital property. It is a form-like page that gives Content Managers an interface to input and upload content. [Read more](https://www.contentstack.com/docs/guide/content-types). 
+
+### **Entry**
+
+An entry is the actual piece of content created using one of the defined content types. Learn more about [Entries](https://www.contentstack.com/docs/guide/content-management#working-with-entries). 
+
+### **Asset**
+
+Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about [Assets](https://www.contentstack.com/docs/guide/content-management#working-with-assets). 
+
+### **Environment**
+
+A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [Environments](https://www.contentstack.com/docs/guide/environments). 
+
+## **Contentstack Ruby SDK: 5-minute Quickstart**
+
+### **Initializing your SDK**
+
+To initialize the SDK, you need to provide values for the keys given in the snippet below:
+
+    stack = Contentstack::Client.new("api_key", "delivery_token", "enviroment_name")
+
+To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings > Stack to view the API Key and Access Token.
+
+### **Querying content from your stack**
+
+To fetch all entries of of a content type, use the query given below:
+
+    entry = stack.content_type(<<CONTENT_TYPE_UID>>).query();
+
+To fetch a specific entry from a content type, use the following query:
+
+    entry = stack.content_type(<<CONTENT_TYPE_UID>>).entry(<<ENTRY_UID>>);
+
+### Get Multiple Entries
+To retrieve multiple entries of a content type, specify the content type UID. You can also specify search parameters to filter results:
+
+    @query = @stack.content_type('blog').query
+    @entries = @query.where('title', 'welcome')
+                    .include_schema
+                    .include_count
+                    .fetch
+    puts "Total Entries -- #{@entries.count}"
+    @entries.each{|entry| puts "#{entry.get('title')}" }
+To retrieve localized versions of entries, you can use the query attribute:
+
+    entry = @stack.content_type('content_type_uid').query.locale('locale_code').fetch()
+
+> Note: Currently, the above query works in case of retrieving localized versions of multiple entries only.
+
+## **Advanced Queries**
+
+You can query for content types, entries, assets and more using our Ruby API Reference. 
+
+[Ruby API Reference Doc](http://www.rubydoc.info/gems/contentstack)
+
+### Paginating Responses
+In a single instance, the [Get Multiple Entries](https://www.contentstack.com/docs/developers/ruby/get-started-with-ruby-sdk/#get-multiple-entries) query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the [skip](https://www.rubydoc.info/gems/contentstack/Contentstack/Query#skip-instance_method) and [limit](https://www.rubydoc.info/gems/contentstack/Contentstack/Query#limit-instance_method) parameters in subsequent requests.
+
+    @stack = Contentstack::Client.new("api_key", "delivery_token", "environment")
+    @entries = @stack.content_type('category').query
+                   .limit(20)
+                   .skip(50)
+                   .fetch
+
+> Note: Currently, the Ruby SDK does not support multiple content types referencing in a single query. For more information on how to query entries and assets, refer the Queries section of our Content Delivery API documentation.
+
+## **Working with Images**
+
+We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on. 
+
+For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/download?crop=300,400. There are several more parameters that you can use for your images. 
+
+[Read Image Delivery API documentation](https://www.contentstack.com/docs/apis/image-delivery-api/). 
+
+SDK functions for Image Delivery API coming soon. 
+
+## **Helpful Links**
+
+* [Contentstack Website](https://www.contentstack.com)
+
+* [Official Documentation](http://contentstack.com/docs)
+
+* [Content Delivery API Docs](https://contentstack.com/docs/apis/content-delivery-api/)
+
+## **The MIT License (MIT)**
+
+Copyright © 2012-2020 [Contentstack](https://www.contentstack.com). All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/contentstack.gemspec

@@ -6,11 +6,13 @@ Gem::Specification.new do |s|
   s.name = %q{contentstack}
   s.version = Contentstack::VERSION.dup
   s.date = Time.now
-  s.authors = [%q{Rohit Sharma}]
-  s.email = ["rubygems@contentstack.com"]
+  s.authors = [%q{Contentstack}]
+  s.email = ["support@contentstack.com"]
+
+  s.required_ruby_version = '>= 2.0'
 
   s.license = "MIT"
-  s.homepage = "https://github.com/builtio-contentstack/contentstack-ruby"
+  s.homepage = "https://github.com/contentstack/contentstack-ruby"
 
   s.summary = %q{Contentstack Ruby client for the Content Delivery API}
   s.description = %q{Contentstack Ruby client for the Content Delivery API}

data/lib/contentstack.rb

@@ -2,15 +2,20 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "contentstack/version"
 require "contentstack/client"
+require "contentstack/region"
 require "util"
 
 
-# == Built.io Contentstack - Ruby SDK
-# Built.io Contentstack is a content management system that facilitates the process of publication by separating the content from site-related programming and design.
+# == Contentstack - Ruby SDK
+# Contentstack is a content management system that facilitates the process of publication by separating the content from site-related programming and design.
 # == Installation
 #   gem install contentstack
 # == Initialize the Stack
-#   @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name")
+# == Initialize the Stack for EU region
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"region": Contentstack::Region::EU })
+# == Initialize the Stack for custom host
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"host": "https://custom-cdn.contentstack.com" })
 # == Usage
 # ==== Get single entry
 #   @stack.content_type('blog').entry('<entry_uid_here>').fetch

data/lib/contentstack/api.rb

@@ -6,11 +6,13 @@ require 'open-uri'
 
 module Contentstack
   class API
-    def self.init_api(api_key, access_token, environment)
-      @host = "https://cdn.contentstack.io"
+    def self.init_api(api_key, delivery_token, environment,host)
+      @host = host
       @api_version = '/v3'
       @environment = environment
-      @headers = {api_key: api_key, access_token: access_token, user_agent: "ruby-sdk/#{Contentstack::VERSION}", environment: @environment}
+      @api_key = api_key
+      @access_token = delivery_token
+      @headers = {environment: @environment}
     end
 
     def self.fetch_content_types(uid="")
@@ -27,9 +29,9 @@ module Contentstack
       send_request(path, query)
     end
 
-    def self.fetch_entry(content_type, entry_uid)
+    def self.fetch_entry(content_type, entry_uid, query)
       path = "/content_types/#{content_type}/entries/#{entry_uid}"
-      send_request(path)
+      send_request(path, query)
     end
 
     def self.get_assets(asset_uid=nil)
@@ -43,12 +45,15 @@ module Contentstack
       q ||= {}
 
       q.merge!(@headers)
-      q.merge!({timestamp: Time.now.to_i})
 
       query = "?" + q.to_query
       # puts "Request URL:- #{@host}#{@api_version}#{path}#{query} \n\n"
       
-      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}").read)
+      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}",
+      "api_key" =>  @api_key,
+      "access_token"=>  @access_token,
+      "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
+      "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
     end
   end
-end
+end

data/lib/contentstack/client.rb

@@ -4,9 +4,12 @@ require 'contentstack/asset_collection'
 
 module Contentstack
   class Client
-    # Initialize "Built.io Contentstack" Client instance
-    def initialize(api_key, access_token, environment)
-      API.init_api(api_key, access_token, environment)
+    attr_reader :region, :host
+    # Initialize "Contentstack" Client instance
+    def initialize(api_key, delivery_token, environment, options={})
+      @region = options[:region].nil? ? Contentstack::Region::US : options[:region]
+      @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host]
+      API.init_api(api_key, delivery_token, environment,  @host)
     end
 
     
@@ -25,5 +28,16 @@ module Contentstack
     def asset(uid)
       Asset.new(uid)
     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
 end

data/lib/contentstack/content_type.rb

@@ -44,7 +44,7 @@ module Contentstack
       end
     end
 
-    def self.find_by_uid(uid)
+    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

data/lib/contentstack/entry.rb

@@ -1,13 +1,179 @@
+require 'active_support/core_ext'
+
 module Contentstack
   class Entry
-    attr_reader :fields, :content_type, :uid, :owner
+    attr_reader :fields, :content_type, :uid, :owner, :query, :schema, :content_type
     def initialize(attrs, content_type_uid=nil)
       setup(attrs, content_type_uid)
     end
 
+    # Get entries from the specified locale. 
+    #
+    # @param [String] code The locale code of the entry
+    #
+    # Example
+    #    @entry = @stack.content_type('category').entry(entry_uid)
+    #    @entry.locale('en-us')
+    #
+    # @return [Contentstack::Entry]
+    def locale(code)
+      @query[:locale] = code
+      self
+    end
+
+    # Specifies an array of 'only' keys in BASE object that would be 'included' in the response.
+    #
+    # @param [Array] fields Array of the 'only' reference keys to be included in response.
+    # @param [Array] fields_with_base Can be used to denote 'only' fields of the reference class
+    #
+    # Example
+    #    # Include only title and description field in response
+    #    @entry = @stack.content_type('category').entry(entry_uid)
+    #    @entry.only(['title', 'description'])
+    #
+    #    # Query product and include only the title and description from category reference
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_reference('category')
+    #          .only('category', ['title', 'description'])
+    #
+    # @return [Contentstack::Entry]
+    def only(fields, fields_with_base=nil)
+      q = {}
+      if [Array, String].include?(fields_with_base.class)
+        fields_with_base = [fields_with_base] if fields_with_base.class == String
+        q[fields.to_sym] = fields_with_base
+      else
+        fields = [fields] if fields.class == String
+        q = {BASE: fields}
+      end
+
+      @query[:only] = q
+      self
+    end
+
+    # Specifies list of field uids that would be 'excluded' from the response.
+    #
+    # @param [Array] fields Array of field uid which get 'excluded' from the response.
+    # @param [Array] fields_with_base Can be used to denote 'except' fields of the reference class
+    #
+    # Example
+    #    # Exclude 'description' field in response
+    #    @entry = @stack.content_type('category').entry(entry_uid)
+    #    @entry.except(['description'])
+    #
+    #    # Query product and exclude the 'description' from category reference
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_reference('category')
+    #          .except('category', ['description'])
+    #
+    # @return [Contentstack::Entry]
+    def except(fields, fields_with_base=nil)
+      q = {}
+      if [Array, String].include?(fields_with_base.class)
+        fields_with_base = [fields_with_base] if fields_with_base.class == String
+        q[fields.to_sym] = fields_with_base
+      else
+        fields = [fields] if fields.class == String
+        q = {BASE: fields}
+      end
+
+      @query[:except] = q
+      self
+    end
+
+    # Add a constraint that requires a particular reference key details.
+    #
+    # @param [String/Array] reference_field_uids Pass string or array of reference fields that must be included in the response
+    #
+    # Example
+    #
+    #    # Include reference of 'category'
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_reference('category')
+    #
+    #    # Include reference of 'category' and 'reviews'
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_reference(['category', 'reviews'])
+    #
+    # @return [Contentstack::Entry]
+    def include_reference(reference_field_uids)
+      self.include(reference_field_uids)
+    end
+
+    # Include schemas of all returned objects along with objects themselves.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_schema
+    #
+    # @return [Contentstack::Entry]
+    def include_schema(flag=true)
+      @query[:include_schema] = flag
+      self
+    end
+
+    # Include object owner's profile in the objects data.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_owner
+    #
+    # @return [Contentstack::Entry]
+    def include_owner(flag=true)
+      @query[:include_owner] = flag
+      self
+    end
+
+    # Include object's content_type in response
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_content_type
+    #
+    # @return [Contentstack::Entry]
+    def include_content_type(flag=true)
+      @query[:include_content_type] = flag
+      self
+    end
+
+    # Include the fallback locale publish content, if specified locale content is not publish.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_fallback
+    #
+    # @return [Contentstack::Entry]
+    def include_fallback(flag=true)
+      @query[:include_fallback] = flag
+      self
+    end
+
+    #
+    # @return [Contentstack::Query]
+    def include(field_uids)
+      field_uids = [field_uids] if field_uids.class == String
+      @query[:include] ||= []
+      @query[:include] = @query[:include] | field_uids
+      self
+    end
+
+    # Execute entry
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.fetch
+    #
+    # @return [Contentstack::EntryCollection]
     def fetch
-      entry = API.fetch_entry(@content_type, self.fields[:uid])
+      entry = API.fetch_entry(@content_type, self.fields[:uid], @query)
       setup(entry["entry"])
+      @schema       = entry["schema"].symbolize_keys if entry["schema"]
+      @content_type = entry["content_type"].symbolize_keys if entry["content_type"]
       self
     end
 
@@ -22,6 +188,7 @@ module Contentstack
       @content_type = content_type_uid if !content_type_uid.blank?
       @owner        = attrs[:_owner] if attrs[:_owner]
       @uid          = attrs[:uid]
+      @query        = {}
     end
   end
 end

data/lib/contentstack/query.rb

@@ -370,6 +370,20 @@ module Contentstack
       self
     end
 
+    # Get entries from the specified locale. 
+    #
+    # @param [String] code The locale code of the entry
+    #
+    # Example
+    #    @query = @stack.content_type('category').query
+    #    @query.locale('en-us')
+    #
+    # @return [Contentstack::Query]
+    def locale(code)
+      @query[:locale] = code
+      self
+    end
+
     # Specifies an array of 'only' keys in BASE object that would be 'included' in the response.
     #
     # @param [Array] fields Array of the 'only' reference keys to be included in response.
@@ -488,6 +502,20 @@ module Contentstack
       self
     end
 
+
+    # Include the fallback locale publish content, if specified locale content is not publish.
+    #
+    # Example
+    #
+    #    @query = @stack.content_type('product').query
+    #    @query.include_fallback
+    #
+    # @return [Contentstack::Query]
+    def include_fallback(flag=true)
+      @query[:include_fallback] = flag
+      self
+    end
+
     # Include objects in 'Draft' mode in response
     #
     # Example

data/lib/contentstack/region.rb

@@ -0,0 +1,6 @@
+module Contentstack
+  class Region
+    EU='eu'
+    US='us'
+  end
+end

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.0.2"
+  VERSION = "0.2.1"
 end

data/spec/content_type_spec.rb

@@ -3,6 +3,8 @@ require_relative '../lib/contentstack.rb'
 
 describe Contentstack::ContentType do
   let(:client) { create_client }
+  let(:eu_client) { create_client('DELIVERY_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
+  let(:custom_host_client) { create_client('DELIVERY_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
 
   describe "Fetch data from API" do
     it "has class as Contentstack::ContentType" do
@@ -14,6 +16,16 @@ describe Contentstack::ContentType do
       @data = client.content_types.first
       expect(@data.title).not_to be nil
     end
+    
+    it "has method called title with data from eu" do
+      @data = eu_client.content_types.first
+      expect(@data.title).not_to be nil
+    end
+
+    it "has method called title with data from custom client" do
+      @data = custom_host_client.content_types.first
+      expect(@data.title).not_to be nil
+    end
 
     it "has method called uid with data" do
       @data = client.content_types.first
@@ -34,6 +46,11 @@ describe Contentstack::ContentType do
       @data = client.content_types.first
       expect(@data.attributes).not_to be nil
     end
+
+    it "Should get content type from uid" do
+      @data = client.content_type("category").fetch
+      expect(@data.attributes).not_to be nil
+    end
   end
 
   describe "Initialized using class" do

data/spec/contentstack_spec.rb

@@ -3,8 +3,30 @@ require_relative '../lib/contentstack.rb'
 
 describe Contentstack do
   let(:client) { create_client }
+  let(:eu_client) { create_client('DELIVERY_TOKEN_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
+  let(:custom_host_client) { create_client('DELIVERY_TOKEN_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
 
   it "has a version number" do
     expect(Contentstack::VERSION).not_to be nil
   end
+
+  it "has region data" do
+    expect(Contentstack::Region::EU).not_to be 'eu'
+    expect(Contentstack::Region::US).not_to be 'us'
+  end
+
+  it "has default host and region" do
+    expect(client.region).to eq Contentstack::Region::US
+    expect(client.host).to eq 'https://cdn.contentstack.io'  
+  end
+
+  it "has custom region with region host" do
+    expect(eu_client.region).to eq Contentstack::Region::EU
+    expect(eu_client.host).to eq 'https://eu-cdn.contentstack.com'  
+  end
+
+  it "has custom host" do
+    expect(custom_host_client.host).to eq 'https://custom-cdn.contentstack.com'  
+  end
+
 end

data/spec/entry_spec.rb

@@ -3,6 +3,10 @@ require_relative '../lib/contentstack.rb'
 
 describe Contentstack::Entry do
   let(:client) { create_client }
+  let(:uid) { "blt05056a2f5e0ebf76" }
+
+  let(:category) {client.content_type("category").entry(uid)}
+  let(:product) {client.content_type("product").entry(uid)}
 
   it "Contentstack::EntryCollection should have Contentstack::Entry instance" do
     data = client.content_type("category").query.fetch
@@ -11,13 +15,75 @@ describe Contentstack::Entry do
   end
 
   it "is an instance of Contentstack::Entry if single entry is fetched" do
-    data = client.content_type("category").entry("blt05056a2f5e0ebf76").fetch
+    data = category.fetch
     expect(data.class).to eq Contentstack::Entry
   end
 
   it 'has a method `get` to get attributes data' do
-    uid = "blt05056a2f5e0ebf76"
-    data = client.content_type("category").entry(uid).fetch
+    data = category.fetch
     expect(data.get('uid')).to eq uid
   end
+
+  it "should set locale the in the request entry" do
+    data = category.locale('en-us')
+    expect(data.query[:locale]).to eq 'en-us'
+  end
+
+  it "should get data using `only` method with string parameter" do
+    data = category.fetch
+    expect(data.fields[:title]).not_to be nil
+    expect(data.fields[:uid]).not_to be nil
+  end
+
+  it "should get data using `only` method with array parameter" do
+    data = category.only(["title"]).fetch
+    expect(data.fields[:title]).not_to be nil
+    expect(data.fields[:uid]).not_to be nil
+  end
+
+  it "should get data using `except` method with string parameter" do
+    data = category.except("category_tags").fetch
+    expect(data.fields[:category_tags]).to be nil
+  end
+
+  it "should get data using `except` method with array parameter" do
+    data = category.except(["description"]).fetch
+    expect(data.fields[:description]).to be nil
+  end
+
+  it "should get data using `only` method for reference fields" do
+    data = product.include_reference('categories').only("categories", ["title", "description"]).fetch
+    expect(data.fields[:categories][0][:title]).to eq "Smartphones"
+  end
+
+  it "should get data using `except` method for reference fields" do
+    data = product.include_reference('categories').except("categories", "title").fetch
+    expect(data.fields[:categories][0][:title]).to eq 'Smartphones'
+  end
+  
+  it "should get data using `include_schema` method" do
+    data = category.include_schema.fetch
+    expect(data.schema).not_to be nil
+  end
+
+  it "should get data using `include_owner` method" do
+    data = product.include_owner.fetch
+    expect(data.fields[:_owner]).not_to be nil
+  end
+
+  it "should get data using `include_owner` method" do
+    data = product.include_fallback.fetch
+    expect(data.fields[:locale]).not_to be nil
+  end
+
+  it "should get data using `include_content_type` method" do
+    data = category.include_content_type.fetch
+    expect(data.content_type).not_to be nil
+  end
+  
+  it "should get data using `include_reference` method" do
+    data = product.include_reference('categories').fetch
+    puts data.get("categories.title")
+    expect(data.fields[:categories][0][:title]).not_to be nil
+  end
 end

data/spec/fixtures/category_content_type.json

@@ -0,0 +1 @@
+{"content_type":{"created_at":"2017-09-28T06:04:02.500Z","updated_at":"2017-09-28T07:13:13.612Z","title":"Product","uid":"product","inbuilt_class":false,"schema":[{"display_name":"Title","uid":"title","data_type":"text","mandatory":true,"unique":true,"field_metadata":{"_default":true},"multiple":false},{"display_name":"URL","uid":"url","data_type":"text","mandatory":false,"field_metadata":{"_default":true},"multiple":false,"unique":false},{"data_type":"text","display_name":"Price","uid":"price","field_metadata":{"description":"","default_value":""},"format":"","error_messages":{"format":""},"multiple":false,"mandatory":false,"unique":false},{"data_type":"text","display_name":"Discounted Price","uid":"discounted_price","field_metadata":{"description":"","default_value":""},"format":"","error_messages":{"format":""},"multiple":false,"mandatory":false,"unique":false},{"data_type":"file","display_name":"Featured Image","uid":"featured_image","extensions":[],"field_metadata":{"description":"","rich_text_type":"standard"},"multiple":false,"mandatory":false,"unique":false},{"data_type":"file","display_name":"Product Images","uid":"product_images","extensions":[],"field_metadata":{"description":"","rich_text_type":"standard"},"multiple":true,"mandatory":false,"unique":false},{"data_type":"text","display_name":"Description","uid":"description","field_metadata":{"description":"","default_value":"","multiline":true},"format":"","error_messages":{"format":""},"multiple":false,"mandatory":false,"unique":false},{"data_type":"reference","display_name":"Categories","reference_to":"category","field_metadata":{"ref_multiple":true},"uid":"categories","multiple":false,"mandatory":false,"unique":false},{"data_type":"reference","display_name":"Related Products","reference_to":"product","field_metadata":{"ref_multiple":true},"uid":"related_products","mandatory":false,"multiple":false,"unique":false}],"last_activity":{"environments":[{"uid":"blt922581483b3573b4","details":[{"locale":"en-us","time":"2017-09-28T09:43:24.028Z"}]}]},"maintain_revisions":true,"description":"","options":{"is_page":true,"singleton":false,"title":"title","sub_title":[],"url_pattern":"/:unique_id","url_prefix":"/products/"},"abilities":{"get_one_object":true,"get_all_objects":true,"create_object":true,"update_object":true,"delete_object":true,"delete_all_objects":true},"DEFAULT_ACL":{"others":{"read":false,"create":false},"users":[{"uid":"blt249905a2fc79092e","read":true,"sub_acl":{"read":true}}]},"SYS_ACL":{"others":{"read":false,"create":false,"update":false,"delete":false,"sub_acl":{"read":false,"create":false,"update":false,"delete":false,"publish":false}},"roles":[{"uid":"bltdbf78d599f92b0c9","read":true,"create":false,"update":false,"delete":false,"sub_acl":{"read":true,"create":true,"update":true,"delete":true,"publish":true}},{"uid":"blt344db9f3f8011ce2","read":true,"create":true,"update":true,"delete":true,"sub_acl":{"read":true,"create":true,"update":true,"delete":true,"publish":true}}]}}}

data/spec/fixtures/category_entry.json

@@ -1 +1 @@
-{"entry":{"title":"Apple Products","tags":[],"locale":"en-us","uid":"blt05056a2f5e0ebf76","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:08:21.276Z","updated_at":"2017-09-28T06:08:21.276Z","ACL":{},"_version":1}}
+{"entry":{"title":"Apple Products","tags":[],"locale":"en-us","uid":"blt05056a2f5e0ebf76","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:08:21.276Z","updated_at":"2017-09-28T06:08:21.276Z","ACL":{},"_version":1}, "schema":[{"display_name":"Title","uid":"title","data_type":"text","mandatory":true,"unique":true,"field_metadata":{"_default":true},"multiple":false},{"data_type":"text","display_name":"Description","uid":"description","field_metadata":{"description":"","default_value":"","multiline":true},"format":"","error_messages":{"format":""},"multiple":false,"mandatory":false,"unique":false}],"content_type":{"created_at":"2017-08-28T11:26:16.005Z","updated_at":"2017-08-28T11:26:28.217Z","title":"Category","uid":"category","inbuilt_class":false,"schema":[{"display_name":"Title","uid":"title","data_type":"text","mandatory":true,"unique":true,"field_metadata":{"_default":true},"multiple":false},{"data_type":"text","display_name":"Description","uid":"description","field_metadata":{"description":"","default_value":"","multiline":true},"format":"","error_messages":{"format":""},"multiple":false,"mandatory":false,"unique":false}],"last_activity":{"environments":[{"uid":"bltc5173a61bc94f944","details":[{"locale":"en-us","time":"2017-09-28T09:37:14.441Z"}]}]},"maintain_revisions":true,"description":"","options":{"is_page":false,"singleton":false,"title":"title","sub_title":[]},"abilities":{"get_one_object":true,"get_all_objects":true,"create_object":true,"update_object":true,"delete_object":true,"delete_all_objects":true},"DEFAULT_ACL":{"others":{"read":false,"create":false},"users":[{"uid":"blt8360496f808a5408","read":true,"sub_acl":{"read":true}}]}}}

data/spec/fixtures/product_entry.json

@@ -1 +1 @@
-{"entry":{"title":"Motorola Moto X4","url":"/products/blt70d3d8c86c566079","price":"500","discounted_price":"450","featured_image":{"uid":"bltcf9489a3cf1eaa00","created_at":"2017-09-28T07:02:20.745Z","updated_at":"2017-09-28T07:02:20.745Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"311812","tags":[],"filename":"1.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltcf9489a3cf1eaa00/59cc9e7c75d9f7760dfc33eb/download","ACL":{},"is_dir":false,"_version":1,"title":"1.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},"product_images":[{"uid":"bltcf9489a3cf1eaa00","created_at":"2017-09-28T07:02:20.745Z","updated_at":"2017-09-28T07:02:20.745Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"311812","tags":[],"filename":"1.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltcf9489a3cf1eaa00/59cc9e7c75d9f7760dfc33eb/download","ACL":{},"is_dir":false,"_version":1,"title":"1.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt49a8b46c6839be12","created_at":"2017-09-28T07:02:30.108Z","updated_at":"2017-09-28T07:02:30.108Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"4226","tags":[],"filename":"2.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt49a8b46c6839be12/59cc9e86462a293417404402/download","ACL":{},"is_dir":false,"_version":1,"title":"2.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"bltb545ae58b0ab72bb","created_at":"2017-09-28T07:02:32.375Z","updated_at":"2017-09-28T07:02:32.375Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"5755","tags":[],"filename":"3.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltb545ae58b0ab72bb/59cc9e8895fd2a0a0daa742a/download","ACL":{},"is_dir":false,"_version":1,"title":"3.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt6af2dddde9d35e3c","created_at":"2017-09-28T07:02:36.507Z","updated_at":"2017-09-28T07:02:36.507Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"312464","tags":[],"filename":"4.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt6af2dddde9d35e3c/59cc9e8c75d9f7760dfc33f1/download","ACL":{},"is_dir":false,"_version":1,"title":"4.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}}],"description":"dual cameras.\nsingular design.\nAdvanced dual rear cameras for your best photos yet. Plus, a beautiful contoured glass and metal frame with an IP68 water resistance rating.* Coming soon.","categories":[{"title":"Smartphones","tags":[],"locale":"en-us","uid":"bltccd0ea06c1da94fd","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:07:37.132Z","updated_at":"2017-09-28T06:07:37.132Z","ACL":{},"_version":1,"publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.932Z","user":"sys_bltcbfe73b68603b243"},"_publish_environment":"blt922581483b3573b4","_publish_locale":"en-us","_publish_scheduled":false}],"related_products":[{"title":"OnePlus 3T A3000 64GB Gunmetal","url":"/products/bltc37f44d9bc85f3ec","price":"539","discounted_price":"499","featured_image":{"uid":"blt2f02748d62b5d9df","created_at":"2017-09-28T06:56:13.016Z","updated_at":"2017-09-28T06:56:13.016Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"40674","tags":[],"filename":"one-plus-three-1x.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt2f02748d62b5d9df/59cc9d0d95fd2a0a0daa7424/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-three-1x.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:37.885Z","user":"sys_bltcbfe73b68603b243"}},"product_images":[{"uid":"blt2f02748d62b5d9df","created_at":"2017-09-28T06:56:13.016Z","updated_at":"2017-09-28T06:56:13.016Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"40674","tags":[],"filename":"one-plus-three-1x.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt2f02748d62b5d9df/59cc9d0d95fd2a0a0daa7424/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-three-1x.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:37.885Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"bltf061d797179b0013","created_at":"2017-09-28T06:56:20.954Z","updated_at":"2017-09-28T06:56:20.954Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"13187","tags":[],"filename":"one-plus-3-2.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltf061d797179b0013/59cc9d1475d9f7760dfc33e5/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-3-2.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:31.431Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt7469869415aa6d33","created_at":"2017-09-28T06:56:24.656Z","updated_at":"2017-09-28T06:56:24.656Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"27485","tags":[],"filename":"one-plus-3-3.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt7469869415aa6d33/59cc9d183ef8e08c0d90ce29/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-3-3.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:26.882Z","user":"sys_bltcbfe73b68603b243"}}],"description":"Snapdragon 821 6gb RAM Unlocked Smartphone","categories":["bltccd0ea06c1da94fd"],"related_products":["blt6c4014da5a782a25"],"tags":[],"locale":"en-us","uid":"bltc37f44d9bc85f3ec","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:57:55.574Z","updated_at":"2017-09-28T06:57:55.574Z","ACL":{},"_version":1,"publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.933Z","user":"sys_bltcbfe73b68603b243"},"_publish_environment":"blt922581483b3573b4","_publish_locale":"en-us","_publish_scheduled":false}],"tags":[],"locale":"en-us","uid":"blt70d3d8c86c566079","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T07:03:11.350Z","updated_at":"2017-09-28T07:03:11.350Z","ACL":{},"_version":1}}
+{"entry":{"title":"Motorola Moto X4","url":"/products/blt70d3d8c86c566079","price":"500","discounted_price":"450","featured_image":{"uid":"bltcf9489a3cf1eaa00","created_at":"2017-09-28T07:02:20.745Z","updated_at":"2017-09-28T07:02:20.745Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"311812","tags":[],"filename":"1.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltcf9489a3cf1eaa00/59cc9e7c75d9f7760dfc33eb/download","ACL":{},"is_dir":false,"_version":1,"title":"1.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},"product_images":[{"uid":"bltcf9489a3cf1eaa00","created_at":"2017-09-28T07:02:20.745Z","updated_at":"2017-09-28T07:02:20.745Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"311812","tags":[],"filename":"1.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltcf9489a3cf1eaa00/59cc9e7c75d9f7760dfc33eb/download","ACL":{},"is_dir":false,"_version":1,"title":"1.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt49a8b46c6839be12","created_at":"2017-09-28T07:02:30.108Z","updated_at":"2017-09-28T07:02:30.108Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"4226","tags":[],"filename":"2.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt49a8b46c6839be12/59cc9e86462a293417404402/download","ACL":{},"is_dir":false,"_version":1,"title":"2.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"bltb545ae58b0ab72bb","created_at":"2017-09-28T07:02:32.375Z","updated_at":"2017-09-28T07:02:32.375Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"5755","tags":[],"filename":"3.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltb545ae58b0ab72bb/59cc9e8895fd2a0a0daa742a/download","ACL":{},"is_dir":false,"_version":1,"title":"3.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt6af2dddde9d35e3c","created_at":"2017-09-28T07:02:36.507Z","updated_at":"2017-09-28T07:02:36.507Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"312464","tags":[],"filename":"4.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt6af2dddde9d35e3c/59cc9e8c75d9f7760dfc33f1/download","ACL":{},"is_dir":false,"_version":1,"title":"4.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.919Z","user":"sys_bltcbfe73b68603b243"}}],"description":"dual cameras.\nsingular design.\nAdvanced dual rear cameras for your best photos yet. Plus, a beautiful contoured glass and metal frame with an IP68 water resistance rating.* Coming soon.","categories":[{"title":"Smartphones","tags":[],"locale":"en-us","uid":"bltccd0ea06c1da94fd","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:07:37.132Z","updated_at":"2017-09-28T06:07:37.132Z","ACL":{},"_version":1,"publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.932Z","user":"sys_bltcbfe73b68603b243"},"_publish_environment":"blt922581483b3573b4","_publish_locale":"en-us","_publish_scheduled":false}],"related_products":[{"title":"OnePlus 3T A3000 64GB Gunmetal","url":"/products/bltc37f44d9bc85f3ec","price":"539","discounted_price":"499","featured_image":{"uid":"blt2f02748d62b5d9df","created_at":"2017-09-28T06:56:13.016Z","updated_at":"2017-09-28T06:56:13.016Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"40674","tags":[],"filename":"one-plus-three-1x.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt2f02748d62b5d9df/59cc9d0d95fd2a0a0daa7424/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-three-1x.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:37.885Z","user":"sys_bltcbfe73b68603b243"}},"product_images":[{"uid":"blt2f02748d62b5d9df","created_at":"2017-09-28T06:56:13.016Z","updated_at":"2017-09-28T06:56:13.016Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"40674","tags":[],"filename":"one-plus-three-1x.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt2f02748d62b5d9df/59cc9d0d95fd2a0a0daa7424/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-three-1x.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:37.885Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"bltf061d797179b0013","created_at":"2017-09-28T06:56:20.954Z","updated_at":"2017-09-28T06:56:20.954Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"13187","tags":[],"filename":"one-plus-3-2.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/bltf061d797179b0013/59cc9d1475d9f7760dfc33e5/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-3-2.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:31.431Z","user":"sys_bltcbfe73b68603b243"}},{"uid":"blt7469869415aa6d33","created_at":"2017-09-28T06:56:24.656Z","updated_at":"2017-09-28T06:56:24.656Z","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","content_type":"image/jpeg","file_size":"27485","tags":[],"filename":"one-plus-3-3.jpg","url":"https://images.contentstack.io/v3/assets/bltc46be1ce6b7e1e24/blt7469869415aa6d33/59cc9d183ef8e08c0d90ce29/download","ACL":{},"is_dir":false,"_version":1,"title":"one-plus-3-3.jpg","publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:42:26.882Z","user":"sys_bltcbfe73b68603b243"}}],"description":"Snapdragon 821 6gb RAM Unlocked Smartphone","categories":["bltccd0ea06c1da94fd"],"related_products":["blt6c4014da5a782a25"],"tags":[],"locale":"en-us","uid":"bltc37f44d9bc85f3ec","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T06:57:55.574Z","updated_at":"2017-09-28T06:57:55.574Z","ACL":{},"_version":1,"publish_details":{"environment":"blt922581483b3573b4","locale":"en-us","time":"2017-09-28T09:28:47.933Z","user":"sys_bltcbfe73b68603b243"},"_publish_environment":"blt922581483b3573b4","_publish_locale":"en-us","_publish_scheduled":false}],"tags":[],"locale":"en-us","uid":"blt70d3d8c86c566079","created_by":"sys_bltcbfe73b68603b243","updated_by":"sys_bltcbfe73b68603b243","created_at":"2017-09-28T07:03:11.350Z","updated_at":"2017-09-28T07:03:11.350Z","ACL":{},"_version":1, "_owner":{"uid":"sys_bltcbfe73b68603b243","created_at":"2012-11-26T09:45:10.000Z","updated_at":"2017-09-15T16:06:07.920Z","email":"rohit.sharma@raweng.com","username":"rohit.sharma_blt50c79ab1","first_name":"Rohit","last_name":"Sharma","company":"raw engineering inc.","plan_id":["cms_plan"],"org_uid":["blt821f82ffcc171fed"]}}}

data/spec/query_spec.rb

@@ -54,7 +54,7 @@ describe Contentstack::Query do
   it "should get data using `include_count` method" do
     data = category_query.include_count.fetch
     expect(data.count).not_to be nil
-    expect(data.count.class).to be Integer
+    expect(data.count).to eq 5
   end
 
   it "should get data using `only` method with string parameter" do
@@ -147,6 +147,11 @@ describe Contentstack::Query do
     expect(data.first.fields[:_owner]).not_to be nil
   end
   
+  it "should get data using `include_owner` method" do
+    data = product_query.include_fallback.fetch
+    expect(data.first.fields[:locale]).not_to be nil
+  end
+
   it "should get data using `include_draft` method" do
     data = category_query.include_draft.fetch
     expect(data.length).to eq 5
@@ -185,4 +190,9 @@ describe Contentstack::Query do
     data = category_query.or([q1,q2]).fetch
     expect(data.length).to eq 5
   end
+
+  it "should set locale the in the request query" do
+    data =  product_query.locale('en-us')
+    expect(data.query[:locale]).to eq 'en-us'
+  end
 end

data/spec/spec_helper.rb

@@ -107,10 +107,22 @@ RSpec.configure do |config|
 =end
 
   config.before(:each) do
-    stub_request(:get, /cdn.contentstack.io\/v3\/content_types/).
+    stub_request(:get, /custom-cdn.contentstack.com\/v3\/content_types/).
+      with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/content_types.json'), :headers => {})
+
+    stub_request(:get, /eu-cdn.contentstack.com\/v3\/content_types/).
       with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
       to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/content_types.json'), :headers => {})
 
+    stub_request(:get, /cdn.contentstack.io\/v3\/content_types/).
+      with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/content_types.json'), :headers => {})
+    
+    stub_request(:get, /cdn.contentstack.io\/v3\/content_types\/category/).
+      with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/category_content_type.json'), :headers => {})
+    
     stub_request(:get, /cdn.contentstack.io\/v3\/assets/).
       with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
       to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/asset_collection.json'), :headers => {})
@@ -140,7 +152,7 @@ RSpec.configure do |config|
       to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/category_entry.json'), :headers => {})
   end
 
-  def create_client(access_token = ENV['ACCESS_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['STACK_ENV'])
-    Contentstack::Client.new(access_token, api_key, environment)
+  def create_client(delivery_token = ENV['ACCESS_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['STACK_ENV'], options = {})
+    Contentstack::Client.new(delivery_token, api_key, environment, options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.1
 platform: ruby
 authors:
-- Rohit Sharma
-autorequire: 
+- Contentstack
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,44 +68,23 @@ dependencies:
         version: '0'
 description: Contentstack Ruby client for the Content Delivery API
 email:
-- rubygems@contentstack.com
+- support@contentstack.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - contentstack.gemspec
 - coverage/.last_run.json
 - coverage/.resultset.json
 - coverage/.resultset.json.lock
-- coverage/assets/0.10.2/application.css
-- coverage/assets/0.10.2/application.js
-- coverage/assets/0.10.2/colorbox/border.png
-- coverage/assets/0.10.2/colorbox/controls.png
-- coverage/assets/0.10.2/colorbox/loading.gif
-- coverage/assets/0.10.2/colorbox/loading_background.png
-- coverage/assets/0.10.2/favicon_green.png
-- coverage/assets/0.10.2/favicon_red.png
-- coverage/assets/0.10.2/favicon_yellow.png
-- coverage/assets/0.10.2/loading.gif
-- coverage/assets/0.10.2/magnify.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png
 - coverage/index.html
 - lib/contentstack.rb
 - lib/contentstack/api.rb
@@ -117,6 +96,7 @@ files:
 - lib/contentstack/entry_collection.rb
 - lib/contentstack/error.rb
 - lib/contentstack/query.rb
+- lib/contentstack/region.rb
 - lib/contentstack/version.rb
 - lib/util.rb
 - rakefile.rb
@@ -128,6 +108,7 @@ files:
 - spec/entry_spec.rb
 - spec/fixtures/asset.json
 - spec/fixtures/asset_collection.json
+- spec/fixtures/category_content_type.json
 - spec/fixtures/category_entry.json
 - spec/fixtures/category_entry_collection.json
 - spec/fixtures/category_entry_collection_without_count.json
@@ -136,11 +117,11 @@ files:
 - spec/fixtures/product_entry_collection.json
 - spec/query_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/builtio-contentstack/contentstack-ruby
+homepage: https://github.com/contentstack/contentstack-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,16 +129,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Contentstack Ruby client for the Content Delivery API
 test_files: []

data/README.rdoc

@@ -1,61 +0,0 @@
-= Contentstack Ruby SDK
-
-<i>Use Built.io Contentstack to power content for your Ruby projects</i>
-
-Create Ruby based applications and use the Ruby SDK to fetch and deliver content from Built.io Contentstack. The SDK uses Content Delivery APIs.
-
-== Getting Started
-
-This guide will help you get started with our Ruby SDK to build apps powered by Built.io Contentstack.
-
-=== SDK Installation and Setup
-
-To use the Ruby SDK, download it using the gem install command
-
-  $ gem install contentstack
-
-=== Initialize SDK
-
-You will need to specify the API key, Access token, and Environment Name of your stack to initialize the SDK:
-
-  @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
-
-Once you have initialized the SDK, you can start getting content in your app.
-
-=== Basic Queries
-
-==== Get a Single Entry
-
-To get a single entry, you need to specify the content type as well as the uid of the entry.
-
-  entry = @stack.content_type('content_type_uid').entry("entry_uid").fetch
-  puts entry.get('title') # Use `get` method to retrieve field value by providing a field's unique ID
-
-==== Get Multiple Entries
-
-To retrieve multiple entries of a content type, you need to specify the content type uid. You can also specify search parameters to filter results.
-
-  @query = @stack.content_type('blog').query
-  @entries = @query.where('title', 'welcome')
-                   .include_schema
-                   .include_count
-                   .fetch
-
-  puts "Total Entries -- #{@entries.count}"
-  @entries.each{|entry| puts "#{entry.get('title')}" }
-
-
-== API Reference
-
-Go through our SDK API Reference guide to know about the methods that can be used to query your content in Built.io Contentstack.
-
-{Read Ruby SDK API Reference Guide}[http://www.rubydoc.info/gems/contentstack/0.0.1]
-
-
-== Example Apps
-
-To help you get started, we have created some sample applications that are powered by Built.io Contentstack Ruby SDK. Click on any of the links below to read the tutorials of the app, view app demo, or download the code from GitHub. 
-
-{Product Catalog}[#]
-
-Built.io Contentstack provides Ruby SDK using which you can create applications based on Ruby, or any other web frameworks created using Ruby.