contentful_bootstrap 2.0.2 → 3.0.0

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

@@ -59,11 +59,13 @@ module Contentful
             ],
             'post' => [
               {
+                'id' => 'inferno',
                 'title' => 'Inferno',
                 'content' => 'Inferno is the last book in Dan Brown\'s collection...',
                 'author' => Links::Entry.new('dan_brown')
               },
               {
+                'id' => 'alturas',
                 'title' => 'Alturas de Macchu Picchu',
                 'content' => 'Alturas de Macchu Picchu is one of Pablo Neruda\'s most famous poetry books...',
                 'author' => Links::Entry.new('pablo_neruda')

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

@@ -12,10 +12,12 @@ module Contentful
           @assets = nil
           @entries = nil
           json
+
+          check_version
         end
 
         def content_types
-          json.fetch('content_types', [])
+          json.fetch('contentTypes', [])
         end
 
         def assets
@@ -28,6 +30,14 @@ module Contentful
 
         private
 
+        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
+        end
+
         def json
           @json ||= ::JSON.parse(::File.read(@file))
         end
@@ -49,29 +59,32 @@ module Contentful
           unprocessed_entries.each do |content_type_id, entry_list|
             entries_for_content_type = []
             entry_list.each do |entry|
+              processed_entry = {}
               array_fields = []
               link_fields = []
 
-              entry.each do |field, value|
+              processed_entry['id'] = entry['sys']['id'] if entry.key?('sys') && entry['sys'].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
+
+                unless link_fields.include?(field) || array_fields.include?(field)
+                  processed_entry[field] = value
+                end
               end
 
               link_fields.each do |lf|
-                entry[lf] = create_link(entry[lf])
+                processed_entry[lf] = create_link(entry['fields'][lf])
               end
 
               array_fields.each do |af|
-                entry[af].map! do |item|
-                  if item.is_a? ::Hash
-                    create_link(item)
-                  else
-                    item
-                  end
+                processed_entry[af] = entry['fields'][af].map do |item|
+                  item.is_a?(::Hash) ? create_link(item) : item
                 end
               end
 
-              entries_for_content_type << entry
+              entries_for_content_type << processed_entry
             end
 
             processed_entries[content_type_id] = entries_for_content_type
@@ -81,7 +94,7 @@ module Contentful
         end
 
         def create_link(link_properties)
-          link_type = link_properties['link_type'].capitalize
+          link_type = link_properties['linkType'].capitalize
           id = link_properties['id']
           case link_type
           when 'Entry'

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

@@ -27,6 +27,11 @@ module Contentful
           def management_class
             fail 'must implement'
           end
+
+          def ==(other)
+            return false unless other.is_a? self.class
+            other.id == id
+          end
         end
       end
     end

data/lib/contentful/bootstrap/token.rb

@@ -16,9 +16,9 @@ module Contentful
         @config_path = config_path
       end
 
-      def ==(other_token)
-        return false unless other_token.is_a?(Contentful::Bootstrap::Token)
-        other_token.config_path == @config_path
+      def ==(other)
+        return false unless other.is_a?(Contentful::Bootstrap::Token)
+        other.config_path == @config_path
       end
 
       def present?

data/lib/contentful/bootstrap/version.rb

@@ -1,5 +1,9 @@
 module Contentful
   module Bootstrap
-    VERSION = '2.0.2'
+    VERSION = '3.0.0'
+
+    def self.major_version
+      VERSION.split('.').first.to_i
+    end
   end
 end

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

@@ -18,7 +18,7 @@ describe Contentful::Bootstrap::Commands::CreateSpace do
       end
 
       it 'does not create template when template_name is nil' do
-        create_space_command = subject.class.new(token, 'foo', nil, 'baz', false)
+        create_space_command = described_class.new(token, 'foo', nil, 'baz', false)
 
         expect(create_space_command.template_name).to eq nil
 
@@ -31,7 +31,7 @@ describe Contentful::Bootstrap::Commands::CreateSpace do
       end
 
       it 'does not create json template when json_template is nil' do
-        create_space_command = subject.class.new(token, 'foo', 'bar', nil, false)
+        create_space_command = described_class.new(token, 'foo', 'bar', nil, false)
 
         expect(create_space_command.json_template).to eq nil
 
@@ -59,14 +59,66 @@ describe Contentful::Bootstrap::Commands::CreateSpace do
     it 'Importing asset array values does not work #22' do
       json_path = File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'issue_22.json'))
 
