relateiq_client 0.1.0

data/spec/integration/relateiq_integration_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+RSpec.describe 'Update a list item for a contact' do
+  let(:accounts_url) { 'https://test.relateiq.com/accounts' }
+  let(:contacts_url) { 'https://test.relateiq.com/contacts' }
+  let(:lists_url) { 'https://test.relateiq.com/lists' }
+  let(:email) { 'gulgowski.devyn@example.com' }
+
+  before do
+    stub_request(:get, lists_url)
+      .to_return(body: File.readlines('spec/fixtures/lists.json').join)
+
+    stub_request(:get, "#{lists_url}/list2id/listitems/?contactIds=contactid")
+      .to_return(body: File.readlines('spec/fixtures/list_items_by_contact_id.json').join)
+
+    stub_request(:post, "#{lists_url}/list2id/listitems")
+      .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+
+    stub_request(:post, "#{accounts_url}")
+      .to_return(body: File.readlines('spec/fixtures/account_by_id.json').join)
+
+    stub_request(:get, "#{contacts_url}/?properties.email=#{email}")
+      .to_return(body: File.readlines('spec/fixtures/contacts_by_email.json').join)
+
+    stub_request(:put, "#{lists_url}/list2id/listitems/listitem1")
+      .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+
+    stub_request(:put, "#{lists_url}/list2id/listitems/listitem2")
+      .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+  end
+
+  it 'finds list by name, creates an account and creates a list item for that list and account' do
+    list = RelateIq::List.find_by_title('Burundi')
+    account = RelateIq::Account.create(name: 'Simple Company')
+    list_item = list.upsert_item(
+      name: 'Simple Name',
+      account_id: account.id,
+      field_values: [
+        { 'sint' => 'Administrator, Civil Service' },
+        { 'status' => 'Homeopath' },
+        { 'maiores' => 'test123' }
+      ]
+    )
+
+    expect(list_item.id).to eq('listitemid')
+    expect(list_item.account_id).to eq('accountid')
+  end
+
+  it 'can find a list items by contact id and update their status' do
+    contacts = RelateIq::Contact.find_by_email(email)
+    list = RelateIq::List.find_by_title('Burundi')
+    contacts.each do |contact|
+      list_items = list.items_by_contact_id(contact.id)
+      list_items.each do |list_item|
+        list_item.field_values << { 'status' => 'Homeopath' }
+        list_item.save
+      end
+    end
+
+    expect(WebMock).to have_requested(:put, "#{lists_url}/list2id/listitems/listitem1")
+      .with(body: '{"listId":"list2id","id":"listitem1","name":"hello+test@example.com",' \
+                  '"contactIds":["contactid"],"fieldValues":{"0":[{"raw":"3"}],"44":[' \
+                  '{"raw":"3"}]}}')
+    expect(WebMock).to have_requested(:put, "#{lists_url}/list2id/listitems/listitem2")
+      .with(body: '{"listId":"list2id","id":"listitem2","name":"hello@example.com",' \
+                  '"contactIds":["contactid"],"fieldValues":{"0":[{"raw":"2"}],"' \
+                  '44":[{"raw":"3"}]}}')
+  end
+end

