contentful_bootstrap 3.10.0 → 3.11.0

data/contentful_bootstrap.gemspec

@@ -27,9 +27,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency 'listen', '~> 3.0.0'
+  spec.add_development_dependency 'listen', '~> 3.0'
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+
   spec.add_runtime_dependency "launchy"
-  spec.add_runtime_dependency "contentful-management", '~> 1.10'
-  spec.add_runtime_dependency "contentful", ">= 2.1.0", "< 3"
+  spec.add_runtime_dependency "contentful-management", '~> 2.0', '>= 2.0.2'
+  spec.add_runtime_dependency "contentful", "~> 2.6.0"
   spec.add_runtime_dependency "inifile"
 end

data/lib/contentful/bootstrap/command_runner.rb

@@ -32,16 +32,18 @@ module Contentful
       def generate_json(space_id, options = {})
         filename = options.fetch(:filename, nil)
         access_token = options.fetch(:access_token, nil)
+        environment = options.fetch(:environment, 'master')
         content_types_only = options.fetch(:content_types_only, false)
         quiet = options.fetch(:quiet, false)
         use_preview = options.fetch(:use_preview, false)
         content_type_ids = options.fetch(:content_type_ids, [])
 
-        fail 'Access Token required' if access_token.nil?
+        raise 'Access Token required' if access_token.nil?
 
         Contentful::Bootstrap::Commands::GenerateJson.new(
           space_id,
           access_token,
+          environment,
           filename,
           content_types_only,
           quiet,

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

@@ -7,7 +7,7 @@ module Contentful
   module Bootstrap
     module Commands
       class Base
-        attr_reader :space, :token, :options, :quiet, :no_input, :client
+        attr_reader :space, :token, :options, :quiet, :no_input
 
         def initialize(token, space, options = {})
           trigger_oauth = options.fetch(:trigger_oauth, true)
@@ -18,32 +18,32 @@ module Contentful
           @no_input = options.fetch(:no_input, false)
 
           configuration if trigger_oauth
-          management_client_init if trigger_oauth
+          client if trigger_oauth
           @space = space
         end
 
         def run
-          fail 'must implement'
+          raise 'must implement'
         end
 
-        protected
-
-        def output(text = nil)
-          Support.output(text, @quiet)
-        end
-
-        private
-
-        def management_client_init
+        def client
           @client ||= ::Contentful::Management::Client.new(
             @token.read,
-            default_locale: options.fetch(:locale, "en-US"),
+            default_locale: options.fetch(:locale, 'en-US'),
             raise_errors: true,
             application_name: 'bootstrap',
             application_version: ::Contentful::Bootstrap::VERSION
           )
         end
 
+        protected
+
+        def output(text = nil)
+          Support.output(text, @quiet)
+        end
+
+        private
+
         def configuration
           if @token.present?
             output 'OAuth token found, moving on!'
@@ -51,13 +51,13 @@ module Contentful
           end
 
           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'
+            if answer.casecmp('n').zero?
               output 'Exiting!'
               exit
             end
           end
 
-          fail 'OAuth token required to proceed' if no_input
+          raise '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'

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

@@ -13,8 +13,9 @@ module Contentful
           @template_name = options.fetch(:template, nil)
           @json_template = options.fetch(:json_template, nil)
           @mark_processed = options.fetch(:mark_processed, false)
-          @locale = options.fetch(:locale, "en-US")
+          @locale = options.fetch(:locale, 'en-US')
           @no_publish = options.fetch(:no_publish, false)
+          @environment = 'master' # Can only add content to a new space through the master environment by default
 
           super(token, space, options)
         end
@@ -51,10 +52,9 @@ module Contentful
               defaultLocale: @locale
             }
             options[:organization_id] = @token.read_organization_id unless @token.read_organization_id.nil?
-            management_client_init
             new_space = client.spaces.create(options)
           rescue Contentful::Management::NotFound
-            fail "Organization ID is required, provide it in Configuration File" if no_input
+            raise 'Organization ID is required, provide it in Configuration File' if no_input
 
             output 'Your account has multiple organizations:'
             output organizations.join("\n")
