infopark_crm_connector 0.9.2 → 1.0.0

data/lib/crm_connector/debugging.rb

@@ -1,21 +0,0 @@
-require 'logger'
-
-module Infopark; module Crm
-  module Debugging
-
-    def logger
-      self.class.logger
-    end
-
-    def self.included(base)
-      base.logger ||= begin
-        logger = Logger.new(STDERR)
-        logger.progname = 'Infopark::Crm'
-        logger.level = Logger::INFO
-        logger
-      end
-    end
-
-  end
-
-end; end

data/lib/crm_connector/default/account.rb

@@ -1,30 +0,0 @@
-module Infopark; module Crm; module Default
-
-  class Account < Resource
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/accounts/search
-    # ==== Examples
-    #   results = Infopark::Crm::Account.search(:params => {:account_group => account_group})
-    #   results = Infopark::Crm::Account.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :account_group => :string,
-      :country => :string,
-      :extended_address => :string,
-      :home_page => :string,
-      :locality => :string,
-      :name => :string,
-      :org_name_address => :string,
-      :org_unit_address => :string,
-      :phone => :string,
-      :postalcode => :string,
-      :region => :string,
-      :street_address => :string,
-      :tags => :array,
-      :want_geo_location => :boolean,
-    }
-  end
-end; end; end

data/lib/crm_connector/default/activity.rb

@@ -1,54 +0,0 @@
-require 'ostruct'
-
-module Infopark; module Crm; module Default
-  class Activity < Resource
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/activity/search
-    # ==== Examples
-    #   results = Infopark::Crm::Activity.search(:params => {:state => 'created'})
-    #   results = Infopark::Crm::Activity.search(:params => {:kind => 'support case'})
-    #   results = Infopark::Crm::Activity.search(:params => {:contact_id => cid})
-    #   results = Infopark::Crm::Activity.search(:params => {:account_id => aid})
-    #   results = Infopark::Crm::Activity.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :account_id => :string,
-      :appointment_contact_id => :string,
-      :appointment_dtend_at => :time,
-      :appointment_dtstart_at => :time,
-      :appointment_location => :string,
-      :comment_notes => :string,
-      :comment_published => :boolean,
-      :contact_id => :string,
-      :email_cc => :string,
-      :kind => :string,
-      :state => :string,
-      :tags => :array,
-      :task_due_at => :time,
-      :task_owner_id => :string,
-      :title => :string,
-    }
-
-    # Queries the WebCRM for the Contact with the id +contact_id+.
-    # Returns +nil+ if +contact_id+ is +nil+.
-    def contact
-      Infopark::Crm::Contact.find(contact_id) if contact_id
-    end
-
-    # Queries the WebCRM for the Account with the id +account_id+.
-    # Returns +nil+ if +account_id+ is +nil+.
-    def account
-      Infopark::Crm::Account.find(account_id) if account_id
-    end
-
-    # Queries the WebCRM for the CustomType with the id +kind+.
-    # Returns +nil+ if +kind+ is +nil+.
-    def custom_type
-      Infopark::Crm::CustomType.find(kind) if kind
-    end
-
-  end
-end; end; end

data/lib/crm_connector/default/contact.rb

