restorm 1.0.0

data/spec/model/http_spec.rb

@@ -0,0 +1,201 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Restorm::Model::HTTP do
+  context "binding a model with an API" do
+    let(:api1) { Restorm::API.new url: "https://api1.example.com" }
+    let(:api2) { Restorm::API.new url: "https://api2.example.com" }
+
+    before do
+      spawn_model("Foo::User")
+      spawn_model("Foo::Comment")
+      Restorm::API.setup url: "https://api.example.com"
+    end
+
+    context "when binding a model to its superclass' her_api" do
+      before do
+        spawn_model "Foo::Superclass"
+        Foo::Superclass.uses_api api1
+        Foo::Subclass = Class.new(Foo::Superclass)
+      end
+
+      specify { expect(Foo::Subclass.her_api).to eq(Foo::Superclass.her_api) }
+    end
+
+    context "when changing her_api without changing the parent class' restorm_api" do
+      before do
+        spawn_model "Foo::Superclass"
+        Foo::Subclass = Class.new(Foo::Superclass)
+        Foo::Superclass.uses_api api1
+        Foo::Subclass.uses_api api2
+      end
+
+      specify { expect(Foo::Subclass.her_api).not_to eq(Foo::Superclass.restorm_api) }
+    end
+  end
+
+  context "making HTTP requests" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/users") { [200, {}, [{ id: 1 }].to_json] }
+          stub.get("/users/1") { [200, {}, { id: 1 }.to_json] }
+          stub.get("/users/popular") do |env|
+            if env[:params]["page"] == "2"
+              [200, {}, [{ id: 3 }, { id: 4 }].to_json]
+            else
+              [200, {}, [{ id: 1 }, { id: 2 }].to_json]
+            end
+          end
+        end
+      end
+
+      spawn_model "Foo::User"
+    end
+
+    describe :get do
+      subject { Foo::User.get(:popular) }
+
+      describe "#length" do
+        subject { super().length }
+        it { is_expected.to eq(2) }
+      end
+      specify { expect(subject.first.id).to eq(1) }
+    end
+
+    describe :get_raw do
+      context "with a block" do
+        specify do
+          Foo::User.get_raw("/users") do |parsed_data, _response|
+            expect(parsed_data[:data]).to eq([{ id: 1 }])
+          end
+        end
+      end
+
+      context "with a return value" do
+        subject { Foo::User.get_raw("/users") }
+        specify { expect(subject[:parsed_data][:data]).to eq([{ id: 1 }]) }
+      end
+    end
+
+    describe :get_collection do
+      context "with a String path" do
+        subject { Foo::User.get_collection("/users/popular") }
+
+        describe "#length" do
+          subject { super().length }
+          it { is_expected.to eq(2) }
+        end
+        specify { expect(subject.first.id).to eq(1) }
+      end
+
+      context "with a Symbol" do
+        subject { Foo::User.get_collection(:popular) }
+
+        describe "#length" do
+          subject { super().length }
+          it { is_expected.to eq(2) }
+        end
+        specify { expect(subject.first.id).to eq(1) }
+      end
+
+      context "with extra parameters" do
+        subject { Foo::User.get_collection(:popular, page: 2) }
+
+        describe "#length" do
+          subject { super().length }
+          it { is_expected.to eq(2) }
+        end
+        specify { expect(subject.first.id).to eq(3) }
+      end
+    end
+
+    describe :get_resource do
+      context "with a String path" do
+        subject { Foo::User.get_resource("/users/1") }
+
+        describe "#id" do
+          subject { super().id }
+          it { is_expected.to eq(1) }
+        end
+      end
+
+      context "with a Symbol" do
+        subject { Foo::User.get_resource(:"1") }
+
+        describe "#id" do
+          subject { super().id }
+          it { is_expected.to eq(1) }
+        end
+      end
+    end
+
+    describe :get_raw do
+      specify do
+        Foo::User.get_raw(:popular) do |parsed_data, _response|
+          expect(parsed_data[:data]).to eq([{ id: 1 }, { id: 2 }])
+        end
+      end
+    end
+  end
+
+  context "setting custom HTTP requests" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |connection|
+        connection.use Restorm::Middleware::FirstLevelParseJSON
+        connection.adapter :test do |stub|
+          stub.get("/users/popular") { [200, {}, [{ id: 1 }, { id: 2 }].to_json] }
+          stub.post("/users/from_default") { [200, {}, { id: 4 }.to_json] }
+        end
+      end
+
+      spawn_model "Foo::User"
+    end
+
+    subject { Foo::User }
+
+    describe :custom_get do
+      before do
+        Foo::User.custom_get :popular, :recent
+      end
+
+      it { is_expected.to respond_to(:popular) }
+      it { is_expected.to respond_to(:recent) }
+
+      it "makes HTTP request" do
+        expect(Foo::User.popular.length).to be 2
+      end
+    end
+
+    describe :custom_post do
+      before do
+        Foo::User.custom_post :from_default
+      end
+
+      it { is_expected.to respond_to(:from_default) }
+
+      it "makes HTTP request" do
+        user = Foo::User.from_default(name: "Tobias Fünke")
+        expect(user.id).to be 4
+      end
+    end
+
+    context "with options" do
+      before do
+        allow(Foo::User).to receive(:warn)
+        Foo::User.custom_get :popular, foo: "bar"
+      end
+
+      it "issues DEPRECATION warning" do
+        expect(Foo::User).to have_received(:warn).with("[DEPRECATION] options for custom request methods are deprecated and will be removed on or after January 2020.")
+      end
+
+      it "makes HTTP request" do
+        expect(Foo::User.popular.length).to be 2
+      end
+    end
+  end
+end

