DashaMailRb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91a40407e341f39c2c69b46912f2e8433241308c
+  data.tar.gz: e0f82857a6903f74cf08e347f1db980fca84ac1a
+SHA512:
+  metadata.gz: 26e0c50494de3efb91d2b4648bf410591c5ea44b74549e47a05f9bbd6b1ee17829d2c18c6c05354e53489e361b3debe454ba2dd8572ca230101f0d7a5954e1dd
+  data.tar.gz: 57dc99884eea31f7d81e61ad3aac2f3e0585e4e2b29f49e2e544ed0452d47f770e72e7cf9f74fc62bf79a0cf1a8f90d37193011068554ac2b9369db3e132ff26

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.3.7
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,43 @@
+# DashaMailRb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/DashaMailRb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'DashaMailRb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install DashaMailRb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/DashaMailRb. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DashaMailRb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/DashaMailRb/blob/master/CODE_OF_CONDUCT.md).

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 "DashaMailRb"
+
+# 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/dashamailrb.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "DashaMailRb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "DashaMailRb"
+  spec.version       = DashaMailRb::VERSION
+  spec.authors       = ["Alexandr Prokopenko"]
+  spec.email         = ["prokopenko@igc.ru"]
+  spec.summary       = %q{Interface for dashamail.ru service API}
+  spec.description   = %q{Interface for dashamail.ru service API}
+  spec.homepage      = "https://github.com/DashaMail/DashamailRb"
+  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('..', __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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dashamailrb.rb

@@ -0,0 +1,6 @@
+require "DashaMailRb/version"
+
+module DashaMailRb
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/dashamailrb/api_exception.rb

@@ -0,0 +1,7 @@
+module Dashamail
+  class ApiException < StandardError
+  end
+
+  class NoDataException < ApiException
+  end
+end

data/lib/dashamailrb/dashamail.rb

@@ -0,0 +1,92 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Dashamail
+  class Connection
+
+    API_URL = 'https://api.dashamail.com'
+
+    # Initializes new connection instance
+    #
+    # @param username [String] Service username
+    # @param password [String] Password
+    def initialize(username, password, endpoint = API_URL)
+      @username, @password = username, password
+      @endpoint = endpoint
+    end
+
+    attr_reader :endpoint
+
+    # Memoized Faraday connection factory
+    #
+    # @return Faraday connection instance
+    def connection
+      @conn ||= Faraday.new(:url => endpoint) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :json
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    # Invokes API method by name
+    #
+    # @param method [String] Method name, corresponding API reference https://dashamail.ru/api/
+    # @param params [Hash] Params to be passed
+    def call_method(method, params = {})
+      response = connection.post '/', {method: method}.merge(credentials).merge(params)
+      err_code = response.body["response"]["msg"]["err_code"]
+
+      case err_code
+      when 0
+        response.body["response"]["data"]
+      when 4
+        raise Dashamail::NoDataException.new(response.body["response"]["msg"]["text"])
+      else
+        raise Dashamail::ApiException.new(response.body["response"]["msg"]["text"])
+      end
+    end
+
+    # Invokes 'lists.get' API method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Array] Array of Dashamail::List instances
+    def lists(params = {})
+      call_method('lists.get', params).map {|list_raw| Dashamail::List.new(self, list_raw)}
+    end
+
+
+    # Invokes 'lists.get' API method to retrieve single List object
+    #
+    # @param id [Fixnum] List id
+    # @return [Dashamail::List] List instance
+    def get_list(id)
+      lists(list_id: id)[0]
+    end
+
+    # 'list.get' method alias
+    #
+    alias_method :get, :lists
+
+    # Invokes 'lists.get_member' API method
+    #
+    # @param email [String] Email for search
+    # @return [Array] Array of Dashamail::Member instances
+    def get_member(email)
+      call_method('lists.get_member', {email: email}).map {|member| Dashamail::Member.new(connection, member)}
+    end
+
+    # Invokes 'lists.unsubscribe_member' API method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Fixnum] Count of unsubscribed members
+    def unsubscribe_member(params)
+      call_method('lists.unsubscribe_member', params)['unsubscribed']
+    end
+
+  private
+
+    def credentials
+      {username: @username, password: @password}
+    end
+  end
+end

data/lib/dashamailrb/list.rb

@@ -0,0 +1,71 @@
+module Dashamail
+  # Mailing list representation class
+  class List < Model
+    attr_reader :raw
+
+    FIELDS = [
+      :id,
+      :state,
+      :count_active,
+      :count_all,
+      :name,
+      :description,
+      :company,
+      :abuse_name,
+      :phone,
+      :address,
+      :city,
+      :url
+    ]
+
+    FIELDS.each do |f|
+      attr_reader f
+    end
+
+    # Initialize new list instance
+    #
+    # @param connection [Pachkin::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      super(connection, doc)
+      FIELDS.each do |field|
+        instance_variable_set :"@#{field}", doc[field.to_s]
+      end
+    end
+
+    # Invokes 'lists.get_members' API method to retreive list members
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Array] Array of Dashamail::Members instances
+    def get_members(params = {})
+      connection.call_method('lists.get_members', params.merge(id_params)).map {|member| Dashamail::Member.new(connection, member)}
+    end
+
+    # Alias to get_members
+    #
+    alias_method :members, :get_members
+
+    # Invokes 'lists.add_memner' method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Dashamail::Member] New member instance
+    def add_member(params)
+      added = connection.call_method('lists.add_member', params.merge(id_params))
+      get_members(added).first
+    end
+
+    # Invokes 'lists.unsubscribe_member' API method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Fixnum] Count of unsubscribed members
+    def unsubscribe_member(params)
+      connection.call_method('lists.unsubscribe_member', params.merge(id_params))['unsubscribed']
+    end
+
+    private
+
+    def id_params
+      {list_id: id}
+    end
+  end
+end

