capsule_crm 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e0eebbeda04a3250c97232ea18644a14122faf
-  data.tar.gz: ea18da6190a19d6d2d45b70950d1fbab38eeb92e
+  metadata.gz: 3b03a8a029e80b9ea38a3769a8cd9ac51a36a2c8
+  data.tar.gz: e43d7db346766c213fc62c30ee08b30aa61a0888
 SHA512:
-  metadata.gz: 8cb6dba2711c9b58643bf0770a62a1be126fce21e46846935c32e152517e4a32cc4345ae4ba79985dec406e07d11d2b5c8908cafc5718fb4cef114277d010bb8
-  data.tar.gz: 75c1f04e11c7d9dcbbd94736d4ba0feb7e8750c26e56bfd145325499a1caab8f2bf71d23f27121e2a9a9b35a4815414c4baa6ccd8f85a306dc18dc148b55fd27
+  metadata.gz: 737d7f366484bdea5916fc1cab2680577ca48c6c2a2f2aa2a056c9e0b1da65fcef07abe30636fddfd38bafca4146e38a4126e8e579686d52856e87d39c906fd4
+  data.tar.gz: 6229c13b72a40d24d83c53598688be4663cd3dc5c366e6036baf7e0fa24dda029c50e71800714cc64134f2fe45486ca7061abd4b14b42f2070620e33244fdc03

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
   - jruby-19mode

data/README.md

@@ -31,53 +31,271 @@ Or install it yourself as:
 
     $ gem install capsule_crm
 
+## Getting Started
+
+You need to configure CapsuleCRM with your API Token and subdomain before you
+can make any requests to it. If you are using rails then you can put this into
+your config/initializers folder.
+```ruby
+CapsuleCRM.configure do |config|
+  config.api_token = 'API Token here'
+  config.subdomain = 'your capsule crm company subdomain here'
+end
+```
+
 ## Usage
 
