infopark_webcrm_sdk 2.1.0 → 2.3.2

data/lib/crm.rb

@@ -4,7 +4,7 @@ require 'crm/errors'
 
 # @api public
 module Crm
-  # Configures the Infopark WebCRM SDK.
+  # Configures the JustRelate WebCRM SDK.
   # The config keys +tenant+, +login+ and +api_key+ must be provided.
   # @example
   #   Crm.configure do |config|

data/lib/crm/account.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM account is an organizational entity such as a company.
+  # A JustRelate WebCRM account is an organizational entity such as a company.
   # @api public
   class Account < Core::BasicResource
     include Core::Mixins::Findable

data/lib/crm/activity.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM activity is a record of an action or a sequence of actions,
+  # A JustRelate WebCRM activity is a record of an action or a sequence of actions,
   # for example a support case.
   # It can be associated with an {Account account} or a {Contact contact}.
   #

data/lib/crm/collection.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM collection is a saved search. To execute such a saved search, call {#compute}.
+  # A JustRelate WebCRM collection is a saved search. To execute such a saved search, call {#compute}.
   # The results are persisted and can be accessed by means of {#output_items}.
   # Output items can be {Account accounts}, {Contact contacts}, {Activity activities},
   # and {Event events}.

data/lib/crm/contact.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM contact represents contact information about a person.
+  # A JustRelate WebCRM contact represents contact information about a person.
   # It can be associated with an {Account account}.
   # @api public
   class Contact < Core::BasicResource

data/lib/crm/core/attachment_store.rb

@@ -24,15 +24,15 @@ module Crm; module Core
   #    The format of +comment_attachments+ is
   #    <tt>["upload_id/filename.ext", ...]</tt>,
   #    e.g. <tt>["e13f0d960feeb2b2903bd/screenshot.jpg"]</tt>.
-  #    Infopark WebCRM in turn translates these upload IDs to attachment IDs.
+  #    JustRelate WebCRM in turn translates these upload IDs to attachment IDs.
   #    Syntactically they look the same. Upload IDs, however, are only temporary,
   #    whereas attachment IDs are permanent. If the client appended a filename to the upload ID,
   #    the attachment ID will contain this filename, too. Otherwise, the attachment ID ends
-  #    with <tt>"/file"</tt>. Please note that Infopark WebCRM replaces filename characters other
+  #    with <tt>"/file"</tt>. Please note that JustRelate WebCRM replaces filename characters other
   #    than <tt>a-zA-Z0-9.+-</tt> with a dash. Multiple dashes will be joined into a single dash.
   # 4. Later, when downloading the attachment, pass the attachment ID to
   #    {Crm::Core::AttachmentStore.generate_download_url}.
-  #    Infopark WebCRM returns a signed AWS S3 URL that remains valid for 5 minutes.
+  #    JustRelate WebCRM returns a signed AWS S3 URL that remains valid for 5 minutes.
   # @api public
   class AttachmentStore
     # +Permission+ holds all the pieces of information required to upload an {AttachmentStore attachment}.

data/lib/crm/core/basic_resource.rb

@@ -1,5 +1,5 @@
 module Crm; module Core
-  # +BasicResource+ is the base class of all Infopark WebCRM SDK resources.
+  # +BasicResource+ is the base class of all JustRelate WebCRM SDK resources.
   # @api public
   class BasicResource
     include Mixins::AttributeProvider

data/lib/crm/core/configuration.rb

@@ -41,7 +41,7 @@ module Crm; module Core
     end
 
     # The {http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html logger} of the
-    # Infopark WebCRM SDK. It logs request URLs according to the +:info+ level.
+    # JustRelate WebCRM SDK. It logs request URLs according to the +:info+ level.
     # Additionally, it logs request and response payloads according to the +:debug+ level.
     # Password fields are filtered out.
     # In a Rails environment, the logger defaults to +Rails.logger+. Otherwise, no logger is set.

data/lib/crm/core/log_subscriber.rb

@@ -1,4 +1,4 @@
-require 'action_dispatch'
+require "active_support/parameter_filter"
 
 module Crm; module Core
   class LogSubscriber < ActiveSupport::LogSubscriber
@@ -10,7 +10,7 @@ module Crm; module Core
       info { "#{event.payload[:method].to_s.upcase} #{event.payload[:resource_path]}" }
       request_payload = event.payload[:request_payload]
       if request_payload.present?
-        debug { "  request body: #{parameter_filter.filter(request_payload)}" }
+        debug { "  request body: #{parameter_filter.filter({data: request_payload})[:data]}" }
       end
     end
 
@@ -21,7 +21,7 @@ module Crm; module Core
       }
       debug {
         response_payload = MultiJson.load(r.body)
-        "  response body: #{parameter_filter.filter(response_payload)}"
+        "  response body: #{parameter_filter.filter({data: response_payload})[:data]}"
       }
     end
 