data/spec/lib/relateiq/account_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe RelateIq::Account do
+  let(:account) { RelateIq::Account.new(id: 'accountid', name: 'account_name') }
+  let(:accounts_url) { 'https://test.relateiq.com/accounts' }
+  let(:json) { '{ "id": "accountid", "name": "account_name" }' }
+
+  before do
+    stub_request(:get, "#{accounts_url}/accountid")
+      .to_return(body: File.readlines('spec/fixtures/account_by_id.json').join)
+    stub_request(:put, "#{accounts_url}/accountid")
+      .to_return(body: File.readlines('spec/fixtures/account_by_id.json').join)
+    stub_request(:post, "#{accounts_url}")
+      .to_return(body: File.readlines('spec/fixtures/account_by_id.json').join)
+  end
+
+  context '#initiazlie' do
+    it 'sets account id and name from initializer' do
+      expect(account.id).to eq('accountid')
+      expect(account.name).to eq('account_name')
+    end
+  end
+
+  context '#to_json' do
+    it 'returns a properly serialized account' do
+      expect(JSON.parse(account.to_json)).to eq(JSON.parse(json))
+    end
+  end
+
+  context '#save' do
+    it 'calls correct save url with account serialized to JSON' do
+      RelateIq::Account.new(id: 'accountid', name: 'Testing Account').save
+      expect(WebMock).to have_requested(:put, "#{accounts_url}/accountid")
+        .with(body: '{"name":"Testing Account","id":"accountid"}')
+    end
+  end
+
+  context '.find' do
+    it 'returns a single account by id' do
+      account = RelateIq::Account.find('accountid')
+      expect(account.id).to eq('accountid')
+      expect(account.name).to eq('Bolstr, Inc.')
+    end
+  end
+
+  context '.from_json' do
+    it 'returns an account object from json representation' do
+      account_from_json = RelateIq::Account.from_json(json)
+      expect(account_from_json.id).to eq('accountid')
+      expect(account_from_json.name).to eq('account_name')
+    end
+  end
+
+  context '.create' do
+    it 'creates an account and returns its id' do
+      account = RelateIq::Account.create(name: 'Testing Account')
+      expect(account.id).to eq('accountid')
+    end
+
+    it 'calls the correct url with body params' do
+      RelateIq::Account.create(name: 'Testing Account')
+      expect(WebMock).to have_requested(:post, accounts_url)
+        .with(body: '{"name":"Testing Account"}').once
+    end
+  end
+end

