esputnik 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 802198ceb5a5916d2f852ef144328876799848205ac3da21e697034f7e054872
+  data.tar.gz: f69fc117fe5fa41dcf3e6c37f529623a28d424a2f5b59653195b6b6a4357102f
+SHA512:
+  metadata.gz: bc18dd10717740026bb63c90dd483e8f600a6fbacd65a568af58ebf1fc3bf4181b64bba9930c0acc3e0d930b58e5fe591ffb5e64ea21d068d3df39c8636e0dbe
+  data.tar.gz: 391f92b9231c0750bb5c30a0635d69981b1868e4b8f6a04890136256854950446eb491c2028e1f68f162876fe13d2a6911785721d3aa051641ece57feadefd84

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Style/AsciiComments:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in esputnik.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    esputnik (0.0.1)
+      activemodel
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.2)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.4.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.1)
+    rake (12.3.2)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (5.0.0)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  esputnik!
+  minitest
+  pry
+  rake
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexander Sviridov
+
+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,38 @@
+# Esputnik
+
+Обертка над API маркетинговой системы eSputnik. Поддерживает минимальный необходимый объем функциональности:
+  - подписка новых пользователей
+  - обновление данных пользователей
+  - отправка событий
+
+Пример 
+
+```
+client = Esputnik::Client.new(login: 'email@busfor.com', password: 'password', logger: Logger.new(STDOUT))
+
+client.simple_contact_subscribe(email: 'test123@example.com', phone: '+79160001122', additional_data: [{id: 98748, value: 'м'}])
+
+client.simple_contact_update(id: 564407320, additional_data: [{id: 98748, value: 'ж'}])
+```
+
+Здесь email и phone - каналы, а такие данные как имя, фамилия и адрес пропущены.
+id=98748 - id дополнительного поля Gender, настроенного для конкретного аккаунта eSputnik.
+
+```
+client.event(event_type_key: 'test', key_value: 'test@example.com', params: {foo: 'bar')
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/esputnik.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'esputnik'
+
+# 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/esputnik.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esputnik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'esputnik'
+  spec.version       = Esputnik::VERSION
+  spec.authors       = ['Alexander Sviridov']
+  spec.email         = ['alexander.sviridov@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for eSputnik'
+  spec.description   = 'Ruby wrapper for eSputnik'
+  spec.homepage      = 'https://github.com/busfor/esputnik'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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_dependency 'activemodel'
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/esputnik.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require 'active_model'
+require 'esputnik/version'
+require 'esputnik/contact'
+require 'esputnik/channel'
+require 'esputnik/response'
+require 'esputnik/client'
+
+module Esputnik
+  class Error < StandardError; end
+end

data/lib/esputnik/channel.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Esputnik
+  Channel = Struct.new(:type,
+                       :value,
+                       :device,
+                       :web_push_subscription) do
+    include ActiveModel::Validations
+
+    validates_presence_of :type
+    validates_presence_of :value
+
+    def as_json
+      self.class.members.each_with_object({}) do |method_name, h|
+        value = public_send(method_name)
+        value = value.as_json if value.respond_to? :as_json
+        h[method_name.to_s.camelize(:lower)] = value if value.present?
+      end
+    end
+  end
+end

data/lib/esputnik/client.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Esputnik
+  class Client
+    BASE_URL = 'https://esputnik.com/api/v1'
+
+    def initialize(login:, password:, logger: nil)
+      @login = login
+      @password = password
+      @logger = logger
+    end
+
+    def version
+      get '/version'
+    end
+
+    def send_event(event_type_key:, key_value:, params: {})
+      post '/event',
+           'eventTypeKey' => event_type_key,
+           'keyValue' => key_value,
+           'params' => wrap_key_value(params)
+    end
+
+    # Метод, упрощающий работу с API eSputnik
+    # additional_data - [{id: <key_id>, value: value}, ... ]
+
+    def simple_contact_subscribe(email:, phone:, additional_data:)
+      contact = Esputnik::Contact.new
+      contact.channels = channels_pair(email: email, phone: phone)
+      contact.fields = additional_data
+
+      contact_subscribe(contact: contact)
+    end
+
+    def simple_contact_update(id:, email:, phone:, additional_data:)
+      contact = Esputnik::Contact.new
+      contact.channels = channels_pair(email: email, phone: phone)
+      contact.fields = additional_data
+
+      contact_update(id: id, contact: contact)
+    end
+
+    # Метод применяется для подключения форм подписки и в других случаях.
+    # Создает новые контакты, существующие обновляет. Создает в системе события для запуска сценариев.
+    # Новые контакты создаются в статусе "неподтвержденный", что позволяет реализовать double opt-in.
+
+    def contact_subscribe(contact:, groups: nil, form_type: nil)
+      raise Error, 'Esputnik::Contact expected' unless contact.is_a?(Esputnik::Contact)
+      raise Error, contact.errors unless contact.valid?
+
+      post '/contact/subscribe',
+           'contact' => contact.as_json,
+           'groups' => groups,
+           'formType' => form_type
+    end
+
+    # Метод для обновления одного контакта. Новые контакты не создает.
+    # Чтобы обновить контакт этим методом надо знать id контакта в нашей системе. Подробнее.
+
+    def contact_update(id:, contact:, groups: nil, form_type: nil)
+      raise Error, 'Esputnik::Contact expected' unless contact.is_a?(Esputnik::Contact)
+      raise Error, contact.errors unless contact.valid?
+
+      put "/contact/#{id}",
+          'contact' => contact.as_json,
+          'groups' => groups,
+          'formType' => form_type
+    end
+
+    private
+
+    def channels_pair(email:, phone:)
+      [
+        Esputnik::Channel.new.tap do |c|
+          c.type = 'email'
+          c.value = email
+        end,
+        Esputnik::Channel.new.tap do |c|
+          c.type = 'sms'
+          c.value = phone
+        end
+      ]
+    end
+
+    def get(path, **data)
+      send_request(:get, path, data)
+    end
+
+    def post(path, data)
+      send_request(:post, path, data)
+    end
+
+    def put(path, data)
+      send_request(:put, path, data)
+    end
+
+    def send_request(method, path, data)
+      response = http_client.send(method, BASE_URL + path) do |req|
+        req.body = data.to_json if data.any?
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Accept'] = 'application/json'
+      end
+
+      Response.new(response)
+    end
+
+    def http_client
+      @http_client ||= build_http_client
+    end
+
+    def build_http_client
+      connection = Faraday.new do |builder|
+        builder.request :url_encoded
+        builder.response :logger, @logger, bodies: true if @logger
+        builder.adapter Faraday.default_adapter
+      end
+
+      connection.basic_auth(@login, @password)
+      connection
+    end
+
+    def wrap_key_value(hash)
+      hash.each_with_object([]) { |(k, v), list| list << { name: k, value: v } }
+    end
+  end
+end

data/lib/esputnik/contact.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Esputnik
+  Contact = Struct.new(:first_name,
+                       :last_name,
+                       :channels,
+                       :address,
+                       :fields,
+                       :address_book_id,
+                       :id,
+                       :contact_key,
+                       :orders_info,
+                       :groups) do
+    include ActiveModel::Validations
+
+    validates_presence_of :channels
+
+    def as_json
+      hash = self.class.members.each_with_object({}) do |method_name, h|
+        value = public_send(method_name)
+        value = value.as_json if value.respond_to? :as_json
+        h[method_name.to_s.camelize(:lower)] = value if value.present?
+      end
+      hash['channels'] = channels&.map(&:as_json)
+      hash
+    end
+  end
+end

data/lib/esputnik/response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Esputnik
+  class Response
+    def initialize(faraday_response)
+      @raw_response = faraday_response
+    end
+
+    def success?
+      @raw_response.success?
+    end
+
+    def json
+      JSON.parse(@raw_response.body) if @raw_response.body.present?
+    end
+
+    def raw_body
+      @raw_response.body
+    end
+  end
+end

data/lib/esputnik/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Esputnik
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: esputnik
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Sviridov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for eSputnik
+email:
+- alexander.sviridov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- esputnik.gemspec
+- lib/esputnik.rb
+- lib/esputnik/channel.rb
+- lib/esputnik/client.rb
+- lib/esputnik/contact.rb
+- lib/esputnik/response.rb
+- lib/esputnik/version.rb
+homepage: https://github.com/busfor/esputnik
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for eSputnik
+test_files: []