contentful-management 0.0.3 → 0.1.0

data/.reek

@@ -1,3 +1,23 @@
 ---
 IrresponsibleModule:
   enabled: false
+TooManyStatements:
+  exclude:
+  - initialize
+  - entries
+  - assets
+  - content_types
+  max_statements: 11
+NestedIterators:
+  enabled: false
+PrimaDonnaMethod:
+  enabled: false
+FeatureEnvy:
+  enabled: true
+  exclude:
+  - initialize
+NilCheck:
+  enabled: true
+  exclude:
+  - save
+  - create

data/.rubocop.yml

@@ -13,4 +13,28 @@ AllCops:
     - bin/cma-console
 
 LineLength:
-  Max: 120
+  Max: 135
+Style/MethodLength:
+  Max: 15
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/CyclomaticComplexity:
+  Max: 8
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/CaseIndentation:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.1.0
+ * Support for webhooks
+ * add image url to asset
+ * Cleaning code
+ * Fix: remove implicit processing of assets.
+ * Fix: Gem is modifying nil #17
+ * Fix: rename asset.process_files to asset.process
+
+
 ### 0.0.3
  * Fix: next_page feature
  * Fix: create entry with specific locale

data/README.md

@@ -244,6 +244,11 @@ asset.file_with_locales= {'en-US' => en_file, 'pl' => pl_file}
 asset.save
 ```
 
+Process an Asset file after create:
+```ruby
+asset.process_file
+```
+
 Updating an asset:
 
 - default locale

data/examples/content_types.rb

@@ -5,7 +5,6 @@ organization = 'organization id'
 
 require 'contentful/management'
 
-
 client = Contentful::Management::Client.new(access_token)
 space = Contentful::Management::Space.create(name: 'MySpace', organization_id: organization)
 
@@ -30,7 +29,6 @@ field2.id = 'wow_content'
 field2.name = 'Wow Content'
 field2.type = 'Location' #content types maybe as symbol?
 
-
 type2.update(name: 'whoat', fields: [field, field2])
 
 type2.fields.add(field2)
@@ -41,5 +39,5 @@ type2.deactivate
 
 type1.destroy
 
-#clean up afterwards!
+# clean up afterwards!
 space.destroy

data/examples/create_space.rb

@@ -23,7 +23,6 @@ locales = dat_space.locales.all
 
 dat_space.destroy
 
-
 # XXX: This does not set the organization_id when a space should be created
 #
 your_space = Contentful::Management::Space.new
@@ -31,5 +30,4 @@ your_space.organization = organization
 your_space.name = 'YourSpace'
 your_space.save
 
-
 your_space.destroy

data/lib/contentful/management/asset.rb

@@ -50,13 +50,12 @@ module Contentful
         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.process_files if result.is_a? self
         result.locale = locale if locale
         result
       end
 
-      # This method is used only when an asset is created. Processes the uploaded file.
-      def process_files
+      # 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.put
@@ -82,7 +81,7 @@ module Contentful
       # See README for details.
       def save
         if id.nil?
-          new_instance = self.class.create(self.sys[:space].id, {fields: instance_variable_get(:@fields)})
+          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)
@@ -163,6 +162,28 @@ module Contentful
           end
         end
       end
+
+      # Returns the image url of an asset
+      # Allows you to pass in the following options for image resizing:
+      #   :width
+      #   :height
+      #   :format
+      #   :quality
+      # 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
+      end
     end
   end
 end

data/lib/contentful/management/client.rb

@@ -22,7 +22,7 @@ module Contentful
           api_url: 'api.contentful.com',
           api_version: '1',
           secure: true,
-          default_locale: 'en-US',
+          default_locale: 'en-US'
       }
 
       def initialize(access_token = nil, configuration = {})
@@ -32,7 +32,6 @@ module Contentful
         Thread.current[:client] = self
       end
 
-
       def update_dynamic_entry_cache_for_spaces!(spaces)
         spaces.each do |space|
           update_dynamic_entry_cache_for_space!(space)

data/lib/contentful/management/content_type.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'field'
+require_relative 'content_type_entry_methods_factory'
 
 module Contentful
   module Management
@@ -184,26 +185,7 @@ module Contentful
       # Returns a Contentful::Management::Entry.
       # See README for details.
       def entries
-        entries = nil
-
-        entries.instance_exec(self) do |content_type|
-
-          define_singleton_method(:all) do
-            Contentful::Management::Entry.all(content_type.space.id, content_type: content_type.id)
-          end
-
-          define_singleton_method(:create) do |params|
-            Entry.create(content_type, params)
-          end
-
-          define_singleton_method(:new) do
-            dynamic_entry_class = content_type.client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
-            dynamic_entry = dynamic_entry_class.new
-            dynamic_entry.content_type = content_type
-            dynamic_entry
-          end
-        end
-        entries
+        Contentful::Management::ContentTypeEntryMethodsFactory.new(self)
       end
 
       private
@@ -215,4 +197,4 @@ module Contentful
       end
     end
   end
-end
+end

data/lib/contentful/management/content_type_entry_methods_factory.rb

@@ -0,0 +1,28 @@
+module Contentful
+  module Management
+    class ContentTypeEntryMethodsFactory
+
+      attr_reader :content_type
+
+      def initialize(content_type)
+        @content_type = content_type
+      end
+
+      def all(params = {})
+        Entry.all(content_type.space.id, params.merge(content_type: content_type.id))
+      end
+
+      def create(attributes)
+        Entry.create(content_type, attributes)
+      end
+
+      def new
+        dynamic_entry_class = content_type.client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
+        dynamic_entry = dynamic_entry_class.new
+        dynamic_entry.content_type = content_type
+        dynamic_entry
+      end
+
+    end
+  end
+end

data/lib/contentful/management/entry.rb

@@ -8,7 +8,6 @@ module Contentful
     # Resource class for Entry.
     # https://www.contentful.com/developers/documentation/content-management-api/#resources-entries
     class Entry
-
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
@@ -43,7 +42,7 @@ module Contentful
       def self.create(content_type, attributes)
         custom_id = attributes[:id] || ''
         locale = attributes[:locale]
-        fields_for_create = if attributes[:fields] #create from initialized dynamic entry via save
+        fields_for_create = if attributes[:fields] # create from initialized dynamic entry via save
                               tmp_entry = new
                               tmp_entry.instance_variable_set(:@fields, attributes.delete(:fields) || {})
                               Contentful::Management::Support.deep_hash_merge(tmp_entry.fields_for_query, tmp_entry.fields_from_attributes(attributes))
@@ -52,7 +51,6 @@ module Contentful
                             end
 
         request = Request.new("/#{ content_type.sys[:space].id  }/entries/#{ custom_id }", {fields: fields_for_create}, nil, content_type_id: content_type.id)
-
         response = custom_id.empty? ? request.post : request.put
         result = ResourceBuilder.new(response, {}, {})
         client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))

data/lib/contentful/management/error.rb

@@ -32,31 +32,31 @@ module Contentful
     end
 
     # 404
-    class NotFound < Error;
+    class NotFound < Error
     end
 
     # 400
-    class BadRequest < Error;
+    class BadRequest < Error
     end
 
     # 403
-    class AccessDenied < Error;
+    class AccessDenied < Error
     end
 
     # 401
-    class Unauthorized < Error;
+    class Unauthorized < Error
     end
 
     # 500
-    class ServerError < Error;
+    class ServerError < Error
     end
 
     # Raised when response is no valid json
-    class UnparsableJson < Error;
+    class UnparsableJson < Error
     end
 
     # Raised when response is not parsable as a Contentful::Resource
-    class UnparsableResource < Error;
+    class UnparsableResource < Error
     end
   end
 end

data/lib/contentful/management/file.rb

@@ -3,7 +3,7 @@ require_relative 'resource'
 
 module Contentful
   module Management
-   # An Asset's file schema
+    # An Asset's file schema
     class File
       include Contentful::Management::Resource
 

data/lib/contentful/management/locale.rb

@@ -18,10 +18,10 @@ module Contentful
       # Gets a collection of locales.
       # Takes an id of a space.
       # Returns a Contentful::Management::Array of Contentful::Management::Locale.
-      def self.all(space_id = nil)
+      def self.all(space_id = nil, parameters = {})
         request = Request.new("/#{ space_id }/locales")
         response = request.get
-        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         result.run
       end
 
@@ -31,7 +31,7 @@ module Contentful
       def self.find(space_id, locale_id)
         request = Request.new("/#{ space_id }/locales/#{ locale_id }")
         response = request.get
-        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         result.run
       end
 
@@ -44,9 +44,9 @@ module Contentful
       #   :publish
       # Returns a Contentful::Management::Locale.
       def self.create(space_id, attributes)
-        request = Request.new("/#{ space_id }/locales", { 'name' => attributes.fetch(:name), 'code' => attributes.fetch(:code) })
+        request = Request.new("/#{ space_id }/locales", {'name' => attributes.fetch(:name), 'code' => attributes.fetch(:code)})
         response = request.post
-        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         result.run
       end
 
@@ -54,9 +54,9 @@ module Contentful
       # Takes a hash with attributes.
       # Returns a Contentful::Management::Locale.
       def update(attributes)
-        request = Request.new("/#{ space.id }/locales/#{ id }", { 'name' => attributes.fetch(:name) }, id = nil, version: sys[:version])
+        request = Request.new("/#{ space.id }/locales/#{ id }", {'name' => attributes.fetch(:name)}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         refresh_data(result.run)
       end
     end

data/lib/contentful/management/request.rb

@@ -65,7 +65,6 @@ module Contentful
         self.class.new(@endpoint, @query, @initial_id, @header)
       end
 
-
       private
 
       def normalize_query(query)
@@ -74,7 +73,7 @@ module Contentful
               [
                   key.to_sym,
                   value
-                  # value.is_a?(::Array) ? value.join(',') : value
+              # value.is_a?(::Array) ? value.join(',') : value
               ]
             end
         ]

data/lib/contentful/management/resource.rb

@@ -15,11 +15,11 @@ module Contentful
     # by the client by default
     module Resource
       COERCIONS = {
-          string: ->(v) { v.to_s },
-          integer: ->(v) { v.to_i },
-          float: ->(v) { v.to_f },
-          boolean: ->(v) { !!v },
-          date: ->(v) { !v.nil? ? DateTime.parse(v) : nil }
+          string: ->(value) { value.to_s },
+          integer: ->(value) { value.to_i },
+          float: ->(value) { value.to_f },
+          boolean: ->(value) { !!value },
+          date: ->(value) { !value.nil? ? DateTime.parse(value) : nil }
       }
 
       attr_reader :properties, :request, :client, :default_locale
@@ -160,7 +160,6 @@ module Contentful
       def self.included(base)
         base.extend(ClassMethods)
       end
-
     end
   end
 end

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

@@ -30,7 +30,6 @@ module Contentful
         end
 
         alias length size
-
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Contentful
   module Management
     module Resource
       module AssetFields
-
+        # Special fields for Asset.
         def fields_coercions
           {
               title: :hash,
@@ -10,8 +10,7 @@ module Contentful
               file: Contentful::Management::File
           }
         end
-
       end
     end
   end
-end
+end