contentful-management 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf3767440a711329cd8a89e79165348a4e7e7c1b
+  data.tar.gz: f7a51847bf88d1dd1c7e92814df67b727772ac64
+SHA512:
+  metadata.gz: 8bc3c9c2e2421fbadb69cbd4f350e34df803a9e2c8197575ebfabb02504f48f4e99f4e26caea2443e9a4529addd8b220cd3b9241d5ecf19fb071d0ea327a06c1
+  data.tar.gz: 518a8413cbe4611e42594c2b2eef3f6b8c129851960c01245b65ed5c14c7aa79ebe9275fe070fe84ad47ba3d9631c467fddef038537d8ccfce10b49c7fb3565e

data/CHANGELOG.md

@@ -1,40 +1,69 @@
 # Change Log
+## 0.3.1
 
+### Added
+* Logging of requests
+* Access to validations in responses
+* Create validations through the API
+
+### Fixed
+* Cleaner and better error handling
+
+### Other
+* Cleaned the code
+* Remove encoding strings from the source code files
 ## 0.2.1
+### Fixed
 * Fix: Use array for symbols in entry fields
 
 ## 0.2.0
+### Fixed
 * Fix: create entry with multiple locales, skip attributes for not localized fields in content types
 * Fix: reload Assets
-* add optional gzip envoding
+
+### Added
+* Add optional gzip encoding
 
 ## 0.1.0
-* Support for webhooks
-* add image url to asset
-* Cleaning code
+### Added
+* Support for web hooks
+* Image url to asset
+
+### Fixed
 * Fix: remove implicit processing of assets.
 * Fix: Gem is modifying nil #17
 * Fix: rename asset.process_files to asset.process
 
+### Other
+* Cleaning code
 
 ## 0.0.3
+### Added:
+* More documentation
+
+### Fixed:
 * Fix: next_page feature
 * Fix: create entry with specific locale
 * Fix: service unavailable error (503)
 * Fix: reload method on objects
+### Other
 * Code cleanup
-* More documentation
 
 ## 0.0.2
+### Fixed
 * Fix: Convert an Entry to a DynamicEntry after being created.
 
 ## 0.0.1
-* Fix: Headers not properly cleared between requests
-* Fix: Create entries with custom identifier
-* Code cleanup
+### Added
 * Adding rdoc
 * Adding filter by content_type id
 
+### Fixed
+* Fix: Headers not properly cleared between requests
+* Fix: Create entries with custom identifier
+
+### Other
+* Code cleanup
 
 ## 0.0.1-pre
 * alpha pre-release

data/Gemfile

@@ -7,7 +7,6 @@ group :development do
   gem 'pry'
 end
 
-
 group :test do
   gem 'simplecov', require: false
 end

data/README.md

