emarsys-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f950906716c6070ed2f0e94e8d44c37ea9831e1
+  data.tar.gz: c61d3389f16de08424dedfc58cd8a96e69f8dee3
+SHA512:
+  metadata.gz: 0f4adf94832cd8d7279ea327c4f071e01feac6a4fb45599789fef28debe4fc5a475dfd93e7b92f6124898f5453b4f69152458d181cc4684bd93cb9c440540fa9
+  data.tar.gz: 7b460d1e83a72d7230d828be158956f9527da7e7c85452962f80956febc378237a93fa02c067f993acfbe3903c57d996ab37c625ab134f068331eb0bbe2c9a77

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,45 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 3
+  CountKeywordArgs: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/EmptyLines:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/EmptyMethod:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at demeter.istvan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Istvan Demeter
+
+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,54 @@
+# Emarsys::Api
+
+This is a wrapper around the API of emarsys B2C marketing cloud.
+Very-very limited right now, only the covers a few endpoints so far.
+
+If you need to cover a new endpoint, please open a ticket or do and send
+a pull request. Thanks!
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emarsys-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emarsys-api
+
+## Usage
+
+setup up the following environment variables (needed by Escher):
+
+KEY_POOL
+SUITE_KEYID
+
+## Development
+
+
+By setting the environment variable EMARSYS_API_URL to http://suite.ett.local you can send request to local 
+development emarsys (suite vagrant, if you know what i mean :stuck_out_tongue_winking_eye:)
+
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake` 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/emartech/emarsys-api-ruby. This
+project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'emarsys/services/api/client'
+
+# 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

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/emarsys-api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emarsys/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'emarsys-api'
+  spec.version = Emarsys::Api::VERSION
+  spec.authors = ['Istvan Demeter']
+  spec.email = ['demeter.istvan@gmail.com']
+
+  spec.summary = 'Ruby client to make it easier to use the API of emarsys B2C MC'
+  spec.homepage = 'https://github.com/emartech/emarsys-api-ruby'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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_dependency 'escher-keypool', '~> 0.0'
+  spec.add_dependency 'faraday', '~> 0.11'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'faraday_middleware-escher', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/lib/emarsys/api.rb

@@ -0,0 +1,25 @@
+module Emarsys
+  module Api
+    ESCHER_AUTH_OPTIONS = {
+      algo_prefix: 'EMS',
+      vendor_key: 'EMS',
+      auth_header_name: 'X-Ems-Auth',
+      date_header_name: 'X-Ems-Date'
+    }.freeze
+
+
+    autoload :Base, 'emarsys/api/base'
+    autoload :Error, 'emarsys/api/error'
+    autoload :RecoverableError, 'emarsys/api/error'
+    autoload :IrrecoverableError, 'emarsys/api/error'
+    autoload :BadRequestError, 'emarsys/api/error'
+    autoload :UnauthorizedError, 'emarsys/api/error'
+    autoload :Services, 'emarsys/api/services'
+    autoload :Internal, 'emarsys/api/internal'
+
+
+    def self.base_url
+      ENV['EMARSYS_API_URL'] || 'https://api.emarsys.net'
+    end
+  end
+end

data/lib/emarsys/api/base.rb

@@ -0,0 +1,76 @@
+require 'escher-keypool'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/escher'
+
+module Emarsys
+  module Api
+    class Base
+      def client
+        @client ||= Faraday.new(url: base_url) do |faraday|
+          faraday.use FaradayMiddleware::Escher::RequestSigner, escher_config
+
+          faraday.response :json, content_type: /\bjson$/
+          faraday.response :json_fix
+
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+
+      private
+
+      def uri
+        URI.join(Emarsys::Api.base_url, module_path)
+      end
+
+
+      def module_path
+        ''
+      end
+
+
+      def base_url
+        uri.to_s
+      end
+
+
+      def hostname
+        uri.hostname
+      end
+
+
+      def escher_config
+        {
+          credential_scope: 'eu/suite/ems_request',
+          host: hostname,
+          options: ESCHER_AUTH_OPTIONS,
+          active_key: -> { ::Escher::Keypool.new.get_active_key('suite') }
+        }
+      end
+
+
+      def validate_response!(response)
+        error_class = error_class_by_status response.status
+        raise error_class.new(*parse_for_error(response)) if error_class
+      end
+
+
+      def error_class_by_status(status)
+        case status
+        when 200 then nil
+        when 202, 423 then RecoverableError
+        when 404 then IrrecoverableError
+        when 400 then BadRequestError
+        when 401 then UnauthorizedError
+        else Error
+        end
+      end
+
+
+      def parse_for_error(response)
+        [response.body, response.status, nil]
+      end
+    end
+  end
+end

data/lib/emarsys/api/error.rb

@@ -0,0 +1,25 @@
+module Emarsys
+  module Api
+    class Error < ::StandardError
+      attr_reader :error_code, :reply_code
+
+      def initialize(message, error_code, reply_code)
+        super(message)
+        @error_code = error_code
+        @reply_code = reply_code
+      end
+    end
+
+    class RecoverableError < Error
+    end
+
+    class IrrecoverableError < Error
+    end
+
+    class BadRequestError < Error
+    end
+
+    class UnauthorizedError < Error
+    end
+  end
+end

data/lib/emarsys/api/internal.rb

@@ -0,0 +1,33 @@
+module Emarsys
+  module Api
+    class Internal < Base
+      attr_reader :customer_id
+
+
+      def initialize(customer_id)
+        @customer_id = customer_id
+      end
+
+
+      def campaign_get(campaign_id)
+        client.get("email/#{campaign_id}").tap { |response| validate_response! response }.body['data']
+      end
+
+
+      private
+
+      def module_path
+        "/api/v2/internal/#{customer_id}"
+      end
+
+
+      def parse_for_error(response)
+        if response.body.is_a? Hash
+          [response.body['replyText'], response.status, response.body['replyCode']]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/emarsys/api/services.rb

@@ -0,0 +1,40 @@
+module Emarsys
+  module Api
+    class Services < Base
+
+      def launchlist_get(customer_id, campaign_id, limit = 10_000, offset = 0) # rubocop:disable Metrics/ParameterLists
+        params = { limit: limit, offset: offset }
+        response = client.get "customers/#{customer_id}/campaigns/#{campaign_id}/launch_list/contact_ids/", params
+
+        validate_response! response
+
+        response.body['contact_ids']
+      end
+
+
+      def email_queue(customer_id, params)
+        response = client.post "customers/#{customer_id}/email_queue/", JSON.generate(params)
+        validate_response! response
+
+        response.body
+      end
+
+
+      private
+
+      def module_path
+        '/api/services'
+      end
+
+
+      def parse_for_error(response)
+        errors = response.body['errors']
+        if response.body.is_a?(Hash) && errors.is_a?(Array) && errors.first.is_a?(Hash)
+          [errors.first['message'], response.status, errors.first['code']]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/emarsys/api/version.rb

@@ -0,0 +1,5 @@
+module Emarsys
+  module Api
+    VERSION = '0.2.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: emarsys-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Istvan Demeter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: escher-keypool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-escher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- demeter.istvan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- emarsys-api.gemspec
+- lib/emarsys/api.rb
+- lib/emarsys/api/base.rb
+- lib/emarsys/api/error.rb
+- lib/emarsys/api/internal.rb
+- lib/emarsys/api/services.rb
+- lib/emarsys/api/version.rb
+homepage: https://github.com/emartech/emarsys-api-ruby
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby client to make it easier to use the API of emarsys B2C MC
+test_files: []