sms_aero 0.0.1

data/lib/sms_aero/operations/check_status.rb

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

data/lib/sms_aero/operations/check_tariff.rb

@@ -0,0 +1,12 @@
+class SmsAero
+  operation :check_tariff do
+    documentation "https://smsaero.ru/api/description/#get-balance"
+
+    path { "checktarif" }
+
+    response :success, 200, format: :json do
+      attribute :result, Types::FilledString
+      attribute :reason, Tariff, as: :tariff
+    end
+  end
+end

data/lib/sms_aero/operations/delete_group.rb

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

data/lib/sms_aero/operations/delete_phone.rb

@@ -0,0 +1,12 @@
+class SmsAero
+  operation :delete_phone do
+    documentation "https://smsaero.ru/api/description/#contacts"
+
+    path { "delphone" }
+
+    query do
+      attribute :phone, Types::Phone
+      attribute :group, Types::FilledString, optional: true
+    end
+  end
+end

data/lib/sms_aero/operations/send_sms.rb

@@ -0,0 +1,17 @@
+class SmsAero
+  operation :send_sms do
+    documentation "https://smsaero.ru/api/description/#send-sms"
+
+    path do |test: false, **|
+      test ? "testsend" : "send"
+    end
+
+    query model: Sms do
+      attribute :to, Types::Phone
+    end
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :id, Types::Coercible::String
+    end
+  end
+end

data/lib/sms_aero/operations/send_to_group.rb

@@ -0,0 +1,15 @@
+class SmsAero
+  operation :send_to_group do
+    documentation "https://smsaero.ru/api/description/#send-sms"
+
+    path { "sendtogroup" }
+
+    query model: Sms do
+      attribute :group, Types::FilledString, default: proc { "all" }
+    end
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :id, Types::Coercible::String, optional: true
+    end
+  end
+end

data/lib/sms_aero/types/birthday.rb

@@ -0,0 +1,20 @@
+module SmsAero::Types
+  # Describes a user's birthday in year-month-date format
+  # Accepts dates, times, datetimes, and strings parceable to dates
+  #
+  # @example
+  #   SmsAero::Types::Birthday["1901-12-9"]                   # => "1901-12-09"
+  #   SmsAero::Types::Birthday[Time.new(1901, 12, 9, 10, 12)] # => "1901-12-09"
+  #
+  Birthday = Strict::String
+             .constrained(format: /\A\d{4}-\d{2}-\d{2}\z/)
+             .constructor do |value|
+               begin
+                 date = value.to_date if value.respond_to? :to_date
+                 date ||= ::Date.parse(value.to_s)
+                 date.strftime "%Y-%m-%d"
+               rescue
+                 raise TypeError, "#{value.inspect} cannot be coerced to date"
+               end
+             end
+end

data/lib/sms_aero/types/channel.rb

@@ -0,0 +1,4 @@
+module SmsAero::Types
+  # Describes acceptable channel codes
+  Channel = Coercible::Int.constrained included_in: [1, 2, 3, 4, 6]
+end

data/lib/sms_aero/types/digital.rb

@@ -0,0 +1,8 @@
+module SmsAero::Types
+  # Converts any value to either 1 or 0 flag for digital sending channel
+  #
+  # @example
+  #   SmsAero::Types::Digital[true] # => 1
+  #
+  Digital = Strict::Int.constructor { |value| value ? 1 : 0 }
+end

data/lib/sms_aero/types/filled_string.rb

@@ -0,0 +1,3 @@
+module SmsAero::Types
+  FilledString = Coercible::String.constrained(filled: true)
+end

data/lib/sms_aero/types/future.rb

@@ -0,0 +1,16 @@
+module SmsAero::Types
+  # Describes coercible Unix time in future
+  Future = Strict::Int.constructor do |value|
+    begin
+      error = TypeError.new "#{value.inspect} is not a valid time in future"
+
+      time = value.to_time              if     value.respond_to? :to_time
+      time ||= ::Time.parse(value.to_s) unless value.is_a? Numeric
+      number = time.to_i
+
+      (number > ::Time.now.to_i) ? number : raise(error)
+    rescue
+      raise error
+    end
+  end
+end

data/lib/sms_aero/types/phone.rb