@@ -404,6 +404,119 @@ Checking if the entry is published:
 my_entry.published?
 ```
 
+### Webhooks
+
+Retrieving all webhooks from the space:
+
+```ruby
+webhooks = blog_space.webhooks.all
+```
+Retrieving one webhook by the webhook-id from the space:
+
+```ruby
+blog_post_webhook = blog_space.webhooks.find(webhook_id)
+```
+
+Creating a webhook
+
+```ruby
+blog_space.webhooks.create(url: 'https://www.example.com', httpBasicUsername: 'username', httpBasicPassword: 'password')
+```
+
+Updating a webhook
+
+```ruby
+blog_post_webhook.update(url: 'https://www.newlink.com')
+```
+
+Destroying webhook:
+
+```ruby
+blog_post_webhook.destroy
+```
+
+## Validations
+
+#### in
+
+Takes an array of values and validates that the field value is in this array.
+
+```ruby
+validation_in = Contentful::Management::Validation.new
+validation_in.in = ['foo', 'bar', 'baz']
+blog_post_content_type.fields.create(id: 'valid', name: 'Testing IN', type: 'Text', validations: [validation_in])
+```
+
+#### size
+
+Takes optional min and max parameters and validates the size of the array (number of objects in it).
+
+```ruby
+validation_size = Contentful::Management::Validation.new
+validation_size.size = { min: 10, max: 15 }
+blog_post_content_type.fields.create(id: 'valid', name: 'Test In', type: 'Text', validations: [validation_size])
+```
+
+#### range
+
+Takes a string that reflects a JS regex and flags, validates against a string. See JS Reference for the parameters.
+
+```ruby
+validation_range = Contentful::Management::Validation.new
+validation_range.range = { min: 100, max: 150 }
+blog_post_content_type.fields.create(id: 'valid', name: 'Range', type: 'Text', validations: [validation_range])
+```
+
+#### regex
+
+Takes a string that reflects a JS regex and flags, validates against a string. See [JS Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) for the parameters.
+
+```ruby
+validation_regexp = Contentful::Management::Validation.new
+validation_regexp.regexp = {pattern: '^such', flags: 'im'}
+blog_post_content_type.fields.create(id: 'valid', name: 'Regex', type: 'Text', validations: [validation_regexp])
+```
+
+#### linkContentType
+
+Takes an array of content type ids and validates that the link points to an entry of that content type.
+
+```ruby
+validation_link_content_type = Contentful::Management::Validation.new
+validation_link_content_type.link_content_type =  ['post_content_type_id']
+blog_post_content_type.fields.create(id: 'entry', name: 'Regex', type: 'Entry', validations: [validation_link_content_type])
+```
+
+#### linkMimetypeGroup
+
+Takes a MimeType group name and validates that the link points to an asset of this group.
+
+```ruby
+validation_link_mimetype_group = Contentful::Management::Validation.new
+validation_link_mimetype_group.link_mimetype_group = 'image'
+content_type.fields.create(id: 'asset', validations: [validation_link_mimetype_group])
+```
+
+#### present
+
+Validates that a value is present.
+
+```ruby
+validation_present = Contentful::Management::Validation.new
+validation_present.present = true
+content_type.fields.create(id: 'number', validations: [validation_present])
+```
+
+#### linkField
+
+Validates that the property is a link (must not be a valid link, just that it looks like one).
+
+```ruby
+validation_link_field = Contentful::Management::Validation.new
+validation_link_field.link_field  = true
+content_type.fields.create(id: 'entry', validations: [validation_link_field])
+```
+
 ### Pagination
 
 ```ruby
