contentstack 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2009d779c953b80883a4d8c8d267cca918c3a784450513643f308ae79645c1
-  data.tar.gz: 4a48fc25a61c332e8f338941828b87836db709eb0c7f819b5e926f1d264ae5d7
+  metadata.gz: 671d9ee269ba5d1ab29949d9c76c55c74fa6b27567c5810ef72992cbcac698d5
+  data.tar.gz: 40e49c3028c79f1a9b54556a739d29aa745c9c280523b5bb166b3297f39db965
 SHA512:
-  metadata.gz: 1c74b89fabfe984e5d068cc6a1c1dcf40b8d098730959677572e71f7f6c0f989bd82d131b87f23f66f83a80c73104197fa008d7ba3685baaf491f2fe214f829a
-  data.tar.gz: e3d42fd8f4fc573a08dae949fe85d0576a7bc9290e724941468439f8afe4093f979b7f992c0572667e0942fe7a9c262ca8b3c42d13f5a7d8c762c9e02695f39a
+  metadata.gz: 455dce0b18e04b9bb7e129466c01f083497c0f80a9dcb99a6ed80c8c3f22c16bd65a2a46f3bf2191f65f7020a549b5a80292cf5cc945860f75438c4ff1ed0229
+  data.tar.gz: 5ac68f4344f8aff3de2964f452cf34591caef69a3ed29af9c58d0a32d0acaff74a278927a7cc602cf24aec379c6df9e3edbbb3b836e9d35aee28a2d610d9ff16

data/.gitignore

@@ -8,4 +8,4 @@ coverage
 .DS_Store
 .bundle/
 */rspec_results.html
-vendor/
+vendor/

data/Gemfile

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

data/Gemfile.lock

@@ -1,61 +1,75 @@
+PATH
+  remote: .
+  specs:
+    contentstack (0.2.0)
+      activesupport (> 3.2.5)
+      contentstack_utils (~> 1.0.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
+    activesupport (6.1.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)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     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)
+    concurrent-ruby (1.1.8)
+    contentstack_utils (1.0.0)
+      activesupport (~> 6.1.0)
+      nokogiri (~> 1.11.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     hashdiff (1.0.1)
-    i18n (1.8.2)
+    i18n (1.8.10)
       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)
+    minitest (5.14.4)
+    nokogiri (1.11.2-arm64-darwin)
+      racc (~> 1.4)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       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)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
       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)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.11.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.25)
-    zeitwerk (2.3.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  universal-darwin-19
 
 DEPENDENCIES
-  activesupport
-  rspec
-  simplecov
-  webmock
-  yard
+  contentstack!
+  rspec (~> 3.10.0)
+  simplecov (~> 0.21.1)
+  webmock (~> 3.11.0)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
-   2.1.4
+   2.2.7

data/contentstack.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', "> 3.2.5"
-
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'webmock'
-  s.add_development_dependency 'simplecov'
+  s.add_dependency 'activesupport', "~> 3.2"
+  s.add_dependency "contentstack_utils", "~> 1.0.0"
+  
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'webmock', '~> 3.11.0'
+  s.add_development_dependency 'simplecov', '~> 0.21.1'
+  s.add_development_dependency 'yard', '~> 0.9.26'
 end

data/lib/contentstack.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "contentstack/version"
 require "contentstack/client"
 require "contentstack/region"
+require "contentstack_utils"
 require "util"
 
 
@@ -22,4 +23,7 @@ require "util"
 # ==== Query entries
 #   @stack.content_type('blog').query.regex('title', '.*hello.*').fetch
 module Contentstack
+    def self.render_content(content, options)
+        ContentstackUtils.render_content(content, options)
+    end
 end

data/lib/contentstack/entry.rb

@@ -152,6 +152,19 @@ module Contentstack
       self
     end
 
+    # Include Embedded Objects (Entries and Assets) along with entry/entries details.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_embedded_items
+    #
+    # @return [Contentstack::Query]
+    def include_embedded_items()
+      @query[:include_embedded_items] = ['BASE']
+      self
+    end
+
     #
     # @return [Contentstack::Query]
     def include(field_uids)

data/lib/contentstack/query.rb

@@ -516,6 +516,19 @@ module Contentstack
       self
     end
 
+    # Include Embedded Objects (Entries and Assets) along with entry/entries details.
+    #
+    # Example
+    #
+    #    @query = @stack.content_type('product').query
+    #    @query.include_embedded_items
+    #
+    # @return [Contentstack::Query]
+    def include_embedded_items()
+      @query[:include_embedded_items] = ['BASE']
+      self
+    end
+
     # Include objects in 'Draft' mode in response
     #
     # Example

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/entry_spec.rb

@@ -4,7 +4,6 @@ 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)}
 
@@ -86,4 +85,10 @@ describe Contentstack::Entry do
     puts data.get("categories.title")
     expect(data.fields[:categories][0][:title]).not_to be nil
   end
+
+  it "should get data using `include_embedded_items` method" do
+    data = product.include_embedded_items().fetch
+    puts data.get("categories.title")
+    expect(data.fields[:categories][0][:title]).not_to be nil
+  end
 end

data/spec/spec_helper.rb

@@ -160,4 +160,8 @@ RSpec.configure do |config|
   def create_client(delivery_token = ENV['DELIVERY_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['ENVIRONMENT'], options = {})
     Contentstack::Client.new(api_key, delivery_token, environment, options)
   end
+
+  def render(content, entry)
+    Contentstack.render_content(content, ContentstackUtils::Model::Options.new(entry))
+  end
 end

metadata

@@ -1,71 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Contentstack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: contentstack_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
 description: Contentstack Ruby client for the Content Delivery API
 email:
 - support@contentstack.com