contentful-management 1.8.1 → 1.9.0

data/spec/lib/contentful/management/space_membership_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'contentful/management/space'
+require 'contentful/management/client'
+
+module Contentful
+  module Management
+    describe SpaceMembership do
+      let(:token) { ENV.fetch('CF_TEST_CMA_TOKEN', '<ACCESS_TOKEN>') }
+      let(:space_id) { 'facgnwwgj5fe' }
+      let(:membership_id) { '6RdRdobdQzh8zKe1Hogiz4' }
+      let(:client) { Client.new(token, raise_errors: true) }
+
+      subject { client.space_memberships }
+
+      describe 'class methods' do
+        describe '::create_attributes' do
+          it 'requires admin, roles and email keys to be present' do
+            expect { described_class.create_attributes(nil, {}) }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, admin: true) }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, admin: true, roles: []) }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, roles: []) }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, roles: [], email: 'foo@bar.com') }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, email: 'foo@bar.com') }.to raise_error KeyError
+            expect { described_class.create_attributes(nil, admin: true, roles: [], email: 'foo@bar.com') }.not_to raise_error
+          end
+          it 'accepts also strings as keys' do
+            # Symbols were tested on the previous spec - testing strings here
+            expect { described_class.create_attributes(nil, 'admin' => true, 'roles' => [], 'email' => 'foo@bar.com') }.not_to raise_error
+          end
+        end
+
+        describe '::clean_roles' do
+          let(:json_role) { {
+            "sys": {
+              "id": "foo",
+              "type": "Link",
+              "linkType": "Role"
+            }
+          } }
+
+          let(:link_role) { Link.new(json_role, nil, client) }
+
+          it 'returns the json representation of the roles wether they are a Link or a Hash' do
+            expect(described_class.clean_roles([json_role, link_role])).to eq [json_role, json_role]
+          end
+        end
+      end
+
+      describe 'instance methods' do
+        let(:membership) { described_class.new({
+          "admin" => true,
+          "roles" => [{
+            "sys" => {
+              "id" => "foo",
+              "type" => "Link",
+              "linkType" => "Role"
+            }
+          }]
+        }) }
+
+        describe '#roles' do
+          it 'returns an array Link objects' do
+            expect(membership.roles.first).to be_a Link
+            expect(membership.roles.first.id).to eq 'foo'
+          end
+        end
+      end
+
+      describe '.all' do
+        it 'returns a Contentful::Array' do
+          vcr('space_memberships/all') { expect(subject.all(space_id)).to be_kind_of Contentful::Management::Array }
+        end
+
+        it 'builds a Contentful::Management::SpaceMembership' do
+          vcr('space_memberships/all') {
+            memberships = subject.all(space_id)
+
+            admin_membership, normal_membership = memberships.items
+
+            expect(admin_membership).to be_a Contentful::Management::SpaceMembership
+            expect(admin_membership.admin).to eq true
+            expect(admin_membership.roles).to eq []
+
+            expect(normal_membership).to be_a Contentful::Management::SpaceMembership
+            expect(normal_membership.admin).to eq false
+            expect(normal_membership.roles.first).to be_a Link
+          }
+        end
+
+        it 'class method also works' do
+          vcr('space_memberships/all') { expect(Contentful::Management::SpaceMembership.all(client, space_id)).to be_kind_of Contentful::Management::Array }
+        end
+      end
+
+      describe '.find' do
+        it 'returns a Contentful::Management::SpaceMembership' do
+          vcr('space_memberships/find') {
+            membership = subject.find(space_id, membership_id)
+
+            expect(membership).to be_a Contentful::Management::SpaceMembership
+            expect(membership.admin).to eq false
+            expect(membership.roles.first).to be_a Link
+          }
+        end
+      end
+
+      describe '.create' do
+        it 'creates a Contentful::Management::SpaceMembership' do
+          vcr('space_memberships/create') {
+            membership = subject.create(
+              space_id,
+              admin: false,
+              roles: [
+                {
+                  "sys" => {
+                    "type" => "Link",
+                    "linkType" => "Role",
+                    "id" => "1Nq88dKTNXNaxkbrRpEEw6"
+                  }
+                }
+              ],
+              email: 'david.litvak+test_rcma@contentful.com'
+            )
+
+            expect(membership).to be_a Contentful::Management::SpaceMembership
+            expect(membership.admin).to eq false
+            expect(membership.roles.first).to be_a Link
+          }
+        end
+      end
+
+      describe '#destroy' do
+        it 'deletes the membership' do
+          vcr('space_memberships/delete') {
+            membership = subject.find(space_id, '7pcydolqtgMaSLwmXMvGqW')
+
+            expect(membership.id).to be_truthy
+
+            membership.destroy
+
+            expect { subject.find(space_id, '7pcydolqtgMaSLwmXMvGqW') }.to raise_error Contentful::Management::NotFound
+          }
+        end
+      end
+    end
+  end
+end

