contentful_bootstrap 3.9.1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e58541eab6426bb8208b9b0c33244d1bea9d65fa
-  data.tar.gz: d0e26fbf73b7e1c01e080eb1268dc90bab01cee0
+  metadata.gz: 87bf2f847f495230e20ba2d7ddaaf81f9549275a
+  data.tar.gz: 30ee1008a09c1297e319e82350256ad94892da13
 SHA512:
-  metadata.gz: 03150c56609259ab73f72026b0feaf962db95cb7b75066dc8166f03568b2022ff73111021bd23220ba3cd0291993d2b65826243d7ba56df906830aaa8fea2ec2
-  data.tar.gz: 22f9528bb02b02b60ffa529df0623c156c1816b8bb8f26e7370bdb93f83284cdeed8c5c9e684c9aae93ccf233792ee065e516c920be6c06e487e721d5009807f
+  metadata.gz: 4392ba1adde7708b019dd6b6fa6d50568435c2a57712f430639c54db9077479bac1183f9c58e52b75cee700cf8025aa2f4b6a90e352af5ef195cc6663348547f
+  data.tar.gz: dabba1d78944aecd7f117e95f85124ddf5be620c4b530576c65ac7adfa74d585838fef53d2341ee391b3627f35a6647bed15a4798c5d48d5148da2b98865e312

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## v3.10.0
+### Added
+* Added `--content-type-ids` filter to `generate_json` command to allow selecting which content types to import.
+
 ## v3.9.1
 ### Fixed
 * Fixed an issue in which assets save as `Contentful::Management::File` objects instead of as JSON when using `--mark-processed`.

data/README.md

