capsule_crm 0.0.6 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27fbb70234eb3c2f46340bb621531d44ef172089
-  data.tar.gz: 545a7d2b1f2dba314ed4e399fff534e56a549a54
+  metadata.gz: 808ce675363a8bae072d7242b8973f41cf5e0c08
+  data.tar.gz: edb34f7e67119375ed840b6da034b2fa653ea116
 SHA512:
-  metadata.gz: 5a8948dc7c1ca6c64a084b31e371f1b51ddff6e15ef991878a2b3985a84ae3a004021883a0d32603c5050cf9753d03ad96a5560f0e287cdb2c4c73bc50c21453
-  data.tar.gz: 925f7f147a537fef527ecce482a9b8975fb5ca2a230ea70c0dab2bc87997963b15faee4408b8b193584aa4e3601848600a0b2cea3e439a458cc5474bd3f5cbac
+  metadata.gz: 5d0464a4804f4551450541ff4e237d9b04eb94581d074a7460b51eb4ab4dc6008109a98774778e597ad8c9534240e3899a291edb6cc7ad63253c92c9656f5628
+  data.tar.gz: 56388862805ba1ad015807817c545d9688930d87da6e4b96971e17d68e8d40a9a0adcfd9e92021d30419d69fe1e07db7b43a552ae92dd1c2cd728121d7a5327b

data/README.md

@@ -31,7 +31,17 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-person = CapsuleCRM::Person.new(first_name: 'Matt', last_name: 'Beedle', organisation_name: "Matt's Company")
+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']
+)
+
+person = CapsuleCRM::Person.new(
+  first_name: 'Matt', last_name: 'Beedle', organisation_name: "Matt's Company",
+  contacts: contacts
+)
 person.save
 
 person.first_name = 'John'
@@ -39,6 +49,17 @@ person.save #=> true
 
 person.valid? #=> true
 
+person.organization #=> CapsuleCRM::Organization
+
+person.organization.tap do |org|
+  org.update_attributes! contacts: CapsuleCRM::Contacts.new(
+    addresses: CapsuleCRM::Address.new(street: 'Thurneysserstr')
+  )
+
+  org.contacts.phones << CapsuleCRM::Phone.new(phone_number: '234243')
+  org.save
+end
+
 person.first_name = nil
 person.last_name = nil
 person.valid? #=> false
@@ -49,6 +70,9 @@ person.save! #=> CapsuleCRM::Errors::InvalidRecord
 person.destroy #=> true
 
 person = CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
