sms_aero 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b52fc948890d3313610388be5e1757e77212476
-  data.tar.gz: 26936444af10df3a81997e8b78acbb18a8c480a7
+  metadata.gz: fdf410ad50fc28f563f44d7749d96e6a1d0c55a3
+  data.tar.gz: cdbbbb1536558b11a8d58f070785e0a67802bc75
 SHA512:
-  metadata.gz: 69ee02b04df901f37a568abf8debc38ca4ac3ad0fc3587a255866d85bd328a75e9e4b359445c209809084447cacfe3dedbbed39fd1421eec84af880b901c778d
-  data.tar.gz: d90ab49c4c46fc3e8e40a2f8d9b0ed90be2017a21fe7bf30b5d7dcf03c171a5ba0437012fedbf5371874420cd6e1f8522124fd0ee58027746a643bb510114706
+  metadata.gz: 1cb59cd8f2900d1f72ca3ceeedfc41bcd75dce2f265f2d6316f4ba312d0204c21e2b36ad90463d111c2f4ef3261dc7119c8ea32b34f66653a496e9ebb3a51fb3
+  data.tar.gz: 71563a2b0af8242313d0f38b6b2e6eb684869d162e0cd1aa68c412fc798f52d076c472d61aa023c4dcc7e171407326c8fb3395bbfc9ae5f2ab268e6752b24adb

data/.rubocop.yml

@@ -12,9 +12,6 @@ Metrics/LineLength:
     - http
     - https
   
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
 Style/Lambda:
   Enabled: false
 
@@ -24,14 +21,14 @@ Style/StringLiterals:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/DateTime:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/SpaceInLambdaLiteral:
+  Enabled: false
+
 Style/PercentLiteralDelimiters:
   Enabled: false

data/CHANGELOG.md

@@ -1,18 +1,25 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.0.11] - [2017-12-19]
+## [0.1.0] - [2017-08-11]
 
-### Added
-- Always add #success to response from #hlr (@Earendil95)
+The gem is re-written on top of newer version of [evil-client]
+Some changes in the interface has been made as well.
 
-## [0.0.10] - [2017-12-03]
+### Changed
 
-### Added
-- checking existance & availability of phone number using methods `#hlr` and `#hlr_status id` (@Earendil95)
+- The root option `:test` renamed to `:testsend` for internal reasons of [evil-client][evil-client] implementation (nepalez)
+- Version of [evil-client][evil-client] used under the hood: 0.3.3 -> 1.1.0 (nepalez)
+
+### Deleted
+
+- Method `send_to_group` removed in favor or `group:` option of `send_sms` (nepalez)
+- Validation of responses returned by a remote server (nepalez)
+- Dependency from [dry-types][dry-types] (nepalez)
 
 ## [0.0.9] - [2017-06-23]
 
@@ -24,10 +31,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Weakened dependency from [dry-types], allowing v0.0.9 (@nepalez)
 
-  Between v0.9.0 and v0.9.1 an `optional` property has been broken.
-
+[evil-client]: https://github.com/evilmartians/evil-client
 [dry-types]: https://github.com/dry-rb/dry-types
 [0.0.8]: https://github.com/nepalez/sms_aero/compare/v0.0.7...v0.0.8
 [0.0.9]: https://github.com/nepalez/sms_aero/compare/v0.0.8...v0.0.9
-[0.0.10]: https://github.com/nepalez/sms_aero/compare/v0.0.9...v0.0.10
-[0.0.11]: https://github.com/nepalez/sms_aero/compare/v0.0.10...v0.0.11
+[0.1.0]: https://github.com/nepalez/sms_aero/compare/v0.0.9...v0.1.0

data/README.md

@@ -5,17 +5,11 @@
 [![Dependency Status][gemnasium-badger]][gemnasium]
 [![Code Climate][codeclimate-badger]][codeclimate]
 
-HTTP(s) client to [SMS Aero service API][sms-aero].
+HTTP(s) client to [SMS Aero service API][sms-aero]
+written on top of [evil-client][evil-client] "framework".
 