data/spec/lib/relateiq/contact_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+RSpec.describe RelateIq::Contact do
+  let(:contacts_url) { 'https://test.relateiq.com/contacts' }
+  let(:email) { 'gulgowski.devyn@example.com' }
+  let(:id) { 'contactid' }
+  before do
+    stub_request(:get, "#{contacts_url}/?properties.email=#{email}")
+      .to_return(body: File.readlines('spec/fixtures/contacts_by_email.json').join)
+
+    stub_request(:get, "#{contacts_url}/#{id}")
+      .to_return(body: File.readlines('spec/fixtures/contact.json').join)
+
+    stub_request(:post, "#{contacts_url}")
+      .to_return(body: File.readlines('spec/fixtures/contact.json').join)
+
+    stub_request(:put, "#{contacts_url}/#{id}")
+      .to_return(body: File.readlines('spec/fixtures/contact.json').join)
+  end
+
+  context '.find_by_email' do
+    it 'returns a Contact with a matching title' do
+      contacts = RelateIq::Contact.find_by_email(email)
+      expect(contacts[0].id).to eq(id)
+    end
+
+    it 'requests the correct url' do
+      RelateIq::Contact.find_by_email(email)
+      url = "#{contacts_url}/?properties.email=gulgowski.devyn@example.com"
+      expect(WebMock).to have_requested(:get, url).once
+    end
+  end
+
+  context '.find' do
+    let(:contact) { RelateIq::Contact.find(id) }
+
+    it 'requests the correct url' do
+      RelateIq::Contact.find(id)
+      url = "#{contacts_url}/#{id}"
+      expect(WebMock).to have_requested(:get, url).once
+    end
+
+    it 'assigns relateiq properties to returned contact' do
+      expect(contact.email).to eq(email)
+    end
+  end
+
+  context '#initialize' do
+    let(:contact_from_api) do
+      RelateIq::Contact.new(
+        id: 'someid',
+        properties: {
+          email: [{ value: 'hello@hello.com' }],
+          company: [
+            { value: 'Bolstr' },
+            { value: 'Bolstr, Inc.' }
+          ],
+          liurl: [{ value: 'https://www.linkedin.com/in/doriankarter' }],
+          twhan: [{ value: '@test' }]
+        }
+      )
+    end
+
+    let(:contact) do
+      RelateIq::Contact.new(
+        id: 'someid',
+        email: 'hello@hello.com',
+        first_name: 'Little',
+        last_name: 'Wuckert',
+        company: ['Bolstr', 'Bolstr, Inc.'],
+        linkedin: 'https://www.linkedin.com/in/doriankarter'
+      )
+    end
+
+    it 'can have mutltiple values on contact' do
+      expect(contact_from_api.company).to eq(['Bolstr', 'Bolstr, Inc.'])
+      expect(contact.company).to eq(['Bolstr', 'Bolstr, Inc.'])
+    end
+
+    it 'translates and cleans up relateiq keys' do
+      expect(contact_from_api.linkedin).to eq('https://www.linkedin.com/in/doriankarter')
+      expect(contact_from_api.twitter).to eq('@test')
+      expect(contact_from_api).to_not respond_to(:liurl)
+      expect(contact_from_api).to_not respond_to(:twhan)
+    end
+
+    it 'allows initializing by user' do
+      expect(contact.id).to eq('someid')
+      expect(contact.email).to eq('hello@hello.com')
+      expect(contact.first_name).to eq('Little')
+      expect(contact.last_name).to eq('Wuckert')
+      expect(contact.linkedin).to eq('https://www.linkedin.com/in/doriankarter')
+    end
+
+    it 'assigns relateiq properties contact object' do
+      expect(contact_from_api.email).to eq('hello@hello.com')
+    end
+  end
+
+  context '#save' do
+    let(:contact_to_update) do
+      RelateIq::Contact.new(
+        id: id,
+        email: 'hello@hello.com',
+        company: ['Bolstr', 'Bolstr, Inc.'],
+        linkedin: 'https://www.linkedin.com/in/doriankarter'
+      )
+    end
+
+    let(:contact_to_create) do
+      RelateIq::Contact.new(
+        email: 'hello@hello.com',
+        company: ['Bolstr', 'Bolstr, Inc.'],
+        linkedin: 'https://www.linkedin.com/in/doriankarter'
+      )
+    end
+
+    it 'executes update when contact has no id' do
+      contact_to_create.save
+      url = "#{contacts_url}"
+      expect(WebMock).to have_requested(:post, url).once
+    end
+
+    it 'executes create (post) when contact has id' do
+      contact_to_update.save
+      url = "#{contacts_url}/#{contact_to_update.id}"
+      expect(WebMock).to have_requested(:put, url).once
+    end
+  end
+
+  context '#to_json' do
+    let(:contact) do
+      RelateIq::Contact.new(
+        id: 'someid',
+        first_name: 'Little',
+        last_name: 'Wuckert',
+        email: 'hello@hello.com',
+        company: ['Bolstr', 'Bolstr, Inc.'],
+        linkedin: 'https://www.linkedin.com/in/doriankarter',
+        twitter: '@test'
+      )
+    end
+
+    it 'should return a proper relateiq json contact and not include unset attributes' do
+      expected_json_hash = {
+        id: 'someid',
+        properties: {
+          name: [{ value: 'Little Wuckert' }],
+          email: [{ value: 'hello@hello.com' }],
+          company: [
+            { value: 'Bolstr' },
+            { value: 'Bolstr, Inc.' }
+          ],
+          liurl: [{ value: 'https://www.linkedin.com/in/doriankarter' }],
+          twhan: [{ value: '@test' }]
+        }
+      }
+      expect(JSON.parse(contact.to_json, symbolize_names: true)).to eq(expected_json_hash)
+    end
+  end
+end

