contentful-management 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf0ce9eb8d18998ab777ab796c1fb0222cb8c8092fd55734e3c7c2031641d47
-  data.tar.gz: ff63153a45ca73048e2bd563a7641dc5dc7e31a4877e4873e418efeabf5e185c
+  metadata.gz: 9d409c0f6953c66a83065653247a19280d9848da412373fc37191da95b540e25
+  data.tar.gz: 3e7895c80b94270ab99d74add2587178fa38ff3bf159081e835ea1e86f6214d0
 SHA512:
-  metadata.gz: aa3b3a247c2ac6a168489665124f1875dfb48aed89799ae66f9074415b4cbbbf706c35cf5d4312f0507eb0afff739bfe5c92212c1123756a296bf185b152168c
-  data.tar.gz: 339fecccc7901697cdc4c89ed67110af4308777156544b800ac1bed1150a8b9615e48c30a788b3a6337f15d9e955ff8eca283eb12ab4f0270bcda9b87ed76e81
+  metadata.gz: c65231651b08dfb2d03ba1a1dde4aa9e88e4e25e1fc712fad4eb227190c9988db5a6f1684df08528bf8734aa79278ddf5ad60c4ae10942428840d0f16d5c2989
+  data.tar.gz: e4b1c3cb65528ce774be67764b8a09850d03597317c9c4ffd93e80dfc4006303c2d5ab1dcf4f4c64312b2147ddd40f80d90d1b16e20af57b5a9e3d7746de89d0

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Master
 
+## Master
+### 2.3.0
+* Added `transformation` and `filters` to `Webhook`.
+* Added `parameters` to `UIExtension.extension`.
+
+### Fixed
+* `#reload` now works with `Environment` objects.
+* Fixed URL generation for `/users` endpoint.
+* Fixed Space Memberships now properly forward all attributes.
+
+### Changed
+* Simplified asset creation process - this change doesn't affect functionality, but removes a couple of steps and provides equivalent functionality.
+
 ## 2.2.2
 ### Fixed
 * Fixed URL generation for `/organizations` endpoint.

data/lib/contentful/management/asset.rb

@@ -32,14 +32,13 @@ module Contentful
 
       # @private
       def self.create_attributes(client, attributes)
-        asset = new
-        asset.instance_variable_set(:@fields, attributes[:fields] || {})
-        asset.locale = attributes[:locale] || client.default_locale
-        asset.title = attributes[:title] if attributes[:title]
-        asset.description = attributes[:description] if attributes[:description]
-        asset.file = attributes[:file] if attributes[:file]
-
-        { fields: asset.fields_for_query }
+        fields = attributes[:fields] || {}
+        locale = attributes[:locale] || client.default_locale
+        fields[:title] = { locale => attributes[:title] } if attributes[:title]
+        fields[:description] = { locale => attributes[:description] } if attributes[:description]
+        fields[:file] = { locale => attributes[:file].properties } if attributes[:file]
+
+        { fields: fields }
       end
 
       # @private

data/lib/contentful/management/client_space_membership_methods_factory.rb

@@ -10,6 +10,14 @@ module Contentful
       def new(*)
         fail 'Not supported'
       end
+
+      def find(resource_id)
+        associated_class.find(client, @space_id, resource_id)
+      end
+
+      def create(attributes)
+        associated_class.create(client, @space_id, attributes)
+      end
     end
   end
 end

data/lib/contentful/management/environment.rb

@@ -133,6 +133,11 @@ module Contentful
         return locale.code unless locale.nil?
         @default_locale
       end
+
+      # @private
+      def refresh_find
+        self.class.find(client, space.id, id)
+      end
     end
   end
 end

data/lib/contentful/management/space_membership.rb

@@ -31,6 +31,29 @@ module Contentful
         }
       end
 