data/lib/dashamailrb/member.rb

@@ -0,0 +1,70 @@
+module Dashamail
+  class Member < Model
+    attr_reader :raw
+
+    FIELDS = [
+      :id,
+      :list_id,
+      :email,
+      :state,
+      :merge_1,
+      :merge_2,
+      :merge_3,
+      :merge_4,
+      :merge_5,
+      :optin_time,
+      :unsub_time,
+      :lastedit_time
+    ]
+
+    FIELDS.each do |f|
+      attr_reader f
+    end
+
+    # Initialize new member instance
+    #
+    # @param connection [Pachkin::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      super(connection, doc)
+      FIELDS.each do |field|
+        instance_variable_set :"@#{field}", doc[field.to_s]
+      end
+    end
+
+    # Invokes 'lists.delete_member' API method
+    #
+    def delete_member
+      connection.call_method('lists.delete_member', id_params)
+    end
+
+    # Invokes 'lists.update_member' API method
+    #
+    # @param params [Hash] Params to be passed
+    def update_member(params)
+      connection.call_method('lists.update_member', params.merge(id_params))
+    end
+
+    # Invokes 'lists.get_lists' API method to retrieve member list
+    #
+    # @param params [Dashamail::List] List instance, accosiated with member
+    def list
+      connection.get_list(list_id)
+    end
+
+    # Invokes 'lists.unsubscribe_member' API method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Fixnum] Count of unsubscribed members
+    def unsubscribe_member(params)
+      connection.call_method('lists.unsubscribe_member', params.merge(id_params))['unsubscribed']
+    end
+
+    private
+
+    def id_params
+      {member_id: id}
+    end
+
+  end
+end

data/lib/dashamailrb/model.rb

@@ -0,0 +1,24 @@
+module Dashamail
+  # Basic class for API model objects
+  class Model
+
+    # API object data
+    attr_reader :raw
+
+    # Initialize new model instance
+    #
+    # @param connection [Dashamail::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      @connection = connection
+      @raw = doc
+    end
+
+    protected
+
+    def connection
+      @connection
+    end
+
+  end
+end

data/lib/dashamailrb/version.rb

@@ -0,0 +1,3 @@
+module DashaMailRb
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: DashaMailRb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandr Prokopenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-15 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'
+description: Interface for dashamail.ru service API
+email:
+- prokopenko@igc.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dashamailrb.gemspec
+- lib/dashamailrb.rb
+- lib/dashamailrb/api_exception.rb
+- lib/dashamailrb/dashamail.rb
+- lib/dashamailrb/list.rb
+- lib/dashamailrb/member.rb
+- lib/dashamailrb/model.rb
+- lib/dashamailrb/version.rb
+homepage: https://github.com/DashaMail/DashamailRb
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Interface for dashamail.ru service API
+test_files: []