infopark_crm_connector 0.9.2

data/CHANGELOG.rdoc

@@ -0,0 +1,87 @@
+=== Version 0.9.2 - 2012-03-19
+* Security improvement for +Contact.authenticate+, +Contact.password_set+ and +contact.password_request+
+
+=== Version 0.9.1 - 2012-02-28
+* Removed +Diary+. Please use +Activity+ instead.
+* Added +Mailing+
+* Added +appointment_*+ and +task_*+ fields to +Activity+
+* Added +role_names+ field to +Contact+
+* Added +tags+ field to +Activity+, +Account+ and +Contact+
+
+=== Version 0.9 - 2012-01-27
+Initial Release of Infopark CRM Connector
+
+==== Changes from OMC Connector to CRM Connector
+* Namespace changed from <tt>OmcConector::</tt> to <tt>Infopark::Crm::</tt>
+* Attribute names may have changed. For new attributes please refer to {Webservice API}[https://www.infopark.de/2486249/70-Webservice-API].
+* Works only with Infopark WebCRM.
+
+===== Changed configuration
+* +live_server_groups_callback+ - replaces +contact_roles_callback+
+
+===== New classes
+* +CustomType+
+* +Role+
+* +System+
+
+===== New methods
+* +Account.search+
+* +Activity.search+
+* +Contact.search+
+* +Event.search+
+* +EventContact.search+
+* +contact.live_server_groups+ - replaces +contact.roles+
+
+===== Removed classes
+* +AccountCollection+
+* +InquiryKind+ - use +CustomType+
+* +InquiryLink+
+* +Inquiry+ - use +Activity+
+* +Location+ - use +contact+ and +account+ properties
+* +Mailing+
+* +RegistrationInquiry+
+* +Session+
+
+
+===== Removed methods
+* +account.contacts+ - use <tt>Contact.search(\:params => {\:acount_id => acount_id})</tt>
+* +Account.find_by_name+ - use +Account.search+
+* +account.inquiries+ - use <tt>Activity.search(:params => {:account_id => account_id})</tt>
+* +account.locations+
+* +contact.account_activities+ - use <tt>Activity.search(:query => {:account_id => account_id})</tt>
+* +contact.activities+ - use <tt>Activity.search(:params => {:contact_id => contact_id})</tt>
+* +contact.create_activity+
+* +contact.create_diary+
+* +contact.create_location_with_account_association+
+* +contact.create_location+
+* +contact.create_registration_request+
+* +contact.event_participation+
+* +contact.find_activity+
+* +Contact.find_by_email+ - use <tt>Contact.search(:params => {:email => email})</tt>
+* +Contact.find_by_login+ - use <tt>Contact.search(:params => {:login => login})</tt>
+* +Contact.languages+
+* +contact.location+
+* +Contact.lookup_uptions+
+* +contact.move_location+
+* +contact.roles+ - use +contact.live_server_groups+
+* +contact.serialized_attributes+ - use +contact.attributes+
+* +contact.subscriptions+
+* +Contact.titles+
+* +contact.update_location+
+* +contact.update_subscriptions+
+* +contact.validate_login+ - use <tt>Contact.search(:params => {:login => login})</tt>
+* <tt>event.attend(!)</tt>
+* +event.contacts+ - use <tt>EventContact.search(:event_id => event_id)</tt>
+* +Event.find_by_name+
+* <tt>event.inquire(!)</tt>
+* <tt>event.refuse(!)</tt>
+* <tt>event.register(!)</tt>
+* +event_contact.attend+ - use <tt>event_contact.status = 'attended'</tt>
+* +event_contact.inquire+ - use <tt>event_contact.status = 'unregistered'</tt>
+* +event_contact.refuse+ - use <tt>event_contact.status = 'refused'</tt>
+* +event_contact.register+ - use <tt>event_contact.status = 'registered'</tt>
+* +event_contact.update_details+
+* +inquiry.create_diary+
+* +inquiry.create_link+
+* +inquiry.diaries+
+* +inquiry.links+

data/LICENSE

@@ -0,0 +1 @@
+Copyright (c) 2009 - 2012 Infopark AG (http://www.infopark.com)

data/README.rdoc

@@ -0,0 +1,59 @@
+
+==Quick Start
+
+  gem 'infopark_crm_connector'
+
+  require 'infopark_crm_connector'
+
+  Infopark::Crm.configure do |configuration|
+    configuration.url = "https://webcrm.server/url"
+    configuration.login = "webcrm_user"
+    configuration.api_key = "api_key_of_webcrm_user"
+  end
+
+  # Communicate with the WebCRM
+  Infopark::Crm::Contact.first.last_name
+
+See Infopark::Crm.configure for a complete list of configuration keys.
+
+The subclasses of Infopark::Crm::Resource (which itself inherits from
+ActiveResource::Base) represent the WebCRM's domain models (accounts, contacts, events etc.).
+
+==Examples
+===Contact
+  # Retrieve the contact identified by the login 'root'
+  contact = Infopark::Crm::Contact.search(:params => {:login => 'root'}).first
+
+  # Change this contact's mail address
+  contact.update_attribute(:email, 'root@example.com')
+
+  # Send a new password request mail to the contact's address
+  contact.password_request
+
+===Activity
+
+  # Configure a new activity kind
+  Infopark::Crm::CustomType.create(:name => 'contact form', :kind => 'Activity',
+      :states => ['new'])
+
+  # Create a new activity
+  activity = Infopark::Crm::Activity.new(:kind => 'contact form')
+
+  # Set properties of this activity
+  activity.title = 'Sprechen Sie Deutsch?'
+
+  # Switch to a different request locale
+  Infopark::Crm.configure {|c| c.locale = 'de'}
+
+  # Post the activity (which is going to fail)
+  activity.save
+  # => false
+
+  # Get to know what's missing
+  activity.errors.messages
+  # => {:state=>["ist kein gültiger Wert"]}
+
+For further information on the WebCRM web service, have a look at
+{this documentation}[https://www.infopark.com/2486249/70-Webservice-API].
+
+:include: LICENSE

data/lib/crm_connector.rb

@@ -0,0 +1,72 @@
+require 'active_resource'
+require 'active_support/core_ext/string/conversions'
+
+module Infopark; module Crm
+  def self.setup_autoload(mod, mod_source)
+    dir = File.expand_path(".", mod_source)[0..-4] # - ".rb"
+    pattern = "#{dir}/*.rb"
+    Dir.glob(pattern).each do |file|
+      file = file[0..-4]
+      const = "#{file[dir.length..-1]}".gsub(%r{[_/](.)}) {$1.upcase}
+      mod.autoload const.to_sym, file
+    end
+  end
+
+  setup_autoload(self, __FILE__)
+
+  # exceptions (defined elsewhere)
+  autoload :AuthenticationFailed, File.expand_path('../crm_connector/core/base', __FILE__)
+
+end; end
+
+module Infopark; module Crm
+
+  # Configures the web service connection
+  #
+  # View {README}[link:README_rdoc.html] for a usage example.
+  #
+  # Supported configuration keys are:
+  # [url] the web service server url (schema, host, port, path (up to, but not including /api))
+  #
+  # [login] the login of a WebCRM user with an API key (web service credential)
+  #
+  # [api_key] the WebCRM user's valid api key (web service credential)
+  #
+  # [locale] The locale to use when sending requests to the server. Can be
+  #          redefined at any time.
+  #
+  #          Example:
+  #
+  #            Infopark::Crm.configure do |configuration|
+  #              configuration.locale = I18n.locale
+  #            end
+  #
+  #            Infopark::Crm::Contact.create.errors.full_messages
+  #
+  # [live_server_groups_callback] A custom definition of what the live_server_groups of
+  #                               a contact is. The provided lambda is called with the contact
+  #                               instance and must return an array of live_server_groups (strings)
+  #
+  #                               Example:
+  #
+  #                                 Infopark::Crm.configure do |configuration|
+  #                                   configuration.live_server_groups_callback = lambda {|contact|
+  #                                     case contact.account.name
+  #                                     when "MyCompany"
+  #                                       %w(admin reader writer)
+  #                                     else
+  #                                       %w(reader)
+  #                                     end
+  #                                   }
+  #                                 end
+  #
+  # [debug] When set to true, includes the module Debugging into every resource, which
+  #         provides a logger method. Cannot be reverted by setting to +false+
+  #
+  def self.configure(&block)
+    yield Configuration
+
+    Core::Base.configure(Configuration)
+  end
+
+end; end

data/lib/crm_connector/account.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Account for documentation
+  class Account < Default::Account; end
+end; end

data/lib/crm_connector/activity.rb

@@ -0,0 +1,5 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Activity for documentation
+  class Activity < Default::Activity; end
+end; end
+

data/lib/crm_connector/base.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  class Base < Core::Base # :nodoc:
+  end
+end; end

data/lib/crm_connector/configuration.rb

@@ -0,0 +1,27 @@
+# :stopdoc:
+
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Infopark; module Crm
+  class Configuration
+
+    cattr_accessor :api_key
+
+    cattr_accessor :login
+
+    cattr_accessor :url
+
+    cattr_accessor :locale
+
+    cattr_accessor :http_host
+
+    cattr_accessor :live_server_groups_callback
+
+    cattr_accessor :debug
+
+    self.login = "webservice"
+
+    self.live_server_groups_callback = lambda {|contact| []}
+
+  end
+end; end

data/lib/crm_connector/contact.rb

@@ -0,0 +1,5 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Contact for documentation
+  class Contact < Default::Contact; end
+end; end
+

data/lib/crm_connector/core.rb

@@ -0,0 +1,7 @@
+module Infopark
+  module Crm
+    module Core
+      Infopark::Crm.setup_autoload(self, __FILE__)
+    end
+  end
+end

data/lib/crm_connector/core/base.rb

@@ -0,0 +1,111 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Infopark; module Crm
+  class ConnectorError < StandardError # :nodoc:
+  end
+
+  # Raised when a contact provides wrong credentials (token/password)
+  #
+  # This differs from the case when the web service api credentials are not accepted
+  # (an ActiveResource error is raised then)
+  class AuthenticationFailed < ConnectorError; end
+end; end
+
+module Infopark; module Crm; module Core
+  class Base < ActiveResource::Base # :nodoc: all
+
+    self.format = :json
+    self.include_root_in_json = true
+
+    cattr_accessor :locale
+    cattr_accessor :http_host
+
+    #--
+    # TBD: drop when ActiveResource 3.0 support is dropped
+    #++
+    class SchemaSupport
+      def self.schema_mapping
+        @schema_mapping ||= {}
+      end
+
+      def self.add(mapping)
+        schema_mapping.merge!(mapping)
+      end
+
+      def self.schema_type(type)
+        default_mapping = ::ActiveResource::Schema::KNOWN_ATTRIBUTE_TYPES
+        return type if default_mapping.include?(type.to_s)
+        return schema_mapping[type.to_sym]
+      end
+
+      add :text => :string
+      add :date => :string
+      add :boolean => nil
+    end
+
+    def self.schema=(definition)
+      ares_compatible_definition = {}
+      definition.each do |k, v|
+        ares_compatible_definition[k] = SchemaSupport.schema_type(v)
+      end
+      super(ares_compatible_definition)
+    end
+
+    #--
+    # TBD: remove when https://github.com/rails/rails/issues/2479 is done
+    #++
+    def self.delete(id, options = {})
+      connection.delete(element_path(id, options), headers)
+    end
+
+    def self.headers
+      headers = super
+      headers.merge!({"Accept-Language" => self.locale}) if self.locale
+      headers.merge!({"Host" => self.http_host}) if self.http_host
+      headers
+    end
+
+    def self.configure(configuration)
+      self.site = configuration.url + '/' if configuration.url
+      self.user = configuration.login
+      self.password = configuration.api_key
+      self.locale = configuration.locale
+      self.http_host = configuration.http_host
+      include Debugging if configuration.debug
+    end
+
+    # Support for field associatable errors (without humanized name guessing)
+    def errors
+      @errors ||= Errors.new(self)
+    end
+
+    class Errors < ActiveResource::Errors # :nodoc:
+      # TBD temporary patch from https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/5616
+      def from_json(json, save_cache = false)
+        errors = ActiveSupport::JSON.decode(json)
+        clear unless save_cache
+        errors.each do |attr_name, messages|
+          Array.wrap(messages).each { |message| add(attr_name.to_sym, message) }
+        end
+      end
+
+      def from_xml(xml, *args)
+        errors = Hash.from_xml(xml)['errors'] rescue {}
+        structured_errors = Array.wrap(errors['machine_readables'])
+        if structured_errors.first
+          clear unless args.first # see ActiveResource::Errors#from_array
+          structured_errors.each do |h|
+            h.each do |key, value|
+              add(key, value)
+            end
+          end
+        else
+          # legacy omc and simple rails responses
+          from_array(errors['error'] || [], *args)
+        end
+      end
+    end
+
+  end
+
+end; end; end

data/lib/crm_connector/core/continuation_support.rb

@@ -0,0 +1,44 @@
+# :stopdoc:
+module Infopark; module Crm; module Core
+  module ContinuationSupport
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.has_continuation
+    end
+
+    module ClassMethods
+      def has_continuation
+        class << self
+          def find_every(options)
+            get_with_continuation(nil, options)
+          end
+
+          private
+
+          def get_with_continuation(prefix, options)
+            prefix_options, query_options = split_options(options[:params])
+            path = collection_path(prefix_options, query_options)
+            response = prefix ? get(prefix, query_options) : connection.get(path, headers)
+            response = format.decode(response.body) unless response.kind_of? Hash # = unless ActiveResource 3.0
+            response = {'results' => response} if response.kind_of? Array # fighting ActiveResource 3.1 magic
+            collection = instantiate_collection(response['results'] || [], prefix_options)
+            result = Core::Enumerator.new(collection, response['continuation_handle'], response['total']) { |yielder|
+              loop do
+                result.within_limit.each {|entity| yielder.yield entity}
+                break if result.continuation_handle.nil?
+                # get next page
+                query_options[:continuation_handle] = result.continuation_handle
+                path = collection_path(prefix_options, query_options)
+                response = prefix ? get(prefix, query_options) : connection.get(path, headers)
+                response = format.decode(response.body) unless response.kind_of? Hash # = unless ActiveResource 3.0
+                response = {'results' => response} if response.kind_of? Array # fighting ActiveResource 3.1 magic
+                collection = instantiate_collection(response['results'] || [], prefix_options)
+                result.update(collection, response['continuation_handle'], response['total'])
+              end
+            }
+          end
+        end
+      end
+    end
+  end
+end; end; end

data/lib/crm_connector/core/enumerator.rb

@@ -0,0 +1,50 @@
+require 'backports'
+
+module Infopark; module Crm; module Core
+  # Transparent wrapper for the web service's continuation ability
+  class Enumerator < Enumerator
+    def initialize(collection, continuation_handle, size, &block) #:nodoc:
+      update(collection, continuation_handle, size)
+      super &block
+    end
+
+    # The +continuation_handle+ parameter to be passed to the next find or search request for
+    # programmatic paging
+    def continuation_handle
+      @continuation_handle
+    end
+
+    # The results of the last response as an array,
+    # the array's size is less than or equal to the +limit+ parameter value
+    def within_limit
+      @collection
+    end
+
+    ##
+    # :method: size
+    # The total count given by the last search response, if available.
+    # #size is undefined otherwise.
+    ##
+
+    #--
+    # Note: We don't want size to return nil for compatibility for count's behavior
+    #++
+    def update(collection, continuation_handle, size) # :nodoc:
+      @collection = collection
+      @continuation_handle = continuation_handle
+      @size = size
+      define_singleton_method(:size) {@size} if @size
+    end
+
+    def inspect #:nodoc:
+      "#{super.chop}, @within_limit=#{within_limit.inspect}" +
+          ", @continuation_handle=#{continuation_handle.inspect}>"
+    end
+
+    private
+
+    def rewind #:nodoc:
+      raise NotImplementedError
+    end
+  end
+end; end; end

data/lib/crm_connector/core/known_attributes.rb

@@ -0,0 +1,8 @@
+# :stopdoc:
+module Infopark; module Crm; module Core
+  class KnownAttributes < Array
+    def include?(val)
+      val.start_with?('custom_') || super(val)
+    end
+  end
+end; end; end

data/lib/crm_connector/core/resource.rb

@@ -0,0 +1,44 @@
+# :stopdoc:
+require 'ostruct'
+
+module Infopark; module Crm; module Core
+  class Resource < Infopark::Crm::Base
+    include Core::ContinuationSupport
+    include Core::SearchSupport
+
+    def self.site
+      Infopark::Crm::Base.site + 'api/'
+    end
+
+    @@deprecation_warnings = true
+    cattr_writer :deprecation_warnings
+
+    def self.deprecated(deprecated, hint = nil)
+      return unless @@deprecation_warnings
+      text = "[WebCrmConnector] #{deprecated} is deprecated."
+      text << " #{hint}" if hint
+      if defined?(Rails.logger)
+        Rails.logger.warn(text)
+      else
+        $stderr.puts(text)
+      end
+    end
+
+    def known_attributes
+      KnownAttributes.new(super)
+    end
+
+    # Inheritable Resources
+    def self.defines_webservice?
+      true
+    end
+
+    def self.inherited(sub)
+      super
+      sub.__send__(:include, InheritingResource) unless sub.defines_webservice?
+    end
+
+    # /Inheritable Resources
+  end
+
+end; end; end

data/lib/crm_connector/core/search_support.rb

@@ -0,0 +1,21 @@
+# :stopdoc:
+module Infopark; module Crm; module Core
+  module SearchSupport
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # adds a search method
+      def has_search
+        class << self
+          def search(options)
+            get_with_continuation(:search, options)
+          end
+        end
+      end
+
+    end
+  end
+end; end; end

data/lib/crm_connector/custom_type.rb

@@ -0,0 +1,7 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::CustomType for documentation
+  class CustomType < Default::CustomType
+    class CustomAttribute < Default::CustomType::CustomAttribute #:nodoc:
+    end
+  end
+end; end

data/lib/crm_connector/debugging.rb

@@ -0,0 +1,21 @@
+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.rb

@@ -0,0 +1,7 @@
+module Infopark
+  module Crm
+    module Default
+      Infopark::Crm.setup_autoload(self, __FILE__)
+    end
+  end
+end

data/lib/crm_connector/default/account.rb

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,112 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,57 @@
+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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,10 @@
+# :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

@@ -0,0 +1,9 @@
+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/event.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Event for documentation
+  class Event < Default::Event; end
+end; end

data/lib/crm_connector/event_contact.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::EventContact for documentation
+  class EventContact < Default::EventContact; end
+end; end

data/lib/crm_connector/inheriting_resource.rb

@@ -0,0 +1,30 @@
+# :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/mailing.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Mailing for documentation
+  class Mailing < Default::Mailing; end
+end; end

data/lib/crm_connector/resource.rb

@@ -0,0 +1,15 @@
+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

data/lib/crm_connector/role.rb

@@ -0,0 +1,4 @@
+module Infopark; module Crm
+  # This is an extendable class. See Default::Role for documentation
+  class Role < Default::Role; end
+end; end

data/lib/crm_connector/system.rb

@@ -0,0 +1,29 @@
+module Infopark; module Crm
+  # ==== Please note
+  # Implementation and naming may change
+  #--
+  # TBD sync with web service
+  #++
+  class System
+    def self.templates
+      response = base.connection.get(path, base.headers)
+      return response['templates'] if response.kind_of? Hash # ActiveResource 3.0
+      base.format.decode(response.body)
+    end
+
+    def self.templates=(hash)
+      data = {'templates' => hash}
+      base.connection.put(path, base.format.encode(data), base.headers)
+    end
+
+    private
+
+    def self.base #:nodoc:
+      Infopark::Crm::Resource
+    end
+
+    def self.path #:nodoc:
+      base.prefix + 'templates'
+    end
+  end
+end; end

data/lib/infopark_crm_connector.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'crm_connector')

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: infopark_crm_connector
+version: !ruby/object:Gem::Version 
+  hash: 63
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 2
+  version: 0.9.2
+platform: ruby
+authors: 
+- Infopark AG
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: backports
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: logger
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Infopark CRM Connector
+email: info@infopark.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- lib/crm_connector.rb
+- lib/crm_connector/account.rb
+- lib/crm_connector/activity.rb
+- lib/crm_connector/base.rb
+- lib/crm_connector/configuration.rb
+- lib/crm_connector/contact.rb
+- lib/crm_connector/core.rb
+- lib/crm_connector/core/base.rb
+- lib/crm_connector/core/continuation_support.rb
+- lib/crm_connector/core/enumerator.rb
+- lib/crm_connector/core/known_attributes.rb
+- lib/crm_connector/core/resource.rb
+- lib/crm_connector/core/search_support.rb
+- lib/crm_connector/custom_type.rb
+- lib/crm_connector/debugging.rb
+- lib/crm_connector/default.rb
+- lib/crm_connector/default/account.rb
+- lib/crm_connector/default/activity.rb
+- lib/crm_connector/default/contact.rb
+- lib/crm_connector/default/custom_type.rb
+- lib/crm_connector/default/event.rb
+- lib/crm_connector/default/event_contact.rb
+- lib/crm_connector/default/mailing.rb
+- lib/crm_connector/default/resource.rb
+- lib/crm_connector/default/role.rb
+- lib/crm_connector/event.rb
+- lib/crm_connector/event_contact.rb
+- lib/crm_connector/inheriting_resource.rb
+- lib/crm_connector/mailing.rb
+- lib/crm_connector/resource.rb
+- lib/crm_connector/role.rb
+- lib/crm_connector/system.rb
+- lib/infopark_crm_connector.rb
+homepage: http://www.infopark.de
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset
+- UTF-8
+- --main
+- README.rdoc
+- --title
+- Infopark CRM Connector 0.9.2 Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Infopark CRM Connector
+test_files: []
+