wix-hive-ruby 0.9.0

data/spec/hive/cursor_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Hive::Cursor do
+
+  let(:client) { double(Hive::Client) }
+  let(:wix_request) { double(Hive::Request::WixAPIRequest, client: client, verb: 'get', path: '/path') }
+  subject(:cursor) {described_class.new( {total: '50', pageSize: '25', nextCursor: '2', previousCursor: '1', results: ['mock']}, String, wix_request)}
+
+  context '.next?' do
+    it 'be true when cursor exists' do
+      expect(cursor.next?).to be_truthy
+    end
+    it 'be false when cursor is 0' do
+      cursor.nextCursor = '0'
+      expect(cursor.next?).to be_falsey
+    end
+
+    it 'be false when cursor is nil' do
+      cursor.nextCursor = nil
+      expect(cursor.next?).to be_falsey
+    end
+  end
+
+  context '.previous?' do
+    it 'be true when cursor exists' do
+      expect(cursor.previous?).to be_truthy
+    end
+    it 'be false when cursor is 0' do
+      cursor.previousCursor = '0'
+      expect(cursor.previous?).to be_falsey
+    end
+
+    it 'be false when cursor is nil' do
+      cursor.previousCursor = nil
+      expect(cursor.previous?).to be_falsey
+    end
+  end
+
+  context '.next_page' do
+    it 'should add the next cursor to the request params' do
+      params = {}
+      expect(wix_request).to receive(:params).and_return(params)
+      expect(wix_request).to receive(:perform_with_cursor).with(String).and_return(double(described_class))
+
+      cursor.next_page
+
+      expect(params).to include cursor: '2'
+    end
+
+    it 'should throw an error when there is no previous cursor' do
+      cursor.nextCursor = nil
+
+      expect{ cursor.next_page }.to raise_error Hive::CursorOperationError
+    end
+  end
+
+
+  context '.previous_page' do
+    it 'should add the previous cursor to the request params' do
+      params = {}
+      expect(wix_request).to receive(:params).and_return(params)
+      expect(wix_request).to receive(:perform_with_cursor).with(String).and_return(double(described_class))
+
+      cursor.previous_page
+
+      expect(params).to include cursor: '1'
+    end
+
+    it 'should throw an error when there is no previous cursor' do
+      cursor.previousCursor = nil
+
+      expect{ cursor.previous_page }.to raise_error Hive::CursorOperationError
+    end
+  end
+end

data/spec/hive/hashie_hash_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Hashie::Hash do
+
+  context '.flexibly_convert_to_hash' do
+    it 'does not raise an error when a class with property method is provided' do
+      class_with_method = Hive::Activities::Messaging::Recipient.new(method: 'EMAIL', destination: {target: 'localhost'})
+      expect { described_class.new.flexibly_convert_to_hash(class_with_method) }.not_to raise_error
+    end
+
+    it 'calls the correct to_hash method' do
+      class WithCustomToHash < Hashie::Dash
+        property :test
+
+        def to_hash
+          {passed: true}
+        end
+      end
+
+      expect(described_class.new.flexibly_convert_to_hash(WithCustomToHash.new(test: 'mock'))).to include passed: true
+    end
+  end
+end

