elasticord 1.0.0

data/spec/elasticord/base_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+require 'elasticsearch'
+
+describe Elasticord::Base, elasticsearch: true do
+  def elastic_search_client
+    @elastic_search_client ||= Elasticsearch::Client.new
+  end
+
+  describe '.index' do
+    it 'described_class should return the current env' do
+      expect(described_class.index).to eq ENV['ENV']
+    end
+
+    context 'given a child class' do
+      ChildClass1 = Class.new(described_class)
+
+      it 'ChildClass1 should return the same current env' do
+        expect(ChildClass1.index).to eq ENV['ENV']
+      end
+
+      context 'given that the child class sets a new index' do
+        before { ChildClass1.index = 'child_class_new_index' }
+
+        it 'described_class should return the current env' do
+          expect(described_class.index).to eq ENV['ENV']
+        end
+
+        it 'ChildClass1 should return child_class_new_index' do
+          expect(ChildClass1.index).to eq 'child_class_new_index'
+        end
+      end
+    end
+  end
+
+  describe '.type' do
+    it 'described_class should return _all' do
+      expect(described_class.type).to eq '_all'
+    end
+
+    context 'given a child class' do
+      ChildClass2 = Class.new(described_class)
+
+      it 'ChildClass2 should return child_class2' do
+        expect(ChildClass2.type).to eq 'child_class2'
+      end
+    end
+  end
+
+  describe '.create' do
+    ChildClass3 = Class.new(described_class)
+
+    def get_one(id)
+      result = elastic_search_client.get \
+        index: ChildClass3.index, type: ChildClass3.type, ignore: 404, id: id
+
+      result
+    end
+
+    context 'Given an id' do
+      let(:id) { '123' }
+
+      before do
+        @child_class = ChildClass3.create id: id, title: 'child class'
+      end
+
+      it 'ElasticSearch should contain a record with that specific id' do
+        result = get_one id
+
+        expect(result['found']).to be true
+      end
+
+      it '@child_class.id should match' do
+        expect(@child_class.id).to eq id
+      end
+
+      it '@child_class should be an instance of ChildClass3' do
+        expect(@child_class).to be_an_instance_of ChildClass3
+      end
+    end
+
+    context 'Given no id' do
+      before do
+        @child_class = ChildClass3.create title: 'child class'
+      end
+
+      it 'ElasticSearch should contain a record with that specific id' do
+        result = get_one @child_class.id
+
+        expect(result['found']).to be true
+      end
+    end
+  end
+
+  describe '.search' do
+    ChildClass4 = Class.new(described_class)
+
+    context 'Given that no record has been created' do
+      before do
+        ChildClass4.delete_all
+        ChildClass4.refresh_index
+
+        @search_result = ChildClass4.search({})
+      end
+
+      it 'should return a hash with total_results: 0 and an empty data' do
+        expect(@search_result).to match a_hash_including({
+          data: [],
+          total_results: 0
+        })
+      end
+    end
+
+    context 'Given that 5 recrod have been created' do
+      before do
+        ChildClass4.delete_all
+        5.times { ChildClass4.create(title: 'child class')  }
+        ChildClass4.refresh_index
+
+        @search_result = ChildClass4.search({})
+      end
+
+      it 'should return a hash with total_results: 5' do
+        expect(@search_result[:total_results]).to be 5
+      end
+
+      it 'should return a hash with 5 instances of the class' do
+        expect(@search_result[:data].length).to be 5
+
+        @search_result[:data].each do |child_class|
+          expect(child_class).to be_an_instance_of ChildClass4
+        end
+      end
+    end
+
+    context 'Given that 30 records have been created' do
+      before do
+        ChildClass4.delete_all
+
+        24.times do
+          ChildClass4.create \
+            title: 'child class', brand: 'oficial', locked: false
+        end
+
+        ChildClass4.create(title: 'class', brand: 'oficial', locked: true)
+
+        5.times do
+          ChildClass4.create(title: 'child', brand: 'unoficial', locked: false)
+        end
+
+        ChildClass4.refresh_index
+      end
+
+      context 'when no pagination params are passed' do
+        before do
+          @search_result = ChildClass4.search({})
+        end
+
+        it 'should return a hash with total_results: 30' do
+          expect(@search_result[:total_results]).to be 30
+        end
+
+        it 'should return a hash with 10 instances of the class' do
+          expect(@search_result[:data].length).to be 10
+
+          @search_result[:data].each do |child_class|
+            expect(child_class).to be_an_instance_of ChildClass4
+          end
+        end
+      end
+
+      context 'when single query params are passed' do
+        before do
+          @search_result = ChildClass4.search \
+            query: {
+              match: { brand: 'oficial' }
+            }
+        end
+
+        it 'should return a hash with total_results: 25' do
+          expect(@search_result[:total_results]).to be 25
+        end
+
+        it 'should return a hash with 10 elements' do
+          expect(@search_result[:data].length).to be 10
+        end
+      end
+
+      context 'when multi query params are passed' do
+        before do
+          @search_result = ChildClass4.search \
+            query: {
+              bool: {
+                must: [
+                  { match: { title: 'child class' } }
+                ],
+                filter: [
+                  { term: { brand: 'oficial' } },
+                  { term: { locked: false } }
+                ]
+              }
+            }
+        end
+
+        it 'should return a hash with total_results: 24' do
+          expect(@search_result[:total_results]).to be 24
+        end
+
+        it 'should return a hash with 10 elements' do
+          expect(@search_result[:data].length).to be 10
+        end
+      end
+    end
+  end
+
+  describe '.get' do
+    ChildClass5 = Class.new(described_class)
+
+    context 'When the record does not exist' do
+      it 'should return false' do
+        result = ChildClass5.get '-1'
+
+        expect(result).to be false
+      end
+    end
+
+    context 'When the record exists' do
+      before do
+        @child_class = ChildClass5.create title: 'child class'
+
+        @result = ChildClass5.get @child_class.id
+      end
+
+      it 'should return an instance of ChildClass5' do
+        expect(@result).to be_an_instance_of ChildClass5
+      end
+
+      it 'should return the same id it requested' do
+        expect(@result.id).to be @child_class.id
+      end
+    end
+  end
+end