data/spec/lib/contentful/management/space_spec.rb

@@ -5,7 +5,7 @@ require 'contentful/management/client'
 module Contentful
   module Management
     describe Space do
-      let(:token) { '<ACCESS_TOKEN>' }
+      let(:token) { ENV.fetch('CF_TEST_CMA_TOKEN', '<ACCESS_TOKEN>') }
       let(:space_id) { 'yr5m0jky5hsh' }
 
       let!(:client) { Client.new(token) }
@@ -22,6 +22,22 @@ module Contentful
         it 'builds a Contentful::Management::Space object' do
           vcr('space/all') { expect(subject.all.first).to be_kind_of Contentful::Management::Space }
         end
+        describe 'content type caching' do
+          it 'fetches all content types when finding a space' do
+            vcr('space/all') do
+              space = subject.all
+              expect(client.dynamic_entry_cache).not_to be_empty
+            end
+          end
+          it 'doesnt fetch content types when explicitly disabled' do
+            vcr('space/all_disabled_cache') do
+              client = Client.new(token, disable_content_type_caching: true)
+              subject = client.spaces
+              space = subject.all
+              expect(client.dynamic_entry_cache).to be_empty
+            end
+          end
+        end
       end
 
       describe '.find' do
@@ -50,6 +66,24 @@ module Contentful
             expect(space.default_locale).to eql 'en-US'
           end
         end
+        describe 'content type caching' do
+          it 'fetches all content types when finding a space' do
+            vcr('space/find') do
+              space = subject.find(space_id)
+              expect(client.dynamic_entry_cache).not_to be_empty
+              expect(client.dynamic_entry_cache.key?('5DSpuKrl04eMAGQoQckeIq'.to_sym)).to be_truthy
+            end
+          end
+          it 'does not fetch content types when explicitly disabled' do
+            vcr('space/disabled_cache') do
+              client = Client.new(token, disable_content_type_caching: true)
+              subject = client.spaces
+
+              space = subject.find('facgnwwgj5fe')
+              expect(client.dynamic_entry_cache).to be_empty
+            end
+          end
+        end
       end
 
       describe '#destroy' do

data/spec/lib/contentful/management/ui_extension_spec.rb

