contentful_bootstrap 3.4.0 → 3.5.0

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

@@ -9,42 +9,43 @@ module Contentful
     module Commands
       class GenerateToken < Base
         attr_reader :token_name
-        def initialize(token, space, token_name = 'Bootstrap Token', trigger_oauth = true)
-          super(token, space, trigger_oauth)
-          @token_name = token_name
-          @actual_space = space unless space.is_a?(String)
+        def initialize(token, space, options = {})
+          @token_name = options.fetch(:token_name, 'Bootstrap Token')
+
+          super(token, space, options)
         end
 
         def run
-          puts 'Creating Delivery API Token'
+          output 'Creating Delivery API Token'
 
           fetch_space
 
           access_token = fetch_access_token
 
-          puts "Token '#{token_name}' created! - '#{access_token}'"
-          print 'Do you want to write the Delivery Token to your configuration file? (Y/n): '
-          unless gets.chomp.downcase == 'n'
-            @token.write_access_token(@actual_space.name, access_token)
-            @token.write_space_id(@actual_space.name, @actual_space.id)
+          output "Token '#{token_name}' created! - '#{access_token}'"
+          Support.input('Do you want to write the Delivery Token to your configuration file? (Y/n): ', no_input) do |answer|
+            unless answer.downcase == 'n'
+              @token.write_access_token(@actual_space.name, access_token)
+              @token.write_space_id(@actual_space.name, @actual_space.id)
+            end
           end
 
           access_token
         end
 
         def fetch_space
-          @actual_space ||= Contentful::Management::Space.find(@space)
+          if @space.is_a?(String)
+            @actual_space = client.spaces.find(@space)
+          else
+            @actual_space = @space
+          end
         end
 
         def fetch_access_token
-          response = Contentful::Management::Request.new(
-            "/#{@actual_space.id}/api_keys",
-            'name' => token_name,
-            'description' => "Created with 'contentful_bootstrap.rb v#{Contentful::Bootstrap::VERSION}'"
-          ).post
-          fail response if response.object.is_a?(Contentful::Management::Error)
-
-          response.object['accessToken']
+          @actual_space.api_keys.create(
+            name: token_name,
+            description: "Created with 'contentful_bootstrap.rb v#{Contentful::Bootstrap::VERSION}'"
+          ).access_token
         end
       end
     end

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

@@ -8,27 +8,28 @@ module Contentful
     module Commands
       class UpdateSpace < Base
         attr_reader :json_template
-        def initialize(token, space_id, json_template = nil, mark_processed = false, trigger_oauth = true, skip_content_types = false)
-          super(token, space_id, trigger_oauth)
-          @json_template = json_template
-          @mark_processed = mark_processed
-          @skip_content_types = skip_content_types
+        def initialize(token, space_id, options = {})
+          @json_template = options.fetch(:json_template, nil)
+          @mark_processed = options.fetch(:mark_processed, false)
+          @skip_content_types = options.fetch(:skip_content_types, false)
+
+          super(token, space_id, options)
         end
 
         def run
           if @json_template.nil?
-            puts 'JSON Template not found. Exiting!'
+            output 'JSON Template not found. Exiting!'
             exit(1)
           end
 
-          puts "Updating Space '#{@space}'"
+          output "Updating Space '#{@space}'"
 
           update_space = fetch_space
 
           update_json_template(update_space)
 
-          puts
-          puts "Successfully updated Space #{@space}"
+          output
+          output "Successfully updated Space #{@space}"
 
           update_space
         end
@@ -36,9 +37,9 @@ module Contentful
         protected
 
         def fetch_space
-          Contentful::Management::Space.find(@space)
+          client.spaces.find(@space)
         rescue Contentful::Management::NotFound
-          puts 'Space Not Found. Exiting!'
+          output 'Space Not Found. Exiting!'
           exit(1)
         end
 
@@ -46,11 +47,11 @@ module Contentful
 
         def update_json_template(space)
           if ::File.exist?(@json_template)
-            puts "Updating from JSON Template '#{@json_template}'"
+            output "Updating from JSON Template '#{@json_template}'"
             Templates::JsonTemplate.new(space, @json_template, @mark_processed, false, @skip_content_types).run
-            puts "JSON Template '#{@json_template}' updated!"
+            output "JSON Template '#{@json_template}' updated!"
           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."
             exit(1)
           end
         end

data/lib/contentful/bootstrap/support.rb

@@ -3,13 +3,30 @@ require 'stringio'
 module Contentful
   module Bootstrap
     module Support