-      allow_any_instance_of(subject.class).to receive(:gets).and_return('y')
+      allow_any_instance_of(described_class).to receive(:gets).and_return('y')
       allow_any_instance_of(Contentful::Bootstrap::Commands::GenerateToken).to receive(:gets).and_return('n')
 
-      command = subject.class.new(token, 'issue_22', nil, json_path)
+      command = described_class.new(token, 'issue_22', nil, json_path)
 
       vcr('issue_22') {
         command.run
       }
     end
   end
+
+  describe 'integration' do
+    before do
+      allow_any_instance_of(described_class).to receive(:gets).and_return('y')
+      allow_any_instance_of(Contentful::Bootstrap::Commands::GenerateToken).to receive(:gets).and_return('n')
+    end
+
+    it 'create space' do
+      command = described_class.new token, 'some_space'
+
+      vcr('create_space') {
+        command.run
+      }
+    end
+
+    it 'create space with blog template' do
+      command = described_class.new token, 'blog_space', 'blog'
+
+      vcr('create_space_with_blog_template') {
+        command.run
+      }
+    end
+
+    it 'create space with gallery template' do
+      command = described_class.new token, 'gallery_space', 'gallery'
+
+      vcr('create_space_with_gallery_template') {
+        command.run
+      }
+    end
+
+    it 'create space with catalogue template' do
+      command = described_class.new token, 'catalogue_space', 'catalogue'
+
+      vcr('create_space_with_catalogue_template') {
+        command.run
+      }
+    end
+
+    it 'create space with json template' do
+      skip 'covered by create_space_spec:issues/#22'
+    end
+
+    it 'create space with json template with no ids' do
+      json_path = File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'no_ids.json'))
+      command = described_class.new token, 'no_ids_space', nil, json_path
+
+      vcr('no_ids') {
+        command.run
+      }
+    end
+  end
 end

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

@@ -79,4 +79,18 @@ describe Contentful::Bootstrap::Commands::GenerateToken do
       expect(subject.token_name).to eq 'bar'
     end
   end
+
+  describe 'integration' do
+    before do
+      allow_any_instance_of(subject.class).to receive(:gets).and_return('n')
+    end
+
+    it 'generates a token for a given space' do
+      command = subject.class.new token, 'zred3m25k5em', 'foo'
+
+      vcr('generate_token') {
+        command.run
+      }
+    end
+  end
 end

data/spec/contentful/bootstrap/templates/json_template_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Contentful::Bootstrap::Templates::JsonTemplate do
   let(:space) { Contentful::Management::Space.new }
   let(:path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'simple.json')) }
-  subject { Contentful::Bootstrap::Templates::JsonTemplate.new space, path }
+  subject { described_class.new space, path }
 
   describe 'instance methods' do
     it '#content_types' do
@@ -49,4 +49,42 @@ describe Contentful::Bootstrap::Templates::JsonTemplate do
       )
     end
   end
+
+  describe 'template version check' do
+    let(:invalid_version_path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'invalid.json')) }
+    let(:low_version_path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'low.json')) }
+    let(:high_version_path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'high.json')) }
+    let(:ok_version_path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'ok_version.json')) }
+
+    it 'rejects templates without version' do
+      expect { described_class.new space, invalid_version_path }.to raise_error "JSON Templates Version Mismatch. Current Version: 3"
+    end
+
+    it 'rejects templates with previous versions' do
+      expect { described_class.new space, low_version_path }.to raise_error "JSON Templates Version Mismatch. Current Version: 3"
+    end
+
+    it 'rejects templates with newer versions' do
+      expect { described_class.new space, high_version_path }.to raise_error "JSON Templates Version Mismatch. Current Version: 3"
+    end
+
+    it 'accepts templates with correct version' do
+      expect { described_class.new space, ok_version_path }.not_to raise_error
+    end
+  end
+
+  describe 'issues' do
+    let(:link_entry_path) { File.expand_path(File.join('spec', 'fixtures', 'json_fixtures', 'links.json')) }
+
+    it 'links are not properly getting processed - #33' do
+      subject = described_class.new space, link_entry_path
+
+      expect(subject.entries["cat"].first).to eq(
+        {
+          "id" => "foo",
+          "link" => Contentful::Bootstrap::Templates::Links::Entry.new('foobar')
+        }
+      )
+    end
+  end
 end

data/spec/contentful/bootstrap/templates/links/asset_spec.rb

