capsule_crm 0.4.6 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48c3f7884a088c4d42cee4aa450fc594c3f9fa96
-  data.tar.gz: 35822071aafa5ea3b7def6616e3e30003fb150ea
+  metadata.gz: ddd7d3301e019fef3e849184c72984525d7fba2b
+  data.tar.gz: c7d33116a1689a4bc34ec6855e6bc3818ae0c588
 SHA512:
-  metadata.gz: 968f3d57a5f7228200488c74021a8c27d05269213094797fdd8124cb843f149cdfc9d1d1b9ffd2a3996fa44cc54b691f9f238bb8b84bf7fbc0a11d4e38376a3f
-  data.tar.gz: 782f7e740f951e5c7ca5114a1ea6f481b5638657f64c39f8210ff6da890a6342d03dedec30df05120d05f8d0c92d36ee0312289f619fa6749e90daec7ef42fee
+  metadata.gz: 92966063166982596f7927c7fbbe3a3d9d12e135914493453e817bb500ca55e41c6fc5dbe693e8cb26d2b496eb16c7b779a6869200f45a0ece520211d2999a52
+  data.tar.gz: 8b64c89681e60317a997c961c30e2e28db74b64244be466db1c902445ee160ad4ad8e295c58526fe772b87c9c35749b59e457866e6cd28b79b9d903f69bcf9ac

data/README.md