+      # Creates an Space Membership
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [Hash] attributes
+      # @see _ README for full attribute list for each resource.
+      #
+      # @return [Contentful::Management::SpaceMembership]
+      def self.create(client, space_id, attributes = {})
+        super(client, space_id, nil, attributes)
+      end
+
+      # Finds an Space Membership by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] space_membership_id
+      #
+      # @return [Contentful::Management::SpaceMembership]
+      def self.find(client, space_id, space_membership_id)
+        super(client, space_id, nil, space_membership_id)
+      end
+
       # @private
       def query_attributes(attributes)
         {

data/lib/contentful/management/ui_extension.rb

@@ -103,6 +103,18 @@ module Contentful
       def sidebar=(value)
         extension['sidebar'] = value
       end
+
+      # Returns extensions parameters
+      # @return [Hash] parameters
+      def parameters
+        extension['parameters']
+      end
+
+      # Sets extension parameters
+      # @param [Hash] value
+      def parameters=(value)
+        extension['parameters'] = value
+      end
     end
   end
 end

data/lib/contentful/management/user.rb

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

data/lib/contentful/management/version.rb

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

data/lib/contentful/management/webhook.rb

@@ -16,6 +16,8 @@ module Contentful
       property :topics, :array
       property :headers, :array
       property :httpBasicUsername, :string
+      property :filters, :array
+      property :transformation, :hash
 
       # @private
       def self.endpoint
@@ -24,7 +26,8 @@ module Contentful
 
       # @private
       def self.create_attributes(_client, attributes)
-        attributes.select { |key, _value| %i[httpBasicUsername httpBasicPassword url name headers topics].include? key }
+        keys = %i[httpBasicUsername httpBasicPassword url name headers topics filters transformation]
+        attributes.select { |key, _value| keys.include? key }
       end
 
       # Creates a webhook.

data/spec/fixtures/vcr_cassettes/environment/find_3.yml

@@ -0,0 +1,139 @@
+---
+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.2.2; platform ruby/2.5.1; os macOS/16;
+      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
+      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, 08 Aug 2018 12:26:09 GMT
+      Etag:
+      - W/"efb427da4c64de61fd8bde26734945d1"
+      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:
+      - d981979609da67ef92a67a74c65363cd
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - ALLOWALL
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '690'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_876_673446=q5sjRVamkAzfaJaZyy0oDGHhalsAAAAAlMz5dhO5pLw0AXzxKfBBEg==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=N1YJW7/yIjiQURM06lKYhQAAAAAUYHvVqzC/esUyoNIlEpco; path=/; Domain=.contentful.com
+      - visid_incap_673446=yFeopm69RiqLXqnXk6DK2GHhalsAAAAAQUIPAAAAAAAJkp0DLHJDXuJES17gxUOs;
+        expires=Thu, 08 Aug 2019 11:25:55 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 4-376352-376358 NNNN CT(0 0 0) RT(1533731168824 74) q(0 0 0 -1) r(2 2) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |+
+        {
+          "name":"testing",
+          "sys":{
+            "type":"Environment",
+            "id":"testing",
+            "version":6,
+            "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":"2018-02-27T10:19:04Z"
+          }
+        }
+
+    http_version: 
+  recorded_at: Wed, 08 Aug 2018 12:26:09 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/space_memberships/find_2.yml

@@ -0,0 +1,336 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/facgnwwgj5fe/space_memberships
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/2.2.2; platform ruby/2.5.1; os macOS/16;
+      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
+      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:
+      - Thu, 09 Aug 2018 10:19:56 GMT
+      Etag:
+      - W/"dda64bbb7b1d0b38bc504a6dcc255340"
+      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:
+      - '0690f30152882fae485b1af466d2a860'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - ALLOWALL
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1999'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_876_673446=9ALjNFdW8mm6kHCbyy0oDEwVbFsAAAAAy83vlR8/H1KaWlNyzE5mrg==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=EbqXDoO7Lhdl5ezj6lKYhQAAAAD33mHJ7Z415lGHeXzZk/wb; path=/; Domain=.contentful.com
+      - visid_incap_673446=72ArswPGQSuHAt6X50fRZUwVbFsAAAAAQUIPAAAAAADs9vSI2+fa1VdM3DV1YO+N;
+        expires=Thu, 08 Aug 2019 11:25:29 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 10-6586772-6586792 NNNN CT(86 91 0) RT(1533809996060 69) q(0 0 2 -1) r(4 4)
+        U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |+
+        {
+          "total":2,
+          "limit":25,
+          "skip":0,
+          "sys":{
+            "type":"Array"
+          },
+          "items":[
+            {
+              "admin":true,
+              "sys":{
+                "type":"SpaceMembership",
+                "id":"1NI22o8oAxT9Jnu2J9wJSu",
+                "version":0,
+                "space":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Space",
+                    "id":"facgnwwgj5fe"
+                  }
+                },
+                "createdBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "createdAt":"2017-03-02T18:30:27Z",
+                "updatedBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "updatedAt":"2017-03-02T18:30:27Z"
+              },
+              "user":{
+                "sys":{
+                  "type":"Link",
+                  "linkType":"User",
+                  "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                }
+              },
+              "roles":[]
+            },
+            {
+              "admin":false,
+              "sys":{
+                "type":"SpaceMembership",
+                "id":"6RdRdobdQzh8zKe1Hogiz4",
+                "version":0,
+                "space":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Space",
+                    "id":"facgnwwgj5fe"
+                  }
+                },
+                "createdBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "createdAt":"2017-07-06T14:18:17Z",
+                "updatedBy":{
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"User",
+                    "id":"4SejVrWT96dvL9IV4Nb7sQ"
+                  }
+                },
+                "updatedAt":"2017-07-06T14:18:17Z"
+              },
+              "user":{
+                "sys":{
+                  "type":"Link",
+                  "linkType":"User",
+                  "id":"3xagQOg6z3bxOhPcTpgsaq"
+                }
+              },
+              "roles":[
+                {
+                  "sys":{
+                    "type":"Link",
+                    "linkType":"Role",
+                    "id":"1Nq88dKTNXNaxkbrRpEEw6"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+
+    http_version: 
+  recorded_at: Thu, 09 Aug 2018 10:19:56 GMT
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/facgnwwgj5fe/space_memberships/1NI22o8oAxT9Jnu2J9wJSu
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/2.2.2; platform ruby/2.5.1; os macOS/16;
+      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
+      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:
+      - Thu, 09 Aug 2018 10:19:57 GMT
+      Etag:
+      - W/"81a83a3caf5c2829b0cf422b77082076"
+      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:
+      - '35998'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '8'
+      X-Contentful-Request-Id:
+      - 5059b298abee08da23c37b9da8d30349
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - ALLOWALL
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '718'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_876_673446=lFEPfCxfGRIjkXCbyy0oDEwVbFsAAAAAyH25TYgKfFJmyVIPsWLeNw==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=b4gUXZg4LhBWqqK66lKYhQAAAABlIcIJNX1tEcXk0rSNRGDr; path=/; Domain=.contentful.com
+      - visid_incap_673446=rGI4jU2yRbamU6nprhSSoEwVbFsAAAAAQUIPAAAAAAB1+vLwDvjUJIJlXLGwuTFA;
+        expires=Thu, 08 Aug 2019 11:25:55 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 11-11718922-11718927 NNNN CT(0 0 0) RT(1533809996560 44) q(0 0 0 -1) r(2 2)
+        U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |+
+        {
+          "admin":true,
+          "sys":{
+            "type":"SpaceMembership",
+            "id":"1NI22o8oAxT9Jnu2J9wJSu",
+            "version":0,
+            "space":{
+              "sys":{
+                "type":"Link",
+                "linkType":"Space",
+                "id":"facgnwwgj5fe"
+              }
+            },
+            "createdBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "createdAt":"2017-03-02T18:30:27Z",
+            "updatedBy":{
+              "sys":{
+                "type":"Link",
+                "linkType":"User",
+                "id":"4SejVrWT96dvL9IV4Nb7sQ"
+              }
+            },
+            "updatedAt":"2017-03-02T18:30:27Z"
+          },
+          "user":{
+            "sys":{
+              "type":"Link",
+              "linkType":"User",
+              "id":"4SejVrWT96dvL9IV4Nb7sQ"
+            }
+          },
+          "roles":[]
+        }
+
+    http_version: 
+  recorded_at: Thu, 09 Aug 2018 10:19:57 GMT
+recorded_with: VCR 4.0.0