@@ -0,0 +1,12 @@
+module SmsAero::Types
+  # Describes a valid phone containing digits without lead zeros
+  #
+  # @example
+  #   SmsAero::Types::Phone["07 (123) 134-12-08"] # => "71231341208"
+  #   SmsAero::Types::Phone["008"] # raises #<Dry::Types::ConstraintError ...>
+  #
+  Phone = Strict::String.constrained(format: /\A\d{11,13}\z/)
+                        .constructor do |value|
+                          value.to_s.scan(/\d/).join[/[^0].*/].to_s
+                        end
+end

data/lib/sms_aero/types/sign_status.rb

@@ -0,0 +1,9 @@
+module SmsAero::Types
+  # Describes statuses of the sign
+  SignStatus = Strict::String.constrained included_in: %w(
+    accepted
+    approved
+    rejected
+    pending
+  )
+end

data/sms_aero.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name     = "sms_aero"
+  gem.version  = "0.0.1"
+  gem.author   = "Andrew Kozin (nepalez)"
+  gem.email    = "andrew.kozin@gmail.com"
+  gem.homepage = "https://github.com/nepalez/sms_aero"
+  gem.summary  = "HTTP(s) client to SMS Aero API"
+  gem.license  = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = gem.files.grep(/^spec/)
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
+
+  gem.required_ruby_version = ">= 2.2"
+
+  gem.add_runtime_dependency "dry-types", "~> 0.9.1"
+  gem.add_runtime_dependency "evil-client", "~> 0.3.0"
+
+  gem.add_development_dependency "rake", "~> 11.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "rubocop", "~> 0.42"
+  gem.add_development_dependency "webmock", "~> 2.1"
+end

data/spec/sms_aero/operations/add_blacklist_spec.rb

