infopark_crm_connector 0.9.2 → 1.0.0

data/lib/crm_connector/system.rb

@@ -1,16 +1,22 @@
 module Infopark; module Crm
-  # ==== Please note
-  # Implementation and naming may change
-  #--
-  # TBD sync with web service
-  #++
+
+  ##
+  # @note Implementation and naming may change
   class System
+
+    ##
+    # Reads the definition of all WebCRM templates.
+    # @return [Hash]
+    # @webcrm_rest_url <code>GET /api/templates</code>
     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
 
+    ##
+    # Sets the definition of all WebCRM templates
+    # @param hash [Hash] the new definition of all WebCRM templates
     def self.templates=(hash)
       data = {'templates' => hash}
       base.connection.put(path, base.format.encode(data), base.headers)
@@ -18,11 +24,11 @@ module Infopark; module Crm
 
     private
 
-    def self.base #:nodoc:
-      Infopark::Crm::Resource
+    def self.base
+      Infopark::Crm::Core::Resource
     end
 
-    def self.path #:nodoc:
+    def self.path
       base.prefix + 'templates'
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_crm_connector
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
-  - 2
-  version: 0.9.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Infopark AG
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-18 00:00:00 Z
+date: 2012-09-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activeresource
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +27,12 @@ dependencies:
         segments: 
         - 3
         version: "3"
+  prerelease: false
+  requirement: *id001
   type: :runtime
-  version_requirements: *id001
+  name: activeresource
 - !ruby/object:Gem::Dependency 
-  name: backports
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,65 +42,41 @@ dependencies:
         - 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"
+  requirement: *id002
   type: :runtime
-  version_requirements: *id003
+  name: backports
 description: Infopark CRM Connector
 email: info@infopark.de
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
-- LICENSE
+extra_rdoc_files: []
+
 files: 
-- CHANGELOG.rdoc
+- .yardopts
+- CHANGELOG.markdown
 - LICENSE
-- README.rdoc
+- README.markdown
 - 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/errors.rb
+- lib/crm_connector/errors/authentication_failed.rb
+- lib/crm_connector/errors/base.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
@@ -110,13 +84,8 @@ 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
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/CHANGELOG.rdoc

@@ -1,87 +0,0 @@
-=== 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/README.rdoc

@@ -1,59 +0,0 @@
-
-==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/base.rb

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

data/lib/crm_connector/core/base.rb

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