contentful-management 2.9.1 → 2.13.0

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

data/lib/contentful/management/resource_builder.rb

@@ -12,9 +12,7 @@ require_relative 'webhook'
 require_relative 'api_key'
 require_relative 'resource'
 require_relative 'snapshot'
-require_relative 'api_usage'
 require_relative 'environment'
-require_relative 'usage_period'
 require_relative 'organization'
 require_relative 'content_type'
 require_relative 'webhook_call'
@@ -24,7 +22,9 @@ require_relative 'webhook_health'
 require_relative 'preview_api_key'
 require_relative 'space_membership'
 require_relative 'editor_interface'
+require_relative 'space_periodic_usage'
 require_relative 'personal_access_token'
+require_relative 'organization_periodic_usage'
 
 module Contentful
   module Management
@@ -37,8 +37,8 @@ module Contentful
         'Space' => Contentful::Management::Space,
         'SpaceMembership' => Contentful::Management::SpaceMembership,
         'Organization' => Contentful::Management::Organization,
-        'ApiUsage' => Contentful::Management::ApiUsage,
-        'UsagePeriod' => Contentful::Management::UsagePeriod,
+        'SpacePeriodicUsage' => Contentful::Management::SpacePeriodicUsage,
+        'OrganizationPeriodicUsage' => Contentful::Management::OrganizationPeriodicUsage,
         'User' => Contentful::Management::User,
         'Environment' => Contentful::Management::Environment,
         'ContentType' => Contentful::Management::ContentType,

data/lib/contentful/management/space.rb

@@ -6,6 +6,7 @@ require_relative 'resource'
 require_relative 'environment'
 require_relative 'space_membership'
 require_relative 'space_role_methods_factory'
+require_relative 'space_user_methods_factory'
 require_relative 'space_webhook_methods_factory'
 require_relative 'space_api_key_methods_factory'
 require_relative 'space_environment_methods_factory'
@@ -35,8 +36,8 @@ module Contentful
       # @param [Contentful::Management::Client] client
       #
       # @return [Contentful::Management::Array<Contentful::Management::Space>]
-      def self.all(client)
-        ClientSpaceMethodsFactory.new(client).all
+      def self.all(client, query = {})
+        ClientSpaceMethodsFactory.new(client).all(query)
       end
 
       # Gets a specific space.
@@ -155,6 +156,15 @@ module Contentful
         SpaceRoleMethodsFactory.new(self)
       end
 
+      # Allows viewing of users in context of the current space
+      # Allows listing all users of space, and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceUserMethodsFactory]
+      def users
+        SpaceUserMethodsFactory.new(self)
+      end
+
       # Allows manipulation of webhooks in context of the current space
       # Allows listing all webhooks for space and finding one by ID.
       # @see _ README for details.

data/lib/contentful/management/{usage_period.rb → space_periodic_usage.rb}

@@ -2,32 +2,35 @@ require_relative 'resource'
 
 module Contentful
   module Management
-    # Resource class for UsagePeriod.
-    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-usages
-    class UsagePeriod
+    # Resource class for SpacePeriodicUsage.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/usage/space-usage/get-space-usage/console/curl
+    class SpacePeriodicUsage
       include Contentful::Management::Resource
       include Contentful::Management::Resource::Refresher
       include Contentful::Management::Resource::SystemProperties
 
-      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]
 
-        "organizations/#{organization_id}/usage_periods"
+        "organizations/#{organization_id}/space_periodic_usages"
       end
 
-      # Gets all usage periods for a given organization.
+      # Gets all space periodic usages for a given organization.
       #
       # @param [Contentful::Management::Client] client
       # @param [String] organization_id
       # @param [Hash] params
       #
-      # @return [Contentful::Management::Array<Contentful::Management::UsagePeriod>]
+      # @return [Contentful::Management::Array<Contentful::Management::SpacePeriodicUsage>]
       def self.all(client, organization_id, params = {})
-        ClientUsagePeriodMethodsFactory.new(client, organization_id).all(params)
+        ClientSpacePeriodicUsageMethodsFactory.new(client, organization_id).all(params)
       end
 
       # Not supported

data/lib/contentful/management/space_user_methods_factory.rb

@@ -0,0 +1,19 @@
+require_relative 'space_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for User API for usage from within Space
+    # @private
+    class SpaceUserMethodsFactory
+      attr_reader :space
+
+      def initialize(space)
+        @space = space
+      end
+
+      def find(id)
+        User.find(space.client, space.id, nil, id)
+      end
+    end
+  end
+end

data/lib/contentful/management/user.rb

@@ -19,7 +19,13 @@ module Contentful
 
       # @private
       def self.build_endpoint(endpoint_options)
-        endpoint = 'users'
+        endpoint = if endpoint_options[:space_id]
+                     "spaces/#{endpoint_options[:space_id]}/users"
+                   elsif endpoint_options[:organization_id]
+                     "organizations/#{endpoint_options[:organization_id]}/users"
+                   else
+                     'users'
+                   end
         endpoint = "#{endpoint}/#{endpoint_options[:resource_id]}" if endpoint_options[:resource_id]
         endpoint
       end

data/lib/contentful/management/validation.rb

@@ -4,6 +4,9 @@ module Contentful
   module Management
     # A ContentType's validations schema
     class Validation
+      # Properties not specific to a field type validation
+      NON_TYPE_PROPERTIES = %i[validations message].freeze
+
       include Contentful::Management::Resource
 
       property :in, :array
@@ -19,6 +22,8 @@ module Contentful
       property :assetImageDimensions, :hash
       property :enabledNodeTypes, :array
       property :enabledMarks, :array