@@ -1,112 +0,0 @@
-module Infopark; module Crm; module Default
-  class Contact < Resource
-
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/contacts/search
-    # ==== Examples
-    #   results = Infopark::Crm::Contact.search(:params => {:login => login})
-    #   results = Infopark::Crm::Contact.search(:params => {:email => email})
-    #   results = Infopark::Crm::Contact.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :account_id => :string,
-      :country => :string,
-      :email => :string,
-      :extended_address => :string,
-      :fax => :string,
-      :first_name => :string,
-      :gender => :string,
-      :job_title => :string,
-      :language => :string,
-      :last_name => :string,
-      :locality => :string,
-      :login => :string,
-      :mobile_phone => :string,
-      :name_prefix => :string,
-      :org_name_address => :string,
-      :org_unit_address => :string,
-      :phone => :string,
-      :postalcode => :string,
-      :region => :string,
-      :role_names => :array,
-      :street_address => :string,
-      :tags => :array,
-      :want_email => :boolean,
-      :want_geo_location => :boolean,
-      :want_phonecall => :boolean,
-      :want_snailmail => :boolean,
-    }
-
-    # Queries the WebCRM for the Account with the id +account_id+.
-    # Returns +nil+ if +account_id+ is +nil+.
-    def account
-      Infopark::Crm::Account.find(account_id) if account_id
-    end
-
-    # ==== RESTful Web Service
-    # POST /api/contacts/authenticate
-    def self.authenticate(login, password)
-      begin
-        response = post(:authenticate, {}, format.encode({:login => login, :password => password}))
-        result = format.decode(response.body)
-        return find(result['id']) if result.kind_of? Hash # ActiveResource 3.0
-        find(result)
-      rescue ActiveResource::ResourceInvalid
-        raise AuthenticationFailed
-      end
-    end
-
-    # ==== RESTful Web Service
-    # POST /api/contacts/password_set
-    def self.password_set(password, token)
-      response = post(:password_set, {}, format.encode({:password => password, :token => token}))
-      result = format.decode(response.body)
-      return result['message'] if result.kind_of? Hash # ActiveResource 3.0
-      result
-    end
-
-    #--
-    # ==== RESTful Web Service
-    # POST /api/contacts/:id/password_set
-    #--
-    # TBD: build this api and use it
-    #++
-    # Shortcut to set the password of this contact.
-    def password_set(password)
-      token = password_request(:params => {:only_get_token => true})
-      self.class.password_set(password, token)
-    end
-
-    # ==== RESTful Web Service
-    # GET /api/contacts/:id/password_request
-    #--
-    # TBD: return nil instead of message for default parameters?
-    #++
-    def password_request(options = {})
-      params = options[:params] || {}
-      response = post(:password_request, {}, self.class.format.encode(params))
-      result = self.class.format.decode(response.body)
-      return result.values.first if result.kind_of? Hash # ActiveResource 3.0
-      result
-    end
-
-    # Returns the live_server_groups of this contact as defined by Configuration.live_server_groups_callback
-    def live_server_groups
-      return @live_server_groups if defined?(@live_server_groups)
-      callback = Configuration.live_server_groups_callback
-      @live_server_groups = callback.call(self) if callback.respond_to?(:call)
-      raise "live_server_groups_callback: not defined or unexpected result!" unless @live_server_groups
-
-      @live_server_groups
-    end
-
-    # Overwrites live_server_groups, so live_server_groups_callback is not called for this object.
-    def live_server_groups=(value)
-      @live_server_groups = value
-    end
-
-  end
-end; end; end

data/lib/crm_connector/default/custom_type.rb

@@ -1,24 +0,0 @@
-module Infopark; module Crm; module Default
-  class CustomType < Resource
-    self.schema = {
-      :custom_attributes => :hash,
-      :icon_css_class => :string,
-      :kind => :string,
-      :name => :string,
-      :states => :array,
-    }
-
-    class CustomAttribute < Resource #:nodoc:
-
-      self.include_root_in_json = false
-
-      #--
-      # TBD: this method is only needed until the deprecated Object#type is removed
-      # Better: define self.schema
-      #++
-      def type #:nodoc:
-        attributes['type']
-      end
-    end
-  end
-end; end; end

data/lib/crm_connector/default/event.rb

@@ -1,23 +0,0 @@
-module Infopark; module Crm; module Default
-  class Event < Resource
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/events/search
-    # ==== Examples
-    #   results = Infopark::Crm::Event.search(:params => {:kind => kind})
-    #   results = Infopark::Crm::Event.search(:params => {:event_set => event_set})
-    #   results = Infopark::Crm::Event.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :details => :string,
-      :dtend_at => :time,
-      :dtstart_at => :time,
-      :event_set => :string,
-      :kind => :string,
-      :location => :string,
-      :title => :string,
-    }
-  end
-end; end; end

data/lib/crm_connector/default/event_contact.rb

