do-list-v8 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e81728e97985f7f9a3b32e552ce342dd020c40ed36531b59736a0239ef5539c
+  data.tar.gz: 1e67836c96ed6b65c51d433980bc2c4d9f0c23619ad4a489c1a5ca4aeb38e4bb
+SHA512:
+  metadata.gz: ca6a51583006e11eccd8e43fe0b21504ea103c12f8672396208770ba15244d1e7a022c17d2a04bc7019a8e2a4e65ce6c1ae3d77a70f3c47b84b95c278a7d1cd8
+  data.tar.gz: 9e2cfaa93df9128cd371fe62ee1fbf8c274a84af95cf9cc6bf93a5f3f82f827122f05545621f604baee8c857b6864ed9fa5cd8001380cb275c1924c98806a612

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in do-list-v8.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    do-list-v8 (0.1.0)
+      nokogiri (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  do-list-v8!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Roan Mertens
+
+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,79 @@
+# do-list-v8-integration-gem
+This is the Ruby gem to integrate with the v8 SOAP api of Do List.
+
+Documentation for their v8 api: http://api.dolist.net/doc
+Log in to their extranet to get an api key and accound id: https://extranet.dolist.net/Home.aspx
+See the how to use section in this readme.
+
+
+## Do List V8
+The V8 platform is the Do List email and SMS marketing platform. It is a place to store contacts, collect and organise data and set up automatic mail deliveries and personalised messages.
+For more info checkout: https://www.dolist.com/en/solutions/dolist-v8/
+
+
+## This gem
+This gem is exclusively to get an authorisation key and to use it to push new entries to the V8 platform.
+The v8 api uses the AccountID and the AuthenticationKey from the use to generate an AuthenticationToken. This token restrains the use of the API to an hour after which another AuthenticationToken needs to be created.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'do-list-v8'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install do-list-v8
+
+
+## How to use?
+When your account gets created you need to get the AccountID and the AuthenticationKey. For that you need to log in to: https://extranet.dolist.net. When logged in, click on the `administration` tab in the top right corner.
+Then click on the `2. Web services` that appear on the settings bar to the right in the `G. Documentation Services`.
+
+Add the IP address of the server you are going to use to connect to their api. Then click on the manage keys tab and create a new key. When the key is created, click on the `see key button` and a popup appears with your ID and key. Save the AccountID and the AuthenticationKey. They will both be used in this gem.
+
+When using this gem, create a new integration and pass it the AccountID and the AuthenticationKey that you got.
+* `do_list = DoList::Integration.new(account_id: [AccountID], api_key: [AuthenticationKey])`
+
+Pass it to a variable. Use the push_entry method each time you want to push an entry to the Do List V8 platform.
+* `do_list.push_entry(fields)`
+
+The push_entry method needs an array with the following key-value pairs. All other key-value pairs will be added as extra fields.
+
+### Required
+`email: 'example@mail.com'`
+
+### Optional
+`mail_opt_out: 1`       -- `0 = opt in`  --  `1 = opt out` --
+`mobile_opt_out: 0`     -- `0 = opt in`  --  `1 = opt out` --
+when not specified they fall back to 0.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/emocial/do-list-v8.
+If anyone is interested in improving this gem, please don't hesitate to fork and send pull requests ;)
+Look in their v8 documentation (http://api.dolist.net/doc) to see the api methods that aren't added to this gem yet.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributors
+
+* Roan Mertens - https://github.com/RoanMertens

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'do-list'
+
+# 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
+
+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/do-list-v8.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'do-list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'do-list-v8'
+  spec.version       = DoList::VERSION
+  spec.authors       = ['Roan Mertens']
+  spec.email         = ['roanmertens91@gmail.com']
+
+  spec.summary       = 'This is the gem to integrate with the Do List V8 platform.'
+  spec.description   = 'The V8 platform is the Do List email and SMS marketing platform. It is a place to store contacts, collect and organise data and set up automatic mail deliveries and personalised messages.
+For more info checkout: https://www.dolist.com/en/solutions/dolist-v8/'
+  spec.homepage      = 'https://github.com/RoanMertens/do-list-v8'
+  spec.license       = 'MIT'
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata['homepage_uri'] = spec.homepage
+  #   spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  # spec.add_development_dependency 'factory_bot', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  # spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+end

data/lib/do-list/auth_token.rb

@@ -0,0 +1,44 @@
+# require 'url_parser'
+
+module DoList
+  class AuthToken
+    def initialize(params = {})
+      @headers = params[:headers]
+      @account_id = params[:account_id]
+      @api_key = params[:api_key]
+      @uri = DoList::UrlParser.parse_url(params[:url])
+      @http = DoList::UrlParser.request_http(@uri)
+      @auth_key, @auth_depr_date = request_auth_key
+    end
+
+    def auth_key
+      @auth_key, @auth_depr_date = request_auth_key if (DateTime.now + (1 / 24.0)) > @auth_depr_date
+      @auth_key
+    end
+
+    private
+
+    def request_auth_key
+      document = DoList::UrlParser.post_http(@http, @uri, body, @headers)
+      parsed = []
+      parsed << document.xpath('//Key').children.to_s
+      parsed << DateTime.parse(document.xpath('//DeprecatedDate').children.to_s)
+    end
+
+    def body
+      <<-GETAUTHBODY
+        <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://api.dolist.net/v2">
+          <soapenv:Header/>
+          <soapenv:Body>
+             <v2:GetAuthenticationToken>
+                <v2:authenticationRequest>
+                   <v2:AccountID>#{@account_id}</v2:AccountID>
+                   <v2:AuthenticationKey>#{@api_key}</v2:AuthenticationKey>
+                </v2:authenticationRequest>
+             </v2:GetAuthenticationToken>
+          </soapenv:Body>
+        </soapenv:Envelope>
+      GETAUTHBODY
+    end
+  end
+end

data/lib/do-list/push_entry.rb

@@ -0,0 +1,67 @@
+# require 'url_parser'
+
+module DoList
+  class PushEntry
+    def initialize(params = {})
+      @headers = params[:headers]
+      @account_id = params[:account_id]
+      @auth_token = params[:auth_token]
+      @uri = DoList::UrlParser.parse_url(params[:url])
+      @http = DoList::UrlParser.request_http(@uri)
+    end
+
+    def push_entry(fields)
+      return false unless fields[:email]
+
+      body = create_body(fields)
+      DoList::UrlParser.post_http(@http, @uri, body, @headers)
+    end
+
+    private
+
+    def create_body(fields)
+      email = fields.delete(:email).to_s
+      mail_opt_out = fields.delete(:mail_opt_out) == 1 ? 1 : 0
+      mobile_opt_out = fields.delete(:mobile_opt_out) == 1 ? 1 : 0
+      fields = body_fields(fields)
+      xml_body(fields, email, mail_opt_out, mobile_opt_out)
+    end
+
+    def body_fields(database_fields)
+      database_fields = database_fields.map do |name, value|
+        <<-FIELD
+          <ns2:Field>
+            <ns2:Name>#{name}</ns2:Name>
+            <ns2:Value>#{value}</ns2:Value>
+          </ns2:Field>
+        FIELD
+      end
+      return '<ns2:Fields/>' if database_fields.empty?
+
+      '<ns2:Fields>' + database_fields.join('') + '</ns2:Fields>'
+    end
+
+    def xml_body(fields, email, mail_opt_out, mobile_opt_out)
+      <<-ADDENTRYBODY
+        <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.dolist.net/v2" xmlns:ns2="http://schemas.datacontract.org/2004/07/Dolist.ContactManagement.API.DataContract.Management">
+          <SOAP-ENV:Body>
+            <ns1:SaveContact>
+              <ns1:token>
+                <ns1:AccountID>#{@account_id}</ns1:AccountID>
+                <ns1:Key>#{@auth_token}</ns1:Key>
+              </ns1:token>
+              <ns1:contact>
+              <ns2:Email>#{email}</ns2:Email>
+              #{fields}
+              <ns2:InterestsToAdd/>
+              <ns2:InterestsToDelete/>
+              <ns2:OptoutEmail>#{mail_opt_out}</ns2:OptoutEmail>
+              <ns2:OptoutMobile>#{mobile_opt_out}</ns2:OptoutMobile>
+              </ns1:contact>
+            </ns1:SaveContact>
+          </SOAP-ENV:Body>
+        </SOAP-ENV:Envelope>
+      ADDENTRYBODY
+    end
+  end
+end

data/lib/do-list/url_parser.rb

@@ -0,0 +1,20 @@
+module DoList
+  class UrlParser
+    class << self
+      def parse_url(url)
+        URI.parse(url)
+      end
+
+      def request_http(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = false
+        http
+      end
+
+      def post_http(http, uri, body, headers)
+        result = http.post(uri.path, body, headers)
+        Nokogiri::XML(result.body).remove_namespaces!
+      end
+    end
+  end
+end

data/lib/do-list/version.rb

@@ -0,0 +1,3 @@
+module DoList
+  VERSION = '0.1.0'
+end

data/lib/do_list.rb

@@ -0,0 +1,47 @@
+require 'do-list/version'
+require 'do-list/auth_token'
+require 'do-list/push_entry'
+require 'do-list/url_parser'
+
+module DoList
+  class Integration
+    def initialize(params = {})
+      @account_id = params[:account_id]
+      @api_key = params[:api_key]
+      @auth_url = 'http://api.dolist.net/v2/AuthenticationService.svc/soap1.1'
+      @push_url = 'http://api.dolist.net/V2/ContactManagementService.svc/soap1.1'
+      @auth_token = DoList::AuthToken.new(account_id: @account_id,
+                                          api_key: @api_key,
+                                          url: @auth_url,
+                                          headers: create_headers('auth'))
+    end
+
+    def auth_key
+      @auth_token.auth_key
+    end
+
+    def push_entry(fields)
+      entry = DoList::PushEntry.new(auth_token: @auth_token.auth_key,
+                                    account_id: @account_id,
+                                    url: @push_url,
+                                    headers: create_headers('push'))
+      entry.push_entry(fields)
+    end
+
+    private
+
+    def create_headers(type)
+      path = 'AuthenticationService/GetAuthenticationToken' if type == 'auth'
+      path = 'ContactManagementService/SaveContact' if type == 'push'
+      {
+        'Content-Type' => 'text/xml; charset=utf-8',
+        'SOAPAction' => "http://api.dolist.net/v2/#{path}"
+      }
+    end
+  end
+end
+
+require 'date'
+require 'net/https'
+require 'uri'
+require 'nokogiri'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: do-list-v8
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roan Mertens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: |-
+  The V8 platform is the Do List email and SMS marketing platform. It is a place to store contacts, collect and organise data and set up automatic mail deliveries and personalised messages.
+  For more info checkout: https://www.dolist.com/en/solutions/dolist-v8/
+email:
+- roanmertens91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- do-list-v8.gemspec
+- lib/do-list/auth_token.rb
+- lib/do-list/push_entry.rb
+- lib/do-list/url_parser.rb
+- lib/do-list/version.rb
+- lib/do_list.rb
+homepage: https://github.com/RoanMertens/do-list-v8
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: This is the gem to integrate with the Do List V8 platform.
+test_files: []