contentful_bootstrap 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aed4d8f7790b4347e4b97050a049803f83ec1384
-  data.tar.gz: 91d3a12fd648ab548711294e39e9399bbb4c6e03
+  metadata.gz: d4714e403b05588c84e46a5f5e66af2224eb566d
+  data.tar.gz: a2ef00692e18a5f7251c88b3ffdba02be6a6f39e
 SHA512:
-  metadata.gz: a862d0a72856f0707f3ab2cd5920cef7484ea06b051cc308a6e03b45af3b60006dd86c86c4ffa23a9feaf8ed34e6811e813a24d5076bca28abe2d85e47ff2969
-  data.tar.gz: 31596e9e9211c8ec76daff969d3a79c2ea9aa6e7901ede6ab0b4b63ab7b1b4ecb7627664db8708c3841fc21fe425b96845a96a4eab0e43d519148fc0a5574faa
+  metadata.gz: 79e35a1d6e63c0bc61b9e8e3eb0ad0cf8a4222c8ebaf2a010d3cf75f728304d8384b24f1ac129415d254bcfc8d5ea0e3045d243612b1dba64538be9a0dbc84dc
+  data.tar.gz: 03aa80d7fa3ac65ed38a27515eed71605715605de6ecf5a191d04ce9fc0e0277b8fbb6a114113029e093cad3faddf9c696515c39758d21119819d7caae2841c0

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## v3.3.0
+### Added
+* Adds possibility to change `contentType` for Assets [#39](https://github.com/contentful/contentful-bootstrap.rb/issues/39)
+* Adds `--content-types-only` option to `generate_json`
+* Adds `--skip-content-types` option to `update_space`
+
+### Fixed
+* Fixes a bug in built-in templates using obsolete `link_type` properties
+
 ## v3.2.0
 ### Added
 * Adds `update_space` command to update already existing spaces using JSON Templates

data/Gemfile

@@ -7,3 +7,4 @@ gem "launchy"
 gem "inifile"
 gem "contentful-management"
 gem "contentful", "~> 0.7", ">= 0.7.3"
+gem 'pry'

data/README.md

@@ -7,7 +7,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 powerful API. Contentful offers tools for managing editorial
+and publish it anywhere via a powerful API. Contentful offers tools for managing editorial
 teams and enabling cooperation between organizations.
 
 ## What does `contentful_bootstrap` do?
@@ -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> <access_token> [--output-file OUTPUT PATH]
+$ contentful_bootstrap generate_json <space_id> <delivery_api_access_token> [--output-file OUTPUT PATH] [--content-types-only]
 ```
 
 You can update existing spaces from JSON Templates by doing:
 
 ```bash
-$ contentful_bootstrap update_space <space_id> -j template_path [--mark-processed]
+$ contentful_bootstrap update_space <space_id> -j template_path [--mark-processed] [--skip-content-types]
 ```
 
 ### Built-in templates
@@ -99,7 +99,8 @@ To Update an existing Space
 options = {
   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 on future update_space calls
-  trigger_oauth: true # if true will trigger OAuth process
+  trigger_oauth: true, # if true will trigger OAuth process
+  skip_content_types: false, # if true will avoid creating the content types
 }
 Contentful::Bootstrap::CommandRunner.new.update_space("space_id", options)
 ```
@@ -123,7 +124,11 @@ Contentful::Bootstrap::CommandRunner.new.generate_token("space_id", options)
 To Generate a JSON Template from an exising Space
 
 ```ruby
-Contentful::Bootstrap::CommandRunner.new.generate_json("space_id", access_token: "access_token")
+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
+)
 ```
 
 Additionally, you can send an options hash with the following keys:
@@ -156,7 +161,7 @@ CONTENTFUL_MANAGEMENT_ACCESS_TOKEN = a_management_access_token
 
 [space_name]
 SPACE_ID = some_space_id ; Space configurations are not required by this tool, but can be generated by it
-CONTENTFUL_DELIVERY_ACCESS_TOKEN = a_delivery_acces_token      ; Delivery Access Token is not required for this tool, but can be generated by it
+CONTENTFUL_DELIVERY_ACCESS_TOKEN = a_delivery_acces_token
 ```
 
 ### JSON Templates

data/bin/contentful_bootstrap

@@ -32,6 +32,9 @@ subcommands = {
     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|
+      options[:skip_content_types] = t
+    end
     opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
       options[:config_path] = c
     end
@@ -53,6 +56,9 @@ subcommands = {
   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|
+      options[:content_types_only] = t
+    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

@@ -44,11 +44,12 @@ module Contentful
       def generate_json(space_id, options = {})
         filename = options.fetch(:filename, nil)
         access_token = options.fetch(:access_token, nil)
+        content_types_only = options.fetch(:content_types_only, false)
 
         fail 'Access Token required' if access_token.nil?
 
         Contentful::Bootstrap::Commands::GenerateJson.new(
-          space_id, access_token, filename
+          space_id, access_token, filename, content_types_only
         ).run
       end
     end

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

@@ -5,11 +5,12 @@ module Contentful
   module Bootstrap
     module Commands
       class GenerateJson
-        attr_reader :space_id, :filename, :access_token
-        def initialize(space_id, access_token, filename = nil)
+        attr_reader :space_id, :filename, :access_token, :content_types_only
+        def initialize(space_id, access_token, filename = nil, content_types_only = false)
           @space_id = space_id
           @access_token = access_token
           @filename = filename
+          @content_types_only = content_types_only
         end
 
         def run
@@ -21,7 +22,7 @@ module Contentful
 
           puts "Generating JSON Template '#{filename}' for Space: '#{space_id}'"
 
-          json = Contentful::Bootstrap::Generator.new(space_id, access_token).generate_json
+          json = Contentful::Bootstrap::Generator.new(space_id, access_token, content_types_only).generate_json
 
           puts
           write(json)

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

@@ -8,10 +8,11 @@ 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)
+        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
         end
 
         def run
@@ -46,7 +47,7 @@ module Contentful
         def update_json_template(space)
           if ::File.exist?(@json_template)
             puts "Updating from JSON Template '#{@json_template}'"
-            Templates::JsonTemplate.new(space, @json_template, @mark_processed, false).run
+            Templates::JsonTemplate.new(space, @json_template, @mark_processed, false, @skip_content_types).run
             puts "JSON Template '#{@json_template}' updated!"
           else
             puts "JSON Template '#{@json_template}' does not exist. Please check that you specified the correct file name."

data/lib/contentful/bootstrap/generator.rb

@@ -7,8 +7,11 @@ require 'contentful/bootstrap/version'
 module Contentful
   module Bootstrap
     class Generator
-      def initialize(space_id, access_token)
+      attr_reader :content_types_only
+
+      def initialize(space_id, access_token, content_types_only)
         @client = Contentful::Client.new(access_token: access_token, space: space_id)
+        @content_types_only = content_types_only
       end
 
       def generate_json
@@ -23,6 +26,8 @@ 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'] = {
@@ -49,6 +54,8 @@ module Contentful
       end
 
       def entries
+        return {} if content_types_only
+
         entries = {}
 
         @client.entries(limit: 1000).each do |entry|

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

@@ -6,14 +6,15 @@ module Contentful
   module Bootstrap
     module Templates
       class Base
-        attr_reader :space
+        attr_reader :space, :skip_content_types
 
-        def initialize(space)
+        def initialize(space, skip_content_types = false)
           @space = space
+          @skip_content_types = skip_content_types
         end
 
         def run
-          create_content_types
+          create_content_types unless skip_content_types
           create_assets
           create_entries
 
@@ -44,10 +45,10 @@ module Contentful
 
         protected
 
-        def create_image(name, url)
+        def create_file(name, url, properties = {})
           image = Contentful::Management::File.new
-          image.properties[:contentType] = 'image/jpeg'
-          image.properties[:fileName] = "#{name}.jpg"
+          image.properties[:contentType] = properties.fetch(:contentType, 'image/jpeg')
+          image.properties[:fileName] = "#{name}"
           image.properties[:upload] = url
           image
         end
@@ -63,7 +64,7 @@ module Contentful
               content_type = space.content_types.new
               content_type.id = ct['id']
               content_type.name = ct['name']
-              content_type.display_field = ct['display_field']
+              content_type.display_field = ct['displayField']
               content_type.description = ct['description']
 
               ct['fields'].each do |f|

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

@@ -10,7 +10,7 @@ module Contentful
             {
               'id' => 'author',
               'name' => 'Author',
-              'display_field' => 'name',
+              'displayField' => 'name',
               'fields' => [
                 {
                   'id' => 'name',
@@ -22,7 +22,7 @@ module Contentful
             {
               'id' => 'post',
               'name' => 'Post',
-              'display_field' => 'title',
+              'displayField' => 'title',
               'fields' => [
                 {
                   'id' => 'title',
@@ -38,7 +38,7 @@ module Contentful
                   'id' => 'author',
                   'name' => 'Author',
                   'type' => 'Link',
-                  'link_type' => 'Entry'
+                  'linkType' => 'Entry'
                 }
               ]
             }

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

@@ -10,7 +10,7 @@ module Contentful
             {
               'id' => 'brand',
               'name' => 'Brand',
-              'display_field' => 'name',
+              'displayField' => 'name',
               'fields' => [
                 {
                   'id' => 'name',
@@ -26,14 +26,14 @@ module Contentful
                   'id' => 'logo',
                   'name' => 'Logo',
                   'type' => 'Link',
-                  'link_type' => 'Asset'
+                  'linkType' => 'Asset'
                 }
               ]
             },
             {
               'id' => 'category',
               'name' => 'Category',
-              'display_field' => 'title',
+              'displayField' => 'title',
               'fields' => [
                 {
                   'id' => 'title',
@@ -49,14 +49,14 @@ module Contentful
                   'id' => 'icon',
                   'name' => 'Icon',
                   'type' => 'Link',
-                  'link_type' => 'Asset'
+                  'linkType' => 'Asset'
                 }
               ]
             },
             {
               'id' => 'product',
               'name' => 'Product',
-              'display_field' => 'name',
+              'displayField' => 'name',
               'fields' => [
                 {
                   'id' => 'name',
@@ -72,19 +72,19 @@ module Contentful
                   'id' => 'image',
                   'name' => 'Image',
                   'type' => 'Link',
-                  'link_type' => 'Asset'
+                  'linkType' => 'Asset'
                 },
                 {
                   'id' => 'brand',
                   'name' => 'Brand',
                   'type' => 'Link',
-                  'link_type' => 'Entry'
+                  'linkType' => 'Entry'
                 },
                 {
                   'id' => 'category',
                   'name' => 'Category',
                   'type' => 'Link',
-                  'link_type' => 'Entry'
+                  'linkType' => 'Entry'
                 },
                 {
                   'id' => 'url',
@@ -101,32 +101,32 @@ module Contentful
             {
               'id' => 'playsam_image',
               'title' => 'Playsam',
-              'file' => create_image('playsam_image', 'https://images.contentful.com/liicpxzmg1q0/4zj1ZOfHgQ8oqgaSKm4Qo2/3be82d54d45b5297e951aee9baf920da/playsam.jpg?h=250&')
+              'file' => create_file('playsam_image.jpg', 'https://images.contentful.com/liicpxzmg1q0/4zj1ZOfHgQ8oqgaSKm4Qo2/3be82d54d45b5297e951aee9baf920da/playsam.jpg?h=250&')
             },
             {
               'id' => 'normann_image',
               'title' => 'Normann',
-              'file' => create_image('normann_image', 'https://images.contentful.com/liicpxzmg1q0/3wtvPBbBjiMKqKKga8I2Cu/75c7c92f38f7953a741591d215ad61d4/zJYzDlGk.jpeg?h=250&')
+              'file' => create_file('normann_image.jpg', 'https://images.contentful.com/liicpxzmg1q0/3wtvPBbBjiMKqKKga8I2Cu/75c7c92f38f7953a741591d215ad61d4/zJYzDlGk.jpeg?h=250&')
             },
             {
               'id' => 'toy_image',
               'title' => 'Toys',
-              'file' => create_image('toy_image', 'https://images.contentful.com/liicpxzmg1q0/6t4HKjytPi0mYgs240wkG/866ef53a11af9c6bf5f3808a8ce1aab2/toys_512pxGREY.png?h=250&')
+              'file' => create_file('toy_image.jpg', 'https://images.contentful.com/liicpxzmg1q0/6t4HKjytPi0mYgs240wkG/866ef53a11af9c6bf5f3808a8ce1aab2/toys_512pxGREY.png?h=250&')
             },
             {
               'id' => 'kitchen_image',
               'title' => 'Kitchen and Home',
-              'file' => create_image('kitchen_image', 'https://images.contentful.com/liicpxzmg1q0/6m5AJ9vMPKc8OUoQeoCS4o/ffc20f5a8f2a71cca4801bc9c51b966a/1418244847_Streamline-18-256.png?h=250&')
+              'file' => create_file('kitchen_image.jpg', 'https://images.contentful.com/liicpxzmg1q0/6m5AJ9vMPKc8OUoQeoCS4o/ffc20f5a8f2a71cca4801bc9c51b966a/1418244847_Streamline-18-256.png?h=250&')
             },
             {
               'id' => 'toy_car',
               'title' => 'Playsam Toy Car',
-              'file' => create_image('toy_car', 'https://images.contentful.com/liicpxzmg1q0/wtrHxeu3zEoEce2MokCSi/acef70d12fe019228c4238aa791bdd48/quwowooybuqbl6ntboz3.jpg?h=250&')
+              'file' => create_file('toy_car.jpg', 'https://images.contentful.com/liicpxzmg1q0/wtrHxeu3zEoEce2MokCSi/acef70d12fe019228c4238aa791bdd48/quwowooybuqbl6ntboz3.jpg?h=250&')
             },
             {
               'id' => 'whiskers',
               'title' => 'Normann Whisk Beaters',
-              'file' => create_image('whiskers', 'https://images.contentful.com/liicpxzmg1q0/10TkaLheGeQG6qQGqWYqUI/d510dde5e575d40288cf75b42383aa53/ryugj83mqwa1asojwtwb.jpg?h=250&')
+              'file' => create_file('whiskers.jpg', 'https://images.contentful.com/liicpxzmg1q0/10TkaLheGeQG6qQGqWYqUI/d510dde5e575d40288cf75b42383aa53/ryugj83mqwa1asojwtwb.jpg?h=250&')
             }
           ]
         end

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

@@ -10,7 +10,7 @@ module Contentful
             {
               'id' => 'author',
               'name' => 'Author',
-              'display_field' => 'name',
+              'displayField' => 'name',
               'fields' => [
                 {
                   'name' => 'Name',
@@ -22,7 +22,7 @@ module Contentful
             {
               'id' => 'image',
               'name' => 'Image',
-              'display_field' => 'title',
+              'displayField' => 'title',
               'fields' => [
                 {
                   'id' => 'title',
@@ -33,14 +33,14 @@ module Contentful
                   'id' => 'photo',
                   'name' => 'Photo',
                   'type' => 'Link',
-                  'link_type' => 'Asset'
+                  'linkType' => 'Asset'
                 }
               ]
             },
             {
               'id' => 'gallery',
               'name' => 'Gallery',
-              'display_field' => 'title',
+              'displayField' => 'title',
               'fields' => [
                 {
                   'id' => 'title',
@@ -51,7 +51,7 @@ module Contentful
                   'id' => 'author',
                   'name' => 'Author',
                   'type' => 'Link',
-                  'link_type' => 'Entry'
+                  'linkType' => 'Entry'
                 },
                 {
                   'id' => 'images',
@@ -59,7 +59,7 @@ module Contentful
                   'type' => 'Array',
                   'items' => {
                     'type' => 'Link',
-                    'link_type' => 'Entry'
+                    'linkType' => 'Entry'
                   }
                 }
               ]
@@ -72,12 +72,12 @@ module Contentful
             {
               'id' => 'pie',
               'title' => 'Pie in the Sky',
-              'file' => create_image('pie', 'https://c2.staticflickr.com/6/5245/5335909339_d307a7cbcf_b.jpg')
+              'file' => create_file('pie.jpg', 'https://c2.staticflickr.com/6/5245/5335909339_d307a7cbcf_b.jpg')
             },
             {
               'id' => 'flower',
               'title' => 'The Flower',
-              'file' => create_image('flower', 'http://c2.staticflickr.com/4/3922/15045568809_b24591e318_b.jpg')
+              'file' => create_file('flower.jpg', 'http://c2.staticflickr.com/4/3922/15045568809_b24591e318_b.jpg')
             }
           ]
         end

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

@@ -10,14 +10,14 @@ module Contentful
         ENTRIES_KEY = 'entries'
         ASSETS_KEY = 'assets'
         BOOTSTRAP_PROCCESSED_KEY = 'bootstrapProcessed'
-        DISPLAY_FIELD_KEY = 'display_field'
-        ALTERNATE_DISPLAY_FIELD_KEY = 'displayField'
+        DISPLAY_FIELD_KEY = 'displayField'
+        ALTERNATE_DISPLAY_FIELD_KEY = 'display_field'
         SYS_KEY = 'sys'
 
         attr_reader :assets, :entries, :content_types
 
-        def initialize(space, file, mark_processed = false, all = true)
-          @space = space
+        def initialize(space, file, mark_processed = false, all = true, skip_content_types = false)
+          super(space, skip_content_types)
           @file = file
           @all = all
           @mark_processed = mark_processed
@@ -98,9 +98,10 @@ module Contentful
           end
 
           unprocessed_assets.map do |asset|
-            asset['file'] = create_image(
+            asset['file'] = create_file(
               asset['file']['filename'],
-              asset['file']['url']
+              asset['file']['url'],
+              { contentType: asset['file'].fetch('contentType', 'image/jpeg') }
             )
             asset
           end