@@ -1,57 +0,0 @@
-module Infopark; module Crm; module Default
-  class EventContact < Resource
-
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/event_contacts/search
-    # ==== Examples
-    #   results = Infopark::Crm::EventContacts.search(:params => {:event_id => eid})
-    #   results = Infopark::Crm::EventContacts.search(:params => {:contact_id => cid})
-    #   results = Infopark::Crm::EventContacts.search(:params => {:state => state})
-    #   results = Infopark::Crm::EventContacts.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :state => :string,
-      :contact_id => :string,
-      :event_id => :string,
-    }
-
-    # Queries the WebCRM for the Contact with the id +contact_id+.
-    # Returns +nil+ if +contact_id+ is +nil+.
-    def contact
-      Infopark::Crm::Contact.find(contact_id) if contact_id
-    end
-
-    # Queries the WebCRM for the Event with the id +event_id+.
-    # Returns +nil+ if +event_id+ is +nil+.
-    def event
-      Infopark::Crm::Event.find(event_id) if event_id
-    end
-
-    # ==== DEPRECATED
-    # Please use +search+ instead.
-    # ==== RESTful Web Service
-    # GET /api/event_contacts/find_all_by_event_id_and_state
-    # ==== Examples
-    #   results = Infopark::Crm::EventContacts.find_by(:params => {:event_id => id})
-    #   count = Infopark::Crm::EventContacts.find_by(:params => {:event_id => id}).size
-    def self.find_by(options)
-      deprecated('EventContact.find_by', 'please use EventContact.search')
-      get_with_continuation(:find_all_by_event_id_and_state, options)
-    end
-
-    # ==== DEPRECATED
-    # Please use +search+ instead.
-    # ==== RESTful Web Service
-    # GET /api/event_contacts/find_by_event_id_and_contact_id
-    # ==== Examples
-    #   result = Infopark::Crm::EventContacts.find_by_event_id_and_contact_id(e_id, c_id))
-    def self.find_by_event_id_and_contact_id(event_id, contact_id)
-      deprecated('EventContact.find_by_event_id_and_contact_id', 'please use EventContact.search')
-      find(:find_by_event_id_and_contact_id, :params => {:event_id => event_id, :contact_id => contact_id})
-    end
-
-  end
-end; end; end

data/lib/crm_connector/default/mailing.rb

@@ -1,33 +0,0 @@
-module Infopark; module Crm; module Default
-  class Mailing < Resource
-
-    ##
-    # :singleton-method: search
-    # ==== RESTful Web Service
-    # GET /api/mailing/search
-    # ==== Examples
-    #   results = Infopark::Crm::Mailing.search(:params => {:event_id => event_id})
-    #   results = Infopark::Crm::Mailing.search(:params => {:only_unreleased => true})
-    #   results = Infopark::Crm::Mailing.search(:params => {:q => 'full-text search'})
-    has_search
-
-    self.schema = {
-      :body => :string,
-      :dtstart_at => :time,
-      :email_from => :string,
-      :email_reply_to => :string,
-      :email_subject => :string,
-      :event_id => :string,
-      :html_body => :string,
-      :mailing_type => :string,
-      :title => :string,
-    }
-
-    # Queries the WebCRM for the Event with the id +event_id+.
-    # Returns +nil+ if +event_id+ is +nil+.
-    def event
-      Infopark::Crm::Event.find(event_id) if event_id
-    end
-  end
-
-end; end; end

data/lib/crm_connector/default/resource.rb

@@ -1,10 +0,0 @@
-# :stopdoc:
-module Infopark; module Crm
-  module Default
-    class Resource < Infopark::Crm::Resource
-      def self.defines_webservice?
-        to_s.start_with?("Infopark::Crm::Default")
-      end
-    end
-  end
-end; end

data/lib/crm_connector/default/role.rb

@@ -1,9 +0,0 @@
-module Infopark; module Crm; module Default
-  class Role < Resource
-    self.schema = {
-      :description => :string,
-      :name => :string,
-      :permissions => :array,
-    }
-  end
-end; end; end

data/lib/crm_connector/inheriting_resource.rb

@@ -1,30 +0,0 @@
-# :stopdoc:
-module Infopark; module Crm
-  module InheritingResource
-    module ClassMethods
-      def element_name
-        superclass.element_name
-      end
-
-      def prefix(*args)
-        superclass.prefix(*args)
-      end
-
-      def collection_name
-        superclass.collection_name
-      end
-
-      def schema
-        superclass.schema
-      end
-
-      def known_attributes
-        superclass.known_attributes
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-  end
-end; end

data/lib/crm_connector/resource.rb

@@ -1,15 +0,0 @@
-module Infopark; module Crm
-  ##
-  # (Extendable) base class for every resource model
-  #
-  # Supports the ActiveResource::Base lifecycle methods, like
-  # * Resource.create(attributes)
-  # * Resource.new(attributes)
-  # * Resource.find(id)
-  # * resource.update_attributes(attributes)
-  # * resource.valid?
-  # * resource.save
-  #
-  # See the ActiveResource documentation for a detailed description.
-  class Resource < Core::Resource; end
-end; end