contentful_bootstrap 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 87bf2f847f495230e20ba2d7ddaaf81f9549275a
-  data.tar.gz: 30ee1008a09c1297e319e82350256ad94892da13
+SHA256:
+  metadata.gz: 7a0377b3978c29173e7cb2740be951072f39fa912080de68bfbb9c0471902088
+  data.tar.gz: 9b8be65f9b642b96a73a4470ad5d6f13fd338d09a75ee961a7e74b5e9a004308
 SHA512:
-  metadata.gz: 4392ba1adde7708b019dd6b6fa6d50568435c2a57712f430639c54db9077479bac1183f9c58e52b75cee700cf8025aa2f4b6a90e352af5ef195cc6663348547f
-  data.tar.gz: dabba1d78944aecd7f117e95f85124ddf5be620c4b530576c65ac7adfa74d585838fef53d2341ee391b3627f35a6647bed15a4798c5d48d5148da2b98865e312
+  metadata.gz: 355d7bc2e47d9f35f9fb28e49dc0988127bd0e9b908d7138966facd123f97cd1a8828df24f094b314473ca8ad7935b2d3166e2409afa2737b798d7dd33486361
+  data.tar.gz: 84039265f10136ea387e9ece1079f581356585d04f3c9facff7b214167c01214771b4a1d0c7c618fbf03b822649f4a041bc9a1223d708cfe1a6a8953d0767c60

data/.rubocop.yml

@@ -1,9 +1,13 @@
-Metrics/LineLength:
-  Max: 120
+inherit_from: .rubocop_todo.yml
+
+AllCops:
   Exclude:
-    - 'lib/contentful/bootstrap/templates/blog.rb'
-    - 'lib/contentful/bootstrap/templates/catalogue.rb'
-    - 'lib/contentful/bootstrap/templates/gallery.rb'
+    - contentful_bootstrap.gemspec
+    - spec/**/*
+    - examples/**/*
+    - Guardfile
+    - Gemfile
+    - Rakefile
 
 Style/Documentation:
   Exclude:

data/.rubocop_todo.yml

@@ -1,58 +1,52 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-11-12 15:38:57 -0300 using RuboCop version 0.35.1.
+# on 2018-04-17 14:00:32 +0200 using RuboCop version 0.55.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 8
+Documentation:
+  Enabled: false
+
 Metrics/AbcSize:
-  Max: 52
+  Max: 62
+
+Metrics/BlockLength:
+  Max: 39
+  CountComments: false
 
-# Offense count: 4
-# Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 176
+  CountComments: false
 
-# Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 16
-# Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 316
+  Max: 167
+  Exclude:
+    - 'lib/contentful/bootstrap/templates/blog.rb'
+    - 'lib/contentful/bootstrap/templates/catalogue.rb'
+    - 'lib/contentful/bootstrap/templates/gallery.rb'
+    - 'bin/contentful_bootstrap'
 
-# Offense count: 19
-# Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 88
+  CountComments: false
 
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 9
+Metrics/ParameterLists:
+  Max: 8
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
-Style/BlockDelimiters:
-  Exclude:
-    - 'spec/contentful/bootstrap/generator_spec.rb'
-
-# Offense count: 2
-Style/ClassVars:
-  Exclude:
-    - 'lib/contentful/bootstrap/token.rb'
+Metrics/PerceivedComplexity:
+  Max: 8
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/DeprecatedHashMethods:
+Naming/MethodName:
+  EnforcedStyle: snake_case
   Exclude:
-    - 'bin/contentful_bootstrap'
+    - 'lib/contentful/bootstrap/server.rb'
 
-# Offense count: 20
-# Configuration parameters: Exclude.
+# Offense count: 6
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -72,52 +66,16 @@ Style/Documentation:
     - 'lib/contentful/bootstrap/templates/links/entry.rb'
     - 'lib/contentful/bootstrap/token.rb'
     - 'lib/contentful/bootstrap/version.rb'
+    - 'lib/contentful/bootstrap/command_runner.rb'
+    - 'lib/contentful/bootstrap/commands/base.rb'
+    - 'lib/contentful/bootstrap/commands/create_space.rb'
+    - 'lib/contentful/bootstrap/commands/generate_json.rb'
+    - 'lib/contentful/bootstrap/commands/generate_token.rb'
+    - 'lib/contentful/bootstrap/commands/update_space.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/FormatString:
   Exclude:
