contentful_model 0.1.7.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2d355e60fd1a5df73ff632025fd2a2fecfbc4ce
-  data.tar.gz: 44795c690dd5d6142240f7944b178ed76f9bc087
+  metadata.gz: cb158dcb23427ac8201185b1201a237ba7dfa0a5
+  data.tar.gz: 7f4e3ac0d68637daf9bb60662c85476ea6e8916a
 SHA512:
-  metadata.gz: 24758869403fb3fccda9b0e97ba2c6186e2a33780d8afdc8cae11b726a251912bc2d59b4c60576a07db52504929410786a09e8ae00c487a14a744ccdd48e3e71
-  data.tar.gz: d39706301c823988bf8fa76da208fd65fcd1c5aefc85a8704aa37262cbff1d162d9500df9e4b9bad72a276d44c2b1d810ba8d1b407e00c6e2eb8fb6853eab97e
+  metadata.gz: 6a69c4da7a8cb02d67af7e4685bcff46f363d4fe63137d30a6a554f7d6c464314ae5980ea3bd2955d61145ee1120b5235675059e5e25c11b2ea986648b983017
+  data.tar.gz: a6b37e8649735c82a5ee6f7439291ceb45b21597e3fc8c0dfe0edf8b483b963af10c07f38a5f2272c876bf9cd4ec2ef1e8419c544379964ccaa2f847077a9ed4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Error Creative Studio
+Copyright 2014 Error Creative Studio, Contentful GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/contentful_model.rb

@@ -1,4 +1,5 @@
 require 'require_all'
+require 'contentful/management'
 require 'contentful'
 require_rel '.'
 
@@ -23,7 +24,9 @@ module ContentfulModel
     attr_accessor :access_token,
                   :preview_access_token,
                   :space,
-                  :entry_mapping
+                  :entry_mapping,
+                  :management_token,
+                  :default_locale
 
     def initialize
       @entry_mapping ||= {}

data/lib/contentful_model/base.rb

@@ -1,19 +1,41 @@
 module ContentfulModel
-  class Base < Contentful::Entry
+  class Base < Contentful::DynamicEntry
     include ContentfulModel::ChainableQueries
     include ContentfulModel::Associations
     include ContentfulModel::Validations
+    include ContentfulModel::Manageable
 
     def initialize(*args)
       super
+      define_getters
       self.class.coercions ||= {}
     end
 
+    private
+
+    def define_getters
+      fields.each do |k, v|
+        if Contentful::Constants::KNOWN_LOCALES.include?(k.to_s)
+          v.keys.each do |name|
+            define_getter(name)
+          end
+        else
+          define_getter(k)
+        end
+      end
+    end
+
+    def define_getter(name)
+      define_singleton_method "#{name.to_s.underscore}" do
+        fields(default_locale)[name]
+      end
+    end
+
     #use method_missing to call fields on the model
     def method_missing(method, *args, &block)
       result = fields[:"#{method.to_s.camelize(:lower)}"]
       # we need to pull out any Contentful::Link references, and also things which don't have any fields at all
-      # because they're newly created (we think exposing these in the Contentful API is a bug, actually)
+      # because they're newly created
       if result.is_a?(Array)
         result.reject! {|r| r.is_a?(Contentful::Link) || (r.respond_to?(:invalid) && r.invalid?)}
       elsif result.is_a?(Contentful::Link)
@@ -24,8 +46,6 @@ module ContentfulModel
         result = nil
       end
 
-
-
       if result.nil?
         # if self.class.rescue_from_no_attribute_fields.member?()
         # end
@@ -66,15 +86,8 @@ module ContentfulModel
       end
 
       "#{self.class.to_s.underscore}/#{self.id}-#{self.updated_at.utc.to_s(:number)}"
-
-    end
-
-    def save
-      raise NotImplementedError, "Saving models isn't implemented; we need to use the Contentful Management API for that. Pull requests welcome!"
     end
 
-    alias_method :create, :save
-
     class << self
       attr_accessor :content_type_id, :coercions, :return_nil_for_empty_attribute_fields
 