@@ -19,5 +19,19 @@ describe Contentful::Bootstrap::Templates::Links::Asset do
     it '#management_class' do
       expect(subject.management_class).to eq Contentful::Management::Asset
     end
+
+    describe '#==' do
+      it 'false when different type' do
+        expect(subject == 2).to be_falsey
+      end
+
+      it 'false when different id' do
+        expect(subject == described_class.new('bar')).to be_falsey
+      end
+
+      it 'true when same id' do
+        expect(subject == described_class.new('foo')).to be_truthy
+      end
+    end
   end
 end

data/spec/contentful/bootstrap/templates/links/base_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Contentful::Bootstrap::Templates::Links::Base do
-  subject { Contentful::Bootstrap::Templates::Links::Base.new 'foo' }
+  subject { described_class.new 'foo' }
 
   describe 'instance methods' do
     it '#link_type' do
@@ -20,6 +20,20 @@ describe Contentful::Bootstrap::Templates::Links::Base do
       it '#management_class' do
         expect { subject.management_class }.to raise_error "must implement"
       end
+
+      describe '#==' do
+        it 'false when different type' do
+          expect(subject == 2).to be_falsey
+        end
+
+        it 'false when different id' do
+          expect(subject == described_class.new('bar')).to be_falsey
+        end
+
+        it 'true when same id' do
+          expect(subject == described_class.new('foo')).to be_truthy
+        end
+      end
     end
   end
 

data/spec/contentful/bootstrap/templates/links/entry_spec.rb

@@ -19,5 +19,19 @@ describe Contentful::Bootstrap::Templates::Links::Entry do
     it '#management_class' do
       expect(subject.management_class).to eq Contentful::Management::Entry
     end
+
+    describe '#==' do
+      it 'false when different type' do
+        expect(subject == 2).to be_falsey
+      end
+
+      it 'false when different id' do
+        expect(subject == described_class.new('bar')).to be_falsey
+      end
+
+      it 'true when same id' do
+        expect(subject == described_class.new('foo')).to be_truthy
+      end
+    end
   end
 end

data/spec/fixtures/json_fixtures/high.json

@@ -0,0 +1,6 @@
+{
+  "version": 4,
+  "content_types": [],
+  "assets": [],
+  "entries": {}
+}

data/spec/fixtures/json_fixtures/invalid.json

@@ -0,0 +1,5 @@
+{
+  "content_types": [],
+  "assets": [],
+  "entries": {}
+}

data/spec/fixtures/json_fixtures/issue_22.json

@@ -1,9 +1,10 @@
 {
-  "content_types": [
+  "version": 3,
+  "contentTypes": [
     {
     "id": "1VX60jHERm6yuem8I2agWG",
     "name": "yolo",
-    "display_field": "title",
+    "displayField": "title",
     "fields": [
       {
         "id": "title",
@@ -16,7 +17,7 @@
         "type": "Array",
         "items": {
           "type": "Link",
-          "link_type": "Asset"
+          "linkType": "Asset"
         }
       }
     ]
@@ -59,18 +60,22 @@
   "entries": {
     "1VX60jHERm6yuem8I2agWG": [
       {
-        "id": "5nQB3z8RgW8CUG6uGyCsEw",
-        "title": "yolo",
-        "assets": [
-          {
-            "link_type": "Asset",
-            "id": "4eX9aQsDdeqweg6Si00KaW"
-          },
-          {
-            "link_type": "Asset",
-            "id": "4D5sv49qaAoMIkWgAW8g0I"
-          }
-        ]
+        "sys": {
+          "id": "5nQB3z8RgW8CUG6uGyCsEw"
+        },
+        "fields": {
+          "title": "yolo",
+          "assets": [
+            {
+              "linkType": "Asset",
+              "id": "4eX9aQsDdeqweg6Si00KaW"
+            },
+            {
+              "linkType": "Asset",
+              "id": "4D5sv49qaAoMIkWgAW8g0I"
+            }
+          ]
+        }
       }
     ]
   }

data/spec/fixtures/json_fixtures/links.json

@@ -0,0 +1,18 @@
+{
+  "version": 3,
+  "content_types": [],
+  "assets": [],
+  "entries": {
+    "cat": [
+      {
+        "sys": { "id": "foo" },
+        "fields": {
+          "link": {
+            "id": "foobar",
+            "linkType": "Entry"
+          }
+        }
+      }
+    ]
+  }
+}