contentful_bootstrap 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4672f655b4d3a32b439e75feec5b7d5fddbcfb5e
-  data.tar.gz: 75bcb4e3054e0a5cbc1abe6a2e7c0083f7a718fe
+  metadata.gz: 3069a4e110431c036457ac8839dc3e01d48146e3
+  data.tar.gz: 9fdeed19e3bdd8c97d77424e029b3f76b65a78e3
 SHA512:
-  metadata.gz: c54a6ad2254d281a207b7764a419313b69b4caf1eff76cd03fb01bc01b757b8f537f73d538122345ccae69ae5b89f782748a22509278881d2122403b19e62140
-  data.tar.gz: 230b8f6a1b6413ce6888bad8a0252435bbc3602a183d31e4aaef66bab51894ceaab68943b4492352bfb3517c4ed984c2d873b8e15056afb844bc2789918e723d
+  metadata.gz: 1a29cc6c70e7e062bc0224b0831a1b3841059ba99e1954690cdf8dfe702bde14cd8090d7c8cad8d52766cef84d81df1e7a9e7bbd3352efced2b7c48a857924ac
+  data.tar.gz: b8638c2bbc11a3f8cb2f5c4a99e763c2220d8b318eccaea6c8e1a01c7123c7807b90aa2b852ea50b8d40229ba81ae3bf197fae3b1c1119b75eb31aa2da2a11d8

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## Unreleased
 