@@ -1,6 +1,9 @@
 [![Build
 Status](https://travis-ci.org/mattbeedle/capsule_crm.png)](https://travis-ci.org/mattbeedle/capsule_crm)
 
+[![Code
+Climate](https://codeclimate.com/github/mattbeedle/capsule_crm.png)](https://codeclimate.com/github/mattbeedle/capsule_crm)
+
 [![Gem
 Version](https://badge.fury.io/rb/capsule_crm.png)](http://badge.fury.io/rb/capsule_crm)
 

data/lib/capsule_crm/connection.rb

@@ -18,15 +18,7 @@ module CapsuleCRM
       response = faraday.post(path, params.to_json) do |request|
         request.headers.update default_request_headers
       end
-      if response.success?
-        if match = response.headers['Location'].match(/\/(?<id>\d+)$/)
-          { id: match[:id] }
-        else
-          true
-        end
-      else
-        false
-      end
+      process_post_response(response)
     end
 
     def self.put(path, params)
@@ -43,6 +35,20 @@ module CapsuleCRM
 
     private
 
+    # TODO clean this shit up
+    def self.process_post_response(response)
+      if response.success?
+        if response.headers['Location'] &&
+          match = response.headers['Location'].match(/\/(?<id>\d+)$/)
+          { id: match[:id] }
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
     def self.default_request_headers
       { accept: 'application/json', content_type: 'application/json' }
     end

data/lib/capsule_crm/person.rb

@@ -233,7 +233,7 @@ module CapsuleCRM
     end
 
     def update_record
-      CapsuleCRM::Connection.put("/api/person/#{id}", attributes)
+      CapsuleCRM::Connection.put("/api/person/#{id}", to_capsule_json)
       self
     end
 

data/lib/capsule_crm/task.rb

@@ -0,0 +1,142 @@
+module CapsuleCRM
+  class Task
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include CapsuleCRM::Associations::BelongsTo
+
+    attribute :id, Integer
+    attribute :due_date, Date
+    attribute :due_date_time, DateTime
+    attribute :category, String
+    attribute :description, String
+    attribute :detail, String
+
+    belongs_to :party, class_name: 'CapsuleCRM::Party'
+    belongs_to :opportunity, class_name: 'CapsuleCRM::Opportunity'
+    belongs_to :case, class_name: 'CapsuleCRM::Case'
+    belongs_to :owner, class_name: 'CapsuleCRM::User'
+
+    validates :description, presence: true
+    validates :due_date, presence: { unless: :due_date_time }
+    validates :due_date_time, presence: { unless: :due_date }
+
+    def attributes=(attributes)
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+    end
+
+    def owner=(user)
+      user = CapsuleCRM::User.find_by_username(user) if user.is_a?(String)
+      @owner = user
+      self
+    end
+
+    def self.all(options = {})
+      init_collection(
+        CapsuleCRM::Connection.get('/api/tasks', options)['tasks']['task']
+      )
+    end
+
+    def self.find(id)
+      new CapsuleCRM::Connection.get("/api/task/#{id}")['task']
+    end
+
+    def self.create(attributes = {})
+      new(attributes).tap(&:save)
+    end
+
+    def self.create!(attributes = {})
+      new(attributes).tap(&:save!)
+    end
+
+    def update_attributes(attributes = {})
+      self.attributes = attributes
+      save
+    end
+
+    def update_attributes!(attributes = {})
+      self.attributes = attributes
+      save!
+    end
+
+    def save
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        false
+      end
+    end
+
+    def save!
+      if valid?
+        save
+      else
+        raise CapsuleCRM::Errors::RecordInvalid.new(self)
+      end
+    end
+
+    def destroy
+      self.id = nil if CapsuleCRM::Connection.delete("/api/task/#{id}")
+      self
+    end
+
+    def complete
+      CapsuleCRM::Connection.post("/api/task/#{id}/complete")
+      self
+    end
+
+    def reopen
+      CapsuleCRM::Connection.post("/api/task/#{id}/reopen")
+      self
+    end
+
+    def self.categories
+      CapsuleCRM::Connection.
+        get('/api/task/categories')['taskCategories']['taskCategory']
+    end
+
+    def new_record?
+      !id
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    def to_capsule_json
+      {
+        task: CapsuleCRM::HashHelper.camelize_keys(capsule_attributes)
+      }.stringify_keys
+    end
+
+    private
+
+    def capsule_attributes
+      { description: description, category: category }.tap do |attrs|
+        attrs.merge!(owner: owner.username) if owner
+        attrs.merge!(due_date: due_date.to_s(:db)) if due_date
+        attrs.merge!(due_date_time: due_date_time.to_s(:db)) if due_date_time
+      end
+    end
+
+    def self.init_collection(collection)
+      CapsuleCRM::ResultsProxy.new(collection.map { |item| new item })
+    end
+
+    def create_record
+      self.attributes = CapsuleCRM::Connection.post(
+        '/api/task', to_capsule_json
+      )
+      self
+    end
+
+    def update_record
+      CapsuleCRM::Connection.put("/api/task/#{id}", to_capsule_json)
+      self
+    end
+  end
+end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.4.6'
+  VERSION = '0.5.6'
 end

data/lib/capsule_crm.rb

@@ -17,6 +17,7 @@ require 'capsule_crm/history'
 require 'capsule_crm/party'
 require 'capsule_crm/phone'
 require 'capsule_crm/tag'
+require 'capsule_crm/task'
 require 'capsule_crm/user'
 require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'

data/spec/fabricators/task_fabricator.rb

@@ -0,0 +1,4 @@
+Fabricator(:task, class_name: :'CapsuleCRM::Task') do
+  description { Faker::Lorem.paragraph }
+  due_date { Date.tomorrow }
+end

data/spec/lib/capsule_crm/task_spec.rb

@@ -0,0 +1,289 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Task do
+  before do
+    configure
+    stub_request(:get, /\/api\/users$/).
+      to_return(body: File.read('spec/support/all_users.json'))
+    stub_request(:get, /\/api\/party\/1$/).
+      to_return(body: File.read('spec/support/person.json'))
+  end
+
+  it { should validate_presence_of(:description) }
+
+  it { should validate_presence_of(:due_date) }
+
+  it { should validate_presence_of(:due_date_time) }
+
+  describe '.find' do
+    before do
+      stub_request(:get, /\/api\/task\/2$/).
+        to_return(body: File.read('spec/support/task.json'))
+    end
+
+    subject { CapsuleCRM::Task.find(2) }
+
+    it { should be_a(CapsuleCRM::Task) }
+
+    it { subject.due_date.should_not be_blank }
+
+    it { subject.category.should eql('Meeting') }
+
+    it { subject.description.should eql('Meet with customer') }
+
+    it { subject.detail.should eql('Meeting at Coffee shop') }
+
+    it { subject.owner.should be_a(CapsuleCRM::User) }
+
+    it { subject.party.should be_a(CapsuleCRM::Person) }
+  end
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/tasks$/).
+        to_return(body: File.read('spec/support/all_tasks.json'))
+    end
+
+    subject { CapsuleCRM::Task.all }
+
+    it { should be_a(Array) }
+
+    it do
+      subject.all? { |item| item.is_a?(CapsuleCRM::Task) }.should be_true
+    end
+
+    it { subject.length.should eql(1) }
+
+    it { subject.first.description.should eql('Meet with customer') }
+  end
+
+  describe '.create' do
+    context 'when it is valid' do
+      before do
+        location = 'https://sample.capsulecrm.com/api/task/59'
+        stub_request(:post, /\/api\/task$/).
+          to_return(headers: { 'Location' => location })
+      end
+
+      subject { CapsuleCRM::Task.create Fabricate.attributes_for(:task) }
+
+      it { should be_a(CapsuleCRM::Task) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is not valid' do
+      subject { CapsuleCRM::Task.create }
+
+      it { should_not be_persisted }
+    end
+  end
+
+  describe '.create!' do
+    context 'when it is valid' do
+      before do
+        location = 'https://sample.capsulecrm.com/api/task/59'
+        stub_request(:post, /\/api\/task$/).
+          to_return(headers: { 'Location' => location })
+      end
+
+      subject { CapsuleCRM::Task.create! Fabricate.attributes_for(:task) }
+
+      it { should be_a(CapsuleCRM::Task) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is not valid' do
+      subject { CapsuleCRM::Task.create! }
+
+      it do
+        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
+  end
+
+  describe '#save' do
+    let(:task) { Fabricate.build(:task) }
+
+    context 'when it is a new record' do
+      before do
+        location = 'https://sample.capsulecrm.com/api/task/59'
+        stub_request(:post, /\/api\/task$/).
+          to_return(headers: { 'Location' => location })
+      end
+
+      subject { task.save }
+
+      it { subject.id.should eql(59) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is an existing record' do
+      before do
+        task.id = 12
+        stub_request(:put, /\/api\/task\/12$/).to_return(status: 200)
+      end
+
+      subject { task.save }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is invalid' do
+      it { subject.save.should be_false }
+    end
+  end
+
+  describe '#save!' do
+    let(:task) { Fabricate.build(:task) }
+
+    context 'when it is a new record' do
+      before do
+        location = 'https://sample.capsulecrm.com/api/task/59'
+        stub_request(:post, /\/api\/task$/).
+          to_return(headers: { 'Location' => location })
+      end
+
+      subject { task.save! }
+
+      it { subject.id.should eql(59) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is an existing record' do
+      before do
+        task.id = 12
+        stub_request(:put, /\/api\/task\/12$/).to_return(status: 200)
+      end
+
+      subject { task.save! }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is invalid' do
+      it do
+        expect { subject.save! }.
+          to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
+  end
+
+  describe '#update_attributes' do
+    context 'when it is valid' do
+      let(:task) { Fabricate.build(:task, id: 1) }
+
+      subject { task.update_attributes description: Faker::Lorem.sentence }
+
+      before { stub_request(:put, /\/api\/task\/1$/).to_return(status: 200) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is not valid' do
+      let(:task) { CapsuleCRM::Task.new(id: 1) }
+
+      subject { task.update_attributes }
+
+      it { should be_false }
+    end
+  end
+
+  describe '#update_attributes!' do
+    context 'when it is valid' do
+      let(:task) { Fabricate.build(:task, id: 1) }
+
+      subject { task.update_attributes! description: Faker::Lorem.sentence }
+
+      before { stub_request(:put, /\/api\/task\/1$/).to_return(status: 200) }
+
+      it { should be_persisted }
+    end
+
+    context 'when it is not valid' do
+      let(:task) { CapsuleCRM::Task.new(id: 1) }
+
+      subject { task.update_attributes! }
+
+      it do
+        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
+  end
+
+  describe '#destroy' do
+    subject { Fabricate.build(:task, id: 1) }
+
+    before do
+      stub_request(:delete, /\/api\/task\/1$/).to_return(status: 200)
+      subject.destroy
+    end
+
+    it { should_not be_persisted }
+  end
+
+  # Not really sure what to test here. CapsuleCRM API doesn't actually tell you
+  # anything about a tasks state
+  describe '#complete' do
+    let(:task) { Fabricate.build(:task, id: 2) }
+
+    subject { task.complete }
+
+    before do
+      stub_request(:post, /\/api\/task\/#{task.id}\/complete$/).
+        to_return(status: 200)
+      task.complete
+    end
+
+    it { should be_persisted }
+  end
+
+  describe '#reopen' do
+    let(:task) { Fabricate.build(:task, id: 3) }
+
+    subject { task.reopen }
+
+    before do
+      stub_request(:post, /\/api\/task\/#{task.id}\/reopen$/).
+        to_return(status: 200)
+    end
+
+    it { should be_persisted }
+  end
+
+  describe '.categories' do
+    subject { CapsuleCRM::Task.categories }
+
+    before do
+      stub_request(:get, /\/api\/task\/categories$/).
+        to_return(body: File.read('spec/support/task_categories.json'))
+    end
+
+    it do
+      expect(subject).to eql(%w(Call Email Follow-up Meeting Milestone Send))
+    end
+  end
+
+  describe '#to_capsule_json' do
+    let(:task) { Fabricate.build(:task) }
+
+    subject { task.to_capsule_json }
+
+    it { expect(subject.keys).to include('task') }
+
+    it { expect(subject['task']['description']).to eql(task.description) }
+
+    it { expect(subject['task']['dueDate']).to eql(task.due_date.to_s) }
+
+    context 'when it has an owner' do
+      let(:owner) { CapsuleCRM::User.new(username: 'matt.beedle') }
+
+      before { task.owner = owner }
+
+      it { expect(subject['task']['owner']).to eql(task.owner.username) }
+    end
+  end
+end

data/spec/support/all_tasks.json

@@ -0,0 +1,16 @@
+{
+  "tasks": {
+    "task": [
+      {
+        "id": "100",
+        "dueDate": "2012-02-24T00:00:00Z",
+        "category": "Meeting",
+        "partyName": "Eric Jones",
+        "description": "Meet with customer",
+        "owner": "a.user",
+        "detail": "Meeting at Coffee shop",
+        "partyId": "1"
+      }
+    ]
+  }
+}

data/spec/support/task.json

@@ -0,0 +1,12 @@
+{
+  "task": {
+    "id": "100",
+    "dueDate": "2012-02-24T00:00:00Z",
+    "category": "Meeting",
+    "partyName": "Eric Jones",
+    "description": "Meet with customer",
+    "owner": "a.user",
+    "detail": "Meeting at Coffee shop",
+    "partyId": "1"
+  }
+}

data/spec/support/task_categories.json

@@ -0,0 +1,12 @@
+{
+  "taskCategories": {
+    "taskCategory": [
+      "Call",
+      "Email",
+      "Follow-up",
+      "Meeting",
+      "Milestone",
+      "Send"
+    ]
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.6
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -266,6 +266,7 @@ files:
 - lib/capsule_crm/results_proxy.rb
 - lib/capsule_crm/tag.rb
 - lib/capsule_crm/taggable.rb
+- lib/capsule_crm/task.rb
 - lib/capsule_crm/user.rb
 - lib/capsule_crm/version.rb
 - lib/capsule_crm/website.rb
@@ -274,6 +275,7 @@ files:
 - spec/fabricators/opportunity_fabricator.rb
 - spec/fabricators/organization_fabricator.rb
 - spec/fabricators/person_fabricator.rb
+- spec/fabricators/task_fabricator.rb
 - spec/lib/capsule_crm/address_spec.rb
 - spec/lib/capsule_crm/associations/has_many_proxy_spec.rb
 - spec/lib/capsule_crm/associations/has_many_spec.rb
@@ -288,6 +290,7 @@ files:
 - spec/lib/capsule_crm/person_spec.rb
 - spec/lib/capsule_crm/tag_spec.rb
 - spec/lib/capsule_crm/taggable_spec.rb
+- spec/lib/capsule_crm/task_spec.rb
 - spec/lib/capsule_crm/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
@@ -296,6 +299,7 @@ files:
 - spec/support/all_parties.json
 - spec/support/all_people.json
 - spec/support/all_tags.json
+- spec/support/all_tasks.json
 - spec/support/all_users.json
 - spec/support/case.json
 - spec/support/countries.json
@@ -306,6 +310,8 @@ files:
 - spec/support/opportunity.json
 - spec/support/organisation.json
 - spec/support/person.json
+- spec/support/task.json
+- spec/support/task_categories.json
 homepage: ''
 licenses: []
 metadata: {}
@@ -336,6 +342,7 @@ test_files:
 - spec/fabricators/opportunity_fabricator.rb
 - spec/fabricators/organization_fabricator.rb
 - spec/fabricators/person_fabricator.rb
+- spec/fabricators/task_fabricator.rb
 - spec/lib/capsule_crm/address_spec.rb
 - spec/lib/capsule_crm/associations/has_many_proxy_spec.rb
 - spec/lib/capsule_crm/associations/has_many_spec.rb
@@ -350,6 +357,7 @@ test_files:
 - spec/lib/capsule_crm/person_spec.rb
 - spec/lib/capsule_crm/tag_spec.rb
 - spec/lib/capsule_crm/taggable_spec.rb
+- spec/lib/capsule_crm/task_spec.rb
 - spec/lib/capsule_crm/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
@@ -358,6 +366,7 @@ test_files:
 - spec/support/all_parties.json
 - spec/support/all_people.json
 - spec/support/all_tags.json
+- spec/support/all_tasks.json
 - spec/support/all_users.json
 - spec/support/case.json
 - spec/support/countries.json
@@ -368,3 +377,5 @@ test_files:
 - spec/support/opportunity.json
 - spec/support/organisation.json
 - spec/support/person.json
+- spec/support/task.json
+- spec/support/task_categories.json