+### Parties
 ```ruby
-contacts = CapsuleCRM::Contacts.new(
-  addresses:  [CapsuleCRM::Address.new(street: 'Oranieburgerstr', city: 'Berlin')],
-  emails:     [CapsuleCRM::Email.new(email_address: 'mattbeedle@gmail.com')],
-  phones:     [CapsuleCRM::Phone.new(phone_number: '123456789')],
-  webstes:    [CapsuleCRM::Website.new(web_service: 'URL', web_address: 'http://github.com']
-)
+# List Parties
+CapsuleCRM::Party.all
 
-person = CapsuleCRM::Person.new(
-  first_name: 'Matt', last_name: 'Beedle', organisation_name: "Matt's Company",
-  contacts: contacts
+# With query parameters
+CapsuleCRM::Party.all(
+  q: 'search term here', email: 'email to search for here',
+  lastmodified: 6.weeks.ago, tag: 'tag to search for here',
+  start: 10, limit: 55
 )
+
+# Find one
+# When the party is an organization this returns a CapsuleCRM::Organization
+# otherise it returns a CapsuleCRM::Person
+party = CapsuleCRM::Party.find(ID)
+```
+
+### People
+```ruby
+# Find a person
+person = CapsuleCRM::Person.find(ID)
+
+# List People
+CapsuleCRM::Person.all
+
+# Initialize a new person
+person = CapsuleCRM::Person.new(first_name: 'Matt', last_name: 'Beedle')
+
+# Validate a person
+person.valid?
+
+# Save a person
 person.save
 
-person.first_name = 'John'
-person.save #=> true
+# Update a person
+person.update_attributes first_name: 'John'
 
-person.valid? #=> true
+# Create a Person
+person = CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
 
-person.organization #=> CapsuleCRM::Organization
+# Get organization associated with a person
+person.organization
 
-person.organization.tap do |org|
-  org.update_attributes! contacts: CapsuleCRM::Contacts.new(
-    addresses: CapsuleCRM::Address.new(street: 'Thurneysserstr')
-  )
+# Delete a person
+person.destroy
 
-  org.contacts.phones << CapsuleCRM::Phone.new(phone_number: '234243')
-  org.save
-end
+# List opportunities
+person.opportunities
 
-person.first_name = nil
-person.last_name = nil
-person.valid? #=> false
+# List tags
+person.tags
 
-person.save #=> false
-person.save! #=> CapsuleCRM::Errors::InvalidRecord
+# Add a tag
+person.add_tag 'a test tag'
 
-person.destroy #=> true
+# View history
+person.histories
 
-person = CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
+# Build a new history item
+history_item = person.histories.build note: 'a note'
+
+# Create a new history item
+history_item = person.histories.create note: 'a note'
+```
+
+### Organizations
+```ruby
+# Find an organization
+organization = CapsuleCRM::Organization.find(ID)
+
+# List Organizations
+CapsuleCRM::Organization.all
+
+# Initialize a new organization
+org = CapsuleCRM::Organization.new(name: 'Vegan.io')
+
+# Validate an organization
+org.valid?
+
+# Save an organization
+org.save
+
+# Update an organization
+org.update_attributes name: 'Apple Inc'
+
+# Create an organization
+org = CapsuleCRM::Organization.create(name: 'Vegan.io')
+
+# Get people for an organization
+org.people
+
+# Delete an organization
+org.destroy
+
+# List opportunities
+org.opportunities
+
+# List tags
+org.tags
+
+# Add a tag
+org.add_tag 'a test tag'
+
+# View history
+org.histories
+
+# Build a new history item
+history = org.histories.build note: 'some note text'
+
+# Create a new history item
+history = org.histories.create note: 'some note text'
+```
+
+### Opportunities
+```ruby
+# Find an opportunity
+opportunity = CapsuleCRM::Opportunity.find(ID)
+
+# List all opportunities
+opportunities = CapsuleCRM::Opportunity.all
+
+# List tags
+opportunity.tags
+
+# Add a tag
+opportunity.add_tag 'tag here'
+
+# View history
+opportunity.histories
+
+# Build a new history item
+history = opportunity.histories.build note: 'some note text'
+
+# Create a new history item
+history_item = opportunity.histories.create note: 'some text here'
+```
+
+### Cases
+```ruby
+# Find a case
+kase = CapsuleCRM::Case.find(ID)
+
+# List Cases
+kase = CapsuleCRM::Case.all
+
+# Update a Case
+kase.update_attributes status: 'CLOSED'
+
+# Delete a Case
+kase.destroy
+
+# List tags
+kase.tags
+
+# Add a tag
+kase.add_tag 'A test tag'
+
+# View history
+kase.histories
+
+# Build a new history
+history = kase.histories.build note: 'note text here'
+
+# Create a new history item
+history_item = kase.histories.create note: 'another note'
+```
+
+### History
+```ruby
+# Find a history item
+history_item = CapsuleCRM::History.find(ID)
+
+# Get the party
+history_item.party
+
+# Get the case
+history_item.case
+
+# Get the opportunity
+history_item.opportunity
+
+# Update a history item
+history_item.update_attributes note: 'some new note text'
+
+# Delete a history item
+history_item.destroy
+```
+
+### Tasks
+```ruby
+# List open tasks
+tasks = CapsuleCRM::Task.all
 
-kase = CapsuleCRM::Case.create! name: 'My First Case', party: person
-kase.update_attributes name: 'A New Case Name'
+# Query open tasks
+tasks = CapsuleCRM::Task.all(
+  category: 'category name', user: 'username', start: 6, limit: 25
+)
+
+# Add a task
+CapsuleCRM::Task.create(
+  description: 'task description', due_date: Date.tomorrow
+)
+
+# Update task
+task.update_attributes description: 'a new improved task description'
+
+# Delete a task
+task.destroy
+
+# Complete a task
+task.complete
+
+# Reopen a task
+task.reopen
+
+# List available task categories
+CapsuleCRM::Task.categories
+```
+
+### Users
+```ruby
+# List all users
+CapsuleCRM::User.all
+
+# Find a user by username
+user = CapsuleCRM::User.find_by_username('username here')
+```
+
+### Countries
+```ruby
+# List all countries
+CapsuleCRM::Country.all
 ```
 
+### Currencies
+```ruby
+# List all currencies
+CapsuleCRM::Currency.all
+```
+
+## Supported Rubies
+
+1.9.2, 1.9.3, 2.0, jruby-19mode, rbx-19mode
+
+## Feedback
+
+Please use github issues to give feedback. If you have a bug to report then an
+accompanying failing test would be great. Extra points for a full pull request
+with fix.
+
 ## Contributing
 
 1. Fork it

data/lib/capsule_crm/history.rb

@@ -27,6 +27,40 @@ module CapsuleCRM
     validates :party, :kase, :opportunity,
       presence: { if: :belongs_to_required? }
 
