capsule_crm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 395464813fddf0c08a191e17b395fed06e65c158
-  data.tar.gz: 391e2918c9f05a3ad4c9362e19bb8adc2b6a4481
+  metadata.gz: 1945cc700e9bcf4ac3a29ed1026046b6a5ab287f
+  data.tar.gz: bf02c59b07e9b4ac57481dc6c058a2aa564c637e
 SHA512:
-  metadata.gz: b5c63e469b2590cafc343352b6127e8251bcb11285f598dfeb0de7296ee279fc24200e34379ba63c9a832f3c68c6ff907da56f5f9e8ad20ffd5e3e135167e6f0
-  data.tar.gz: d0d215942a05b56c9c1d71181749be9ec3e77ec1b486485e197f35c18c3ba7b3e8915572742c8d648b6848a5a5937905560ac010e364a8ed8d7d8a9484537cb9
+  metadata.gz: f3aa284a494b32be73bef69bc8c63a48d0bec998d225295b3065c00ededf8153f0795d2777167f417bccce4439474d5de5d8ffa2608ec6c3131996d4dcc041a3
+  data.tar.gz: bf1c4ff048daf6db130a22ffe4ef6748c433d13e9059e472639198f45cc66a740231deb783b2544b33516f29e4918d61e88c81df1433091edf7d615d6016ca31

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+before_install:
+  - gem update --system
+  - gem install bundler
+  - gem install rake
+script:
+  - bundle exec rspec spec/
+bundler_args: --binstubs=./bundler_stubs

data/README.md

@@ -1,6 +1,6 @@
-# CapsuleCrm
+# CapsuleCRM
 
-TODO: Write a gem description
+CapsuleCRM provides an ActiveModel compliant interface to the capsulecrm API
 
 ## Installation
 
