contentful-management 1.10.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 830c89f9c7aca41a9bd49279659cde3fd52749de
-  data.tar.gz: e89598e1ff1ad742b7c127d8662998198937d314
+SHA256:
+  metadata.gz: a112a23e2e96dbdc7494254e44553f0ff240a287cb2c1f36bc445778e5a06e1b
+  data.tar.gz: 87f4f922bd21f2b33967b64f6d090c2bed1772cec8280b7c836c5f169c4f244c
 SHA512:
-  metadata.gz: 4e295c3a89f384e258c7ec87ddbf5c475e990bf0fb703739f94480b4575528a629b8d74c0d75aa6f5a7b6eeec1ede27d250832ad7ad15f04c78ac8503f2fb70a
-  data.tar.gz: 2e75de7fae165a19d26d685dd1b39f7626a8ebf56b6d536350658343467643aed9193afe6354b52f3951bef9ce16bf7d4735724c441c83b63404ddcd98e5ca5c
+  metadata.gz: 0e1ea76e93a1bb0600d3163066ae498909a17ccceac9edf26317af85a8e48e30d9afa501e9251087b6d4ad87cb0261d82f5b5c26f26a33cfe059e20465c1b1d8
+  data.tar.gz: 127443c3e4474e961cb8a974e1f6fbc500cf073c2024a0979f8bf3853ab667c8199ac9622ffa9334f065dbc6b70f5db716ec7e0caf73097d1d96cb598f5d2b6f

data/.rubocop.yml

@@ -22,5 +22,8 @@ Metrics/LineLength:
 Metrics/ClassLength:
   Max: 350
 
+Metrics/ModuleLength:
+  Max: 350
+
 Style/SignalException:
   EnforcedStyle: 'semantic'

data/CHANGELOG.md

@@ -2,6 +2,54 @@
 
 ## Master
 