@@ -84,7 +97,7 @@ module ContentfulModel
 
       def add_entry_mapping
         unless ContentfulModel.configuration.entry_mapping.has_key?(@content_type_id)
-          ContentfulModel.configuration.entry_mapping[@content_type_id] = Object.const_get(self.to_s.to_sym)
+          ContentfulModel.configuration.entry_mapping[@content_type_id] = self.to_s.constantize
         end
       end
 
@@ -96,7 +109,6 @@ module ContentfulModel
         else
           @client ||= ContentfulModel::Client.new(ContentfulModel.configuration.to_hash)
         end
-
       end
 
       def content_type
@@ -115,7 +127,7 @@ module ContentfulModel
         @return_nil_for_empty_attribute_fields ||= []
 
         fields.each do |field|
-          define_method field do 
+          define_method field do
             begin
               super()
             rescue ContentfulModel::AttributeNotFoundError
@@ -126,13 +138,6 @@ module ContentfulModel
           @return_nil_for_empty_attribute_fields.push(field)
         end
       end
-
     end
-
-
-
-
-
-
   end
 end

data/lib/contentful_model/chainable_queries.rb

@@ -8,7 +8,12 @@ module ContentfulModel
     module ClassMethods
 
       def all
-        raise ArgumentError, "You need to set self.content_type in your model class" if @content_type_id.nil?
+        raise ArgumentError, 'You need to set self.content_type in your model class' if @content_type_id.nil?
+        self
+      end
+
+      def params(options)
+        @query << options
         self
       end
 
@@ -27,6 +32,16 @@ module ContentfulModel
         self
       end
 
+      def locale(locale_code)
+        @query << {'locale' => locale_code}
+        self
+      end
+      
+      def load_children(n)
+        @query << {'include' => n}
+        self
+      end
+
       def order(args)
         prefix = ''
         if args.is_a?(Hash)
@@ -35,6 +50,8 @@ module ContentfulModel
         elsif args.is_a?(Symbol)
           column = args.to_s
           prefix = ''
+        else
+          column = args.to_s
         end
         @query << {'order' => "#{prefix}fields.#{column.camelize(:lower)}"}
         self
@@ -47,7 +64,7 @@ module ContentfulModel
           #query is a hash
           if query.values.first.is_a?(Array) #we need to do an 'in' query
             @query << {"fields.#{query.keys.first.to_s.camelize(:lower)}[in]" => query.values.first.join(",")}
-          elsif query.values.first.is_a?(String) || [TrueClass,FalseClass].member?(query.values.first.class)
+          elsif query.values.first.is_a?(String) || query.values.first.is_a?(Numeric) || [TrueClass,FalseClass].member?(query.values.first.class)
             @query << {"fields.#{query.keys.first.to_s.camelize(:lower)}" => query.values.first}
           elsif query.values.first.is_a?(Hash)
             # if the search is a hash, use the key to specify the search field operator
@@ -65,7 +82,15 @@ module ContentfulModel
       def search(parameters)
         if parameters.is_a?(Hash)
           parameters.each do |field, search|
-            @query << {"fields.#{field.to_s.camelize(:lower)}[match]" => search}
+            # if the search is a hash, use the key to specify the search field operator
+            # For example
+            # Model.search(start_date: {gte: DateTime.now}) => "fields.start_date[gte]" => DateTime.now
+            if search.is_a?(Hash)
+              search_key, search_value = *search.flatten
+              @query << {"fields.#{field.to_s.camelize(:lower)}[#{search_key}]" => search_value}
+            else
+              @query << {"fields.#{field.to_s.camelize(:lower)}[match]" => search}
+            end
           end
         elsif parameters.is_a?(String)
           @query << {"query" => parameters}

data/lib/contentful_model/client.rb

@@ -8,7 +8,7 @@ module ContentfulModel
         configuration[:api_url] = PREVIEW_API_URL
         configuration[:access_token] = configuration[:preview_access_token]
       end
-      super(configuration)
+      super({ raise_errors: true, dynamic_entries: :auto }.merge(configuration))
     end
   end
-end
+end

data/lib/contentful_model/errors.rb

@@ -1,4 +1,5 @@
 module ContentfulModel
   class AssociationError < StandardError; end
