sms_aero 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47495d4e60d1b2a8904d61a84e717e2dd07f45e6
-  data.tar.gz: d4f7bf8b15f966f5aa2995484caaa44a81e006f5
+  metadata.gz: 11a7f4bcfe9374590b97682e24add8d2a61ff4f1
+  data.tar.gz: f16f9215a7b84ab1a0906af3515be48461022012
 SHA512:
-  metadata.gz: 4072ece391ff1ad9f1ebd508b9a89d39c70e6c95f9aecb4a6d85ddf08de1b10da031f5e94ec3a65601cd906199e00e367587ef6a17a288326e86be35a2324704
-  data.tar.gz: 036f412146078b61ec6d1fee915d4a98686de50301938e9c7e7e7b57879e4972365510aff4a805fb7f0fb41e8b672b6c9ebb1a2711075a990de512aa8274f214
+  metadata.gz: aad6a6ba533cc42e810959fe7819f6c4d5b5f3d9b7c212b487ed5807007a27fce2d50d7a20433b334be9173b59db753f2737f3fa1ae6f7471a6f2c39c6ba74da
+  data.tar.gz: 16f5ee1c830ba19bcfa9b7879caeb83c1b798f711428dc97834906eba4bb7931385d6597a442046a472fe80ceb4d9bb2470c730379c1d7b4c244d67fdf08f394

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

@@ -4,6 +4,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.0.10] - [2017-12-03]
+
+### Added
+- checking existance & availability of phone number using methods `#hlr` and `#hlr_status id` (@Earendil95)
+
 ## [0.0.9] - [2017-06-23]
 
 ### Fixed
@@ -19,3 +24,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 [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.8...v0.0.10
+

data/README.md

@@ -127,3 +127,14 @@ 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
+```

data/lib/sms_aero/operations/hlr.rb

@@ -0,0 +1,32 @@
+class SmsAero
+  HLR_STATUSES = {
+    1 => :available,
+    2 => :unavailable,
+    3 => :nonexistent
+  }.freeze
+
+  operation :hlr do
+    documentation "https://smsaero.ru/api/description/#hlr"
+
+    path { "hlr" }
+
+    query { attribute :phone, Types::Phone }
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :id, proc(&:to_s)
+      attribute :success, default: proc { id != "" }
+    end
+  end
+
+  operation :hlr_status do
+    documentation "https://smsaero.ru/api/description/#hlr"
+
+    path { "hlrStatus" }
+
+    query { attribute :id, Types::Coercible::String.constrained(filled: true) }
+
+    response :success, 200, format: :json, model: Answer do
+      attribute :status, -> (s) { HLR_STATUSES[s.to_i] }
+    end
+  end
+end

data/lib/sms_aero/types/birthday.rb

@@ -13,7 +13,7 @@ module SmsAero::Types
                  date = value.to_date if value.respond_to? :to_date
                  date ||= ::Date.parse(value.to_s)
                  date.strftime "%Y-%m-%d"
-               rescue
+               rescue StandardError
                  raise TypeError, "#{value.inspect} cannot be coerced to date"
                end
              end

data/lib/sms_aero/types/future.rb

@@ -9,7 +9,7 @@ module SmsAero::Types
       number = time.to_i
 
       number > ::Time.now.to_i ? number : raise(error)
-    rescue
+    rescue StandardError
       raise error
     end
   end

data/sms_aero.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "sms_aero"
-  gem.version  = "0.0.9"
+  gem.version  = "0.0.10"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/nepalez/sms_aero"

data/spec/sms_aero/operations/hlr_spec.rb

@@ -0,0 +1,88 @@
+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).to be_kind_of SmsAero::Answer
+      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(TypeError, /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).to be_kind_of SmsAero::Answer
+      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

data/spec/sms_aero/types/sign_status_spec.rb

@@ -2,18 +2,18 @@ require "spec_helper"
 
 RSpec.describe SmsAero::Types::SignStatus do
   context "valid status:" do
-    let(:values) { %w(accepted approved rejected pending) }
+    let(:items) { %w(accepted approved rejected pending) }
 
     it "returns a status" do
-      values.each { |value| expect(described_class[value]).to eq value }
+      items.each { |item| expect(described_class[item]).to eq item }
     end
   end
 
   context "invalid status:" do
-    let(:value) { "wrong" }
+    let(:item) { "wrong" }
 
     it "fails" do
-      expect { described_class[value] }.to raise_error(StandardError, /wrong/)
+      expect { described_class[item] }.to raise_error(StandardError, /wrong/)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_aero
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -142,6 +142,7 @@ files:
 - lib/sms_aero/operations/check_tariff.rb
 - lib/sms_aero/operations/delete_group.rb
 - lib/sms_aero/operations/delete_phone.rb
+- lib/sms_aero/operations/hlr.rb
 - lib/sms_aero/operations/send_sms.rb
 - lib/sms_aero/operations/send_to_group.rb
 - lib/sms_aero/types/birthday.rb
@@ -165,6 +166,7 @@ files:
 - spec/sms_aero/operations/check_tariff_spec.rb
 - spec/sms_aero/operations/delete_group_spec.rb
 - spec/sms_aero/operations/delete_phone_spec.rb
+- spec/sms_aero/operations/hlr_spec.rb
 - spec/sms_aero/operations/send_sms_spec.rb
 - spec/sms_aero/operations/send_to_group_spec.rb
 - spec/sms_aero/types/birthday_spec.rb
@@ -194,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: HTTP(s) client to SMS Aero API
@@ -211,6 +213,7 @@ test_files:
 - spec/sms_aero/operations/check_tariff_spec.rb
 - spec/sms_aero/operations/delete_group_spec.rb
 - spec/sms_aero/operations/delete_phone_spec.rb
+- spec/sms_aero/operations/hlr_spec.rb
 - spec/sms_aero/operations/send_sms_spec.rb
 - spec/sms_aero/operations/send_to_group_spec.rb
 - spec/sms_aero/types/birthday_spec.rb