@@ -35,7 +35,7 @@ module Crm; module Core
     private
 
     def parameter_filter
-      @parameter_filter ||= ::ActionDispatch::Http::ParameterFilter.new(['password'])
+      @parameter_filter ||= ::ActiveSupport::ParameterFilter.new(['password'])
     end
   end
 end; end

data/lib/crm/core/mixins/modifiable.rb

@@ -2,7 +2,7 @@ require "active_support/concern"
 
 module Crm; module Core; module Mixins
   # +Modifiable+ is a collection of methods that are used to {ClassMethods#create .create},
-  # {#update} and {#delete} an Infopark WebCRM item.
+  # {#update} and {#delete} a JustRelate WebCRM item.
   # @api public
   module Modifiable
     extend ActiveSupport::Concern

data/lib/crm/errors.rb

@@ -1,7 +1,7 @@
 module Crm
   # @api public
   module Errors
-    # +BaseError+ is the superclass of all Infopark WebCRM SDK errors.
+    # +BaseError+ is the superclass of all JustRelate WebCRM SDK errors.
     # @api public
     class BaseError < StandardError
     end

data/lib/crm/event.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM event contains all data associated with an event such
+  # A JustRelate WebCRM event contains all data associated with an event such
   # as a conference or a trade show. An event has participants ({EventContact}).
   # @api public
   class Event < Core::BasicResource

data/lib/crm/event_contact.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM event contact is a participant or a potential participant of an {Event}.
+  # A JustRelate WebCRM event contact is a participant or a potential participant of an {Event}.
   # @api public
   class EventContact < Core::BasicResource
     include Core::Mixins::Findable

data/lib/crm/mailing.rb

@@ -1,10 +1,10 @@
 module Crm
-  # The purpose of an Infopark WebCRM mailing is to send an email, e.g. a newsletter,
+  # The purpose of a JustRelate WebCRM mailing is to send an email, e.g. a newsletter,
   # to several recipients.
   # The emails will be sent to the members of the contact collection associated with the mailing
   # (+mailing.collection_id+).
   #
-  # Infopark WebCRM uses the {http://liquidmarkup.org/ Liquid template engine} for evaluating
+  # JustRelate WebCRM uses the {http://liquidmarkup.org/ Liquid template engine} for evaluating
   # mailing content.
   # @api public
   class Mailing < Core::BasicResource
@@ -19,6 +19,16 @@ module Crm
     # @!parse extend Core::Mixins::Modifiable::ClassMethods
     # @!parse extend Core::Mixins::Searchable::ClassMethods
 
+    # Clones a mailing.
+    # @example
+    #   mailing.clone
+    #   # => Crm::Mailing
+    # @return [BasicResource] the cloned mailing.
+    # @api public
+    def clone
+      self.class.new(Core::RestApi.instance.post("#{path}/clone", {}))
+    end
+
     # Renders a preview of the email for the given contact.
     # @example
     #   mailing.html_body

data/lib/crm/mailing_delivery.rb

