pipeline_dealers 0.0.1

data/lib/pipeline_dealers/backend/test/backend.rb

@@ -0,0 +1,34 @@
+require_relative "collection"
+
+module PipelineDealers
+  module Backend
+    class Test
+      attr_reader :items
+
+      def cache key
+        yield
+      end
+
+      def initialize(client)
+        @client = client
+        @items = Hash.new([])
+        @last_id = 41
+      end
+
+      def collection(options)
+        Collection.new(self, options)
+      end
+
+      def save(collection, model)
+        @items[model.class] << model
+        if model.id.nil?
+          model.send(:instance_variable_set, :@id, @last_id += 1)
+        end
+      end
+
+      def destroy(collection, to_remove)
+        @items[to_remove.class].reject! { |model| model == to_remove }
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/backend/test/collection.rb

@@ -0,0 +1,34 @@
+module PipelineDealers
+  module Backend
+    class Test
+      class Collection < Backend::Base::Collection
+        extend Delegator
+
+        delegate :count, :first, to: :items
+
+        def initialize(backend, options)
+          super(backend, options)
+        end
+
+        def find id
+          items.select { |model| model.id == id }.first
+        end
+
+        def each &operation
+          items.each &operation
+        end
+
+        def collect &operation
+          items.collect &operation
+        end
+
+        protected
+
+        def items
+          @backend.items[@model_klass]
+          @backend.items[@model_klass]
+        end
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/backend/test.rb

@@ -0,0 +1,3 @@
+require "pipeline_dealers/backend/base"
+require "pipeline_dealers/backend/test/backend"
+require "pipeline_dealers/backend/test/collection"

data/lib/pipeline_dealers/client.rb

@@ -0,0 +1,23 @@
+module PipelineDealers
+  # This class models the API client.
+  class Client
+    attr_reader :api_key
+    attr_reader :backend
+
+    def initialize(options = {})
+      @backend = (options.delete(:backend) || Backend::Http).new(options)
+    end
+
+    def companies
+      @companies ||= @backend.collection(client: self, model_klass: Model::Company, custom_fields: { model_klass: Model::Company::CustomField, cached: true, cache_key: "custom_company_fields" })
+    end
+
+    def people
+      @people ||= @backend.collection(client: self, model_klass: Model::Person, custom_fields: {model_klass: Model::Person::CustomField, cached: true, cache_key: "custom_person_fields"})
+    end
+
+    def notes
+      @notes ||= @backend.collection(client: self, model_klass: Model::Note)
+    end
+  end
+end

data/lib/pipeline_dealers/delegator.rb