-  class AttributeNotFoundError < StandardError; end
-end
+  class VersionMismatchError < StandardError; end
+  class AttributeNotFoundError < NoMethodError; end
+end

data/lib/contentful_model/manageable.rb

@@ -0,0 +1,135 @@
+module ContentfulModel
+  module Manageable
+    attr_reader :dirty
+
+    def initialize(*args)
+      super
+      @dirty = false
+      @changed_fields = []
+      define_setters
+    end
+
+    def to_management(entry_to_update = management_entry)
+      published_entry = self.class.client.entry(id)
+      fields.each do |field, value|
+        entry_to_update.send(
+          "#{field.to_s.underscore}=",
+          management_field_value(
+            @changed_fields.include?(field) ? value : published_entry.send(field.to_s.underscore)
+          )
+        )
+      end
+
+      entry_to_update
+    end
+
+    def refetch_management_entry
+      @management_entry = fetch_management_entry
+    end
+
+    def save
+      begin
+        to_management.save
+      rescue Contentful::Management::Conflict
+        # Retries with re-fetched entry
+        to_management(refetch_management_entry).save
+      end
+
+      @dirty = false
+      @changed_fields = []
+
+      self
+    rescue Contentful::Management::Conflict
+      fail ContentfulModel::VersionMismatchError, "Version Mismatch persisting after refetch attempt, use :refetch_management_entry and try again later."
+    end
+
+    def publish
+      begin
+        to_management.publish
+      rescue Contentful::Management::Conflict
+        to_management(refetch_management_entry).save
+      end
+
+      self
+    rescue Contentful::Management::Conflict
+      fail ContentfulModel::VersionMismatchError, "Version Mismatch persisting after refetch attempt, use :refetch_management_entry and try again later."
+    end
+
+    private
+
+    def management_space
+      @management_space ||= self.class.management(default_locale: locale).spaces.find(space.id)
+    end
+
+    def fetch_management_entry
+      management_space.entries.find(id)
+    end
+
+    def management_entry
+      # Fetches always in case of Version changes to avoid Validation errors
+      @management_entry ||= fetch_management_entry
+    end
+
+    def define_setters
+      fields.each do |k, v|
+        if Contentful::Constants::KNOWN_LOCALES.include?(k.to_s)
+          v.keys.each do |name|
+            define_setter(name)
+          end
+        else
+          define_setter(k)
+        end
+      end
+    end
+
+    def define_setter(name)
+      define_singleton_method "#{name.to_s.underscore}=" do |value|
+        @dirty = true
+        @changed_fields << name
+        fields(default_locale)[name] = value
+      end
+    end
+
+    def management_field_value(entry_value)
+      case entry_value
+      when Contentful::Entry
+        Contentful::Management::Entry.hash_with_link_object('Entry', entry_value)
+      when Contentful::Asset
+        Contentful::Management::Entry.hash_with_link_object('Asset', entry_value)
+      when Contentful::Link
+        Contentful::Management::Entry.hash_with_link_object(entry_value.sys[:contentType], entry_value)
+      else
+        entry_value
+      end
+    end
+
+    module ClassMethods
+      def management(options = {})
+        @management ||= ContentfulModel::Management.new(
+          options.merge(default_locale: ContentfulModel.configuration.default_locale)
+        )
+      end
+
+      def create(values = {}, publish = false)
+        entry = management.entries.create(
+          management.content_types.find(
+            ContentfulModel.configuration.space,
+            content_type_id
+          ),
+          values
+        )
+
+        if publish
+          entry.publish
+          entry = self.find(entry.id)
+        end
+
+        entry
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/contentful_model/management.rb

@@ -0,0 +1,7 @@
+module ContentfulModel
+  class Management < Contentful::Management::Client
+    def initialize(options = {})
+      super(ContentfulModel.configuration.management_token, options)
+    end
+  end
+end

data/lib/contentful_model/migrations/content_type.rb