@@ -0,0 +1,88 @@
+RSpec.describe SmsAero, "#add_blacklist" do
+  let(:settings) { { user: "LOGIN", password: "PASSWORD" } }
+  let(:client)   { described_class.new(settings) }
+  let(:params)   { { phone: "+7 (018) 132-4388" } }
+  let(:answer)   { { result: "accepted" } }
+
+  before  { stub_request(:any, //).to_return(body: answer.to_json) }
+  subject { client.add_blacklist(params) }
+
+  context "using ssl via POST:" do
+    let(:host)  { "https://gate.smsaero.ru/addblacklist" }
+    let(:query) { "answer=json&password=PASSWORD&phone=70181324388&user=LOGIN" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+
+    it "returns success" do
+      expect(subject).to be_kind_of SmsAero::Answer
+      expect(subject.result).to eq "accepted"
+    end
+  end
+
+  context "via GET:" do
+    let(:host)  { "https://gate.smsaero.ru/addblacklist" }
+    let(:query) { "answer=json&password=PASSWORD&phone=70181324388&user=LOGIN" }
+
+    before { settings[:use_post] = false }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:get, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "not using ssl:" do
+    let(:host)  { "http://gate.smsaero.ru/addblacklist" }
+    let(:query) { "answer=json&password=PASSWORD&phone=70181324388&user=LOGIN" }
+
+    before { settings[:use_ssl] = false }
+
+    it "sends a request via http" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom user:" do
+    let(:host)  { "https://gate.smsaero.ru/addblacklist" }
+    let(:query) { "answer=json&password=PASSWORD&phone=70181324388&user=USER" }
+
+    before { params[:user] = "USER" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom password:" do
+    let(:host)  { "https://gate.smsaero.ru/addblacklist" }
+    let(:query) { "answer=json&password=PSWD&phone=70181324388&user=LOGIN" }
+
+    before { params[:password] = "PSWD" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid phone:" do
+    before { params[:phone] = "foobar23" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError, /23/)
+    end
+  end
+
+  context "without a phone:" do
+    before { params.delete :phone }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(KeyError)
+    end
+  end
+end

data/spec/sms_aero/operations/add_group_spec.rb

@@ -0,0 +1,88 @@
+RSpec.describe SmsAero, "#add_group" do
+  let(:settings) { { user: "LOGIN", password: "PASSWORD" } }
+  let(:client)   { described_class.new(settings) }
+  let(:params)   { { group:  "foobar" } }
+  let(:answer)   { { result: "accepted" } }
+
+  before  { stub_request(:any, //).to_return(body: answer.to_json) }
+  subject { client.add_group(params) }
+
+  context "using ssl via POST:" do
+    let(:host)  { "https://gate.smsaero.ru/addgroup" }
+    let(:query) { "answer=json&group=foobar&password=PASSWORD&user=LOGIN" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+
+    it "returns success" do
+      expect(subject).to be_kind_of SmsAero::Answer
+      expect(subject.result).to eq "accepted"
+    end
+  end
+
+  context "via GET:" do
+    let(:host)  { "https://gate.smsaero.ru/addgroup" }
+    let(:query) { "answer=json&group=foobar&password=PASSWORD&user=LOGIN" }
+
+    before { settings[:use_post] = false }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:get, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "not using ssl:" do
+    let(:host)  { "http://gate.smsaero.ru/addgroup" }
+    let(:query) { "answer=json&group=foobar&password=PASSWORD&user=LOGIN" }
+
+    before { settings[:use_ssl] = false }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom user:" do
+    let(:host)  { "https://gate.smsaero.ru/addgroup" }
+    let(:query) { "answer=json&group=foobar&password=PASSWORD&user=USER" }
+
+    before { params[:user] = "USER" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom password:" do
+    let(:host)  { "https://gate.smsaero.ru/addgroup" }
+    let(:query) { "answer=json&group=foobar&password=PSWD&user=LOGIN" }
+
+    before { params[:password] = "PSWD" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid group:" do
+    before { params[:group] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "without a group:" do
+    before { params.delete :group }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(KeyError)
+    end
+  end
+end

data/spec/sms_aero/operations/add_phone_spec.rb

@@ -0,0 +1,221 @@
+RSpec.describe SmsAero, "#add_phone" do
+  let(:settings) { { user: "LOGIN", password: "PASSWORD" } }
+  let(:client)   { described_class.new(settings) }
+  let(:params)   { { phone:  "+7 (909) 382-84-45" } }
+  let(:answer)   { { result: "accepted" } }
+
+  before  { stub_request(:any, //).to_return(body: answer.to_json) }
+  subject { client.add_phone(params) }
+
+  context "using ssl via POST:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) { "answer=json&password=PASSWORD&phone=79093828445&user=LOGIN" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+
+    it "returns success" do
+      expect(subject).to be_kind_of SmsAero::Answer
+      expect(subject.result).to eq "accepted"
+    end
+  end
+
+  context "via GET:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) { "answer=json&password=PASSWORD&phone=79093828445&user=LOGIN" }
+
+    before { settings[:use_post] = false }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:get, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "not using ssl:" do
+    let(:host)  { "http://gate.smsaero.ru/addphone" }
+    let(:query) { "answer=json&password=PASSWORD&phone=79093828445&user=LOGIN" }
+
+    before { settings[:use_ssl] = false }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom user:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) { "answer=json&password=PASSWORD&phone=79093828445&user=USER" }
+
+    before { params[:user] = "USER" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with custom password:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) { "answer=json&password=PSWD&phone=79093828445&user=LOGIN" }
+
+    before { params[:password] = "PSWD" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid phone:" do
+    before { params[:phone] = "1324" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError, /1324/)
+    end
+  end
+
+  context "without a phone:" do
+    before { params.delete :phone }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(KeyError)
+    end
+  end
+
+  context "with valid fname:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&fname=joe&password=PASSWORD&phone=79093828445&user=LOGIN"
+    end
+
+    before { params[:fname] = "joe" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid fname:" do
+    before { params[:fname] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "with valid sname:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&password=PASSWORD&phone=79093828445&sname=joe&user=LOGIN"
+    end
+
+    before { params[:sname] = "joe" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid sname:" do
+    before { params[:sname] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "with valid lname:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&lname=smith&password=PASSWORD&phone=79093828445&user=LOGIN"
+    end
+
+    before { params[:lname] = "smith" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid lname:" do
+    before { params[:lname] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "with valid group:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&group=qux&password=PASSWORD&phone=79093828445&user=LOGIN"
+    end
+
+    before { params[:group] = "qux" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid group:" do
+    before { params[:group] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "with valid param:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&param=qux&password=PASSWORD&phone=79093828445&user=LOGIN"
+    end
+
+    before { params[:param] = "qux" }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid param:" do
+    before { params[:param] = "" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError)
+    end
+  end
+
+  context "with valid bday:" do
+    let(:host)  { "https://gate.smsaero.ru/addphone" }
+    let(:query) do
+      "answer=json&bday=1901-08-17&password=PASSWORD&" \
+      "phone=79093828445&user=LOGIN"
+    end
+
+    before { params[:bday] = Date.parse("1901-08-17") }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, "#{host}?#{query}")).to have_been_made
+    end
+  end
+
+  context "with invalid bday:" do
+    before { params[:bday] = "foo" }
+
+    it "raises an exception" do
+      expect { subject }.to raise_error(TypeError, /foo/)
+    end
+  end
+end