contentful-management 1.0.1 → 1.1.0

data/spec/fixtures/vcr_cassettes/webhook/create_with_name_and_headers.yml

@@ -0,0 +1,119 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.contentful.com/spaces/zjvxmotjud5s/webhook_definitions/some_id
+    body:
+      encoding: UTF-8
+      string: '{"name":"some_webhook","url":"https://www.example2.com","headers":[{"key":"MyHeader","value":"foobar"}]}'
+    headers:
+      User-Agent:
+      - RubyContentfulManagementGem/1.0.1
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Accept-Ranges:
+      - bytes
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Mon, 11 Apr 2016 12:02:42 GMT
+      Etag:
+      - '"01be3e0e10cb470efae890f743919134"'
+      Server:
+      - nginx
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - b89-586923734
+      Content-Length:
+      - '779'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_298_673446=smiVONW/3z4SYfTFKrYiBGKSC1cAAAAAWFRx31EjUEYkINQqH3WjVA==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=vrUaNl0JVwteQduiaoBaJgAAAAC8NTjiFbae4xBPiFqTka40; path=/; Domain=.contentful.com
+      - visid_incap_673446=gUN9MJSOQeC2jpXLGMK41mKSC1cAAAAAQUIPAAAAAAAW7GMqfuKypNg7FVuYvw1a;
+        expires=Tue, 11 Apr 2017 09:48:50 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 6-47862086-47862138 NNNN CT(135 136 0) RT(1460376161233 384) q(0 0 2 -1) r(5
+        5) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: UTF-8
+      string: |+
+        {
+          "url":"https://www.example2.com",
+          "httpBasicUsername":null,
+          "name":"some_webhook",
+          "headers":[
+            {
+              "key":"MyHeader",
+              "value":"foobar"
+            }
+          ],
+          "topics":[
+            "*.publish",
+            "*.unpublish"
+          ],
+          "sys":{
+            "type":"WebhookDefinition",
+            "id":"some_id",
+            "version":1,
+            "space":{
+              "sys":{
+                "type":"Link",
+                "linkType":"Space",
+                "id":"zjvxmotjud5s"
+              }
+            },
+            "createdBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "createdAt":"2016-04-11T12:01:38Z",
+            "updatedBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "updatedAt":"2016-04-11T12:02:42Z"
+          }
+        }
+
+    http_version: 
+  recorded_at: Mon, 11 Apr 2016 12:02:42 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/webhook/topics.yml

@@ -0,0 +1,117 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.contentful.com/spaces/zjvxmotjud5s/webhook_definitions
+    body:
+      encoding: UTF-8
+      string: '{"name":"test_topics","url":"https://www.example3.com","topics":["Entry.save","Entry.publish","ContentType.*"]}'
+    headers:
+      User-Agent:
+      - RubyContentfulManagementGem/1.0.1
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Accept-Ranges:
+      - bytes
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Mon, 11 Apr 2016 12:07:22 GMT
+      Etag:
+      - '"dd51fac46eba663bcf7329d8b7ee8b2d"'
+      Location:
+      - https://api.contentful.com/spaces/zjvxmotjud5s/webhook_definitions/6M41zyKGz55qnovKxmQpDq
+      Server:
+      - nginx
+      Status:
+      - 201 Created
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - 0b5-378528942
+      Content-Length:
+      - '755'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_298_673446=ObNhKWt19F4cF/bFKrYiBHmTC1cAAAAAkqUyDYhnniovgNttVTfJiA==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=91YRMe7grEIWz1qEaoBaJgAAAABieAw9TAy6uXkiSIdAo7qF; path=/; Domain=.contentful.com
+      - visid_incap_673446=5hUsKWioRmWE8c2RlEOdQnmTC1cAAAAAQUIPAAAAAACl2BFxadnn1v0+QIVhz6Py;
+        expires=Tue, 11 Apr 2017 09:48:50 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 8-70349673-70349687 NNNN CT(145 137 0) RT(1460376440866 93) q(0 0 3 -1) r(6
+        6) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: UTF-8
+      string: |+
+        {
+          "url":"https://www.example3.com",
+          "httpBasicUsername":null,
+          "name":"test_topics",
+          "headers":[],
+          "topics":[
+            "Entry.save",
+            "Entry.publish",
+            "ContentType.*"
+          ],
+          "sys":{
+            "type":"WebhookDefinition",
+            "id":"6M41zyKGz55qnovKxmQpDq",
+            "version":0,
+            "space":{
+              "sys":{
+                "type":"Link",
+                "linkType":"Space",
+                "id":"zjvxmotjud5s"
+              }
+            },
+            "createdBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "createdAt":"2016-04-11T12:07:21Z",
+            "updatedBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "updatedAt":"2016-04-11T12:07:21Z"
+          }
+        }
+
+    http_version: 
+  recorded_at: Mon, 11 Apr 2016 12:07:22 GMT
+recorded_with: VCR 2.9.3

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