-    - 'lib/contentful/bootstrap/commands.rb'
+    - 'lib/contentful/bootstrap/commands/create_space.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'bin/contentful_bootstrap'
-
-# Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodName:
-  Enabled: false
-
-# Offense count: 2
-Style/MultilineBlockChain:
-  Exclude:
-    - 'lib/contentful/bootstrap/generator.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'contentful_bootstrap.gemspec'
-
-# Offense count: 68
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-Style/TrailingComma:
-  Exclude:
-    - 'bin/contentful_bootstrap'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-    - 'contentful_bootstrap.gemspec'
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## v3.11.0
+### Added
+* Added `--environment` support to `update_space` and `generate_json`.
+
+### Changed
+* Updated to the new CMA and CDA SDK versions.
+
 ## v3.10.0
 ### Added
 * Added `--content-type-ids` filter to `generate_json` command to allow selecting which content types to import.

data/Guardfile

@@ -1,5 +1,21 @@
-guard :rspec, cmd: 'rspec --format documentation --color' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+group :green_red_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cmd: "rubocop" do
+  end
 end

data/README.md

@@ -5,10 +5,7 @@
 A small CLI tool for getting started with Contentful
 
 ## Contentful
-[Contentful](http://www.contentful.com) is a content management platform for web applications,
-mobile apps and connected devices. It allows you to create, edit & manage content in the cloud
-and publish it anywhere via a powerful API. Contentful offers tools for managing editorial
-teams and enabling cooperation between organizations.
+[[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
 
 ## What does `contentful_bootstrap` do?
 `contentful_bootstrap` let's you set up a new Contentful environment with a single command.
@@ -38,13 +35,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-type-ids ct_id_1,ct_id_2] [--content-types-only] [--use-preview] [--quiet]
+$ contentful_bootstrap generate_json <space_id> <delivery_api_access_token> [--environment ENVIRONMENT_ID] [--output-file OUTPUT PATH] [--content-type-ids ct_id_1,ct_id_2] [--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] [--no-publish] [--quiet]
+$ contentful_bootstrap update_space <space_id> -j template_path [--environment ENVIRONMENT_ID] [--mark-processed] [--skip-content-types] [--no-publish] [--quiet]
 ```
 
 ### Built-in templates
@@ -102,6 +99,7 @@ To Update an existing Space
 ```ruby
 options = {
   json_template: "/path/to/template.json", # Will use the JSON file specified as a Template
+  environment: "master", # Will update the specified environment, will NOT create the environment if it doesn't exist, defaults to "master"
   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 on future update_space calls
   trigger_oauth: true, # if true will trigger OAuth process
@@ -137,6 +135,7 @@ To Generate a JSON Template from an exising Space
 Contentful::Bootstrap::CommandRunner.new.generate_json(
   "space_id",
   access_token: "delivery_or_preview_api_access_token",
+  environment: "master", # Will fetch content from the specified environment, defaults to "master"
   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
@@ -152,6 +151,7 @@ Additionally, you can send an options hash with the following keys:
 ```ruby
 options = {
   access_token: "access_token" # REQUIRED
+  environment: "master", # Will fetch content from the specified environment, defaults to "master"
   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

data/bin/contentful_bootstrap

@@ -7,105 +7,111 @@ options = {}
 
 subcommands = {
   'create_space' => OptionParser.new do |opts|
-    opts.banner = "Usage: create_space <space_name> [--template TEMPLATE_NAME] [--json-template JSON_PATH] [--locale LOCALE] [--mark-processed] [--config CONFIG_PATH]"
-    opts.on("-t TEMPLATE", "--template TEMPLATE", "Specify Template", "Available Templates: blog, catalogue, gallery") do |t|
+    opts.banner = 'Usage: create_space <space_name> [--template TEMPLATE_NAME] [--json-template JSON_PATH] [--locale LOCALE] [--mark-processed] [--config CONFIG_PATH]'
+    opts.on('-t TEMPLATE', '--template TEMPLATE', 'Specify Template', 'Available Templates: blog, catalogue, gallery') do |t|
       options[:template] = t
     end
-    opts.on("-j JSON_PATH", "--json-template JSON_PATH", "Specify JSON Template Path") do |j|
+    opts.on('-j JSON_PATH', '--json-template JSON_PATH', 'Specify JSON Template Path') do |j|
       options[:json_template] = j
     end
-    opts.on("-l LOCALE", "--locale LOCALE", "Set the Default Locale for the Space", "Defaults to 'en-US'") do |l|
+    opts.on('-l LOCALE', '--locale LOCALE', 'Set the Default Locale for the Space', "Defaults to 'en-US'") do |l|
       options[:locale] = l
     end
-    opts.on('-m', '--mark-processed', "Mark Processed Items on JSON Templates") do |m|
+    opts.on('-m', '--mark-processed', 'Mark Processed Items on JSON Templates') do |m|
       options[:mark_processed] = m
     end
-    opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
+    opts.on('-c CONFIG_PATH', '--config CONFIG_PATH', 'Specify Configuration Path') do |c|
       options[:config_path] = c
     end
-    opts.on("-q", "--quiet", "Don't output to STDOUT") do |q|
+    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|
+    opts.on('-n', '--no-publish', "Don't publish") do |n|
       options[:no_publish] = n
     end
-    opts.on_tail("-h", "--help", "Print this message") do
+    opts.on_tail('-h', '--help', 'Print this message') do
       puts opts
     end
   end,
   'update_space' => OptionParser.new do |opts|
-    opts.banner = "Usage: update_space <space_id> --json-template JSON_PATH [--locale LOCALE] [--mark-processed] [--config CONFIG_PATH]"
-    opts.on("-j JSON_PATH", "--json-template JSON_PATH", "Specify JSON Template Path") do |j|
+    opts.banner = 'Usage: update_space <space_id> --json-template JSON_PATH [--environment ENVIRONMENT_ID] [--locale LOCALE] [--mark-processed] [--config CONFIG_PATH]'
+    opts.on('-j JSON_PATH', '--json-template JSON_PATH', 'Specify JSON Template Path') do |j|
       options[:json_template] = j
     end
-    opts.on("-l LOCALE", "--locale LOCALE", "Set the Default Locale for the Space", "Defaults to 'en-US'") do |l|
+    opts.on('-e ENVIRONMENT_ID', '--environment ENVIRONMENT_ID', 'Specify target environment ID', "Defaults to 'master'") do |e|
+      options[:environment] = e
+    end
+    opts.on('-l LOCALE', '--locale LOCALE', 'Set the Default Locale for the Space', "Defaults to 'en-US'") do |l|
       options[:locale] = l
     end
-    opts.on('-m', '--mark-processed', "Mark Processed Items on JSON Templates") do |m|
+    opts.on('-m', '--mark-processed', 'Mark Processed Items on JSON Templates') do |m|
       options[:mark_processed] = m
     end
-    opts.on('-T', '--skip-content-types', "Skip Content Types on Space update") do |t|
+    opts.on('-T', '--skip-content-types', 'Skip Content Types on Space update') do |t|
       options[:skip_content_types] = t
     end
-    opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
+    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|
+    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|
+    opts.on('-q', '--quiet', "Don't output to STDOUT") do |q|
       options[:quiet] = q
     end
-    opts.on_tail("-h", "--help", "Print this message") do
+    opts.on_tail('-h', '--help', 'Print this message') do
       puts opts
     end
   end,
   'generate_token' => OptionParser.new do |opts|
-    opts.banner = "Usage: generate_token <space_id> [--name TOKEN_NAME] [--config CONFIG_PATH]"
-    opts.on("-n NAME", "--name TOKEN_NAME", "Specify Token Name") do |n|
+    opts.banner = 'Usage: generate_token <space_id> [--name TOKEN_NAME] [--config CONFIG_PATH]'
+    opts.on('-n NAME', '--name TOKEN_NAME', 'Specify Token Name') do |n|
       options[:name] = n
     end
-    opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
+    opts.on('-c CONFIG_PATH', '--config CONFIG_PATH', 'Specify Configuration Path') do |c|
       options[:config_path] = c
     end
-    opts.on("-q", "--quiet", "Don't output to STDOUT") do |q|
+    opts.on('-q', '--quiet', "Don't output to STDOUT") do |q|
       options[:quiet] = q
     end
-    opts.on_tail("-h", "--help", "Print this message") do
+    opts.on_tail('-h', '--help', 'Print this message') do
       puts opts
     end
   end,
   'generate_json' => OptionParser.new do |opts|
-    opts.banner = "Usage: generate_json <space_id> <access_token> [--output-file OUTPUT_PATH]"
-    opts.on("-t", "--content-types-only", "Only fetch Content Types") do |t|
+    opts.banner = 'Usage: generate_json <space_id> <access_token> [--environment ENVIRONMENT_ID] [--output-file OUTPUT_PATH] [--content-types-only] [--use-preview] [--content-type-ids <ID_1>, <ID_2>]'
+    opts.on('-e ENVIRONMENT_ID', '--environment ENVIRONMENT_ID', 'Specify target environment ID', "Defaults to 'master'") do |e|
+      options[:environment] = e
+    end
+    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|
+    opts.on('-p', '--use-preview', 'Use Preview API') do |p|
       options[:use_preview] = p
     end
-    opts.on("-i", "--content-type-ids <ID_1>,<ID_2>", ::Array, "Array of content type IDs to import") do |ids|
+    opts.on('-i', '--content-type-ids <ID_1>,<ID_2>', ::Array, 'Array of content type IDs to import') do |ids|
       options[:content_type_ids] = ids
     end
-    opts.on("-o OUTPUT_PATH", "--output-file OUTPUT_PATH", "Specify Output File") do |f|
+    opts.on('-o OUTPUT_PATH', '--output-file OUTPUT_PATH', 'Specify Output File') do |f|
       options[:filename] = f
     end
-    opts.on("-q", "--quiet", "Don't output to STDOUT") do |q|
+    opts.on('-q', '--quiet', "Don't output to STDOUT") do |q|
       options[:quiet] = q
     end
-    opts.on_tail("-h", "--help", "Print this message") do
+    opts.on_tail('-h', '--help', 'Print this message') do
       puts opts
     end
-  end,
+  end
 }
 
 global = OptionParser.new do |opts|
-  opts.banner = "Usage: contentful_bootstrap <command> <space_name> [options]"
-  opts.separator ""
+  opts.banner = 'Usage: contentful_bootstrap <command> <space_name> [options]'
+  opts.separator ''
   opts.separator <<-HELP
     Available commands are:
     \t#{subcommands.keys.sort.join("\n\t")}
   HELP
-  opts.on_tail("-v", "--version", "Show Version") do
+  opts.on_tail('-v', '--version', 'Show Version') do
     puts "Contentful Bootstrap: #{Contentful::Bootstrap::VERSION}"
     exit(0)
   end
@@ -114,10 +120,10 @@ end
 global.order!
 command = ARGV.shift
 
-is_help = ARGV.include?("-h") || ARGV.include?("--help")
+is_help = ARGV.include?('-h') || ARGV.include?('--help')
 space = ARGV.shift unless is_help
 
-options[:access_token] = ARGV.shift if command == "generate_json" && !is_help
+options[:access_token] = ARGV.shift if command == 'generate_json' && !is_help
 
 if subcommands.key? command
   subcommands[command].order!
@@ -128,23 +134,21 @@ if subcommands.key? command
     exit(1)
   end
 
-  if is_help
-    exit
-  end
+  exit if is_help
 
   if space.nil? || space.empty?
     ARGV << '-h'
     subcommands[command].order!
     puts
-    puts "Required Arguments not specified. Exiting!"
+    puts 'Required Arguments not specified. Exiting!'
     exit
   end
 
   options[:trigger_oauth] = true
 
-  Contentful::Bootstrap::CommandRunner.new(options.fetch(:config_path, "")).send(command, space, options)
+  Contentful::Bootstrap::CommandRunner.new(options.fetch(:config_path, '')).send(command, space, options)
 else
-  puts "Usage: contentful_bootstrap <command> <space> [options]"
+  puts 'Usage: contentful_bootstrap <command> <space> [options]'
   puts
   puts <<-HELP
     Subcommand not available or missing