@@ -18,7 +18,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+person = CapsuleCRM::Person.new(first_name: 'Matt', last_name: 'Beedle', organisation_name: "Matt's Company")
+person.save
+
+person.first_name = 'John'
+person.save #=> true
+
+person.valid? #=> true
+
+person.first_name = nil
+person.last_name = nil
+person.valid? #=> false
+
+person.save #=> false
+person.save! #=> CapsuleCRM::Errors::InvalidRecord
+
+person.destroy #=> true
+
+person = CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
+```
 
 ## Contributing
 

data/capsule_crm.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency('activemodel')
   gem.add_runtime_dependency('activesupport')
   gem.add_runtime_dependency('faraday')
+  gem.add_runtime_dependency('faraday_middleware')
   gem.add_runtime_dependency('virtus')
 
   gem.add_development_dependency('cucumber')

data/lib/capsule_crm/address.rb

@@ -0,0 +1,17 @@
+module CapsuleCRM
+  class Address
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Serializers::JSON
+
+    include CapsuleCRM::CapsuleJsonable
+
+    attribute :type
+    attribute :street
+    attribute :city
+    attribute :state
+    attribute :zip
+    attribute :country
+  end
+end

data/lib/capsule_crm/capsule_jsonable.rb

@@ -0,0 +1,9 @@
+module CapsuleCRM
+  module CapsuleJsonable
+    extend ActiveSupport::Concern
+
+    def to_capsule_json
+      CapsuleCRM::HashHelper.camelize_keys attributes
+    end
+  end
+end

data/lib/capsule_crm/connection.rb

@@ -15,28 +15,39 @@ module CapsuleCRM
     end
 
     def self.post(path, params)
-      JSON.parse faraday.post(path, params).body
+      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 }
+      else
+        false
+      end
     end
 
     def self.put(path, params)
-      JSON.parse faraday.put(path, params).body
+      faraday.put(path, params) do |request|
+        request.headers.update default_request_headers
+      end.success?
     end
 
-    def self.delete(path, params)
-      JSON.parse faraday.delete(path, params).body
+    def self.delete(path)
+      faraday.delete(path) do |request|
+        request.headers.update default_request_headers
+      end.success?
     end
 
     private
 
     def self.default_request_headers
-      {
-        'Accept' => 'application/json',
-      }
+      { accept: 'application/json', content_type: 'application/json' }
     end
 
     def self.faraday
-      Faraday.new("http://#{subdomain}.capsulecrm.com").tap do |connection|
+      Faraday.new("https://#{subdomain}.capsulecrm.com").tap do |connection|
         connection.basic_auth(CapsuleCRM.configuration.api_token, '')
+        connection.request  :json
       end
     end
 

data/lib/capsule_crm/contactable.rb

@@ -0,0 +1,20 @@
+module CapsuleCRM
+  module Contactable
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :phones=,    to: :contacts
+      delegate :websites=,  to: :contacts
+      delegate :emails=,    to: :contacts
+      delegate :addresses=, to: :contacts
+    end
+
+    def contacts=(contacts)
+      @contacts = contacts
+    end
+
+    def contacts
+      @contacts ||= CapsuleCRM::Contacts.new
+    end
+  end
+end

data/lib/capsule_crm/contacts.rb

@@ -0,0 +1,148 @@
+module CapsuleCRM
+  class Contacts
+
+    # Public: Initializes a new CapsuleCRM::Contacts object
+    #
+    # attributes  - The Hash of attributes
+    #               :addresses  - The Array of CapsuleCRM::Address objects
+    #               :emails     - The Array of CapsuleCRM::Email objects
+    #
+    # Examples
+    #
+    # CapsuleCRM::Contacts.new
+    #
+    # CapsuleCRM::Contacts.new(addresses: addresses, emails: emails)
+    #
+    # Returns a CapsuleCRM::Contact
+    def initialize(attributes = {})
+      self.addresses  = attributes[:addresses]
+      self.emails     = attributes[:emails]
+      self.phones     = attributes[:phones]
+      self.websites   = attributes[:websites]
+    end
+
+    # Public: Sets the addresses for this contacts container
+    #
+    # addresses - The Array of CapsuleCRM::Address objects
+    #
+    # Examples
+    #
+    # address = CapsuleCRM::Address.new(street: 'Oranienburgerstrasse')
+    # contacts = CapsuleCRM::Contacts.new
+    # contacts.addresses = [address]
+    # contacts.addresses << address
+    #
+    # Returns an Array of CapsuleCRM::Address objects
+    def addresses=(addresses)
+      @addresses = addresses
+    end
+
+    # Public: Gets the addresses for this contacts container
+    #
+    # Examples
+    #
+    # contacts.addresses
+    #
+    # Returns an Array of CapsuleCRM::Address objects
+    def addresses
+      @addresses || []
+    end
+
+    # Public: Sets the emails for this contacts container
+    #
+    # emails  - The Array of CapsuleCRM::Email objects
+    #
+    # Examples
+    #
+    # email = CapsuleCRM::Email.new(type: 'HOME', email_address:
+    # 'matt@gmail.com')
+    # contacts = CapsuleCRM::Contacts.new
+    # contacts.emails = [email]
+    #
+    # Returns an Array of CapsuleCRM::Email objects
+    def emails=(emails)
+      @emails = emails
+    end
+
+    # Public: Gets the emails for this contacts container
+    #
+    # Examples
+    #
+    # contacts.emails
+    #
+    # Returns an Array of CapsuleCRM::Email objects
+    def emails
+      @emails || []
+    end
+
+    # Public: Sets the phones for this contacts controller
+    #
+    # phones  - The Array of CapsuleCRM::Phone objects
+    #
+    # Examples
+    #
+    # phone = CapsuleCRM::Phone.new(type: 'Mobile', phone_number: '1234')
+    # contacts = CapsuleCRM::Contacts.new
+    # contacts.phones = [phone]
+    #
+    # Returns an Array of CapsuleCRM::Phone objects
+    def phones=(phones)
+      @phones = phones
+    end
+
+    # Public: Gets the phones for this contacts container
+    #
+    # Examples
+    #
+    # contacts.phones
+    #
+    # Returns a Hash
+    def phones
+      @phones || []
+    end
+
+    # Public: Sets the websites for this contacts container
+    #
+    # websites  - The Array of CapsuleCRM::Website objects
+    #
+    # Examples
+    #
+    # website = CapsuleCRM::Website.new(
+    #   type: 'Work', web_service: 'URL', web_address: 'http://github.com'
+    # )
+    # contacts = CapsuleCRM::Contacts.new
+    # contacts.websites = [website]
+    #
+    # Returns an Array of CapsuleCRM::Website objects
+    def websites=(websites)
+      @websites = websites
+    end
+
+    # Public: Gets the websites for this contacts container
+    #
+    # Examples
+    #
+    # contacts.websites
+    #
+    # Returns a Hash
+    def websites
+      @websites || []
+    end
+
+    # Public: Builds a hash of all contact information
+    #
+    # Examples
+    #
+    # contacts.to_capsule_json
+    #
+    # Returns a Hash
+    def to_capsule_json
+      {
+        address:  addresses.map(&:to_capsule_json),
+        email:    emails.map(&:to_capsule_json),
+        phone:    phones.map(&:to_capsule_json),
+        website:  websites.map(&:to_capsule_json)
+      }.stringify_keys
+    end
+  end
+end

data/lib/capsule_crm/email.rb

@@ -0,0 +1,13 @@
+module CapsuleCRM
+  class Email
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Serializers::JSON
+
+    include CapsuleCRM::CapsuleJsonable
+
+    attribute :type
+    attribute :email_address
+  end
+end

data/lib/capsule_crm/errors/record_invalid.rb

@@ -0,0 +1,6 @@
+module CapsuleCRM
+  module Errors
+    class RecordInvalid < StandardError
+    end
+  end
+end

data/lib/capsule_crm/hash_helper.rb

@@ -10,8 +10,13 @@ module CapsuleCRM
 
     def self.camelize_keys!(hash)
       hash.keys.each do |key|
-        hash[key.to_s.camelize] = hash.delete(key)
+        hash[key.to_s.camelize(:lower)] = hash.delete(key)
       end
     end
+
+    def self.camelize_keys(hash)
+      camelize_keys!(hash)
+      hash
+    end
   end
 end

data/lib/capsule_crm/organization.rb

@@ -1,84 +1,251 @@
 require 'active_support/core_ext'
 
-class CapsuleCRM::Organization
-  include ::Virtus
-
-  include CapsuleCRM::Associations
-
-  extend ActiveModel::Naming
-  extend ActiveModel::Callbacks
-  extend ActiveModel::Conversion
-  include ActiveModel::Validations
-  include ActiveModel::Validations::Callbacks
-
-  attribute :name
-  attribute :about
-
-  # has_many :people
-
-  validates :name, presence: true
-
-  # Public: Get all organizations from Capsule. The list can be restricted
-  # and/or paginated with various query parameters sent through the options
-  # hash.
-  #
-  # options - The Hash of allowed query parameters for Capsule (default: {}):
-  #           :q      - The String search term that will be matched against name,
-  #           telephone number and exact match on searchable custom fields
-  #           :email  - The String email address to search for
-  #           :tag    - The String tag to search for
-  #           :start  - The Integer first record to be returned in pagination.
-  #           The results start with an index of 1
-  #           :limit  - The Integer maximum number of matching records to be
-  #           returned
-  #
-  # Examples
-  #
-  # Organization.all
-  #
-  # Organization.all(q: "a search query", start: 10, limit: 20)
-  #
-  # Returns a ResultsProxy of organizations
-  def self.all(options = {})
-    options.delete_if { |key, value| !allowed_filtering_options.include?(key) }
-    delete_invalid_options(options)
-    CapsuleCRM::ResultsProxy.new(
-      CapsuleCRM::Connection.get('/api/party', options).map do |result|
-        new(result)
+module CapsuleCRM
+  class Organization
+    include ::Virtus
+
+    extend ActiveModel::Naming
+    extend ActiveModel::Callbacks
+    extend ActiveModel::Conversion
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+
+    attribute :name
+    attribute :about
+
+    validates :name, presence: true
+
+    # Public: Set the attributes of an organization
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :name   - The String organization name
+    #               :about  - The String information about the organization
+    #
+    # Examples
+    #
+    # CapsuleCRM::Organization.new
+    #
+    # Returns a CapsuleCRM::Organization
+    def attributes=(attributes)
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+      self
+    end
+
+    # Public: Get all people from Capsule. The list can be restricted
+    # and/or paginated with various query parameters sent through the options
+    # hash.
+    #
+    # options - The Hash of allowed query parameters for Capsule (default: {}):
+    #           :q      - The String search term that will be matched against
+    #           name,
+    #           :tag    - The String tag to search for
+    #           :start  - The Integer first record to be returned in
+    #           pagination.
+    #           The results start with an index of 1
+    #           :limit  - The Integer maximum number of matching records to be
+    #           returned
+    #
+    # Examples
+    #
+    # CapsuleCRM::Organization.all
+    #
+    # CapsuleCRM::Organization.all(q: "a search query", start: 10, limit: 20)
+    #
+    # Returns a ResultsProxy of organisations
+    def self.all(options = {})
+      init_collection(
+        CapsuleCRM::Connection.
+        get('/api/party', options)['parties']['organisation']
+      )
+    end
+
+    # Public: Get an organization by ID
+    #
+    # id  - The Integer organization ID
+    #
+    # Examples
+    #
+    # CapsuleCRM::Organization.find(1)
+    #
+    # Returns a CapsuleCRM::Organization
+    def self.find(id)
+      new CapsuleCRM::Connection.get("/api/party/#{id}")['organisation']
+    end
+
+    # Public: Create a new organization in capsulecrm
+    #
+    # attributes  - The Hash of organization attributes (default: {}):
+    #               :name   - The String organization name
+    #               :about  - The String information about the organization
+    #
+    # Examples
+    #
+    # CapsuleCRM::Organization.create(name: 'Google Inc')
+    #
+    # Returns a CapsuleCRM::Organization
+    def self.create(attributes = {})
+      new(attributes).tap(&:save)
+    end
+
+    # Public: Create a new organization in capsulecrm and raise a
+    # CapsuleCRM::Errors::InvalidRecord error if not possible
+    #
+    # attributes  - The Hash of organization attributes (default: {}):
+    #               :name   - The String organization name
+    #               :about  - The String information about the organization
+    #
+    # Examples
+    #
+    # CapsuleCRM::Organization.create!(name: 'Google Inc')
+    #
+    # Returns a CapsuleCRM
+    def self.create!(attributes = {})
+      new(attributes).tap(&:save!)
+    end
+
+    # Public: If the organization already exists in capsule then update them,
+    # otherwise create a new organization
+    #
+    # Examples
+    #
+    # organization = CapsuleCRM::Organization.new(name: 'Google Inc')
+    # organization.save
+    #
+    # organization = CapsuleCRM::Organization.find(1)
+    # organization.name = 'Apple'
+    # organization.save
+    #
+    # Returns a CapsuleCRM::Organization
+    def save
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        false
       end
-    )
-  end
+    end
 
-  def self.find(id)
-    new CapsuleCRM::Connection.get("/api/party/#{id}")
-  end
+    # Public: If the organization already exists in capsule then update them,
+    # otherwise create a new organization. If the organization is not valid
+    # then a CapsuleCRM::Errors::RecordInvalid exception is raised
+    #
+    # Examples
+    #
+    # organization = CapsuleCRM::Organization.new(name: 'Google Inc')
+    # organization.save!
+    #
+    # organization = CapsuleCRM::Organization.find(1)
+    # organization.name = 'Apple'
+    # organization.save!
+    #
+    # organization = CapsuleCRM::Organization.new
+    # organization.save!
+    # => CapsuleCRM::Errors::InvalidRecord
+    #
+    # Returns a CapsuleCRM::Organization
+    def save!
+      if valid?
+        new_record ? create_record : update_record
+      else
+        raise CapsuleCRM::Errors::RecordInvalid.new(self)
+      end
+    end
 
-  def save
-    if new_record?
-      create(attributes)
-    else
-      update(attributes)
+    # Public: Update the organization in capsule
+    #
+    # attributes  - The Hash of organization attributes (default: {}):
+    #               :name   - The String organization name
+    #               :about  - The String information about the organization
+    #
+    # Examples
+    #
+    # organization = CapsuleCRM::Organization.find(1)
+    # organization.update_attributes name: 'Google Inc'
+    # => true
+    #
+    # organization.update_attributes {}
+    # => false
+    #
+    # Returns a CapsuleCRM::Organization
+    def update_attributes(attributes = {})
+      self.attributes = attributes
+      save
     end
-  end
 
-  def create(attributes = {})
-    CapsuleCRM::Connection.post('/api/organization', attributes)
-  end
+    # Public: Update the organization in capsule. If the organization is not
+    # valid then a CapsuleCRM::Errors::RecordInvalid exception will be raised
+    #
+    # attributes  - The Hash of organization attributes (default: {}):
+    #               :name   - The String organization name
+    #               :about  - The String information about the organization
+    #
+    # Examples
+    #
+    # organization = CapsuleCRM::Organization.find(1)
+    # organization.update_attributes! name: 'Microsoft'
+    # => true
+    #
+    # organization = CapsuleCRM::Organization.find(1)
+    # organization.update_attributes!
+    # => CapsuleCRM::Errors::RecordInvalid
+    #
+    # Returns a CapsuleCRM::Organization
+    def update_attributes!(attributes = {})
+      self.attributes = attributes
+      save!
+    end
 
-  def update_attributes(attributes = {})
-    CapsuleCRM::Connection.put("/api/organization/#{id}", attributes)
-  end
+    # Public: Determine whether this CapsuleCRM::Organization is a new record
+    # or not
+    #
+    # Returns a Boolean
+    def new_record?
+      !id
+    end
 
-  private
+    # Public: Determine whether or not this CapsuleCRM::Organization has
+    # already been persisted to capsulecrm
+    #
+    # Returns a Boolean
+    def persisted?
+      !new_record?
+    end
 
-  def delete_invalid_all_options(options)
-    options.stringify_keys!
-    options.delete_if do |key, value|
-      !allowed_filtering_options.include?(key)
+    # Public: Build a hash of attributes and merge in the attributes for the
+    # contact information
+    #
+    # Examples
+    #
+    # organization.to_capsule_json
+    #
+    # Returns a Hash
+    def to_capsule_json
+      {
+        organisation: attributes.merge(contacts: contacts.to_capsule_json).
+        stringify_keys
+      }.stringify_keys
+    end
+
+    private
+
+    def create_record
+      self.attributes = CapsuleCRM::Connection.post(
+        '/api/organisation', to_capsule_json
+      )
+    end
+
+    def update_record
+      CapsuleCRM::Connection.put("/api/organisation/#{id}", attributes)
     end
-  end
 
-  def allowed_filtering_options
-    %w(q email last_modified tag start limit)
+    # Private: Build a ResultsProxy from a Array of CapsuleCRM::Organization
+    # attributes
+    #
+    # collection  - The Array of CapsuleCRM::Organization attributes hashes
+    #
+    # Returns a CapsuleCRM::ResultsProxy
+    def self.init_collection(collection)
+      CapsuleCRM::ResultsProxy.new(collection.map { |item| new item })
+    end
   end
 end