capsulecrm 0.0.2 → 0.0.3

data/capsulecrm.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name        = "capsulecrm"
   s.version     = CapsuleCRM::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ahmed Adam"]
-  s.email       = ["ahmed.msgs@gmail.com"]
-  s.homepage    = ""
+  s.authors     = ["Ahmed Adam", "Tadas Tamosauskas"]
+  s.email       = ["ahmed.msgs@gmail.com", "tadastoo@yahoo.com"]
+  s.homepage    = "https://github.com/ahmedrb/capsulecrm"
   s.summary     = %q{CapsuleCRM API Gem}
-  s.description = %q{CapsuleCRM API Gem}
+  s.description = %q{Wraps up a CapsuleCRM API}
 
   s.add_dependency 'httparty', '>= 0.7.4'
   s.add_dependency 'activemodel', '>= 3.0.5'

data/examples.rb

@@ -4,6 +4,11 @@
 # find by id
 person = CapsuleCRM::Person.find 123
 
+# or if you don't know what you are searching for Party
+something = CapsuleCRM::Party.find 123
+something.is?(:person)
+something.is?(:organisation)
+
 # find by email
 person = CapsuleCRM::Person.find_by_email 'foo@example.com'
 
@@ -46,6 +51,11 @@ person.phone_numbers # CapsuleCRM::Collection
 person.phone_numbers.first.number # 01234 56789
 person.phone_numbers.first.type   # work
 
+# Contacts: CapsuleCRM::Website (read-only)
+party.websites # CapsuleCRM::Collection
+party.websites.first.url # http://google.com
+party.websites.first.web_address # http://google.com
+
 # Contacts: CapsuleCRM::Email (read-only)
 person.emails # CapsuleCRM::Collection
 person.emails.first.address # 'foo@example.com'
@@ -63,3 +73,7 @@ person.addresses.first.country  # United Kingdom
 person.custom_fields # CapsuleCRM::Collection
 person.custom_fields.first.label # 'Favourite colour'
 person.custom_fields.first.value # 'Blue'
+
+# CapsuleCRM::Tag (read-only)
+person.tags # CapsuleCRM::Collection
+person.tag_names # ["array", "of all", "tags", "as strings"]

data/lib/capsulecrm.rb

@@ -38,3 +38,5 @@ require 'capsulecrm/contact'
 require 'capsulecrm/email'
 require 'capsulecrm/phone'
 require 'capsulecrm/address'
+require 'capsulecrm/tag'
+require 'capsulecrm/website'

data/lib/capsulecrm/organisation.rb

@@ -7,7 +7,7 @@ class CapsuleCRM::Organisation < CapsuleCRM::Party
   # nodoc
   def people
     return @people if @people
-    path = self.class.base_path
+    path = self.class.get_path
     path = [path, '/', id, '/people'].join
     last_response = self.class.get(path)
     @people = CapsuleCRM::Person.init_many(last_response)

data/lib/capsulecrm/party.rb

@@ -4,7 +4,7 @@ class CapsuleCRM::Party < CapsuleCRM::Base
   # nodoc
   def addresses
     return @addresses if @addresses
-    data = raw_data['contacts']['address']
+    data = raw_data['contacts'].try(:[], 'address')
     @addresses = CapsuleCRM::Address.init_many(self, data)
   end
 
@@ -12,18 +12,30 @@ class CapsuleCRM::Party < CapsuleCRM::Base
   # nodoc
   def custom_fields
     return @custom_fields if @custom_fields
-    path = self.class.base_path
+    path = self.class.get_path
     path = [path, '/', id, '/customfield'].join
     last_response = self.class.get(path)
-    data = last_response['customFields']['customField']
+    data = last_response['customFields'].try(:[], 'customField')
     @custom_fields = CapsuleCRM::CustomField.init_many(self, data)
   end
 
+  def tags
+    return @tags if @tags
+    path = self.class.get_path
+    path = [path, '/', id, '/tag'].join
+    last_response = self.class.get(path)
+    data = last_response['tags'].try(:[], 'tag')
+    @tags = CapsuleCRM::Tag.init_many(self, data)
+  end
+
+  def tag_names
+    tags.map(&:name)
+  end
 
   # nodoc
   def emails
     return @emails if @emails