+## v3.5.0
+
+### Added
+* Add `-q` and `--quiet` flags to the CLI Tool and their respective command classes [#48](https://github.com/contentful/contentful-bootstrap.rb/issues/48)
+* Add `:no_input` option to library commands [#48](https://github.com/contentful/contentful-bootstrap.rb/issues/48)
+
+### Changed
+* Refactored internals to allow more option flexibility and simplified the `CommandRunner`.
+* Updated dependencies to the newest available SDKs
+
+### Fixed
+* Fixed Object Field parsing for JSON Templates [#51](https://github.com/contentful/contentful-bootstrap.rb/issues/51)
+
+
 ## v3.4.0
 ### Added
 * Add `-v` and `--version` flags to output current version

data/Gemfile

@@ -6,5 +6,5 @@ gemspec
 gem "launchy"
 gem "inifile"
 gem "contentful-management"
-gem "contentful", "~> 0.7", ">= 0.7.3"
+gem "contentful"
 gem 'pry'

data/README.md

@@ -26,25 +26,25 @@ $ gem install contentful_bootstrap
 You can create spaces by doing:
 
 ```bash
-$ contentful_bootstrap create_space <space_name> [--template template_name] [--json-template template_path] [--mark-processed] [--config CONFIG_PATH]
+$ contentful_bootstrap create_space <space_name> [--template template_name] [--json-template template_path] [--mark-processed] [--config CONFIG_PATH] [--quiet]
 ```
 
 You can also generate new Delivery API Tokens by doing:
 
 ```bash
-$ contentful_bootstrap generate_token <space_id> [--name token_name] [--config CONFIG_PATH]
+$ contentful_bootstrap generate_token <space_id> [--name token_name] [--config CONFIG_PATH] [--quiet]
 ```
 
 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]
+$ contentful_bootstrap generate_json <space_id> <delivery_api_access_token> [--output-file OUTPUT PATH] [--content-types-only] [--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]
+$ contentful_bootstrap update_space <space_id> -j template_path [--mark-processed] [--skip-content-types] [--quiet]
 ```
 
 ### Built-in templates
@@ -88,7 +88,9 @@ options = {
   template: "blog", # Will use one of the predefined templates and create Content Types, Assets and Entries
   json_template: "/path/to/template.json", # Will use the JSON file specified as a Template
   mark_processed: false, # if true will mark all resources as 'bootstrapProcessed' and will be avoided for update_space calls (doesnt affect create_space)
-  trigger_oauth: true # if true will trigger OAuth process
+  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
 }
 Contentful::Bootstrap::CommandRunner.new.create_space("space_name", options)
 ```
@@ -101,6 +103,8 @@ 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
+  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
 }
 Contentful::Bootstrap::CommandRunner.new.update_space("space_id", options)
 ```
@@ -116,7 +120,9 @@ Additionally, you can send an options hash with the following keys:
 ```ruby
 options = {
   name: "Some Nice Token Name", # Will Create the Delivery API Token with the specified name
-  trigger_oauth: true # if true will trigger OAuth process
+  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
 }
 Contentful::Bootstrap::CommandRunner.new.generate_token("space_id", options)
 ```
@@ -127,7 +133,9 @@ To Generate a JSON Template from an exising Space
 Contentful::Bootstrap::CommandRunner.new.generate_json(
   "space_id",
   access_token: "delivery_api_access_token",
-  content_types_only: false # if true will not fetch Entries and Assets
+  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
 )
 ```
 
@@ -137,7 +145,9 @@ Additionally, you can send an options hash with the following keys:
 ```ruby
 options = {
   access_token: "access_token" # REQUIRED
-  filename: "template.json" # Will save the JSON to the specified file
+  filename: "template.json", # Will save the JSON to the specified file
+  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
 }
 Contentful::Bootstrap::CommandRunner.new.generate_json("space_id", options)
 ```
@@ -157,6 +167,7 @@ The configuration file will be in `ini` format and looks like the following
 
 ```ini
 [global]
+CONTENTFUL_ORGANIZATION_ID = an_organization_id
 CONTENTFUL_MANAGEMENT_ACCESS_TOKEN = a_management_access_token
 
 [space_name]

data/bin/contentful_bootstrap

@@ -20,6 +20,9 @@ subcommands = {
     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|
+      options[:quiet] = q
+    end
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
@@ -38,6 +41,9 @@ subcommands = {
     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|
+      options[:quiet] = q
+    end
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
@@ -50,6 +56,9 @@ subcommands = {
     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|
+      options[:quiet] = q
+    end
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
@@ -62,6 +71,9 @@ subcommands = {
     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|
+      options[:quiet] = q
+    end
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
@@ -95,7 +107,7 @@ if subcommands.key? command
   unless STDIN.tty? && STDOUT.tty?
     $stderr.write "This tool requires user interaction\n"
     $stderr.write "Exiting!\n"
-    exit
+    exit(1)
   end
 
   if is_help

data/contentful_bootstrap.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency 'listen', '~> 3.0.0'
   spec.add_runtime_dependency "launchy"
-  spec.add_runtime_dependency "contentful-management", '~> 0.9'
-  spec.add_runtime_dependency "contentful", "~> 0.7"
+  spec.add_runtime_dependency "contentful-management", '~> 1.0'
+  spec.add_runtime_dependency "contentful", "> 0", "< 3"
   spec.add_runtime_dependency "inifile"
 end

data/lib/contentful/bootstrap/command_runner.rb

@@ -12,32 +12,20 @@ module Contentful
       end
 
       def create_space(space_name, options = {})
-        template_name = options.fetch(:template, nil)
-        json_template = options.fetch(:json_template, nil)
-        mark_processed = options.fetch(:mark_processed, false)
-        trigger_oauth = options.fetch(:trigger_oauth, true)
-
         Contentful::Bootstrap::Commands::CreateSpace.new(
-          @token, space_name, template_name, json_template, mark_processed, trigger_oauth
+          @token, space_name, options
         ).run
       end
 
       def update_space(space_id, options = {})
-        json_template = options.fetch(:json_template, nil)
-        mark_processed = options.fetch(:mark_processed, false)
-        trigger_oauth = options.fetch(:trigger_oauth, true)
-
         Contentful::Bootstrap::Commands::UpdateSpace.new(
-          @token, space_id, json_template, mark_processed, trigger_oauth
+          @token, space_id, options
         ).run
       end
 
       def generate_token(space, options = {})
-        token_name = options.fetch(:name, 'Bootstrap Token')
-        trigger_oauth = options.fetch(:trigger_oauth, true)
-
         Contentful::Bootstrap::Commands::GenerateToken.new(
-          @token, space, token_name, trigger_oauth
+          @token, space, options
         ).run
       end
 

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

@@ -7,11 +7,16 @@ module Contentful
   module Bootstrap
     module Commands
       class Base
-        include Support
-        attr_reader :space, :token
+        attr_reader :space, :token, :options, :quiet, :no_input, :client
+
+        def initialize(token, space, options = {})
+          trigger_oauth = options.fetch(:trigger_oauth, true)
 
-        def initialize(token, space, trigger_oauth = true)
           @token = token
+          @options = options
+          @quiet = options.fetch(:quiet, false)
+          @no_input = options.fetch(:no_input, false)
+
           configuration if trigger_oauth
           management_client_init if trigger_oauth
           @space = space
@@ -21,32 +26,41 @@ module Contentful
           fail 'must implement'
         end
 
+        protected
+
+        def output(text = nil)
+          Support.output(text, @quiet)
+        end
+
         private
 
         def management_client_init
-          ::Contentful::Bootstrap::Management.new(@token.read, raise_errors: true)
+          @client ||= ::Contentful::Bootstrap::Management.new(@token.read, raise_errors: true)
         end
 
         def configuration
           if @token.present?
-            puts 'OAuth token found, moving on!'
+            output 'OAuth token found, moving on!'
             return
           end
 
-          print 'OAuth Token not found, do you want to create a new configuration file? (Y/n): '
-          if gets.chomp.downcase == 'n'
-            puts 'Exiting!'
-            exit
+          Support.input('OAuth Token not found, do you want to create a new configuration file? (Y/n): ', no_input) do |answer|
+            if answer.downcase == 'n'
+              output 'Exiting!'
+              exit
+            end
           end
 
-          puts "Configuration will be saved on #{@token.filename}"
-          puts 'A new tab on your browser will open for requesting OAuth permissions'
+          fail 'OAuth token required to proceed' if no_input
+
+          output "Configuration will be saved on #{@token.filename}"
+          output 'A new tab on your browser will open for requesting OAuth permissions'
           token_server
-          puts
+          output
         end
 
         def token_server
-          silence_stderr do # Don't show any WEBrick related stuff
+          Support.silence_stderr do # Don't show any WEBrick related stuff
             server = Contentful::Bootstrap::Server.new(@token)
 
             server.start

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

@@ -9,33 +9,32 @@ module Contentful
     module Commands
       class CreateSpace < Base
         attr_reader :template_name, :json_template
-        def initialize(
-            token, space_name, template_name = nil,
-            json_template = nil, mark_processed = false, trigger_oauth = true)
-          super(token, space_name, trigger_oauth)
-          @template_name = template_name
-          @json_template = json_template
-          @mark_processed = mark_processed
+        def initialize(token, space, options = {})
+          @template_name = options.fetch(:template, nil)
+          @json_template = options.fetch(:json_template, nil)
+          @mark_processed = options.fetch(:mark_processed, false)
+
+          super(token, space, options)
         end
 
         def run
-          puts "Creating Space '#{@space}'"
+          output "Creating Space '#{@space}'"
 
           new_space = fetch_space
 
-          puts "Space '#{@space}' created!"
-          puts
+          output "Space '#{@space}' created!"
+          output
 
           create_template(new_space) unless @template_name.nil?
           create_json_template(new_space) unless @json_template.nil?
 
           access_token = generate_token(new_space)
-          puts
-          puts "Space ID: '#{new_space.id}'"
-          puts "Access Token: '#{access_token}'"
-          puts
-          puts 'You can now insert those values into your configuration blocks'
-          puts "Manage your content at https://app.contentful.com/spaces/#{new_space.id}"
+          output
+          output "Space ID: '#{new_space.id}'"
+          output "Access Token: '#{access_token}'"
+          output
+          output 'You can now insert those values into your configuration blocks'
+          output "Manage your content at https://app.contentful.com/spaces/#{new_space.id}"
 
           new_space
         end
@@ -49,18 +48,21 @@ module Contentful
               name: @space
             }
             options[:organization_id] = @token.read_organization_id unless @token.read_organization_id.nil?
-            new_space = Contentful::Management::Space.create(options)
+            new_space = client.spaces.create(options)
           rescue Contentful::Management::NotFound
-            puts 'Your account has multiple organizations:'
-            puts organizations.join("\n")
-            print 'Please insert the Organization ID you\'d want to create the spaces for: '
-            organization_id = gets.chomp
-            @token.write_organization_id(organization_id)
-            puts 'Your Organization ID has been stored as the default organization.'
-            new_space = Contentful::Management::Space.create(
-              name: @space,
-              organization_id: organization_id
-            )
+            fail "Organization ID is required, provide it in Configuration File" if no_input
+
+            output 'Your account has multiple organizations:'
+            output organizations.join("\n")
+            Support.input('Please insert the Organization ID you\'d want to create the spaces for: ', no_input) do |answer|
+              organization_id = answer
+              @token.write_organization_id(organization_id)
+              output 'Your Organization ID has been stored as the default organization.'
+              new_space = client.spaces.create(
+                name: @space,
+                organization_id: organization_id
+              )
+            end
           end
 
           new_space
@@ -71,7 +73,7 @@ module Contentful
         def organizations
           client = management_client_init
           url = client.base_url.sub('spaces', 'token')
-          response = Contentful::Management::Client.get_http(url, nil, client.request_headers)
+          response = client.get_http(url, nil, client.request_headers)
           organization_ids = JSON.load(response.body.to_s)['includes']['Organization'].map do |org|
             sprintf('%-20s %s', org['name'], org['sys']['id'])
           end
@@ -88,30 +90,30 @@ module Contentful
 
         def create_template(space)
           if templates.key? @template_name.to_sym
-            puts "Creating Template '#{@template_name}'"
+            output "Creating Template '#{@template_name}'"
 
-            templates[@template_name.to_sym].new(space).run
-            puts "Template '#{@template_name}' created!"
+            templates[@template_name.to_sym].new(space, quiet).run
+            output "Template '#{@template_name}' created!"
           else
-            puts "Template '#{@template_name}' not found. Valid templates are '#{templates.keys.map(&:to_s).join('\', \'')}'"
+            output "Template '#{@template_name}' not found. Valid templates are '#{templates.keys.map(&:to_s).join('\', \'')}'"
           end
-          puts
+          output
         end
 
         def create_json_template(space)
           if ::File.exist?(@json_template)
-            puts "Creating JSON Template '#{@json_template}'"
-            Templates::JsonTemplate.new(space, @json_template, @mark_processed).run
-            puts "JSON Template '#{@json_template}' created!"
+            output "Creating JSON Template '#{@json_template}'"
+            Templates::JsonTemplate.new(space, @json_template, @mark_processed, true, quiet).run
+            output "JSON Template '#{@json_template}' created!"
           else
-            puts "JSON Template '#{@json_template}' does not exist. Please check that you specified the correct file name."
+            output "JSON Template '#{@json_template}' does not exist. Please check that you specified the correct file name."
           end
-          puts
+          output
         end
 
         def generate_token(space)
           Contentful::Bootstrap::Commands::GenerateToken.new(
-            @token, space, 'Bootstrap Token', false
+            @token, space, options
           ).run
         end
       end

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

@@ -6,11 +6,12 @@ module Contentful
     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)
+        def initialize(space_id, access_token, filename = nil, content_types_only = false, quiet = false)
           @space_id = space_id
           @access_token = access_token
           @filename = filename
           @content_types_only = content_types_only
+          @quiet = quiet
         end
 
         def run
@@ -32,7 +33,7 @@ module Contentful
           if filename.nil?
             puts "#{json}\n"
           else
-            puts "Saving JSON template to '#{filename}'"
+            puts "Saving JSON template to '#{filename}'" unless @quiet
             ::File.write(filename, json)
           end
         end