bima-shark-sdk 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a9cc4def17d9461b6ddc032cba99930bfa2337d
+  data.tar.gz: f6c2eeb6ee700a7ffd6a2d711ef4cfe81d7e0092
+SHA512:
+  metadata.gz: 304bedeaea5bb6a8ed37b6c48f89c7173775d4c3e9b42c04838776b29d115c5820d7cca37d950a3d63252ea4d067b73b81f773413d12689f2d55efa6fb41787d
+  data.tar.gz: f3f64da6335e24a50aa4e4b7e996a2773980fafc9ca7d25076c9157f33ef884c93f2836d5a84b60a93d6e3d8362fcc3c3305f62df03c161cf8e3da6e2798d841

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'config/routes.rb'
+    - 'db/schema.rb'
+    - 'lib/bima-shark-sdk.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 100
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.5.7
+before_install:
+  - gem install bundler -v '~> 1.17'
+script:
+  - bundle exec rake spec
+  - bundle exec rubocop --config '.rubocop.yml'

data/CHANGELOG.md

@@ -0,0 +1,131 @@
+## Changelog
+
+#### 2.3.0
+- `Shark::MailingService` template can `#render` partials
+
+#### 2.2.0
+- added `Shark::ContactLog` resource
+- added `Shark::MailingService::Mail#header_image` as parameter
+
+#### 2.1.0
+- added `Shark::Contact.find_by_permissions` method
+
+#### 2.0.1
+- added `Mail#reply_to` attribute
+
+#### 2.0.0
+- added `Shark::Membership.exists?` to quickly check, if a contact is member of a group
+- [break] remove `SurveyService` module
+- [break] rename `DoubleOptInService` => `DoubleOptIn`
+- [break] remove `SubscriptionService` module
+- [break] remove `NotificationService` module
+- [break] remove `ContactService` module
+- [break] remove `ConsentService` module
+- [break] remove `AssetService` module
+
+#### 1.0.1
+- whitelist `Mail#from` as attribute
+
+#### 1.0.0
+- drop support for `json_api_client < 1.10`
+- [break] drop Ruby `2.1` support
+- use `Rubocop`
+
+#### 0.14.0
+- Asset Service Client supports package API
+
+#### 0.13.4
+- Add `download` link handling to the `FakeAssetService`.
+- [fix] Determining the resource id in `FakeAssetService` fails when the endpoint base path is not `/`.
+- [fix] `links` attribute in fake asset service response contains wrong URIs.
+
+#### 0.13.3
+- add `X-Forwarded-Proto: https` as default header
+
+#### 0.13.2
+- add `SharkSpec.stub_mailing_service`
+- cleanup SharkSpec helpers with some meta programming
+
+#### 0.13.1
+- [fix] `attachments` attribute for `Mail` objects needs to be a hash
+
+#### 0.13.0
+- make all `Mail` attributes known to `BaseMailer`
+
+#### 0.12.0
+- add `MailingService.use_shark_mailer`
+
+#### 0.11.0
+- extend with MailingService
+
+#### 0.10.3
+- [fix] add backwards compatibility to Ruby 2.1
+- added Travis CI
+
+#### 0.10.2
+- [fix] `ContactService::Group#has_contact?` raised exception without `includes(:contact)`
+
+#### 0.10.1
+- Double Opt In Service: added `message_footer_html` attribute to Request
+
+#### 0.10.0
+- extend with Double Opt In Service
+
+#### 0.9.0
+- extend with AssetService and SubscriptionService
+
+#### 0.8.0
+- extend with ConsentService
+
+#### 0.7.5
+- extend with NotificationService
+
+#### 0.7.4
+- [fix] `Shark::ContactService::Group#has_contact?`
+
+#### 0.7.3
+- [fix] doorkeeper spec issue
+- use Rails logger when used in Rails apps
+
+#### 0.7.2
+- [fix] milacrm spec issue
+
+#### 0.7.1
+- [fix] undefined method `responds_to?` in Configuration
+
+#### 0.7.0
+- survey rating star support
+- survey text field support
+
+#### 0.6.4
+- added some annotations
+- [break] cleanup client and server errors
+
+#### 0.6.3
+- restructured FormService::RSpec (e.g. `SharkSpec.stub_contact_service`)
+- form service:
+  - removed API v1 resources
+  - added FormVersion::form_structure to get a tree model of the pages form
+
+
+#### 0.6.2
+- [break] remove `URI.join()` from `settings.rb` in apps
+- contact service:
+    - supports activity
+- form service:
+    - supports API v2
+
+#### 0.6.1
+- fixes including of RSpec helper files
+
+#### 0.6.0
+- supports Contact Service: accounts, contacts and groups
+
+#### 0.5.1
+- added DateTime accessors to SurveyService
+
+#### 0.5.0
+- added create participant to SurveyService
+
+#### 0.4.0
+- initial version with SurveyService and FormService

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bima-shark-sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Huy Dinh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# bima-shark-sdk
+
+[![Build Status](https://travis-ci.com/infopark-customers/bima-shark-sdk.svg?token=E8GNUMCMv7q5uwHSaqs7&branch=develop)](https://travis-ci.com/infopark-customers/bima-shark-sdk)
+
+## Installation
+
+Include **bima-shark-sdk** in your Gemfile and put the gem in the vendor/cache directory of your Rails application.
+
+```ruby
+  gem "bima-shark-sdk"
+```
+
+## Configuration
+
+```ruby
+  Shark.configure do |config|
+    config.asset_service.site = __ASSET_SERVICE_URL__
+
+    config.contact_service.site = __CONTACT_SERVICE_URL__
+
+    config.consent_service.site = __CONSENT_SERVICE_URL__
+
+    config.double_opt_in_service.site = __DOUBLE_OPT_IN_SERVICE_URL__
+
+    config.form_service.site = __FORM_SERVICE_URL__
+
+    config.subscription_service.site = __SUBSCRIPTION_SERVICE_URL__
+
+    config.survey_service.site = __MILACRM_URL__
+  end
+```
+
+If you want to send emails in your application also add:
+
+```ruby
+Shark::MailingService.use_shark_mailer do |mailer|
+  mailer.context_helpers = [
+    ActiveSupport::NumberHelper
+  ]
+  mailer.default_layout = 'system_2019'
+  mailer.default_template_root = File.expand_path('../../app/views', __dir__)
+end
+```
+
+## Testing
+
+```
+bundle exec rake spec
+```
+
+## Documentation
+
+Please look for the documentation in the [wiki](https://github.com/infopark-customers/bima-shark-sdk/wiki/Home).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bima-shark-sdk.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bima-shark-sdk'
+  spec.version       = Shark::VERSION
+  spec.authors       = ['Huy Dinh', 'Johannes Schmeißer', 'Joergen Dahlke']
+  spec.email         = ['bima-team@infopark.de']
+
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/infopark-customers/bima-shark-sdk'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|pkg)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.1.0'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'json_api_client', '>= 1.10.0'
+  spec.add_dependency 'net-http-persistent'
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.81.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'shark'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# TODO
+Shark.configure do |config|
+  config.contact_service.site = 'https://contactservice-development.bundesimmo.de/api/'
+  config.survey_service.site = 'https://milacrm-development.bundesimmo.de/api/v1/'
+  config.form_service.site = 'https://formservice-development.bundesimmo.de/api/v1/'
+  config.notification_service.site = 'https://api-development.bundesimmo.de/notification-service/'
+  config.subscription_service.site = 'https://api-development.bundesimmo.de/subscription-service/'
+end
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bima-shark-sdk/rspec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+require File.expand_path('../shark/rspec/helpers', __dir__)
+
+class SharkSpec
+  extend Shark::RSpec::Helpers
+
+  class << self
+    def method_missing(name, *args, &block)
+      if name.match(/^stub_/)
+        fake_service(name).setup
+      elsif name.match(/^unstub_/)
+        fake_service(name).reset
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, _include_private)
+      if name.match(/^stub_/)
+        true
+      elsif name.match(/^unstub_/)
+        true
+      else
+        super
+      end
+    end
+
+    protected
+
+    def fake_service(method)
+      service = method.to_s.gsub(/(un)?stub_/, '').camelize
+      Module.const_get("Shark::RSpec::Fake#{service}")
+    end
+  end
+end

data/lib/bima-shark-sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'shark'

data/lib/shark/account.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Shark
+  class Account < Base
+    extend ContactService::Resource
+  end
+end

data/lib/shark/activity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Shark
+  class Activity < Base
+    extend ContactService::Resource
+
+    def self.find_all_by_contact_id(contact_id)
+      where(contact_id: contact_id).all
+    end
+  end
+end

data/lib/shark/asset.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shark
+  class Asset < Base
+    extend AssetService::Resource
+
+    custom_endpoint :recreate_variations, on: :member, request_method: :post
+
+    def self.where(_args = {})
+      raise Shark::ActionNotSupportedError, 'Shark::AssetService::Asset.where is not supported'
+    end
+  end
+end

data/lib/shark/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Shark
+  class Base < JsonApiClient::Resource
+    self.json_key_format = :underscored_key
+    self.connection_class = Shark::Client::Connection
+    self.connection_options = {
+      headers: {
+        'Content-Type' => 'application/vnd.api+json',
+        'Accept' => 'application/vnd.api+json',
+        'X-Forwarded-Proto' => 'https'
+      }
+    }
+
+    class << self
+      def add_datetime_accessors(*method_names)
+        method_names.each do |name|
+          # get
+          define_method name do
+            value = super()
+            DateTime.parse(value) if value
+          end
+
+          # set
+          define_method "#{name}=" do |value|
+            if value.respond_to?(:iso8601)
+              super(value.iso8601(0))
+            else
+              super(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shark/client/connection.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Shark
+  module Client
+    class Connection
+      attr_reader :site, :connection_options
+
+      def initialize(options = {})
+        @site = options.fetch(:site)
+        @connection_options = {
+          headers: options[:headers] || {},
+          params: options[:params] || {}
+        }
+
+        @connection = Faraday.new do |faraday|
+          faraday.use Shark::Middleware::ComposeRequest
+          faraday.use Shark::Middleware::Status
+          faraday.use JsonApiClient::Middleware::ParseJson
+          faraday.adapter :net_http_persistent
+        end
+      end
+
+      def use(middleware, *args, &block); end
+
+      # @param request_action [Symbol] One of :get, :post, :put, :patch, :delete.
+      # @param path [String] The url path
+      # @param options [Hash]
+      #   - params [Hash] The request params
+      #   - headers [Hash] The request headers
+      #   - body [Hash]
+      # @return [Faraday::Response]
+      # @api private
+      def run(request_action, path, params: {}, headers: {}, body: nil)
+        raise ArgumentError, 'Configuration :site cannot be nil' if site.blank?
+        raise ArgumentError, 'Parameter :path cannot be nil' if path.blank?
+
+        url = File.join(site, path)
+        request_headers = connection_options_headers.merge(headers || {})
+        request_params = connection_options_params.merge(params || {})
+
+        if Shark.service_token.present?
+          request_headers['Authorization'] = "Bearer #{Shark.service_token}"
+        end
+
+        @connection.send(request_action) do |request|
+          request.url(url)
+          request.headers.merge!(request_headers)
+          request.body = body
+          request.params.merge!(request_params)
+        end
+      end
+
+      # @see request
+      alias request run
+
+      private
+
+      def connection_options_headers
+        connection_options[:headers] || {}
+      end
+
+      def connection_options_params
+        connection_options[:params] || {}
+      end
+    end
+  end
+end

data/lib/shark/concerns/connected.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Shark
+  module Connected
+    extend ActiveSupport::Concern
+
+    delegate :connection, to: :class
+
+    included do
+      class_attribute :connection_options
+
+      self.connection_options = {
+        headers: {
+          'Content-Type' => 'application/vnd.api+json',
+          'Accept' => 'application/vnd.api+json',
+          'X-Forwarded-Proto' => 'https'
+        }
+      }
+    end
+
+    module ClassMethods
+      # Return/build a connection object
+      #
+      # @return [Connection] The connection to the api server
+      # @api public
+      def connection(rebuild = false, &block)
+        _build_connection(rebuild, &block)
+        @connection
+      end
+
+      protected
+
+      # @api private
+      def _build_connection(rebuild = false)
+        return @connection unless @connection.nil? || rebuild
+
+        options = connection_options.merge(site: site)
+        @connection = Shark::Client::Connection.new(options).tap do |conn|
+          yield(conn) if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/shark/concerns/normalized_email.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shark
+  module NormalizedEmail
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def normalize_email(email)
+        email.to_s.downcase.strip
+      end
+    end
+  end
+end