data/spec/hive/rest/activities_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Hive::REST::Activities do
+
+  FACTORY = Hive::Activities
+  subject(:activities) { (Class.new { include Hive::Util; include Hive::REST::Activities }).new }
+
+  context '.new_activity' do
+    it 'with a valid activity' do
+      session_token = '1234'
+
+      activity = Hive::Activity.new(
+          type: FACTORY::MUSIC_ALBUM_FAN.type,
+          locationUrl: 'http://www.wix.com',
+          details: { summary: 'test', additionalInfoUrl: 'http://www.wix.com' },
+          info: { album: { name: 'Wix', id: '1234' } })
+
+      expect(activities).to receive(:perform_with_object).with(:post, 'v1/activities', Hive::ActivityResult, body: activity.to_json, params: { userSessionToken: session_token }).and_return(instance_double(Faraday::Response, body: 'mock'))
+
+      activities.new_activity(session_token, activity)
+    end
+
+    it 'with a read only activity' do
+      session_token = '1234'
+
+      activity = Hive::Activity.new(
+          type: FACTORY::CONTACTS_CREATE.type,
+          locationUrl: 'http://www.wix.com',
+          details: { summary: 'test', additionalInfoUrl: 'http://www.wix.com' },
+          info: FACTORY::CONTACTS_CREATE.klass.new)
+
+      expect { activities.new_activity(session_token, activity) }.to raise_error ArgumentError
+    end
+  end
+
+  it '.activity' do
+    expect(activities).to receive(:perform_with_object).with(:get, 'v1/activities/id', Hive::Activity).and_return(instance_double(Faraday::Response, body: 'mock'))
+    activities.activity('id')
+  end
+
+  context '.activities' do
+    it 'accepts a pageSize param and it passes it to the request' do
+      expect(activities).to receive(:perform_with_cursor).with(:get, 'v1/activities', Hive::Activity, {params: {pageSize: 50}}).and_return(instance_double(Faraday::Response, body: 'mock'))
+      activities.activities(pageSize: 50)
+    end
+
+    it 'accepts activityTypes parameter and transforms it before passing it to the request' do
+      expect(activities).to receive(:perform_with_cursor).with(:get, 'v1/activities', Hive::Activity, {params: {activityTypes: 'type1,type2'}}).and_return(instance_double(Faraday::Response, body: 'mock'))
+      activities.activities(activityTypes: %w(type1 type2))
+    end
+  end
+
+  context '.add_contact_activity'  do
+    it 'with valid activity' do
+      contact_id = '1234'
+
+      activity = Hive::Activity.new(
+          type: FACTORY::MUSIC_ALBUM_FAN.type,
+          locationUrl: 'http://www.wix.com',
+          details: { summary: 'test', additionalInfoUrl: 'http://www.wix.com' },
+          info: { album: { name: 'Wix', id: '1234' } })
+
+      expect(activities).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/activities", Hive::ActivityResult, body: activity.to_json).and_return(instance_double(Faraday::Response, body: 'mock'))
+
+      activities.add_contact_activity(contact_id, activity)
+    end
+
+    it 'with a read only activity' do
+      contact_id = '1234'
+
+      activity = Hive::Activity.new(
+          type: FACTORY::CONTACTS_CREATE.type,
+          locationUrl: 'http://www.wix.com',
+          details: { summary: 'test', additionalInfoUrl: 'http://www.wix.com' },
+          info: FACTORY::CONTACTS_CREATE.klass.new)
+
+      expect { activities.add_contact_activity(contact_id, activity) }.to raise_error ArgumentError
+    end
+  end
+
+  it '.contact_activities' do
+    contact_id = '1234'
+
+    expect(activities).to receive(:perform_with_cursor).with(:get, "v1/contacts/#{contact_id}/activities", Hive::Activity, {params: {} }).and_return(instance_double(Faraday::Response, body: 'mock'))
+    activities.contact_activities(contact_id)
+  end
+end