data/spec/model/introspection_spec.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Restorm::Model::Introspection do
+  context "introspecting a resource" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.post("/users")     { [200, {}, { id: 1, name: "Tobias Funke" }.to_json] }
+          stub.get("/users/1")    { [200, {}, { id: 1, name: "Tobias Funke" }.to_json] }
+          stub.put("/users/1")    { [200, {}, { id: 1, name: "Tobias Funke" }.to_json] }
+          stub.delete("/users/1") { [200, {}, { id: 1, name: "Tobias Funke" }.to_json] }
+          stub.get("/projects/1/comments") { [200, {}, [{ id: 1, body: "Hello!" }].to_json] }
+        end
+      end
+
+      spawn_model "Foo::User"
+      spawn_model "Foo::Comment" do
+        collection_path "projects/:project_id/comments"
+      end
+    end
+
+    describe "#inspect" do
+      it "outputs resource attributes for an existing resource" do
+        @user = Foo::User.find(1)
+        expect(["#<Foo::User(users/1) name=\"Tobias Funke\" id=1>", "#<Foo::User(users/1) id=1 name=\"Tobias Funke\">"]).to include(@user.inspect)
+      end
+
+      it "outputs resource attributes for an not-saved-yet resource" do
+        @user = Foo::User.new(name: "Tobias Funke")
+        expect(@user.inspect).to eq("#<Foo::User(users) name=\"Tobias Funke\">")
+      end
+
+      it "outputs resource attributes using getters" do
+        @user = Foo::User.new(name: "Tobias Funke", password: "Funke")
+        @user.instance_eval do
+          def password
+            "filtered"
+          end
+        end
+        expect(@user.inspect).to include("name=\"Tobias Funke\"")
+        expect(@user.inspect).to include("password=\"filtered\"")
+        expect(@user.inspect).not_to include("password=\"Funke\"")
+      end
+
+      it "support dash on attribute" do
+        @user = Foo::User.new(:'life-span' => "3 years")
+        expect(@user.inspect).to include("life-span=\"3 years\"")
+      end
+    end
+
+    describe "#inspect with errors in resource path" do
+      it "prints the resource path as “unknown”" do
+        @comment = Foo::Comment.where(project_id: 1).first
+        path = "<unknown path, missing `project_id`>"
+        expect(["#<Foo::Comment(#{path}) body=\"Hello!\" id=1>", "#<Foo::Comment(#{path}) id=1 body=\"Hello!\">"]).to include(@comment.inspect)
+      end
+    end
+  end
+
+  describe "#restorm_nearby_class" do
+    context "for a class inside of a module" do
+      before do
+        spawn_model "Foo::User"
+        spawn_model "Foo::AccessRecord"
+        spawn_model "AccessRecord"
+        spawn_model "Log"
+      end
+
+      it "returns a sibling class, if found" do
+        expect(Foo::User.restorm_nearby_class("AccessRecord")).to eq(Foo::AccessRecord)
+        expect(AccessRecord.restorm_nearby_class("Log")).to eq(Log)
+        expect(Foo::User.restorm_nearby_class("Log")).to eq(Log)
+        expect { Foo::User.restorm_nearby_class("X") }.to raise_error(NameError)
+      end
+    end
+  end
+end

