contactually-ruby 0.0.2

data/spec/fixtures/task.json

@@ -0,0 +1,27 @@
+{
+  "id": 123123,
+  "title": "Lolokopter",
+  "due_date": "2015-10-01T00:00:00Z",
+  "interaction_type": null,
+  "completed_at": null,
+  "deleted_at": null,
+  "is_follow_up": false,
+  "last_contacted": null,
+  "contact_id": 1234,
+  "ignored": null,
+  "completed_via": null,
+  "user_id": 12345,
+  "approval_data": {
+    "approval_type": false,
+    "approval_text": false,
+    "approval_url": false,
+    "approval_template": false,
+    "approval_account_id": false
+  },
+  "contact_program_step_id": null,
+  "unresponded_followup_id": null,
+  "user_bucket": {
+    "id": 12312,
+    "name": "Colleague"
+  }
+}

data/spec/fixtures/tasks_index.json

@@ -0,0 +1,41 @@
+{
+  "meta": {
+    "total": 1,
+    "next_page": null,
+    "previous_page": null
+  },
+  "data": [
+    {
+      "id": 123123,
+      "title": "Lolokopter",
+      "due_date": "2015-10-01T00:00:00Z",
+      "interaction_type": null,
+      "completed_at": null,
+      "deleted_at": null,
+      "is_follow_up": false,
+      "last_contacted": null,
+      "contact_id": 1234,
+      "ignored": null,
+      "completed_via": null,
+      "user_id": 12345,
+      "approval_data": {
+        "approval_type": false,
+        "approval_text": false,
+        "approval_url": false,
+        "approval_template": false,
+        "approval_account_id": false
+      },
+      "contact_program_step_id": null,
+      "unresponded_followup_id": null,
+      "user_bucket": {
+        "id": 12312,
+        "name": "Colleague"
+      }
+    }
+  ],
+  "weekly_progress": [
+    0,
+    7
+  ],
+  "on_due_date": true
+}