data/spec/hive/rest/contacts_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+describe Hive::REST::Contacts do
+
+  time_now = Time.now
+  subject(:contacts) { (Class.new { include Hive::Util; include Hive::REST::Contacts }).new }
+
+  it '.contacts' do
+    expect(contacts).to receive(:perform_with_cursor).with(:get, 'v1/contacts', Hive::Contact, {params: {pageSize: 50}}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.contacts(pageSize: 50)
+  end
+
+  it '.contact' do
+    expect(contacts).to receive(:perform_with_object).with(:get, 'v1/contacts/id', Hive::Contact).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.contact('id')
+  end
+
+  it '.new_contact' do
+    contact = double('Contact')
+    expect(contact).to receive(:to_json).and_return('mock')
+    expect(contacts).to receive(:perform_with_object).with(:post, 'v1/contacts', Hashie::Mash, body: 'mock').and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.new_contact(contact)
+  end
+
+  context '.upsert_contact' do
+    it 'with phone provided' do
+      expect(contacts).to receive(:perform_with_object).with(:put, 'v1/contacts', Hashie::Mash, body: '{"phone":"123456789"}').and_return(instance_double(Faraday::Response, body: 'mock'))
+      contacts.upsert_contact(phone: '123456789')
+    end
+
+    it 'with email provided' do
+      expect(contacts).to receive(:perform_with_object).with(:put, 'v1/contacts', Hashie::Mash, body: '{"email":"alext@wix.com"}').and_return(instance_double(Faraday::Response, body: 'mock'))
+      contacts.upsert_contact(email: 'alext@wix.com')
+    end
+
+    it 'without email or phone' do
+      expect { contacts.upsert_contact(nothing: nil) }.to raise_error(ArgumentError)
+    end
+  end
+
+  it '.contacts_tags' do
+    expect(contacts).to receive(:perform_with_object).with(:get, 'v1/contacts/tags', Array).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.contacts_tags
+  end
+
+  it '.contacts_subscribers' do
+    expect(contacts).to receive(:perform_with_cursor).with(:get, 'v1/contacts/subscribers', Hive::ContactSubscriber).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.contacts_subscribers
+  end
+
+  it '.update_contact' do
+    id = '1234'
+    contact = double('Contact')
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contact).to receive(:to_json).and_return('mock')
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{id}", Hive::Contact, body: 'mock', params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+
+    pending('HAPI-3')
+    contacts.update_contact(id, contact)
+  end
+
+  it '.update_contact_name' do
+    contact_id = '1234'
+    contact_name = double('ContactName')
+    allow(Time).to receive(:now) { time_now }
+    expect(contact_name).to receive(:to_json).and_return('mock')
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/name", Hive::Contact, body: 'mock', params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_name(contact_id, contact_name)
+  end
+
+  it '.update_contact_company' do
+    contact_id = '1234'
+    company = Hive::Company.new
+    company.name = 'Wix'
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/company", Hive::Contact, body: company.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_company(contact_id, company)
+  end
+
+  it '.update_contact_picture' do
+    contact_id = '1234'
+    picture = 'http://example.com/img1.jpg'
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/picture", Hive::Contact, body: picture.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_picture(contact_id, picture)
+  end
+
+  it '.update_contact_address' do
+    contact_id = '1234'
+    address_id = '5678'
+    address = Hive::Address.new
+    address.address = 'Wix'
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/address/#{address_id}", Hive::Contact, body: address.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_address(contact_id, address_id, address)
+  end
+
+  it '.update_contact_email' do
+    contact_id = '1234'
+    email_id = '5678'
+    email = Hive::Email.new
+
+    email.tag = 'work'
+    email.email = 'alex@example.com'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/email/#{email_id}", Hive::Contact, body: email.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_email(contact_id, email_id, email)
+  end
+
+  it '.update_contact_email' do
+    contact_id = '1234'
+    phone_id = '5678'
+    phone = Hive::Phone.new
+
+    phone.tag = 'work'
+    phone.phone = '18006666'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/phone/#{phone_id}", Hive::Contact, body: phone.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_phone(contact_id, phone_id, phone)
+  end
+
+  it '.update_contact_date' do
+    contact_id = '1234'
+    date_id = '5678'
+
+    date = Hive::Date.new
+    date.date = Time.now.iso8601(3)
+    date.tag = 'update'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/date/#{date_id}", Hive::Contact, body: date.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_date(contact_id, date_id, date)
+  end
+
+  it '.update_contact_note' do
+    contact_id = '1234'
+    note_id = '5678'
+    note = Hive::Note.new
+    note.content = 'Note'
+    note.modifiedAt = Time.now.iso8601(3)
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/note/#{note_id}", Hive::Contact, body: note.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_note(contact_id, note_id, note)
+  end
+
+  it '.update_contact_custom' do
+    contact_id = '1234'
+    custom_id = '5678'
+
+    custom = Hive::Custom.new
+    custom.field = 'custom_field'
+    custom.value = 'custom_value'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:put, "v1/contacts/#{contact_id}/custom/#{custom_id}", Hive::Contact, body: custom.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.update_contact_custom(contact_id, custom_id, custom)
+  end
+
+  it '.add_contact_address' do
+    contact_id = '1234'
+    address = Hive::Address.new
+    address.address = 'Wix'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/address", Hive::Contact, body: address.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_address(contact_id, address)
+  end
+
+  it '.add_contact_email' do
+    contact_id = '1234'
+    email = Hive::Email.new
+    email.tag = 'work'
+    email.email = 'alex@example.com'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/email", Hive::Contact, body: email.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_email(contact_id, email)
+  end
+
+  it '.add_contact_email' do
+    contact_id = '1234'
+    phone = Hive::Phone.new
+    phone.tag = 'work'
+    phone.phone = '18006666'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/phone", Hive::Contact, body: phone.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_phone(contact_id, phone)
+  end
+
+  it '.add_contact_note' do
+    contact_id = '1234'
+    note = Hive::Note.new
+    note.content = 'Note'
+    note.modifiedAt = Time.now.iso8601(3)
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/note", Hive::Contact, body: note.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_note(contact_id, note)
+  end
+
+  it '.add_contact_custom' do
+    contact_id = '1234'
+    custom = Hive::Custom.new
+    custom.field = 'custom_update'
+    custom.value = 'custom_value'
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/custom", Hive::Contact, body: custom.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_custom(contact_id, custom)
+  end
+
+  it '.add_contact_tags' do
+    contact_id = '1234'
+    tags = ['crazy/tag', 'lalala/tag']
+
+    allow(Time).to receive(:now) { time_now }
+    expect(contacts).to receive(:perform_with_object).with(:post, "v1/contacts/#{contact_id}/tags", Hive::Contact, body: tags.to_json, params: {modifiedAt: time_now.iso8601(3)}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    contacts.add_contact_tags(contact_id, tags)
+  end
+end

data/spec/hive/rest/insights_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Hive::REST::Insights do
+
+  subject(:insights) { (Class.new { include Hive::Util; include Hive::REST::Insights }).new }
+
+  it '.activities_summary' do
+    expect(insights).to receive(:perform_with_object).with(:get, 'v1/insights/activities/summary', Hive::ActivitySummary, params: {}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    insights.activities_summary
+  end
+
+  it '.contact_activities_summary' do
+    contact_id = 'id'
+    expect(insights).to receive(:perform_with_object).with(:get, "v1/insights/contacts/#{contact_id}/activities/summary", Hive::ActivitySummary, params: {}).and_return(instance_double(Faraday::Response, body: 'mock'))
+    insights.contact_activities_summary(contact_id)
+  end
+end

data/spec/hive/util_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Hive::Util do
+  let(:request) { instance_double(Hive::Request::WixAPIRequest) }
+  let(:mock_response) { instance_double(Faraday::Response, body: 'mock') }
+  subject(:util) { (Class.new { include Hive::Util }).new }
+
+  context '.perform' do
+    it 'should create and perform a request' do
+      expect(Hive::Request::WixAPIRequest).to receive(:new).with(util, 'get', '/path', {}).and_return(request)
+      expect(request).to receive(:perform).and_return(mock_response)
+
+      util.perform('get', '/path')
+    end
+  end
+
+  context '.perform_with_object' do
+    it 'should create and perform a request on the given class' do
+      expect(Hive::Request::WixAPIRequest).to receive(:new).with(util, 'get', '/path', {}).and_return(request)
+      expect(request).to receive(:perform_with_object).with(Hive::Contact).and_return(mock_response)
+
+      util.perform_with_object('get', '/path', Hive::Contact)
+
+    end
+  end
+
+  context '.perform_with_cursor' do
+    it 'should create and perform a request and return a cursor' do
+      expect(Hive::Request::WixAPIRequest).to receive(:new).with(util, 'get', '/path', {}).and_return(request)
+      expect(request).to receive(:perform_with_cursor).with(Hive::Contact).and_return(mock_response)
+
+      util.perform_with_cursor('get', '/path', Hive::Contact)
+
+    end
+  end
+end