@@ -38,7 +38,7 @@ $ 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-types-only] [--use-preview] [--quiet]
+$ 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]
 ```
 
 You can update existing spaces from JSON Templates by doing:
@@ -140,6 +140,7 @@ Contentful::Bootstrap::CommandRunner.new.generate_json(
   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
+  content_type_ids: [], # if any ID is specified, JSON will only include those content types and entries that have that content type
   quiet: false, # if true will not output to STDOUT - only when filename is provided
   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
 )
@@ -154,6 +155,7 @@ options = {
   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
+  content_type_ids: [], # if any ID is specified, JSON will only include those content types and entries that have that content type
   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
 }

data/bin/contentful_bootstrap

@@ -83,6 +83,9 @@ subcommands = {
     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|
+      options[:content_type_ids] = ids
+    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

@@ -35,11 +35,18 @@ module Contentful
         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?
 
         Contentful::Bootstrap::Commands::GenerateJson.new(
-          space_id, access_token, filename, content_types_only, quiet, use_preview
+          space_id,
+          access_token,
+          filename,
+          content_types_only,
+          quiet,
+          use_preview,
+          content_type_ids
         ).run
       end
     end

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

@@ -5,14 +5,15 @@ module Contentful
   module Bootstrap
     module Commands
       class GenerateJson
-        attr_reader :space_id, :filename, :access_token, :content_types_only, :use_preview
-        def initialize(space_id, access_token, filename = nil, content_types_only = false, quiet = false, use_preview = false)
+        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 = [])
           @space_id = space_id
           @access_token = access_token
           @filename = filename
           @content_types_only = content_types_only
           @quiet = quiet
           @use_preview = use_preview
+          @content_type_ids = content_type_ids
         end
 
         def run
@@ -29,7 +30,8 @@ module Contentful
             space_id,
             access_token,
             content_types_only,
-            use_preview
+            use_preview,
+            content_type_ids
           ).generate_json
 
           write(json)

data/lib/contentful/bootstrap/generator.rb

@@ -10,9 +10,9 @@ module Contentful
       DELIVERY_API_URL = 'cdn.contentful.com'.freeze
       PREVIEW_API_URL = 'preview.contentful.com'.freeze
 
-      attr_reader :content_types_only, :client
+      attr_reader :content_types_only, :content_type_ids, :client
 
-      def initialize(space_id, access_token, content_types_only, use_preview)
+      def initialize(space_id, access_token, content_types_only, use_preview, content_type_ids)
         @client = Contentful::Client.new(
           access_token: access_token,
           space: space_id,
@@ -21,6 +21,7 @@ module Contentful
           api_url: use_preview ? PREVIEW_API_URL : DELIVERY_API_URL
         )
         @content_types_only = content_types_only
+        @content_type_ids = content_type_ids
       end
 
       def generate_json
@@ -35,7 +36,10 @@ module Contentful
       private
 
       def content_types
-        proccessed_content_types = @client.content_types.map do |type|
+        query = {}
+        query['sys.id[in]'] = content_type_ids.join(',') unless content_type_ids.empty?
+
+        proccessed_content_types = @client.content_types(query).map do |type|
           result = { 'id' => type.sys[:id], 'name' => type.name }
           result['displayField'] = type.display_field unless type.display_field.nil?
 
@@ -80,7 +84,17 @@ module Contentful
         entries = {}
 
         query = { order: 'sys.createdAt', limit: 1000 }
-        entries_count = @client.entries(limit: 1).total
+        count_query = { limit: 1 }
+
+        unless content_type_ids.empty?
+          search_key = 'sys.contentType.sys.id[in]'
+          ids = content_type_ids.join(',')
+
+          query[search_key] = ids
+          count_query[search_key] = ids
+        end
+
+        entries_count = @client.entries(count_query).total
         ((entries_count / 1000) + 1).times do |i|
           query[:skip] = i * 1000
 

data/lib/contentful/bootstrap/version.rb

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

data/spec/contentful/bootstrap/command_runner_spec.rb

@@ -101,7 +101,7 @@ describe Contentful::Bootstrap::CommandRunner do
         allow_any_instance_of(Contentful::Bootstrap::Commands::GenerateJson).to receive(:run)
 
         expect(Contentful::Bootstrap::Commands::GenerateJson).to receive(:new).with(
-          'foo', 'bar', nil, false, false, false
+          'foo', 'bar', nil, false, false, false, []
         ).and_call_original
 
         subject.generate_json('foo', access_token: 'bar')
@@ -111,7 +111,7 @@ describe Contentful::Bootstrap::CommandRunner do
         allow_any_instance_of(Contentful::Bootstrap::Commands::GenerateJson).to receive(:run)
 
         expect(Contentful::Bootstrap::Commands::GenerateJson).to receive(:new).with(
-          'foo', 'bar', 'baz', true, false, false
+          'foo', 'bar', 'baz', true, false, false, []
         ).and_call_original
 
         subject.generate_json('foo', access_token: 'bar', filename: 'baz', content_types_only: true)

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

@@ -48,6 +48,38 @@ describe Contentful::Bootstrap::Commands::GenerateJson do
           subject.run
         }
       end
+
+      describe 'specific content types' do
+        it 'can select a single content type' do
+          vcr('generate_json_single_ct') {
+            subject.instance_variable_set(:@space_id, 'cfexampleapi')
+            subject.instance_variable_set(:@access_token, 'b4c0n73n7fu1')
+            subject.instance_variable_set(:@content_type_ids, ['cat'])
+            subject.instance_variable_set(:@quiet, true)
+
+            json_fixture('cfexampleapi_cat') { |json|
+              expect(subject).to receive(:write).with(JSON.pretty_generate(json))
+            }
+
+            subject.run
+          }
+        end
+
+        it 'can select multiple content types' do
+          vcr('generate_json_multi_ct') {
+            subject.instance_variable_set(:@space_id, 'cfexampleapi')
+            subject.instance_variable_set(:@access_token, 'b4c0n73n7fu1')
+            subject.instance_variable_set(:@content_type_ids, ['cat', 'human'])
+            subject.instance_variable_set(:@quiet, true)
+
+            json_fixture('cfexampleapi_cat_human') { |json|
+              expect(subject).to receive(:write).with(JSON.pretty_generate(json))
+            }
+
+            subject.run
+          }
+        end
+      end
     end
 
     describe '#write' do

data/spec/contentful/bootstrap/generator_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Contentful::Bootstrap::Generator do
-  subject { Contentful::Bootstrap::Generator.new('wl1z0pal05vy', '48d7db7d4cd9d09df573c251d456f4acc72141b92f36e57f8684b36cf5cfff6e', false, false) }
+  subject { Contentful::Bootstrap::Generator.new('wl1z0pal05vy', '48d7db7d4cd9d09df573c251d456f4acc72141b92f36e57f8684b36cf5cfff6e', false, false, []) }
 
   describe 'user agent headers' do
     it 'client has proper integration data' do
@@ -19,7 +19,7 @@ describe Contentful::Bootstrap::Generator do
     end
 
     context 'with content_types_only set to true' do
-      subject { Contentful::Bootstrap::Generator.new('wl1z0pal05vy', '48d7db7d4cd9d09df573c251d456f4acc72141b92f36e57f8684b36cf5cfff6e', true, false) }
+      subject { Contentful::Bootstrap::Generator.new('wl1z0pal05vy', '48d7db7d4cd9d09df573c251d456f4acc72141b92f36e57f8684b36cf5cfff6e', true, false, []) }
 
       it 'can generate a JSON template for a given space with only Content Types' do
         vcr('generate_json_content_types_only') {

data/spec/fixtures/json_fixtures/cfexampleapi_cat.json

@@ -0,0 +1,154 @@
+{
+  "version": 3,
+  "contentTypes": [
+    {
+      "id": "cat",
+      "name": "Cat",
+      "displayField": "name",
+      "fields": [
+        {
+          "id": "name",
+          "name": "Name",
+          "type": "Text"
+        },
+        {
+          "id": "likes",
+          "name": "Likes",
+          "type": "Array",
+          "items": {
+            "type": "Symbol"
+          }
+        },
+        {
+          "id": "color",
+          "name": "Color",
+          "type": "Symbol"
+        },
+        {
+          "id": "bestFriend",
+          "name": "Best Friend",
+          "type": "Link",
+          "linkType": "Entry"
+        },
+        {
+          "id": "birthday",
+          "name": "Birthday",
+          "type": "Date"
+        },
+        {
+          "id": "lifes",
+          "name": "Lifes left",
+          "type": "Integer"
+        },
+        {
+          "id": "lives",
+          "name": "Lives left",
+          "type": "Integer"
+        },
+        {
+          "id": "image",
+          "name": "Image",
+          "type": "Link",
+          "linkType": "Asset"
+        }
+      ]
+    }
+  ],
+  "assets": [
+    {
+      "id": "1x0xpXu4pSGS4OukSyWGUK",
+      "title": "Doge",
+      "file": {
+        "filename": "doge",
+        "url": "https://images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg"
+      }
+    },
+    {
+      "id": "happycat",
+      "title": "Happy Cat",
+      "file": {
+        "filename": "happycatw",
+        "url": "https://images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
+      }
+    },
+    {
+      "id": "jake",
+      "title": "Jake",
+      "file": {
+        "filename": "jake",
+        "url": "https://images.contentful.com/cfexampleapi/4hlteQAXS8iS0YCMU6QMWg/2a4d826144f014109364ccf5c891d2dd/jake.png"
+      }
+    },
+    {
+      "id": "nyancat",
+      "title": "Nyan Cat",
+      "file": {
+        "filename": "Nyan_cat_250px_frame",
+        "url": "https://images.contentful.com/cfexampleapi/4gp6taAwW4CmSgumq2ekUm/9da0cd1936871b8d72343e895a00d611/Nyan_cat_250px_frame.png"
+      }
+    }
+  ],
+  "entries": {
+    "cat": [
+      {
+        "sys": {
+          "id": "nyancat"
+        },
+        "fields": {
+          "name": "Nyan Cat",
+          "likes": [
+            "rainbows",
+            "fish"
+          ],
+          "color": "rainbow",
+          "bestFriend": {
+            "linkType": "Entry",
+            "id": "happycat"
+          },
+          "birthday": "2011-04-04T22:00:00+00:00",
+          "lives": 1337,
+          "image": {
+            "linkType": "Asset",
+            "id": "nyancat"
+          }
+        }
+      },
+      {
+        "sys": {
+          "id": "happycat"
+        },
+        "fields": {
+          "name": "Happy Cat",
+          "likes": [
+            "cheezburger"
+          ],
+          "color": "gray",
+          "bestFriend": {
+            "linkType": "Entry",
+            "id": "nyancat"
+          },
+          "birthday": "2003-10-28T23:00:00+00:00",
+          "lives": 1,
+          "image": {
+            "linkType": "Asset",
+            "id": "happycat"
+          }
+        }
+      },
+      {
+        "sys": {
+          "id": "garfield"
+        },
+        "fields": {
+          "name": "Garfield",
+          "likes": [
+            "lasagna"
+          ],
+          "color": "orange",
+          "birthday": "1979-06-18T23:00:00+00:00",
+          "lives": 9
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/json_fixtures/cfexampleapi_cat_human.json

@@ -0,0 +1,202 @@
+{
+  "version": 3,
+  "contentTypes": [
+    {
+      "id": "cat",
+      "name": "Cat",
+      "displayField": "name",
+      "fields": [
+        {
+          "id": "name",
+          "name": "Name",
+          "type": "Text"
+        },
+        {
+          "id": "likes",
+          "name": "Likes",
+          "type": "Array",
+          "items": {
+            "type": "Symbol"
+          }
+        },
+        {
+          "id": "color",
+          "name": "Color",
+          "type": "Symbol"
+        },
+        {
+          "id": "bestFriend",
+          "name": "Best Friend",
+          "type": "Link",
+          "linkType": "Entry"
+        },
+        {
+          "id": "birthday",
+          "name": "Birthday",
+          "type": "Date"
+        },
+        {
+          "id": "lifes",
+          "name": "Lifes left",
+          "type": "Integer"
+        },
+        {
+          "id": "lives",
+          "name": "Lives left",
+          "type": "Integer"
+        },
+        {
+          "id": "image",
+          "name": "Image",
+          "type": "Link",
+          "linkType": "Asset"
+        }
+      ]
+    },
+    {
+      "id": "human",
+      "name": "Human",
+      "displayField": "name",
+      "fields": [
+        {
+          "id": "name",
+          "name": "Name",
+          "type": "Text"
+        },
+        {
+          "id": "description",
+          "name": "Description",
+          "type": "Text"
+        },
+        {
+          "id": "likes",
+          "name": "Likes",
+          "type": "Array",
+          "items": {
+            "type": "Symbol"
+          }
+        },
+        {
+          "id": "image",
+          "name": "Image",
+          "type": "Array",
+          "items": {
+            "type": "Link",
+            "linkType": "Asset"
+          }
+        }
+      ]
+    }
+  ],
+  "assets": [
+    {
+      "id": "1x0xpXu4pSGS4OukSyWGUK",
+      "title": "Doge",
+      "file": {
+        "filename": "doge",
+        "url": "https://images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg"
+      }
+    },
+    {
+      "id": "happycat",
+      "title": "Happy Cat",
+      "file": {
+        "filename": "happycatw",
+        "url": "https://images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
+      }
+    },
+    {
+      "id": "jake",
+      "title": "Jake",
+      "file": {
+        "filename": "jake",
+        "url": "https://images.contentful.com/cfexampleapi/4hlteQAXS8iS0YCMU6QMWg/2a4d826144f014109364ccf5c891d2dd/jake.png"
+      }
+    },
+    {
+      "id": "nyancat",
+      "title": "Nyan Cat",
+      "file": {
+        "filename": "Nyan_cat_250px_frame",
+        "url": "https://images.contentful.com/cfexampleapi/4gp6taAwW4CmSgumq2ekUm/9da0cd1936871b8d72343e895a00d611/Nyan_cat_250px_frame.png"
+      }
+    }
+  ],
+  "entries": {
+    "cat": [
+      {
+        "sys": {
+          "id": "nyancat"
+        },
+        "fields": {
+          "name": "Nyan Cat",
+          "likes": [
+            "rainbows",
+            "fish"
+          ],
+          "color": "rainbow",
+          "bestFriend": {
+            "linkType": "Entry",
+            "id": "happycat"
+          },
+          "birthday": "2011-04-04T22:00:00+00:00",
+          "lives": 1337,
+          "image": {
+            "linkType": "Asset",
+            "id": "nyancat"
+          }
+        }
+      },
+      {
+        "sys": {
+          "id": "happycat"
+        },
+        "fields": {
+          "name": "Happy Cat",
+          "likes": [
+            "cheezburger"
+          ],
+          "color": "gray",
+          "bestFriend": {
+            "linkType": "Entry",
+            "id": "nyancat"
+          },
+          "birthday": "2003-10-28T23:00:00+00:00",
+          "lives": 1,
+          "image": {
+            "linkType": "Asset",
+            "id": "happycat"
+          }
+        }
+      },
+      {
+        "sys": {
+          "id": "garfield"
+        },
+        "fields": {
+          "name": "Garfield",
+          "likes": [
+            "lasagna"
+          ],
+          "color": "orange",
+          "birthday": "1979-06-18T23:00:00+00:00",
+          "lives": 9
+        }
+      }
+    ],
+    "human": [
+      {
+        "sys": {
+          "id": "finn"
+        },
+        "fields": {
+          "name": "Finn",
+          "description": "Fearless adventurer! Defender of pancakes.",
+          "likes": [
+            "adventure"
+          ]
+        }
+      }
+    ]
+  }
+}