sms_aero 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4085b518c9a9df7ed562ce3b9b4af7e9bafc4d18
-  data.tar.gz: c4f2d81c67a6bf2085b4013b160bf03743e6eaf2
+  metadata.gz: ee41b1be5aeaa61ce83c74ca4e3605d45f981c4e
+  data.tar.gz: bfd499ee848d4ed0848c80d5bd0920055518c9d6
 SHA512:
-  metadata.gz: 88343afc18f9b4018cf8bdf9f45ac1f57a25f838ca41e7734221768bdabbec6a85791272fb8c1e84c5401ebbc7529927b40dfd191bf9630515b2c5cfb2aee0a9
-  data.tar.gz: ca6cc12bd5f7ba6b50b8f4d239a32726e0d61b6d8f0d4b733edc18adf1f5c9f63ec1aacd7b91c2cc986a64801bca2810dea2eacfd41b8f576d8770d9a9f55937
+  metadata.gz: 8bb5adc819ed5576a3df4de08db3e9f72376c1446dfa53b6eb70fc5f14bf1363cf4a23043670d185511a9e997c01638f97fd4a2f1f94e28c8c8fb0711ad279d9
+  data.tar.gz: e72f8ea396e6c79fcead9a9232081976a67e38f579db861cb0e9a59fe62ee53746dc13e812acabaea196344e195d17b82af2f13369f730e12c7c2d9c2969b95b

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -5,6 +5,11 @@ 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.1.2] - [2017-12-03]
+
+### Added
+- checking existance & availability of phone number using methods `#hlr` and `#hlr_status id` (@Earendil95)
+
 ## [0.1.1] - [2017-09-02]
 
 ### Changed
@@ -43,3 +48,4 @@ Some changes in the interface has been made as well.
 [0.0.9]: https://github.com/nepalez/sms_aero/compare/v0.0.8...v0.0.9
 [0.1.0]: https://github.com/nepalez/sms_aero/compare/v0.0.9...v0.1.0
 [0.1.1]: https://github.com/nepalez/sms_aero/compare/v0.1.0...v0.1.1
+[0.1.2]: https://github.com/nepalez/sms_aero/compare/v0.1.0...v0.1.2

data/README.md

@@ -123,6 +123,17 @@ 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

data/lib/sms_aero/birthday.rb

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

data/lib/sms_aero/future.rb

@@ -10,7 +10,7 @@ class SmsAero::Future < String
     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
+  rescue StandardError
     raise "#{value} is not a valid time"
   end
 end

data/lib/sms_aero/hlr_status.rb

@@ -0,0 +1,11 @@
+module SmsAero::HlrStatus
+  extend SmsAero::Callable
+
+  def self.new(value)
+    case value.to_i
+    when 1 then :available
+    when 2 then :unavailable
+    else :nonexistent
+    end
+  end
+end

data/lib/sms_aero/response/with_hlr.rb

@@ -0,0 +1,5 @@
+class SmsAero
+  class Response::WithHlr < Response
+    option :status, HlrStatus
+  end
+end

data/lib/sms_aero/response.rb

@@ -1,8 +1,8 @@
 class SmsAero::Response
   extend Dry::Initializer
   extend SmsAero::Optional
-  option :reason, proc(&:to_s),    default: proc { nil }
-  option :result, proc(&:strip),   default: -> { "accepted" }
+  option :reason, proc(&:to_s),  default: proc { nil }
+  option :result, proc(&:strip), default: -> { "accepted" }
 
   def success?
     result == "accepted"
@@ -27,4 +27,5 @@ class SmsAero::Response
   require_relative "response/with_senders"
   require_relative "response/with_statuses"
   require_relative "response/with_tariff"
+  require_relative "response/with_hlr"
 end

data/lib/sms_aero.rb

@@ -14,6 +14,7 @@ class SmsAero < Evil::Client
   require_relative "sms_aero/group"
   require_relative "sms_aero/channel"
   require_relative "sms_aero/tariff"
+  require_relative "sms_aero/hlr_status"
   require_relative "sms_aero/response"
 
   option :user,     FilledString
@@ -113,7 +114,7 @@ class SmsAero < Evil::Client
     option :group, FilledString
 
     path  "delgroup"
-    query { options.select { |key| key == :group } }
+    query { { group: group } }
   end
 
   operation :delete_phone do
@@ -121,7 +122,7 @@ class SmsAero < Evil::Client
     option :group, FilledString, optional: true
 
     path  "delphone"
-    query { options.select { |key| %i[phone group].include? key } }
+    query { options.slice(:phone, :group) }
   end
 
   operation :send_sms do
@@ -140,4 +141,22 @@ class SmsAero < Evil::Client
 
     response(200) { |*res| Response::WithId.build(*res) }
   end