-      def silence_stderr
+      def self.silence_stderr
         old_stderr = $stderr
         $stderr = StringIO.new
         yield
       ensure
         $stderr = old_stderr
       end
+
+      def self.output(text = nil, quiet = false)
+        if text.nil?
+          puts unless quiet
+          return
+        end
+
+        puts text unless quiet
+      end
+
+      def self.input(prompt_text, no_input = false)
+        return if no_input
+
+        print prompt_text
+        answer = gets.chomp
+        yield answer if block_given?
+      end
     end
   end
 end

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

@@ -8,8 +8,9 @@ module Contentful
       class Base
         attr_reader :space, :skip_content_types
 
-        def initialize(space, skip_content_types = false)
+        def initialize(space, quiet = false, skip_content_types = false)
           @space = space
+          @quiet = quiet
           @skip_content_types = skip_content_types
         end
 
@@ -21,9 +22,9 @@ module Contentful
           after_run
         rescue Contentful::Management::Error => e
           error = e.error
-          puts "Error at: #{error[:url]}"
-          puts "Message: #{error[:message]}"
-          puts "Details: #{error[:details]}"
+          output "Error at: #{error[:url]}"
+          output "Message: #{error[:message]}"
+          output "Details: #{error[:details]}"
 
           raise e
         end
@@ -45,6 +46,10 @@ module Contentful
 
         protected
 
+        def output(text = nil)
+          Support.output(text, @quiet)
+        end
+
         def create_file(name, url, properties = {})
           image = Contentful::Management::File.new
           image.properties[:contentType] = properties.fetch(:contentType, 'image/jpeg')
@@ -58,7 +63,7 @@ module Contentful
         def create_content_types
           content_types.each do |ct|
             begin
-              puts "Creating Content Type '#{ct['name']}'"
+              output "Creating Content Type '#{ct['name']}'"
 
               fields = []
               content_type = space.content_types.new
@@ -88,7 +93,7 @@ module Contentful
               content_type.save
               content_type.activate
             rescue Contentful::Management::Conflict
-              puts "ContentType '#{ct['id']}' already created! Skipping"
+              output "ContentType '#{ct['id']}' already created! Skipping"
               next
             end
           end
@@ -105,7 +110,7 @@ module Contentful
         def create_assets
           assets.each do |asset|
             begin
