contentful_model 0.2.0 → 1.0.0

data/lib/contentful_model/validations/lambda_validation.rb

@@ -0,0 +1,17 @@
+module Contentful
+  module Validations
+    # Class to define lambda validations
+    class LambdaValidation
+      def initialize(name, fn)
+        @name = name
+        fail "#{name}: Validator function or Proc is required" unless fn.is_a?(Proc)
+        @validator = fn
+      end
+
+      def validate(entry)
+        return ["#{@name}: validation not met"] unless @validator[entry]
+        []
+      end
+    end
+  end
+end

data/lib/contentful_model/validations/validates_presence_of.rb

@@ -1,10 +1,12 @@
 module Contentful
   module Validations
+    # Module to check presence of a field
     module PresenceOf
       def self.included(base)
         base.extend(ClassMethods)
       end
 
+      # Class method
       module ClassMethods
         def validates_presence_of(*args)
           @validations ||= []
@@ -13,6 +15,7 @@ module Contentful
       end
     end
 
+    # Actual validation
     class PresenceValidation
       attr_reader :fields
 
@@ -24,7 +27,7 @@ module Contentful
         errors = []
 
         fields.each do |field|
-          errors << "#{field} is required" unless entry.respond_to?(field)
+          errors << "#{field} is required" unless entry.respond_to?(field) && entry.public_send(field).present?
         end
 
         errors

data/lib/contentful_model/validations/validations.rb

@@ -1,6 +1,10 @@
+require_relative 'validates_presence_of'
+require_relative 'lambda_validation'
+
 # A module to validate entries. A little like ActiveRecord. We don't think this should be necessary, really,
 # because Contentful should be doing the validating, but they expose invalid entries through the preview API.
 module ContentfulModel
+  # Defines general validation methods
   module Validations
     def self.included(base)
       base.extend ClassMethods
@@ -8,23 +12,28 @@ module ContentfulModel
       attr_reader :errors
     end
 
-    def valid?
-      validate
+    def valid?(save = false)
+      validate(save)
     end
 
-    def invalid?
-      !valid?
+    def invalid?(save = false)
+      !valid?(save)
     end
 
-    def validate
+    def validate(save = false)
       @errors = []
-      unless self.respond_to?(:fields)
+      unless respond_to?(:fields)
         @errors.push("Entity doesn't respond to the fields() method")
         return false
       end
 
-      validations = self.class.send(:validations)
-      unless validations.nil?
+      validation_kinds = [:validations]
+      validation_kinds << :save_validations if save
+
+      validation_kinds.each do |validation_kind|
+        validations = self.class.send(validation_kind)
+        next if validations.nil?
+
         validations.each do |validation|
           @errors += validation.validate(self)
         end
@@ -33,10 +42,49 @@ module ContentfulModel
       @errors.empty?
     end
 
+    # Class methods for Validations
     module ClassMethods
       def validations
         @validations
       end
+
+      def save_validations
+        @save_validations
+      end
+
+      def validate_with(validation, on_load: false)
+        if validation.is_a?(Class)
+          validation = validation.new
+        elsif validation.respond_to?(:validate)
+          validation = validation
+        else
+          fail '::validate_with requires a Class or object that responds to #validate(entry)'
+        end
+
+        if on_load
+          @validations ||= []
+          @validations << validation
+        else
+          @save_validations ||= []
+          @save_validations << validation
+        end
+      end
+
+      def validate(name, fn = nil, on_load: false, &block)
+        vs = []
+        fail '::validate requires either a function or a block sent as a validation' if fn.nil? && block.nil?
+
+        vs << ::Contentful::Validations::LambdaValidation.new(name, fn) unless fn.nil?
+        vs << ::Contentful::Validations::LambdaValidation.new(name, block) unless block.nil?
+
+        if on_load
+          @validations ||= []
+          @validations += vs
+        else
+          @save_validations ||= []
+          @save_validations += vs
+        end
+      end
     end
   end
 end

data/lib/contentful_model/version.rb

@@ -1,3 +1,3 @@
 module ContentfulModel
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'.freeze
 end

