apes 1.0.0

data/spec/apes/concerns/response_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Apes::Concerns::Response do
+  class ResponseHandlingMockContainer
+    include Apes::Concerns::Response
+  end
+  
+  module Mockspace
+    class NameMockController
+    end
+  end
+  
+  subject { ResponseHandlingMockContainer.new }
+  
+  describe "#response_template_for" do
+    it "should return the right template" do
+      expect(subject.response_template_for(Mockspace::NameMockController.new)).to eq("mockspace_name_mock_controller")
+      expect(subject.response_template_for([Mockspace::NameMockController.new])).to eq("mockspace_name_mock_controller")
+    end
+  end
+  
+  describe "#response_meta" do
+    it "should return the right meta" do
+      expect(subject.response_meta).to be_a(HashWithIndifferentAccess)
+      expect(subject.response_meta("FOO")).to eq("FOO")
+      
+      subject.instance_variable_set(:@meta, "BAR")
+      expect(subject.response_meta).to eq("BAR")
+    end
+  end
+  
+  describe "#response_data" do
+    it "should return the right data" do
+      expect(subject.response_data).to be_a(HashWithIndifferentAccess)
+      expect(subject.response_data("FOO")).to eq("FOO")
+      
+      subject.instance_variable_set(:@data, "BAR")
+      expect(subject.response_data).to eq("BAR")
+    end
+  end
+  
+  describe "#response_links" do
+    it "should return the right links" do
+      expect(subject.response_links).to be_a(HashWithIndifferentAccess)
+      expect(subject.response_links("FOO")).to eq("FOO")
+      
+      subject.instance_variable_set(:@links, "BAR")
+      expect(subject.response_links).to eq("BAR")
+    end
+  end
+  
+  describe "#response_included" do
+    it "should return the right included data" do
+      allow(subject).to receive(:controller).and_return(OpenStruct.new(included: nil))
+      expect(subject.response_included).to be_a(HashWithIndifferentAccess)
+      expect(subject.response_included("FOO")).to eq("FOO")
+      
+      allow(subject).to receive(:controller).and_return(OpenStruct.new(included: "BAR"))
+      subject.instance_variable_set(:@links, "BAR")
+      expect(subject.response_links).to eq("BAR")
+    end
+  end
+  
+  describe "#response_include" do
+    it "should add included data" do
+      data = {}
+      allow(subject).to receive(:controller).and_return(OpenStruct.new(included: data))
+      
+      subject.response_include("DATA")
+      expect(data).to eq({"string:DATA"=>["DATA", nil]})
+    end
+  end
+  
+  describe "#response_timestamp" do
+    it "should return the right timestamp" do
+      expect(subject.response_timestamp(DateTime.civil(2024, 12, 6, 3, 2, 1, "+7"))).to eq("2024-12-06T03:02:01.000+0700")
+    end
+  end
+end

data/spec/apes/controller_spec.rb

@@ -0,0 +1,54 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::Controller do
+  describe "#handle_cors", type: :controller do
+    it "should render the right content" do
+      expect(subject).to receive(:render).with(nothing: true, status: :no_content)
+      subject.handle_cors
+    end
+  end
+  
+  describe "#default_url_options" do
+    it "should always mark the host as needed in URLs" do
+      allow(Apes::RuntimeConfiguration).to receive(:development?).and_return(true)
+      expect(subject).to receive(:request).and_return(OpenStruct.new(url: "http://localhost"))
+      expect(subject.default_url_options[:only_path]).to be_falsey
+    end
+  end
+  
+  describe "#render_error" do
+    it "should render the right template" do
+      expect(subject).to receive(:render).with("errors/403", status: :forbidden)
+      subject.render_error(:forbidden, ["1", "2"])
+      expect(subject.instance_variable_get(:@errors)).to eq(["1", "2"])
+      
+      expect(subject).to receive(:render).with("errors/404", status: 404)
+      subject.render_error(404, ["3", "4"])
+      expect(subject.instance_variable_get(:@errors)).to eq(["3", "4"])
+    end
+  end
+  
+  describe "#render_default_views (private)" do
+    it "should render the object template if a object is set" do
+      subject.instance_variable_set(:@object, "FOO")
+      expect(subject).to receive(:render).with("/object")
+      subject.send(:render_default_views, RuntimeError.new)
+    end
+    
+    it "should render the collection template if a collection is set" do
+      subject.instance_variable_set(:@objects, "FOO")
+      expect(subject).to receive(:render).with("/collection")
+      subject.send(:render_default_views, RuntimeError.new)
+    end
+    
+    it "should fallback to the default handler otherwise" do
+      expect(subject).to receive(:error_handle_exception).with(an_instance_of(RuntimeError))
+      subject.send(:render_default_views, RuntimeError.new)
+    end
+  end
+end

