justrelate_sdk 1.0.0.rc1

data/lib/justrelate/template_set.rb

@@ -0,0 +1,81 @@
+module JustRelate
+  # +TemplateSet+ represents the JustRelate 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 e-mail body (+password_request_email_body+).
+  #
+  # JustRelate uses the {http://liquidmarkup.org/ Liquid template engine} for evaluating
+  # the templates.
+  # @api public
+  class TemplateSet < Core::BasicResource
+    include Core::Mixins::ChangeLoggable
+    include Core::Mixins::Inspectable
+
+    def self.path
+      resource_name
+    end
+
+    # Returns the template set singleton.
+    # @return [TemplateSet]
+    # @api public
+    def self.singleton
+      new({}).reload
+    end
+
+    # Updates the attributes of this template set.
+    # See {Core::Mixins::Modifiable#update Modifiable#update} for details.
+    # @return [self] the updated template set singleton.
+    # @api public
+    def update(attributes)
+      load_attributes(
+          Core::RestApi.instance.put(path, attributes, if_match_header))
+    end
+
+    # Renders a preview of the template set using the specified context items.
+    # This is for testing your (future) templates.
+    #
+    # * All templates contained in the set are rendered.
+    # * You may temporally add any number of +templates+ to the set
+    #   (just for the purpose of rendering).
+    # * Pass as +context+ items all the instances (e.g. contact, acticity)
+    #   for which the templates should be rendered.
+    #
+    # Templates have access to the context items.
+    # You can use the following keys to represent context items:
+    # * +account+
+    # * +contact+
+    # * +activity+
+    # * +mailing+
+    # * +event+
+    # The keys expect an ID as input. For example, <tt>{"account" => "23"}</tt> allows
+    # the template to access +account.name+ of the account with the ID +23+.
+    #
+    # @example
+    #   contact.first_name
+    #   # => 'Michael'
+    #
+    #   template_set.templates['digest_email_subject']
+    #   # => 'Summary for {{contact.first_name}}'
+    #
+    #   template_set.render_preview(
+    #     templates: { greeting: 'Dear {{contact.first_name}}, {{foo}}' },
+    #     context: {contact: contact.id, foo: 'welcome!'}
+    #   )
+    #   # => {
+    #   #  ...
+    #   #  'digest_email_subject' => 'Summary for Michael',
+    #   #  'greeting' => 'Dear Michael, welcome!',
+    #   #  ...
+    #   # }
+    # @param templates [Hash{String => String}]
+    #   the set of additional or temporary replacement templates to render.
+    # @param context [Hash{String => String}] the context items of the preview.
+    # @return [Hash{String => String}] the processed templates.
+    # @api public
+    def render_preview(templates: {}, context: {})
+      Core::RestApi.instance.post("#{path}/render_preview", {
+        'templates' => templates,
+        'context' => context,
+      })
+    end
+  end
+end

data/lib/justrelate/type.rb

@@ -0,0 +1,78 @@
+module JustRelate
+  # A JustRelate type defines a set of attributes associated with every instance of the type.
+  # @example Listing all attributes of a type
+  #   account_type = JustRelate::Type.find('account')
+  #   # => JustRelate::Type
+  #
+  #   # Listing all standard attributes
+  #   account_type.standard_attribute_definitions.keys
+  #   # => ['name', 'created_at', 'updated_at', ...]
+  #
+  #   # Listing all custom attributes
+  #   account_type.attribute_definitions.keys
+  #   # => ['custom_plan', ...]
+  #
+  # @example Inspecting an attribute definition of a type
+  #   account_type.standard_attribute_definitions["name"]
+  #   # => {
+  #   #  'attribute_type' => 'string',
+  #   #  'create'         => true,
+  #   #  'mandatory'      => true,
+  #   #  'read'           => true,
+  #   #  'title'          => 'Name',
+  #   #  'update'         => true,
+  #   # }
+  #
+  # @example Adding a new custom attribute to a type
+  #   account_type.attribute_definitions.keys
+  #   # => ['custom_plan']
+  #
+  #   # Add a new custom attribute named "custom_shipping_details"
+  #   attr_defs = account_type.attribute_definitions.merge({
+  #     custom_shipping_details: {
+  #       attribute_type: 'text',
+  #       title: 'Shipping Details',
+  #     }
+  #   })
+  #   account_type.update({
+  #     attribute_definitions: attr_defs,
+  #   })
+  #   # => JustRelate::Type
+  #
+  #   account_type.attribute_definitions.keys
+  #   # => ['custom_plan', 'custom_shipping_details']
+  #
+  # @example Removing a custom attribute from a type
+  #   account_type.attribute_definitions.keys
+  #   # => ['custom_plan', 'custom_shipping_details']
+  #
+  #   attr_defs = account_type.attribute_definitions.except('custom_shipping_details')
+  #   account_type.update({
+  #     attribute_definitions: attr_defs,
+  #   })
+  #   # => JustRelate::Type
+  #
+  #   account_type.attribute_definitions.keys
+  #   # => ['custom_plan']
+  # @api public
+  class Type < Core::BasicResource
+    include Core::Mixins::Findable
+    include Core::Mixins::Modifiable
+    include Core::Mixins::ChangeLoggable
+    include Core::Mixins::Inspectable
+    inspectable :id, :item_base_type
+
+    # @!parse extend Core::Mixins::Findable::ClassMethods
+    # @!parse extend Core::Mixins::Modifiable::ClassMethods
+
+    # Returns all types.
+    # @param include_deleted [Boolean] whether to include deleted types. Default: +false+.
+    # @return [Array<Type>]
+    # @api public
+    def self.all(include_deleted: false)
+      Core::RestApi.instance.get('types', { include_deleted: include_deleted }).map do |item|
+        new(item)
+      end
+    end
+  end
+end

