contentful-management 2.9.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eab2699745e66fdf31687b99ba2105e59a1bd4a378ba0f4418ebbd3d9e528545
-  data.tar.gz: f4ca387a625b6461b160372136b76ee6228c79357a8be9f356428350e4784e9d
+  metadata.gz: 713c97cfc5294398f42d62da51db32197d2117fff66bc2161741b463593a56f0
+  data.tar.gz: 78627973b71ab35edf5239e2d5c08ec90c752ff11fcf76966585715849a77d60
 SHA512:
-  metadata.gz: 3acfd6e9399c6d250f1340542250050cb9301230fc5cce2bbf0da9d657a8d67bbaf1319185f519567fb2bf9a32d6a540a4f27665600e09a5ea2ee9298ef32cd6
-  data.tar.gz: a018f28bd8f836f5aafebd6a25ca666c376976f62ce22fb997133562d4f5654257be68ae6035f833f1de1613311596c062c4c05f8d7a94f487fce0be4192539d
+  metadata.gz: '019005f468ed53914a758a7853e5f59535ec03c29a726d6fa8a678418cd42da3de6539d11db3426c03cf26d5cdd6c63bffbb3cd0b61aa4497466f82a5920c63d'
+  data.tar.gz: 5f65e0d107b4b909ad7678bbd7e108f3a101e39daa9b5e698335ca9efc09860ff16a500fbf7dfd52e398d70c4d5fc745c059c0f1a5921fe0a5499a7c9c9f11a3

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## Master
 
+## 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)
+
+### Changed
+* Updated maximum allowed version of the `http` gem. [#205](https://github.com/contentful/contentful-management.rb/issues/205)
+
+## 2.10.0
+### Added
+* Added support for query parameters on the Space endpoints. [#197](https://github.com/contentful/contentful-management.rb/pull/197)
+
+### Fixed
+* Fixed environment aware resources that were not having the `environment_id` properly calculated. [#195](https://github.com/contentful/contentful-management.rb/pull/195)
+
+### Changed
+* Relaxed maximum allowed version of the `json` gem. [#196](https://github.com/contentful/contentful-management.rb/pull/196)
+
+## 2.9.1
+### Fixed
+* Default locale is now fetched from the client instead of passed around. [#194](https://github.com/contentful/contentful-management.rb/pull/194)
+
 ## 2.9.0
 ### Added
 * Added validations for Rich Text. [#193](https://github.com/contentful/contentful-management.rb/pull/193)

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

data/contentful-management.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'http', '> 1.0', '< 3.0'
+  spec.add_dependency 'http', '> 1.0', '< 5.0'
   spec.add_dependency 'multi_json', '~> 1'
-  spec.add_dependency 'json', '~> 1.8'
+  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'
@@ -32,7 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-yard'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_development_dependency 'listen', '~> 3.0'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'tins', '~> 1.6.0'
   spec.add_development_dependency 'simplecov'
 end

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_space_methods_factory.rb

@@ -15,8 +15,8 @@ module Contentful
       # Gets a collection of spaces.
       #
       # @return [Contentful::Management::Array<Contentful::Management::Space>]
-      def all
-        @resource_requester.all
+      def all(query = {})
+        @resource_requester.all({}, query)
       end
 
       # Gets a specific space.

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

@@ -95,18 +95,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/environment.rb

@@ -139,8 +139,9 @@ module Contentful
       # @return [String]
       def find_locale
         locale = locales.all.detect(&:default)
-        return locale.code unless locale.nil?
-        @default_locale
+        return locale.code if locale
+
+        default_locale
       end
 
       # @private

data/lib/contentful/management/organization.rb

@@ -16,20 +16,20 @@ 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
     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/resource.rb

@@ -27,18 +27,16 @@ module Contentful
       }.freeze
       # rubocop:enable Style/DoubleNegation
 
-      attr_reader :properties, :request, :default_locale, :raw_object
+      attr_reader :properties, :request, :raw_object
       attr_accessor :client
 
       # @private
       def initialize(object = nil,
                      request = nil,
                      client = nil,
-                     nested_locale_fields = false,
-                     default_locale = Contentful::Management::Client::DEFAULT_CONFIGURATION[:default_locale])
+                     nested_locale_fields = false)
         self.class.update_coercions!
         @nested_locale_fields = nested_locale_fields
-        @default_locale = default_locale
 
         @properties = extract_from_object object, :property, self.class.property_coercions.keys
         @request = request
@@ -134,6 +132,11 @@ module Contentful
         nil
       end
 
+      # Get default_locale from client
+      def default_locale
+        client.default_locale
+      end
+
       protected
 
       def update_headers

data/lib/contentful/management/resource/environment_aware.rb

@@ -6,14 +6,17 @@ module Contentful
         # Gets the environment ID for the resource.
         def environment_id
           env = sys.fetch(:environment, {})
-          case env
-          when ::Hash
-            env.fetch(:id, 'master')
-          when ::Contentful::Management::Link
-            env.id
-          else
-            'master'
-          end
+          env_from_sys =
+            case env
+            when ::Hash
+              env.fetch(:id, nil)
+            when ::Contentful::Management::Link, ::Contentful::Management::Environment
+              env.id
+            end
+
+          return env_from_sys if env_from_sys
+
+          respond_to?(:content_type) && content_type && content_type.environment_id || 'master'
         end
       end
     end