data/spec/apes/errors_spec.rb

@@ -0,0 +1,14 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::Errors::BaseError do
+  it "should save details" do
+    subject = Apes::Errors::BaseError.new({a: 1})
+    expect(subject.message).to eq("")
+    expect(subject.details).to eq({a: 1})
+  end
+end

data/spec/apes/models_spec.rb

@@ -0,0 +1,148 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::Model do
+  class MockBaseModel < ActiveRecord::Base
+    include Apes::Model
+
+    self.abstract_class = true
+  end
+
+  class MockQueryingModel < MockBaseModel
+    SECONDARY_QUERY = "name = :id"
+
+    def self.table_name
+      "querying_temp_table"
+    end
+
+    attr_reader :field
+    validates :field, "presence" => true
+  end
+
+  class MockQueryingOtherModel < MockBaseModel
+    include Apes::Model
+
+    SECONDARY_KEY = :handle
+
+    def self.table_name
+      "querying_temp_table"
+    end
+  end
+
+  class MockQueryingAnotherModel < MockBaseModel
+    include Apes::Model
+
+    def self.table_name
+      "querying_temp_table"
+    end
+  end
+
+  subject {
+    MockQueryingModel.new(id: SecureRandom.uuid, handle: "HANDLE", name: "NAME")
+  }
+
+  around(:each) do |example|
+    db = Tempfile.new("apes-test")
+    MockBaseModel.establish_connection(adapter: "sqlite3", database: db.path)
+    MockBaseModel.connection.execute("CREATE TABLE IF NOT EXISTS querying_temp_table(id uuid, handle varchar, name varchar);")
+    example.call
+    db.unlink
+  end
+
+  describe ".find_with_any!" do
+    it "should find a record using the primary key when the ID is a UUID" do
+      expect(MockQueryingOtherModel).to receive(:find).with(subject.id).and_return(subject)
+      expect(MockQueryingOtherModel.find_with_any!(subject.id)).to eq(subject)
+    end
+
+    it "should find a record using the secondary key" do
+      expect(MockQueryingOtherModel).to receive(:find_by!).with(handle: subject.handle).and_return(subject)
+      expect(MockQueryingOtherModel.find_with_any!(subject.handle)).to eq(subject)
+    end
+
+    it "should find a record using the secondary query" do
+      expect(MockQueryingModel).to receive(:find_by!).with("name = :id", {id: subject.name}).and_return(subject)
+      expect(MockQueryingModel.find_with_any!(subject.name).id).to eq(subject.id)
+    end
+
+    it "should fallback to a reasonable query" do
+      expect(MockQueryingAnotherModel).to receive(:find_by!).with(handle: subject.handle).and_return(subject)
+      expect(MockQueryingAnotherModel.find_with_any!(subject.handle).id).to eq(subject.id)
+    end
+
+    it "should raise an exception when nothing is found" do
+      expect { MockQueryingOtherModel.find_with_any!("NOTHING") }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  describe ".find_with_any" do
+    it "should find a records" do
+      expect(MockQueryingOtherModel).to receive(:find_by!).with(handle: subject.handle).and_return(subject)
+      expect(MockQueryingOtherModel.find_with_any(subject.handle)).to eq(subject)
+    end
+
+    it "should raise an exception when nothing is found" do
+      expect { MockQueryingOtherModel.find_with_any("NOTHING") }.not_to raise_error
+    end
+  end
+
+  describe ".search" do
+    let(:params) { {filter: {query: "ABC"}} }
+    let(:table_name) { "querying_temp_table" }
+
+    it "should do nothing if no value is present" do
+      expect(MockQueryingOtherModel.search().to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\"")
+    end
+
+    it "should perform a query on the fields" do
+      expect(MockQueryingOtherModel.search(params: params, fields: [:name, :token, :secret]).to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\" WHERE (name ILIKE '%ABC%' OR token ILIKE '%ABC%' OR secret ILIKE '%ABC%')")
+    end
+
+    it "should allow prefix based queries" do
+      expect(MockQueryingOtherModel.search(params: params, start_only: true).to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\" WHERE (name ILIKE 'ABC%')")
+    end
+
+    it "should allow case sensitive searches" do
+      expect(MockQueryingOtherModel.search(params: params, case_sensitive: true).to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\" WHERE (name LIKE '%ABC%')")
+    end
+
+    it "should allow to use AND based searches" do
+      expect(MockQueryingOtherModel.search(params: params, method: :other).to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\" WHERE (name ILIKE '%ABC%')")
+    end
+
+    it "should extend existing queries" do
+      expect(MockQueryingOtherModel.search(params: params, query: MockQueryingOtherModel.where("secret IS NOT NULL")).to_sql).to eq("SELECT \"#{table_name}\".* FROM \"#{table_name}\" WHERE (secret IS NOT NULL) AND (name ILIKE '%ABC%')")
+    end
+  end
+
+  describe "#additional_errors" do
+    it "should return a ActiveModel::Errors object" do
+      expect(MockQueryingModel.new.additional_errors).to be_a(ActiveModel::Errors)
+    end
+  end
+
+  describe "#run_validations!" do
+    it "should merge errors when validating" do
+      subject = MockQueryingModel.new
+      subject.additional_errors.add(:field, "ANOTHER")
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["ANOTHER", "can't be blank"]})
+    end
+  end
+
+  describe "#all_validation_errors" do
+    it "should allow to add additional errors after validation" do
+      subject = MockQueryingModel.new
+      expect(subject.all_validation_errors.to_hash).to eq({})
+      subject.validate
+      expect(subject.all_validation_errors.to_hash).to eq({field: ["can't be blank"]})
+      subject.additional_errors.add(:field, "ANOTHER")
+      expect(subject.all_validation_errors.to_hash).to eq({field: ["can't be blank", "ANOTHER"]})
+      expect(subject.all_validation_errors.to_hash).to eq({field: ["can't be blank", "ANOTHER"]}) # Should not add errors twice
+    end
+  end
+end