-    data = raw_data['contacts']['email']
+    data = raw_data['contacts'].try(:[], 'email')
     @emails = CapsuleCRM::Email.init_many(self, data)
   end
 
@@ -31,10 +43,21 @@ class CapsuleCRM::Party < CapsuleCRM::Base
   # nodoc
   def phone_numbers
     return @phone_numbers if @phone_numbers
-    data = raw_data['contacts']['phone']
+    data = raw_data['contacts'].try(:[], 'phone')
     @phone_numbers = CapsuleCRM::Phone.init_many(self, data)
   end
 
+  # nodoc
+  def websites
+    return @websites if @websites
+    data = raw_data['contacts'].try(:[], 'website')
+    @websites = CapsuleCRM::Website.init_many(self, data)
+  end
+
+  def is?(kind)
+    required_class = kind.to_s.camelize
+    self.class.to_s.include? required_class
+  end
 
   # nodoc
   def self.get_path
@@ -60,5 +83,9 @@ class CapsuleCRM::Party < CapsuleCRM::Base
     find_all(options)
   end
 
-
+  def self.init_one(response)
+    return CapsuleCRM::Person.init_one(response) if response['person']
+    return CapsuleCRM::Organisation.init_one(response) if response['organisation']
+    raise CapsuleCRM::RecordNotRecognised, "Could not recognise returned entity type: #{response}"
+  end
 end

data/lib/capsulecrm/recorn_not_recognised.rb

@@ -0,0 +1 @@
+class CapsuleCRM::RecordNotRecognised < StandardError; end

data/lib/capsulecrm/tag.rb

@@ -0,0 +1,12 @@
+class CapsuleCRM::Tag < CapsuleCRM::Child
+
+  attr_accessor :name
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'name' => 'name'
+    }
+    super.merge map
+  end
+end

data/lib/capsulecrm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCRM
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/capsulecrm/website.rb

@@ -0,0 +1,19 @@
+class CapsuleCRM::Website < CapsuleCRM::Child
+
+  attr_accessor :web_address
+  attr_accessor :url
+  attr_accessor :web_service
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'webAddress' => 'web_address',
+      'url' => 'url',
+      'webService' => 'web_service'
+    }
+    super.merge map
+  end
+
+
+end

data/test/fixtures/responses/party_tags.yml

@@ -0,0 +1,26 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/10185257/tag
+    body:
+    headers:
+      user-agent:
+      - CapsuleCRM ruby gem
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - "*/*"
+      server:
+      - Apache
+      date:
+      - Tue, 12 Apr 2011 12:31:20 GMT
+      content-length:
+      - "426"
+      set-cookie:
+      - "[SESSION-COOKIE]"
+    body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><tags size="11"><tag><name>TMT</name></tag><tag><name>Industrials</name></tag><tag><name>Energy</name></tag><tag><name>Consumer</name></tag><tag><name>Healthcare</name></tag><tag><name>Professional Services</name></tag><tag><name>Mid-cap</name></tag><tag><name>Large-cap</name></tag><tag><name>EU</name></tag><tag><name>Asia</name></tag><tag><name>USA</name></tag></tags>
+    http_version: "1.1"

data/test/fixtures/responses/person_find_by_id.yml

@@ -1,76 +1,102 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
     uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/10185256
-    body: 
-    headers: 
-      user-agent: 
+    body:
+    headers:
+      user-agent:
       - CapsuleCRM ruby gem
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      content-type: 
+    headers:
+      content-type:
       - "*/*"
-      server: 
+      server:
       - Apache
-      date: 
+      date:
       - Tue, 12 Apr 2011 12:34:21 GMT
-      content-length: 
+      content-length:
       - "333"
-      set-cookie: 
+      set-cookie:
       - "[SESSION-COOKIE]"
     body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><organisation><id>10185256</id><contacts><email><id>18583945</id><emailAddress>gov@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/org_avatar_70.png</pictureURL><name>UK Government</name></organisation>
     http_version: "1.1"
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
     uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/10185257