+    def self._for_party(party_id)
+      init_collection(
+        CapsuleCRM::Connection.
+          get("/api/party/#{party_id}/history")['history'].
+          fetch('historyItem', nil)
+      )
+    end
+
+    class << self
+      alias :_for_organization :_for_party
+      alias :_for_person :_for_party
+    end
+
+    def self._for_case(case_id)
+      init_collection(
+        CapsuleCRM::Connection.
+          get("/api/kase/#{case_id}/history")['history']['historyItem']
+      )
+    end
+
+    def self._for_opportunity(opportunity_id)
+      init_collection(
+        CapsuleCRM::Connection.
+          get("/api/opportunity/#{opportunity_id}/history")\
+          ['history']['historyItem']
+      )
+    end
+
+    def self.init_collection(collection)
+      CapsuleCRM::ResultsProxy.new(
+        [collection].flatten.delete_if(&:blank?).map { |item| new(item) }
+      )
+    end
+
     # Public: Underscore all of the attributes keys and set the attributes of
     # this history item
     #

data/lib/capsule_crm/milestone.rb

@@ -0,0 +1,34 @@
+module CapsuleCRM
+  class Milestone
+    include Virtus
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :description, String
+    attribute :probability, Float
+    attribute :complete, Boolean
+
+    def self.all
+      init_collection(
+        CapsuleCRM::Connection.
+          get('/api/opportunity/milestones')['milestones']['milestone']
+      )
+    end
+
+    def self.find(id)
+      all.select { |item| item.id == id }.first
+    end
+
+    def self.find_by_name(name)
+      all.select { |item| item.name == name }.first
+    end
+
+    private
+
+    def self.init_collection(collection)
+      CapsuleCRM::ResultsProxy.new(
+        collection.map { |attributes| new attributes }
+      )
+    end
+  end
+end

data/lib/capsule_crm/opportunity.rb

@@ -24,10 +24,19 @@ module CapsuleCRM
 
     validates :name, presence: true
     validates :party_id, presence: true
-    validates :milestone_id, presence: { unless: :milestone }
-    validates :milestone, presence: { unless: :milestone_id }
+    validates :milestone, presence: true
 
     belongs_to :party, class_name: 'CapsuleCRM::Party'
+    belongs_to :milestone, class_name: 'CapsuleCRM::Milestone'
+
+    def milestone=(milestone)
+      if milestone.is_a?(String)
+        milestone = CapsuleCRM::Milestone.find_by_name(milestone)
+      end
+      @milestone = milestone
+      self.milestone_id = milestone.try(:id)
+      self
+    end
 
     # Public: Set the attributes of a opportunity
     #

data/lib/capsule_crm/party.rb

@@ -3,7 +3,7 @@ class CapsuleCRM::Party
 
   include CapsuleCRM::Associations::HasMany
 
-  has_many :histories, class_name: 'CapsuleCRM::History'
+  has_many :histories, class_name: 'CapsuleCRM::History', source: :party
 
   def self.all(options = {})
     attributes = CapsuleCRM::Connection.get('/api/party', options)

data/lib/capsule_crm/taggable.rb

@@ -16,6 +16,14 @@ module CapsuleCRM
       end
     end
 
+    def remove_tag(tag_name)
+      if id
+        CapsuleCRM::Connection.delete(
+          "/api/#{api_singular_name}/#{id}/#{URI.encode(tag_name)}"
+        )
+      end
+    end
+
     def api_singular_name
       self.class.to_s.demodulize.downcase.singularize
     end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.5.7'
+  VERSION = '0.6.0'
 end

data/lib/capsule_crm.rb

@@ -30,6 +30,7 @@ require 'capsule_crm/opportunity'
 require 'capsule_crm/organization'
 require 'capsule_crm/participant'
 require 'capsule_crm/person'
+require 'capsule_crm/milestone'
 require 'capsule_crm/version'
 
 module CapsuleCRM

data/spec/lib/capsule_crm/history_spec.rb

@@ -3,8 +3,99 @@ require 'spec_helper'
 describe CapsuleCRM::History do
   before { configure }
 
+  before do
+    stub_request(:get, /\/api\/users$/).
+      to_return(body: File.read('spec/support/all_users.json'))
+    stub_request(:get, /\/api\/opportunity\/milestones$/).
+      to_return(body: File.read('spec/support/milestones.json'))
+  end
+
   it { should validate_presence_of(:note) }
 
