contactually-api 0.0.1

data/lib/contactually/notes.rb

@@ -0,0 +1,39 @@
+module Contactually
+  class Notes
+    def initialize(master)
+      @master = master
+    end
+
+    def index(params = {})
+      hash = @master.call('notes.json', :get, params)
+      notes_hash_to_objects(hash)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("notes/#{id}.json", :get, params)
+      NoteRepresenter.new(Note.new).from_hash(hash)
+    end
+
+    def create(params = {})
+      hash = @master.call('notes.json', :post, params)
+      NoteRepresenter.new(Note.new).from_hash(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("notes/#{id}.json", :delete, params)
+    end
+
+    def update(id, params = {})
+      hash = @master.call("notes/#{id}.json", :put, params)
+      NoteRepresenter.new(Note.new).from_hash(hash)
+    end
+
+    private
+
+    def notes_hash_to_objects(hash)
+      hash['notes'].inject([]) do |arr, note|
+        arr << NoteRepresenter.new(Note.new).from_hash(note)
+      end
+    end
+  end
+end

data/lib/contactually/representer/account_representer.rb

@@ -0,0 +1,13 @@
+module Contactually
+  class Account < OpenStruct
+  end
+
+  class AccountRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :username
+    property :remote_id
+    property :type
+    property :disabled_at
+  end
+end

data/lib/contactually/representer/contact_representer.rb

@@ -0,0 +1,46 @@
+module Contactually
+  class Contact < OpenStruct
+  end
+
+  class ContactRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :user_id
+    property :first_name
+    property :last_name
+    property :full_name
+    property :initials
+    property :title
+    property :company
+    property :email
+    property :avatar
+    property :avatar_url
+    property :last_contacted
+    property :visible
+    property :twitter
+    property :facebook_url
+    property :linkedin_url
+    property :first_contacted
+    property :created_at
+    property :updated_at
+    property :hits
+    property :team_parent_id
+    property :snoozed_at
+    property :snooze_days
+    property :email_addresses
+    property :tags
+    property :contact_status
+    property :team_last_contacted
+    property :team_last_contacted_by
+    property :phone_numbers
+    property :addresses
+    property :social_profiles
+    property :websites
+    property :custom_fields
+    property :sent
+    property :received
+    property :link
+    property :content
+    collection :groupings, extend: GroupingRepresenter, class: Grouping
+  end
+end

data/lib/contactually/representer/content_representer.rb

@@ -0,0 +1,16 @@
+module Contactually
+  class Content < OpenStruct
+  end
+
+  class ContentRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :user_id
+    property :url
+    property :title
+    property :description
+    property :article
+    property :original_content_id
+    collection :groupings, extend: GroupingRepresenter, class: Grouping
+  end
+end

data/lib/contactually/representer/grouping_representer.rb

@@ -0,0 +1,28 @@
+module Contactually
+  class Grouping < OpenStruct
+  end
+
+  class GroupingRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :type
+    property :name
+    property :stub
+    property :user_id
+    property :domain_id
+    property :editable
+    property :conversable
+    property :locked
+    property :derived_from_id
+    property :created_at
+    property :updated_at
+    property :has_followups
+    property :num_days_to_followup
+    property :program_id
+    property :objective
+    property :sort_order
+    property :accounts
+    property :number_of_contacts
+    property :goal
+  end
+end

data/lib/contactually/representer/grouping_statistics_representer.rb

@@ -0,0 +1,12 @@
+module Contactually
+  class GroupingStatistics < OpenStruct
+  end
+
+  class GroupingStatisticsRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :messages_sent
+    property :messages_received
+    property :status
+    collection :contacts, extend: ContactRepresenter, class: Contact
+  end
+end

data/lib/contactually/representer/note_representer.rb

@@ -0,0 +1,13 @@
+module Contactually
+  class Note < OpenStruct
+  end
+
+  class NoteRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :body
+    property :contact_id
+    property :timestamp
+    property :user_id
+  end
+end

data/lib/contactually/representer/task_representer.rb

@@ -0,0 +1,19 @@
+module Contactually
+  class Task < OpenStruct
+  end
+
+  class TaskRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+    property :id
+    property :title
+    property :due_date
+    property :completed_at
+    property :deleted_at
+    property :is_follow_up
+    property :last_contacted
+    property :contact_id
+    property :ignored
+    property :completed_via
+    property :approval_data
+  end
+end

data/lib/contactually/tasks.rb

@@ -0,0 +1,12 @@
+module Contactually
+  class Tasks
+    def initialize(master)
+      @master = master
+    end
+
+    def show(id, params = {})
+      hash = @master.call("tasks/#{id}.json", :get, params)
+      TaskRepresenter.new(Task.new).from_hash(hash)
+    end
+  end
+end

data/lib/contactually/version.rb

@@ -0,0 +1,3 @@
+module Contactually
+  VERSION = "0.0.1"
+end

data/spec/accounts_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Contactually::Accounts do
+
+  before(:all) do
+    Contactually.configure { |c| c.api_key = 'VALID_API_KEY' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::Accounts
+    end
+
+    specify do
+      expect(subject.instance_variable_get(:@master)).to be_kind_of Contactually::API
+    end
+  end
+
+  describe '#index' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('accounts.json', :get, { foo: :bar }).and_return({ 'accounts' => [] })
+      subject.index({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns accounts from json response' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/accounts_index.json"))
+      allow(@master).to receive(:call).with('accounts.json', :get, {}).and_return(JSON.load(json))
+      expect(subject.index({})).to be_kind_of Array
+      expect(subject.index({})[0]).to be_kind_of Contactually::Account
+    end
+  end
+
+  describe '#show' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('accounts/1.json', :get, { foo: :bar }).and_return({ id: 1 })
+      subject.show(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns an account' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/account.json"))
+      allow(@master).to receive(:call).with('accounts/1.json', :get, { foo: :bar }).and_return(JSON.load(json))
+      expect(subject.show(1, { foo: :bar })).to be_kind_of Contactually::Account
+    end
+  end
+
+  describe '#destroy' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('accounts/1.json', :delete, {})
+      subject.destroy(1)
+      expect(@master).to have_received(:call)
+    end
+  end
+end

data/spec/api_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Contactually::API do
+
+  describe 'missing configuration' do
+    before(:all) { Contactually.configure { |c| c.api_key = nil } }
+    specify do
+      expect{ subject }.to raise_error Contactually::ConfigMissingApiKeyError
+    end
+  end
+
+  describe 'valid configuration' do
+    before(:all) { Contactually.configure { |c| c.api_key = 'VALID_API_KEY' } }
+
+    describe '#initialize' do
+      it 'initializes correctly' do
+        expect{ subject }.not_to raise_error
+        expect(subject).to be_kind_of Contactually::API
+      end
+
+      it 'sets instance variables' do
+        expect(subject.instance_variable_get(:@api_key)).to eq 'VALID_API_KEY'
+        expect(subject.instance_variable_get(:@base_url)).to eq Contactually.contactually_url
+      end
+    end
+
+    describe '#call' do
+      it 'redirects get request to get' do
+        allow(subject).to receive(:get).and_return(Struct.new(:status, :body).new(200, {}))
+        subject.call('bla', :get, {})
+        expect(subject).to have_received(:get).with('bla', {})
+      end
+
+      it 'redirects post request to post' do
+        allow(subject).to receive(:post).and_return(Struct.new(:status, :body).new(200, {}))
+        subject.call('bla', :post, {})
+        expect(subject).to have_received(:post).with('bla', {})
+      end
+    end
+
+    describe '#call_params' do
+      specify do
+        expect(subject.send(:call_params, { foo: :bar })).to eql({ api_key: 'VALID_API_KEY', foo: :bar })
+      end
+    end
+
+    describe '#base_url' do
+      specify do
+        expect(subject.send(:base_url, 'foo/bar')).to eql("#{Contactually.contactually_url}foo/bar")
+      end
+    end
+
+    describe '#contacts' do
+      specify do
+        expect(subject.contacts).to be_kind_of Contactually::Contacts
+      end
+    end
+
+    describe '#notes' do
+      specify do
+        expect(subject.notes).to be_kind_of Contactually::Notes
+      end
+    end
+
+    describe '#groupings' do
+      specify do
+        expect(subject.groupings).to be_kind_of Contactually::Groupings
+      end
+    end
+
+    describe '#get' do
+      it 'parses from json response' do
+        allow(subject.connection).to receive(:get).
+          with('https://www.contactually.com/api/v1/url', { foo: :bar, api_key: 'VALID_API_KEY' }).
+          and_return(Struct.new(:status, :body).new(200, "{ \"foo\": \"bar\" }"))
+        expect(subject.call('url', :get, { foo: :bar })).to be_kind_of Hash
+      end
+    end
+
+    describe '#post' do
+      it 'parses from json response' do
+        allow(subject.connection).to receive(:post).and_return(Struct.new(:status, :body).new(200, "{ \"foo\": \"bar\" }"))
+        expect(subject.call('url', :post, { foo: :bar })).to be_kind_of Hash
+      end
+    end
+  end
+end

data/spec/contact_groupings_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Contactually::ContactGroupings do
+
+  before(:all) do
+    Contactually.configure { |c| c.api_key = 'VALID_API_KEY' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::ContactGroupings
+    end
+
+    specify do
+      expect(subject.instance_variable_get(:@master)).to be_kind_of Contactually::API
+    end
+  end
+
+
+  describe '#create' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/1/groupings.json', :post, { grouping_id: 512 }).and_return({ 'id' => 1234 })
+      subject.create(1, { grouping_id: 512 })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns grouping from json response' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/grouping.json"))
+      allow(@master).to receive(:call).with('contacts/1/groupings.json', :post, { grouping_id: 512 }).and_return(JSON.load(json))
+      expect(subject.create(1, { grouping_id: 512 })).to be_kind_of Contactually::Grouping
+    end
+  end
+
+  describe '#destroy' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/1/groupings/15.json', :delete, { foo: :bar }).and_return({ 'success' => true })
+      subject.destroy(1, 15, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+  end
+end

data/spec/contacts_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Contactually::Contacts do
+
+  before(:all) do
+    Contactually.configure { |c| c.api_key = 'VALID_API_KEY' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::Contacts
+    end
+
+    specify do
+      expect(subject.instance_variable_get(:@master)).to be_kind_of Contactually::API
+    end
+  end
+
+  describe '#create' do
+    it 'calls the api with correct params' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/contact.json"))
+      allow(@master).to receive(:call).with('contacts.json', :post, { contact: { foo: :bar }}).and_return(JSON.load(json))
+      subject.create({ contact: { foo: :bar }})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a contact' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/contact.json"))
+      allow(@master).to receive(:call).with('contacts.json', :post, { contact: { foo: :bar }}).and_return(JSON.load(json))
+      expect(subject.create({ contact: { foo: :bar } })).to be_kind_of Contactually::Contact
+    end
+  end
+
+  describe '#destroy' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/1.json', :delete, {})
+      subject.destroy(1)
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#destroy_multiple' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts.json', :delete, { ids: [ 1, 2, 3 ]})
+      subject.destroy_multiple({ ids: [ 1, 2, 3 ]})
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#show' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/1.json', :get, { foo: :bar }).and_return({ id: 1 })
+      subject.show(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a contact' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/contact.json"))
+      allow(@master).to receive(:call).with('contacts/1.json', :get, { foo: :bar }).and_return(JSON.load(json))
+      expect(subject.show(1, { foo: :bar })).to be_kind_of Contactually::Contact
+    end
+  end
+
+  describe '#tags' do
+    it 'calls the api with correct params - Array' do
+      allow(@master).to receive(:call).with('contacts/1/tags.json', :post, { tags: 'lol, haha' })
+      subject.tags(1, { tags: [ 'lol', 'haha' ]})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'calls the api with correct params - String' do
+      allow(@master).to receive(:call).with('contacts/1/tags.json', :post, { tags: 'lol, haha' })
+      subject.tags(1, { tags: 'lol, haha' })
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#update' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/1.json', :put, { contact: { foo: :bar }})
+      subject.update(1, { contact: { foo: :bar } })
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#index' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts.json', :get, { foo: :bar }).and_return({ 'contacts' => [] })
+      subject.index({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns contacts from json response' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/contacts_index.json"))
+      allow(@master).to receive(:call).with('contacts.json', :get, {}).and_return(JSON.load(json))
+      expect(subject.index({})).to be_kind_of Array
+      expect(subject.index({})[0]).to be_kind_of Contactually::Contact
+    end
+  end
+
+  describe '#search' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('contacts/search.json', :get, { term: :foo_bar }).and_return({ 'contacts' => [] })
+      subject.search({ term: :foo_bar})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns contacts from json response' do
+      json = File.read(File.join(File.dirname(__FILE__),"fixtures/contacts_index.json"))
+      allow(@master).to receive(:call).with('contacts/search.json', :get, { term: :foo_bar }).and_return(JSON.load(json))
+      expect(subject.search({ term: :foo_bar })).to be_kind_of Array
+      expect(subject.search({ term: :foo_bar })[0]).to be_kind_of Contactually::Contact
+    end
+  end
+end