@@ -38,6 +38,10 @@ module Contentful
 
       describe '.all_published' do
         let!(:space_id) { 'bjwq7b86vgmm' }
+        before :each do
+          expect_any_instance_of(Contentful::Management::Asset.client_association_class).to receive(:warn)
+        end
+
         it 'class method also works' do
           vcr('asset/all_public') { expect(Contentful::Management::Asset.all_published(client, space_id)).to be_kind_of Contentful::Management::Array }
         end

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

@@ -207,6 +207,42 @@ module Contentful
             end
           end
         end
+
+        it 'creates a content_type with an omitted field' do
+          vcr('content_type/omitted_field') {
+            space = client.spaces.find('ngtgiva4wofg')
+
+            omitted_field = Contentful::Management::Field.new
+            omitted_field.id = 'omitted_field'
+            omitted_field.name = 'omitted_field'
+            omitted_field.type = 'Symbol'
+            omitted_field.omitted = true
+
+            name_field = Contentful::Management::Field.new
+            name_field.id = 'name'
+            name_field.name = 'name'
+            name_field.type = 'Symbol'
+
+            content_type = space.content_types.new
+            content_type.id = 'omitted_ct'
+            content_type.name = 'Omitted CT'
+            content_type.fields = [omitted_field, name_field]
+            content_type.display_field = 'name'
+
+            content_type.save
+            content_type.activate
+
+            content_type.reload
+
+            field = content_type.fields.detect { |f| f.name == 'omitted_field' }
+
+            expect(field.omitted).to be_truthy
+
+            field = content_type.fields.detect { |f| f.name == 'name' }
+
+            expect(field.omitted).to be_falsey
+          }
+        end
       end
 
       describe '#update' do

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

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'contentful/management/space'
+require 'contentful/management/client'
+
+module Contentful
+  module Management
+    describe EditorInterface do
+      let(:token) { '<ACCESS_TOKEN>' }
+      let(:space_id) { 'oe3b689om6k5' }
+      let(:content_type_id) { 'testInterfaces' }
+      let(:editor_interface_id) { 'default' }
+
+      let(:editor_interface_attrs) {
+        {
+          controls: [
+            {
+              'fieldId' => 'symbol1',
+              'widgetId' => 'urlEditor'
+            }
+          ]
+        }
+      }
+
+      let!(:client) { Client.new(token) }
+
+      subject { client.editor_interfaces }
+
+      describe '.default' do
+        it 'class method also works' do
+          vcr('editor_interfaces/default_for_space') { expect(Contentful::Management::EditorInterface.default(client, space_id, content_type_id)).to be_kind_of Contentful::Management::EditorInterface }
+        end
+        it 'builds a Contentful::Management::Locale object' do
+          vcr('editor_interfaces/default_for_space') { expect(subject.default(space_id, content_type_id)).to be_kind_of Contentful::Management::EditorInterface }
+        end
+      end
+
+      describe '#update' do
+        let(:content_type_id) { 'smallerType' }
+
+        it 'can update the editor_interface' do
+          vcr('editor_interfaces/update') do
+            editor_interface = subject.default(space_id, content_type_id)
+
+            expect(editor_interface.controls.first['widgetId']).to eq 'singleline'
+
+            editor_interface.controls.first['widgetId'] = 'urlEditor'
+            editor_interface.update(controls: editor_interface.controls)
+
+            editor_interface.reload
+
+            expect(editor_interface.controls.first['widgetId']).to eq 'urlEditor'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -44,6 +44,11 @@ module Contentful
 
       describe '.all_published' do
         let!(:space_id) { 'bjwq7b86vgmm' }