@@ -412,6 +525,23 @@ blog_space.assets.all(limit: 5).next_page
 blog_space.entries.all(limit: 5).next_page
 ``` 
 
+## Logging
+
+Logging is disabled by default, it can be enabled by setting a logger instance and a logging severity.
+
+```ruby
+client = Contentful::Management::Client.new('access_token', logger: logger_instance, log_level: Logger::DEBUG)
+```
+
+Example loggers:
+
+```ruby
+Rails.logger
+Logger.new('logfile.log')
+```
+
+The default severity is set to INFO and logs only the request attributes (headers, parameters and url). Setting it to DEBUG will also log the raw JSON response.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/contentful-management/fork )

data/Rakefile

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'bundler/gem_tasks'
 require 'rubygems'
 require 'rake'

data/contentful-management.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'contentful/management/version'

data/examples/blog.rb

@@ -16,7 +16,7 @@ organization = 'organization id'
 
 require 'contentful/management'
 
-client = Contentful::Management::Client.new(access_token)
+Contentful::Management::Client.new(access_token)
 
 blog_space = Contentful::Management::Space.create(name: 'Blog', organization_id: organization)
 # blog_space = Contentful::Management::Space.find('zlso53r1zad6')

data/lib/contentful/management.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'contentful/management/version'
 require 'contentful/management/support'
 require 'contentful/management/client'

data/lib/contentful/management/array.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'resource/array_like'
 

data/lib/contentful/management/asset.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'resource/asset_fields'
 require_relative 'resource/fields'
@@ -18,7 +17,10 @@ module Contentful
       # Takes an id of space and an optional hash of query options
       # Returns a Contentful::Management::Array of Contentful::Management::Asset.
       def self.all(space_id, query = {})
-        request = Request.new("/#{ space_id }/assets", query)
+        request = Request.new(
+            "/#{ space_id }/assets",
+            query
+        )
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         result.run
@@ -46,7 +48,10 @@ module Contentful
         asset.description = attributes[:description] if attributes[:description]
         asset.file = attributes[:file] if attributes[:file]
 
-        request = Request.new("/#{ space_id }/assets/#{ attributes[:id] || ''}", fields: asset.fields_for_query)
+        request = Request.new(
+            "/#{ space_id }/assets/#{ attributes[:id]}",
+            fields: asset.fields_for_query
+        )
         response = attributes[:id].nil? ? request.post : request.put
         result = ResourceBuilder.new(response, {}, {}).run
         result.locale = locale if locale
@@ -56,7 +61,12 @@ module Contentful
       # Processing an Asset file
       def process_file
         instance_variable_get(:@fields).keys.each do |locale|
-          request = Request.new("/#{ space.id }/assets/#{ id }/files/#{ locale }/process", {}, id = nil, version: sys[:version])
+          request = Request.new(
+              "/#{ space.id }/assets/#{ id }/files/#{ locale }/process",
+              {},
+              id = nil,
+              version: sys[:version]
+          )
           request.put
         end
         sys[:version] += 1
@@ -70,7 +80,12 @@ module Contentful
         self.title = attributes[:title] if attributes[:title]
         self.description = attributes[:description] if attributes[:description]
         self.file = attributes[:file] if attributes[:file]
-        request = Request.new("/#{ space.id }/assets/#{ id }", {fields: fields_for_query}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/assets/#{ id }",
+            {fields: fields_for_query},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -79,11 +94,11 @@ module Contentful
       # If an asset is a new object gets created in the Contentful, otherwise the existing asset gets updated.
       # See README for details.
       def save
-        if id.nil?
+        if id
+          update(title: title, description: description, file: file)
+        else
           new_instance = self.class.create(sys[:space].id, fields: instance_variable_get(:@fields))
           refresh_data(new_instance)
-        else
-          update(title: title, description: description, file: file)
         end
       end
 
@@ -103,7 +118,12 @@ module Contentful
       # Publishes an asset.
       # Returns a Contentful::Management::Asset.
       def publish
-        request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/assets/#{ id }/published",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -112,7 +132,12 @@ module Contentful
       # Unpublishes an asset.
       # Returns a Contentful::Management::Asset.
       def unpublish
-        request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/assets/#{ id }/published",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -121,7 +146,12 @@ module Contentful
       # Archive an asset.
       # Returns a Contentful::Management::Asset.
       def archive
-        request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/assets/#{ id }/archived",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -130,7 +160,12 @@ module Contentful
       # Unarchvie an asset.
       # Returns a Contentful::Management::Asset.
       def unarchive
-        request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/assets/#{ id }/archived",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -139,13 +174,13 @@ module Contentful
       # Checks if an asset is published.
       # Returns true if published.
       def published?
-        !sys[:publishedAt].nil?
+        sys[:publishedAt] ? true : false
       end
 
       # Checks if an asset is archvied.
       # Returns true if archived.
       def archived?
-        !sys[:archivedAt].nil?
+        sys[:archivedAt] ? true : false
       end
 
       # Returns currently supported local or default locale.
@@ -157,11 +192,19 @@ module Contentful
       def fields_for_query
         self.class.fields_coercions.keys.each_with_object({}) do |field_name, results|
           results[field_name] = @fields.each_with_object({}) do |(locale, fields), field_results|
-            field_results[locale] = field_name == :file ? (fields[field_name] ? fields[field_name].properties : nil) : fields[field_name]
+            field_results[locale] = get_value_from(fields, field_name)
           end
         end
       end
 
+      def get_value_from(fields, field_name)
+        if field_name == :file
+          fields[field_name].properties if fields[field_name]
+        else
+          fields[field_name]
+        end
+      end
+
       # Returns the image url of an asset
       # Allows you to pass in the following options for image resizing:
       #   :width
@@ -171,17 +214,13 @@ module Contentful
       # See https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
       def image_url(options = {})
         query = {
-          w:  options[:w]  || options[:width],
-          h:  options[:h]  || options[:height],
-          fm: options[:fm] || options[:format],
-          q:  options[:q]  || options[:quality]
-        }.reject { |_k, v| v.nil? }
-
-        if query.empty?
-          file.url
-        else
-          "#{file.url}?#{URI.encode_www_form(query)}"
-        end
+            w: options[:w] || options[:width],
+            h: options[:h] || options[:height],
+            fm: options[:fm] || options[:format],
+            q: options[:q] || options[:quality]
+        }.select { |_k, value| value }
+
+        query.empty? ? file.url : "#{file.url}?#{URI.encode_www_form(query)}"
       end
     end
   end