-    body: 
-    headers: 
-      user-agent: 
+    body:
+    headers:
+      user-agent:
       - CapsuleCRM ruby gem
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      content-type: 
+    headers:
+      content-type:
       - "*/*"
-      server: 
+      server:
       - Apache
-      date: 
+      date:
       - Tue, 12 Apr 2011 12:34:22 GMT
-      content-length: 
+      content-length:
       - "897"
-      set-cookie: 
+      set-cookie:
       - "[SESSION-COOKIE]"
     body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><person><id>10185257</id><contacts><address><id>18565068</id><type>Office</type><street>10 Downing Street</street><city>London</city><zip>SW1A 2AA</zip><country>United Kingdom</country></address><email><id>18565066</id><type>Work</type><emailAddress>pm@example.com</emailAddress></email><phone><id>18566503</id><phoneNumber>12345 67890</phoneNumber></phone><website><id>18565067</id><webAddress>http://www.number10.gov.uk/</webAddress><webService>URL</webService><url>http://www.number10.gov.uk/</url></website></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Mr</title><firstName>David</firstName><lastName>Cameron</lastName><jobTitle>Prime Minister</jobTitle><organisationId>10185256</organisationId><organisationName>UK Government</organisationName></person>
     http_version: "1.1"
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
     uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/10185256
-    body: 
-    headers: 
-      user-agent: 
+    body:
+    headers:
+      user-agent:
       - CapsuleCRM ruby gem
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      content-type: 
+    headers:
+      content-type:
       - "*/*"
-      server: 
+      server:
       - Apache
-      date: 
+      date:
       - Tue, 12 Apr 2011 12:34:24 GMT
-      content-length: 
+      content-length:
       - "333"
-      set-cookie: 
+      set-cookie:
       - "[SESSION-COOKIE]"
     body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><organisation><id>10185256</id><contacts><email><id>18583945</id><emailAddress>gov@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/org_avatar_70.png</pictureURL><name>UK Government</name></organisation>
     http_version: "1.1"
+
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/11111111
+    body:
+    headers:
+      user-agent:
+      - CapsuleCRM ruby gem
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - "*/*"
+      server:
+      - Apache
+      date:
+      - Tue, 12 Apr 2011 12:34:24 GMT
+      content-length:
+      - "333"
+      set-cookie:
+      - "[SESSION-COOKIE]"
+    body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><organisation><id>10185256</id><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/org_avatar_70.png</pictureURL><name>UK Government</name></organisation>
+    http_version: "1.1"

data/test/party_dot_find_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+class PartyDotFindTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  # nodoc
+  def test_find_organisation
+    VCR.use_cassette('person.find_by_id') do
+      @organisation = CapsuleCRM::Party.find organisations(:gov)
+    end
+    assert @organisation.is?(:organisation)
+  end
+
+  # nodoc
+  def test_find_person
+    VCR.use_cassette('person.find_by_id') do
+      @person = CapsuleCRM::Party.find people(:pm)
+    end
+    assert @person.is?(:person)
+    assert_equal @person.first_name, "David"
+  end
+
+  def test_party_without_contacts
+    VCR.use_cassette('person.find_by_id') do
+      @org = CapsuleCRM::Party.find organisations(:emptyish)
+    end
+
+    fields = %w(emails phone_numbers websites addresses)
+    fields.each do |field|
+      assert @org.send(field).blank?
+    end
+  end
+
+  # nodoc
+  def teardown
+    WebMock.reset!
+  end
+
+end

data/test/party_dot_tags_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+class PartyDotTagsTest < Test::Unit::TestCase
+
+  def setup
+    VCR.use_cassette('person.find_by_id') do
+      @person = CapsuleCRM::Person.find people(:pm)
+    end
+  end
+
+  def test_tag_names
+    VCR.use_cassette('party.tags') do
+      @taglist = @person.tag_names
+    end
+    assert_equal @taglist.size, 11
+  end
+
+
+  def test_tags_and_tagnames
+    VCR.use_cassette('party.tags') do
+      @tagnames = @person.tag_names
+      @taglist = @person.tags
+    end
+    assert_equal @tagnames.size, @taglist.size
+  end
+
+  def teardown
+    WebMock.reset!
+  end
+
+end

