sms_aero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd3453fde3013efda34bdd4eef1de330c07933fc
+  data.tar.gz: 62bb50f526ccfd080df2b399fdefad5aedfbdc15
+SHA512:
+  metadata.gz: 6ac5ea53d23db0b146cc6aea6cac0cf4ebad9f0f72715d8b9b085f3bf0d42c299a7d91530fdfd51483ceb35d97700f0df2d232d3b791a01c092ac0390502b044
+  data.tar.gz: a9a944438acf080749852be2fbcb5dedc3e23c79098269d89b8e21d546bfd3d09c20eb1e93b2d28f1c2e176c782f03927c053bd63a5c6691d902dfd442dab477

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+---
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/FrozenStringLiteralComment:
+        enabled: false

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+---
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.3
+
+Style/Lambda:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo:     false
+language: ruby
+cache:    bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - '2.3.0'
+  - ruby-head
+  - jruby-9.1.0.0
+  - jruby-head
+before_install: gem install bundler -v 1.12.5
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sms_aero.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry",        platform: :mri
+  gem "pry-byebug", platform: :mri
+end
+
+gem "evil-client",     github: "evilmartians/evil-client", branch: "master"
+gem "dry-initializer", github: "dry-rb/dry-initializer",   branch: "master"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Kozin (aka nepalez)
+
+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,126 @@
+# SmsAero
+
+[![Gem Version][gem-badger]][gem]
+[![Build Status][travis-badger]][travis]
+[![Dependency Status][gemnasium-badger]][gemnasium]
+[![Code Climate][codeclimate-badger]][codeclimate]
+
+HTTP(s) client to [SMS Aero service API][sms-aero].
+
+[sms-aero]: https://smsaero.ru/api/description/
+[codeclimate-badger]: https://img.shields.io/codeclimate/github/nepalez/sms_aero.svg?style=flat
+[codeclimate]: https://codeclimate.com/github/nepalez/sms_aero
+[gem-badger]: https://img.shields.io/gem/v/sms_aero.svg?style=flat
+[gem]: https://rubygems.org/gems/sms_aero
+[gemnasium-badger]: https://img.shields.io/gemnasium/nepalez/sms_aero.svg?style=flat
+[gemnasium]: https://gemnasium.com/nepalez/sms_aero
+[travis-badger]: https://img.shields.io/travis/nepalez/sms_aero/master.svg?style=flat
+[travis]: https://travis-ci.org/nepalez/sms_aero
+
+## Synopsis
+
+See [operation specs][specs] for more verbose examples.
+
+[specs]: https://github.com/nepalez/sms_aero/tree/master/spec/sms_aero/operations
+
+Initialize a client with user and password:
+
+```ruby
+client = SmsAero.new user: "joe", password: "foobar"
+```
+
+Then send requests:
+
+```ruby
+answer = client.send_sms text: "Hello!",
+                         to:   "+7 (909) 382-84-45",
+                         date: "2100/01/12", # Date, Time, DateTime are accepted as well
+                         type: 3 # see API docs for details
+
+answer.result # => "accepted"
+answer.id     # => "38293"
+```
+
+```ruby
+answer = client.check_status id: "38293"
+answer.result # => "pending"
+```
+
+```ruby
+answer = client.send_to_group text:  "Hello!",
+                              group: "customers",
+                              date:  "2100/01/12",
+                              type:  1
+
+answer.result # => "accepted"
+answer.id     # => "894924"
+```
+
+```ruby
+answer = client.check_sending id: "894924"
+answer.result # => "pending"
+```
+
+```ruby
+answer = client.add_blacklist phone: "+7 (999) 123-45-67"
+answer.result # => "accepted"
+```
+
+```ruby
+answer = client.add_group group: "baz"
+answer.result # => "accepted"
+```
+
+```ruby
+answer = client.add_phone phone: "+7 (999) 123-45-67",
+                          group: "customers",
+                          fname: "John",
+                          lname: "Paul",
+                          lname: "Doe",
+                          bday:  "1998/08/12",
+                          param: "VIP"
+
+answer.result # => "accepted"
+```
+
+```ruby
+answer = client.check_balance
+answer.result  # => "accepted"
+answer.balance # => 1973.2
+```
+
+```ruby
+answer = client.check_groups
+answer.result   # => "accepted"
+answer.channels # => ["customers", "employee"]
+```
+
+```ruby
+answer = client.check_senders sign: "qux"
+answer.result # => "accepted"
+answer.result # => ["peter", "paul"]
+```
+
+```ruby
+answer = client.check_sign sign: "qux"
+answer.result # => "accepted"
+answer.data   # => ["approved"]   
+```
+
+```ruby
+answer = client.check_tariff
+answer.result # => "accepted"
+answer.tariff # => { direct: 10.3, digital: 3.89 }
+```
+
+```ruby
+answer = client.delete_group group: "employee"
+answer.result   # => "accepted"
+```
+
+```ruby
+answer = client.delete_phone phone: "+7 (999) 123-4567",
+                             group: "customers"
+
+answer.result   # => "accepted"
+```

data/Rakefile

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

data/lib/sms_aero.rb