data/spec/factories/v1/admins.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory 'v1/admin', class: DashOverlord::Models::V1::Admin do
+    trait :streetbees do
+      email 'admin@streetbees.com'
+      secured_password 'password'
+    end
+  end
+end

data/spec/factories/v1/bee_videos.rb

@@ -0,0 +1,18 @@
+FactoryGirl.define do
+  factory 'v1/bee_video', class: DashOverlord::Models::V1::BeeVideo do
+    trait :female_laundry do
+      segment_uid 'laundry'
+      gender 'Female'
+    end
+
+    trait :male_hhc do
+      segment_uid 'hhc'
+      gender 'Male'
+    end
+
+    trait :female_hhc do
+      segment_uid 'hhc'
+      gender 'Female'
+    end
+  end
+end

data/spec/factories/v1/chart_configs.rb

@@ -0,0 +1,23 @@
+FactoryGirl.define do
+  factory 'v1/chart_config', class: DashOverlord::Models::V1::ChartConfig do
+    trait :pie_chart do
+      source 1
+      function 'count'
+      project_id 1
+    end
+
+    trait :count do
+      function 'count'
+    end
+
+    trait :percentage do
+      source 1
+      function 'percentage'
+      project_id 1
+    end
+
+    trait :average do
+      function 'average'
+    end
+  end
+end

data/spec/factories/v1/clients.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory 'v1/client', class: DashOverlord::Models::V1::Client do
+    trait :unilever do
+      name 'Unilever'
+      uid 'unilever'
+    end
+
+    trait :vodafone do
+      name 'Vodafone'
+      uid 'vodafone'
+    end
+  end
+end

