contentful-management 1.8.1 → 1.9.0

data/contentful-management.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'guard-yard'
   spec.add_development_dependency 'rubocop', '~> 0.41.0'
-  spec.add_development_dependency 'listen', '3.0.0'
+  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 'simplecov'

data/lib/contentful/management/asset.rb

@@ -53,7 +53,7 @@ module Contentful
         instance_variable_get(:@fields).keys.each do |locale|
           request = Request.new(
             client,
-            "/#{space.id}/assets/#{id}/files/#{locale}/process",
+            "spaces/#{space.id}/assets/#{id}/files/#{locale}/process",
             {},
             nil,
             version: sys[:version]

data/lib/contentful/management/client.rb

@@ -3,17 +3,23 @@ require 'contentful/management/response'
 require 'contentful/management/resource_builder'
 
 require 'contentful/management/version'
-require 'contentful/management/http_client'
 
 require 'contentful/management/client_space_methods_factory'
+require 'contentful/management/client_space_membership_methods_factory'
+require 'contentful/management/client_organization_methods_factory'
+require 'contentful/management/client_user_methods_factory'
 require 'contentful/management/client_api_key_methods_factory'
+require 'contentful/management/client_personal_access_tokens_methods_factory'
 require 'contentful/management/client_asset_methods_factory'
 require 'contentful/management/client_content_type_methods_factory'
 require 'contentful/management/client_entry_methods_factory'
 require 'contentful/management/client_locale_methods_factory'
 require 'contentful/management/client_role_methods_factory'
+require 'contentful/management/client_ui_extension_methods_factory'
 require 'contentful/management/client_editor_interface_methods_factory'
 require 'contentful/management/client_webhook_methods_factory'
+require 'contentful/management/client_webhook_call_methods_factory'
+require 'contentful/management/client_webhook_health_methods_factory'
 require 'contentful/management/client_upload_methods_factory'
 require 'contentful/management/client_snapshot_methods_factory'
 
@@ -28,10 +34,8 @@ module Contentful
     # Client for interacting with the Contentful Management API
     # @see _ https://www.contentful.com/developers/docs/references/content-management-api/
     class Client
-      extend Contentful::Management::HTTPClient
-
       attr_reader :access_token, :configuration, :logger
-      attr_accessor :organization_id, :version, :zero_length, :content_type_id, :dynamic_entry_cache
+      attr_accessor :organization_id, :version, :content_type_id, :dynamic_entry_cache
 
       # Default configuration for Contentful::Management::Client
       DEFAULT_CONFIGURATION = {
@@ -45,6 +49,7 @@ module Contentful
         log_level: Logger::INFO,
         raise_errors: false,
         dynamic_entries: [],
+        disable_content_type_caching: false,
         proxy_host: nil,
         proxy_port: nil,
         proxy_username: nil,
@@ -70,6 +75,7 @@ module Contentful
       # @option configuration [::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR] :log_level
       # @option configuration [Boolean] :raise_errors
       # @option configuration [::Array<String>] :dynamic_entries
+      # @option configuration [Boolean] :disable_content_type_caching
       # @option configuration [String] :proxy_host
       # @option configuration [Fixnum] :proxy_port
       # @option configuration [String] :proxy_username
@@ -88,7 +94,7 @@ module Contentful
       end
 
       # Allows manipulation of spaces in context of the current client
-      # Allows listing all spaces for client and finding one by id.
+      # Allows listing all spaces for client and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientSpaceMethodsFactory]
@@ -96,8 +102,35 @@ module Contentful
         ClientSpaceMethodsFactory.new(self)
       end
 
+      # Allows manipulation of space memberships in context of the current client
+      # Allows listing all space memberships for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientSpaceMembershipMethodsFactory]
+      def space_memberships
+        ClientSpaceMembershipMethodsFactory.new(self)
+      end
+
+      # Allows viewing of organizations in context of the current client
+      # Allows listing all organizations for client.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientOrganizationMethodsFactory]
+      def organizations
+        ClientOrganizationMethodsFactory.new(self)
+      end
+
+      # Allows viewing of users in context of the current client
+      # Allows listing all users for client.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientUserMethodsFactory]
+      def users
+        ClientUserMethodsFactory.new(self)
+      end
+
       # Allows manipulation of api keys in context of the current client
-      # Allows listing all api keys for client, creating new and finding one by id.
+      # Allows listing all api keys for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientApiKeyMethodsFactory]
@@ -105,8 +138,17 @@ module Contentful
         ClientApiKeyMethodsFactory.new(self)
       end
 
+      # Allows manipulation of personal access tokens in context of the current client
+      # Allows listing all personal access tokens for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientPersonalAccessTokenMethodsFactory]
+      def personal_access_tokens
+        ClientPersonalAccessTokenMethodsFactory.new(self)
+      end
+
       # Allows manipulation of assets in context of the current client
-      # Allows listing all assets for client, creating new and finding one by id.
+      # Allows listing all assets for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientAssetMethodsFactory]
@@ -115,7 +157,7 @@ module Contentful
       end
 
       # Allows manipulation of content types in context of the current client
-      # Allows listing all content types for client, creating new and finding one by id.
+      # Allows listing all content types for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientContentTypeMethodsFactory]
@@ -124,7 +166,7 @@ module Contentful
       end
 
       # Allows manipulation of entries in context of the current client
-      # Allows listing all entries for client, creating new and finding one by id.
+      # Allows listing all entries for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientEntryMethodsFactory]
@@ -133,7 +175,7 @@ module Contentful
       end
 
       # Allows manipulation of locales in context of the current client
-      # Allows listing all locales for client, creating new and finding one by id.
+      # Allows listing all locales for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientLocaleMethodsFactory]
@@ -142,7 +184,7 @@ module Contentful
       end
 
       # Allows manipulation of roles in context of the current client
-      # Allows listing all roles for client, creating new and finding one by id.
+      # Allows listing all roles for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientRoleMethodsFactory]
@@ -150,8 +192,17 @@ module Contentful
         ClientRoleMethodsFactory.new(self)
       end
 
+      # Allows manipulation of UI extensions in context of the current client
+      # Allows listing all UI extensions for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientUIExtensionMethodsFactory]
+      def ui_extensions
+        ClientUIExtensionMethodsFactory.new(self)
+      end
+
       # Allows manipulation of editor interfaces in context of the current client
-      # Allows listing all editor interfaces for client, creating new and finding one by id.
+      # Allows listing all editor interfaces for client and finding one by content type.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientEditorInterfaceMethodsFactory]
@@ -160,7 +211,7 @@ module Contentful
       end
 
       # Allows manipulation of webhooks in context of the current client
-      # Allows listing all webhooks for client, creating new and finding one by id.
+      # Allows listing all webhooks for client, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientWebhookMethodsFactory]
@@ -168,8 +219,26 @@ module Contentful
         ClientWebhookMethodsFactory.new(self)
       end
 
+      # Allows manipulation of webhook calls in context of the current client
+      # Allows listing all webhook call details for client and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientWebhookCallMethodsFactory]
+      def webhook_calls
+        ClientWebhookCallMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of webhook health in context of the current client
+      # Allows listing all webhook health details for client and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientWebhookHealthMethodsFactory]
+      def webhook_health
+        ClientWebhookHealthMethodsFactory.new(self)
+      end
+
       # Allows manipulation of uploads in context of the current client
-      # Allows creating new and finding uploads by id.
+      # Allows creating new and finding uploads by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientUploadMethodsFactory]
@@ -178,12 +247,30 @@ module Contentful
       end
 
       # Allows manipulation of snapshots in context of the current client
-      # Allows listing all webhooks for client, creating new and finding one by id.
+      # Allows listing all snapshots for client and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientSnapshotMethodsFactory]
+      def snapshots(resource_type = 'entries')
+        ClientSnapshotMethodsFactory.new(self, resource_type)
+      end
+
+      # Allows manipulation of entry snapshots in context of the current client
+      # Allows listing all entry snapshots for client and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientSnapshotMethodsFactory]
+      def entry_snapshots
+        ClientSnapshotMethodsFactory.new(self, 'entries')
+      end
+
+      # Allows manipulation of content type snapshots in context of the current client
+      # Allows listing all content type snapshots for client and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::ClientSnapshotMethodsFactory]
-      def snapshots
-        ClientSnapshotMethodsFactory.new(self)
+      def content_type_snapshots
+        ClientSnapshotMethodsFactory.new(self, 'content_types')
       end
 
       # @private
@@ -194,7 +281,7 @@ module Contentful
 
       # @private
       def update_all_dynamic_entry_cache!
-        return if configuration[:dynamic_entries].empty?
+        return if configuration[:dynamic_entries].empty? || configuration[:disable_content_type_caching]
 
         spaces = configuration[:dynamic_entries].map { |space_id| ::Contentful::Management::Space.find(self, space_id) }
         update_dynamic_entry_cache_for_spaces!(spaces)
@@ -202,6 +289,8 @@ module Contentful
 
       # @private
       def update_dynamic_entry_cache_for_spaces!(spaces)
+        return if configuration[:disable_content_type_caching]
+
         spaces.each do |space|
           update_dynamic_entry_cache_for_space!(space)
         end
@@ -211,6 +300,8 @@ module Contentful
       # See README for details.
       # @private
       def update_dynamic_entry_cache_for_space!(space)
+        return if configuration[:disable_content_type_caching]
+
         update_dynamic_entry_cache!(space.content_types.all)
       end
 
@@ -271,7 +362,7 @@ module Contentful
 
       # @private
       def host_url(request)
-        (%r{^/[\w|-]+/uploads(?:/[\w|-]*)?$} =~ request.url) ? uploads_url : base_url
+        (%r{^spaces/[\w|-|_]+/uploads(?:/[\w|-|_]*)?$} =~ request.url) ? uploads_url : base_url
       end
 
       # @private
@@ -298,39 +389,78 @@ module Contentful
       # @private
       def delete(request)
         execute_request(request) do |url|
-          self.class.delete_http(url, {}, request_headers(request), proxy_parameters)
+          http_send(:delete, url, { params: request.query }, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def get(request)
         execute_request(request) do |url|
-          self.class.get_http(url, request.query, request_headers(request), proxy_parameters)
+          http_send(:get, url, { params: request.query }, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def post(request)
         execute_request(request) do |url|
-          self.class.post_http(url, request.query, request_headers(request), proxy_parameters)
+          data = if url.include?(Client::DEFAULT_CONFIGURATION[:uploads_url])
+                   { body: request.query }
+                 else
+                   { json: request.query }
+                 end
+
+          http_send(:post, url, data, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def put(request)
         execute_request(request) do |url|
-          self.class.put_http(url, request.query, request_headers(request), proxy_parameters)
+          http_send(:put, url, { json: request.query }, request_headers(request), proxy_parameters)
         end
       end
 
+      # Proxy Helper
+      #
+      # @param [Symbol] type
+      # @param [String] url
+      # @param [Hash] params
+      # @param [Hash] headers
+      # @param [Hash] proxy
+      #
+      # @return [HTTP::Response]
+      def proxy_send(type, url, params, headers, proxy)
+        HTTP[headers].via(
+          proxy[:host],
+          proxy[:port],
+          proxy[:username],
+          proxy[:password]
+        ).public_send(type, url, params)
+      end
+
+      # HTTP Helper
+      # Abtracts the Proxy/No-Proxy logic
+      #
+      # @param [Symbol] type
+      # @param [String] url
+      # @param [Hash] params
+      # @param [Hash] headers
+      # @param [Hash] proxy
+      #
+      # @return [HTTP::Response]
+      def http_send(type, url, params, headers, proxy)
+        return proxy_send(type, url, params, headers, proxy) unless proxy[:host].nil?
+        HTTP[headers].public_send(type, url, params)
+      end
+
       # @private
       def base_url
-        "#{protocol}://#{configuration[:api_url]}/spaces"
+        "#{protocol}://#{configuration[:api_url]}/"
       end
 
       # @private
       def uploads_url
-        "#{protocol}://#{configuration[:uploads_url]}/spaces"
+        "#{protocol}://#{configuration[:uploads_url]}/"
       end
 
       # @private
@@ -436,11 +566,6 @@ module Contentful
         Hash['X-Contentful-Content-Type', content_type_id]
       end
 
-      # @private
-      def zero_length_header
-        Hash['Content-Length', 0]
-      end
-
       # @private
       def accept_encoding_header(encoding)
         Hash['Accept-Encoding', encoding]
@@ -455,7 +580,6 @@ module Contentful
         headers.merge! api_version_header
         headers.merge! organization_header(organization_id) if organization_id
         headers.merge! version_header(version) if version
-        headers.merge! zero_length_header if zero_length
         headers.merge! content_type_header(content_type_id) if content_type_id
         headers.merge! accept_encoding_header('gzip') if gzip_encoded
 

data/lib/contentful/management/client_organization_methods_factory.rb

@@ -0,0 +1,23 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Organizations API for usage from within Client
+    # @private
+    class ClientOrganizationMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def new(*)
+        fail 'Not supported'
+      end
+
+      def find(*)
+        fail 'Not supported'
+      end
+
+      def all(*)
+        super(nil)
+      end
+    end
+  end
+end

data/lib/contentful/management/client_personal_access_tokens_methods_factory.rb

@@ -0,0 +1,27 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Personal Access Token API for usage from within Client
+    # @private
+    class ClientPersonalAccessTokenMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def new(*)
+        fail 'Not supported'
+      end
+
+      def all(params = {})
+        super(nil, params)
+      end
+
+      def find(personal_access_token_id)
+        super(nil, personal_access_token_id)
+      end
+
+      def create(attributes)
+        super(nil, attributes)
+      end
+    end
+  end
+end

data/lib/contentful/management/client_snapshot_methods_factory.rb

@@ -7,21 +7,31 @@ module Contentful
     class ClientSnapshotMethodsFactory
       include Contentful::Management::ClientAssociationMethodsFactory
 
+      def initialize(client, resource_type)
+        super(client)
+        @resource_type = resource_type
+      end
+
       def create(*)
         fail 'Not supported'
       end
 
-      def all(space_id, entry_id, _params = {})
-        @resource_requester.find(
-          space_id: space_id,
-          entry_id: entry_id
+      def all(space_id, resource_id, params = {})
+        @resource_requester.all(
+          {
+            resource_type: @resource_type,
+            space_id: space_id,
+            resource_id: resource_id
+          },
+          params
         )
       end
 
-      def find(space_id, entry_id, snapshot_id)
+      def find(space_id, resource_id, snapshot_id)
         @resource_requester.find(
+          resource_type: @resource_type,
           space_id: space_id,
-          entry_id: entry_id,
+          resource_id: resource_id,
           snapshot_id: snapshot_id
         )
       end