data/spec/apes/pagination_cursor_spec.rb

@@ -0,0 +1,113 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::PaginationCursor do
+  def create_cursor(value = nil, direction = "next", count = nil, use_offset = false)
+    Apes::PaginationCursor.new({count: count, page: JWT.encode({aud: "pagination", sub: {value: value, use_offset: use_offset, direction: direction}}, Apes::RuntimeConfiguration.jwt_token, "HS256")})
+  end
+  
+  def decode_cursor(cursor)
+    JWT.decode(cursor, Apes::RuntimeConfiguration.jwt_token, true, {algorithm: "HS256", verify_aud: true, aud: "pagination"}).dig(0, "sub")
+  end
+
+  describe "#initialize" do
+    it "should load a JWT token from data" do
+      subject = create_cursor("1", "previous", 3, true)
+      
+      expect(subject.value).to eq("1")
+      expect(subject.direction).to eq("previous")
+      expect(subject.size).to eq(3)
+      expect(subject.use_offset).to be_truthy
+    end
+    
+    it "should ensure good defaults" do
+      subject = Apes::PaginationCursor.new({count: 3, page: "FOO"})
+      
+      expect(subject.value).to be_nil
+      expect(subject.direction).to eq("next")
+      expect(subject.size).to eq(3)
+      expect(subject.use_offset).to be_falsey
+    
+    end
+    
+    it "should sanitize values" do
+      subject = create_cursor("1", "other", -1)
+      
+      expect(subject.direction).to eq("next")
+      expect(subject.size).to eq(Apes::PaginationCursor::DEFAULT_SIZE)
+    end
+  end
+  
+  describe "#operator" do
+    it "should return the right operator" do
+      subject = create_cursor("", "next", -1)
+      expect(subject.operator(:asc)).to eq(">")
+      expect(subject.operator(:desc)).to eq("<")
+      
+      subject = create_cursor("", "previous", -1)
+      expect(subject.operator(:asc)).to eq("<")
+      expect(subject.operator(:desc)).to eq(">")
+    end
+  end
+  
+  describe "#might_exist?" do
+    it "should check if a pagination link might exist" do
+      subject = create_cursor("", "next", -1)
+      expect(subject.might_exist?("first", [])).to be_truthy
+      expect(subject.might_exist?("next", [])).to be_falsey
+      expect(subject.might_exist?("prev", [])).to be_falsey
+      expect(subject.might_exist?("first", [1])).to be_truthy
+      expect(subject.might_exist?("next", [1])).to be_truthy
+      expect(subject.might_exist?("prev", [1])).to be_falsey
+      
+      subject = create_cursor("1", "next", -1)
+      expect(subject.might_exist?("prev", [1])).to be_truthy
+    end
+  end
+  
+  describe "#save" do
+    describe "when NOT using offset based pagination" do
+      it "should generate a valid token for direction next" do
+        cursor = create_cursor(1, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "next")
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => 2, "use_offset" => false, "direction" => "next", "size" => 25})
+      end
+      
+      it "should generate a valid token for direction prev" do
+        cursor = create_cursor(1, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "previous")
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => 1, "use_offset" => false, "direction" => "previous", "size" => 25})
+      end
+      
+      it "should generate a valid token for direction first" do
+        cursor = create_cursor(1, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "first")
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => nil, "use_offset" => false, "direction" => "next", "size" => 25})
+      end
+    end
+    
+    describe "when using offset based pagination" do
+      it "should generate a valid token for direction next" do
+        cursor = create_cursor(30, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "next", use_offset: true)
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => 55, "use_offset" => true, "direction" => "next", "size" => 25})
+      end
+      
+      it "should generate a valid token for direction prev" do
+        cursor = create_cursor(30, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "previous", use_offset: true)
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => 5, "use_offset" => true, "direction" => "previous", "size" => 25})
+      end
+      
+      it "should generate a valid token for direction first" do
+        cursor = create_cursor(30, "next", -1).save([OpenStruct.new(id: 1), OpenStruct.new(id: 2)], "first", use_offset: true)
+        subject = decode_cursor(cursor)
+        expect(subject).to eq({"value" => nil, "use_offset" => true, "direction" => "next", "size" => 25})
+      end
+    end
+  end
+end