data/spec/lib/relateiq/list_item_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+RSpec.describe RelateIq::ListItem do
+  let(:lists_url) { 'https://test.relateiq.com/lists' }
+
+  before do
+    stub_request(:get, lists_url)
+      .to_return(body: File.readlines('spec/fixtures/lists.json').join)
+
+    stub_request(:get, "#{lists_url}/list2id/listitems/?contactIds=contactid")
+      .to_return(body: File.readlines('spec/fixtures/list_items_by_contact_id.json').join)
+
+    stub_request(:put, "#{lists_url}/list2id/listitems/listitemid")
+      .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+
+    stub_request(:post, "#{lists_url}/list2id/listitems")
+      .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+  end
+
+  context '.create' do
+    it 'requests correct url with all parameters' do
+      RelateIq::ListItem.create(name: 'itemname', list_id: 'list2id')
+      url = "#{lists_url}/list2id/listitems"
+      expect(WebMock).to have_requested(:post, url)
+        .with(body: '{"listId":"list2id","name":"itemname"}')
+    end
+
+    it 'returns the id of the list item' do
+      item = RelateIq::ListItem.create(name: 'itemname', list_id: 'list2id')
+      expect(item.id).to eq('listitemid')
+    end
+  end
+
+  context '.find_by_contact' do
+    let(:list_items) do
+      RelateIq::ListItem.find_by_contact('list2id', 'contactid')
+    end
+
+    it 'requests correct url with all parameters' do
+      RelateIq::ListItem.find_by_contact('list2id', 'contactid')
+      expect(WebMock).to have_requested(:get, "#{lists_url}/list2id/listitems/?contactIds=contactid")
+    end
+
+    it 'returns 2 list items' do
+      expect(list_items.count).to eq(2)
+      expect(list_items[0].is_a? RelateIq::ListItem).to eq(true)
+      expect(list_items[1].is_a? RelateIq::ListItem).to eq(true)
+    end
+  end
+
+  context '.from_json' do
+    it 'returns an instance of ListItem containing all properties specified in json' do
+      json = '{ "listId": "list2id", "name": "test" }'
+      deserialized_list_item = RelateIq::ListItem.from_json(json)
+      expect(deserialized_list_item.list_id).to eq('list2id')
+    end
+  end
+
+  context '#to_json' do
+    it 'returns a full representation of list item in relateiq json format' do
+      list_item = RelateIq::ListItem.new(
+        name: 'itemname',
+        list_id: 'list2id',
+        field_values: [{ 'nobis' => 'Dancer' }],
+        contact_ids: ['contactid1', 'contactid2'],
+        account_id: 'accountid'
+      )
+      json_hash = {
+        'listId' => 'list2id',
+        'name' => 'itemname',
+        'accountId' => 'accountid',
+        'contactIds' => ['contactid1', 'contactid2'],
+        'fieldValues' => {
+          '0' => [{ 'raw' => '17' }]
+        }
+      }
+      expect(list_item.to_json).to eq(json_hash.to_json)
+    end
+
+    it 'does not render an account id to a contact type list' do
+      list_item = RelateIq::ListItem.new(
+        list_id: 'list1id',
+        contact_ids: ['contactid1', 'contactid2'],
+        account_id: 'accountid'
+      )
+      json_hash = {
+        'listId' => 'list1id',
+        'contactIds' => ['contactid1', 'contactid2'],
+      }
+      expect(list_item.to_json).to eq(json_hash.to_json)
+    end
+
+    it 'omits properties that are not filled' do
+      list_item = RelateIq::ListItem.new(
+        name: 'itemname',
+        list_id: 'list2id',
+        field_values: [{ 'nobis' => 'Dancer' }]
+      )
+      json_hash = {
+        'listId' => 'list2id',
+        'name' => 'itemname',
+        'fieldValues' => {
+          '0' => [{ 'raw' => '17' }]
+        }
+      }
+      expect(list_item.to_json).to eq(json_hash.to_json)
+    end
+  end
+
+  context '#save' do
+    it 'saves existing list item' do
+      RelateIq::ListItem.new(
+        id: 'listitemid',
+        name: 'itemname',
+        list_id: 'list2id',
+        field_values: nil
+      ).save
+      url = "#{lists_url}/list2id/listitems/listitemid"
+      expect(WebMock).to have_requested(:put, url)
+        .with(body: '{"listId":"list2id","id":"listitemid","name":"itemname"}')
+    end
+
+    it 'creates new item when no id is supplied' do
+      RelateIq::ListItem.new(
+        name: 'itemname',
+        list_id: 'list2id'
+      ).save
+      url = "#{lists_url}/list2id/listitems"
+      expect(WebMock).to have_requested(:post, url)
+        .with(body: '{"listId":"list2id","name":"itemname"}')
+    end
+  end
+end

