contentful-management 0.9.0 → 1.0.0

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

@@ -7,7 +7,7 @@ module Contentful
         # Updates the current version of the object to the version on the system
         def reload
           self_class = self.class
-          resource = self.is_a?(Space) ? self_class.find(id) : self_class.find(space.id, id)
+          resource = self.is_a?(Space) ? self_class.find(client, id) : self_class.find(client, space.id, id)
           refresh_data(resource) if resource.is_a? self_class
         end
 

data/lib/contentful/management/resource_builder.rb

@@ -8,6 +8,8 @@ require_relative 'space'
 require_relative 'content_type'
 require_relative 'asset'
 require_relative 'webhook'
+require_relative 'api_key'
+require_relative 'locale'
 
 module Contentful
   module Management
@@ -23,7 +25,9 @@ module Contentful
         'Asset' => Contentful::Management::Asset,
         'Array' => :array_or_sync_page,
         'Link' => Contentful::Management::Link,
-        'WebhookDefinition' => Contentful::Management::Webhook
+        'WebhookDefinition' => Contentful::Management::Webhook,
+        'ApiKey' => Contentful::Management::ApiKey,
+        'Locale' => Contentful::Management::Locale
       }
       # Default Entry Mapping
       # @see _ README for more information on Entry Mapping
@@ -31,13 +35,13 @@ module Contentful
 
       attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
 
-      def initialize(response, resource_mapping = {}, entry_mapping = {})
+      def initialize(response, client, resource_mapping = {}, entry_mapping = {})
         @response = response
-        @client = Contentful::Management::Client.shared_instance
+        @client = client
         @included_resources = {}
         @known_resources = Hash.new { |hash, key| hash[key] = {} }
         @nested_locales = true
-        @default_locale = (client.configuration || Contentful::Client::DEFAULT_CONFIGURATION)[:default_locale]
+        @default_locale = (client.configuration || Contentful::Management::Client::DEFAULT_CONFIGURATION)[:default_locale]
         @resource_mapping = default_resource_mapping.merge(resource_mapping)
         @entry_mapping = default_entry_mapping.merge(entry_mapping)
       end

data/lib/contentful/management/resource_requester.rb

@@ -0,0 +1,96 @@
+module Contentful
+  module Management
+    # Generic Resource Request Class
+    # @private
+    class ResourceRequester
+      attr_reader :client, :resource_class
+
+      def initialize(client, resource_class)
+        @client = client
+        @resource_class = resource_class
+      end
+
+      def all(endpoint_options = {}, query = {})
+        get(endpoint_options, query)
+      end
+
+      def find(endpoint_options = {})
+        get(endpoint_options)
+      end
+
+      def create(endpoint_options = {}, attributes = {})
+        custom_id = attributes[:id]
+        request = Request.new(
+          client,
+          resource_class.build_endpoint(endpoint_options),
+          resource_class.create_attributes(client, attributes),
+          nil,
+          resource_class.create_headers(client, attributes)
+        )
+        response = custom_id.nil? ? request.post : request.put
+        resource = ResourceBuilder.new(response, client).run
+        resource.after_create(attributes) if resource_class?(resource)
+        resource
+      end
+
+      def update(object, endpoint_options = {}, attributes = {}, headers = {})
+        object.refresh_data(put(endpoint_options, attributes, headers))
+      end
+
+      def destroy(endpoint_options = {})
+        delete(endpoint_options)
+      end
+
+      def archive(object, endpoint_options = {}, headers = {})
+        update(object, endpoint_options, {}, headers)
+      end
+      alias_method :publish, :archive
+
+      def unarchive(object, endpoint_options = {}, headers = {})
+        object.refresh_data(delete(endpoint_options, {}, headers))
+      end
+      alias_method :unpublish, :unarchive
+
+      private
+
+      def resource_class?(object)
+        object.resource?
+      rescue
+        false
+      end
+
+      def get(endpoint_options = {}, query = {})
+        request = Request.new(
+          client,
+          resource_class.build_endpoint(endpoint_options),
+          query
+        )
+        ResourceBuilder.new(request.get, client).run
+      end
+
+      def put(endpoint_options = {}, attributes = {}, headers = {})
+        request = Request.new(
+          client,
+          resource_class.build_endpoint(endpoint_options),
+          attributes,
+          nil,
+          headers
+        )
+        ResourceBuilder.new(request.put, client).run
+      end
+
+      def delete(endpoint_options = {}, attributes = {}, headers = {})
+        request = Request.new(
+          client,
+          resource_class.build_endpoint(endpoint_options),
+          attributes,
+          nil,
+          headers
+        )
+        response = request.delete
+        return true if response.status == :no_content
+        ResourceBuilder.new(response, client).run
+      end
+    end
+  end
+end