+## 2.0.0
+### Added
+* Added support for Environments
+
+### Changed
+
+**BREAKING CHANGES**:
+* In order to provide a better top-level client API, `space_id` and `environment_id`, are now sent on the resource proxy call, rather than on the call itself. This allows for better reusability of proxies, which in the end provide a better developer experience.
+Resources that are not environment-aware, still have the parameter arrangement changed, so proxies are also reusable, but do not include `environment_id`.
+The `spaces`, `users`, `organizations` and `personal_access_tokens` proxies still do not require any parameters as they are top level resources.
+
+Before (this code will assume that the old code was also environment aware, so that the impact is more visible):
+
+```ruby
+# Fetching all entries
+client.entries.all(space_id, environment_id)
+
+# Fetching a single entry
+client.entries.find(space_id, environment_id, entry_id)
+
+# If you wanted to find another entry, you'd have to repeat `space_id` and `environment_id`
+client.entries.find(space_id, environment_id, another_entry_id)
+```
+
+Now:
+
+```ruby
+# Fetching all entries
+client.entries(space_id, environment_id).all
+
+# Fetching a single entry
+entries_proxy = client.entries(space_id, environment_id)
+entries_proxy.find(entry_id)
+
+# If you wanted to find another entry, you just reuse the resource proxy
+entries_proxy.find(another_entry_id)
+```
+
+The proxies, apart from the parameter re-shuffling, have kept the same interface.
+
+* Spaces do no longer have proxies for `entries`, `assets`, `content_types`, `ui_extensions`, `locales` and `editor_interfaces`. These can now be found under `environments`.
+* Space objects now have `environments` as a proxy accessor.
+* Content Type Caching is now done when requesting Content Types, or when a property is missing on an Entry. Also `dynamic_entries` has been updated to receive a hash of `space_id => environment_id` pairs.
+
+### Removed
+
+* `all_published` methods for Entries and Assets have been removed.
+
 ## 1.10.1
 ### Fixed
 * Fixed an error when calling next page on `Contentful::Array` that came from requests without query parameters. [#143](https://github.com/contentful/contentful-management.rb/issues/143)

data/README.md

@@ -87,24 +87,72 @@ blog_space.name = 'New Blog Space'
 blog_space.save
 ```
 
-### Assets
+### Environments
+
+Retrieving all environments:
+
+```ruby
+environments = client.environments('space_id').all
+```
 
-Retrieving all assets from the space:
+Or if you already have a fetched space:
 
 ```ruby
-blog_post_assets = blog_space.assets.all
+environments = space.environments.all
 ```
 
-Retrieving all published assets from the space: **DEPRECATED**
+Retrieving one environment by ID:
 
 ```ruby
-blog_post_assets = blog_space.assets.all_published
+environment = client.environments('space_id').find('master')
+```
+
+Destroying a environment:
+
+```ruby
+environment.destroy
+```
+
+Creating a environment:
+
+```ruby
+environment = client.environments('space_id').new
+environment.id = 'dev'
+environment.name = 'Development'
+environment.save
+```
+
+or
+
+```ruby
+environment = client.environments(space_id).create(id: 'dev', name: 'Development')
+```
+
+Updating a environment:
+
+```ruby
+environment.update(name: 'New Blog environment')
+```
+
+or
+
+```ruby
+environment.name = 'Dev'
+environment.save
+```
+
+### Assets
+
+Retrieving all assets from the environment:
+
+```ruby
+blog_post_assets = environment.assets.all
 ```
 
 Retrieving an asset by id:
 
 ```ruby
-blog_post_asset = blog_space.assets.find('asset_id')
+blog_post_asset = environment.assets.find('asset_id')
 ```
 
 Creating a file:
@@ -119,13 +167,13 @@ image_file.properties[:upload] = 'http://www.example.com/example.jpg'
 Creating an asset:
 
 ```ruby
-my_image_asset = blog_space.assets.create(title: 'My Image', description: 'My Image Description', file: image_file)
+my_image_asset = environment.assets.create(title: 'My Image', description: 'My Image Description', file: image_file)
 ```
 
 or an asset with multiple locales
 
 ```ruby
-my_image_localized_asset = space.assets.new
+my_image_localized_asset = environment.assets.new
 my_image_localized_asset.title_with_locales= {'en-US' => 'title', 'pl' => 'pl title'}
 my_image_localized_asset.description_with_locales= {'en-US' => 'description', 'pl' => 'pl description'}
 en_file = Contentful::Management::File.new
@@ -204,21 +252,21 @@ my_image_asset.published?
 Creating an upload from a file path:
 
 ```ruby
-upload = client.uploads.create('space_id', '/path/to/file.md')
+upload = client.uploads('space_id').create('/path/to/file.md')
 ```
 
 Alternatively, create it from an `::IO` object:
 
 ```ruby
 File.open('/path/to/file.md', 'rb') do |file|
-  upload = client.uploads.create('space_id', file)
+  upload = client.uploads('space_id').create(file)
 end
 ```
 
 Finding an upload:
 
 ```ruby
-upload = client.uploads.find('space_id', 'upload_id')
+upload = client.uploads('space_id').find('upload_id')
 ```
 
 Deleting an upload:
@@ -231,7 +279,7 @@ Associating an upload with an asset:
 
 ```ruby
 # We find or create an upload:
-upload = client.uploads.find('space_id', 'upload_id')
+upload = client.uploads('space_id').find('upload_id')
 
 # We create a File object with the associated upload:
 file = Contentful::Management::File.new
@@ -240,28 +288,22 @@ file.properties[:fileName] = 'file.md'
 file.properties[:uploadFrom] = upload.to_link_json  # We create the Link from the upload.
 
 # We create an asset with the associated file:
-asset = client.assets.create('space_id', title: 'My Upload', file: file)
+asset = client.assets('space_id', 'environment_id').create(title: 'My Upload', file: file)
 asset.process_file  # We process the file, to generate an URL for our upload.
 ```
 
 ### Entries
 
-Retrieving all entries from the space:
-
-```ruby
-entries = blog_space.entries.all
-```
-
-Retrieving all published entries from the space: **DEPRECATED**
+Retrieving all entries from the environment:
 
 ```ruby
-entries = blog_space.entries.all_published
+entries = environment.entries.all
 ```
 
-Retrieving all entries from the space with given content type:
+Retrieving all entries from the environment with given content type:
 
 ```ruby
-entries = blog_space.entries.all(content_type: content_type.id)
+entries = environment.entries.all(content_type: content_type.id)
 ```
 
 or
@@ -273,7 +315,7 @@ entries = content_type.entries.all
 Retrieving an entry by ID:
 
 ```ruby
-entry = blog_space.entries.find('entry_id')
+entry = environment.entries.find('entry_id')
 ```
 
 Creating a location:
@@ -355,26 +397,26 @@ my_entry.published?
 > make an extra request to fetch the content type and fill the missing fields.
 > To allow for content type caching:
 >   * 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)`
+>   * Query entries through `environment.entries.find` instead of `Entry.find(environment_id, entry_id)`
 
 ### Content Types
 
-Retrieving all content types from a space:
+Retrieving all content types from a environment:
 
 ```ruby
-blog_post_content_types = blog_space.content_types.all
+blog_post_content_types = environment.content_types.all
 ```
 
-Retrieving all published content types from a space:
+Retrieving all published content types from a environment:
 
 ```ruby
-blog_post_content_types = blog_space.content_types.all_published
+blog_post_content_types = environment.content_types.all_published
 ```
 
-Retrieving one content type by ID from a space:
+Retrieving one content type by ID from a environment:
 
 ```ruby