@@ -0,0 +1,127 @@
+module ContentfulModel
+  module Migrations
+    class ContentType
+      def initialize(name = nil, management_content_type = nil)
+        @name = name
+        @management_content_type = management_content_type
+      end
+
+      def save
+        if new?
+          @management_content_type = management.content_types.create(
+            ContentfulModel.configuration.space,
+            name: @name,
+            fields: fields
+          )
+        else
+          @management_content_type.fields = @fields
+          @management_content_type.save
+        end
+
+        self
+      end
+
+      def publish
+        return self if new?
+
+        @management_content_type.publish
+
+        self
+      end
+
+      def field(name, type)
+        name = name.to_s
+        type = type.to_s
+
+        new_field = Contentful::Management::Field.new
+        new_field.id = name.split(' ').map(&:capitalize).join('').underscore
+        new_field.name = name
+        new_field.type = management_type(type)
+        new_field.link_type = management_link_type(type) if link?(type)
+        new_field.items = management_items(type) if array?(type)
+
+        fields << new_field
+
+        new_field
+      end
+
+      def remove_field(field_id)
+        @management_content_type.fields.destroy(field_id)
+      end
+
+      def new?
+        @management_content_type.nil? || @management_content_type.id.nil?
+      end
+
+      def fields
+        if new?
+          return @fields ||= []
+        else
+          return @fields ||= fields_from_management_type
+        end
+      end
+
+      private
+
+      def fields_from_management_type
+        @management_content_type.fields
+      end
+
+      def management_type(type)
+        if [
+          :text, :symbol,
+          :integer, :number,
+          :date, :boolean,
+          :location, :object
+        ].include?(type.to_sym)
+          return type.capitalize
+        elsif type == 'string'
+          return 'Symbol'
+        elsif link?(type)
+          return 'Link'
+        elsif array?(type)
+          return 'Array'
+        else
+          raise_field_type_error(type)
+        end
+      end
+
+      def management_link_type(type)
+        if [:entry_link, :asset_link].include?(type.to_sym)
+          return type.split('_').first.capitalize
+        else
+          raise_field_type_error(type)
+        end
+      end
+
+      def management_items(type)
+        if [:entry_array, :asset_array].include?(type.to_sym)
+          items = Contentful::Management::Field.new
+          items.type = 'Link'
+          items.link_type = type.split('_').first.capitalize
+
+          return items
+        else
+          raise_field_type_error(type)
+        end
+      end
+
+      def link?(type)
+        type.end_with?('_link')
+      end
+
+      def array?(type)
+        type.end_with?('_array')
+      end
+
+      def management
+        @management ||= ContentfulModel::Management.new
+      end
+
+      def raise_field_type_error(type)
+        fail ContentfulModel::Migrations::InvalidFieldTypeError, "`:#{type}' is not a valid Field Type"
+      end
+    end
+  end
+end
+

data/lib/contentful_model/migrations/content_type_factory.rb

@@ -0,0 +1,27 @@
+module ContentfulModel
+  module Migrations
+    module ContentTypeFactory
+      def self.create(name, fields = {}, &block)
+        content_type = ContentfulModel::Migrations::ContentType.new(name)
+
+        yield(content_type) if block_given?
+
+        fields.each do |name, type|
+          content_type.field(name, type)
+        end
+
+        content_type.save
+      end
+
+      def self.find(content_type_id)
+        ContentfulModel::Migrations::ContentType.new(
+          nil,
+          ContentfulModel::Management.new.content_types.find(
+            ContentfulModel.configuration.space,
+            content_type_id
+          )
+        )
+      end
+    end
+  end
+end

data/lib/contentful_model/migrations/errors.rb

@@ -0,0 +1,5 @@
+module ContentfulModel
+  module Migrations
+    class InvalidFieldTypeError < StandardError; end
+  end
+end

data/lib/contentful_model/migrations/migration.rb

@@ -0,0 +1,25 @@
+module ContentfulModel
+  module Migrations
+    module Migration
+      def create_content_type(name, fields = {}, &block)
+        ContentfulModel::Migrations::ContentTypeFactory.create(name, fields, &block)
+      end
+
+      def add_content_type_field(content_type_id, name, type)
+        content_type = ContentfulModel::Migrations::ContentTypeFactory.find(content_type_id)
+
+        content_type.field(name, type)
+
+        content_type.save
+      end
+
+      def remove_content_type_field(content_type_id, field_id)
+        content_type = ContentfulModel::Migrations::ContentTypeFactory.find(content_type_id)
+
+        content_type.remove_field(field_id)
+
+        content_type.save
+      end
+    end
+  end
+end