data/lib/contentful/management/space.rb

@@ -27,52 +27,58 @@ module Contentful
 
       attr_accessor :found_locale
 
-      # Gets a collection of spaces.
+      # @private
+      def self.build_endpoint(endpoint_options)
+        return "/#{endpoint_options[:space_id]}" if endpoint_options.key?(:space_id)
+        ''
+      end
+
+      # Gets all Spaces
+      #
+      # @param [Contentful::Management::Client] client
+      #
       # @return [Contentful::Management::Array<Contentful::Management::Space>]
-      def self.all
-        request = Request.new('')
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        spaces = result.run
-        client.update_dynamic_entry_cache_for_spaces!(spaces)
-        spaces
+      def self.all(client)
+        ClientSpaceMethodsFactory.new(client).all
       end
 
       # Gets a specific space.
       #
+      # @param [Contentful::Management::Client] client
       # @param [String] space_id
       #
       # @return [Contentful::Management::Space]
-      def self.find(space_id)
-        request = Request.new("/#{space_id}")
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        space = result.run
-        client.update_dynamic_entry_cache_for_space!(space) if space.is_a? Space
-        space
+      def self.find(client, space_id)
+        ClientSpaceMethodsFactory.new(client).find(space_id)
+      end
+
+      # @private
+      def self.create_attributes(client, attributes)
+        default_locale = attributes[:default_locale] || client.default_locale
+        { 'name' => attributes.fetch(:name), defaultLocale: default_locale }
+      end
+
+      # @private
+      def self.create_headers(_client, attributes)
+        { organization_id: attributes[:organization_id] }
+      end
+
+      # @private
+      def after_create(attributes)
+        self.found_locale = attributes[:default_locale] || client.default_locale
       end
 
       # Create a space.
       #
+      # @param [Contentful::Management::Client] client
       # @param [Hash] attributes
       # @option attributes [String] :name
       # @option attributes [String] :default_locale
       # @option attributes [String] :organization_id Required if user has more than one organization
       #
       # @return [Contentful::Management::Space]
-      def self.create(attributes)
-        default_locale = attributes[:default_locale] || client.default_locale
-        request = Request.new(
-          '',
-          { 'name' => attributes.fetch(:name), defaultLocale: default_locale },
-          nil,
-          organization_id: attributes[:organization_id]
-        )
-        response = request.post
-        result = ResourceBuilder.new(response, {}, {})
-        space = result.run
-        space.found_locale = default_locale if space.is_a? Space
-        space
+      def self.create(client, attributes)
+        ResourceRequester.new(client, self).create({}, attributes)
       end
 
       # Updates a space.
@@ -83,16 +89,13 @@ module Contentful
       #
       # @return [Contentful::Management::Space]
       def update(attributes)