data/spec/groupings_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Contactually::Groupings do
+
+  let(:groupings_index_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/groupings_index.json")) }
+  let(:grouping_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/grouping.json")) }
+
+  before(:all) do
+    Contactually.configure { |c| c.access_token = 'VALID_ACCESS_TOKEN' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::Groupings
+    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('groupings.json', :get, { foo: :bar }).and_return({ 'data' => [] })
+      subject.index({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns groupings from json response' do
+      allow(@master).to receive(:call).with('groupings.json', :get, {}).and_return(JSON.load(groupings_index_json))
+      expect(subject.index({})).to be_kind_of Array
+      expect(subject.index({})[0]).to be_kind_of Contactually::Grouping
+    end
+  end
+
+  describe '#create' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('groupings.json', :post, { grouping: { foo: :bar }}).and_return({ 'id' => 1234 })
+      subject.create({ grouping: { foo: :bar }})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns groupings from json response' do
+      allow(@master).to receive(:call).with('groupings.json', :post, { grouping: { foo: :bar }}).and_return(JSON.load(grouping_json))
+      expect(subject.create({ grouping: { foo: :bar }})).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('groupings/1.json', :delete, {})
+      subject.destroy(1)
+      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('groupings/1.json', :get, { foo: :bar }).and_return({ id: 1234 })
+      subject.show(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a grouping from json response' do
+      allow(@master).to receive(:call).with('groupings/1.json', :get, { foo: :bar }).and_return(JSON.load(grouping_json))
+      expect(subject.show(1, { foo: :bar })).to be_kind_of Contactually::Grouping
+    end
+  end
+
+  describe '#update' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('groupings/1.json', :put, { grouping: { foo: :bar }}).and_return({ id: 1234 })
+      subject.update(1, { grouping: { foo: :bar }})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a grouping from json response' do
+      allow(@master).to receive(:call).with('groupings/1.json', :put, { grouping: { foo: :bar }}).and_return(JSON.load(grouping_json))
+      expect(subject.update(1, { grouping: { foo: :bar }})).to be_kind_of Contactually::Grouping
+    end
+  end
+end

data/spec/notes_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Contactually::Notes do
+
+  let(:notes_index_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/notes_index.json")) }
+  let(:note_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/note.json")) }
+
+  before(:all) do
+    Contactually.configure { |c| c.access_token = 'VALID_ACCESS_TOKEN' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::Notes
+    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('notes.json', :get, { foo: :bar }).and_return({ 'data' => [] })
+      subject.index({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns notes from json response' do
+      allow(@master).to receive(:call).with('notes.json', :get, {}).and_return(JSON.load(notes_index_json))
+      expect(subject.index({})).to be_kind_of Array
+      expect(subject.index({})[0]).to be_kind_of Contactually::Note
+    end
+  end
+
+  describe '#show' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('notes/1.json', :get, { foo: :bar }).and_return(JSON.load(note_json))
+      subject.show(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a note' do
+      allow(@master).to receive(:call).with('notes/1.json', :get, { foo: :bar }).and_return(JSON.load(note_json))
+      expect(subject.show(1, { foo: :bar })).to be_kind_of Contactually::Note
+    end
+  end
+
+  describe '#create' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('notes.json', :post, { note: { foo: :bar }}).and_return(JSON.load(note_json))
+      subject.create({ note: { foo: :bar }})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a note' do
+      allow(@master).to receive(:call).with('notes.json', :post, { note: { foo: :bar }}).and_return(JSON.load(note_json))
+      expect(subject.create({ note: { foo: :bar }})).to be_kind_of Contactually::Note
+    end
+  end
+
+  describe '#update' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('notes/1.json', :put, { note: { foo: :bar }}).and_return(JSON.load(note_json))
+      subject.update(1, { note: { foo: :bar }})
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a note' do
+      allow(@master).to receive(:call).with('notes/1.json', :put, { note: { foo: :bar }}).and_return(JSON.load(note_json))
+      expect(subject.update(1, { note: { foo: :bar }})).to be_kind_of Contactually::Note
+    end
+  end
+
+  describe '#destroy' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('notes/1.json', :delete, { foo: :bar })
+      subject.destroy(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'pry-byebug'
+require 'contactually-ruby'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color = true
+end

data/spec/tasks_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Contactually::Tasks do
+
+  let(:task_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/task.json")) }
+  let(:tasks_index_json) { File.read(File.join(File.dirname(__FILE__),"fixtures/tasks_index.json")) }
+
+  before(:all) do
+    Contactually.configure { |c| c.access_token = 'VALID_ACCESS_TOKEN' }
+    @master = Contactually::API.new
+  end
+
+  subject { described_class.new @master }
+  describe '#initialize' do
+    specify do
+      expect(subject).to be_kind_of Contactually::Tasks
+    end
+
+    specify do
+      expect(subject.instance_variable_get(:@master)).to be_kind_of Contactually::API
+    end
+  end
+
+  describe '#show' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1.json', :get, { foo: :bar }).and_return(JSON.load(task_json))
+      subject.show(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a task' do
+      allow(@master).to receive(:call).with('tasks/1.json', :get, { foo: :bar }).and_return(JSON.load(task_json))
+      expect(subject.show(1, { foo: :bar })).to be_kind_of Contactually::Task
+    end
+  end
+
+  describe '#complete' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1/complete.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      subject.complete(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a task' do
+      allow(@master).to receive(:call).with('tasks/1/complete.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      expect(subject.complete(1, { foo: :bar })).to be_kind_of Contactually::Task
+    end
+  end
+
+  describe '#create' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      subject.create({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a new task' do
+      allow(@master).to receive(:call).with('tasks.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      expect(subject.create({ foo: :bar })).to be_kind_of Contactually::Task
+    end
+  end
+
+  describe '#update' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1.json', :put, { foo: :bar }).and_return(JSON.load(task_json))
+      subject.update(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a new task' do
+      allow(@master).to receive(:call).with('tasks/1.json', :put, { foo: :bar }).and_return(JSON.load(task_json))
+      expect(subject.update(1, { foo: :bar })).to be_kind_of Contactually::Task
+    end
+  end
+
+  describe '#destroy' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1.json', :delete, { foo: :bar }).and_return(JSON.load('{ "deleted": true }'))
+      subject.destroy(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#generate_followups' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/generate_followups.json', :post, { foo: :bar }).and_return(JSON.load('{ "deleted": true }'))
+      subject.generate_followups({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#generate_followups' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1/snooze.json', :post, { foo: :bar }).and_return(JSON.load('{ "snooze": true }'))
+      subject.snooze(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+  end
+
+  describe '#ignore' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks/1/ignore.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      subject.ignore(1, { foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns a new task' do
+      allow(@master).to receive(:call).with('tasks/1/ignore.json', :post, { foo: :bar }).and_return(JSON.load(task_json))
+      expect(subject.ignore(1, { foo: :bar })).to be_kind_of Contactually::Task
+    end
+  end
+
+  describe '#index' do
+    it 'calls the api with correct params' do
+      allow(@master).to receive(:call).with('tasks.json', :get, { foo: :bar }).and_return({ 'data' => [] })
+      subject.index({ foo: :bar })
+      expect(@master).to have_received(:call)
+    end
+
+    it 'returns tasks from json response' do
+      allow(@master).to receive(:call).with('tasks.json', :get, {}).and_return(JSON.load(tasks_index_json))
+      expect(subject.index({})).to be_kind_of Array
+      expect(subject.index({})[0]).to be_kind_of Contactually::Task
+    end
+  end
+
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: contactually-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tim Segraves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: roar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+description: This is a simple wrapper for the contactually api.
+email:
+- tim@revaluate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/contactually-ruby.rb
+- lib/contactually/accounts.rb
+- lib/contactually/api.rb
+- lib/contactually/buckets.rb
+- lib/contactually/contact_groupings.rb
+- lib/contactually/contacts.rb
+- lib/contactually/contents.rb
+- lib/contactually/errors.rb
+- lib/contactually/groupings.rb
+- lib/contactually/middleware/error_detector.rb
+- lib/contactually/notes.rb
+- lib/contactually/representer/account_representer.rb
+- lib/contactually/representer/bucket_representer.rb
+- lib/contactually/representer/contact_representer.rb
+- lib/contactually/representer/content_representer.rb
+- lib/contactually/representer/grouping_representer.rb
+- lib/contactually/representer/grouping_statistic_representer.rb
+- lib/contactually/representer/note_representer.rb
+- lib/contactually/representer/task_representer.rb
+- lib/contactually/tasks.rb
+- lib/contactually/utils.rb
+- lib/contactually/version.rb
+- spec/accounts_spec.rb
+- spec/api_spec.rb
+- spec/buckets_spec.rb
+- spec/contact_groupings_spec.rb
+- spec/contacts_spec.rb
+- spec/contents_spec.rb
+- spec/error_detector_spec.rb
+- spec/fixtures/account.json
+- spec/fixtures/accounts_index.json
+- spec/fixtures/bucket.json
+- spec/fixtures/buckets_index.json
+- spec/fixtures/contact.json
+- spec/fixtures/contacts_index.json
+- spec/fixtures/content.json
+- spec/fixtures/contents_index.json
+- spec/fixtures/grouping.json
+- spec/fixtures/groupings_index.json
+- spec/fixtures/note.json
+- spec/fixtures/note_destroy.json
+- spec/fixtures/notes_index.json
+- spec/fixtures/task.json
+- spec/fixtures/tasks_index.json
+- spec/groupings_spec.rb
+- spec/notes_spec.rb
+- spec/spec_helper.rb
+- spec/tasks_spec.rb
+homepage: https://github.com/revaluate/contactually-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A wrapper for the contactually.com V2 api
+test_files:
+- spec/accounts_spec.rb
+- spec/api_spec.rb
+- spec/buckets_spec.rb
+- spec/contact_groupings_spec.rb
+- spec/contacts_spec.rb
+- spec/contents_spec.rb
+- spec/error_detector_spec.rb
+- spec/fixtures/account.json
+- spec/fixtures/accounts_index.json
+- spec/fixtures/bucket.json
+- spec/fixtures/buckets_index.json
+- spec/fixtures/contact.json
+- spec/fixtures/contacts_index.json
+- spec/fixtures/content.json
+- spec/fixtures/contents_index.json
+- spec/fixtures/grouping.json
+- spec/fixtures/groupings_index.json
+- spec/fixtures/note.json
+- spec/fixtures/note_destroy.json
+- spec/fixtures/notes_index.json
+- spec/fixtures/task.json
+- spec/fixtures/tasks_index.json
+- spec/groupings_spec.rb
+- spec/notes_spec.rb
+- spec/spec_helper.rb
+- spec/tasks_spec.rb