contentful-management 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bb620d6df69c4e84f671fe8a91e91f1fae53310
-  data.tar.gz: f1cb940d955248205c1c564d45aa25e8c59de0d4
+  metadata.gz: 9e9540f9f6f76faa7bc81ffc078b274f6ad41c9f
+  data.tar.gz: 627329c7f26dcb8f7866def702f06d0c44721777
 SHA512:
-  metadata.gz: e7b895437b69329cab7a8d4e45454cf304bcedbb911463ed5fd5b92d37b1cc479c31a164ee96ee46991ced0eddcbf38c186544eeeef135a38b819e6382a78d34
-  data.tar.gz: ba872718b2b957c72a36956c72db232b1edbb537d14bd18520ccb32a1921666ae423b8b2172c73a1c84894edd40db732f8bddf775af5751294af4a2fa21f3d66
+  metadata.gz: 8d249c4f1a49c297c970a712c9e7a934b52928e839b2d7fa63e451c714ed7e002e26799eb8aa3550dd1cce1ab3d88537ebd6a30455c996bff32fd306fb6e0f13
+  data.tar.gz: e6e6a254e522a42befd514c7877db377c4f0c32abca8760fc8fb2f291afc155a815fca42057fb77e89a490269ce6251a5f95d1c6e51eb6832ae9ee1a2166f794

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master
 