@@ -0,0 +1,95 @@
+module Crm
+  # MailingDelivery represents a mailing delivery.
+  # @api public
+  class MailingDelivery
+    include Core::Mixins::Inspectable
+    include Core::Mixins::AttributeProvider
+
+    inspectable :mailing_id, :id
+
+    def self.all(mailing_id, since: nil)
+      path = ['mailings', mailing_id, 'mailing_deliveries'].compact.join('/')
+      params = {}
+      case since
+      when Time
+        params[:since] = since.utc.xmlschema
+      when String
+        params[:since] = since
+      when nil
+        # ignore
+      else
+        raise "unknown class of since param: #{since.class}"
+      end
+      Core::RestApi.instance.get(path, params).map {|attrs| new({'mailing_id' => mailing_id}.merge(attrs))}
+    end
+
+    # Creates or updates a mailing delivery.
+    # @example
+    #   Crm::MailingDelivery.create(mailing.id, "abc@example.com", {
+    #     custom_data: {
+    #       salutation: 'Hello You',
+    #     },
+    #   })
+    # @param mailing_id [String] the mailing ID
+    # @param id [String] the email address
+    # @param attributes [Hash{String, Symbol => String}] the new attributes.
+    # @return [self] the created or updated mailing delivery.
+    # @api public
+    def self.create(mailing_id, id, attributes = {})
+      new({'mailing_id' => mailing_id, 'id' => id}).update(attributes)
+    end
+
+    # Returns the requested mailing delivery.
+    # @example
+    #   d = Crm::MailingDelivery.find(mailing.id, "abc@example.com")
+    #   # => #<Crm::MailingDelivery mailing_id="94933088cec0014575ff920ee9830cfb", id="abc@example.com">
+    # @param mailing_id [String] the mailing ID
+    # @param id [String] the email address
+    # @return [MailingDelivery]
+    # @api public
+    def self.find(mailing_id, id)
+      raise Crm::Errors::ResourceNotFound.new("Items could not be found.", [mailing_id]) if mailing_id.blank?
+      raise Crm::Errors::ResourceNotFound.new("Items could not be found.", [id]) if id.blank?
+
+      new({'mailing_id' => mailing_id, 'id' => id}).reload
+    end
+
+    # Deletes the mailing delivery.
+    #
+    # @raise [Errors::ResourceConflict] if the item has been changed concurrently.
+    #   {Core::BasicResource#reload Reload} it, review the changes and retry.
+    # @api public
+    def delete
+      Core::RestApi.instance.delete(path, nil, if_match_header)
+      nil
+    end
+
+    # Updates the attributes of this mailing delivery.
+    # @example
+    #   mailing_delivery.update({
+    #     custom_data: {
+    #       salutation: 'Hello You',
+    #     },
+    #   })
+    # @param attributes [Hash{String, Symbol => String}] the new attributes.
+    # @return [self] the updated mailing delivery.
+    # @api public
+    def update(attributes = {})
+      load_attributes(Core::RestApi.instance.put(path, attributes, if_match_header))
+    end
+
+    def reload
+      load_attributes(Core::RestApi.instance.get(path))
+    end
+
+    private
+
+    def path
+      ['mailings', mailing_id, 'mailing_deliveries', id].compact.join('/')
+    end
+
+    def if_match_header
+      {'If-Match' => self['version']}
+    end
+  end
+end

data/lib/crm/template_set.rb

@@ -1,9 +1,9 @@
 module Crm
-  # +TemplateSet+ represents the Infopark WebCRM template set singleton.
+  # +TemplateSet+ represents the JustRelate WebCRM template set singleton.
   # The templates of the {.singleton template set singleton} can be used to render customized text,
   # e.g. a mailing greeting or a password request email body (+password_request_email_body+).
   #
-  # Infopark WebCRM uses the {http://liquidmarkup.org/ Liquid template engine} for evaluating
+  # JustRelate WebCRM uses the {http://liquidmarkup.org/ Liquid template engine} for evaluating
   # the templates.
   # @api public
   class TemplateSet < Core::BasicResource

data/lib/crm/type.rb

@@ -1,5 +1,5 @@
 module Crm
-  # An Infopark WebCRM type defines a set of attributes associated with every instance of the type.
+  # A JustRelate WebCRM type defines a set of attributes associated with every instance of the type.
   # @example Listing all attributes of a type
   #   account_type = Crm::Type.find('account')
   #   # => Crm::Type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark_webcrm_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.2
 platform: ruby
 authors:
-- Infopark AG
+- JustRelate Group GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -80,11 +80,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: "\n    Infopark WebCRM is a professional cloud CRM built for Ruby.\n
-  \   For more information about Infopark WebCRM, please visit https://infopark.com/.\n
-  \   For more information about the Infopark WebCRM SDK for Ruby, please visit\n
+description: "\n    JustRelate WebCRM is a professional cloud CRM built for Ruby.\n
+  \   For more information about JustRelate WebCRM, please visit https://justrelate.com/.\n
+  \   For more information about the JustRelate WebCRM SDK for Ruby, please visit\n
   \   http://www.rubydoc.info/gems/infopark_webcrm_sdk\n  "
-email: info@infopark.de
+email: info@justrelate.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,6 +119,7 @@ files:
 - lib/crm/event.rb
 - lib/crm/event_contact.rb
 - lib/crm/mailing.rb
+- lib/crm/mailing_delivery.rb
 - lib/crm/mailing_recipient.rb
 - lib/crm/template_set.rb
 - lib/crm/type.rb
@@ -142,9 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Infopark WebCRM SDK
+summary: JustRelate WebCRM SDK
 test_files: []