@@ -0,0 +1,61 @@
+# Copied from activesupport/lib/active_support/core_ext/module/delegation.rb
+
+module PipelineDealers
+  module Delegator
+    def delegate(*methods)
+      options = methods.pop
+      unless options.is_a?(Hash) && to = options[:to]
+        raise ArgumentError, 'Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
+      end
+
+      prefix, allow_nil = options.values_at(:prefix, :allow_nil)
+
+      if prefix == true && to =~ /^[^a-z_]/
+        raise ArgumentError, 'Can only automatically set the delegation prefix when delegating to a method.'
+      end
+
+      method_prefix = \
+        if prefix
+          "#{prefix == true ? to : prefix}_"
+        else
+          ''
+        end
+
+      file, line = caller.first.split(':', 2)
+      line = line.to_i
+
+      to = to.to_s
+      to = 'self.class' if to == 'class'
+
+      methods.each do |method|
+        # Attribute writer methods only accept one argument. Makes sure []=
+        # methods still accept two arguments.
+        definition = (method =~ /[^\]]=$/) ? 'arg' : '*args, &block'
+
+        if allow_nil
+          module_eval(<<-EOS, file, line - 2)
+            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
+              if #{to} || #{to}.respond_to?(:#{method})         #   if client || client.respond_to?(:name)
+                #{to}.#{method}(#{definition})                  #     client.name(*args, &block)
+              end                                               #   end
+            end                                                 # end
+          EOS
+        else
+          exception = %(raise "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
+
+          module_eval(<<-EOS, file, line - 1)
+            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
+              #{to}.#{method}(#{definition})                    #   client.name(*args, &block)
+            rescue NoMethodError                                # rescue NoMethodError
+              if #{to}.nil?                                     #   if client.nil?
+                #{exception}                                    #     # add helpful message to the exception
+              else                                              #   else
+                raise                                           #     raise
+              end                                               #   end
+            end                                                 # end
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/error/connection.rb

@@ -0,0 +1,17 @@
+module PipelineDealers
+  class Error
+    class Connection < Error
+    end
+
+    class Connection
+      class Unprocessable < Error::Connection
+        attr_reader :errors
+
+        def initialize(errors)
+          @errors = errors
+          @message = "Couldn't save to the server: #{errors.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/error/custom_field.rb

@@ -0,0 +1,12 @@
+module PipelineDealers
+  class Error
+    class NoSuchCustomField < Error
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+        @message = "Could not find a custom field with the name #{name.inspect}"
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/error/invalid_attribute.rb

@@ -0,0 +1,29 @@
+module PipelineDealers
+  class Error
+    class InvalidAttribute < Error
+      attr_reader :attribute_name
+
+      def initialize(klass, attribute_name)
+        @klass = klass
+        @attribute_name = attribute_name
+      end
+    end
+
+    class InvalidAttributeName < InvalidAttribute
+      def initialize(klass, attribute_name)
+        super
+        @message = "The attribute #{attribute_name.inspect} is not known by #{klass.inspect}!"
+      end
+    end
+
+    class InvalidAttributeValue < InvalidAttribute
+      attr_reader :value
+
+      def initialize(klass, attribute_name, value)
+        super(klass, attribute_name)
+        @value = value
+        @message = "The attribute #{attribute_name.inspect} does not accept the value #{value.inspect} (on model #{klass.inspect})"
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/error.rb

@@ -0,0 +1,12 @@
+module PipelineDealers
+  class Error < Exception
+    attr_reader :message
+    def to_s
+      @message
+    end
+  end
+end
+
+require "pipeline_dealers/error/connection"
+require "pipeline_dealers/error/custom_field"
+require "pipeline_dealers/error/invalid_attribute"

data/lib/pipeline_dealers/limits.rb

@@ -0,0 +1,7 @@
+module PipelineDealers
+  # There are the limits of the API
+  module Limits
+    MAX_RESULTS_PER_PAGE    = 200
+    MAX_REQUESTS_PER_SECOND = 1
+  end
+end

data/lib/pipeline_dealers/model/company/custom_field.rb

@@ -0,0 +1,9 @@
+module PipelineDealers
+  class Model
+    class Company
+      class CustomField < Model::CustomField
+        self.collection_url = "admin/company_custom_field_labels"
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/company.rb

@@ -0,0 +1,46 @@
+module PipelineDealers
+  class Model
+    class Company < Model
+      include HasCustomFields
+      self.collection_url = "companies"
+      self.attribute_name = "company"
+
+      attrs :name,
+            :description,
+            :email,
+            :web,
+            :fax,
+            :address_1,
+            :address_2,
+            :city,
+            :postal_code,
+            :country,
+            :phone1,
+            :phone2,
+            :phone3,
+            :phone4,
+            :phone1_desc,
+            :phone2_desc, :phone3_desc,
+            :phone4_desc,
+            :created_at,
+            :import_id
+
+
+      # Read only
+      attrs :won_deals_total, 
+            :image_thumb_url,
+            :updated_at,
+            :total_pipeline,
+            :state,
+        read_only: true
+
+      def people
+        @client.people.where(company_id: self.id)
+      end
+
+      def notes
+        @client.notes.where(company_id: self.id)
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/custom_field.rb

@@ -0,0 +1,94 @@
+module PipelineDealers
+  class Model
+    class CustomField < Model
+      attr_reader :dropdown_entries
+
+      attrs :name, 
+            :field_type, 
+            :is_required, 
+            :custom_field_label_dropdown_entries,
+        readonly: true
+
+      def process_attributes
+        @dropdown_entries = @attributes.delete(:custom_field_label_dropdown_entries)
+      end
+
+      def decode(model, value)
+        coder_for(model).decode(value)
+      end
+
+      def encode(model, value)
+        coder_for(model).encode(value)
+      end
+
+      protected
+
+      def coder_for(model)
+        coder_klass = Coder::Types[field_type.to_sym]
+        if coder_klass.nil?
+          raise "Unkown custom field type '#{field_type.inspect}'"
+        else
+          return coder_klass.new(model, self)
+        end
+      end
+
+      class Coder
+        def initialize(model, field)
+          @model, @field = model, field
+        end
+
+        class Identity < Coder
+          def encode(value) value end
+          def decode(value) value end
+        end
+
+        class Dropdown < Coder
+          def encode value
+            find :value, of: value, and_return: :id
+          end
+
+          def decode id
+            find :id, of: id, and_return: :value
+          end
+
+          protected
+
+          def find key, options
+            key        = key.to_s
+            value      = options[:of]
+            and_return = options[:and_return].to_s
+
+            entry = @field.dropdown_entries.find { |entry| entry[key] == value }
+            
+            if entry
+              return entry[and_return]
+            else
+              raise Error::InvalidAttributeValue.new(@model, @field.name, value)
+            end
+          end
+        end
+
+        class MultiSelect < Coder
+          def encode values
+            coder = Dropdown.new(@model, @field)
+            values.collect { |value| coder.encode(value) }
+          end
+
+          def decode ids
+            coder = Dropdown.new(@model, @field)
+            ids.collect { |value| coder.decode(value) }
+          end
+        end
+
+        Types = {
+          numeric: Identity,
+          text: Identity,
+          currency: Identity,
+          dropdown: Dropdown,
+          multi_select: MultiSelect,
+          multi_association: Identity # Does not work yet
+        } 
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/has_custom_fields.rb

@@ -0,0 +1,62 @@
+require "active_support/concern"
+
+module PipelineDealers
+  class Model
+    module HasCustomFields
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :custom_fields
+      end
+
+      CUSTOM_FIELD_PREFIX = "custom_label_"
+      CUSTOM_FIELD_REGEX  = /#{CUSTOM_FIELD_PREFIX}(\d+)/
+
+      protected
+
+      def custom_field_collection
+        if @collection.respond_to?(:custom_fields)
+          @collection.custom_fields.all
+        else
+          raise "Expected collection of model '#{@collection.model_klass}' to have the custom field collection (custom_fields method)!"
+        end
+      end
+
+      def process_attributes
+        @custom_fields = pld2human_fields(@attributes.delete(:custom_fields))
+      end
+
+      def attributes_for_saving attributes
+        attributes.merge("custom_fields" => human2pld_fields(@custom_fields))
+      end
+
+      def pld2human_fields attributes
+        attributes ||= {}
+        result = {}
+
+        attributes.each do |key, value|
+          field_id = CUSTOM_FIELD_REGEX.match(key)[1].to_i
+          field = custom_field_collection.select { |field| field.id == field_id }.first
+
+          raise Error::InvalidAttributeName.new(self, key) if field.nil?
+          result[field.name] = field.decode(self, value)
+        end
+
+        result
+      end
+
+      def human2pld_fields attributes
+        attributes ||= {}
+        result = HashWithIndifferentAccess.new
+
+        attributes.each do |name, value|
+          field = custom_field_collection.select { |field| field.name == name}.first
+          raise Error::InvalidAttributeName.new(self, name) if field.nil?
+          result[CUSTOM_FIELD_PREFIX + field.id.to_s] = field.encode(self, value)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/note.rb

@@ -0,0 +1,37 @@
+module PipelineDealers
+  class Model
+    class Note < Model
+      self.collection_url = "notes"
+      self.attribute_name = "note"
+
+      attrs :deal_id,
+            :person_id,
+            :company_id,
+            :title,
+            :created_by_user_id,
+            :created_by_user,
+            :note_category_id,
+            :content,
+            :note_category
+
+      # Read only
+      attrs :created_at, 
+            :updated_at,
+            :deal,
+            :person,
+            :company,
+        read_only: true
+
+      alias_method :person_cache,  :person
+      alias_method :company_cache, :company
+
+      def person
+        @client.people.find(self.person_id)
+      end
+
+      def company
+        @client.companies.find(self.company_id)
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/person/custom_field.rb

@@ -0,0 +1,9 @@
+module PipelineDealers
+  class Model
+    class Person 
+      class CustomField < Model::CustomField
+        self.collection_url = "admin/person_custom_field_labels"
+      end
+    end
+  end
+end

data/lib/pipeline_dealers/model/person.rb

@@ -0,0 +1,63 @@
+module PipelineDealers
+  class Model
+    class Person < Model
+      include HasCustomFields
+      self.collection_url = "people"
+      self.attribute_name = "person"
+
+      attrs :first_name,
+            :last_name,
+            :phone,
+            :home_phone,
+            :mobile,
+            :position,
+            :website,
+            :email,
+            :email2,
+            :home_email,
+            :company_id,
+            :user_id,
+            :type,
+            :lead_status_id,
+            :lead_source_id,
+            :predefined_contacts_tag_ids,
+            :deal_ids,
+            :work_address_1,
+            :work_address_2,
+            :work_city,
+            :work_state,
+            :work_country,
+            :work_postal_code,
+            :home_address_1,
+            :home_address_2,
+            :home_city,
+            :home_state,
+            :home_country,
+            :home_postal_code,
+            :fax,
+            :facebook_url,
+            :linked_in_url,
+            :twitter,
+            :instant_message,
+            :created_at
+
+
+      # Read only
+      attrs :predefined_contacts_tags,
+            :won_deals_total,
+            :full_name,
+            :company_name,
+            :user,
+            :lead_status,
+            :lead_source,
+            :image_thumb_url,
+            :predefined_contacts_tags,
+            :updated_at,
+            :deals,
+            :company,
+            :viewed_at,
+            :total_pipeline,
+      read_only: true
+    end
+  end
+end