@@ -76,7 +76,6 @@ module Contentful
         private
 
         def organizations
-          management_client_init
           organizations = client.organizations.all
           organization_ids = organizations.map do |organization|
             sprintf('%-30s %s', organization.name, organization.id)
@@ -96,7 +95,7 @@ module Contentful
           if templates.key? @template_name.to_sym
             output "Creating Template '#{@template_name}'"
 
-            templates[@template_name.to_sym].new(space, quiet).run
+            templates[@template_name.to_sym].new(space, @environment, quiet).run
             output "Template '#{@template_name}' created!"
           else
             output "Template '#{@template_name}' not found. Valid templates are '#{templates.keys.map(&:to_s).join('\', \'')}'"
@@ -107,7 +106,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, false, @no_publish).run
+            Templates::JsonTemplate.new(space, @json_template, @environment, @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,10 +5,20 @@ module Contentful
   module Bootstrap
     module Commands
       class GenerateJson
-        attr_reader :space_id, :filename, :access_token, :content_types_only, :use_preview, :content_type_ids
-        def initialize(space_id, access_token, filename = nil, content_types_only = false, quiet = false, use_preview = false, content_type_ids = [])
+        attr_reader :space_id, :filename, :access_token, :content_types_only, :use_preview, :content_type_ids, :environment
+        def initialize(
+            space_id,
+            access_token,
+            environment = 'master',
+            filename = nil,
+            content_types_only = false,
+            quiet = false,
+            use_preview = false,
+            content_type_ids = []
+        )
           @space_id = space_id
           @access_token = access_token
+          @environment = environment
           @filename = filename
           @content_types_only = content_types_only
           @quiet = quiet
@@ -29,6 +39,7 @@ module Contentful
           json = Contentful::Bootstrap::Generator.new(
             space_id,
             access_token,
+            environment,
             content_types_only,
             use_preview,
             content_type_ids

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

@@ -24,7 +24,7 @@ module Contentful
 
           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'
+            unless answer.casecmp('n').zero?
               @token.write_access_token(@actual_space.name, access_token)
               @token.write_space_id(@actual_space.name, @actual_space.id)
             end
@@ -34,11 +34,11 @@ module Contentful
         end
 
         def fetch_space
-          if @space.is_a?(String)
-            @actual_space = client.spaces.find(@space)
-          else
-            @actual_space = @space
-          end
+          @actual_space = if @space.is_a?(String)
+                            client.spaces.find(@space)
+                          else
+                            @space
+                          end
         end
 
         def fetch_access_token

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

@@ -14,6 +14,7 @@ module Contentful
           @skip_content_types = options.fetch(:skip_content_types, false)
           @no_publish = options.fetch(:no_publish, false)
           @quiet = options.fetch(:quiet, false)
+          @environment = options.fetch(:environment, 'master')
 
           super(token, space_id, options)
         end
@@ -39,7 +40,6 @@ module Contentful
         protected
 
         def fetch_space
-          management_client_init
           client.spaces.find(@space)
         rescue Contentful::Management::NotFound
           output 'Space Not Found. Exiting!'
@@ -51,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, @quiet, @skip_content_types, @no_publish).run
+            Templates::JsonTemplate.new(space, @json_template, @environment, @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

@@ -12,10 +12,11 @@ module Contentful
 
       attr_reader :content_types_only, :content_type_ids, :client
 
-      def initialize(space_id, access_token, content_types_only, use_preview, content_type_ids)
+      def initialize(space_id, access_token, environment, content_types_only, use_preview, content_type_ids)
         @client = Contentful::Client.new(
-          access_token: access_token,
           space: space_id,
+          access_token: access_token,
+          environment: environment,
           application_name: 'bootstrap',
           application_version: ::Contentful::Bootstrap::VERSION,
           api_url: use_preview ? PREVIEW_API_URL : DELIVERY_API_URL
@@ -137,9 +138,9 @@ module Contentful
       def map_field_properties(field)
         properties = {}
 
-        [:id, :name, :type, :link_type, :required, :localized].each do |property|
+        %i[id name type link_type required localized].each do |property|
           value = field.public_send(property) if field.respond_to?(property)
-          properties[Support.camel_case(property.to_s).to_sym] = value unless value.nil? || [:required, :localized].include?(property)
+          properties[Support.camel_case(property.to_s).to_sym] = value unless value.nil? || %i[required localized].include?(property)
         end
 
         items = field.items if field.respond_to?(:items)

data/lib/contentful/bootstrap/support.rb

@@ -4,7 +4,7 @@ module Contentful
   module Bootstrap
     module Support
       def self.camel_case(a_string)
-        a_string.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+        a_string.split('_').each_with_object([]) { |e, a| a.push(a.empty? ? e : e.capitalize) }.join
       end
 
       def self.silence_stderr

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

@@ -6,10 +6,10 @@ module Contentful
   module Bootstrap
     module Templates
       class Base
-        attr_reader :space, :skip_content_types
+        attr_reader :environment, :skip_content_types
 
-        def initialize(space, quiet = false, skip_content_types = false, no_publish = false)
-          @space = space
+        def initialize(space, environment_id = 'master', quiet = false, skip_content_types = false, no_publish = false)
+          @environment = space.environments.find(environment_id)
           @quiet = quiet
           @skip_content_types = skip_content_types
           @no_publish = no_publish
@@ -42,8 +42,7 @@ module Contentful
           []
         end
 
-        def after_run
-        end
+        def after_run; end
 
         protected
 
@@ -54,7 +53,7 @@ module Contentful
         def create_file(name, url, properties = {})
           image = Contentful::Management::File.new
           image.properties[:contentType] = properties.fetch(:contentType, 'image/jpeg')
-          image.properties[:fileName] = "#{name}"
+          image.properties[:fileName] = name.to_s
           image.properties[:upload] = url
           image
         end
@@ -67,12 +66,6 @@ module Contentful
               output "Creating Content Type '#{ct['name']}'"
 
               fields = []
-              content_type = space.content_types.new
-              content_type.id = ct['id']
-              content_type.name = ct['name']
-              content_type.display_field = ct['displayField']
-              content_type.description = ct['description']
-
               ct['fields'].each do |f|
                 field = Contentful::Management::Field.new
                 field.id = f['id']
@@ -90,8 +83,14 @@ module Contentful
                 fields << field
               end
 
-              content_type.fields = fields
-              content_type.save
+              content_type = environment.content_types.create(
+                id: ct['id'],
+                name: ct['name'],
+                displayField: ct['displayField'],
+                description: ct['description'],
+                fields: fields
+              )
+
               content_type.activate
             rescue Contentful::Management::Conflict
               output "ContentType '#{ct['id']}' already created! Skipping"
@@ -112,7 +111,7 @@ module Contentful
           assets.each do |asset_json|
             begin
               output "Creating Asset '#{asset_json['title']}'"
-              asset = space.assets.create(
+              asset = environment.assets.create(
                 id: asset_json['id'],
                 title: asset_json['title'],
                 file: asset_json['file']
@@ -121,7 +120,7 @@ module Contentful
             rescue Contentful::Management::Conflict
               output "Asset '#{asset_json['id']}' already created! Updating instead."
 
-              asset = space.assets.find(asset_json['id']).tap do |a|
+              asset = environment.assets.find(asset_json['id']).tap do |a|
                 a.title = asset_json['title']
                 a.file = asset_json['file']
               end
@@ -134,7 +133,7 @@ module Contentful
           assets.each do |asset_json|
             attempts = 0
             while attempts < 10
-              asset = space.assets.find(asset_json['id'])
+              asset = environment.assets.find(asset_json['id'])
               unless asset.file.url.nil?
                 asset.publish unless @no_publish
                 break
@@ -149,7 +148,7 @@ module Contentful
         def create_entries
           content_types = []
           processed_entries = entries.map do |content_type_id, entry_list|
-            content_type = space.content_types.find(content_type_id)
+            content_type = environment.content_types.find(content_type_id)
             content_types << content_type
 
             entry_list.each.map do |e|
@@ -177,15 +176,13 @@ module Contentful
 
               regular_fields.each do |rf|
                 value = e.delete(rf)
-                if value.is_a? ::Contentful::Bootstrap::Templates::Links::Base
-                  value = value.to_management_object
-                end
+                value = value.to_management_object if value.is_a? ::Contentful::Bootstrap::Templates::Links::Base
                 e[rf.to_sym] = value
               end
 
               begin
                 output "Creating Entry #{e[:id]}"
-                entry = content_type.entries.create({:id => e[:id]})
+                entry = content_type.entries.create(id: e[:id])
                 entry.save
 
                 e = e.clone
@@ -201,13 +198,13 @@ module Contentful
           processed_entries = processed_entries.map do |e|
             output "Populating Entry #{e[:id]}"
 
-            entry = space.entries.find(e[:id])
+            entry = environment.entries.find(e[:id])
             e.delete(:id)
             entry.update(e)
             entry.save
 
             10.times do
-              break if space.entries.find(entry.id).sys[:version] >= 4
+              break if environment.entries.find(entry.id).sys[:version] >= 4
               sleep(0.5)
             end
 
@@ -215,7 +212,7 @@ module Contentful
           end
 
           processed_entries.each do |e|
-            space.entries.find(e).publish unless @no_publish
+            environment.entries.find(e).publish unless @no_publish
           end
         end
       end

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

@@ -6,29 +6,29 @@ module Contentful
   module Bootstrap
     module Templates
       class JsonTemplate < Base
-        CONTENT_TYPES_KEY = 'contentTypes'
-        ENTRIES_KEY = 'entries'
-        ASSETS_KEY = 'assets'
-        BOOTSTRAP_PROCCESSED_KEY = 'bootstrapProcessed'
-        DISPLAY_FIELD_KEY = 'displayField'
-        ALTERNATE_DISPLAY_FIELD_KEY = 'display_field'
-        SYS_KEY = 'sys'
+        CONTENT_TYPES_KEY = 'contentTypes'.freeze
+        ENTRIES_KEY = 'entries'.freeze
+        ASSETS_KEY = 'assets'.freeze
+        BOOTSTRAP_PROCCESSED_KEY = 'bootstrapProcessed'.freeze
+        DISPLAY_FIELD_KEY = 'displayField'.freeze
+        ALTERNATE_DISPLAY_FIELD_KEY = 'display_field'.freeze
+        SYS_KEY = 'sys'.freeze
 
         attr_reader :assets, :entries, :content_types
 
-        def initialize(space, file, mark_processed = false, all = true, quiet = false, skip_content_types = false, no_publish = false)
-          super(space, quiet, skip_content_types, no_publish)
+        def initialize(space, file, environment = 'master', mark_processed = false, all = true, quiet = false, skip_content_types = false, no_publish = false)
           @file = file
+          json
+          check_version
+
+          super(space, environment, quiet, skip_content_types, no_publish)
+
           @all = all
           @mark_processed = mark_processed
 
-          json
-
           @assets = process_assets
           @entries = process_entries
           @content_types = process_content_types
-
-          check_version
         end
 
         def after_run
@@ -66,30 +66,32 @@ module Contentful
 
         def parse_json
           ::JSON.parse(::File.read(@file))
-        rescue
+        rescue StandardError
           output 'File is not JSON. Exiting!'
           exit(1)
         end
 
         def check_version
           json_version = json.fetch('version', 0)
-          gem_major_version = Contentful::Bootstrap.major_version
-          unless gem_major_version == json_version
-            fail "JSON Templates Version Mismatch. Current Version: #{gem_major_version}"
-          end
+          gem_major = Contentful::Bootstrap.major_version
+          raise "JSON Templates Version Mismatch. Current Version: #{gem_major}" unless gem_major == json_version
         end
 
         def process_content_types
           processed_content_types = json.fetch(CONTENT_TYPES_KEY, [])
 
           unless all?
-            processed_content_types = processed_content_types.select do |content_type|
-              !content_type.fetch(BOOTSTRAP_PROCCESSED_KEY, false)
+            processed_content_types = processed_content_types.reject do |content_type|
+              content_type.fetch(BOOTSTRAP_PROCCESSED_KEY, false)
             end
           end
 
           processed_content_types.each do |content_type|
-            content_type[DISPLAY_FIELD_KEY] = content_type.key?(ALTERNATE_DISPLAY_FIELD_KEY) ? content_type.delete(ALTERNATE_DISPLAY_FIELD_KEY) : content_type[DISPLAY_FIELD_KEY]
+            content_type[DISPLAY_FIELD_KEY] = if content_type.key?(ALTERNATE_DISPLAY_FIELD_KEY)
+                                                content_type.delete(ALTERNATE_DISPLAY_FIELD_KEY)
+                                              else
+                                                content_type[DISPLAY_FIELD_KEY]
+                                              end
           end
 
           processed_content_types
@@ -99,8 +101,8 @@ module Contentful
           unprocessed_assets = json.fetch(ASSETS_KEY, [])
 
           unless all?
-            unprocessed_assets = unprocessed_assets.select do |asset|
-              !asset.fetch(BOOTSTRAP_PROCCESSED_KEY, false)
+            unprocessed_assets = unprocessed_assets.reject do |asset|
+              asset.fetch(BOOTSTRAP_PROCCESSED_KEY, false)
             end
           end
 
@@ -108,57 +110,48 @@ module Contentful
             asset['file'] = create_file(
               asset['file']['filename'],
               asset['file']['url'],
-              { contentType: asset['file'].fetch('contentType', 'image/jpeg') }
+              contentType: asset['file'].fetch('contentType', 'image/jpeg')
             )
             asset
           end
         end
 
+        def process_entry(entry)
+          processed_entry = {}
+          processed_entry['id'] = entry[SYS_KEY]['id'] if entry.key?(SYS_KEY) && entry[SYS_KEY].key?('id')
+
+          entry.fetch('fields', {}).each do |field, value|
+            if link?(value)
+              processed_entry[field] = create_link(value)
+              next
+            elsif array?(value)
+              processed_entry[field] = value.map { |i| link?(i) ? create_link(i) : i }
+              next
+            end
+
+            processed_entry[field] = value
+          end
+
+          processed_entry
+        end
+
         def process_entries
-          processed_entries = {}
           unprocessed_entries = json.fetch(ENTRIES_KEY, {})
-          unprocessed_entries.each do |content_type_id, entry_list|
+          unprocessed_entries.each_with_object({}) do |(content_type_id, entry_list), processed_entries|
             entries_for_content_type = []
 
             unless all?
-              entry_list = entry_list.select do |entry|
-                !entry[SYS_KEY].fetch(BOOTSTRAP_PROCCESSED_KEY, false)
+              entry_list = entry_list.reject do |entry|
+                entry[SYS_KEY].fetch(BOOTSTRAP_PROCCESSED_KEY, false)
               end
             end
 
             entry_list.each do |entry|
-              processed_entry = {}
-              array_fields = []
-              link_fields = []
-
-              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 link?(value)
-                array_fields << field if array?(value)
-
-                unless link_fields.include?(field) || array_fields.include?(field)
-                  processed_entry[field] = value
-                end
-              end
-
-              link_fields.each do |lf|
-                processed_entry[lf] = create_link(entry['fields'][lf])
-              end
-
-              array_fields.each do |af|
-                processed_entry[af] = entry['fields'][af].map do |item|
-                  link?(item) ? create_link(item) : item
-                end
-              end
-
-              entries_for_content_type << processed_entry
+              entries_for_content_type << process_entry(entry)
             end
 
             processed_entries[content_type_id] = entries_for_content_type
           end
-
-          processed_entries
         end
 
         def create_link(link_properties)