-[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
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
 
 ## Synopsis
 
@@ -28,7 +22,7 @@ Initialize a client with user and password:
 ```ruby
 client = SmsAero.new user: "joe",        # required
                      password: "foobar", # required
-                     test: true          # optional - to send test SMS by default
+                     testsend: true      # optional - to send test SMS
 ```
 
 Then send requests:
@@ -39,9 +33,9 @@ answer = client.send_sms text: "Hello!",
                          date: "2100/01/12", # Date, Time, DateTime are accepted as well
                          type: 3 # see API docs for details
 
-answer.result  # => "accepted"
-answer.id      # => "38293"
-answer.success # => true (checks whether id was returned)
+answer.result   # => "accepted"
+answer.id       # => "38293"
+answer.success? # => true (checks whether an id has been returned)
 ```
 
 ```ruby
@@ -50,13 +44,14 @@ answer.result # => "pending"
 ```
 
 ```ruby
-answer = client.send_to_group text:  "Hello!",
-                              group: "customers",
-                              date:  "2100/01/12",
-                              type:  1
+answer = client.send_sms text:  "Hello!",
+                         group: "customers",
+                         date:  Date.new("2100/01/12"),
+                         type:  1
 
-answer.result # => "accepted"
-answer.id     # => "894924"
+answer.result   # => "accepted"
+answer.id       # => "894924"
+answer.success? # => true (checks whether an id has been returned)
 ```
 
 ```ruby
@@ -128,13 +123,13 @@ answer = client.delete_phone phone: "+7 (999) 123-4567",
 answer.result   # => "accepted"
 ```
 
-```ruby
-# checking existance & availability of phone number
-answer = client.hlr phone: "+7 (999) 123-4567"
-answer.result   # => "accepted"
-id = answer.id  # => "12345", id of request
-
-answer = client.hlr_status id
-answer.result   # => "accepted"
-answer.status   # => any of :available, :unavailable or :nonexistent
-```
+[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
+[evil-client]: https://github.com/evilmartians/evil-client

data/lib/sms_aero.rb

@@ -1,56 +1,141 @@
 require "evil/client"
-require "dry-types"
 
 # HTTP(s) client to the "SMS Aero" online service
-class SmsAero
-  extend Evil::Client::DSL
+class SmsAero < Evil::Client
+  require_relative "sms_aero/callable"
+  require_relative "sms_aero/optional"
+  require_relative "sms_aero/filled_string"
+  require_relative "sms_aero/future"
+  require_relative "sms_aero/digital"
+  require_relative "sms_aero/phone"
+  require_relative "sms_aero/birthday"
+  require_relative "sms_aero/group"
+  require_relative "sms_aero/channel"
+  require_relative "sms_aero/tariff"
+  require_relative "sms_aero/response"
 
-  # Collection of dry-types with gem-specific additions
-  Types = Module.new { |types| types.include Dry::Types.module }
+  option :user,     FilledString
+  option :password, optional: true
+  option :token,    default: -> { OpenSSL::Digest::MD5.new.hexdigest(password) }
+  option :use_ssl,  true.method(:&), default: proc { true }
+  option :use_post, true.method(:&), default: proc { true }
+  option :testsend, true.method(:&), default: proc { false }
 
-  # Definitions for types, models, and API operations
-  %w(types models operations).each do |folder|
-    path = File.expand_path("../sms_aero/#{folder}/*.rb", __FILE__)
-    Dir[path].each { |file| require(file) }
+  path          { "http#{'s' if use_ssl}://gate.smsaero.ru/" }
+  http_method   { use_post ? :post : :get }
+  query         { { user: user, password: token, answer: "json" } }
+  response(200) { |*res| Response.build(*res) }
+  headers "X-Ruby-Client"    => "https://github.com/nepalez/sms_aero",
+          "X-Ruby-Framework" => "https://github.com/evilmartians/evil-client"
+
+  operation :add_blacklist do
+    option :phone, Phone
+
+    path  "addblacklist"
+    query { { phone: phone } }
   end
 
-  settings do
-    option :user,     Types::FilledString
-    option :password, Types::Password
-    option :use_ssl,  Types::Form::Bool, default: proc { true }
-    option :use_post, Types::Form::Bool, default: proc { true }
-    option :test,     Types::Form::Bool, default: proc { false }
+  operation :add_group do
+    option :group, Group
+
+    path  "addgroup"
+    query { { group: group } }
   end
 
-  base_url do |settings|
-    "http#{'s' if settings.use_ssl}://gate.smsaero.ru/"
+  operation :add_phone do
+    option :phone,  Phone
+    option :group,  optional: true, type: Group
+    option :bday,   optional: true, type: Birthday
+    option :lname,  optional: true
+    option :fname,  optional: true
+    option :sname,  optional: true
+    option :param,  optional: true
+    option :param2, optional: true
+    option :param3, optional: true
+
+    path  "addphone"
+    query { options.except :password, :token, :use_ssl, :use_post, :testsend }
   end
 
-  operation do |settings|
-    documentation "https://smsaero.ru/api/description/"
+  operation :check_balance do
+    path "balance"
+    response(200) { |*res| Response::WithBalance.build(*res) }
+  end
 
-    http_method(settings.use_post ? :post : :get)
+  operation :check_groups do
+    path "checkgroup"
+    response(200) { |*res| Response::WithGroups.build(*res) }
+  end
 
-    security do
-      key_auth :user,     settings.user,     using: :query
-      key_auth :password, settings.password, using: :query
-      key_auth :answer,   "json",            using: :query
-    end
+  operation :check_senders do
+    option :sign, FilledString
+
+    path          "senders"
+    query         { { sign: sign } }
+    response(200) { |*res| Response::WithSenders.build(*res) }
+  end
+
+  operation :check_sending do
+    option :id, FilledString
+
+    path  "checksending"
+    query { { id: id } }
+  end
+
+  operation :check_sign do
+    option :sign, FilledString
 
-    responses format: :json do
-      response :success, 200, model: Answer
-      response :failure, 200, model: Answer
+    path  "sign"
+    query { { sign: sign } }
+
+    response(200) do |_, _, body|
+      data = JSON.parse(body.first)
+      Response::WithStatuses.new(data: data)
     end
   end
 
-  private
+  operation :check_status do
+    option :id, FilledString
+
+    path  "status"
+    query { { id: id } }
+  end
+
+  operation :check_tariff do
+    path "checktarif"
+
+    response(200) { |*res| Response::WithTariff.build(*res) }
+  end
+
+  operation :delete_group do
+    option :group, FilledString
 
-  def method_missing(name, *args)
-    op = operations[name.to_sym]
-    op ? op.call(*args) : super
+    path  "delgroup"
+    query { options.select { |key| key == :group } }
   end
 
-  def respond_to_missing?(name, *)
-    operations.key? name.to_sym
+  operation :delete_phone do
+    option :phone, Phone
+    option :group, FilledString, optional: true
+
+    path  "delphone"
+    query { options.select { |key| %i[phone group].include? key } }
+  end
+
+  operation :send_sms do
+    option :to,      Phone, optional: true
+    option :group,   Group, optional: true
+    option :from,    FilledString
+    option :text,    FilledString
+    option :date,    Future,  optional: true
+    option :digital, Digital, optional: true
+    option :type,    Channel, default: -> { 2 unless digital == 1 }
+
+    validate(:address_given) { !to ^ !group }
+
+    path  { group && "sendtogroup" || testsend && "testsend" || "send" }
+    query { options.slice(:to, :group, :from, :text, :date, :digital, :type) }
+
+    response(200) { |*res| Response::WithId.build(*res) }
   end
 end

data/lib/sms_aero/birthday.rb

@@ -0,0 +1,12 @@
+class SmsAero::Birthday < String
+  extend SmsAero::Callable
+
+  private
+
+  def initialize(value)
+    date = value.respond_to?(:to_date) ? value.to_date : Date.parse(value)
+    super date.strftime "%Y-%m-%d"
+  rescue
+    raise "#{value} is not a valid value for a birthday"
+  end
+end

data/lib/sms_aero/callable.rb

@@ -0,0 +1,6 @@
+module SmsAero::Callable
+  def call(*args)
+    new(*args)
+  end
+  alias [] call
+end

data/lib/sms_aero/channel.rb

@@ -0,0 +1,15 @@
+class SmsAero::Channel < String
+  extend SmsAero::Callable
+
+  def self.new(value)
+    value ? super(value) : Dry::Initializer::UNDEFINED
+  end
+
+  private
+
+  def initialize(value)
+    channel = value.to_s
+    return super(channel) if %w(1 2 3 4 6).include? channel
+    raise "Incorrect value #{channel} for channel"
+  end
+end

data/lib/sms_aero/digital.rb

@@ -0,0 +1,7 @@
+module SmsAero::Digital
+  extend SmsAero::Callable
+
+  def self.new(value)
+    value ? 1 : 0
+  end
+end

data/lib/sms_aero/filled_string.rb

@@ -0,0 +1,11 @@
+class SmsAero::FilledString < String
+  extend SmsAero::Callable
+
+  private
+
+  def initialize(value)
+    string = value.to_s
+    raise "blank value" if string == ""
+    super string
+  end
+end

data/lib/sms_aero/future.rb

@@ -0,0 +1,16 @@
+# Coercible Unix time in future
+class SmsAero::Future < String
+  extend SmsAero::Callable
+
+  private
+
+  def initialize(value)
+    time = value.to_time         if     value.respond_to? :to_time
+    time ||= ::Time.parse(value) unless value.is_a? Numeric
+    number = time.to_i
+    return super(number.to_s) if number > ::Time.now.to_i
+    raise "#{value} is a time in the past, not in the future"
+  rescue
+    raise "#{value} is not a valid time"
+  end
+end

data/lib/sms_aero/group.rb

@@ -0,0 +1,11 @@
+class SmsAero::Group < String
+  extend SmsAero::Callable
+
+  private
+
+  def initialize(value)
+    group = value.to_s
+    raise "'#{value}' is not a valid group name" unless group[/^\w{1,20}$/]
+    super group
+  end
+end

data/lib/sms_aero/optional.rb

@@ -0,0 +1,15 @@
+module SmsAero::Optional
+  private
+
+  def initialize(opts)
+    super opts.each_with_object({}) { |(key, val), obj| obj[key.to_sym] = val }
+  end
+
+  def respond_to_missing?(name, *)
+    @__options__.respond_to? name
+  end
+
+  def method_missing(*args, &block)
+    respond_to_missing?(*args) ? @__options__.send(*args, &block) : super
+  end
+end