-        request = Request.new(
-          "/#{id}",
+        ResourceRequester.new(client, self.class).update(
+          self,
+          { space_id: id },
           { 'name' => attributes.fetch(:name) },
-          nil,
           version: sys[:version],
           organization_id: attributes[:organization_id]
         )
-        response = request.put
-        result = ResourceBuilder.new(response, {}, {})
-        refresh_data(result.run)
       end
 
       # If a space is new, an object gets created in the Contentful, otherwise the existing space gets updated.
@@ -103,7 +106,7 @@ module Contentful
         if id
           update(name: name, organization_id: organization)
         else
-          new_instance = self.class.create(name: name, organization_id: organization)
+          new_instance = self.class.create(client, name: name, organization_id: organization)
           refresh_data(new_instance)
         end
       end
@@ -112,13 +115,7 @@ module Contentful
       #
       # @return [true, Contentful::Management::Error] success
       def destroy
-        request = Request.new("/#{id}")
-        response = request.delete
-        if response.status == :no_content
-          true
-        else
-          ResourceBuilder.new(response, {}, {}).run
-        end
+        ResourceRequester.new(client, self.class).destroy(space_id: id)
       end
 
       # Allows manipulation of content types in context of the current space
@@ -187,7 +184,7 @@ module Contentful
       #
       # @return [String]
       def find_locale
-        locale = ::Contentful::Management::Locale.all(id).detect(&:default)
+        locale = locales.all.detect(&:default)
         return locale.code unless locale.nil?
         @default_locale
       end

data/lib/contentful/management/space_association_all_published_method_factory.rb

@@ -4,7 +4,7 @@ module Contentful
     # @private
     module SpaceAssociationAllPublishedMethodsFactory
       def all_published(params = {})
-        associated_class.all_published(space.id, params)
+        associated_class.all_published(space.client, space.id, params)
       end
     end
   end

data/lib/contentful/management/space_association_methods_factory.rb

@@ -1,3 +1,5 @@
+require_relative 'resource_requester'
+
 module Contentful
   module Management
     # Wrapper for Space Association Methods
@@ -10,20 +12,21 @@ module Contentful
       end
 
       def all(params = {})
-        associated_class.all(space.id, params)
+        associated_class.all(space.client, space.id, params)
       end
 
       def find(id)
-        associated_class.find(space.id, id)
+        associated_class.find(space.client, space.id, id)
       end
 
       def create(attributes)
-        associated_class.create(space.id, attributes)
+        associated_class.create(space.client, space.id, attributes)
       end
 
       def new
         object = associated_class.new
         object.sys[:space] = space
+        object.client = space.client
         object
       end
 

data/lib/contentful/management/space_entry_methods_factory.rb

@@ -3,7 +3,7 @@ require_relative 'space_association_all_published_method_factory'
 
 module Contentful
   module Management
-    # Wrapper for ContentType API for usage from within Space
+    # Wrapper for Entry API for usage from within Space
     # @private
     class SpaceEntryMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '0.9.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/contentful/management/webhook.rb

@@ -12,93 +12,20 @@ module Contentful
       property :url, :string
       property :httpBasicUsername, :string
 
-      # Gets a collection of webhooks.
-      #
-      # @param [String] space_id
-      # @param [Hash] parameters
-      # @option parameters [String] 'sys.id'
-      # @option parameters [String] :url
-      #
-      # @return [Contentful::Management::Array<Contentful::Management::Webhook>]
-      def self.all(space_id, parameters = {})
-        request = Request.new(
-          "/#{space_id}/webhook_definitions",
-          parameters
-        )
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        result.run
-      end
-
-      # Gets a specific webhook.
-      #
-      # @param [String] space_id
-      # @param [String] webhook_id
-      #
-      # @return [Contentful::Management::Webhook]
-      def self.find(space_id, webhook_id)
-        request = Request.new("/#{space_id}/webhook_definitions/#{webhook_id}")
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        result.run
-      end
-
-      # Creates a webhook.
-      #
-      # @param [String] space_id
-      # @param [Hash] attributes
-      # @option attributes [String] :url
-      # @option attributes [String] :httpBasicUsername
-      # @option attributes [String] :httpBasicPassword
-      #
-      # @return [Contentful::Management::Webhook]
-      def self.create(space_id, attributes)
-        id = attributes[:id]
-        request = Request.new(
-          "/#{space_id}/webhook_definitions/#{id}",
-          endpoint_parameters(attributes)
-        )
-        response = id.nil? ? request.post : request.put
-        ResourceBuilder.new(response, {}, {}).run
+      # @private
+      def self.endpoint
+        'webhook_definitions'
       end
 
-      # Updates a webhook.
-      #
-      # @param [Hash] attributes
-      # @option attributes [String] :url
-      # @option attributes [String] :httpBasicUsername
-      # @option attributes [String] :httpBasicPassword
-      #
-      # @return [Contentful::Management::Webhook]
-      def update(attributes)
-        request = Request.new(
-          "/#{space.id}/webhook_definitions/#{id}",
-          self.class.endpoint_parameters(attributes),
-          nil,
-          version: sys[:version]
-        )
-        response = request.put
-        result = ResourceBuilder.new(response, {}, {})
-        refresh_data(result.run)
+      # @private
+      def self.create_attributes(_client, attributes)
+        attributes.select { |key, _value| [:httpBasicUsername, :httpBasicPassword, :url].include? key }
       end
 
-      # Destroys an webhook.
-      #
-      # @return [true, Contentful::Management::Error] success
-      def destroy
-        request = Request.new("/#{space.id}/webhook_definitions/#{id}")
-        response = request.delete
-        if response.status == :no_content
-          true
-        else
-          result = ResourceBuilder.new(response, {}, {})
-          result.run
-        end
-      end
+      protected
 
-      # @private
-      def self.endpoint_parameters(attributes)
-        attributes.select { |key, _value| [:httpBasicUsername, :httpBasicPassword, :url].include? key }
+      def query_attributes(attributes)
+        self.class.create_attributes(nil, attributes)
       end
     end
   end

data/spec/fixtures/vcr_cassettes/asset/create.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/assets/
+    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/assets
     body:
       encoding: UTF-8
       string: '{"fields":{"title":{"en-US":"titlebyCreateAPI"},"description":{"en-US":"descByAPI"},"file":{"en-US":{"contentType":"image/jpeg","fileName":"pic1.jpg","upload":"https://upload.wikimedia.org/wikipedia/commons/c/c7/Gasometer_Berlin_Sch%C3%B6neberg_2011.jpg"}}}}'