data/lib/justrelate.rb

@@ -0,0 +1,149 @@
+require 'active_support/all'
+require 'net/http/post/multipart'
+require 'justrelate/errors'
+
+# @api public
+module JustRelate
+  # Configures the JustRelate SDK.
+  # The config keys +tenant+, +login+ and +api_key+ must be provided.
+  # @example
+  #   JustRelate.configure do |config|
+  #     config.tenant  = 'my_tenant'
+  #     config.login   = 'my_login'
+  #     config.api_key = 'my_api_key'
+  #   end
+  # @yieldparam config [JustRelate::Core::Configuration]
+  # @return [void]
+  # @api public
+  def self.configure
+    config = ::JustRelate::Core::Configuration.new
+    yield config
+    config.validate!
+    Core::RestApi.instance = Core::RestApi.new(config.endpoint_uri, config.login, config.api_key)
+  end
+
+  def self.autoload_module(mod, mod_source)
+    mod_dir = mod_source.gsub(/\.rb$/, '')
+    Dir.glob("#{mod_dir}/*.rb").each do |file|
+      name = File.basename(file, ".rb")
+      mod.autoload name.camelcase, file
+    end
+  end
+
+  # Fetches multiple items by +ids+.
+  # The base type of the items can be mixed (e.g. a {JustRelate::Contact} or {JustRelate::Account}).
+  # @example
+  #   JustRelate.find('e70a7123f499c5e0e9972ab4dbfb8fe3')
+  #   # => JustRelate::Contact
+  #
+  #   JustRelate.find('e70a7123f499c5e0e9972ab4dbfb8fe3', '2185dd25c2f4fa41fbef422c1b9cfc38')
+  #   # => JustRelate::Core::ItemEnumerator
+  #
+  #   JustRelate.find(['e70a7123f499c5e0e9972ab4dbfb8fe3', '2185dd25c2f4fa41fbef422c1b9cfc38'])
+  #   # => JustRelate::Core::ItemEnumerator
+  # @param ids [String, Array<String>] A single ID or a list of IDs.
+  # @return [JustRelate::Core::BasicResource]
+  #   A {JustRelate::Core::BasicResource single item} if the method was called with a single ID.
+  # @return [JustRelate::Core::ItemEnumerator]
+  #   An {JustRelate::Core::ItemEnumerator enumerator} if the method was called with multiple IDs.
+  # @raise [Errors::ResourceNotFound] if at least one of the IDs could not be found.
+  # @api public
+  def self.find(*ids)
+    enumerator = Core::ItemEnumerator.new(ids.flatten)
+
+    if ids.size == 1 && !ids.first.kind_of?(Array)
+      enumerator.first
+    else
+      enumerator
+    end
+  end
+
+  # Performs a search.
+  # Retrieves only IDs and passes them to an {Core::ItemEnumerator ItemEnumerator}.
+  # The {Core::ItemEnumerator ItemEnumerator} then fetches the items on demand.
+  #
+  # The search considers the following base types:
+  # * {JustRelate::Account Account}
+  # * {JustRelate::Activity Activity}
+  # * {JustRelate::Collection Collection}
+  # * {JustRelate::Contact Contact}
+  # * {JustRelate::Event Event}
+  # * {JustRelate::EventContact EventContact}
+  # * {JustRelate::Mailing Mailing}
+  # @example
+  #   JustRelate.search([{field: 'last_name', condition: 'equals', value: 'Johnson'}])
+  #   # => JustRelate::Core::ItemEnumerator with max 10 contacts with last name Johnson.
+  #
+  #   JustRelate.search(
+  #     [
+  #       {field: 'last_name', condition: 'equals', value: 'Johnson'},
+  #       {field: 'locality', condition: 'equals', value: 'Boston'}
+  #     ],
+  #     limit: 20,
+  #     offset: 10,
+  #     sort_by: 'created_at',
+  #     sort_order: 'desc',
+  #     include_deleted: true
+  #   )
+  #   # => JustRelate::Core::ItemEnumerator with max 20 contacts with last name Johnson from Boston.
+  # @param filters [Array<Hash{String => String}>]
+  #   Array of filters, each filter is a hash with three properties:
+  #   +field+, +condition+, +value+. Filters are AND expressions.
+  # @param query [String]
+  #   The search term of a full-text search for words starting with the term
+  #   (case-insensitive prefix search). Affects score.
+  # @param limit [Fixnum] The number of results to return at most. Minimum: +0+.
+  #    Use +:none+ to specify no limit. Default: +10+.
+  # @param offset [Fixnum] The number of results to skip. Minimum: +0+. Default: +0+.
+  # @param sort_by [String] The name of the attribute by which the result is to be sorted:
+  #   * +base_type+
+  #   * +created_at+ (server default)
+  #   * +dtstart_at+
+  #   * +first_name+
+  #   * +last_name+
+  #   * +score+
+  #   * +title+
+  #   * +updated_at+
+  # @param sort_order [String] One of +asc+ (ascending) or +desc+ (descending).
+  #   For +sort_by+ +score+, the only valid sort order is +desc+ (can be omitted).
+  # @param include_deleted [Boolean]
+  #   whether to include deleted items in the results. Server default: +false+.
+  # @return [JustRelate::Core::ItemEnumerator]
+  #   An {JustRelate::Core::ItemEnumerator enumerator} to iterate over the found items.
+  # @api public
+  def self.search(filters: nil, query: nil, limit: nil, offset: nil, sort_by: nil,
+      sort_order: nil, include_deleted: nil)
+    server_limit = 1000
+    limit ||= 10
+    limit = Float::INFINITY if limit == :none
+    offset ||= 0
+
+    ids = []
+    total = nil
+    initial_offset = offset
+
+    loop do
+      params = {
+        'filters' => filters,
+        'query' => query,
+        'limit' => [limit, server_limit].min,
+        'offset' => offset,
+        'sort_by' => sort_by,
+        'sort_order' => sort_order,
+        'include_deleted' => include_deleted,
+      }.reject { |k, v| v.nil? }
+      search_results = Core::RestApi.instance.post('search', params)
+      ids.concat(search_results['results'].map { |r| r['id'] })
+      total = search_results['total']
+      break if ids.size >= [limit, (total - initial_offset)].min
+      limit -= server_limit
+      offset += server_limit
+    end
+
+    Core::ItemEnumerator.new(ids, total: total)
+  end
+
+  autoload_module(self, File.expand_path(__FILE__))
+end
+
+JustRelate::Core::LogSubscriber.attach_to :justrelate

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: justrelate_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Infopark AG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "\n    JustRelate is a professional cloud CRM built for Ruby.\n    For
+  more information about JustRelate, please visit https://justrelate.com/.\n  "
+email: info@infopark.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- UPGRADE.md
+- config/ca-bundle.crt
+- lib/justrelate.rb
+- lib/justrelate/account.rb
+- lib/justrelate/activity.rb
+- lib/justrelate/collection.rb
+- lib/justrelate/contact.rb
+- lib/justrelate/core.rb
+- lib/justrelate/core/attachment_store.rb
+- lib/justrelate/core/basic_resource.rb
+- lib/justrelate/core/configuration.rb
+- lib/justrelate/core/connection_manager.rb
+- lib/justrelate/core/item_enumerator.rb
+- lib/justrelate/core/log_subscriber.rb
+- lib/justrelate/core/mixins.rb
+- lib/justrelate/core/mixins/attribute_provider.rb
+- lib/justrelate/core/mixins/change_loggable.rb
+- lib/justrelate/core/mixins/findable.rb
+- lib/justrelate/core/mixins/inspectable.rb
+- lib/justrelate/core/mixins/merge_and_deletable.rb
+- lib/justrelate/core/mixins/modifiable.rb
+- lib/justrelate/core/mixins/searchable.rb
+- lib/justrelate/core/rest_api.rb
+- lib/justrelate/core/search_configurator.rb
+- lib/justrelate/errors.rb
+- lib/justrelate/event.rb
+- lib/justrelate/event_contact.rb
+- lib/justrelate/mailing.rb
+- lib/justrelate/template_set.rb
+- lib/justrelate/type.rb
+homepage: https://justrelate.com
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: 'JustRelate: A professional cloud CRM.'
+test_files: []
+has_rdoc: