intercom_export 0.0.1

data/spec/intercom_export/differ/intercom_zendesk_spec.rb

@@ -0,0 +1,226 @@
+require 'spec_helper'
+require 'intercom_export/differ/intercom_zendesk'
+require 'intercom_export/model/zendesk_user'
+require 'intercom_export/model/zendesk_ticket'
+
+
+RSpec.describe IntercomExport::Differ::IntercomZendesk do
+
+  describe '#diff' do
+    context 'when comparing tickets' do
+      context 'when the remote object does not exist' do
+        it 'returns the commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomConversation.new(
+                id: '4347072250',
+                created_at: 1458220933,
+                updated_at: 1458290738,
+                user: IntercomExport::Reference.new('someuser'),
+                assignee: IntercomExport::Reference.new('someadmin'),
+                open: false,
+                read: true,
+                tags: ['foo'],
+                conversation_message: {
+                  id: '23964139',
+                  subject: '<p>Register</p>',
+                  body: '<p>Sorry but Ive got to go</p>',
+                  author: IntercomExport::Reference.new('someuser'),
+                  attachments: []
+                },
+                conversation_parts: [
+                  {
+                    id: '82997204',
+                    part_type: 'close',
+                    body: '<p>Hello<br>There</p><p>Help</p>',
+                    created_at: 1458221859,
+                    updated_at: 1458221859,
+                    notified_at: 1458221859,
+                    assigned_to: IntercomExport::Reference.new('someadmin'),
+                    author: IntercomExport::Reference.new('someadmin'),
+                    attachments: []
+                  },
+                  {
+                    id: '83193198',
+                    part_type: 'comment',
+                    body: '<p>Please fix this</p>',
+                    created_at: 1458241272,
+                    updated_at: 1458241272,
+                    notified_at: 1458241272,
+                    assigned_to: nil,
+                    author: IntercomExport::Reference.new('someuser'),
+                    attachments: []
+                  },
+                  {
+                    id: '83405663',
+                    part_type: 'note',
+                    body: '<p>Done</p>',
+                    created_at: 1458290721,
+                    updated_at: 1458290721,
+                    notified_at: 1458290721,
+                    assigned_to: nil,
+                    author: IntercomExport::Reference.new('someadmin'),
+                    attachments: []
+                  }
+                ]
+              ),
+              nil
+            )
+          ).to eq([
+            {
+              name: :import_ticket,
+              details: {
+                external_id: 'intercom-conversation-4347072250',
+                tags: ['foo'],
+                status: 'solved',
+                requester_id: IntercomExport::Reference.new('someuser'),
+                assignee_id: IntercomExport::Reference.new('someadmin'),
+                subject: 'Register',
+                comments: [
+                  {
+                    author_id: IntercomExport::Reference.new('someuser'),
+                    html_body: '<p>Sorry but Ive got to go</p>',
+                    created_at: '2016-03-17T13:22:13Z'
+                  },
+                  {
+                    author_id: IntercomExport::Reference.new('someadmin'),
+                    value: "Hello\nThere\n\nHelp",
+                    public: true,
+                    created_at: '2016-03-17T13:37:39Z'
+                  },
+                  {
+                    author_id: IntercomExport::Reference.new('someuser'),
+                    value: 'Please fix this',
+                    public: true,
+                    created_at: '2016-03-17T19:01:12Z'
+                  },
+                  {
+                    author_id: IntercomExport::Reference.new('someadmin'),
+                    value: 'Done',
+                    public: false,
+                    created_at: '2016-03-18T08:45:21Z'
+                  }
+                ],
+                created_at: '2016-03-17T13:22:13Z',
+                updated_at: '2016-03-18T08:45:38Z',
+              }
+            }
+          ])
+        end
+      end
+
+      context 'when the remote object exists' do
+        it 'returns no commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomConversation.new,
+              IntercomExport::Model::ZendeskTicket.new
+            )
+          ).to eq([])
+        end
+      end
+    end
+
+    context 'when comparing users' do
+      context 'when the remote object does exist' do
+        it 'returns the correct commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomUser.new(
+                id: 123, name: 'Theo', email: 'theo@example.com'
+              ),
+              IntercomExport::Model::ZendeskUser.new(
+                id: 999, name: 'Theo', email: 'theo@example.com'
+              )
+            )
+          ).to eq([
+            {
+              name: :reference,
+              details: 999,
+              reference: IntercomExport::Reference.new('intercom-user-123')
+            }
+          ])
+        end
+      end
+
+      context 'when the remote object does not exist' do
+        it 'returns the correct commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomUser.new(
+                id: 123, name: 'Theo', email: 'theo@example.com'
+              ),
+              nil
+            )
+          ).to eq([
+            {
+              name: :import_user,
+              details: { external_id: 'intercom-user-123', name: 'Theo', email: 'theo@example.com' },
+              reference: IntercomExport::Reference.new('intercom-user-123')
+            }
+          ])
+        end
+
+        it 'copes with missing name the correct commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomUser.new(
+                id: 1, name: nil, email: 't@example.com'
+              ),
+              nil
+            )
+          ).to eq([
+            {
+              name: :import_user,
+              details: { external_id: 'intercom-user-1', name: 't@example.com', email: 't@example.com' },
+              reference: IntercomExport::Reference.new('intercom-user-1')
+            }
+          ])
+        end
+      end
+    end
+
+    context 'when comparing admins' do
+      context 'when the remote object does exist' do
+        it 'returns the correct commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomAdmin.new(
+                id: 123, name: 'Theo', email: 'theo@example.com'
+              ),
+              IntercomExport::Model::ZendeskUser.new(
+                id: 999, name: 'Theo', email: 'theo@example.com'
+              )
+            )
+          ).to eq([
+            {
+              name: :reference,
+              details: 999,
+              reference: IntercomExport::Reference.new('intercom-admin-123')
+            }
+          ])
+        end
+      end
+
+      context 'when the remote object does not exist' do
+        it 'returns the correct commands' do
+          expect(
+            subject.diff(
+              IntercomExport::Model::IntercomAdmin.new(
+                id: 123, name: 'Theo', email: 'theo@example.com'
+              ),
+              nil
+            )
+          ).to eq([
+            {
+              name: :import_user,
+              details: { external_id: 'intercom-admin-123', name: 'Theo', email: 'theo@example.com' },
+              reference: IntercomExport::Reference.new('intercom-admin-123')
+            }
+          ])
+        end
+      end
+    end
+
+  end
+end

data/spec/intercom_export/executor/zendesk_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'intercom_export/executor/zendesk'
+require 'intercom_export/reference'
+
+require 'zendesk_api'
+
+RSpec.describe IntercomExport::Executor::Zendesk do
+
+  let(:zendesk_client) { double('zendesk client') }
+  let(:zendesk_collection_users) { double('ZendeskAPI::Collection') }
+  let(:zendesk_collection_tickets) { double('ZendeskAPI::Collection') }
+
+  subject { IntercomExport::Executor::Zendesk.new(zendesk_client) }
+
+  before do
+    allow(zendesk_client).to receive(:users).and_return(zendesk_collection_users)
+    allow(zendesk_client).to receive(:tickets).and_return(zendesk_collection_tickets)
+  end
+
+  describe '#call' do
+    context 'for users' do
+      it 'creates a new record' do
+        expect(zendesk_collection_users).to receive(:create!).with(
+          external_id: '123', name: 'Theo', email: 'foo@bar.com'
+        ).and_return(ZendeskAPI::User.new(zendesk_client, id: 999))
+
+        subject.call([{
+          name: :import_user,
+          details: { external_id: '123', name: 'Theo', email: 'foo@bar.com' },
+          reference: IntercomExport::Reference.new('123')
+        }])
+      end
+    end
+
+    context 'for tickets' do
+      it 'creates a new record' do
+        expect(zendesk_collection_users).to receive(:create!).with(
+          external_id: '123', name: 'Theo', email: 'foo@bar.com'
+        ).and_return(ZendeskAPI::User.new(zendesk_client, id: 999))
+
+        expect(zendesk_collection_tickets).to receive(:import!).with(
+          subject: 'This is totally broken',
+          requester_id: 999,
+          comments: [
+            { author_id: 999, value: 'This is a comment' }
+          ]
+        )
+
+        subject.call([
+          {
+            name: :import_user,
+            details: { external_id: '123', name: 'Theo', email: 'foo@bar.com' },
+            reference: IntercomExport::Reference.new('123')
+          },
+          {
+            name: :import_ticket,
+            details: {
+              subject: 'This is totally broken',
+              requester_id: IntercomExport::Reference.new('123'),
+              comments: [
+                { author_id: IntercomExport::Reference.new('123'), value: 'This is a comment' }
+              ]
+            }
+          }
+        ])
+      end
+    end
+
+    context 'for tickets with existing users' do
+      it 'creates a new record' do
+        expect(zendesk_collection_tickets).to receive(:import!).with(
+          subject: 'This is totally broken',
+          requester_id: 998,
+          comments: [
+            { author_id: 998, value: 'This is a comment' }
+          ]
+        )
+
+        subject.call([
+          {
+            name: :reference,
+            details: 998,
+            reference: IntercomExport::Reference.new('123')
+          },
+          {
+            name: :import_ticket,
+            details: {
+              subject: 'This is totally broken',
+              requester_id: IntercomExport::Reference.new('123'),
+              comments: [
+                { author_id: IntercomExport::Reference.new('123'), value: 'This is a comment' }
+              ]
+            }
+          }
+        ])
+      end
+    end
+  end
+end

data/spec/intercom_export/finder/intercom_zendesk_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'intercom_export/finder/intercom_zendesk'
+require 'intercom_export/model/intercom_admin'
+require 'intercom_export/model/intercom_user'
+require 'intercom_export/model/intercom_conversation'
+
+require 'zendesk_api'
+
+RSpec.describe IntercomExport::Finder::IntercomZendesk do
+
+  let(:zendesk_client) { double(ZendeskAPI::Client) }
+
+  subject { IntercomExport::Finder::IntercomZendesk.new(zendesk_client) }
+
+  describe '#find' do
+    let(:zendesk_user_collection) { double(ZendeskAPI::Collection) }
+    let(:expected_zendesk_user) { ZendeskAPI::User.new(nil, id: 123) }
+    let(:expected_zendesk_ticket) { ZendeskAPI::Ticket.new(nil, id: 456) }
+
+    before do
+      allow(zendesk_client).to receive(:users).and_return(zendesk_user_collection)
+    end
+
+    context 'for an intercom admin' do
+      context 'when result exists' do
+        it 'looks up using their email' do
+          allow(zendesk_user_collection).to receive(:search).with(query: 'email:theo@example.com')
+            .and_return([expected_zendesk_user])
+
+          result = subject.find(IntercomExport::Model::IntercomAdmin.new('email' => 'theo@example.com'))
+          expect(result).to eq(IntercomExport::Model::ZendeskUser.new(id: 123))
+        end
+      end
+      context 'when result does not exist' do
+        it 'returns nil' do
+          allow(zendesk_user_collection).to receive(:search).with(query: 'email:theo@example.com')
+            .and_return([])
+
+          result = subject.find(IntercomExport::Model::IntercomAdmin.new('email' => 'theo@example.com'))
+          expect(result).to be_nil
+        end
+      end
+    end
+
+    context 'for an intercom user' do
+      context 'when result exists' do
+        it 'looks up using their email' do
+          allow(zendesk_user_collection).to receive(:search).with(query: 'email:theo@example.com')
+            .and_return([expected_zendesk_user])
+
+          result = subject.find(IntercomExport::Model::IntercomUser.new('email' => 'theo@example.com'))
+          expect(result).to eq(IntercomExport::Model::ZendeskUser.new(id: 123))
+        end
+      end
+      context 'when result does not exist' do
+        it 'returns nil' do
+          allow(zendesk_user_collection).to receive(:search).with(query: 'email:theo@example.com')
+            .and_return([])
+
+          result = subject.find(IntercomExport::Model::IntercomUser.new('email' => 'theo@example.com'))
+          expect(result).to be_nil
+        end
+      end
+    end
+
+    context 'for an intercom conversation' do
+      context 'when result exists' do
+        it 'looks up using the external id' do
+          allow(zendesk_client).to receive(:search).with(
+            query: 'type:ticket external_id:intercom-conversation-123'
+          ).and_return([expected_zendesk_ticket])
+
+          result = subject.find(IntercomExport::Model::IntercomConversation.new('id' => '123'))
+          expect(result).to eq(IntercomExport::Model::ZendeskTicket.new(id: 456))
+        end
+      end
+      context 'when result does not exist' do
+        it 'returns nil' do
+          allow(zendesk_client).to receive(:search).with(
+            query: 'type:ticket external_id:intercom-conversation-123'
+          ).and_return([])
+
+          result = subject.find(IntercomExport::Model::IntercomConversation.new('id' => '123'))
+          expect(result).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/intercom_export/splitter/intercom_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+require 'intercom_export/splitter/intercom'
+
+require 'intercom'
+
+RSpec.describe IntercomExport::Splitter::Intercom do
+
+  let(:intercom_client) { instance_double(Intercom::Client) }
+  let(:intercom_admin_service) { instance_double(Intercom::Service::Admin) }
+  let(:intercom_user_service) { instance_double(Intercom::Service::User) }
+
+  subject { IntercomExport::Splitter::Intercom.new(intercom_client) }
+
+  describe '#split' do
+    before do
+      Intercom::Utils.define_lightweight_class('ConversationMessage')
+      Intercom::Utils.define_lightweight_class('ConversationPart')
+      Intercom::Utils.define_lightweight_class('NobodyAdmin')
+
+
+      allow(intercom_client).to receive(:admins).and_return(intercom_admin_service)
+      allow(intercom_client).to receive(:users).and_return(intercom_user_service)
+
+      allow(intercom_admin_service).to receive(:all).and_return(intercom_admins_full)
+      allow(intercom_user_service).to receive(:find).with(id: '56c186c20655c319400233a4').and_return(
+        intercom_user_full
+      )
+    end
+
+    let(:intercom_user_partial) do
+      Intercom::User.new(id: '56c186c20655c319400233a4')
+    end
+
+    let(:intercom_user_full) do
+      Intercom::User.new(id: '56c186c20655c319400233a4', name: 'Bob', email: 'bob@example.com')
+    end
+
+    let(:intercom_admin_partial) do
+      Intercom::Admin.new(id: '266817')
+    end
+
+    let(:intercom_admins_full) do
+      [
+        Intercom::Admin.new(id: 1, name: 'Wrong', email: 'wrong@example.com'),
+        Intercom::Admin.new(id: 266817, name: 'Theo', email: 'theo@example.com')
+      ]
+    end
+
+    let(:message) do
+      Intercom::Message.new(
+        author: intercom_user_partial,
+        body: 'I love this site',
+        id: '22294826',
+        subject: ''
+      )
+    end
+
+    let(:parts) do
+      [
+        Intercom::ConversationPart.new(
+          assigned_to: intercom_admin_partial,
+          attachments: [],
+          author: intercom_admin_partial,
+          body: 'Yes it is',
+          created_at: 1456784671,
+          id: '75615723',
+          notified_at: 1456784671,
+          part_type: 'close',
+          updated_at: 1456784671
+        ),
+        Intercom::ConversationPart.new(
+          assigned_to: nil,
+          attachments: [],
+          author: intercom_user_partial,
+          body: 'Thanks',
+          created_at: 1456829509,
+          id: '75809480',
+          notified_at: 1456829509,
+          part_type: 'close',
+          updated_at: 1456829509
+        ),
+        Intercom::ConversationPart.new(
+          assigned_to: nil,
+          attachments: [],
+          author: Intercom::User.new(id: '11111'),
+          body: nil,
+          created_at: 1458751031,
+          id: '85606347',
+          notified_at: 1458751031,
+          part_type: 'close',
+          updated_at: 1458751031
+        )
+      ]
+    end
+
+    let(:conversation) do
+      Intercom::Conversation.new(
+        id: '2016534877',
+        created_at: 1456761281,
+        updated_at: 1456829509,
+        user: intercom_user_partial,
+        assignee: Intercom::NobodyAdmin.new,
+        conversation_message: message,
+        open: true,
+        read: true,
+        conversation_parts: parts,
+        tags: []
+      )
+    end
+
+    it 'returns the parts in order they need to be recreated' do
+      expect(subject.split(conversation)).to eq([
+        IntercomExport::Model::IntercomAdmin.new(
+          id: '266817', name: 'Theo', email: 'theo@example.com'
+        ),
+        IntercomExport::Model::IntercomUser.new(
+          id: '56c186c20655c319400233a4', name: 'Bob', email: 'bob@example.com'
+        ),
+        IntercomExport::Model::IntercomConversation.new(
+          id: '2016534877',
+          created_at: 1456761281,
+          updated_at: 1456829509,
+          user: IntercomExport::Reference.new('intercom-user-56c186c20655c319400233a4'),
+          assignee: nil,
+          conversation_message: {
+            author: IntercomExport::Reference.new('intercom-user-56c186c20655c319400233a4'),
+            body: 'I love this site',
+            id: '22294826',
+            subject: ''
+          },
+          open: true,
+          read: true,
+          conversation_parts: [
+            {
+              assigned_to: IntercomExport::Reference.new('intercom-admin-266817'),
+              attachments: [],
+              author: IntercomExport::Reference.new('intercom-admin-266817'),
+              body: 'Yes it is',
+              created_at: 1456784671,
+              id: '75615723',
+              notified_at: 1456784671,
+              part_type: 'close',
+              updated_at: 1456784671
+            },
+            {
+              assigned_to: nil,
+              attachments: [],
+              author: IntercomExport::Reference.new('intercom-user-56c186c20655c319400233a4'),
+              body: 'Thanks',
+              created_at: 1456829509,
+              id: '75809480',
+              notified_at: 1456829509,
+              part_type: 'close',
+              updated_at: 1456829509
+            }
+          ],
+          tags: []
+        )
+      ])
+    end
+  end
+end