contentful_bootstrap 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1ca35ef188d6a3d38b7c2f97eae1d7f2ac3d815
-  data.tar.gz: 79ab058638c98f8c151de7fb932ff644707ffef5
+  metadata.gz: 4d0bf2dba800e936efa11794d15440a1da64db05
+  data.tar.gz: 9af2801f2a777c99d2dd4f46bb6323964b7592a9
 SHA512:
-  metadata.gz: 522a5774bb87c0efd7a969572c580c77a498d5eb3460bfec192c1782e0e9736591761ee87e57e9d4837c7e8f8cd6fd62f09b62940c9fbd66c3984620bf8d94f4
-  data.tar.gz: 3aa214a216e55b2af983e532a9dc5a44d1e74fa8594174cb9fc45c2e254f4894e9f7c373041c59bf0b82313ade49529fd54163f08e1003b04628f190aa97d38a
+  metadata.gz: 9de02a76a5062f9c084f886168c9d41d800cb72d44bfdab9c8437e61ed9dbab30b1d0d4bdfb821e9bb95262ff86aaabe3f831f37a4f64a86e88bdebe07d6feb1
+  data.tar.gz: 0b37f36ec8d8b5cd26112f071180bcbdaa1838ec239b485bb1f22dbdd2f32bda827e6d6fcd8a6cbf8d73046a722db6130d5744ec39a15f5edea703f3a555e33d

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## v3.9.0
+### Fixed
+* Fixed `quiet` not being forwarded properly to `generate_json` and `update_space`
+* Fixed `X-Contentful-User-Agent` headers now use `application` instead of `integration` header.
+
+### Added
+* Added `--use-preview` flag to `generate_json` command [#62](https://github.com/contentful/contentful-bootstrap.rb/issues/62)
+* Added `--no-publish` flag to `create_space` and `update_space` commands [#62](https://github.com/contentful/contentful-bootstrap.rb/issues/62)
+
+### Changed
+* `generate_json` now imports all available content in your space [#62](https://github.com/contentful/contentful-bootstrap.rb/issues/62)
+* Assets can now be updated when using `update_space`.
+
 ## v3.8.0
 ### Changed
 * Changed `Contentful::Bootstrap::CreateCommand#organizations` to use the new public `/organizations` endpoint.

data/README.md

@@ -26,7 +26,7 @@ $ gem install contentful_bootstrap
 You can create spaces by doing:
 
 ```bash
-$ contentful_bootstrap create_space <space_name> [--template template_name] [--json-template template_path] [--locale locale_code] [--mark-processed] [--config CONFIG_PATH] [--quiet]
+$ contentful_bootstrap create_space <space_name> [--template template_name] [--json-template template_path] [--locale locale_code] [--mark-processed] [--no-publish] [--config CONFIG_PATH] [--quiet]
 ```
 
 You can also generate new Delivery API Tokens by doing:
@@ -38,13 +38,13 @@ $ contentful_bootstrap generate_token <space_id> [--name token_name] [--config C
 You can also generate JSON Templates from existing spaces by doing:
 
 ```bash
-$ contentful_bootstrap generate_json <space_id> <delivery_api_access_token> [--output-file OUTPUT PATH] [--content-types-only] [--quiet]
+$ contentful_bootstrap generate_json <space_id> <delivery_api_access_token> [--output-file OUTPUT PATH] [--content-types-only] [--use-preview] [--quiet]
 ```
 
 You can update existing spaces from JSON Templates by doing:
 
 ```bash
-$ contentful_bootstrap update_space <space_id> -j template_path [--mark-processed] [--skip-content-types] [--quiet]
+$ contentful_bootstrap update_space <space_id> -j template_path [--mark-processed] [--skip-content-types] [--no-publish] [--quiet]
 ```
 
 ### Built-in templates
@@ -89,6 +89,7 @@ options = {
   json_template: "/path/to/template.json", # Will use the JSON file specified as a Template
   locale: "es-AR", # Will create the space with the specified locale code as default locale, defaults to "en-US"
   mark_processed: false, # if true will mark all resources as 'bootstrapProcessed' and will be avoided for update_space calls (doesnt affect create_space)
+  no_publish: false, # if true it won't publish your entries or assets
   trigger_oauth: true, # if true will trigger OAuth process
   quiet: false, # if true will not output to STDOUT
   no_input: false # if true all input operations won't be done, exceptions thrown with alternatives through configuration file in cases in which it cannot proceed
@@ -105,6 +106,7 @@ options = {
   mark_processed: false, # if true will mark all resources as 'bootstrapProcessed and will be avoided on future update_space calls
   trigger_oauth: true, # if true will trigger OAuth process
   skip_content_types: false, # if true will avoid creating the content types
+  no_publish: false, # if true it won't publish your entries or assets
   quiet: false, # if true will not output to STDOUT
   no_input: false # if true all input operations won't be done, exceptions thrown with alternatives through configuration file in cases in which it cannot proceed
 }
@@ -134,10 +136,12 @@ To Generate a JSON Template from an exising Space
 ```ruby
 Contentful::Bootstrap::CommandRunner.new.generate_json(
   "space_id",
-  access_token: "delivery_api_access_token",
+  access_token: "delivery_or_preview_api_access_token",
+  use_preview: false, # if true will fetch from the Preview API instead of Delivery API
   filename: nil, # path to file in which to store JSON
   content_types_only: false, # if true will not fetch Entries and Assets
-  quiet: false # if true will not output to STDOUT - only when filename is provided
+  quiet: false, # if true will not output to STDOUT - only when filename is provided
+  no_input: false # if true all input operations won't be done, exceptions thrown with alternatives through configuration file in cases in which it cannot proceed
 )
 ```
 
@@ -147,7 +151,9 @@ Additionally, you can send an options hash with the following keys:
 ```ruby
 options = {
   access_token: "access_token" # REQUIRED
+  use_preview: false, # if true will fetch from the Preview API instead of Delivery API
   filename: "template.json", # Will save the JSON to the specified file
+  content_types_only: false, # if true will not fetch Entries and Assets
   quiet: false, # if true will not output to STDOUT
   no_input: false # if true all input operations won't be done, exceptions thrown with alternatives through configuration file in cases in which it cannot proceed
 }
@@ -186,6 +192,37 @@ a common baseline. You can find a complete example [here](./examples/templates/c
 Using the `--mark-processed` option alongside `--json-template` will mark all resources as `bootstrapProcessed`,
 which will make it so `update_space` calls avoid already created resources. (A resource being either a Content Type, Entry or Asset).
 
+## Workflow for backing up draft/updated content
+
+In many cases, you want to have a dump of your whole space, including draft/updated content.
+To achieve this, do the following:
+
+1. Export the content:
+
+```bash
+# Export published content
+contentful_bootstrap generate_json <SPACE_ID> <DELIVERY_TOKEN> -o bootstrap-published.json
+
+# Export draft/updated content
+contentful_bootstrap generate_json <SPACE_ID> <PREVIEW_TOKEN> -o bootstrap-preview.json --use-preview
+```
+
+> Notice that on the second command we're using the `--use-preview` flag to use the Preview API to fetch the content.
+
+2. Create or update a space with the templates:
+
+```bash
+# Import published content
+contentful_bootstrap update_space <SPACE_ID> -j bootstrap-published.json
+
+# Import draft/updated content
+contentful_bootstrap update_space <SPACE_ID> -j bootstrap-preview.json --no-publish
+```
+
+> Notice that on the second command we're using the `--no-publish` flag to avoid publishing content that was originally draft/updated.
+
+With this simple two-step process, you ensure that your content is fully reproducible, even if it's in draft state.
+
 ## Contributing
 
 Feel free to improve this tool by submitting a Pull Request. For more information,

data/bin/contentful_bootstrap

@@ -26,6 +26,9 @@ subcommands = {
     opts.on("-q", "--quiet", "Don't output to STDOUT") do |q|
       options[:quiet] = q
     end
+    opts.on("-n", "--no-publish", "Don't publish") do |n|
+      options[:no_publish] = n
+    end
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
@@ -47,6 +50,9 @@ subcommands = {
     opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
       options[:config_path] = c
     end
+    opts.on("-n", "--no-publish", "Don't publish") do |n|
+      options[:no_publish] = n
+    end
     opts.on("-q", "--quiet", "Don't output to STDOUT") do |q|
       options[:quiet] = q
     end
@@ -74,6 +80,9 @@ subcommands = {
     opts.on("-t", "--content-types-only", "Only fetch Content Types") do |t|
       options[:content_types_only] = t
     end
+    opts.on("-p", "--use-preview", "Use Preview API") do |p|
+      options[:use_preview] = p
+    end
     opts.on("-o OUTPUT_PATH", "--output-file OUTPUT_PATH", "Specify Output File") do |f|
       options[:filename] = f
     end

data/lib/contentful/bootstrap/command_runner.rb

@@ -33,11 +33,13 @@ module Contentful
         filename = options.fetch(:filename, nil)
         access_token = options.fetch(:access_token, nil)
         content_types_only = options.fetch(:content_types_only, false)
+        quiet = options.fetch(:quiet, false)
+        use_preview = options.fetch(:use_preview, false)
 
         fail 'Access Token required' if access_token.nil?
 
         Contentful::Bootstrap::Commands::GenerateJson.new(
-          space_id, access_token, filename, content_types_only
+          space_id, access_token, filename, content_types_only, quiet, use_preview
         ).run
       end
     end

data/lib/contentful/bootstrap/commands/base.rb

@@ -39,8 +39,8 @@ module Contentful
             @token.read,
             default_locale: options.fetch(:locale, "en-US"),
             raise_errors: true,
-            integration_name: 'bootstrap',
-            integration_version: ::Contentful::Bootstrap::VERSION
+            application_name: 'bootstrap',
+            application_version: ::Contentful::Bootstrap::VERSION
           )
         end
 

data/lib/contentful/bootstrap/commands/create_space.rb

@@ -14,6 +14,7 @@ module Contentful
           @json_template = options.fetch(:json_template, nil)
           @mark_processed = options.fetch(:mark_processed, false)
           @locale = options.fetch(:locale, "en-US")
+          @no_publish = options.fetch(:no_publish, false)
 
           super(token, space, options)
         end
@@ -106,7 +107,7 @@ module Contentful
         def create_json_template(space)
           if ::File.exist?(@json_template)
             output "Creating JSON Template '#{@json_template}'"
-            Templates::JsonTemplate.new(space, @json_template, @mark_processed, true, quiet).run
+            Templates::JsonTemplate.new(space, @json_template, @mark_processed, true, quiet, false, @no_publish).run
             output "JSON Template '#{@json_template}' created!"
           else
             output "JSON Template '#{@json_template}' does not exist. Please check that you specified the correct file name."

data/lib/contentful/bootstrap/commands/generate_json.rb

@@ -5,38 +5,50 @@ module Contentful
   module Bootstrap
     module Commands
       class GenerateJson
-        attr_reader :space_id, :filename, :access_token, :content_types_only
-        def initialize(space_id, access_token, filename = nil, content_types_only = false, quiet = false)
+        attr_reader :space_id, :filename, :access_token, :content_types_only, :use_preview
+        def initialize(space_id, access_token, filename = nil, content_types_only = false, quiet = false, use_preview = false)
           @space_id = space_id
           @access_token = access_token
           @filename = filename
           @content_types_only = content_types_only
           @quiet = quiet
+          @use_preview = use_preview
         end
 
         def run
           if access_token.nil?
-            puts 'Access Token not specified'
-            puts 'Exiting!'
-            exit
+            output 'Access Token not specified'
+            output 'Exiting!'
+            exit(1)
           end
 
-          puts "Generating JSON Template '#{filename}' for Space: '#{space_id}'"
+          output "Generating JSON Template for Space: '#{space_id}'"
+          output
 
-          json = Contentful::Bootstrap::Generator.new(space_id, access_token, content_types_only).generate_json
+          json = Contentful::Bootstrap::Generator.new(
+            space_id,
+            access_token,
+            content_types_only,
+            use_preview
+          ).generate_json
 
-          puts
           write(json)
         end
 
         def write(json)
           if filename.nil?
-            puts "#{json}\n"
+            output "#{json}\n"
           else
-            puts "Saving JSON template to '#{filename}'" unless @quiet
+            output "Saving JSON template to '#{filename}'"
             ::File.write(filename, json)
           end
         end
+
+        protected
+
+        def output(text = nil)
+          Support.output(text, @quiet)
+        end
       end
     end
   end

data/lib/contentful/bootstrap/commands/update_space.rb

@@ -12,6 +12,8 @@ module Contentful
           @json_template = options.fetch(:json_template, nil)
           @mark_processed = options.fetch(:mark_processed, false)
           @skip_content_types = options.fetch(:skip_content_types, false)
+          @no_publish = options.fetch(:no_publish, false)
+          @quiet = options.fetch(:quiet, false)
 
           super(token, space_id, options)
         end
@@ -49,7 +51,7 @@ module Contentful
         def update_json_template(space)
           if ::File.exist?(@json_template)
             output "Updating from JSON Template '#{@json_template}'"
-            Templates::JsonTemplate.new(space, @json_template, @mark_processed, true, false, @skip_content_types).run
+            Templates::JsonTemplate.new(space, @json_template, @mark_processed, true, @quiet, @skip_content_types, @no_publish).run
             output "JSON Template '#{@json_template}' updated!"
           else
             output "JSON Template '#{@json_template}' does not exist. Please check that you specified the correct file name."

data/lib/contentful/bootstrap/generator.rb

@@ -7,14 +7,18 @@ require 'contentful/bootstrap/version'
 module Contentful
   module Bootstrap
     class Generator
+      DELIVERY_API_URL = 'cdn.contentful.com'.freeze
+      PREVIEW_API_URL = 'preview.contentful.com'.freeze
+
       attr_reader :content_types_only, :client
 
-      def initialize(space_id, access_token, content_types_only)
+      def initialize(space_id, access_token, content_types_only, use_preview)
         @client = Contentful::Client.new(
           access_token: access_token,
           space: space_id,
-          integration_name: 'bootstrap',
-          integration_version: ::Contentful::Bootstrap::VERSION
+          application_name: 'bootstrap',
+          application_version: ::Contentful::Bootstrap::VERSION,
+          api_url: use_preview ? PREVIEW_API_URL : DELIVERY_API_URL
         )
         @content_types_only = content_types_only
       end
@@ -30,20 +34,6 @@ module Contentful
 
       private
 
-      def assets
-        return [] if content_types_only
-
-        proccessed_assets = @client.assets(limit: 1000).map do |asset|
-          result = { 'id' => asset.sys[:id], 'title' => asset.title }
-          result['file'] = {
-            'filename' => ::File.basename(asset.file.file_name, '.*'),
-            'url' => "https:#{asset.file.url}"
-          }
-          result
-        end
-        proccessed_assets.sort_by { |item| item['id'] }
-      end
-
       def content_types
         proccessed_content_types = @client.content_types.map do |type|
           result = { 'id' => type.sys[:id], 'name' => type.name }
@@ -58,22 +48,54 @@ module Contentful
         proccessed_content_types.sort_by { |item| item['id'] }
       end
 
+      def assets
+        return [] if content_types_only
+
+        processed_assets = []
+
+        query = { order: 'sys.createdAt', limit: 1000 }
+        assets_count = @client.assets(limit: 1).total
+        ((assets_count / 1000) + 1).times do |i|
+          query[:skip] = i * 1000
+
+          @client.assets(query).each do |asset|
+            processed_asset = {
+              'id' => asset.sys[:id],
+              'title' => asset.title,
+              'file' => {
+                'filename' => ::File.basename(asset.file.file_name, '.*'),
+                'url' => "https:#{asset.file.url}"
+              }
+            }
+            processed_assets << processed_asset
+          end
+        end
+
+        processed_assets.sort_by { |item| item['id'] }
+      end
+
       def entries
         return {} if content_types_only
 
         entries = {}
 
-        @client.entries(limit: 1000).each do |entry|
-          result = { 'sys' => { 'id' => entry.sys[:id] }, 'fields' => {} }
+        query = { order: 'sys.createdAt', limit: 1000 }
+        entries_count = @client.entries(limit: 1).total
+        ((entries_count / 1000) + 1).times do |i|
+          query[:skip] = i * 1000
 
-          entry.fields.each do |key, value|
-            value = map_field(value)
-            result['fields'][field_id(entry, key)] = value unless value.nil?
-          end
+          @client.entries(query).each do |entry|
+            result = { 'sys' => { 'id' => entry.sys[:id] }, 'fields' => {} }
 
-          ct_id = entry.content_type.sys[:id]
-          entries[ct_id] = [] if entries[ct_id].nil?
-          entries[ct_id] << result
+            entry.fields.each do |key, value|
+              value = map_field(value)
+              result['fields'][field_id(entry, key)] = value unless value.nil?
+            end
+
+            ct_id = entry.content_type.sys[:id]
+            entries[ct_id] = [] if entries[ct_id].nil?
+            entries[ct_id] << result
+          end
         end
 
         entries

data/lib/contentful/bootstrap/templates/base.rb

@@ -8,10 +8,11 @@ module Contentful
       class Base
         attr_reader :space, :skip_content_types
 
-        def initialize(space, quiet = false, skip_content_types = false)
+        def initialize(space, quiet = false, skip_content_types = false, no_publish = false)
           @space = space
           @quiet = quiet
           @skip_content_types = skip_content_types
+          @no_publish = no_publish
         end
 
         def run
@@ -108,29 +109,39 @@ module Contentful
         end
 
         def create_assets
-          assets.each do |asset|
+          assets.each do |asset_json|
             begin
-              output "Creating Asset '#{asset['title']}'"
+              output "Creating Asset '#{asset_json['title']}'"
               asset = space.assets.create(
-                id: asset['id'],
-                title: asset['title'],
-                file: asset['file']
+                id: asset_json['id'],
+                title: asset_json['title'],
+                file: asset_json['file']
               )
               asset.process_file
+            rescue Contentful::Management::Conflict
+              output "Asset '#{asset_json['id']}' already created! Updating instead."
 
-              attempts = 0
-              while attempts < 10
-                unless space.assets.find(asset.id).file.url.nil?
-                  asset.publish
-                  break
-                end
+              asset = space.assets.find(asset_json['id']).tap do |a|
+                a.title = asset_json['title']
+                a.file = asset_json['file']
+              end
 
-                sleep(1) # Wait for Process
-                attempts += 1
+              asset.save
+              asset.process_file
+            end
+          end
+
+          assets.each do |asset_json|
+            attempts = 0
+            while attempts < 10
+              asset = space.assets.find(asset_json['id'])
+              unless asset.file.url.nil?
+                asset.publish unless @no_publish
+                break
               end
-            rescue Contentful::Management::Conflict
-              output "Asset '#{asset['id']}' already created! Skipping"
-              next
+
+              sleep(1) # Wait for Process
+              attempts += 1
             end
           end
         end
@@ -203,7 +214,9 @@ module Contentful
             entry.id
           end
 
-          processed_entries.each { |e| space.entries.find(e).publish }
+          processed_entries.each do |e|
+            space.entries.find(e).publish unless @no_publish
+          end
         end
       end
     end