data/lib/contentful_model/queries.rb

@@ -5,13 +5,12 @@ module ContentfulModel
     end
 
     module ClassMethods
-
       def inherited(subclass)
         instantiate_query(subclass)
       end
 
       def instantiate_query(klass)
-        klass.instance_variable_set(:"@query",ContentfulModel::Query.new(klass))
+        klass.instance_variable_set(:"@query", ContentfulModel::Query.new(klass))
       end
 
       def load
@@ -24,7 +23,6 @@ module ContentfulModel
         @query << {'sys.id' => id}
         load.first
       end
-
     end
   end
 end

data/lib/contentful_model/query.rb

@@ -15,7 +15,7 @@ module ContentfulModel
     end
 
     def execute
-      query = @parameters.merge!(default_parameters)
+      query = @parameters.merge(default_parameters)
       result = client.send(:entries,query)
       return result.to_a.reject {|entity| entity.is_a?(Contentful::Link) || entity.invalid?}
     end
@@ -28,4 +28,4 @@ module ContentfulModel
       @parameters = default_parameters
     end
   end
-end
+end

data/lib/contentful_model/validations/validates_presence_of.rb

@@ -7,12 +7,28 @@ module Contentful
 
       module ClassMethods
         def validates_presence_of(*args)
-          @validations ||= {}
-          @validations[:presence] ||= []
-          @validations[:presence].push(args)
-          @validations[:presence].flatten!
+          @validations ||= []
+          @validations << PresenceValidation.new(args)
         end
       end
     end
+
+    class PresenceValidation
+      attr_reader :fields
+
+      def initialize(fields)
+        @fields = fields
+      end
+
+      def validate(entry)
+        errors = []
+
+        fields.each do |field|
+          errors << "#{field} is required" unless entry.respond_to?(field)
+        end
+
+        errors
+      end
+    end
   end
-end
+end

data/lib/contentful_model/validations/validations.rb

@@ -17,7 +17,7 @@ module ContentfulModel
     end
 
     def validate
-      @errors ||= []
+      @errors = []
       unless self.respond_to?(:fields)
         @errors.push("Entity doesn't respond to the fields() method")
         return false
@@ -25,26 +25,12 @@ module ContentfulModel
 
       validations = self.class.send(:validations)
       unless validations.nil?
-        validations.each do |type, fields|
-          case type
-            # validates_presence_of
-            when :presence
-              fields.each do |field|
-                unless self.respond_to?(field)
-                  @errors << "#{field} is required"
-                end
-              end
-          end
+        validations.each do |validation|
+          @errors += validation.validate(self)
         end
       end
 
-
-      if @errors.empty?
-        return true
-      else
-        return false
-      end
-
+      @errors.empty?
     end
 
     module ClassMethods
@@ -53,4 +39,4 @@ module ContentfulModel
       end
     end
   end
-end
+end

data/lib/contentful_model/version.rb

@@ -1,3 +1,3 @@
 module ContentfulModel
-  VERSION = "0.1.7.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: contentful_model
 version: !ruby/object:Gem::Version
-  version: 0.1.7.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Error Creative Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: contentful-management
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A wrapper around the Contentful gem to give you a base class to inherit
   your models from
 email:
@@ -87,6 +185,12 @@ files:
 - lib/contentful_model/chainable_queries.rb
 - lib/contentful_model/client.rb
 - lib/contentful_model/errors.rb
+- lib/contentful_model/manageable.rb
+- lib/contentful_model/management.rb
+- lib/contentful_model/migrations/content_type.rb
+- lib/contentful_model/migrations/content_type_factory.rb
+- lib/contentful_model/migrations/errors.rb
+- lib/contentful_model/migrations/migration.rb
 - lib/contentful_model/queries.rb
 - lib/contentful_model/query.rb
 - lib/contentful_model/validations/validates_presence_of.rb
@@ -113,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A thin wrapper for Contentful gem