+      property :nodes, :hash
+      property :message, :string
 
       # @private
       def properties_to_hash
@@ -30,7 +35,7 @@ module Contentful
       # Returns type of validation
       # @return [Symbol]
       def type
-        properties.keys.reject { |key| key == :validations }.each do |type|
+        properties.keys.reject { |key| NON_TYPE_PROPERTIES.include?(key) }.each do |type|
           value = send(Support.snakify(type))
           return type if !value.nil? && value
         end

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '2.9.1'.freeze
+    VERSION = '2.13.0'.freeze
   end
 end

data/spec/fixtures/vcr_cassettes/asset/196_environment_id.yml

@@ -0,0 +1,140 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/facgnwwgj5fe/environments/testing
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/2.10.0; platform ruby/2.6.3; os macOS/18;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/2.2.2
+  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,X-Contentful-Enable-Alpha-Feature,X-Contentful-Source-Environment,X-Contentful-Team,X-Contentful-Parent-Id
+      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
+      Cf-Organization-Id:
+      - 4SsuxQCaMaemfIms52Jr8s
+      Cf-Space-Id:
+      - facgnwwgj5fe
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Contentful-Api:
+      - cma
+      Date:
+      - Wed, 12 Jun 2019 09:50:55 GMT
+      Etag:
+      - W/"b5f8d465c58fdb2d4de7e800b00f1eaa"
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Server:
+      - Contentful
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '36000'
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '35999'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '9'
+      X-Contentful-Request-Id:
+      - 2373953b0bf0c685ba5661a9fe0b5d67
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - ALLOWALL
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '692'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_1077_673446=RtgaHDXP7XMdFb6xI0byDv/KAF0AAAAACSGiFccitmBt23MZnqPWxA==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=7nwaCaO7f3nYLwxVYMlkBAAAAAD3ZpP6TCMI5gIrwYpyuK9W; path=/; Domain=.contentful.com
+      - visid_incap_673446=HtXBvewwRv2t0RzGAoorGv/KAF0AAAAAQUIPAAAAAABa3NNCQ4sPwmHFDGhpUKoq;
+        expires=Thu, 11 Jun 2020 08:51:05 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 4-7987266-7987270 NNNN CT(108 108 0) RT(1560333054770 102) q(0 0 2 -1) r(4
+        4) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |+
+        {
+          "name":"testing 2",
+          "sys":{
+            "type":"Environment",
+            "id":"testing",
+            "version":7,
+            "space":{
+              "sys":{
+                "type":"Link",
+                "linkType":"Space",
+                "id":"facgnwwgj5fe"
+              }
+            },
+            "status":{
+              "sys":{
+                "type":"Link",
+                "linkType":"Status",
+                "id":"ready"
+              }
+            },
+            "createdBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "createdAt":"2018-02-27T10:19:01Z",
+            "updatedBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "updatedAt":"2019-04-02T13:32:30Z"
+          }
+        }
+
+    http_version: 
+  recorded_at: Wed, 12 Jun 2019 09:50:55 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/content_type/196_retain_environment_id.yml

@@ -0,0 +1,150 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/facgnwwgj5fe/environments/testing/content_types/foo
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/2.10.0; platform ruby/2.6.3; os macOS/18;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/2.2.2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      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,X-Contentful-Enable-Alpha-Feature,X-Contentful-Source-Environment,X-Contentful-Team,X-Contentful-Parent-Id
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+      Cf-Environment-Id:
+      - testing
+      Cf-Space-Id:
+      - facgnwwgj5fe
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Contentful-Api:
+      - cma
+      Date:
+      - Wed, 12 Jun 2019 09:53:39 GMT
+      Etag:
+      - '"0b2c5704e213e8a4a0dd2c52b41f69f6"'
+      Server:
+      - Contentful
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '36000'
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '35999'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '9'
+      X-Contentful-Request-Id:
+      - f5fddca25cc4f8e04c8d81881e6e7701
+      Content-Length:
+      - '1291'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_1077_673446=BpbBNbCuYjrQIb6xI0byDqPLAF0AAAAAZh/XsY8rfyTQa65eQDXXQA==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=EDV6F0YIwmCvoc7iYMlkBAAAAACzIXkMlBj6/0YOnyu4iuW5; path=/; Domain=.contentful.com
+      - visid_incap_673446=RDpZ/bR1RpCWIvRJhiD7DaPLAF0AAAAAQUIPAAAAAADdNxoQbzqM+ClPhb8yvpKl;
+        expires=Thu, 11 Jun 2020 08:51:29 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 13-3220957-3220958 NNNN CT(0 0 0) RT(1560333218442 92) q(0 0 0 -1) r(10 10)
+        U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "facgnwwgj5fe"
+              }
+            },
+            "id": "foo",
+            "type": "ContentType",
+            "createdAt": "2017-03-02T19:32:52.225Z",
+            "updatedAt": "2017-03-10T15:38:16.371Z",
+            "environment": {
+              "sys": {
+                "id": "testing",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "publishedVersion": 6,
+            "publishedAt": "2017-03-02T22:41:20.685Z",
+            "firstPublishedAt": "2017-03-02T21:51:34.581Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "publishedCounter": 3,
+            "version": 9,
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            }
+          },
+          "displayField": "name",
+          "name": "foo",
+          "description": "",
+          "fields": [
+            {
+              "id": "name",
+              "name": "name",
+              "type": "Symbol",
+              "localized": false,
+              "required": false,
+              "validations": [],
+              "disabled": false,
+              "omitted": false
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Wed, 12 Jun 2019 09:53:40 GMT
+recorded_with: VCR 4.0.0