@@ -0,0 +1,55 @@
+require "evil/client"
+require "dry-types"
+
+# HTTP(s) client to the "SMS Aero" online service
+class SmsAero
+  extend Evil::Client::DSL
+
+  # Collection of dry-types with gem-specific additions
+  Types = Module.new { |types| types.include Dry::Types.module }
+
+  # Definitions for types, models, and API operations
+  %w(types models operations).each do |folder|
+    path = File.expand_path("lib/sms_aero/#{folder}/*.rb")
+    Dir[path].each { |file| require(file) }
+  end
+
+  settings do
+    option :user,     Types::FilledString
+    option :password, Types::FilledString
+    option :use_ssl,  Types::Form::Bool, default: proc { true }
+    option :use_post, Types::Form::Bool, default: proc { true }
+  end
+
+  base_url do |settings|
+    "http#{"s" if settings.use_ssl}://gate.smsaero.ru/"
+  end
+
+  operation do |settings|
+    documentation "https://smsaero.ru/api/description/"
+
+    http_method(settings.use_post ? :post : :get)
+
+    security do |user: nil, password: nil, **|
+      key_auth :user,     user     || settings.user,     using: :query
+      key_auth :password, password || settings.password, using: :query
+      key_auth :answer,   "json",                        using: :query
+    end
+
+    responses format: :json do
+      response :success, 200, model: Answer
+      response :failure, 200, model: Answer
+    end
+  end
+
+  private
+
+  def method_missing(name, *args)
+    op = operations[name.to_sym]
+    op ? op.call(*args) : super
+  end
+
+  def respond_to_missing?(name, *)
+    operations.key? name.to_sym
+  end
+end

data/lib/sms_aero/models/answer.rb

@@ -0,0 +1,8 @@
+class SmsAero
+  class Answer < Evil::Client::Model
+    attribute :reason, default: proc { nil }
+    attribute :result,
+              Types::FilledString.constructor(&:strip),
+              default: proc { "accepted" }
+  end
+end

data/lib/sms_aero/models/sms.rb

@@ -0,0 +1,15 @@
+# Describes an SMS that can be send to either a phone or a group
+class SmsAero
+  class Sms < Evil::Client::Model
+    attribute :text,    Types::FilledString
+    attribute :date,    Types::Future,  optional: true
+    attribute :digital, Types::Digital, optional: true
+    attribute :type,    Types::Channel, default: -> (*) do
+                                          case digital
+                                          when Dry::Initializer::UNDEFINED
+                                            2
+                                          else Dry::Initializer::UNDEFINED
+                                          end
+                                        end
+  end
+end

data/lib/sms_aero/models/tariff.rb

@@ -0,0 +1,8 @@
+class SmsAero
+  class Tariff < Evil::Client::Model
+    attributes type: Types::Coercible::Float, optional: true do
+      attribute :"Direct channel",  as: :direct
+      attribute :"Digital channel", as: :digital
+    end
+  end
+end

data/lib/sms_aero/operations/add_blacklist.rb

@@ -0,0 +1,11 @@
+class SmsAero
+  operation :add_blacklist do
+    documentation "https://smsaero.ru/api/description/#balcklist"
+
+    path { "addblacklist" }
+
+    query do
+      attribute :phone, Types::Phone
+    end
+  end
+end

data/lib/sms_aero/operations/add_group.rb

@@ -0,0 +1,11 @@
+class SmsAero
+  operation :add_group do
+    documentation "https://smsaero.ru/api/description/#groups"
+
+    path { "addgroup" }
+
+    query do
+      attribute :group, Types::FilledString
+    end
+  end
+end

data/lib/sms_aero/operations/add_phone.rb

@@ -0,0 +1,17 @@
+class SmsAero
+  operation :add_phone do
+    documentation "https://smsaero.ru/api/description/#contacts"
+
+    path { "addphone" }
+
+    query do
+      attribute :phone, Types::Phone
+      attribute :group, Types::FilledString, optional: true
+      attribute :lname, Types::FilledString, optional: true
+      attribute :fname, Types::FilledString, optional: true
+      attribute :sname, Types::FilledString, optional: true
+      attribute :param, Types::FilledString, optional: true
+      attribute :bday,  Types::Birthday,     optional: true
+    end
+  end
+end

data/lib/sms_aero/operations/check_balance.rb

@@ -0,0 +1,11 @@
+class SmsAero
+  operation :check_balance do
+    documentation "https://smsaero.ru/api/description/#get-balance"
+
+    path { "balance" }
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :balance, Types::Coercible::Float
+    end
+  end
+end

data/lib/sms_aero/operations/check_groups.rb

@@ -0,0 +1,12 @@
+class SmsAero
+  operation :check_groups do
+    documentation "https://smsaero.ru/api/description/#groups"
+
+    path { "checkgroup" }
+
+    response :success, 200, format: :json do
+      attribute :result, Types::FilledString
+      attribute :reason, Types::Hash, as: :channels
+    end
+  end
+end

data/lib/sms_aero/operations/check_senders.rb

@@ -0,0 +1,15 @@
+class SmsAero
+  operation :check_senders do
+    documentation "https://smsaero.ru/api/description/#signs"
+
+    path { "senders" }
+
+    query do
+      attribute :sign, Types::FilledString
+    end
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :data, Types::Array.member(Types::FilledString)
+    end
+  end
+end

data/lib/sms_aero/operations/check_sending.rb

@@ -0,0 +1,11 @@
+class SmsAero
+  operation :check_sending do
+    documentation "https://smsaero.ru/api/description/#check-status"
+
+    path { "checksending" }
+
+    query do
+      attribute :id, Types::Coercible::String.constrained(filled: true)
+    end
+  end
+end

data/lib/sms_aero/operations/check_sign.rb

@@ -0,0 +1,15 @@
+class SmsAero
+  operation :check_sign do
+    documentation "https://smsaero.ru/api/description/#signs"
+
+    path { "sign" }
+
+    query do
+      attribute :sign, Types::FilledString
+    end
+
+    response :success, 200, format: :json do
+      attribute :data, Types::Array.member(Types::SignStatus), as: :statuses
+    end
+  end
+end