+## 1.1.0
+### Added
+* Add Roles and Permissions Support
+* Add Headers, Topics and Webhook Name Support
+* Add Editor Interfaces Support
+* Add `:omitted` property to Content Type Fields
+
+### Changed
+* Added Deprecation warning for `assets.all_published` and `entries.all_published`. This methods will be completely removed soon.
+
 ## 1.0.1
 ### Changed
 * Changed locale selection priority when requesting fields [#91](https://github.com/contentful/contentful-management.rb/issues/91)

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 group :development do
   gem 'guard'
+  gem 'listen', '3.0.0'
   gem 'guard-rspec'
   gem 'guard-rubocop'
   gem 'pry'

data/README.md

@@ -1,4 +1,3 @@
-
 # Contentful::Management
 [![Gem Version](https://badge.fury.io/rb/contentful-management.svg)](http://badge.fury.io/rb/contentful-management) [![Build Status](https://travis-ci.org/contentful/contentful-management.rb.svg)](https://travis-ci.org/contentful/contentful-management.rb)
 
@@ -85,131 +84,6 @@ blog_space.name = 'New Blog Space'
 blog_space.save
 ```
 
-### Content Types
-
-Retrieving all content types from a space:
-
-```ruby
-blog_post_content_types = blog_space.content_types.all
-```
-
-Retrieving all published content types from a space:
-
-```ruby
-blog_post_content_types = blog_space.content_types.all_published
-```
-
-Retrieving one content type by id from a space:
-
-```ruby
-blog_post_content_type = blog_space.content_types.find(id)
-```
-
-Creating a field for a content type:
-
-```ruby
-title_field = Contentful::Management::Field.new
-title_field.id = 'blog_post_title'
-title_field.name = 'Post Title'
-title_field.type = 'Text'
-blog_post_content_type.fields.add(field)
-```
-
-or
-
-```ruby
-blog_post_content_type.fields.create(id: 'title_field_id', name: 'Post Title', type: 'Text')
-```
-- if the field_id exists, the related field will be updated.
-
-or the field of link type:
-```ruby
-blog_post_content_type.fields.create(id: 'my_entry_link_field', name: 'My Entry Link Field', type: 'Link', link_type: 'Entry')
-```
-
-or the field of an array type:
-```ruby
-items = Contentful::Management::Field.new
-items.type = 'Link'
-items.link_type = 'Entry'
-blog_post_content_type.fields.create(id: 'my_array_field', name: 'My Array Field', type: 'Array', items: items)
-```
-
-Deleting a field from the content type:
-
-```ruby
-blog_post_content_type.fields.destroy(title_field_id)
-```
-
-Creating a content type:
-
-```ruby
-blog_space.content_types.create(name: 'Post', fields: [title_field, body_field])
-```
-
-or
-
-```ruby
-blog_post_content_type = blog_space.content_types.new
-blog_post_content_type.name = 'Post'
-blog_post_content_type.fields = [title_field, body_field]
-blog_post_content_type.save
-```
-
-Destroying a content type:
-
-```ruby
-blog_post_content_type.destroy
-```
-
-Activating or deactivating a content type:
-
-```ruby
-blog_post_content_type.activate
-blog_post_content_type.deactivate
-```
-
-Checking if a content type is active:
-
-```ruby
-blog_post_content_type.active?
-```
-
-Updating a content type:
-
-```ruby
-blog_post_content_type.update(name: 'Post', description: 'Post Description', fields: [title_field])
-```
-
-### Locales
-
-Retrieving all locales from the space:
-
-```ruby
-blog_post_locales = blog_space.locales.all
-```
-
-Retrieving one locale by the locale-id from the space:
-
-```ruby
-blog_post_locale = blog_space.locales.find(locale_id)
-```
-
-Creating a locale
-```ruby
-blog_space.locales.create(name: 'German', code: 'de-DE')
-```
-
-Updating a locale
-```ruby
-blog_post_locale.update(name: 'German', code: 'de-DE')
-```
-
-Destroying a locale
-```ruby
-blog_post_locale.destroy
-```
-
 ### Assets
 
 Retrieving all assets from the space:
@@ -218,7 +92,7 @@ Retrieving all assets from the space:
 blog_post_assets = blog_space.assets.all
 ```
 
-Retrieving all published assets from the space:
+Retrieving all published assets from the space: **DEPRECATED**
 
 ```ruby
 blog_post_assets = blog_space.assets.all_published
@@ -330,7 +204,7 @@ Retrieving all entries from the space:
 entries = blog_space.entries.all
 ```
 
-Retrieving all published entries from the space:
+Retrieving all published entries from the space: **DEPRECATED**
 
 ```ruby
 entries = blog_space.entries.all_published
@@ -435,57 +309,103 @@ my_entry.published?
 >   * Enable [Content Type Cache](#content-type-cache) at Client Instantiation time
 >   * Query Entries through `space.entries.find` instead of `Entry.find(space_id, entry_id)`
 
-### Webhooks
+### Content Types
 
-Retrieving all webhooks from the space:
+Retrieving all content types from a space:
 
 ```ruby
-webhooks = blog_space.webhooks.all
+blog_post_content_types = blog_space.content_types.all
 ```
-Retrieving one webhook by the webhook-id from the space:
+
+Retrieving all published content types from a space:
 
 ```ruby
-blog_post_webhook = blog_space.webhooks.find(webhook_id)
+blog_post_content_types = blog_space.content_types.all_published
 ```
 
-Creating a webhook
+Retrieving one content type by id from a space:
 
 ```ruby
-blog_space.webhooks.create(url: 'https://www.example.com', httpBasicUsername: 'username', httpBasicPassword: 'password')
+blog_post_content_type = blog_space.content_types.find(id)
 ```
 
-Updating a webhook
+Creating a field for a content type:
 
 ```ruby
-blog_post_webhook.update(url: 'https://www.newlink.com')
+title_field = Contentful::Management::Field.new
+title_field.id = 'blog_post_title'
+title_field.name = 'Post Title'
+title_field.type = 'Text'
+blog_post_content_type.fields.add(field)
 ```
 
-Destroying webhook:
+or
 
 ```ruby
-blog_post_webhook.destroy
+blog_post_content_type.fields.create(id: 'title_field_id', name: 'Post Title', type: 'Text')
 ```
+- if the field_id exists, the related field will be updated.
 
-### Api Keys
+or the field of link type:
+```ruby
+blog_post_content_type.fields.create(id: 'my_entry_link_field', name: 'My Entry Link Field', type: 'Link', link_type: 'Entry')
+```
 
-Retrieving all api keys from the space:
+or the field of an array type:
+```ruby
+items = Contentful::Management::Field.new
+items.type = 'Link'
+items.link_type = 'Entry'
+blog_post_content_type.fields.create(id: 'my_array_field', name: 'My Array Field', type: 'Array', items: items)
+```
+
+Deleting a field from the content type:
 
 ```ruby
-blog_post_api_keys = blog_space.api_keys.all
+blog_post_content_type.fields.destroy(title_field_id)
 ```
 
-Retrieving one api key by the api-key-id from the space:
+Creating a content type:
 
 ```ruby
-blog_post_api_key = blog_space.api_keys.find(api_key_id)
+blog_space.content_types.create(name: 'Post', fields: [title_field, body_field])
 ```
 
-Creating an api key
+or
+
 ```ruby
-blog_space.api_keys.create(name: 'foobar key', description: 'key for foobar mobile app')
+blog_post_content_type = blog_space.content_types.new
+blog_post_content_type.name = 'Post'
+blog_post_content_type.fields = [title_field, body_field]
+blog_post_content_type.save
+```
+
+Destroying a content type:
+
+```ruby
+blog_post_content_type.destroy
 ```
 
-## Validations
+Activating or deactivating a content type:
+
+```ruby
+blog_post_content_type.activate
+blog_post_content_type.deactivate
+```
+
+Checking if a content type is active:
+
+```ruby
+blog_post_content_type.active?
+```
+
+Updating a content type:
+
+```ruby
+blog_post_content_type.update(name: 'Post', description: 'Post Description', fields: [title_field])
+```
+
+### Validations
 
 #### in
 
@@ -567,6 +487,180 @@ validation_link_field.link_field  = true
 content_type.fields.create(id: 'entry', validations: [validation_link_field])
 ```
 
+### Locales
+
+Retrieving all locales from the space:
+
+```ruby
+blog_post_locales = blog_space.locales.all
+```
+
+Retrieving one locale by the locale-id from the space:
+
+```ruby
+blog_post_locale = blog_space.locales.find(locale_id)
+```
+
+Creating a locale
+```ruby
+blog_space.locales.create(name: 'German', code: 'de-DE')
+```
+
+Updating a locale
+```ruby
+blog_post_locale.update(name: 'German', code: 'de-DE')
+```
+
+Destroying a locale
+```ruby
+blog_post_locale.destroy
+```
+
+### Roles
+
+Retrieving all roles from the space:
+
+```ruby
+blog_post_roles = blog_space.roles.all
+```
+
+Retrieving one role by the locale-id from the space:
+
+```ruby
+blog_post_role = blog_space.role.find(role_id)
+```
+
+Creating a role
+```ruby
+role_attributes = {
+  name: 'My Role',
+  description: 'foobar role',
+  permissions: {
+    'ContentDelivery': 'all',
+    'ContentModel': ['read'],
+    'Settings': []
+  },
+  policies: [
+    {
+      effect: 'allow',
+      actions: 'all',
+      constraint: {
+        and: [
+          {
+            equals: [
+              { doc: 'sys.type' },
+              'Entry'
+            ]
+          },
+          {
+            equals: [
+              { doc: 'sys.type' },
+              'Asset'
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}
+blog_space.roles.create(role_attributes)
+```
+
+Updating a role
+```ruby
+blog_post_role.update(name: 'Some Other Role') # Can change any attribute here
+```
+
+Destroying a role
+```ruby
+blog_post_role.destroy
+```
+
+### Webhooks
+
+Retrieving all webhooks from the space:
+
+```ruby
+webhooks = blog_space.webhooks.all
+```
+Retrieving one webhook by the webhook-id from the space:
+
+```ruby
+blog_post_webhook = blog_space.webhooks.find(webhook_id)
+```
+
+Creating a webhook
+
+```ruby
+blog_space.webhooks.create(
+  name: 'My Webhook',
+  url: 'https://www.example.com',
+  httpBasicUsername: 'username',
+  httpBasicPassword: 'password'
+)
+```
+
+Updating a webhook
+
+```ruby
+blog_post_webhook.update(url: 'https://www.newlink.com')
+```
+
+Destroying webhook:
+
+```ruby
+blog_post_webhook.destroy
+```
+
+Creating a Webhook with Custom Headers and Custom Topics:
+
+```ruby
+blog_space.webhooks.create(
+  name: 'Entry Save Only',
+  url: 'https://www.example.com',
+  topics: [ 'Entry.save' ],
+  headers: [
+    {
+      key: 'X-My-Custom-Header',
+      value: 'Some Value'
+    }
+  ]
+)
+```
+
+### Api Keys
+
+Retrieving all api keys from the space:
+
+```ruby
+blog_post_api_keys = blog_space.api_keys.all
+```
+
+Retrieving one api key by the api-key-id from the space:
+
+```ruby
+blog_post_api_key = blog_space.api_keys.find(api_key_id)
+```
+
+Creating an api key
+```ruby
+blog_space.api_keys.create(name: 'foobar key', description: 'key for foobar mobile app')
+```
+
+### Editor Interface
+
+Retrieving editor interface for a content type:
+
+```ruby
+blog_post_editor_interface = blog_post_content_type.editor_interface.default
+```
+
+You can call the EditorInterface API from any level within the Content Model Hierarchy, take into account that you'll need to
+pass the ids of the levels below it.
+
+> Hierarchy is as follows:
+> `No Object -> Space -> ContentType -> EditorInterface`
+
 ### Pagination
 
 ```ruby
@@ -575,7 +669,7 @@ blog_space.assets.all(limit: 5).next_page
 blog_space.entries.all(limit: 5).next_page
 ```
 
-## Logging
+### Logging
 
 Logging is disabled by default, it can be enabled by setting a logger instance and a logging severity.
 
@@ -594,7 +688,7 @@ Logger.new('logfile.log')
 
 The default severity is set to INFO and logs only the request attributes (headers, parameters and url). Setting it to DEBUG will also log the raw JSON response.
 
-## Raise Errors
+### Raise Errors
 
 If `:raise_errors` is set to true, an Exception will be raised in case of an error. The default is false, in this case a ```Contentful::Management::Error``` object will be returned.
 
@@ -602,7 +696,7 @@ If `:raise_errors` is set to true, an Exception will be raised in case of an err
 client = Contentful::Management::Client.new('access_token', raise_errors: true)
 ```
 
-## Content Type Cache
+### Content Type Cache
 
 This allows for fetching Content Types for your Space at Client instantiation time, which prevents extra requests per Entry.
 To enable this, in your Client instantiation do:
@@ -613,7 +707,7 @@ client = Contentful::Management::Client.new(token, dynamic_entries: ['my_space_i
 
 You can enable the Cache for as many Spaces as you want.
 
-## Proxy Support
+### Proxy Support
 
 This allows for using the CMA SDK through a proxy, for this, your proxy must support HTTPS and your server must have a valid signed certificate.