data/spec/factories/v1/users.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory 'v1/user', class: DashOverlord::Models::V1::User do
+    trait :unilever do
+      admin false
+      email 'admin@unilever.com'
+      secured_password 'password'
+    end
+
+    trait :vodafone do
+      admin false
+      email 'admin@vodafone.com'
+      secured_password 'password'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+ENV['ENV'] = 'test'
+
+require File.expand_path('../../config/boot', __FILE__)
+
+require 'pry-byebug'
+require 'factory_girl'
+require 'database_cleaner'
+
+Dir[File.expand_path('../**/support/**/*.rb', __FILE__)].each do |file|
+  require file
+end
+
+# I guess either "FactoryGirl" or "DatabaseCleaner" needs this line bellow
+ActiveRecord::Base.establish_connection DashOverlord::V1::Config.get(:db_config)
+
+RSpec.configure do |config|
+  config.include Helpers
+  config.include FactoryGirl::Syntax::Methods
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding quota_rules_full_example: true
+
+  config.order = 'random'
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.before(:each, elasticsearch: true) do
+    DashOverlord::Models::V1::ElasticSearch.delete_all
+    DashOverlord::Models::V1::ElasticSearch.refresh_index
+  end
+
+  BCrypt::Engine.cost = 1
+end
+
+Dir[File.expand_path('../**{,/*/**}/factories', __FILE__)].each do |factory_dir|
+  FactoryGirl.definition_file_paths << factory_dir
+end
+
+FactoryGirl.find_definitions

data/spec/support/helpers.rb

@@ -0,0 +1,65 @@
+module Helpers
+  def raise_context_unknown_error(context)
+    status = context.status
+
+    return if status.ok?
+    return if status.created?
+    return if status.accepted?
+    return if status.not_found?
+    return if status.unauthorized?
+    return if status.forbidden?
+    return if status.unprocessable_entity?
+    return if status.bad_request?
+    return if status.not_modified?
+
+    raise_hell(context.errors.inspect)
+  end
+
+  def raise_hell(message)
+    raise DashOverlord::HellRaiserError.new(message)
+  end
+
+  def admin_session
+    admin_session = {}
+
+    if @current_admin
+      admin_session[:admin_id] = @current_admin.id
+    end
+
+    admin_session
+  end
+
+  def user_session
+    user_session = {}
+
+    if @current_user
+      user_session[:user_id] = @current_user.id
+    end
+
+    user_session
+  end
+
+  def app_response(context)
+    http_statusses = DashOverlord::Serializers::Base::RAILS_HTTP_STATUS
+
+    OpenStruct.new \
+      data: to_hash_recursive(context.data),
+      http_status: http_statusses[context.status.to_sym]
+  end
+
+  def to_hash_recursive(data)
+    if data.is_a? Array
+      return data.map { |array_entry| to_hash_recursive(array_entry) }
+    end
+
+    if data.respond_to?(:each)
+      new_hash = {}
+
+      data.each { |key, value| new_hash[key.to_s] = to_hash_recursive(value) }
+
+      return ActiveSupport::HashWithIndifferentAccess.new new_hash
+    end
+
+    data
+  end
+end

data/spec/support/shared_missing_admin.rb

@@ -0,0 +1,39 @@
+shared_examples 'authenticated admin use_case' do
+  context 'when current_admin is not present' do
+    before do
+      make_the_call nil
+    end
+
+    it 'response.http_status should return 401' do
+      expect(@response.http_status).to be 401
+    end
+
+    it 'response.data should return a 401 message' do
+      expect(@response.data).to match a_hash_including({
+        'code' => 401,
+        'message' => I18n.t('v1.admins.not_logged_in'),
+        'status' => 'unauthorized'
+      })
+    end
+  end
+
+  context 'when current_admin does not exist' do
+    before do
+      @current_admin = OpenStruct.new id: 666
+
+      make_the_call nil
+    end
+
+    it 'response.http_status should return 401' do
+      expect(@response.http_status).to be 401
+    end
+
+    it 'response.data should return a 401 message' do
+      expect(@response.data).to match a_hash_including({
+        'code' => 401,
+        'message' => I18n.t('v1.admins.not_logged_in'),
+        'status' => 'unauthorized'
+      })
+    end
+  end
+end