diaspora/spec/integration/api/conversations_controller_spec.rb

# frozen_string_literal: true

require_relative "api_spec_helper"

describe Api::V1::ConversationsController do
  let(:auth) {
    FactoryGirl.create(
      :auth_with_default_scopes,
      scopes: %w[openid conversations],
      user:   FactoryGirl.create(:user, profile: FactoryGirl.create(:profile_with_image_url))
    )
  }

  let(:auth_participant) {
    FactoryGirl.create(:auth_with_all_scopes)
  }

  let(:auth_minimum_scopes) {
    FactoryGirl.create(:auth_with_default_scopes)
  }

  let!(:access_token) { auth.create_access_token.to_s }
  let!(:access_token_participant) { auth_participant.create_access_token.to_s }
  let!(:access_token_minimum_scopes) { auth_minimum_scopes.create_access_token.to_s }
  let(:invalid_token) { SecureRandom.hex(9) }

  before do
    alice.person.profile = FactoryGirl.create(:profile_with_image_url)

    auth.user.aspects.create(name: "first")
    auth.user.share_with(alice.person, auth.user.aspects[0])
    alice.share_with(auth.user.person, alice.aspects[0])
    auth.user.disconnected_by(eve)

    auth_minimum_scopes.user.aspects.create(name: "first")
    auth_minimum_scopes.user.share_with(alice.person, auth_minimum_scopes.user.aspects[0])
    alice.share_with(auth_minimum_scopes.user.person, alice.aspects[0])

    @conversation_request = {
      subject:      "new conversation",
      body:         "first message",
      recipients:   [alice.guid],
      access_token: access_token
    }
  end

  describe "#create" do
    context "with valid data" do
      it "creates the conversation" do
        post api_v1_conversations_path, params: @conversation_request
        expect(response.status).to eq(201)
        conversation = response_body(response)
        confirm_conversation_format(conversation, @conversation_request, [auth.user, alice])
      end
    end

    context "without valid data" do
      it "fails with empty body" do
        post api_v1_conversations_path, params: {access_token: access_token}
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end

      it "fails with missing subject " do
        incomplete_conversation = {
          body:         "first message",
          recipients:   [alice.guid],
          access_token: access_token
        }
        post api_v1_conversations_path, params: incomplete_conversation
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end

      it "fails with missing body " do
        incomplete_conversation = {
          subject:      "new conversation",
          recipients:   [alice.guid],
          access_token: access_token
        }
        post api_v1_conversations_path, params: incomplete_conversation
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end

      it "fails with missing recipients " do
        incomplete_conversation = {
          subject:      "new conversation",
          body:         "first message",
          access_token: access_token
        }
        post api_v1_conversations_path, params: incomplete_conversation
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end

      it "fails with bad recipient ID " do
        incomplete_conversation = {
          subject:      "new conversation",
          body:         "first message",
          recipients:   ["999_999_999"],
          access_token: access_token
        }
        post api_v1_conversations_path, params: incomplete_conversation
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end

      it "fails with invalid recipient (not allowed to message) " do
        incomplete_conversation = {
          subject:      "new conversation",
          body:         "first message",
          recipients:   [eve.guid],
          access_token: access_token
        }
        post api_v1_conversations_path, params: incomplete_conversation
        confirm_api_error(response, 422, "Couldn't accept or process the conversation")
      end
    end

    context "with improper credentials" do
      it "fails without conversation scope" do
        conversation_request = {
          subject:      "new conversation",
          body:         "first message",
          recipients:   [alice.guid],
          access_token: access_token_minimum_scopes
        }
        post api_v1_conversations_path, params: conversation_request
        expect(response.status).to eq(403)
      end

      it "fails without valid token" do
        conversation_request = {
          subject:      "new conversation",
          body:         "first message",
          recipients:   [alice.guid],
          access_token: invalid_token
        }
        post api_v1_conversations_path, params: conversation_request
        expect(response.status).to eq(401)
      end
    end
  end

  describe "#index" do
    before do
      Timecop.travel(1.hour.ago) do
        post api_v1_conversations_path, params: @conversation_request
        @read_conversation_guid = response_body(response)["guid"]
        @read_conversation = conversation_service.find!(@read_conversation_guid)
        post api_v1_conversations_path, params: @conversation_request
      end
      post api_v1_conversations_path, params: @conversation_request
      @conversation_guid = response_body(response)["guid"]
      @conversation = conversation_service.find!(@conversation_guid)
      @conversation.conversation_visibilities[0].unread = 1
      @conversation.conversation_visibilities[0].save!
      @conversation.conversation_visibilities[1].unread = 1
      @conversation.conversation_visibilities[1].save!
      @date = @conversation.created_at
    end

    it "returns all the user conversations" do
      get api_v1_conversations_path, params: {access_token: access_token}
      expect(response.status).to eq(200)
      returned_conversations = response_body(response)
      expect(returned_conversations.length).to eq(3)
      actual_conversation = returned_conversations.select {|c| c["guid"] == @read_conversation_guid }[0]
      confirm_conversation_format(actual_conversation, @read_conversation, [auth.user, alice])

      expect(returned_conversations.to_json).to match_json_schema(:api_v1_schema, fragment: "#/definitions/conversations")
    end

    it "returns all the user unread conversations" do
      get(
        api_v1_conversations_path,
        params: {only_unread: true, access_token: access_token}
      )
      expect(response.status).to eq(200)
      expect(response_body(response).length).to eq(1)
    end

    it "returns all the user unread conversations with only_unread explicitly false" do
      get(
        api_v1_conversations_path,
        params: {only_unread: false, access_token: access_token}
      )
      expect(response.status).to eq(200)
      expect(response_body(response).length).to eq(3)
    end

    it "returns all the user conversations after a given date" do
      get(
        api_v1_conversations_path,
        params: {only_after: @date, access_token: access_token}
      )
      expect(response.status).to eq(200)
      expect(response_body(response).length).to eq(1)
    end

    context "with improper credentials" do
      it "fails without conversation scope" do
        get(
          api_v1_conversations_path,
          params: {only_after: @date, access_token: access_token_minimum_scopes}
        )
        expect(response.status).to eq(403)
      end

      it "fails without valid token" do
        get(
          api_v1_conversations_path,
          params: {only_after: @date, access_token: invalid_token}
        )
        expect(response.status).to eq(401)
      end
    end
  end

  describe "#show" do
    before do
      post api_v1_conversations_path, params: @conversation_request
      @conversation_guid = response_body(response)["guid"]
      @conversation = conversation_service.find!(@conversation_guid)
    end

    context "valid conversation ID" do
      it "returns the corresponding conversation" do
        get(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token}
        )
        expect(response.status).to eq(200)
        conversation = response_body(response)
        confirm_conversation_format(conversation, @conversation, [auth.user, alice])

        expect(conversation.to_json).to match_json_schema(:api_v1_schema, fragment: "#/definitions/conversation")
      end
    end

    context "non existing conversation ID" do
      it "returns a not found error (404)" do
        get(
          api_v1_conversation_path(-1),
          params: {access_token: access_token}
        )
        confirm_api_error(response, 404, "Conversation with provided guid could not be found")
      end
    end

    context "with improper credentials" do
      it "fails without conversation scope" do
        get(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token_minimum_scopes}
        )
        expect(response.status).to eq(403)
      end

      it "fails without valid token" do
        conversation_guid = response_body(response)["guid"]
        get(
          api_v1_conversation_path(conversation_guid),
          params: {access_token: invalid_token}
        )
        expect(response.status).to eq(401)
      end
    end
  end

  describe "#update" do
    before do
      post api_v1_conversations_path, params: @conversation_request
      @conversation_guid = response_body(response)["guid"]
      @conversation = conversation_service.find!(@conversation_guid)
    end

    context "valid conversation ID" do
      it "marks as read and returns the corresponding conversation" do
        @conversation.conversation_visibilities.where(person: auth.user.person).update(unread: true)

        patch(
          api_v1_conversation_path(@conversation_guid),
          params: {read: true, access_token: access_token}
        )
        expect(response.status).to eq(200)
        conversation = response_body(response)
        confirm_conversation_format(conversation, @conversation, [auth.user, alice])

        expect(conversation.to_json).to match_json_schema(:api_v1_schema, fragment: "#/definitions/conversation")
      end

      it "marks as unread and returns the corresponding conversation" do
        @conversation.conversation_visibilities.where(person: auth.user.person).update(unread: false)

        patch(
          api_v1_conversation_path(@conversation_guid),
          params: {read: false, access_token: access_token}
        )
        expect(response.status).to eq(200)
        conversation = response_body(response)
        confirm_conversation_format(conversation, @conversation, [auth.user, alice], read: false)

        expect(conversation.to_json).to match_json_schema(:api_v1_schema, fragment: "#/definitions/conversation")
      end
    end

    context "with missing parameters" do
      it "for read" do
        patch(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token}
        )
        confirm_api_error(response, 422, "Couldn't update the conversation")
      end
    end

    context "non existing conversation ID" do
      it "returns a not found error (404)" do
        get(
          api_v1_conversation_path(-1),
          params: {access_token: access_token}
        )
        confirm_api_error(response, 404, "Conversation with provided guid could not be found")
      end
    end

    context "with improper credentials" do
      it "fails without conversation scope" do
        get(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token_minimum_scopes}
        )
        expect(response.status).to eq(403)
      end

      it "fails without valid token" do
        conversation_guid = response_body(response)["guid"]
        get(
          api_v1_conversation_path(conversation_guid),
          params: {access_token: invalid_token}
        )
        expect(response.status).to eq(401)
      end
    end
  end

  describe "#destroy " do
    before do
      auth.user.seed_aspects
      auth.user.share_with auth_participant.user.person, auth.user.aspects[1]
      auth_participant.user.share_with(
        auth.user.person, auth_participant.user.aspects[0]
      )

      @conversation_request = {
        subject:      "new conversation",
        body:         "first message",
        recipients:   [auth_participant.user.guid],
        access_token: access_token
      }
      post api_v1_conversations_path, params: @conversation_request
      @conversation_guid = response_body(response)["guid"]
    end

    context "destroy" do
      it "destroys the first participant visibility" do
        delete(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token}
        )
        expect(response.status).to eq 204
        get api_v1_conversation_path(
          @conversation_guid,
          params: {access_token: access_token}
        )
        confirm_api_error(response, 404, "Conversation with provided guid could not be found")
        get api_v1_conversation_path(
          @conversation_guid,
          params: {access_token: access_token_participant}
        )
        expect(response.status).to eq 200
      end
    end

    context "destroy all visibilities" do
      it "destroys the second participant visibilty and the conversation" do
        delete(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token}
        )
        delete(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token_participant}
        )
        expect(response.status).to eq 204

        get api_v1_conversation_path(
          @conversation_guid,
          params: {access_token: access_token_participant}
        )
        confirm_api_error(response, 404, "Conversation with provided guid could not be found")

        expect {
          Conversation.find(guid: @conversation_guid)
        }.to raise_error(ActiveRecord::RecordNotFound)
      end
    end

    context "non existing conversation ID" do
      it "returns a not found error (404)" do
        delete(
          api_v1_conversation_path(42),
          params: {access_token: access_token}
        )
        confirm_api_error(response, 404, "Conversation with provided guid could not be found")
      end
    end

    context "with improper credentials" do
      it "fails without conversation scope" do
        delete(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: access_token_minimum_scopes}
        )
        expect(response.status).to eq(403)
      end

      it "fails without valid token" do
        delete(
          api_v1_conversation_path(@conversation_guid),
          params: {access_token: invalid_token}
        )
        expect(response.status).to eq(401)
      end
    end
  end

  def conversation_service
    ConversationService.new(alice)
  end

  private

  def response_body(response)
    JSON.parse(response.body)
  end

  # rubocop:disable Metrics/AbcSize
  def confirm_conversation_format(conversation, ref_conversation, ref_participants, read: true)
    expect(conversation["guid"]).to_not be_nil
    conversation_service.find!(conversation["guid"])
    expect(conversation["subject"]).to eq ref_conversation[:subject]
    expect(conversation["created_at"]).to_not be_nil
    expect(conversation["read"]).to read ? be_truthy : be_falsy
    expect(conversation["participants"].length).to eq(ref_participants.length)
    participants = conversation["participants"]

    expect(participants.length).to eq(ref_participants.length)
    ref_participants.each do |p|
      conversation_participant = participants.find {|cp| cp["guid"] == p.guid }
      confirm_person_format(conversation_participant, p)
    end
  end
  # rubocop:enable Metrics/AbcSize

  # rubocop:disable Metrics/AbcSize
  def confirm_person_format(post_person, user)
    expect(post_person["guid"]).to eq(user.guid)
    expect(post_person["diaspora_id"]).to eq(user.diaspora_handle)
    expect(post_person["name"]).to eq(user.name)
    expect(post_person["avatar"]).to eq(user.profile.image_url(size: :thumb_medium))
  end
  # rubocop:enable Metrics/AbcSize
end