data/spec/apes/runtime_configuration_spec.rb

@@ -0,0 +1,100 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::RuntimeConfiguration do
+  describe ".root" do
+    it "should get the information from RubyGems" do
+      expect(Apes::RuntimeConfiguration.root).to be_a(String)
+    end
+  end
+
+  describe ".rails_root" do
+    it "should get the information from Rails" do
+      stub_const("Rails", {root: "/ABC"}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.rails_root).to eq("/ABC")
+    end
+
+    it "should fallback to a default" do
+      allow(Rails).to receive(:root).and_raise(RuntimeError)
+
+      expect(Apes::RuntimeConfiguration.rails_root).to be_nil
+      expect(Apes::RuntimeConfiguration.rails_root("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+
+  describe ".gems_root" do
+    it "should get the information from Rails" do
+      expect(Apes::RuntimeConfiguration.gems_root).to be_a(String)
+    end
+
+    it "should fallback to a default" do
+      allow(Gem).to receive(:loaded_specs).and_raise(RuntimeError)
+
+      expect(Apes::RuntimeConfiguration.gems_root).to be_nil
+      expect(Apes::RuntimeConfiguration.gems_root("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+
+  describe ".environment" do
+    it "should get the information from Rails secrets" do
+      stub_const("Rails", {env: "FOO"}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.environment).to eq("FOO")
+    end
+
+    it "should fallback to a default" do
+      allow(Rails).to receive(:env).and_raise(RuntimeError)
+      expect(Apes::RuntimeConfiguration.environment).to eq("development")
+      expect(Apes::RuntimeConfiguration.environment("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+
+  describe ".environment" do
+    it "should check if Rails is in development" do
+      stub_const("Rails", {env: "development"}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.development?).to be_truthy
+
+      stub_const("Rails", {env: "FOO"}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.development?).to be_falsey
+    end
+  end
+
+  describe ".jwt_token" do
+    it "should get the information from Rails secrets" do
+      stub_const("Rails", {application: {secrets: {jwt: "SECRET"}}}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.jwt_token).to eq("SECRET")
+    end
+
+    it "should fallback to a default" do
+      expect(Apes::RuntimeConfiguration.jwt_token).to eq("secret")
+      expect(Apes::RuntimeConfiguration.jwt_token("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+
+  describe ".cors_source" do
+    it "should get the information from Rails secrets" do
+      stub_const("Rails", {application: {secrets: {cors_source: "SOURCE"}}}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.cors_source).to eq("SOURCE")
+    end
+  
+    it "should fallback to a default" do
+      expect(Apes::RuntimeConfiguration.cors_source).to eq("localhost")
+      expect(Apes::RuntimeConfiguration.cors_source("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+
+  describe ".timestamp_formats" do
+    it "should get the information from Rails secrets" do
+      stub_const("Rails", {application: {config: {timestamp_formats: {a: 1}}}}.ensure_access(:dotted))
+      expect(Apes::RuntimeConfiguration.timestamp_formats).to eq({a: 1})
+    end
+
+    it "should fallback to a default" do
+      expect(Apes::RuntimeConfiguration.timestamp_formats).to eq({})
+      expect(Apes::RuntimeConfiguration.timestamp_formats("DEFAULT")).to eq("DEFAULT")
+    end
+  end
+end