data/test/person_dot_find_all_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 class PersonDotFindAllTest < Test::Unit::TestCase
 

data/test/person_dot_find_by_id_test.rb

@@ -48,6 +48,10 @@ class PersonDotFindByIdTest < Test::Unit::TestCase
     @person.phone_numbers.each { |pn| assert pn.is_a?(CapsuleCRM::Phone) }
   end
 
+  def test_websites
+    assert_equal CapsuleCRM::ChildCollection, @person.phone_numbers.class
+    assert_equal 1, @person.websites.size
+  end
 
   def teardown
     WebMock.reset!

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'ruby-debug'
+# require 'ruby-debug'
 require 'test/unit'
 require 'webmock/test_unit'
 require 'vcr'
@@ -33,7 +33,8 @@ class Test::Unit::TestCase
   # nodoc
   def organisations(key)
     ids = {
-      :gov => 10185256
+      :gov => 10185256,
+      :emptyish => 11111111
     }
     ids[key]
   end

metadata

@@ -1,21 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: capsulecrm
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ahmed Adam
+- Tadas Tamosauskas
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 +01:00
+date: 2011-04-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +22,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 7
-        - 4
         version: 0.7.4
   type: :runtime
   version_requirements: *id001
@@ -42,11 +33,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 3
-        - 0
-        - 5
         version: 3.0.5
   type: :runtime
   version_requirements: *id002
@@ -58,17 +44,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 3
-        - 0
-        - 5
         version: 3.0.5
   type: :runtime
   version_requirements: *id003
-description: CapsuleCRM API Gem
+description: Wraps up a CapsuleCRM API
 email: 
 - ahmed.msgs@gmail.com
+- tadastoo@yahoo.com
 executables: []
 
 extensions: []
@@ -96,21 +78,27 @@ files:
 - lib/capsulecrm/person.rb
 - lib/capsulecrm/phone.rb
 - lib/capsulecrm/record_not_found.rb
+- lib/capsulecrm/recorn_not_recognised.rb
+- lib/capsulecrm/tag.rb
 - lib/capsulecrm/version.rb
+- lib/capsulecrm/website.rb
 - test/create_person_test.rb
 - test/fixtures/responses/create_person.yml
+- test/fixtures/responses/party_tags.yml
 - test/fixtures/responses/person_find_all.yml
 - test/fixtures/responses/person_find_all_with_limit.yml
 - test/fixtures/responses/person_find_all_with_offset.yml
 - test/fixtures/responses/person_find_by_id.yml
 - test/fixtures/responses/update_person.yml
 - test/fixtures/responses/update_person_without_changes.yml
+- test/party_dot_find_test.rb
+- test/party_dot_tags_test.rb
 - test/person_dot_find_all_test.rb
 - test/person_dot_find_by_id_test.rb
 - test/test_helper.rb
 - test/update_person_test.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/ahmedrb/capsulecrm
 licenses: []
 
 post_install_message: 
@@ -123,25 +111,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: capsulecrm
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: CapsuleCRM API Gem
-test_files: []
-
+test_files: 
+- test/create_person_test.rb
+- test/fixtures/responses/create_person.yml
+- test/fixtures/responses/party_tags.yml
+- test/fixtures/responses/person_find_all.yml
+- test/fixtures/responses/person_find_all_with_limit.yml
+- test/fixtures/responses/person_find_all_with_offset.yml
+- test/fixtures/responses/person_find_by_id.yml
+- test/fixtures/responses/update_person.yml
+- test/fixtures/responses/update_person_without_changes.yml
+- test/party_dot_find_test.rb
+- test/party_dot_tags_test.rb
+- test/person_dot_find_all_test.rb
+- test/person_dot_find_by_id_test.rb
+- test/test_helper.rb
+- test/update_person_test.rb