+
+kase = CapsuleCRM::Case.create! name: 'My First Case', party: person
+kase.update_attributes name: 'A New Case Name'
 ```
 
 ## Contributing

data/lib/capsule_crm/case.rb

@@ -7,6 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations::BelongsTo
+    include CapsuleCRM::Taggable
 
     attribute :id, Integer
     attribute :name, String

data/lib/capsule_crm/connection.rb

@@ -14,13 +14,16 @@ module CapsuleCRM
       JSON.parse response.body
     end
 
-    def self.post(path, params)
+    def self.post(path, params = {})
       response = faraday.post(path, params.to_json) do |request|
         request.headers.update default_request_headers
       end
       if response.success?
-        id = response.headers['Location'].match(/\/(?<id>\d+)$/)[:id]
-        { id: id }
+        if match = response.headers['Location'].match(/\/(?<id>\d+)$/)
+          { id: match[:id] }
+        else
+          true
+        end
       else
         false
       end

data/lib/capsule_crm/contacts.rb

@@ -15,10 +15,10 @@ module CapsuleCRM
     #
     # Returns a CapsuleCRM::Contact
     def initialize(attributes = {})
-      self.addresses  = attributes[:addresses]
-      self.emails     = attributes[:emails]
-      self.phones     = attributes[:phones]
-      self.websites   = attributes[:websites]
+      self.addresses  = Array(attributes[:addresses])
+      self.emails     = Array(attributes[:emails])
+      self.phones     = Array(attributes[:phones])
+      self.websites   = Array(attributes[:websites])
     end
 
     # Public: Sets the addresses for this contacts container

data/lib/capsule_crm/organization.rb

@@ -11,6 +11,7 @@ module CapsuleCRM
     include ActiveModel::Validations::Callbacks
 
     include CapsuleCRM::Associations::HasMany
+    include CapsuleCRM::Taggable
 
     attribute :id,    Integer
     attribute :name,  String

data/lib/capsule_crm/party.rb

@@ -1,4 +1,5 @@
 class CapsuleCRM::Party
+  include CapsuleCRM::Taggable
 
   def self.all(options = {})
     attributes = CapsuleCRM::Connection.get('/api/party', options)

data/lib/capsule_crm/tag.rb

@@ -0,0 +1,13 @@
+module CapsuleCRM
+  class Tag
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :name
+
+    validates :name, presence: true
+  end
+end

data/lib/capsule_crm/taggable.rb

@@ -0,0 +1,23 @@
+module CapsuleCRM
+  module Taggable
+    extend ActiveSupport::Concern
+
+    def tags
+      CapsuleCRM::Connection.get(
+        "/api/#{api_singular_name}/#{id}/tag"
+      )['tags']['tag'].map { |item| CapsuleCRM::Tag.new(item) }
+    end
+
+    def add_tag(tag_name)
+      if id
+        CapsuleCRM::Connection.post(
+          "/api/#{api_singular_name}/#{id}/#{URI.encode(tag_name)}"
+        )
+      end
+    end
+
+    def api_singular_name
+      self.class.to_s.demodulize.downcase.singularize
+    end
+  end
+end

data/lib/capsule_crm/user.rb

@@ -0,0 +1,34 @@
+module CapsuleCRM
+  class User
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include CapsuleCRM::Associations::BelongsTo
+
+    attribute :username, String
+    attribute :name, String
+    attribute :currency, String
+    attribute :timezone, String
+    attribute :logged_in, Boolean
+
+    belongs_to :party, class_name: 'CapsuleCRM::Party'
+
+    # Public: Retrieve all users from CapsuleCRM
+    #
+    # Examples:
+    #
+    # CapsuleCRM::User.all
+    #
+    # Returns a CapsuleCRM::ResultsProxy of CapsuleCRM::User objects
+    def self.all
+      CapsuleCRM::ResultsProxy.new(
+        CapsuleCRM::Connection.get('/api/users')['users']['user'].map do |item|
+          new item
+        end
+      )
+    end
+  end
+end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.0.6'
+  VERSION = '0.1.6'
 end

data/lib/capsule_crm.rb

@@ -3,6 +3,7 @@ require 'faraday'
 require 'faraday_middleware'
 require 'virtus'
 require 'capsule_crm/capsule_jsonable'
+require 'capsule_crm/taggable'
 require 'capsule_crm/associations'
 require 'capsule_crm/address'
 require 'capsule_crm/case'
@@ -10,6 +11,8 @@ require 'capsule_crm/connection'
 require 'capsule_crm/email'
 require 'capsule_crm/party'
 require 'capsule_crm/phone'
+require 'capsule_crm/tag'
+require 'capsule_crm/user'
 require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'
 require 'capsule_crm/results_proxy'

data/spec/lib/capsule_crm/tag_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Tag do
+
+  it { should validate_presence_of(:name) }
+end

data/spec/lib/capsule_crm/taggable_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class TaggableItem
+  include CapsuleCRM::Taggable
+  include Virtus
+
+  attribute :id
+end
+
+describe CapsuleCRM::Taggable do
+  before { configure }
+
+  describe '#tags' do
+    before do
+      stub_request(:get, /\/api\/taggableitem\/1\/tag$/).
+        to_return(body: File.read('spec/support/all_tags.json'))
+    end
+
+    let(:taggable_item) { TaggableItem.new(id: 1) }
+
+    subject { taggable_item.tags }
+
+    it { should be_a(Array) }
+
+    it { subject.length.should eql(2) }
+
+    it do
+      subject.all? { |item| item.is_a?(CapsuleCRM::Tag) }.should be_true
+    end
+
+    it { subject.first.name.should eql('Customer') }
+
+    it { subject.last.name.should eql('VIP') }
+  end
+
+  describe '#add_tag' do
+    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(:post, /\/api\/taggableitem\/1\/A%20Test%20Tag$/).
+          to_return(headers: { 'Location' =>  loc })
+      end
+
+      subject { taggable_item.add_tag 'A Test Tag' }
+
+      it { subject.should be_true }
+    end
+
+    context 'when the taggable item has no id' do
+      let(:taggable_item) { TaggableItem.new }
+
+      subject { taggable_item.add_tag 'A Test Tag' }
+
+      it { subject.should be_nil }
+    end
+  end
+end

data/spec/lib/capsule_crm/user_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe CapsuleCRM::User do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/users$/).
+        to_return(body: File.read('spec/support/all_users.json'))
+    end
+
+    subject { CapsuleCRM::User.all }
+
+    it { should be_a(Array) }
+
+    it { subject.length.should eql(2) }
+
+    it { subject.all? { |item| item.is_a?(CapsuleCRM::User) }.should be_true }
+  end
+end

data/spec/support/all_tags.json

@@ -0,0 +1,12 @@
+{
+  "tags": {
+    "tag": [
+      {
+        "name": "Customer"
+      },
+      {
+        "name": "VIP"
+      }
+    ]
+  }
+}

data/spec/support/all_users.json

@@ -0,0 +1,21 @@
+{
+  "users": {
+    "user": [
+      {
+        "username": "a.user",
+        "currency": "GBP",
+        "name": "Alfred User",
+        "loggedIn": "true",
+        "timezone": "Europe/London",
+        "partyId": "100"
+      },
+      {
+        "username": "j.joe",
+        "currency": "GBP",
+        "name": "Jane Doe",
+        "timezone": "Europe/London",
+        "partyId": "101"
+      }
+    ]
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.6
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-11 00:00:00.000000000 Z
+date: 2013-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -244,6 +244,9 @@ files:
 - lib/capsule_crm/person.rb
 - lib/capsule_crm/phone.rb
 - lib/capsule_crm/results_proxy.rb
+- lib/capsule_crm/tag.rb
+- lib/capsule_crm/taggable.rb
+- lib/capsule_crm/user.rb
 - lib/capsule_crm/version.rb
 - lib/capsule_crm/website.rb
 - spec/fabricators/opportunity_fabricator.rb
@@ -257,11 +260,16 @@ files:
 - spec/lib/capsule_crm/opportunity_spec.rb
 - spec/lib/capsule_crm/organization_spec.rb
 - 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/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
 - spec/support/all_opportunities.json
 - spec/support/all_parties.json
 - spec/support/all_people.json
+- spec/support/all_tags.json
+- spec/support/all_users.json
 - spec/support/case.json
 - spec/support/deleted_opportunities.json
 - spec/support/helpers.rb
@@ -304,11 +312,16 @@ test_files:
 - spec/lib/capsule_crm/opportunity_spec.rb
 - spec/lib/capsule_crm/organization_spec.rb
 - 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/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
 - spec/support/all_opportunities.json
 - spec/support/all_parties.json
 - spec/support/all_people.json
+- spec/support/all_tags.json
+- spec/support/all_users.json
 - spec/support/case.json
 - spec/support/deleted_opportunities.json
 - spec/support/helpers.rb