+
+  operation :hlr do
+    option :phone, Phone
+
+    path  "hlr"
+    query { { phone: phone } }
+
+    response(200) { |*res| Response::WithId.build(*res) }
+  end
+
+  operation :hlr_status do
+    option :id, FilledString
+
+    path  "hlrStatus"
+    query { { id: id } }
+
+    response(200) { |*res| Response::WithHlr.build(*res) }
+  end
 end

data/sms_aero.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "sms_aero"
-  gem.version  = "0.1.1"
+  gem.version  = "0.1.2"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/nepalez/sms_aero"
@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake", ">= 10"
   gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "rubocop", "~> 0.42"
+  gem.add_development_dependency "rubocop", "~> 0.48"
   gem.add_development_dependency "webmock", "~> 2.1"
 end

data/spec/operations/hlr_spec.rb

@@ -0,0 +1,86 @@
+describe SmsAero do
+  let(:settings) { { user: "LOGIN", password: "PASSWORD" } }
+  let(:client)   { described_class.new(settings) }
+
+  before { stub_request(:any, //).to_return(body: answer.to_json) }
+
+  describe "#hlr" do
+    let(:params)   { { phone: "+7(002)034-5678" } }
+    let(:answer) { { result: "accepted", id: 123 } }
+    let(:url) do
+      "https://gate.smsaero.ru/hlr?answer=json&user=LOGIN&" \
+        "password=319f4d26e3c536b5dd871bb2c52e3178&phone=70020345678"
+    end
+
+    subject { client.hlr params }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, url)).to have_been_made
+    end
+
+    it "returns success" do
+      expect(subject.result).to eq "accepted"
+      expect(subject.id).to eq "123"
+    end
+
+    context "with invalid phone" do
+      let(:params) { { phone: "123" } }
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(Evil::Client::ValidationError, /123/)
+      end
+    end
+
+    context "without a phone" do
+      let(:params) { {} }
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#hlr_status" do
+    let(:params) { { id: 1 } }
+    let(:status) { 1 }
+    let(:answer) { { result: "accepted", status: status } }
+    let(:url) do
+      "https://gate.smsaero.ru/hlrStatus?answer=json&user=LOGIN&" \
+        "password=319f4d26e3c536b5dd871bb2c52e3178&id=1"
+    end
+
+    subject { client.hlr_status params }
+
+    it "sends a request" do
+      subject
+      expect(a_request(:post, url)).to have_been_made
+    end
+
+    it "returns success" do
+      expect(subject.result).to eq "accepted"
+    end
+
+    it "converts status to sym" do
+      expect(subject.status).to eq :available
+    end
+
+    context "other statuses" do
+      context "unavailable" do
+        let(:status) { 2 }
+
+        it "converts status to sym" do
+          expect(subject.status).to eq :unavailable
+        end
+      end
+
+      context "nonexistent" do
+        let(:status) { 3 }
+
+        it "converts status to sym" do
+          expect(subject.status).to eq :nonexistent
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: sms_aero
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-02 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: evil-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  name: evil-client
-  prerelease: false
   type: :runtime
+  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'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
-  name: rubocop
-  prerelease: false
+        version: '0.48'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.48'
 - !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-  name: webmock
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description:
+description: 
 email: andrew.kozin@gmail.com
 executables: []
 extensions: []
@@ -107,11 +107,13 @@ files:
 - lib/sms_aero/filled_string.rb
 - lib/sms_aero/future.rb
 - lib/sms_aero/group.rb
+- lib/sms_aero/hlr_status.rb
 - lib/sms_aero/optional.rb
 - lib/sms_aero/phone.rb
 - lib/sms_aero/response.rb
 - lib/sms_aero/response/with_balance.rb
 - lib/sms_aero/response/with_groups.rb
+- lib/sms_aero/response/with_hlr.rb
 - lib/sms_aero/response/with_id.rb
 - lib/sms_aero/response/with_senders.rb
 - lib/sms_aero/response/with_statuses.rb
@@ -135,13 +137,14 @@ files:
 - spec/operations/check_tariff_spec.rb
 - spec/operations/delete_group_spec.rb
 - spec/operations/delete_phone_spec.rb
+- spec/operations/hlr_spec.rb
 - spec/operations/send_sms_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nepalez/sms_aero
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -156,9 +159,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.4
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
 specification_version: 4
 summary: HTTP(s) client to SMS Aero API
 test_files:
@@ -179,5 +182,6 @@ test_files:
 - spec/operations/check_tariff_spec.rb
 - spec/operations/delete_group_spec.rb
 - spec/operations/delete_phone_spec.rb
+- spec/operations/hlr_spec.rb
 - spec/operations/send_sms_spec.rb
 - spec/spec_helper.rb