-              puts "Creating Asset '#{asset['title']}'"
+              output "Creating Asset '#{asset['title']}'"
               asset = space.assets.create(
                 id: asset['id'],
                 title: asset['title'],
@@ -124,7 +129,7 @@ module Contentful
                 attempts += 1
               end
             rescue Contentful::Management::Conflict
-              puts "Asset '#{asset['id']}' already created! Skipping"
+              output "Asset '#{asset['id']}' already created! Skipping"
               next
             end
           end
@@ -168,14 +173,14 @@ module Contentful
               end
 
               begin
-                puts "Creating Entry #{e[:id]}"
+                output "Creating Entry #{e[:id]}"
                 entry = content_type.entries.create({:id => e[:id]})
                 entry.save
 
                 e = e.clone
                 e[:id] = entry.id # in case no ID was specified in template
               rescue Contentful::Management::Conflict
-                puts "Entry '#{e[:id]}' already exists! Skipping"
+                output "Entry '#{e[:id]}' already exists! Skipping"
               ensure
                 next e
               end
@@ -183,7 +188,7 @@ module Contentful
           end.flatten
 
           processed_entries = processed_entries.map do |e|
-            puts "Populating Entry #{e[:id]}"
+            output "Populating Entry #{e[:id]}"
 
             entry = space.entries.find(e[:id])
             e.delete(:id)

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

@@ -16,8 +16,8 @@ module Contentful
 
         attr_reader :assets, :entries, :content_types
 
-        def initialize(space, file, mark_processed = false, all = true, skip_content_types = false)
-          super(space, skip_content_types)
+        def initialize(space, file, mark_processed = false, all = true, quiet = false, skip_content_types = false)
+          super(space, quiet, skip_content_types)
           @file = file
           @all = all
           @mark_processed = mark_processed
@@ -68,7 +68,7 @@ module Contentful
         def json
           @json ||= ::JSON.parse(::File.read(@file))
         rescue
-          puts 'File is not JSON. Exiting!'
+          output 'File is not JSON. Exiting!'
           exit(1)
         end
 
@@ -127,8 +127,8 @@ module Contentful
               processed_entry['id'] = entry[SYS_KEY]['id'] if entry.key?(SYS_KEY) && entry[SYS_KEY].key?('id')
 
               entry.fetch('fields', {}).each do |field, value|
-                link_fields << field if value.is_a? ::Hash
-                array_fields << field if value.is_a? ::Array
+                link_fields << field if is_link?(value)
+                array_fields << field if is_array?(value)
 
                 unless link_fields.include?(field) || array_fields.include?(field)
                   processed_entry[field] = value
@@ -141,7 +141,7 @@ module Contentful
 
               array_fields.each do |af|
                 processed_entry[af] = entry['fields'][af].map do |item|
-                  item.is_a?(::Hash) ? create_link(item) : item
+                  is_link?(item) ? create_link(item) : item
                 end
               end
 
@@ -172,6 +172,14 @@ module Contentful
         def mark_processed?
           @mark_processed
         end
+
+        def is_link?(value)
+          value.is_a?(::Hash) && value.key?('id') && value.key?('linkType')
+        end
+
+        def is_array?(value)
+          value.is_a?(::Array)
+        end
       end
     end
   end

data/lib/contentful/bootstrap/version.rb

@@ -1,6 +1,6 @@
 module Contentful
   module Bootstrap
-    VERSION = '3.4.0'
+    VERSION = '3.5.0'
 
     def self.major_version
       VERSION.split('.').first.to_i

data/spec/contentful/bootstrap/command_runner_spec.rb

@@ -12,7 +12,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'default values' do
         expect(Contentful::Bootstrap::Commands::CreateSpace).to receive(:new).with(
-          subject.token, 'foo', nil, nil, false, true
+          subject.token, 'foo', {}
         ).and_call_original
 
         subject.create_space('foo')
@@ -20,7 +20,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'with options' do
         expect(Contentful::Bootstrap::Commands::CreateSpace).to receive(:new).with(
-          subject.token, 'foo', 'bar', 'baz', true, false
+          subject.token, 'foo', template: 'bar', json_template: 'baz', mark_processed: true, trigger_oauth: false
         ).and_call_original
 
         subject.create_space('foo', template: 'bar', json_template: 'baz', mark_processed: true, trigger_oauth: false)
@@ -40,7 +40,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'default values' do
         expect(Contentful::Bootstrap::Commands::UpdateSpace).to receive(:new).with(
-          subject.token, 'foo', nil, false, true
+          subject.token, 'foo', {}
         ).and_call_original
 
         subject.update_space('foo')
@@ -48,7 +48,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'with options' do
         expect(Contentful::Bootstrap::Commands::UpdateSpace).to receive(:new).with(
-          subject.token, 'foo', 'bar', true, false
+          subject.token, 'foo', json_template: 'bar', mark_processed: true, trigger_oauth: false
         ).and_call_original
 
         subject.update_space('foo', json_template: 'bar', mark_processed: true, trigger_oauth: false)
@@ -69,7 +69,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'default values' do
         expect(Contentful::Bootstrap::Commands::GenerateToken).to receive(:new).with(
-          subject.token, 'foo', 'Bootstrap Token', true
+          subject.token, 'foo', {}
         ).and_call_original
 
         subject.generate_token('foo')
@@ -77,7 +77,7 @@ describe Contentful::Bootstrap::CommandRunner do
 
       it 'with options' do
         expect(Contentful::Bootstrap::Commands::GenerateToken).to receive(:new).with(
-          subject.token, 'foo', 'bar', false
+          subject.token, 'foo', name: 'bar', trigger_oauth: false
         ).and_call_original
 
         subject.generate_token('foo', name: 'bar', trigger_oauth: false)

data/spec/contentful/bootstrap/commands/base_spec.rb

@@ -7,7 +7,7 @@ describe Contentful::Bootstrap::Commands::Base do
   let(:no_token_path) { File.expand_path(File.join('spec', 'fixtures', 'ini_fixtures', 'no_token.ini')) }
   let(:token) { Contentful::Bootstrap::Token.new path }
   let(:non_management_token) { Contentful::Bootstrap::Token.new no_token_path }
-  subject { Contentful::Bootstrap::Commands::Base.new token, 'foo', false }
+  subject { described_class.new(token, 'foo', trigger_oauth: false, quiet: true) }
 
   describe 'abstract methods' do
     it '#run' do
@@ -18,35 +18,35 @@ describe Contentful::Bootstrap::Commands::Base do
   describe 'initialize' do
     describe 'configuration' do
       it 'runs configuration when trigger_oauth is true' do
-        expect_any_instance_of(subject.class).to receive(:configuration)
-        subject.class.new(token, 'foo')
+        expect_any_instance_of(described_class).to receive(:configuration)
+        described_class.new(token, 'foo', quiet: true)
       end
 
       it 'doesnt run configuration when trigger_oauth is false' do
-        expect_any_instance_of(subject.class).not_to receive(:configuration)
-        subject.class.new(token, 'foo', false)
+        expect_any_instance_of(described_class).not_to receive(:configuration)
+        described_class.new(token, 'foo', trigger_oauth: false, quiet: true)
       end
     end
 
     describe 'management_client_init' do
       it 'runs management_client_init when trigger_oauth is true' do
-        expect_any_instance_of(subject.class).to receive(:management_client_init)
-        subject.class.new(token, 'foo')
+        expect_any_instance_of(described_class).to receive(:management_client_init)
+        described_class.new(token, 'foo', quiet: true)
       end
 
       it 'doesnt run management_client_init when trigger_oauth is false' do
-        expect_any_instance_of(subject.class).not_to receive(:management_client_init)
-        subject.class.new(token, 'foo', false)
+        expect_any_instance_of(described_class).not_to receive(:management_client_init)
+        described_class.new(token, 'foo', trigger_oauth: false, quiet: true)
       end
     end
   end
 
   describe 'instance methods' do
     it '#management_client_init' do
-      allow_any_instance_of(subject.class).to receive(:configuration)
+      allow_any_instance_of(described_class).to receive(:configuration)
       expect(Contentful::Management::Client).to receive(:new).with(token.read, raise_errors: true)
 
-      subject.class.new(token, 'foo')
+      described_class.new(token, 'foo', quiet: true)
     end
 
     describe '#configuration' do
@@ -55,35 +55,35 @@ describe Contentful::Bootstrap::Commands::Base do
       end
 
       it 'passes if token is found' do
-        expect { subject.class.new(token, 'foo') }.to output("OAuth token found, moving on!\n").to_stdout
+        expect { described_class.new(token, 'foo') }.to output("OAuth token found, moving on!\n").to_stdout
       end
 
       describe 'token not found' do
         it 'exits if answer is no' do
-          expect_any_instance_of(subject.class).to receive(:gets) { "n\n" }
-          expect { subject.class.new(non_management_token, 'foo') }.to raise_error SystemExit
+          expect(Contentful::Bootstrap::Support).to receive(:gets) { "n" }
+          expect { described_class.new(non_management_token, 'foo', quiet: true) }.to raise_error SystemExit
         end
 
         it 'runs token_server if other answer' do
-          expect_any_instance_of(subject.class).to receive(:gets) { "y\n" }
-          expect_any_instance_of(subject.class).to receive(:token_server)
+          expect(Contentful::Bootstrap::Support).to receive(:gets) { "y" }
+          expect_any_instance_of(described_class).to receive(:token_server)
 
-          subject.class.new(non_management_token, 'foo')
+          described_class.new(non_management_token, 'foo', quiet: true)
         end
       end
     end
 
     it '#token_server' do
-      allow_any_instance_of(subject.class).to receive(:management_client_init)
+      allow_any_instance_of(described_class).to receive(:management_client_init)
 
-      expect_any_instance_of(subject.class).to receive(:gets) { "y\n" }
+      expect(Contentful::Bootstrap::Support).to receive(:gets) { "y" }
       expect_any_instance_of(Contentful::Bootstrap::Server).to receive(:start) {}
       expect_any_instance_of(Contentful::Bootstrap::Server).to receive(:running?) { true }
       expect(Net::HTTP).to receive(:get).with(URI('http://localhost:5123')) {}
       expect(non_management_token).to receive(:present?).and_return(false, true)
       expect_any_instance_of(Contentful::Bootstrap::Server).to receive(:stop) {}
 
-      subject.class.new(non_management_token, 'foo')
+      described_class.new(non_management_token, 'foo', quiet: true)
     end
   end
 
@@ -97,6 +97,20 @@ describe Contentful::Bootstrap::Commands::Base do
     end
   end
 
-  describe '#initialize' do
+  describe 'additional options' do
+    describe ':no_input' do
+      it ':no_input will disallow all input operations' do
+        expect_any_instance_of(described_class).not_to receive(:token_server)
+        expect(Contentful::Bootstrap::Support).not_to receive(:gets)
+        expect { described_class.new(non_management_token, 'foo', quiet: true, no_input: true) }.to raise_error "OAuth token required to proceed"
+      end
+
+      it 'without :no_input input operations are allowed' do
+        expect_any_instance_of(described_class).to receive(:token_server)
+        expect(Contentful::Bootstrap::Support).to receive(:gets) { "y" }
+        allow(non_management_token).to receive(:read) { true }
+        described_class.new(non_management_token, 'foo', quiet: true, no_input: false)
+      end
+    end
   end
 end