data/spec/asset_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe ContentfulModel::Asset do
+  before :each do
+    ContentfulModel.configure do |config|
+      config.space = 'cfexampleapi'
+      config.access_token = 'b4c0n73n7fu1'
+    end
+  end
+
+  describe 'class methods' do
+    it '.all' do
+      vcr('asset/all') {
+        assets = described_class.all
+        expect(assets).to be_a ::Contentful::Array
+        expect(assets.first).to be_a described_class
+        expect(assets.first.id).to eq 'nyancat'
+      }
+    end
+
+    it '.find' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        expect(asset).to be_a described_class
+        expect(asset.id).to eq 'nyancat'
+      }
+    end
+  end
+
+  describe 'queries' do
+    it '#resize' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.resize(10, 20).load
+
+        expect(url).to include('w=10')
+        expect(url).to include('h=20')
+      }
+    end
+
+    it '#width' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.width(20).load
+
+        expect(url).to include('w=20')
+      }
+    end
+
+    it '#height' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.height(10).load
+
+        expect(url).to include('h=10')
+      }
+    end
+
+    it '#format' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.format('jpg').load
+
+        expect(url).to include('fm=jpg')
+      }
+    end
+
+    it '#jpeg_quality' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.jpeg_quality(80).load
+
+        expect(url).to include('fm=jpg')
+        expect(url).to include('q=80')
+      }
+    end
+
+    it '#png_8bit' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.png_8bit.load
+
+        expect(url).to include('fm=png')
+        expect(url).to include('fl=png8')
+      }
+    end
+
+    it '#resize_behavior' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.resize_behavior('thumb').load
+
+        expect(url).to include('fit=thumb')
+      }
+    end
+
+    it '#thumbnail_focused_on' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.thumbnail_focused_on('face').load
+
+        expect(url).to include('fit=thumb')
+        expect(url).to include('f=face')
+      }
+    end
+
+    it '#rounded_corners' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.rounded_corners(20).load
+
+        expect(url).to include('r=20')
+      }
+    end
+
+    it '#padded_background_color' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.padded_background_color('rgb:ffffff').load
+
+        expect(url).to include('fit=pad')
+        expect(url).to include('bg=rgb%3Affffff') # '%3A' is the urlencoded hexcode for ':'
+      }
+    end
+
+    it 'chaining' do
+      vcr('asset/find') {
+        asset = described_class.find('nyancat')
+        url = asset.resize(10, 20).rounded_corners(30).png_8bit.thumbnail_focused_on('face').load
+
+        expect(url).to include('w=10')
+        expect(url).to include('h=20')
+        expect(url).to include('r=30')
+        expect(url).to include('fm=png')
+        expect(url).to include('fl=png8')
+        expect(url).to include('fit=thumb')
+        expect(url).to include('f=face')
+      }
+    end
+  end
+end

data/spec/associations/belongs_to_many_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class BelongsToManyParent < ContentfulModel::Base
+  self.content_type_id = 'belongsToManyParent'
+
+  has_many :children, class_name: 'BelongsToManyChild'
+end
+
+class BelongsToManyChild < ContentfulModel::Base
+  self.content_type_id = 'belongsToManyChild'
+
+  belongs_to_many :parents, inverse_of: :children, class_name: 'BelongsToManyParent'
+end
+
+describe ContentfulModel::Associations::BelongsToMany do
+  before :each do
+    ContentfulModel.configure do |c|
+      c.space = 'a22o2qgm356c'
+      c.access_token = '60229df5876f14f499870d0d26f37b1323764ed637289353a5f74a5ea190c214'
+      c.entry_mapping = {}
+    end
+
+    BelongsToManyParent.add_entry_mapping
+    BelongsToManyChild.add_entry_mapping
+  end
+
+  it 'defines reverse relationship' do
+    vcr('association/belongs_to_many') {
+      child = BelongsToManyChild.first
+      expect(child.name).to eq 'BelongsToMany - Child'
+
+      expect(child.parents).to be_a ::Array
+      expect(child.parents.size).to eq 2
+      expect(child.parents.first).to be_a BelongsToManyParent
+      expect(child.parents.first.name).to eq 'BelongsToMany - Parent 1'
+    }
+  end
+end

