infopark_crm_connector 1.0.1 → 1.1.0

data/README.markdown

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/infopark/crm_connector.png?branch=master)](https://travis-ci.org/infopark/crm_connector)
 
-Infopark WebCRM Connector is the official Ruby SDK for [Infopark WebCRM](http://www.infopark.de/webcrm). It basically wraps the [WebCRM web services API](http://kb.infopark.de/crm-api) using [Active Resource](http://rubydoc.info/gems/activeresource/). Currently, Active Resource 3.0, 3.1 and 3.2 in combination with Ruby 1.8.7, 1.9.x and 2.0.0 are tested and supported.
+Infopark WebCRM Connector is the official Ruby SDK for [Infopark WebCRM](http://www.infopark.de/webcrm). It basically wraps the [WebCRM web services API](http://kb.infopark.de/crm-api) using [Active Resource](http://rubydoc.info/gems/activeresource/). Currently, Active Resource 3.1 and 3.2 in combination with Ruby 1.8.7, 1.9.x and 2.0.0 are tested and supported.
 
 # Installation
 
@@ -102,6 +102,10 @@ Run tests with all supported versions of Active Resource:
 
 # Changelog
 
+## Version 1.1.0 - 2013-10-21
+* Remove support for ActiveResource 3.0.
+* Added `Attachment.upload_permission`, `Attachment.download_url` and the activity comment property `attachments`. See [API documentation](https://dev.infopark.net/26635f6d056215c9/attachments)
+
 ## Version 1.0.1 - 2013-03-20
 * Added continuous integration of travis-ci.org (see [travis-ci.org/infopark/crm_connector](https://travis-ci.org/infopark/crm_connector/))
 * Bugfix: Default attributes are inherited to subclasses (fixes [Issue #1](https://github.com/infopark/crm_connector/issues/1))

data/lib/crm_connector/activity.rb

@@ -24,6 +24,7 @@ module Infopark; module Crm
       :appointment_dtstart_at => :time,
       :appointment_location => :string,
       :comment_notes => :string,
+      :comment_attachments => :array,
       :comment_published => :boolean,
       :contact_id => :string,
       :email_cc => :string,
@@ -59,5 +60,16 @@ module Infopark; module Crm
       Infopark::Crm::CustomType.find(kind) if kind
     end
 
+
+    class Comment < Core::Resource
+      self.schema = {
+        :contact_id => :string,
+        :notes => :string,
+        :attachments => :array,
+        :published => :boolean,
+        :updated_at => :time,
+        :updated_by => :string,
+      }
+    end
   end
 end; end

data/lib/crm_connector/attachment.rb

@@ -0,0 +1,37 @@
+module Infopark
+  module Crm
+
+    class Attachment < Core::Resource
+
+      class Permission < Struct.new(:url, :fields, :upload_id)
+      end
+
+      ##
+      # Generates a temporary Amazon S3 URL for uploading a file to S3.
+      # @return [Permission]
+      # @webcrm_rest_url <code>GET /api/attachments/upload_permission</code>
+      # @see https://dev.infopark.net/26635f6d056215c9/attachments
+      # @example
+      #   permission = Infopark::Crm::Attachment.upload_permission
+      def self.upload_permission
+        perm = get(:upload_permission)
+        Permission.new(perm["url"], perm["fields"], perm["upload_id"])
+      end
+
+      ##
+      # Generates a temporary download URL for the given attachment.
+      # @param attachment_id [String] An attachment ID taken from the attachments field inside the comments section of an activity.
+      # @param activity_id [String] The activity ID the attachment belongs to
+      # @return [String]
+      # @webcrm_rest_url <code>GET /api/attachments/download_url</code>
+      # @see https://dev.infopark.net/26635f6d056215c9/attachments
+      # @example
+      #   url = Infopark::Crm::Attachment.download_url("c972c011b52ba671b68b16db961b82e7", "ff30a81adaaae7bd5a7066c350530c41")
+      def self.download_url(attachment_id, activity_id)
+        get(:download_url, :attachment_id => attachment_id, :activity_id => activity_id)
+      end
+
+    end
+
+  end
+end

data/lib/crm_connector/contact.rb

@@ -61,7 +61,6 @@ module Infopark; module Crm
       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 Errors::AuthenticationFailed
@@ -76,9 +75,7 @@ module Infopark; module Crm
     # @webcrm_rest_url <code>POST /api/contacts/password_set</code>
     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
+      format.decode(response.body)
     end
 
     ##
@@ -98,9 +95,7 @@ module Infopark; module Crm
     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
+      self.class.format.decode(response.body)
     end
 
     # Returns the live_server_groups of this contact as defined by +Configuration.live_server_groups_callback+

data/lib/crm_connector/core/continuation_support.rb

@@ -20,7 +20,7 @@ module Infopark; module Crm; module Core
             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 = format.decode(response.body) unless response.kind_of? Hash
             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|
@@ -31,7 +31,7 @@ module Infopark; module Crm; module Core
                 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 = format.decode(response.body) unless response.kind_of? Hash
                 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'])

data/lib/crm_connector/system.rb

@@ -10,7 +10,6 @@ module Infopark; module Crm
     # @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
 

metadata

@@ -1,66 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: infopark_crm_connector
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        version: "3"
-  prerelease: false
-  requirement: *id001
-  type: :runtime
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activeresource
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
-  prerelease: false
-  requirement: *id002
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
   name: backports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Infopark CRM Connector
 email: info@infopark.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .yardopts
 - LICENSE
 - README.markdown
 - lib/crm_connector.rb
 - lib/crm_connector/account.rb
 - lib/crm_connector/activity.rb
+- lib/crm_connector/attachment.rb
 - lib/crm_connector/configuration.rb
 - lib/crm_connector/contact.rb
 - lib/crm_connector/core.rb
@@ -80,39 +75,31 @@ files:
 - lib/crm_connector/system.rb
 - lib/infopark_crm_connector.rb
 homepage: http://www.infopark.de
-licenses: 
+licenses:
 - LGPLv3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4081557291616134614
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 17
-      segments: 
-      - 1
-      - 3
-      - 5
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Infopark CRM Connector
 test_files: []
-