ruby-trello 2.2.0 → 3.1.0

data/spec/unit/trello/schema/attribute/base_spec.rb

@@ -0,0 +1,349 @@
+require 'spec_helper'
+
+RSpec.describe 'Trello::Schema::Attribute::Base' do
+
+  let(:attribute) { Trello::Schema::Attribute::Base.new(name: name, options: options, serializer: serializer) }
+
+  describe '#name' do
+    let(:options) { nil }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when name is a symbol' do
+      let(:name) { :name }
+
+      it 'directly return the name' do
+        expect(attribute.name).to eq(:name)
+      end
+    end
+
+    context 'when name is a string' do
+      let(:name) { 'name' }
+
+      it 'directly return the symbolize name' do
+        expect(attribute.name).to eq(:name)
+      end
+    end
+  end
+
+  describe '#primary_key?' do
+    let(:name) { :name }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when explict pass primary_key' do
+      let(:options) { { primary_key: true } }
+
+      it 'direct return the primary_key value' do
+        expect(attribute.primary_key?).to eq(true)
+      end
+    end
+
+    context 'when does not explict pass primary_key' do
+      let(:options) { nil }
+
+      it 'return false' do
+        expect(attribute.primary_key?).to eq(false)
+      end
+    end
+  end
+
+  describe '#readlonly?' do
+    let(:name) { :name }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when does not explict pass readonly parameter' do
+      let(:options) { nil }
+
+      it 'return false' do
+        expect(attribute.readonly?).to eq(false)
+      end
+    end
+
+    context 'when does explict pass readonly parameter' do
+      context 'and readonly is true' do
+        let(:options) { { readonly: true } }
+
+        it 'return true' do
+          expect(attribute.readonly?).to eq(true)
+        end
+      end
+
+      context 'and readonly is false' do
+        let(:options) { { readonly: false } }
+
+        it 'return false' do
+          expect(attribute.readonly?).to eq(false)
+        end
+      end
+
+      context 'and readonly is not a boolean' do
+        let(:options) { { readonly: 'other' } }
+
+        it 'return false' do
+          expect(attribute.readonly?).to eq(false)
+        end
+      end
+    end
+  end
+
+  describe '#update_only?' do
+    let(:name) { :name }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when does not explict pass update_only parameter' do
+      let(:options) { nil }
+
+      it 'return false' do
+        expect(attribute.update_only?).to eq(false)
+      end
+    end
+
+    context 'when does explict pass update_only parameter' do
+      context 'and update_only is true' do
+        let(:options) { { update_only: true } }
+
+        it 'return true' do
+          expect(attribute.update_only?).to eq(true)
+        end
+      end
+
+      context 'and update_only is false' do
+        let(:options) { { update_only: false } }
+
+        it 'return false' do
+          expect(attribute.update_only?).to eq(false)
+        end
+      end
+
+      context 'and update_only is not a boolean' do
+        let(:options) { { update_only: 'other' } }
+
+        it 'return false' do
+          expect(attribute.update_only?).to eq(false)
+        end
+      end
+    end
+  end
+
+  describe '#create_only?' do
+    let(:name) { :name }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when does not explict pass create_only parameter' do
+      let(:options) { nil }
+
+      it 'return false' do
+        expect(attribute.create_only?).to eq(false)
+      end
+    end
+
+    context 'when does explict pass create_only parameter' do
+      context 'and create_only is true' do
+        let(:options) { { create_only: true } }
+
+        it 'return true' do
+          expect(attribute.create_only?).to eq(true)
+        end
+      end
+
+      context 'and create_only is false' do
+        let(:options) { { create_only: false } }
+
+        it 'return false' do
+          expect(attribute.create_only?).to eq(false)
+        end
+      end
+
+      context 'and create_only is not a boolean' do
+        let(:options) { { create_only: 'other' } }
+
+        it 'return false' do
+          expect(attribute.create_only?).to eq(false)
+        end
+      end
+    end
+  end
+
+  describe '#for_action?' do
+    let(:name) { :name }
+    let(:serializer) { Trello::Schema::Serializer::Default }
+
+    context 'when it is a primary_key' do
+      let(:options) { { primary_key: true } }
+
+      context 'pass in :create' do
+        it 'return false' do
+          expect(attribute.for_action?(:create)).to eq(false)
+        end
+      end
+
+      context 'pass in :update' do
+        it 'return true' do
+          expect(attribute.for_action?(:update)).to eq(true)
+        end
+      end
+    end
+
+    context 'when it is a update_only attribute' do
+      let(:options) { { update_only: true } }
+
+      context 'pass in :create' do
+        it 'return false' do
+          expect(attribute.for_action?(:create)).to eq(false)
+        end
+      end
+
+      context 'pass in :update' do
+        it 'return true' do
+          expect(attribute.for_action?(:update)).to eq(true)
+        end
+      end
+    end
+
+    context 'when it is a create_only attribute' do
+      let(:options) { { create_only: true } }
+
+      context 'pass in :create' do
+        it 'return true' do
+          expect(attribute.for_action?(:create)).to eq(true)
+        end
+      end
+
+      context 'pass in :update' do
+        it 'return false' do
+          expect(attribute.for_action?(:update)).to eq(false)
+        end
+      end
+    end
+
+    context 'when it is a readonly attribute' do
+      context 'and it is a primary_key' do
+        let(:options) { { readonly: true, primary_key: true } }
+
+        context 'pass in :create' do
+          it 'return false' do
+            expect(attribute.for_action?(:create)).to eq(false)
+          end
+        end
+
+        context 'pass in :update' do
+          it 'return true' do
+            expect(attribute.for_action?(:update)).to eq(true)
+          end
+        end
+      end
+
+      context 'and it is not a primary_key' do
+        let(:options) { { readonly: true } }
+
+        context 'pass in :create' do
+          it 'return false' do
+            expect(attribute.for_action?(:create)).to eq(false)
+          end
+        end
+
+        context 'pass in :update' do
+          it 'return false' do
+            expect(attribute.for_action?(:update)).to eq(false)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#remote_key' do
+    let(:name) { :date_create_utc }
+    let(:serializer) { double('serializer') }
+
+    context 'when explict pass in remote_key' do
+      context 'and remote_key is a string' do
+        let(:options) { { remote_key: 'dateCreateUTC' } }
+
+        it 'directly return the stringify remote_key' do
+          expect(attribute.remote_key).to eq('dateCreateUTC')
+        end
+      end
+
+      context 'and remote_key is a symbol' do
+        let(:options) { { remote_key: :dateCreateUTC } }
+
+        it 'directly return the stringify remote_key' do
+          expect(attribute.remote_key).to eq('dateCreateUTC')
+        end
+      end
+    end
+
+    context 'when does not explict pass in remote_key' do
+      let(:options) { {} }
+
+      it 'return the stringify name' do
+        expect(attribute.remote_key).to eq('date_create_utc')
+      end
+    end
+  end
+
+  describe '#default' do
+    let(:name) { :closed }
+    let(:serializer) { double('serializer') }
+
+    context 'when explicit pass in default' do
+      let(:options) { { default: false } }
+
+      it 'directly return the default value' do
+        expect(attribute.default).to eq(false)
+      end
+    end
+
+    context 'when does not explict pass in default' do
+      let(:options) { {} }
+
+      it 'return nil' do
+        expect(attribute.default).to eq(nil)
+      end
+    end
+  end
+
+  describe '#build_attributes' do
+    let(:name) { :date_create_utc }
+    let(:serializer) { double('serializer') }
+    let(:options) { nil }
+
+    it 'will raise exception' do
+      expect{ attribute.build_attributes({}, {}) }.to raise_error('Need override')
+    end
+  end
+
+  describe '#build_payload_for_create' do
+    let(:name) { :date_create_utc }
+    let(:serializer) { double('serializer') }
+    let(:options) { nil }
+
+    it 'will raise exception' do
+      expect{ attribute.build_payload_for_create({}, {}) }.to raise_error('Need override')
+    end
+  end
+
+  describe '#build_payload_for_update' do
+    let(:name) { :date_create_utc }
+    let(:serializer) { double('serializer') }
+    let(:options) { nil }
+
+    it 'will raise exception' do
+      expect{ attribute.build_payload_for_update({}, {}) }.to raise_error('Need override')
+    end
+  end
+
+  describe '#register' do
+    let(:name) { :date_create_utc }
+    let(:serializer) { double('serializer') }
+    let(:options) { nil }
+
+    let(:board_klass) { double('Trello::Board') }
+
+    it 'call register on AttributeRegistration' do
+      expect(Trello::Schema::AttributeRegistration).to receive(:register).with(board_klass, attribute)
+
+      attribute.register(board_klass)
+    end
+  end
+
+end

