contentful-management 0.8.0 → 0.9.0

data/lib/contentful/management/space_api_key_methods_factory.rb

@@ -0,0 +1,15 @@
+require_relative 'space_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for ApiKey API for usage from within Space
+    # @private
+    class SpaceApiKeyMethodsFactory
+      include Contentful::Management::SpaceAssociationMethodsFactory
+
+      def new
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/space_asset_methods_factory.rb

@@ -1,9 +1,13 @@
 require_relative 'space_association_methods_factory'
+require_relative 'space_association_all_published_method_factory'
 
 module Contentful
   module Management
+    # Wrapper for Asset API for usage from within Space
+    # @private
     class SpaceAssetMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory
+      include Contentful::Management::SpaceAssociationAllPublishedMethodsFactory
     end
   end
 end

data/lib/contentful/management/space_association_all_published_method_factory.rb

@@ -0,0 +1,11 @@
+module Contentful
+  module Management
+    # Wrapper for /public API for usage from within Space Wrapper Classes
+    # @private
+    module SpaceAssociationAllPublishedMethodsFactory
+      def all_published(params = {})
+        associated_class.all_published(space.id, params)
+      end
+    end
+  end
+end

data/lib/contentful/management/space_association_methods_factory.rb

@@ -1,5 +1,7 @@
 module Contentful
   module Management
+    # Wrapper for Space Association Methods
+    # @private
     module SpaceAssociationMethodsFactory
       attr_reader :space
 
@@ -27,8 +29,8 @@ module Contentful
 
       def associated_class
         class_name = /\A(.+)Space(.+)MethodsFactory\z/.match(self.class.name).captures.join
-        class_name.split('::').reduce(Object) do |mod, class_name|
-          mod.const_get(class_name)
+        class_name.split('::').reduce(Object) do |mod, actual_class_name|
+          mod.const_get(actual_class_name)
         end
       end
     end

data/lib/contentful/management/space_content_type_methods_factory.rb

@@ -1,9 +1,13 @@
 require_relative 'space_association_methods_factory'
+require_relative 'space_association_all_published_method_factory'
 
 module Contentful
   module Management
+    # Wrapper for ContentType API for usage from within Space
+    # @private
     class SpaceContentTypeMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory
+      include Contentful::Management::SpaceAssociationAllPublishedMethodsFactory
     end
   end
 end

data/lib/contentful/management/space_entry_methods_factory.rb

@@ -1,9 +1,13 @@
 require_relative 'space_association_methods_factory'
+require_relative 'space_association_all_published_method_factory'
 
 module Contentful
   module Management
+    # Wrapper for ContentType API for usage from within Space
+    # @private
     class SpaceEntryMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory
+      include Contentful::Management::SpaceAssociationAllPublishedMethodsFactory
 
       def create(_attributes)
         fail 'Not supported'

data/lib/contentful/management/space_locale_methods_factory.rb

@@ -2,6 +2,8 @@ require_relative 'space_association_methods_factory'
 
 module Contentful
   module Management
+    # Wrapper for Locale API for usage from within Space
+    # @private
     class SpaceLocaleMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory
 

data/lib/contentful/management/space_webhook_methods_factory.rb

@@ -2,6 +2,8 @@ require_relative 'space_association_methods_factory'
 
 module Contentful
   module Management
+    # Wrapper for Webhook API for usage from within Space
+    # @private
     class SpaceWebhookMethodsFactory
       include Contentful::Management::SpaceAssociationMethodsFactory
 

data/lib/contentful/management/validation.rb

@@ -15,6 +15,7 @@ module Contentful
       property :linkMimetypeGroup, :string
       property :linkField, :boolean
 
+      # @private
       def properties_to_hash
         properties.each_with_object({}) do |(key, value), results|
           results[key] = value if Field.value_exists?(value)
@@ -22,13 +23,13 @@ module Contentful
       end
 
       # Returns type of validation
+      # @return [Symbol]
       def type
         properties.keys.reject { |key| key == :validations }.each do |type|
-          value = self.send(Support.snakify(type))
+          value = send(Support.snakify(type))
           return type if !value.nil? && value
         end
       end
-
     end
   end
 end

data/lib/contentful/management/version.rb

@@ -1,5 +1,8 @@
+# Contentful Namespace
 module Contentful
+  # Management Namespace
   module Management
-    VERSION = '0.8.0'
+    # Gem Version
+    VERSION = '0.9.0'
   end
 end

data/lib/contentful/management/webhook.rb

@@ -3,7 +3,7 @@ require_relative 'resource'
 module Contentful
   module Management
     # Resource class for Webhook.
-    # https://www.contentful.com/developers/documentation/content-management-api/http/#resources-webhooks
+    # @see _ https://www.contentful.com/developers/documentation/content-management-api/http/#resources-webhooks
     class Webhook
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
@@ -13,12 +13,17 @@ module Contentful
       property :httpBasicUsername, :string
 
       # Gets a collection of webhooks.