data/spec/model/nested_attributes_spec.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Restorm::Model::NestedAttributes do
+  context "with a belongs_to association" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      spawn_model "Foo::User" do
+        belongs_to :company, path: "/organizations/:id", foreign_key: :organization_id
+        accepts_nested_attributes_for :company
+      end
+
+      spawn_model "Foo::Company"
+
+      @user_with_data_through_nested_attributes = Foo::User.new name: "Test", company_attributes: { name: "Example Company" }
+    end
+
+    context "when child does not yet exist" do
+      it "creates an instance of the associated class" do
+        expect(@user_with_data_through_nested_attributes.company).to be_a(Foo::Company)
+        expect(@user_with_data_through_nested_attributes.company.name).to eq("Example Company")
+      end
+    end
+
+    context "when child does exist" do
+      it "updates the attributes of the associated object" do
+        @user_with_data_through_nested_attributes.company_attributes = { name: "Fünke's Company" }
+        expect(@user_with_data_through_nested_attributes.company).to be_a(Foo::Company)
+        expect(@user_with_data_through_nested_attributes.company.name).to eq("Fünke's Company")
+      end
+    end
+  end
+
+  context "with a has_one association" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      spawn_model "Foo::User" do
+        has_one :pet
+        accepts_nested_attributes_for :pet
+      end
+
+      spawn_model "Foo::Pet"
+
+      @user_with_data_through_nested_attributes = Foo::User.new name: "Test", pet_attributes: { name: "Hasi" }
+    end
+
+    context "when child does not yet exist" do
+      it "creates an instance of the associated class" do
+        expect(@user_with_data_through_nested_attributes.pet).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes.pet.name).to eq("Hasi")
+      end
+    end
+
+    context "when child does exist" do
+      it "updates the attributes of the associated object" do
+        @user_with_data_through_nested_attributes.pet_attributes = { name: "Rodriguez" }
+        expect(@user_with_data_through_nested_attributes.pet).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes.pet.name).to eq("Rodriguez")
+      end
+    end
+  end
+
+  context "with a has_many association" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      spawn_model "Foo::User" do
+        has_many :pets
+        accepts_nested_attributes_for :pets
+      end
+
+      spawn_model "Foo::Pet"
+
+      @user_with_data_through_nested_attributes = Foo::User.new name: "Test", pets_attributes: [{ name: "Hasi" }, { name: "Rodriguez" }]
+    end
+
+    context "when children do not yet exist" do
+      it "creates an instance of the associated class" do
+        expect(@user_with_data_through_nested_attributes.pets.length).to eq(2)
+        expect(@user_with_data_through_nested_attributes.pets[0]).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes.pets[1]).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes.pets[0].name).to eq("Hasi")
+        expect(@user_with_data_through_nested_attributes.pets[1].name).to eq("Rodriguez")
+      end
+    end
+  end
+
+  context "with a has_many association as a Hash" do
+    before do
+      Restorm::API.setup url: "https://api.example.com" do |builder|
+        builder.use Restorm::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      spawn_model "Foo::User" do
+        has_many :pets
+        accepts_nested_attributes_for :pets
+      end
+
+      spawn_model "Foo::Pet"
+
+      @user_with_data_through_nested_attributes_as_hash = Foo::User.new name: "Test", pets_attributes: { "0" => { name: "Hasi" }, "1" => { name: "Rodriguez" } }
+    end
+
+    context "when children do not yet exist" do
+      it "creates an instance of the associated class" do
+        expect(@user_with_data_through_nested_attributes_as_hash.pets.length).to eq(2)
+        expect(@user_with_data_through_nested_attributes_as_hash.pets[0]).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes_as_hash.pets[1]).to be_a(Foo::Pet)
+        expect(@user_with_data_through_nested_attributes_as_hash.pets[0].name).to eq("Hasi")
+        expect(@user_with_data_through_nested_attributes_as_hash.pets[1].name).to eq("Rodriguez")
+      end
+    end
+  end
+
+  context "with an unknown association" do
+    it "raises an error" do
+      expect do
+        spawn_model("Foo::User") { accepts_nested_attributes_for :company }
+      end.to raise_error(Restorm::Errors::AssociationUnknownError, "Unknown association name :company")
+    end
+  end
+end