contentful-management 2.11.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6053a222f0246ee05c699c0f53a7a0c56834aff0dfb109dbe8e2e00336cafb7
-  data.tar.gz: 7ea4cad8b0090a73e11d1ce14058d84ad8aa840d928335d12627f11441c8266d
+  metadata.gz: 85f13e855cf6a3d868bb24e36b3bc311f05a5df0206ae6d66a5f9b1d6ba5a94a
+  data.tar.gz: 979be40c83e892575ccebbd1fcd2a41f2da39a87992d43994d31d999feae33e8
 SHA512:
-  metadata.gz: 3be70b623839233a8c98f4c8442fdb1e5d4b24a8d67852181597f90a8d5cb443b83bd6f8a27fa0a66e10a9b393d490d96cc777c02be54f2fcd99cec2685d0022
-  data.tar.gz: 98b4aaa70e1594f19d113893c26ab6d53c292e105591c21e51c21095a0c6f79896d396f0ca55bbab54cc9f52809595fb9c9311b2a1ec510bd4a9cda0130726df
+  metadata.gz: 2e724340067a6e209d5387388e6c05e71fec59f9211cbcf60e868d79a439fe1a2f76ebfb36b936e7be61956be2b2fe3ee0c859d2f1125c48ccaaa007acdadcd7
+  data.tar.gz: e95297441626f040734f1e0719f748816ae76b72afe8c57a4f9705d4afde5ed568cfffce73f9ec438cc8ef92299d1ad5b6328d6ca29c0a4231e43ec54e3b55b5

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 ## Master
 