+  describe '_.for_party' do
+    let(:party) { Fabricate.build(:person, id: 1) }
+
+    subject { CapsuleCRM::History._for_party(party.id) }
+
+    context 'when there are some history items' do
+      before do
+        stub_request(:get, /\/api\/party\/#{party.id}\/history$/).
+          to_return(body: File.read('spec/support/all_history.json'))
+      end
+
+      it { should be_a(Array) }
+
+      it do
+        subject.all? { |item| item.is_a?(CapsuleCRM::History) }.should be_true
+      end
+    end
+
+    context 'when there are no history items' do
+      before do
+        stub_request(:get, /\/api\/party\/#{party.id}\/history$/).
+          to_return(body: File.read('spec/support/no_history.json'))
+      end
+
+      it { should be_blank }
+    end
+  end
+
+  describe '._for_case' do
+    let(:kase) { Fabricate.build(:case, id: 1) }
+
+    subject { CapsuleCRM::History._for_case(kase.id) }
+
+    context 'when there are some history items' do
+      before do
+        stub_request(:get, /\/api\/kase\/#{kase.id}\/history$/).
+          to_return(body: File.read('spec/support/all_history.json'))
+      end
+
+      it { should be_a(Array) }
+
+      it do
+        subject.all? { |item| item.is_a?(CapsuleCRM::History) }.should be_true
+      end
+    end
+
+    context 'when there are no history items' do
+      before do
+        stub_request(:get, /\/api\/kase\/#{kase.id}\/history$/).
+          to_return(body: File.read('spec/support/no_history.json'))
+      end
+
+      it { should be_blank }
+    end
+  end
+
+  describe '._for_opportunity' do
+    let(:opportunity) { Fabricate.build(:opportunity, id: 1) }
+
+    subject { CapsuleCRM::History._for_opportunity(opportunity.id) }
+
+    context 'when there are some history items' do
+      before do
+        stub_request(:get, /\/api\/opportunity\/#{opportunity.id}\/history$/).
+          to_return(body: File.read('spec/support/all_history.json'))
+      end
+
+      it { should be_a(Array) }
+
+      it do
+        subject.all? { |item| item.is_a?(CapsuleCRM::History) }.should be_true
+      end
+    end
+
+    context 'when there are no history items' do
+      before do
+        stub_request(:get, /\/api\/opportunity\/#{opportunity.id}\/history$/).
+          to_return(body: File.read('spec/support/no_history.json'))
+      end
+
+      it { should be_blank }
+    end
+  end
+
   describe 'find' do
     before do
       stub_request(:get, /\/api\/history\/100$/).

data/spec/lib/capsule_crm/milestone_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Milestone do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/opportunity\/milestones$/).
+        to_return(body: File.read('spec/support/milestones.json'))
+    end
+
+    subject { CapsuleCRM::Milestone.all }
+
+    it { should be_a(Array) }
+
+    it do
+      subject.all? { |item| item.is_a?(CapsuleCRM::Milestone) }.should be_true
+    end
+
+    it do
+      expect(subject.first.description).
+        to eql('You have a potential buyer for your offering')
+    end
+
+    it { expect(subject.first.probability).to eql(10.0) }
+
+    it { expect(subject.first.complete).to be_false }
+  end
+end

data/spec/lib/capsule_crm/opportunity_spec.rb

@@ -3,24 +3,53 @@ require 'spec_helper'
 describe CapsuleCRM::Opportunity do
   before { configure }
 
-  it { should validate_presence_of(:name) }
+  before do
+    stub_request(:get, /\/api\/opportunity\/milestones$/).
+      to_return(body: File.read('spec/support/milestones.json'))
+  end
 
-  it { should validate_presence_of(:milestone_id) }
+  it { should validate_presence_of(:name) }
 
   it { should validate_presence_of(:milestone) }
 
   context 'when milestone_id is set' do
     subject { CapsuleCRM::Opportunity.new(milestone_id: 1) }
 
-    it { should_not validate_presence_of(:milestone) }
+    before do
+      subject.valid?
+    end
+
+    it { subject.errors[:milestone].should be_blank }
   end
 
   context 'when milestone is set' do
-    subject { CapsuleCRM::Opportunity.new(milestone: 'a') }
+    let(:milestone) { CapsuleCRM::Milestone.new name: 'Bid' }
+
+    subject { CapsuleCRM::Opportunity.new(milestone: milestone) }
 
     it { should_not validate_presence_of(:milestone_id) }
   end
 
+  describe '#milestone=' do
+    context 'when it receives a milestone name' do
+      subject { CapsuleCRM::Opportunity.new(milestone: 'Bid') }
+
+      it { subject.milestone.should be_a(CapsuleCRM::Milestone) }
+
+      it { subject.milestone_id.should_not be_blank }
+    end
+
+    context 'when it receives a milestone object' do
+      let(:milestone) { CapsuleCRM::Milestone.all.first }
+
+      subject { CapsuleCRM::Opportunity.new(milestone: milestone) }
+
+      it { subject.milestone.should be_a(CapsuleCRM::Milestone) }
+
+      it { subject.milestone_id.should_not be_blank }
+    end
+  end
+
   describe '#party=' do
     let(:opportunity) { Fabricate.build(:opportunity, party: nil) }
 
@@ -110,7 +139,7 @@ describe CapsuleCRM::Opportunity do
 
   describe '.find' do
     before do
-      stub_request(:get, /.*/).
+      stub_request(:get, /\/api\/opportunity\/1$/).
         to_return(body: File.read('spec/support/opportunity.json'))
     end
 
@@ -138,7 +167,7 @@ describe CapsuleCRM::Opportunity do
 
     it { subject.owner.should eql('a.user') }
 
-    it { subject.milestone.should eql('Bid') }
+    it { subject.milestone.name.should eql('Bid') }
 
     it { subject.probability.should eql(50.0) }
 

data/spec/lib/capsule_crm/taggable_spec.rb

@@ -56,4 +56,29 @@ describe CapsuleCRM::Taggable do
       it { subject.should be_nil }
     end
   end
+
+  describe '#remove_tag' do
+
+    subject { taggable_item.remove_tag 'A Test Tag' }
+
+    context 'when the taggable item has an id' do
+      let(:taggable_item) { TaggableItem.new(id: 1) }
+
+      before do
+        loc = 'https://sample.capsulecrm.com/api/party/1000/tag/A%20Test%20Tag'
+        stub_request(:delete, /\/api\/taggableitem\/1\/A%20Test%20Tag$/).
+          to_return(headers: { 'Location' => loc })
+      end
+
+      it { subject.should be_true }
+    end
+
+    context 'when the taggable item has no id' do
+      let(:taggable_item) { TaggableItem.new }
+
+      subject { taggable_item.remove_tag 'A Test Tag' }
+
+      it { subject.should be_nil }
+    end
+  end
 end

data/spec/support/milestones.json

@@ -0,0 +1,32 @@
+{
+  "milestones": {
+    "milestone": [
+      {
+        "id": "1",
+        "name": "New",
+        "description": "You have a potential buyer for your offering",
+        "probability": "10",
+        "complete": "false"
+      },
+      {
+        "id": "2",
+        "name": "Bid",
+        "description": "You have put forward a bid for your offering",
+        "probability": "50",
+        "complete": "false"
+      },
+      {
+        "id": "3",
+        "name": "Won",
+        "probability": "100",
+        "complete": "true"
+      },
+      {
+        "id": "4",
+        "name": "Lost",
+        "probability": "0",
+        "complete": "true"
+      }
+    ]
+  }
+}

data/spec/support/no_history.json

@@ -0,0 +1,5 @@
+{
+  "history": {
+    "@size": "0"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-26 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -257,6 +257,7 @@ files:
 - lib/capsule_crm/errors/record_invalid.rb
 - lib/capsule_crm/hash_helper.rb
 - lib/capsule_crm/history.rb
+- lib/capsule_crm/milestone.rb
 - lib/capsule_crm/opportunity.rb
 - lib/capsule_crm/organization.rb
 - lib/capsule_crm/participant.rb
@@ -285,6 +286,7 @@ files:
 - spec/lib/capsule_crm/currency_spec.rb
 - spec/lib/capsule_crm/email_spec.rb
 - spec/lib/capsule_crm/history_spec.rb
+- spec/lib/capsule_crm/milestone_spec.rb
 - spec/lib/capsule_crm/opportunity_spec.rb
 - spec/lib/capsule_crm/organization_spec.rb
 - spec/lib/capsule_crm/party_spec.rb
@@ -308,6 +310,8 @@ files:
 - spec/support/deleted_opportunities.json
 - spec/support/helpers.rb
 - spec/support/history.json
+- spec/support/milestones.json
+- spec/support/no_history.json
 - spec/support/opportunity.json
 - spec/support/organisation.json
 - spec/support/person.json
@@ -353,6 +357,7 @@ test_files:
 - spec/lib/capsule_crm/currency_spec.rb
 - spec/lib/capsule_crm/email_spec.rb
 - spec/lib/capsule_crm/history_spec.rb
+- spec/lib/capsule_crm/milestone_spec.rb
 - spec/lib/capsule_crm/opportunity_spec.rb
 - spec/lib/capsule_crm/organization_spec.rb
 - spec/lib/capsule_crm/party_spec.rb
@@ -376,6 +381,8 @@ test_files:
 - spec/support/deleted_opportunities.json
 - spec/support/helpers.rb
 - spec/support/history.json
+- spec/support/milestones.json
+- spec/support/no_history.json
 - spec/support/opportunity.json
 - spec/support/organisation.json
 - spec/support/person.json