-      # Takes an id of space and hash of parameters.
-      # Returns a Contentful::Management::Array of Contentful::Management::Webhook.
+      #
+      # @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
+          "/#{space_id}/webhook_definitions",
+          parameters
         )
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
@@ -26,37 +31,51 @@ module Contentful
       end
 
       # Gets a specific webhook.
-      # Takes an id of space and webhook.
-      # Returns a Contentful::Management::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 }")
+        request = Request.new("/#{space_id}/webhook_definitions/#{webhook_id}")
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
       # Creates a webhook.
-      # Takes a space id and hash with attributes (url, httpBasicUsername, httpBasicPassword)
-      # Returns a Contentful::Management::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)
+          "/#{space_id}/webhook_definitions/#{id}",
+          endpoint_parameters(attributes)
         )
         response = id.nil? ? request.post : request.put
         ResourceBuilder.new(response, {}, {}).run
       end
 
       # Updates a webhook.
-      # Takes a hash with attributes.
-      # Returns a Contentful::Management::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),
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/webhook_definitions/#{id}",
+          self.class.endpoint_parameters(attributes),
+          nil,
+          version: sys[:version]
         )
         response = request.put
         result = ResourceBuilder.new(response, {}, {})
@@ -64,18 +83,20 @@ module Contentful
       end
 
       # Destroys an webhook.
-      # Returns true if succeed.
+      #
+      # @return [true, Contentful::Management::Error] success
       def destroy
-        request = Request.new("/#{ space.id }/webhook_definitions/#{ id }")
+        request = Request.new("/#{space.id}/webhook_definitions/#{id}")
         response = request.delete
         if response.status == :no_content
-          return true
+          true
         else
           result = ResourceBuilder.new(response, {}, {})
           result.run
         end
       end
 
+      # @private
       def self.endpoint_parameters(attributes)
         attributes.select { |key, _value| [:httpBasicUsername, :httpBasicPassword, :url].include? key }
       end

data/spec/fixtures/vcr_cassettes/api_key/all_for_space.yml

@@ -0,0 +1,194 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/bjwq7b86vgmm/api_keys
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulManagementGem/0.8.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '0'
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+  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
+      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
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Tue, 26 Jan 2016 13:11:06 GMT
+      Etag:
+      - '"bf2ed3f9a14d5d32893e02c307f6214d"'
+      Server:
+      - nginx
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - 9e1-668687247
+      Content-Length:
+      - '2871'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: |+
+        {
+          "sys":{
+            "type":"Array"
+          },
+          "items":[
+            {
+              "sys":{
+                "type":"ApiKey",
+                "id":"6vbW35TjBTc8FyRTAuXZZe",
+                "version":0,
+                "space":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Space",
+                    "id":"bjwq7b86vgmm"
+                  }
+                },
+                "createdBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "createdAt":"2016-01-26T02:31:31Z",
+                "updatedBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "updatedAt":"2016-01-26T02:31:31Z"
+              },
+              "name":"testKey",
+              "description":null,
+              "accessToken":"833ea085204398499ea424c8ad832f1ae1cac4d64e2cc56db774aff87ef20b33",
+              "policies":[
+                {
+                  "effect":"allow",
+                  "actions":"all"
+                }
+              ]
+            },
+            {
+              "sys":{
+                "type":"ApiKey",
+                "id":"1hGMMHcRIRDQuZFQvANxny",
+                "version":0,
+                "space":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Space",
+                    "id":"bjwq7b86vgmm"
+                  }
+                },
+                "createdBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "createdAt":"2016-01-26T12:49:30Z",
+                "updatedBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "updatedAt":"2016-01-26T12:49:30Z"
+              },
+              "name":"otherKey",
+              "description":null,
+              "accessToken":"163ce7aaa3d87d9cbc25fd846d2bd7d70c3a707a5e9ebd7adfcb3bc773a51fd3",
+              "policies":[
+                {
+                  "effect":"allow",
+                  "actions":"all"
+                }
+              ]
+            },
+            {
+              "sys":{
+                "type":"ApiKey",
+                "id":"1nlVhF1rbb6iLWCdm72QVi",
+                "version":0,
+                "space":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Space",
+                    "id":"bjwq7b86vgmm"
+                  }
+                },
+                "createdBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "createdAt":"2016-01-26T13:11:03Z",
+                "updatedBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "updatedAt":"2016-01-26T13:11:03Z"
+              },
+              "name":"testLocalCreate",
+              "description":"bg",
+              "accessToken":"b8d6f1bfac699f3eeceb9ee61711d9e1011e7fcbaf6836961e706c3cd49d7751",
+              "policies":[
+                {
+                  "effect":"allow",
+                  "actions":"all"
+                }
+              ]
+            }
+          ],
+          "total":3,
+          "limit":25,
+          "skip":0
+        }
+
+    http_version: 
+  recorded_at: Tue, 26 Jan 2016 13:11:06 GMT
+recorded_with: VCR 2.9.3