data/spec/associations/belongs_to_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ContentfulModel::Associations::BelongsTo do
+  before :each do
+    ContentfulModel.configure do |c|
+      c.default_locale = 'en-US'
+      c.access_token = '4d0f55d940975f78139daae5d965b463c0816e88ad16062d2c1ee3d6cb930521'
+      c.space = 'facgnwwgj5fe'
+      c.entry_mapping = {}
+    end
+  end
+
+  it 'is not implemented - on purpose' do
+    expect {
+      class BelongsToCat < ContentfulModel::Base
+        self.content_type_id = 'cat'
+
+        belongs_to :best_friend, class: Cat
+      end
+    }.to raise_error "Contentful doesn't have a singular belongs_to relationship. Use belongs_to_many instead."
+  end
+end

data/spec/associations/has_many_nested_spec.rb

@@ -0,0 +1,321 @@
+require 'spec_helper'
+
+class Nested < ContentfulModel::Base
+  self.content_type_id = 'nested'
+
+  has_many_nested :related
+end
+
+class RootNested < ContentfulModel::Base
+  self.content_type_id = 'rootNested'
+
+  has_many_nested :related, root: -> { RootNested.find('4UnXECdw6AAwyeCUcIuqCy') }
+end
+
+describe ContentfulModel::Associations::HasManyNested do
+  before :each do
+    ContentfulModel.configure do |c|
+      c.space = 'a22o2qgm356c'
+      c.access_token = '60229df5876f14f499870d0d26f37b1323764ed637289353a5f74a5ea190c214'
+      c.entry_mapping = {}
+    end
+
+    Nested.add_entry_mapping
+    RootNested.add_entry_mapping
+  end
+
+  context 'without root' do
+    context 'only has children' do
+      it 'parent is nil' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+          expect(nested.parent).to be_nil
+        }
+      end
+
+      it 'has children' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+
+          expect(nested.children?).to be_truthy
+          expect(nested.children).to be_a ::Array
+          expect(nested.children.size).to eq 1
+          expect(nested.children.first).to be_a Nested
+          expect(nested.children.first.name).to eq 'Nested 2'
+        }
+      end
+
+      it 'is the root' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+          expect(nested.root?).to be_truthy
+          expect(nested.root).to eq nested
+        }
+      end
+
+      it 'has no ancestors' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+          expect(nested.ancestors).to be_empty
+        }
+      end
+
+      it 'find ancestors will return self - if passed a block and no ancestors are found' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+          expect(nested.find_ancestors { |a| a }).to eq nested
+        }
+      end
+
+      it 'find ancestors will be an empty array - if no ancestors and found and no block given' do
+        vcr('association/nested_without_root_parentless') {
+          nested = Nested.find('5CNbxcca5OwgI68eSuWso2')
+          expect(nested.find_ancestors.to_a).to eq []
+        }
+      end
+
+      it 'creates a tree of children relationships' do
+        vcr('association/nested_without_root_parentless_higher_include') {
+          nested = Nested.query.params('sys.id' => '5CNbxcca5OwgI68eSuWso2', include: 3).load.first
+          child_1 = nested.children.first
+          child_2 = child_1.children.first
+          expect(nested.nested_children).not_to be_empty
+          expect(nested.nested_children).to eq(
+            child_1 => {
+              child_2 => nil
+            }
+          )
+        }
+      end
+
+      it 'creates a tree of children by field' do
+        vcr('association/nested_without_root_parentless_higher_include') {
+          nested = Nested.query.params('sys.id' => '5CNbxcca5OwgI68eSuWso2', include: 3).load.first
+          child_1 = nested.children.first
+          child_2 = child_1.children.first
+          expect(nested.nested_children_by(:name)).not_to be_empty
+          expect(nested.nested_children_by(:name)).to eq(
+            child_1.name => {
+              child_2.name => nil
+            }
+          )
+        }
+      end
+
+      it 'generates flattened structures to use as paths for entries' do
+        vcr('association/nested_without_root_parentless_higher_include') {
+          nested = Nested.query.params('sys.id' => '5CNbxcca5OwgI68eSuWso2', include: 3).load.first
+          child_1 = nested.children.first
+          child_2 = child_1.children.first
+          expect(nested.all_child_paths_by(:name)).not_to be_empty
+          expect(nested.all_child_paths_by(:id)).to eq [[child_1.id, child_2.id]]
+        }
+      end
+
+      it 'generates a path for entries that match a value' do
+        vcr('association/nested_without_root_parentless_higher_include') {
+          nested = Nested.query.params('sys.id' => '5CNbxcca5OwgI68eSuWso2', include: 3).load.first
+          child_1 = nested.children.first
+          child_2 = child_1.children.first
+          expect(nested.find_child_path_by(:name, child_2.name)).not_to be_empty
+          expect(nested.find_child_path_by(:name, child_2.name)).to eq [[child_1.name, child_2.name]]
+
+          expect(nested.find_child_path_by(:name, 'foo')).to be_empty
+        }
+      end
+    end
+
+    context 'has parent and child' do
+      it 'parent exists' do
+        vcr('association/nested_without_root_middle') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+          expect(nested.parent).to be_a Nested
+          expect(nested.parent.name).to eq 'Nested 1'
+        }
+      end
+
+      it 'has children' do
+        vcr('association/nested_without_root_middle') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+
+          expect(nested.children?).to be_truthy
+          expect(nested.children).to be_a ::Array
+          expect(nested.children.size).to eq 1
+          expect(nested.children.first).to be_a Nested
+          expect(nested.children.first.name).to eq 'Nested 3'
+        }
+      end
+
+      it 'is not the root' do
+        vcr('association/nested_without_root_middle_parent') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+          expect(nested.root?).to be_falsey
+          expect(nested.root).to eq nested.parent
+        }
+      end
+
+      it 'has ancestors' do
+        vcr('association/nested_without_root_middle_parent') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+          expect(nested.ancestors).not_to be_empty
+          expect(nested.ancestors.size).to eq 1
+          expect(nested.ancestors.first.name).to eq 'Nested 1'
+        }
+      end
+
+      it 'find ancestors will return an enumerator of ancestors - if no block given' do
+        vcr('association/nested_without_root_middle_parent') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+          expect(nested.find_ancestors.to_a.map(&:name)).to eq ['Nested 1']
+        }
+      end
+
+      it 'find ancestors executes the block for each ancestor - if block given' do
+        vcr('association/nested_without_root_middle_parent') {
+          nested = Nested.find('3gpECMvSLSOC8wgkQ6GQ2q')
+
+          ancestor_names = []
+          nested.find_ancestors { |a| ancestor_names << a.name }
+
+          expect(ancestor_names).to eq ['Nested 1']
+        }
+      end
+
+      it 'creates a tree of children relationships' do
+        vcr('association/nested_without_root_middle_higher_include') {
+          nested = Nested.query.params('sys.id' => '3gpECMvSLSOC8wgkQ6GQ2q', include: 3).load.first
+          child_1 = nested.children.first
+          expect(nested.nested_children).not_to be_empty
+          expect(nested.nested_children).to eq(
+            child_1 => nil
+          )
+        }
+      end
+
+      it 'creates a tree of children by field' do
+        vcr('association/nested_without_root_middle_higher_include') {
+          nested = Nested.query.params('sys.id' => '3gpECMvSLSOC8wgkQ6GQ2q', include: 3).load.first
+          child_1 = nested.children.first
+          expect(nested.nested_children_by(:name)).not_to be_empty
+          expect(nested.nested_children_by(:name)).to eq(
+            child_1.name => nil
+          )
+        }
+      end
+
+      it 'generates flattened structures to use as paths for entries' do
+        vcr('association/nested_without_root_middle_higher_include') {
+          nested = Nested.query.params('sys.id' => '3gpECMvSLSOC8wgkQ6GQ2q', include: 3).load.first
+          child_1 = nested.children.first
+          expect(nested.all_child_paths_by(:name)).not_to be_empty
+          expect(nested.all_child_paths_by(:id)).to eq [[child_1.id]]
+        }
+      end
+
+      it 'generates a path for entries that match a value' do
+        vcr('association/nested_without_root_middle_higher_include') {
+          nested = Nested.query.params('sys.id' => '3gpECMvSLSOC8wgkQ6GQ2q', include: 3).load.first
+          child_1 = nested.children.first
+          expect(nested.find_child_path_by(:name, child_1.name)).not_to be_empty
+          expect(nested.find_child_path_by(:name, child_1.name)).to eq [[child_1.name]]
+
+          expect(nested.find_child_path_by(:name, 'foo')).to be_empty
+        }
+      end
+    end
+
+    context 'only has parent' do
+      it 'parent exists' do
+        vcr('association/nested_without_root_childless') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+          expect(nested.parent).to be_a Nested
+          expect(nested.parent.name).to eq 'Nested 2'
+        }
+      end
+
+      it 'has no children' do
+        vcr('association/nested_without_root_childless') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+
+          expect(nested.children?).to be_falsey
+          expect(nested.children).to be_a ::Array
+          expect(nested.children.size).to eq 0
+        }
+      end
+
+      it 'is not the root' do
+        vcr('association/nested_without_root_childless') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+          expect(nested.root?).to be_falsey
+          expect(nested.root.name).to eq 'Nested 1'
+        }
+      end
+
+      it 'has ancestors' do
+        vcr('association/nested_without_root_childless') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+          expect(nested.ancestors).not_to be_empty
+          expect(nested.ancestors.size).to eq 2
+        }
+      end
+
+      it 'find ancestors will return an enumerator of ancestors - if no block given' do
+        vcr('association/nested_without_root_child_parent') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+          expect(nested.find_ancestors.to_a.map(&:name)).to eq ['Nested 2', 'Nested 1']
+        }
+      end
+
+      it 'find ancestors executes the block for each ancestor - if block given' do
+        vcr('association/nested_without_root_child_parent') {
+          nested = Nested.find('2pFubMJuVqMSisGeCmoqem')
+
+          ancestor_names = []
+          nested.find_ancestors { |a| ancestor_names << a.name }
+
+          expect(ancestor_names).to eq ['Nested 2', 'Nested 1']
+        }
+      end
+
+      it 'creates a tree of children relationships' do
+        vcr('association/nested_without_root_child_higher_include') {
+          nested = Nested.query.params('sys.id' => '2pFubMJuVqMSisGeCmoqem', include: 3).load.first
+          expect(nested.nested_children).to be_empty
+        }
+      end
+
+      it 'creates a tree of children by field' do
+        vcr('association/nested_without_root_child_higher_include') {
+          nested = Nested.query.params('sys.id' => '2pFubMJuVqMSisGeCmoqem', include: 3).load.first
+          expect(nested.nested_children_by(:name)).to be_empty
+        }
+      end
+
+      it 'generates flattened structures to use as paths for entries' do
+        vcr('association/nested_without_root_child_higher_include') {
+          nested = Nested.query.params('sys.id' => '2pFubMJuVqMSisGeCmoqem', include: 3).load.first
+          expect(nested.all_child_paths_by(:name)).to be_empty
+        }
+      end
+
+      it 'generates a path for entries that match a value' do
+        vcr('association/nested_without_root_child_higher_include') {
+          nested = Nested.query.params('sys.id' => '2pFubMJuVqMSisGeCmoqem', include: 3).load.first
+          expect(nested.find_child_path_by(:name, 'foo')).to be_empty
+        }
+      end
+    end
+  end
+
+  context 'with root' do
+    it 'has root method defined' do
+      vcr('association/nested_with_root_root') {
+        non_root_id = '5sdA4Fv5o4SOeyq4Sq8qmG'
+        root_nested = RootNested.find(non_root_id)
+
+        expect(root_nested.name).to eq 'RootNested - 1'
+        expect(root_nested.root_root_nested.name).to eq 'RootNested - Root'
+      }
+    end
+  end
+end