+
+        before :each do
+          expect_any_instance_of(Contentful::Management::Entry.client_association_class).to receive(:warn)
+        end
+
         it 'class method also works' do
           vcr('entry/all_public') { expect(Contentful::Management::Entry.all_published(client, space_id)).to be_kind_of Contentful::Management::Array }
         end

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

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'contentful/management/space'
+require 'contentful/management/client'
+
+module Contentful
+  module Management
+    describe Role do
+      let(:token) { '<ACCESS_TOKEN>' }
+      let(:space_id) { '03vrieuz7eun' }
+      let(:role_id) { '0rQMQMd6ZTgeF7hxjz7JDi' }
+
+      let(:role_attrs) {
+        {
+          name: 'testRoleCreate',
+          description: 'test role',
+          permissions: {
+            'ContentDelivery' => 'all',
+            'ContentModel' => ['read'],
+            'Settings' => []
+          },
+          policies: [
+            {
+              effect: 'allow',
+              actions: 'all',
+              constraint: {
+                and: [
+                  {
+                    equals: [
+                      { doc: 'sys.type' },
+                      'Entry'
+                    ]
+                  },
+                  {
+                    equals: [
+                      { doc: 'sys.type' },
+                      'Asset'
+                    ]
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      }
+
+      let!(:client) { Client.new(token) }
+
+      subject { client.roles }
+
+      describe '.all' do
+        it 'class method also works' do
+          vcr('roles/all_for_space') { expect(Contentful::Management::Role.all(client, space_id)).to be_kind_of Contentful::Management::Array }
+        end
+        it 'returns a Contentful::Array' do
+          vcr('roles/all_for_space') { expect(subject.all(space_id)).to be_kind_of Contentful::Management::Array }
+        end
+        it 'builds a Contentful::Management::Locale object' do
+          vcr('roles/all_for_space') { expect(subject.all(space_id).first).to be_kind_of Contentful::Management::Role }
+        end
+      end
+
+      describe '.find' do
+        it 'class method also works' do
+          vcr('roles/find') { expect(Contentful::Management::Role.find(client, space_id, role_id)).to be_kind_of Contentful::Management::Role }
+        end
+        it 'returns a Contentful::Management::Role' do
+          vcr('roles/find') { expect(subject.find(space_id, role_id)).to be_kind_of Contentful::Management::Role }
+        end
+        it 'returns the locale for a given key' do
+          vcr('roles/find') do
+            role = subject.find(space_id, role_id)
+            expect(role.id).to eq role_id
+          end
+        end
+        it 'returns an error when content_type does not exists' do
+          vcr('roles/find_for_space_not_found') do
+            result = subject.find(space_id, 'not_exist')
+            expect(result).to be_kind_of Contentful::Management::NotFound
+          end
+        end
+      end
+      describe '.create' do
+        it 'create role for space' do
+          vcr('roles/create_for_space') do
+            role = subject.create(space_id, role_attrs)
+
+            expect(role.name).to eq 'testRoleCreate'
+            expect(role.description).to eq 'test role'
+            expect(role.permissions['ContentDelivery']).to eq 'all'
+            expect(role.policies.first['effect']).to eq 'allow'
+          end
+        end
+      end
+      describe '#update' do
+        it 'can update the role' do
+          vcr('roles/update') do
+            role = subject.find(space_id, role_id)
+            role.update(name: 'Something')
+
+            role.reload
+
+            expect(role.name).to eq 'Something'
+          end
+        end
+      end
+
+      describe '#destroy' do
+        it 'can destroy roles' do
+          vcr('roles/destroy') do
+            role_attrs[:name] = 'ToDelete'
+            role = subject.create(space_id, role_attrs)
+
+            expect(subject.find(space_id, role.id).name).to eq 'ToDelete'
+
+            role.destroy
+
+            error = subject.find(space_id, role.id)
+
+            expect(error).to be_a Contentful::Management::NotFound
+          end
+        end
+      end
+    end
+  end
+end