data/spec/lib/relateiq/list_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+RSpec.describe RelateIq::List do
+  let(:lists_url) { 'https://test.relateiq.com/lists' }
+  let(:list_class) { RelateIq::List }
+  let(:list_2) { RelateIq::List.find_by_title('Burundi') }
+  let(:list_hash) do
+    {
+      id: 'someid',
+      title: 'List Title',
+      listType: 'contact',
+      modifiedDate: 12345678,
+      fields: [
+        {
+          id: '5',
+          name: 'unde',
+          listOptions: [],
+          isMultiSelect: false,
+          isEditable: false,
+          dataType: 'DateTime'
+        },
+        {
+          id: '9',
+          name: 'porro',
+          listOptions: [
+            {
+              id: '0',
+              display: 'Teacher, special educational needs'
+            },
+            {
+              id: '1',
+              display: 'Applications developer'
+            }
+          ],
+          isMultiSelect: false,
+          isEditable: true,
+          dataType: 'List'
+        }
+      ]
+    }
+  end
+  let(:list_json) { list_hash.to_json }
+
+  before do
+    stub_request(:get, lists_url)
+      .to_return(body: File.readlines('spec/fixtures/lists.json').join)
+
+    stub_request(:get, "#{lists_url}/list2id/listitems/?contactIds=contactid")
+      .to_return(body: File.readlines('spec/fixtures/list_items_by_contact_id.json').join)
+  end
+
+  context '.all' do
+    it 'returns an array of lists' do
+      expect(list_class.all.count).to eq(6)
+      list_class.all.each do |item|
+        expect(item.is_a? list_class).to eq(true)
+      end
+    end
+
+    it 'returns field list_options as an array' do
+      status_field = RelateIq::List.all[0].fields.find { |f| f[:name] == 'status' }
+      status_field[:listOptions].is_a? Array
+    end
+
+    it 'caches a copy in memory and does not call web method more than once' do
+      list_class.clean_cache
+      list_class.all
+      list_class.all
+      expect(WebMock).to have_requested(:get, lists_url).once
+    end
+  end
+
+  context '.find_by_title' do
+    it 'returns a List with a matching title' do
+      expect(list_class.find_by_title('Swaziland')).to eq(list_class.all[2])
+    end
+
+    it 'is case insensitive' do
+      expect(list_class.find_by_title('swaziland')).to eq(list_class.all[2])
+    end
+  end
+
+  context '.from_json' do
+    it 'can create an array of lists from json' do
+      lists_from_json = RelateIq::List.from_json(File.readlines('spec/fixtures/lists.json').join)
+      lists_from_json.each do |l|
+        expect(l.is_a?(RelateIq::List)).to eq(true)
+      end
+      expect(lists_from_json.count).to eq(6)
+    end
+
+    it 'can create a single list from json' do
+      list_from_json = RelateIq::List.from_json(list_json)
+      expect(list_from_json.id).to eq('someid')
+    end
+  end
+
+  context '#initialize' do
+    let(:list_from_api) do
+      RelateIq::List.new(list_hash)
+    end
+
+    let(:list) do
+      RelateIq::List.new(
+        id: 'someid',
+        title: 'List Title',
+        list_type: 'contact'
+      )
+    end
+
+    it 'translates and cleans up relateiq keys' do
+      expect(list_from_api.list_type).to eq('contact')
+      expect(list_from_api.modified_date).to eq(12345678)
+    end
+
+    it 'allows setting attributes directly through the constructor' do
+      expect(list.list_type).to eq('contact')
+    end
+  end
+
+  context '#items_by_contact_id' do
+    it 'can accept a single contact id' do
+      list_item_class = RelateIq::ListItem
+      allow(list_item_class).to receive(:find_by_contact)
+      list_2.items_by_contact_id('contactid')
+      expect(list_item_class).to have_received(:find_by_contact).with('list2id', 'contactid')
+    end
+  end
+
+  context '#upsert_item' do
+    before do
+      stub_request(:put, "#{lists_url}/list2id/listitems/listitemid")
+        .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+
+      stub_request(:post, "#{lists_url}/list2id/listitems")
+        .to_return(body: File.readlines('spec/fixtures/list_item.json').join)
+    end
+
+    it 'creates a post request if no id is provided includes current list id' do
+      list_2.upsert_item(name: 'test')
+      expect(WebMock).to have_requested(:post, "#{lists_url}/list2id/listitems")
+        .with(body: '{"listId":"list2id","name":"test"}')
+    end
+  end
+end