data/spec/unit/trello/schema/attribute/board_pref_spec.rb

@@ -0,0 +1,208 @@
+
+require 'spec_helper'
+
+RSpec.describe 'Trello::Schema::Attribute::BoardPref' do
+
+  let(:attribute) { Trello::Schema::Attribute::BoardPref.new(name: name, options: options, serializer: serializer) }
+
+  describe '#build_attributes' do
+    let(:name) { :visibility_level }
+    let(:options) { { remote_key: :permissionLevel } }
+    let(:serializer) { double('serializer') }
+    let(:default) { nil }
+
+    before do
+      allow(serializer)
+        .to receive(:deserialize)
+        .with(raw_value, default)
+        .and_return(deserialize_result)
+    end
+
+    let(:build_attributes) { attribute.build_attributes(params, attributes) }
+    let(:attributes) { { name: 'John' } }
+
+    context 'when prefs and name key are both missing' do
+      let(:raw_value) { nil }
+      let(:deserialize_result) { nil }
+      let(:params) { {} }
+
+      it 'deserialize and set the attribute to nil' do
+        expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: nil })
+      end
+    end
+
+    context "when params's key prefs exits" do
+      context 'and target key is missing' do
+        let(:raw_value) { nil }
+        let(:deserialize_result) { nil }
+        let(:params) { { 'prefs' => {} } }
+
+        it 'deserialize and set the attribute to nil' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: nil })
+        end
+      end
+
+      context 'and target value is nil' do
+        let(:raw_value) { nil }
+        let(:deserialize_result) { nil }
+        let(:params) { { 'prefs' => { 'permissionLevel' => nil } } }
+
+        it 'deserialize and set the attribute to nil' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: nil })
+        end
+      end
+
+      context 'and target value is false' do
+        let(:raw_value) { false }
+        let(:deserialize_result) { false }
+        let(:params) { { 'prefs' => { 'permissionLevel' => false } } }
+
+        it 'deserialize and set the attribute to false' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: false })
+        end
+      end
+
+      context 'and target value is not nil or false' do
+        let(:raw_value) { 'org' }
+        let(:deserialize_result) { 'org' }
+        let(:params) { { 'prefs' => { 'permissionLevel' => 'org' } } }
+
+        it 'deserialize and set the attribute' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: 'org' })
+        end
+      end
+    end
+
+    context "when params's key prefs does not exits" do
+      context 'and target value is nil' do
+        let(:raw_value) { nil }
+        let(:deserialize_result) { nil }
+        let(:params) { { visibility_level: nil } }
+
+        it 'get and deserialize that value and set to attributes with symbolize name' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: nil })
+        end
+      end
+
+      context 'and target value is false' do
+        let(:raw_value) { false }
+        let(:deserialize_result) { false }
+        let(:params) { { visibility_level: false } }
+
+        it 'get and deserialize that value and set to attributes with symbolize name' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: false })
+        end
+      end
+
+      context 'and target value is not nil or false ' do
+        let(:raw_value) { 'org' }
+        let(:deserialize_result) { 'org' }
+        let(:params) { { visibility_level: 'org' } }
+
+        it 'get and deserialize that value and set to attributes with symbolize name' do
+          expect(build_attributes).to match_hash_with_indifferent_access({ name: 'John', visibility_level: 'org' })
+        end
+      end
+    end
+  end
+
+  describe '#build_payload_for_create' do
+    let(:name) { :visibility_level }
+    let(:options) { { remote_key: :permissionLevel } }
+    let(:serializer) { double('serializer') }
+    let(:default) { nil }
+
+    before do
+      allow(serializer)
+        .to receive(:serialize)
+        .with('org')
+        .and_return('org')
+    end
+
+    let(:build_attributes) { attribute.build_payload_for_create(attributes, payload) }
+    let(:payload) { { 'name' => 'John' } }
+
+
+    context 'when attribute is for action create' do
+
+      context 'when attribute value is nil' do
+        let(:attributes) { { visibility_level: nil } }
+
+        it "won't put it in payload" do
+          expect(build_attributes).to eq({ 'name' => 'John' })
+        end
+      end
+
+      context 'when attributes does not contain the attribute key' do
+        let(:attributes) { {} }
+
+        it "won't put it in payload" do
+          expect(build_attributes).to eq({ 'name' => 'John' })
+        end
+      end
+
+      context 'when attribute value is normal' do
+        let(:attributes) { { visibility_level: 'org' } }
+
+        it 'get and serialize that value and set to payload with stringify name' do
+          expect(build_attributes).to eq({ 'name' => 'John', 'prefs_permissionLevel' => 'org' })
+        end
+      end
+    end
+
+    context 'when attribute is not for action create' do
+      let(:options) { { remote_key: :permissionLevel, update_only: true } }
+      let(:attributes) { { visibility_level: 'org' } }
+
+      it "won't put it in payload" do
+        expect(build_attributes).to eq({ 'name' => 'John' })
+      end
+    end
+  end
+
+  describe '#build_payload_for_update' do
+    let(:name) { :visibility_level }
+    let(:serializer) { double('serializer') }
+    let(:default) { nil }
+
+    before do
+      allow(serializer)
+        .to receive(:serialize)
+        .with('org')
+        .and_return('org')
+    end
+
+    let(:build_attributes) { attribute.build_payload_for_update(attributes, payload) }
+    let(:payload) { { 'name' => 'John' } }
+
+    context 'when attribute is for action create' do
+      let(:options) { { remote_key: :permissionLevel } }
+
+      context 'when attributes does not contain the attribute key' do
+        let(:attributes) { {} }
+
+        it "won't put it in payload" do
+          expect(build_attributes).to eq({ 'name' => 'John' })
+        end
+      end
+
+      context 'when attribute value is normal' do
+        let(:attributes) { { visibility_level: 'org' } }
+
+        it 'get and serialize that value and set to payload with stringify name' do
+          expect(build_attributes).to eq({ 'name' => 'John', 'prefs/permissionLevel' => 'org' })
+        end
+      end
+    end
+
+    context 'when attribute is not for action update' do
+      let(:options) { { remote_key: :permissionLevel, create_only: true } }
+      let(:attributes) { { visibility_level: 'org' } }
+
+      it "won't put it in payload" do
+        expect(build_attributes).to eq({ 'name' => 'John' })
+      end
+    end
+  end
+
+end