-blog_post_content_type = blog_space.content_types.find(id)
+blog_post_content_type = environment.content_types.find(id)
 ```
 
 Creating a field for a content type:
@@ -416,13 +458,13 @@ 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])
+environment.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 = environment.content_types.new
 blog_post_content_type.name = 'Post'
 blog_post_content_type.fields = [title_field, body_field]
 blog_post_content_type.save
@@ -537,22 +579,22 @@ content_type.fields.create(id: 'entry', validations: [validation_link_field])
 
 ### Locales
 
-Retrieving all locales from the space:
+Retrieving all locales from the environment:
 
 ```ruby
-blog_post_locales = blog_space.locales.all
+blog_post_locales = environment.locales.all
 ```
 
-Retrieving one locale by ID from the space:
+Retrieving one locale by ID from the environment:
 
 ```ruby
-blog_post_locale = blog_space.locales.find(locale_id)
+blog_post_locale = environment.locales.find(locale_id)
 ```
 
 Creating a locale:
 
 ```ruby
-blog_space.locales.create(name: 'German', code: 'de-DE')
+environment.locales.create(name: 'German', code: 'de-DE')
 ```
 
 Updating a locale:
@@ -764,21 +806,21 @@ user = client.users.me
 
 ### UI Extensions
 
-Retrieving all UI extensions from the space:
+Retrieving all UI extensions from the environment:
 
 ```ruby
-extensions = blog_space.ui_extensions.all
+extensions = environment.ui_extensions.all
 ```
-Retrieving one UI extension by ID from the space:
+Retrieving one UI extension by ID from the environment:
 
 ```ruby
-blog_post_extension = blog_space.ui_extensions.find(extension_id)
+blog_post_extension = environment.ui_extensions.find(extension_id)
 ```
 
 Creating a UI extension:
 
 ```ruby
-blog_space.ui_extensions.create(
+environment.ui_extensions.create(
   extension: {
     'name' => 'My extension',
     'src' => 'https://www.example.com',
@@ -851,7 +893,7 @@ You can call the EditorInterface API from any level within the content model hie
 pass the IDs of the levels below it.
 
 > Hierarchy is as follows:
-> `No Object -> Space -> ContentType -> EditorInterface`
+> `No Object -> Environment -> ContentType -> EditorInterface`
 
 ### Entry Snapshots
 
@@ -884,9 +926,9 @@ snapshot = content_type.snapshots.find('some_snapshot_id')
 ### Pagination
 
 ```ruby
-blog_space.entries.all(limit: 5).next_page
-blog_space.assets.all(limit: 5).next_page
-blog_space.entries.all(limit: 5).next_page
+environment.entries.all(limit: 5).next_page
+environment.assets.all(limit: 5).next_page
+environment.entries.all(limit: 5).next_page
 ```
 
 ### Logging
@@ -918,14 +960,14 @@ client = Contentful::Management::Client.new('access_token', raise_errors: true)
 
 ### Content Type Cache
 
-This allows for fetching content types for your space at client instantiation time, which prevents extra requests per entry.
+This allows for fetching content types for your environment at client instantiation time, which prevents extra requests per entry.
 To enable this, in your client instantiation do:
 
 ```ruby
-client = Contentful::Management::Client.new(token, dynamic_entries: ['my_space_id'])
+client = Contentful::Management::Client.new(token, dynamic_entries: {'my_space_id' => 'my_environment_id'})
 ```
 
-You can enable the cache for as many spaces as you want. If no space is added, content types will be fetched upon space find.
+You can enable the cache for as many environments as you want. If no environment is added, content types will be fetched upon environment find.
 
 To completely disable this feature, upon client instantiation do:
 

data/lib/contentful/management/api_key.rb

@@ -6,13 +6,13 @@ module Contentful
     # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-keys
     class ApiKey
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::SystemProperties
 
       property :name
+      property :policies
       property :description
       property :accessToken
-      property :policies
 
       # @private
       def self.create_attributes(_client, attributes)
@@ -21,6 +21,29 @@ module Contentful
           'description' => attributes.fetch(:description, nil)
         }
       end
+
+      # Creates an API Key.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [Hash] attributes
+      # @see _ README for full attribute list for each resource.
+      #
+      # @return [Contentful::Management::ApiKey]
+      def self.create(client, space_id, attributes = {})
+        super(client, space_id, nil, attributes)
+      end
+
+      # Finds an API Key by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] api_key_id
+      #
+      # @return [Contentful::Management::ApiKey]
+      def self.find(client, space_id, api_key_id)
+        super(client, space_id, nil, api_key_id)
+      end
     end
   end
 end

data/lib/contentful/management/array.rb

@@ -11,13 +11,13 @@ module Contentful
       DEFAULT_LIMIT = 100
 
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::ArrayLike
+      include Contentful::Management::Resource::SystemProperties
 
+      property :items
+      property :skip, :integer
       property :total, :integer
       property :limit, :integer
-      property :skip, :integer
-      property :items
 
       # Simplifies pagination
       def next_page