@@ -0,0 +1,276 @@
+require 'spec_helper'
+require 'contentful/management/space'
+require 'contentful/management/client'
+
+module Contentful
+  module Management
+    describe UIExtension do
+      let(:token) { ENV.fetch('CF_TEST_CMA_TOKEN', '<ACCESS_TOKEN>') }
+      let(:space_id) { 'arqlnkt58eul' }
+      let(:playground_space_id) { 'facgnwwgj5fe' }
+      let(:extension_id) { '2ZJduY1pKEma6G8Y2ImqYU' }
+      let(:client) { Client.new(token, raise_errors: true) }
+
+      subject { client.ui_extensions }
+
+      describe 'class methods' do
+        describe '::valid_extension' do
+          it 'false when name is missing' do
+            extension = {}
+
+            expect(described_class.valid_extension(extension)).to be_falsey
+          end
+
+          it 'false when fieldTypes is missing' do
+            extension = {
+              'name' => 'foobar'
+            }
+
+            expect(described_class.valid_extension(extension)).to be_falsey
+          end
+
+          it 'false when fieldTypes is present but not an array' do
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => 'baz'
+            }
+
+            expect(described_class.valid_extension(extension)).to be_falsey
+          end
+
+          it 'false when both src and srcdoc missing' do
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol']
+            }
+
+            expect(described_class.valid_extension(extension)).to be_falsey
+          end
+
+          it 'true when all of the above are passed' do
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'src' => 'foo'
+            }
+
+            expect(described_class.valid_extension(extension)).to be_truthy
+
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'srcdoc' => 'foo'
+            }
+
+            expect(described_class.valid_extension(extension)).to be_truthy
+          end
+
+          it 'false if sidebar is present but not boolean' do
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'srcdoc' => 'foo',
+              'sidebar' => true
+            }
+
+            expect(described_class.valid_extension(extension)).to be_truthy
+
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'srcdoc' => 'foo',
+              'sidebar' => false
+            }
+
+            expect(described_class.valid_extension(extension)).to be_truthy
+
+            extension = {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'srcdoc' => 'foo',
+              'sidebar' => 'foobar'
+            }
+
+            expect(described_class.valid_extension(extension)).to be_falsey
+          end
+        end
+
+        describe '::create_attributes' do
+          it 'raises an error if extension sent is not valid' do
+            invalid_extension = {
+              extension: {
+                'name' => 'foobar'
+              }
+            }
+
+            expect do
+              described_class.create_attributes(nil, invalid_extension)
+            end.to raise_error 'Invalid UI Extension attributes'
+          end
+
+          it 'does nothing otherwise' do
+            extension = {
+              'extension' => {
+                'name' => 'foobar',
+                'fieldTypes' => ['Symbol'],
+                'srcdoc' => 'foo',
+                'sidebar' => false
+              }
+            }
+
+            expect(described_class.create_attributes(nil, extension)).to eq extension
+          end
+        end
+      end
+
+      describe 'instance methods' do
+        let(:extension) {
+          described_class.new(
+            'extension' => {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'srcdoc' => 'foo',
+              'sidebar' => false
+            }
+          )
+        }
+
+        let(:src_extension) {
+          described_class.new(
+            'extension' => {
+              'name' => 'foobar',
+              'fieldTypes' => ['Symbol'],
+              'src' => 'http://foo.com',
+              'sidebar' => false
+            }
+          )
+        }
+
+        it '#name' do
+          expect(extension.name).to eq 'foobar'
+          extension.name = 'baz'
+
+          expect(extension.name).to eq 'baz'
+          expect(extension.extension['name']).to eq 'baz'
+        end
+
+        it '#field_types' do
+          expect(extension.field_types).to eq ['Symbol']
+
+          extension.field_types = ['Symbol', 'Text']
+
+          expect(extension.field_types).to eq ['Symbol', 'Text']
+          expect(extension.extension['fieldTypes']).to eq ['Symbol', 'Text']
+        end
+
+        describe '#source' do
+          it 'will get first available source' do
+            expect(extension.source).to eq 'foo'
+            expect(src_extension.source).to eq 'http://foo.com'
+          end
+
+          it 'if source is a url will set it to src' do
+            expect(extension.extension['srcdoc']).to eq 'foo'
+
+            extension.source = 'http://example.com'
+
+            expect(extension.extension['srcdoc']).to be_nil
+            expect(extension.source).to eq 'http://example.com'
+            expect(extension.extension['src']).to eq 'http://example.com'
+          end
+
+          it 'if source is a string will set it to srcdoc' do
+            expect(src_extension.extension['src']).to eq 'http://foo.com'
+
+            src_extension.source = 'foobar'
+
+            expect(src_extension.extension['src']).to be_nil
+            expect(src_extension.source).to eq 'foobar'
+            expect(src_extension.extension['srcdoc']).to eq 'foobar'
+          end
+        end
+
+        it '#sidebar' do
+          expect(extension.sidebar).to eq false
+
+          extension.sidebar = true
+
+          expect(extension.sidebar).to eq true
+          expect(extension.extension['sidebar']).to eq true
+        end
+      end
+
+      describe '.all' do
+        it 'returns a Contentful::Array' do
+          vcr('ui_extension/all') { expect(subject.all(space_id)).to be_kind_of Contentful::Management::Array }
+        end
+
+        it 'builds a Contentful::Management::UIExtension' do
+          vcr('ui_extension/all') {
+            extension = subject.all(space_id).first
+
+            expect(extension).to be_kind_of Contentful::Management::UIExtension
+            expect(extension.name).to eq 'My awesome extension by srcDoc'
+            expect(extension.field_types).to eq [{"type"=>"Symbol"}, {"type"=>"Text"}]
+            expect(extension.source).to eq "<!doctype html><html lang='en'><head><meta charset='UTF-8'/><title>Sample Editor Extension</title><link rel='stylesheet' href='https://contentful.github.io/ui-extensions-sdk/cf-extension.css'><script src='https://contentful.github.io/ui-extensions-sdk/cf-extension-api.js'></script></head><body><div id='content'></div><script>window.contentfulExtension.init(function (extension) {window.alert(extension);var value = extension.field.getValue();extension.field.setValue('Hello world!');extension.field.onValueChanged(function(value) {if (value !== currentValue) {extension.field.setValue('Hello world!');}});});</script></body></html>"
+            expect(extension.sidebar).to eq false
+            expect(extension.id).to be_truthy
+          }
+        end
+
+        it 'class method also works' do
+          vcr('ui_extension/all') { expect(Contentful::Management::UIExtension.all(client, space_id)).to be_kind_of Contentful::Management::Array }
+        end
+      end
+
+      describe '.find' do
+        it 'returns a Contentful::Management::UIExtension' do
+          vcr('ui_extension/find') {
+            extension = subject.find(space_id, extension_id)
+
+            expect(extension).to be_kind_of Contentful::Management::UIExtension
+            expect(extension.name).to eq 'My awesome extension by srcDoc'
+            expect(extension.field_types).to eq [{"type"=>"Symbol"}, {"type"=>"Text"}]
+            expect(extension.source).to eq "<!doctype html><html lang='en'><head><meta charset='UTF-8'/><title>Sample Editor Extension</title><link rel='stylesheet' href='https://contentful.github.io/ui-extensions-sdk/cf-extension.css'><script src='https://contentful.github.io/ui-extensions-sdk/cf-extension-api.js'></script></head><body><div id='content'></div><script>window.contentfulExtension.init(function (extension) {window.alert(extension);var value = extension.field.getValue();extension.field.setValue('Hello world!');extension.field.onValueChanged(function(value) {if (value !== currentValue) {extension.field.setValue('Hello world!');}});});</script></body></html>"
+            expect(extension.sidebar).to eq false
+            expect(extension.id).to be_truthy
+          }
+        end
+      end
+
+      describe '.create' do
+        it 'creates a Contentful::Management::UIExtension' do
+          vcr('ui_extension/create') {
+            extension = subject.create(playground_space_id, extension: {
+              'name' => 'test extension',
+              'fieldTypes' => [{"type"=>"Symbol"}, {"type"=>"Text"}],
+              'srcdoc' => "<!doctype html><html lang='en'><head><meta charset='UTF-8'/><title>Sample Editor Extension</title><link rel='stylesheet' href='https://contentful.github.io/ui-extensions-sdk/cf-extension.css'><script src='https://contentful.github.io/ui-extensions-sdk/cf-extension-api.js'></script></head><body><div id='content'></div><script>window.contentfulExtension.init(function (extension) {window.alert(extension);var value = extension.field.getValue();extension.field.setValue('Hello world!');extension.field.onValueChanged(function(value) {if (value !== currentValue) {extension.field.setValue('Hello world!');}});});</script></body></html>",
+              'sidebar' => false
+            })
+
+            expect(extension).to be_kind_of Contentful::Management::UIExtension
+            expect(extension.name).to eq 'test extension'
+            expect(extension.field_types).to eq [{"type"=>"Symbol"}, {"type"=>"Text"}]
+            expect(extension.source).to eq "<!doctype html><html lang='en'><head><meta charset='UTF-8'/><title>Sample Editor Extension</title><link rel='stylesheet' href='https://contentful.github.io/ui-extensions-sdk/cf-extension.css'><script src='https://contentful.github.io/ui-extensions-sdk/cf-extension-api.js'></script></head><body><div id='content'></div><script>window.contentfulExtension.init(function (extension) {window.alert(extension);var value = extension.field.getValue();extension.field.setValue('Hello world!');extension.field.onValueChanged(function(value) {if (value !== currentValue) {extension.field.setValue('Hello world!');}});});</script></body></html>"
+            expect(extension.sidebar).to eq false
+            expect(extension.id).to be_truthy
+          }
+        end
+      end
+
+      describe '#destroy' do
+        it 'deletes the extension' do
+          vcr('ui_extension/delete') {
+            extension = subject.find(playground_space_id, '2rf6QdckyoECCsQeE6gIOg')
+
+            expect(extension.id).to be_truthy
+
+            extension.destroy
+
+            expect { subject.find(playground_space_id, '2rf6QdckyoECCsQeE6gIOg') }.to raise_error Contentful::Management::NotFound
+          }
+        end
+      end
+    end
+  end
+end