+## 3.0.0
+### Fixed
+* Added support for Tags metadata
+
+### Changed
+
+**BREAKING CHANGES**:
+* Introduction of new top-level tags `metadata` property in api response.
+
+## 2.13.1
+### Fixed
+* Fixed an issue when loading entries or assets that included tags. [#219](https://github.com/contentful/contentful-management.rb/issues/219)
+
+## 2.13.0
+### Fixed
+* Fixed a possible validation error when submitting a content type. [#218](https://github.com/contentful/contentful-management.rb/pull/218)
+
+### Added
+* Added support for Users API. [#217](https://github.com/contentful/contentful-management.rb/pull/217)
+
+## 2.12.1
+
+### Fixed
+* Fixed an issue where JSON fields with top-level arrays were not properly parsed. [#215](https://github.com/contentful/contentful-management.rb/issues/215)
+
+## 2.12.0
+
+*Note*: Only a minor change because the removed feature was *Alpha*.
+
+### Added
+* Add `OrganizationPeriodicUsage`, `Client#organization_periodic_usages` and `Organization#periodic_usages`.
+* Add `SpacePeriodicUsage`, `Client#space_periodic_usages` and `Organization#space_periodic_usages`.
+
+### Removed
+* Removed now deprecated Alpha Usage APIs, which have been superseeded by the new APIs added.
+
 ## 2.11.0
 ### Added
 * Added support for Rich Text specific validations. [#200](https://github.com/contentful/contentful-management.rb/pull/200)

data/README.md

@@ -827,40 +827,46 @@ Retrieving all organization details:
 organizations = client.organizations.all
 ```
 
-### Usage Periods (ALPHA)
+### Usage
 
 *Note*: This feature is available only to Commited v2 customers.
 
-Retrieving all Usage Periods for an Organizations you belong to:
+#### Organization Periodic Usage
+
+Retrieving all API Usage statistics for an Organization during a given usage period, broken down by organization for all APIs:
 
 ```ruby
-usage_periods = client.usage_periods('organization_id').all
+# Optionally, you can pass the metric, start and end date filters
+usage = client.organization_periodic_usages('organization_id').all
+
+# For example only CDA and CMA metrics from yesterday onwards
+usage = client.organization_periodic_usages('organization_id').all('metric[in]': ['cda', 'cma'], startDate: (Date.today - 1).iso8601)
 ```
 
 Alternatively, if you have an already fetched organization:
 
 ```ruby
-usage_periods = organization.usage_periods().all()
+# Breaking down CMA usage by space, for a given period.
+usage = organization.periodic_usages.all
 ```
 
-### API Usage (ALPHA)
+#### Space Periodic Usage
 
-*Note*: This feature is available only to Commited v2 customers.
-
-Retrieving all API Usage statistics for an Organizations during a given usage period, broken down by organization for all APIs:
+Retrieving all API Usage statistics for an Organization during a given usage period, broken down by space for all APIs:
 
 ```ruby
-# Valid usage types are by 'organization' and by 'space'.
-# Usage period IDs are numerical and can be fetched from the Usage Periods API.
-# Valid API breakdowns are: 'cda', 'cpa', 'cma' or 'all_apis'.
-usage = client.api_usage('organization_id').all('organization', usage_period_id, 'all_apis')
+# Optionally, you can pass the metric, start and end date filters
+usage = client.space_periodic_usages('organization_id').all
+
+# For example only CDA and CMA metrics from yesterday onwards
+usage = client.space_periodic_usages('organization_id').all('metric[in]': ['cda', 'cma'], startDate: (Date.today - 1).iso8601)
 ```
 
 Alternatively, if you have an already fetched organization:
 
 ```ruby
 # Breaking down CMA usage by space, for a given period.
-usage = organization.api_usage().all('space', usage_period_id, 'cma')
+usage = organization.space_periodic_usages.all
 ```
 
 ### Users
@@ -871,6 +877,17 @@ Retrieving current user details:
 user = client.users.me
 ```
 
+Retrieving one user by ID from the space:
+
+```ruby
+user = blog_space.users.find(user_id)
+```
+
+Retrieving one user by ID from an organization:
+
+```ruby
+user = organization.users.find('user_id')
+```
 ### UI Extensions
 
 Retrieving all UI extensions from the environment:

data/contentful-management.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '>= 1.8', '< 3.0'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '< 11.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'public_suffix', '< 1.5'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'

data/lib/contentful/management/asset.rb

@@ -1,6 +1,7 @@
 require_relative 'resource'
 require_relative 'resource/fields'
 require_relative 'resource/archiver'
+require_relative 'resource/metadata'
 require_relative 'resource/publisher'
 require_relative 'resource/asset_fields'
 require_relative 'resource/environment_aware'
@@ -15,6 +16,7 @@ module Contentful
       include Contentful::Management::Resource
       include Contentful::Management::Resource::Fields
       include Contentful::Management::Resource::Archiver
+      include Contentful::Management::Resource::Metadata
       include Contentful::Management::Resource::Refresher
       include Contentful::Management::Resource::Publisher
       include Contentful::Management::Resource::SystemProperties

data/lib/contentful/management/client.rb

@@ -20,9 +20,7 @@ require 'contentful/management/client_upload_methods_factory'
 require 'contentful/management/client_api_key_methods_factory'
 require 'contentful/management/client_webhook_methods_factory'
 require 'contentful/management/client_snapshot_methods_factory'
-require 'contentful/management/client_api_usage_methods_factory'
 require 'contentful/management/client_environment_methods_factory'
-require 'contentful/management/client_usage_period_methods_factory'
 require 'contentful/management/client_organization_methods_factory'
 require 'contentful/management/client_content_type_methods_factory'
 require 'contentful/management/client_ui_extension_methods_factory'
@@ -31,7 +29,9 @@ require 'contentful/management/client_webhook_health_methods_factory'
 require 'contentful/management/client_preview_api_key_methods_factory'
 require 'contentful/management/client_space_membership_methods_factory'
 require 'contentful/management/client_editor_interface_methods_factory'
+require 'contentful/management/client_space_periodic_usage_methods_factory'
 require 'contentful/management/client_personal_access_tokens_methods_factory'
+require 'contentful/management/client_organization_periodic_usage_methods_factory'
 
 module Contentful
   module Management
@@ -133,22 +133,20 @@ module Contentful
         ClientOrganizationMethodsFactory.new(self)
       end
 
-      # Allows viewing of usage periods in context of the current client
-      # Allows listing all usage periods for client.
+      # Allows listing all usage periods for organization grouped by organization.
       # @see _ README for details.
       #
-      # @return [Contentful::Management::ClientUsagePeriodMethodsFactory]
-      def usage_periods(organization_id)
-        ClientUsagePeriodMethodsFactory.new(self, organization_id)
+      # @return [Contentful::Management::ClientOrganizationPeriodicUsageMethodsFactory]
+      def organization_periodic_usages(organization_id)
+        ClientOrganizationPeriodicUsageMethodsFactory.new(self, organization_id)
       end
 
-      # Allows viewing of api usage in context of the current client
-      # Allows listing all api usage for client.
+      # Allows listing all usage periods for organization grouped by space.
       # @see _ README for details.
       #
-      # @return [Contentful::Management::ClientApiUsageMethodsFactory]
-      def api_usage(organization_id)
-        ClientApiUsageMethodsFactory.new(self, organization_id)
+      # @return [Contentful::Management::ClientSpacePeriodicUsageMethodsFactory]
+      def space_periodic_usages(organization_id)
+        ClientSpacePeriodicUsageMethodsFactory.new(self, organization_id)
       end
 
       # Allows viewing of users in context of the current client

data/lib/contentful/management/{client_usage_period_methods_factory.rb → client_organization_periodic_usage_methods_factory.rb}

@@ -2,9 +2,9 @@ require_relative 'client_association_methods_factory'
 
 module Contentful
   module Management
-    # Wrapper for Usage Period for usage from within Client
+    # Wrapper for Organization Periodic Usages for usage from within Client
     # @private
-    class ClientUsagePeriodMethodsFactory
+    class ClientOrganizationPeriodicUsageMethodsFactory
       include Contentful::Management::ClientAssociationMethodsFactory
 
       def initialize(client, organization_id)
@@ -17,8 +17,7 @@ module Contentful
           {
             organization_id: @organization_id
           },
-          params,
-          'x-contentful-enable-alpha-feature' => 'usage-insights'
+          params
         )
       end
 

data/lib/contentful/management/{client_api_usage_methods_factory.rb → client_space_periodic_usage_methods_factory.rb}

@@ -2,9 +2,9 @@ require_relative 'client_association_methods_factory'
 
 module Contentful
   module Management
-    # Wrapper for API Usage for usage from within Client
+    # Wrapper for Space Periodic Usages for usage from within Client
     # @private
-    class ClientApiUsageMethodsFactory
+    class ClientSpacePeriodicUsageMethodsFactory
       include Contentful::Management::ClientAssociationMethodsFactory
 
       def initialize(client, organization_id)
@@ -12,19 +12,12 @@ module Contentful
         @organization_id = organization_id
       end
 
-      def all(usage_type, usage_period_id, api, params = {})
-        mandatory_params = {
-          'filters[usagePeriod]' => usage_period_id,
-          'filters[metric]' => api
-        }
-
+      def all(params = {})
         @resource_requester.all(
           {
-            usage_type: usage_type,
             organization_id: @organization_id
           },
-          mandatory_params.merge(params),
-          'x-contentful-enable-alpha-feature' => 'usage-insights'
+          params
         )
       end
 

data/lib/contentful/management/entry.rb

@@ -1,6 +1,7 @@
 require_relative 'resource'
 require_relative 'resource/fields'
 require_relative 'resource/archiver'
+require_relative 'resource/metadata'
 require_relative 'resource/publisher'
 require_relative 'resource_requester'
 require_relative 'resource/field_aware'
@@ -15,6 +16,7 @@ module Contentful
     # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-entries
     class Entry
       include Contentful::Management::Resource
+      include Contentful::Management::Resource::Metadata
       extend Contentful::Management::Resource::EntryFields
       include Contentful::Management::Resource::SystemProperties
 
@@ -95,18 +97,20 @@ module Contentful
 
       # @private
       def self.parse_objects_array(attributes)
-        attributes.each_with_object([]) do |attr, arr|
-          if attr.is_a? Entry
-            arr << hash_with_link_object('Entry', attr)
-          elsif attr.is_a? Asset
-            arr << hash_with_link_object('Asset', attr)
-          elsif attr.is_a? Hash
-            arr << attr
-          elsif attr.class.ancestors.map(&:to_s).include?('Contentful::Entry')
-            arr << hash_with_link_object('Entry', attr)
-          elsif attr.class.ancestors.map(&:to_s).include?('Contentful::Asset')
-            arr << hash_with_link_object('Asset', attr)
-          end
+        attributes.each_with_object([]) do |attribute, result|
+          result << if attribute.is_a? Entry
+                      hash_with_link_object('Entry', attribute)
+                    elsif attribute.is_a? Asset
+                      hash_with_link_object('Asset', attribute)
+                    elsif attribute.is_a? Hash
+                      attribute
+                    elsif attribute.class.ancestors.map(&:to_s).include?('Contentful::Entry')
+                      hash_with_link_object('Entry', attribute)
+                    elsif attribute.class.ancestors.map(&:to_s).include?('Contentful::Asset')
+                      hash_with_link_object('Asset', attribute)
+                    else
+                      attribute
+                    end
         end
       end
 

data/lib/contentful/management/field.rb

@@ -87,7 +87,9 @@ module Contentful
 
       def validations_to_hash(validations)
         validations.each_with_object([]) do |validation, results|
-          results << validation.properties_to_hash
+          validation_hash = validation.properties_to_hash
+
+          results << validation.properties_to_hash if Field.value_exists?(validation_hash)
         end
       end
     end

data/lib/contentful/management/organization.rb

@@ -1,4 +1,5 @@
 require_relative 'resource'
+require 'contentful/management/organization_user_methods_factory'
 
 module Contentful
   module Management
@@ -16,20 +17,29 @@ module Contentful
         'organizations'
       end
 
-      # Allows listing all usage periods for organization.
+      # Allows listing all usage periods for organization grouped by organization or space.
       # @see _ README for details.
       #
-      # @return [Contentful::Management::ClientApiUsageMethodsFactory]
-      def usage_periods
-        ClientApiUsageMethodsFactory.new(client, id)
+      # @return [Contentful::Management::ClientOrganizationPeriodicUsageMethodsFactory]
+      def periodic_usages
+        ClientOrganizationPeriodicUsageMethodsFactory.new(client, id)
       end
 
-      # Allows listing all api usage for organization.
+      # Allows listing all usage periods for organization grouped by organization or space.
       # @see _ README for details.
       #
-      # @return [Contentful::Management::ClientApiUsageMethodsFactory]
-      def api_usage
-        ClientApiUsageMethodsFactory.new(client, id)
+      # @return [Contentful::Management::ClientSpacePeriodicUsageMethodsFactory]
+      def space_periodic_usages
+        ClientSpacePeriodicUsageMethodsFactory.new(client, id)
+      end
+
+      # Allows viewing of users in context of an organization
+      # Allows listing all users for an organization, and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::OrganizationUserMethodsFactory]
+      def users
+        OrganizationUserMethodsFactory.new(client, id)
       end
     end
   end

data/lib/contentful/management/{api_usage.rb → organization_periodic_usage.rb}

@@ -2,40 +2,35 @@ require_relative 'resource'
 
 module Contentful
   module Management
-    # Resource class for ApiUsage.
-    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-usages
-    class ApiUsage
+    # Resource class for OrganizationPeriodicUsage.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/usage/organization-usage/get-organization-usage/console/curl
+    class OrganizationPeriodicUsage
       include Contentful::Management::Resource
       include Contentful::Management::Resource::Refresher
       include Contentful::Management::Resource::SystemProperties
 
-      property :unitOfMeasure
-      property :interval
-      property :usage
-      property :startDate, :date
-      property :endDate, :date
+      property :metric, :string
+      property :usage, :integer
+      property :usagePerDay, :object
+      property :unitOfMeasure, :string
+      property :dateRange, :object
 
       # @private
       def self.build_endpoint(endpoint_options)
         organization_id = endpoint_options[:organization_id]
-        usage_type = endpoint_options[:usage_type]
 
-        "organizations/#{organization_id}/usages/#{usage_type}"
+        "organizations/#{organization_id}/organization_periodic_usages"
       end
 
-      # Gets all api usage statistics for a given organization and usage type, filtered by usage period and api.
+      # Gets all organization periodic usages for a given organization.
       #
       # @param [Contentful::Management::Client] client
       # @param [String] organization_id
-      # @param [String] usage_type
-      # @param [Integer] usage_period_id
-      # @param [String] api
       # @param [Hash] params
       #
-      # @return [Contentful::Management::Array<Contentful::Management::ApiUsage>]
-      # rubocop:disable Metrics/ParameterLists
-      def self.all(client, organization_id, usage_type, usage_period_id, api, params = {})
-        ClientApiUsageMethodsFactory.new(client, organization_id).all(usage_type, usage_period_id, api, params)
+      # @return [Contentful::Management::Array<Contentful::Management::OrganizationPeriodicUsage>]
+      def self.all(client, organization_id, params = {})
+        ClientOrganizationPeriodicUsageMethodsFactory.new(client, organization_id).all(params)
       end
 
       # Not supported

data/lib/contentful/management/organization_user_methods_factory.rb

@@ -0,0 +1,18 @@
+module Contentful
+  module Management
+    # Wrapper for Users API for usage from within Organization
+    # @private
+    class OrganizationUserMethodsFactory
+      attr_reader :client
+
+      def initialize(client, organization_id)
+        @client = client
+        @organization_id = organization_id
+      end
+
+      def find(id)
+        User.find(client, nil, nil, id, @organization_id)
+      end
+    end
+  end
+end