smsc_ru 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b7204a7fb41962c07eb001ff76384414f650e892
4
+ data.tar.gz: 142c238c77bcbe0f3d2005ac1eb9e787a38345d9
5
+ SHA512:
6
+ metadata.gz: 58059a14410f8a8efb9b018a0ec6ef3cd0a93d3b967455fba5f035b817b18906aa46a6cf0283fcdf9a23f9dfbba85a2d67f5618614f99cf2268eae8482df8138
7
+ data.tar.gz: 95576fcff6e4702114c10142c1cc322d98d248728439c82222165bd7072e379c5e94c8200e35ee5889f3d7fdef6ffaab00b50ff80a4f39df918ea3672d3409ce
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.rubocop.yml ADDED
@@ -0,0 +1,13 @@
1
+ AllCops:
2
+ TargetRubyVersion: 2.2
3
+ Exclude:
4
+ - '**/tmp/**/*'
5
+
6
+ Metrics/LineLength:
7
+ Max: 120
8
+
9
+ Metrics/MethodLength:
10
+ Max: 20
11
+
12
+ Metrics/AbcSize:
13
+ Max: 20
data/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ **0.1.0**
2
+
3
+ * Implement base functionality: send sms, check delivery status, balance
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in super-test-gem.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2012 Square Inc.
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,103 @@
1
+ # Smsc_ru - Ruby API Client for smsc.ru
2
+
3
+ ## Installation
4
+
5
+ Add this line to your application's Gemfile:
6
+
7
+ ```ruby
8
+ gem 'smsc_ru'
9
+ ```
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install smsc_ru
18
+
19
+ ## Configuration
20
+
21
+ ```ruby
22
+ Smsc.configure do |config|
23
+ # Mandatory attributes, creating client fail, if it not specified
24
+ config.login = 'your_login'
25
+ config.password = 'your_password' # password or MD5 hash
26
+
27
+ # Optional configuration
28
+ # default: smsc.ru
29
+ config.host = 'custom_endpoint'
30
+ # default: false
31
+ config.ssl = true
32
+ # default Logger.new(STDOUT)
33
+ config.logger = CustomerLogger.new
34
+ end
35
+ ```
36
+
37
+ Or via constructor params:
38
+
39
+ ```ruby
40
+ client = Smsc::Client.new do |client|
41
+ client.login = 'custom loging'
42
+ client.password = 'custom password'
43
+ end
44
+ ```
45
+
46
+ ## Usage
47
+
48
+ Usage example:
49
+ ```ruby
50
+ client = Smsc::Client.new
51
+
52
+ # send one sms
53
+ client.send_sms("79999999999", "Ваш пароль: 123")
54
+
55
+ # send multiple sms
56
+ client.send_sms("79999999999,78888888888", "Ваш пароль: 123")
57
+
58
+ # raise error on problem
59
+ client.send_sms("79999", "Ваш пароль: 123") # => error Smsc::BadRequest.new('invalid phone')
60
+
61
+ # add additional parameters
62
+ client.send_sms("79999999999,78888888888", "Ваш пароль: 123", translit: 1)
63
+
64
+ # Check sms status
65
+ client.status(12345, "79999999999") # => Smsc::Status model with attributes
66
+
67
+ # Receive balance
68
+ balance = client.balance
69
+ ```
70
+
71
+ Gem wrap response in models and raise errors on problems
72
+
73
+ ## Development
74
+
75
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
76
+ ```
77
+ SMSC_LOGIN=your_login SMSC_PASSWORD=your_password bin/console
78
+ ```
79
+ After starting console just type
80
+ ```ruby
81
+ client = Smsc::Client.new
82
+ client.balance
83
+ ```
84
+
85
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
86
+
87
+ ## Contributing
88
+
89
+ 1. Fork it ( https://github.com/SPBTV/smsc_ru )
90
+ 2. Create your feature branch (`git checkout -b feature/my-new-feature`)
91
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
92
+ 4. Push to the branch (`git push origin feature/my-new-feature`)
93
+ 5. Create a new Pull Request
94
+
95
+ ## License
96
+
97
+ Copyright 2015 SPB TV AG
98
+
99
+ Licensed under the Apache License, Version 2.0 (the ["License"](LICENSE)); you may not use this file except in compliance with the License.
100
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
101
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
102
+ See the License for the specific language governing permissions and limitations under the License.
103
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:rspec)
5
+
6
+ task default: :rspec
data/bin/console ADDED
@@ -0,0 +1,12 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'smsc'
5
+ require 'pry'
6
+
7
+ Smsc.configure do |config|
8
+ config.login = ENV.fetch('SMSC_LOGIN')
9
+ config.password = ENV.fetch('SMSC_PASSWORD')
10
+ end
11
+
12
+ Pry.start self
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,43 @@
1
+ require 'faraday'
2
+
3
+ # @private
4
+ module FaradayMiddleware
5
+ # @private
6
+ class HttpLogger < Faraday::Middleware
7
+ extend Forwardable
8
+ def_delegators :@logger, :debug, :info, :warn, :error, :fatal
9
+
10
+ def initialize(app, logger)
11
+ @app = app
12
+ @logger = logger
13
+ end
14
+
15
+ def call(env)
16
+ start_time = Time.now
17
+ info { request_info(env) }
18
+ debug { "Request headers: #{env[:request_headers].inspect}" }
19
+ @app.call(env).on_complete do
20
+ end_time = Time.now
21
+ response_time = end_time - start_time
22
+ info { response_info(env, response_time) }
23
+ debug { "Response headers: #{env[:response_headers].inspect}" }
24
+ debug { "Response body: #{env[:body].delete("\n")}" }
25
+ end
26
+ end
27
+
28
+ private
29
+
30
+ def filter(output)
31
+ output = output.to_s.gsub(/login=[a-zA-Z0-9_]*/, 'login=[LOGIN]')
32
+ output.to_s.gsub(/psw=[a-zA-Z0-9_]*/, 'psw=[PASSWORD]')
33
+ end
34
+
35
+ def request_info(env)
36
+ format('Started %s request to: %s', env[:method].to_s.upcase, filter(env[:url]))
37
+ end
38
+
39
+ def response_info(env, response_time)
40
+ format('Response from %s; Status: %d; Time: %.1fms', filter(env[:url]), env[:status], (response_time * 1_000.0))
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,37 @@
1
+ require 'faraday'
2
+ require 'json'
3
+
4
+ module FaradayMiddleware
5
+ # @private
6
+ class RaiseHttpException < Faraday::Middleware
7
+ # Smsc always return 200, so we handle only network errors
8
+ def call(env)
9
+ @app.call(env).on_complete do |response|
10
+ case response[:status].to_i
11
+ when 500
12
+ raise Smsc::InternalServerError, error_message_500(response, 'Something is wrong.')
13
+ when 502
14
+ raise Smsc::BadGateway, error_message_500(response, 'The server returned an invalid or incomplete response.')
15
+ when 503
16
+ raise Smsc::ServiceUnavailable, error_message_500(response, 'The server unavailable.')
17
+ when 504
18
+ raise Smsc::GatewayTimeout, error_message_500(response, 'Gateway Time-out')
19
+ when 500..600
20
+ raise Smsc::ServerError, error_message_500(response)
21
+ end
22
+ end
23
+ end
24
+
25
+ private
26
+
27
+ def error_message_500(response, body = nil)
28
+ "#{[response[:status].to_s + ':', body].compact.join(' ')} \
29
+ #{response[:method].to_s.upcase} #{filter(response[:url].to_s)}"
30
+ end
31
+
32
+ def filter(url)
33
+ url = url.to_s.gsub(/login=[a-zA-Z0-9_]*/, 'login=[LOGIN]')
34
+ url.to_s.gsub(/psw=[a-zA-Z0-9_]*/, 'psw=[PASSWORD]')
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,25 @@
1
+ require_relative '../models/balance'
2
+
3
+ module Smsc
4
+ module Api
5
+ # Balance api module
6
+ module Balance
7
+ # Receive customer balance
8
+ #
9
+ # @return [Smsc::Balance] balance model
10
+ def balance
11
+ request(
12
+ endpoint: 'balance',
13
+ params: {},
14
+ model: Smsc::Balance,
15
+ errors: {
16
+ 1 => BadRequest,
17
+ 2 => Unauthorized,
18
+ 4 => TooManyRequests,
19
+ 9 => TooManyRequests
20
+ }
21
+ )
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,35 @@
1
+ require_relative '../models/send_sms_status'
2
+
3
+ module Smsc
4
+ module Api
5
+ # Send sms api module
6
+ module SendSms
7
+ # Check status
8
+ #
9
+ # @param phones [String] user phone
10
+ # @param message [String] sms message
11
+ # @param options [Hash]
12
+ # @return [Smsc::SendSmsStatus] response status
13
+ #
14
+ def send_sms(phones, message, options = {})
15
+ params = options.merge(phones: phones, mes: message)
16
+
17
+ request(
18
+ endpoint: 'send',
19
+ params: params,
20
+ model: Smsc::SendSmsStatus,
21
+ errors: {
22
+ 1 => BadRequest,
23
+ 2 => Unauthorized,
24
+ 3 => PaymentRequired,
25
+ 4 => TooManyRequests,
26
+ 5 => BadRequest,
27
+ 6 => Forbidden,
28
+ 7 => BadRequest,
29
+ 9 => TooManyRequests
30
+ }
31
+ )
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,31 @@
1
+ require_relative '../models/status'
2
+
3
+ module Smsc
4
+ module Api
5
+ # Status api module
6
+ module Status
7
+ # Check status
8
+ #
9
+ # @param phone [String] user phone
10
+ # @param sms_id [Integer] sms id
11
+ # @param options [Hash]
12
+ # @return [Smsc::Status] status object
13
+ #
14
+ def status(phone, sms_id, options = {})
15
+ params = options.merge(phone: phone, id: sms_id)
16
+
17
+ request(
18
+ endpoint: 'status',
19
+ params: params,
20
+ model: Smsc::Status,
21
+ errors: {
22
+ 1 => BadRequest,
23
+ 2 => Unauthorized,
24
+ 4 => TooManyRequests,
25
+ 9 => TooManyRequests
26
+ }
27
+ )
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,29 @@
1
+ require_relative 'request'
2
+ require_relative 'connection'
3
+
4
+ require_relative 'api/balance'
5
+ require_relative 'api/send_sms'
6
+ require_relative 'api/status'
7
+
8
+ module Smsc
9
+ # Client provides access to SMSC API.
10
+ #
11
+ class Client
12
+ attr_accessor :config
13
+
14
+ def initialize
15
+ @config = Smsc.config.dup
16
+ yield(config) if block_given?
17
+
18
+ raise ArgumentError, 'login required' if config.login.nil?
19
+ raise ArgumentError, 'password required' if config.password.nil?
20
+ end
21
+
22
+ include Connection
23
+ include Request
24
+
25
+ include Api::Balance
26
+ include Api::Status
27
+ include Api::SendSms
28
+ end
29
+ end
@@ -0,0 +1,18 @@
1
+ module Smsc
2
+ # Smsc configuration container.
3
+ #
4
+ class Config
5
+ attr_accessor \
6
+ :login,
7
+ :password,
8
+ :host,
9
+ :ssl,
10
+ :logger
11
+
12
+ def initialize(params = {})
13
+ params.each do |key, val|
14
+ send("#{key}=", val)
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,23 @@
1
+ require 'faraday'
2
+ require_relative '../../lib/faraday_middleware/http_logger'
3
+ require_relative '../../lib/faraday_middleware/raise_http_exception'
4
+
5
+ module Smsc
6
+ # @private
7
+ module Connection
8
+ private
9
+
10
+ def connection(url)
11
+ Faraday.new(url: url) do |connection|
12
+ connection.params['login'] = config.login
13
+ connection.params['psw'] = config.password
14
+ connection.params['fmt'] = 3
15
+
16
+ connection.use FaradayMiddleware::RaiseHttpException
17
+ connection.use FaradayMiddleware::HttpLogger, config.logger
18
+
19
+ connection.adapter Faraday.default_adapter
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,39 @@
1
+ require 'faraday'
2
+
3
+ module Smsc
4
+ # Custom error class for rescuing from all Smsc errors
5
+ class Error < StandardError; end
6
+
7
+ # Main class for client errors
8
+ class ClientError < Error; end
9
+
10
+ # Raised when Smsc return error with status code 1, 7
11
+ class BadRequest < ClientError; end
12
+
13
+ # Raised when Smsc return error with status code 2
14
+ class Unauthorized < ClientError; end
15
+
16
+ # Raised when Smsc return error with status code 4, 9
17
+ class TooManyRequests < ClientError; end
18
+
19
+ # Raised when Smsc return error with status code 3
20
+ class PaymentRequired < ClientError; end
21
+
22
+ # Raised when Smsc return error with status code 6
23
+ class Forbidden < ClientError; end
24
+
25
+ # Main class for server errors
26
+ class ServerError < Error; end
27
+
28
+ # Raised when Smsc returns the HTTP status code 500
29
+ class InternalServerError < ServerError; end
30
+
31
+ # Raised when Smsc returns the HTTP status code 502
32
+ class BadGateway < ServerError; end
33
+
34
+ # Raised when Smsc returns the HTTP status code 503
35
+ class ServiceUnavailable < ServerError; end
36
+
37
+ # Raised when Smsc returns the HTTP status code 504
38
+ class GatewayTimeout < ServerError; end
39
+ end
@@ -0,0 +1,10 @@
1
+ module Smsc
2
+ # Balance model
3
+ class Balance
4
+ include Virtus.model
5
+
6
+ # @!attribute balance
7
+ # @return [Float] current balance
8
+ attribute :balance, Float
9
+ end
10
+ end
@@ -0,0 +1,14 @@
1
+ module Smsc
2
+ # Status for send sms endpoint
3
+ class SendSmsStatus
4
+ include Virtus.model
5
+
6
+ # @!attribute id
7
+ # @return [Integer] sms id
8
+ attribute :id, Integer
9
+
10
+ # @!attribute cnt
11
+ # @return [Integer] count transmitted sms
12
+ attribute :cnt, Integer
13
+ end
14
+ end
@@ -0,0 +1,22 @@
1
+ module Smsc
2
+ # Balance model
3
+ class Status
4
+ include Virtus.model
5
+
6
+ # @!attribute status
7
+ # @return [Numeric] status for sent sms
8
+ attribute :status, Numeric
9
+
10
+ # @!attribute last_date
11
+ # @return [DateTime] date for last changed status
12
+ attribute :last_date, DateTime
13
+
14
+ # @!attribute last_timestamp
15
+ # @return [Integer] timestamp for last changed status
16
+ attribute :last_timestamp, Integer
17
+
18
+ # @!attribute err
19
+ # @return [Integer] error code if sms not delivered
20
+ attribute :err, Integer
21
+ end
22
+ end
@@ -0,0 +1,23 @@
1
+ require 'addressable/template'
2
+ require_relative 'response'
3
+
4
+ module Smsc
5
+ # @private
6
+ module Request
7
+ URL_TEMPLATE = '{scheme}://{host}/sys/{endpoint}.php{?params*}'.freeze
8
+
9
+ private
10
+
11
+ def request(request_params)
12
+ request_url = Addressable::Template.new(URL_TEMPLATE).expand(
13
+ scheme: config.ssl ? 'https' : 'http',
14
+ host: config.host,
15
+ endpoint: request_params[:endpoint],
16
+ params: request_params[:params]
17
+ )
18
+
19
+ response = connection(request_url).get
20
+ Response.parse(response.body, request_params)
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,25 @@
1
+ require 'json'
2
+
3
+ module Smsc
4
+ # Response parse
5
+ class Response
6
+ class << self
7
+ def parse(body, request_params)
8
+ json = JSON.parse(body, symbolize_names: true)
9
+ raise_client_errors(json, request_params[:errors] || {})
10
+
11
+ request_params[:model].new(json)
12
+ end
13
+
14
+ def raise_client_errors(json, error_map)
15
+ error_code = json[:error_code]
16
+ error_message = json[:error]
17
+ return if error_code.nil?
18
+
19
+ error_class = error_map[error_code.to_i]
20
+ raise error_class, error_message unless error_class.nil?
21
+ raise Smsc::ClientError, error_message
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,3 @@
1
+ module Smsc
2
+ VERSION = '0.1.0'.freeze
3
+ end
data/lib/smsc.rb ADDED
@@ -0,0 +1,29 @@
1
+ require 'logger'
2
+ require 'virtus'
3
+ require_relative 'smsc/version'
4
+ require_relative 'smsc/config'
5
+ require_relative 'smsc/errors'
6
+ require_relative 'smsc/client'
7
+
8
+ # Namespace for smsc API client
9
+ module Smsc
10
+ DEFAULT_HOST = 'smsc.ru'.freeze
11
+ DEFAULT_SSL = true
12
+ DEFAULT_LOGGER = Logger.new(STDOUT)
13
+
14
+ class << self
15
+ def config
16
+ @config ||= Config.new(
17
+ login: nil,
18
+ password: nil,
19
+ host: DEFAULT_HOST,
20
+ ssl: DEFAULT_SSL,
21
+ logger: DEFAULT_LOGGER
22
+ )
23
+ end
24
+
25
+ def configure
26
+ yield(config)
27
+ end
28
+ end
29
+ end
data/lib/smsc_ru.rb ADDED
@@ -0,0 +1 @@
1
+ require 'smsc'
data/smsc.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ lib = File.expand_path('../lib', __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'smsc/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'smsc_ru'
7
+ spec.version = Smsc::VERSION
8
+ spec.authors = ['Kirill Sapozhnikov']
9
+ spec.email = ['ksapozhnikov@spbtv.com']
10
+
11
+ spec.summary = 'Api client for smsc.ru'
12
+ spec.description = 'Api client for smsc.ru'
13
+ spec.homepage = 'https://github.com/SPBTV/smsc_ru.git'
14
+ spec.license = 'Apache 2.0'
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.bindir = 'exe'
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_dependency 'faraday', '~> 0.9.0'
23
+ spec.add_dependency 'addressable', '~> 2.4'
24
+ spec.add_dependency 'virtus', '~> 1.0'
25
+
26
+ spec.add_development_dependency 'bundler', '>= 1.9'
27
+ spec.add_development_dependency 'rake', '~> 10.0'
28
+ spec.add_development_dependency 'rspec', '~> 3.3'
29
+ spec.add_development_dependency 'vcr', '~> 3.0'
30
+ spec.add_development_dependency 'pry', '~> 0.10'
31
+ spec.add_development_dependency 'webmock', '~> 2.1.0'
32
+ spec.add_development_dependency 'rubocop', '~> 0.44.0'
33
+ end
metadata ADDED
@@ -0,0 +1,212 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: smsc_ru
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Kirill Sapozhnikov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-10-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.9.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.9.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: addressable
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.4'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.4'
41
+ - !ruby/object:Gem::Dependency
42
+ name: virtus
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '1.9'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '1.9'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.3'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.3'
97
+ - !ruby/object:Gem::Dependency
98
+ name: vcr
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '3.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: pry
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '0.10'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '0.10'
125
+ - !ruby/object:Gem::Dependency
126
+ name: webmock
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 2.1.0
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 2.1.0
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: 0.44.0
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: 0.44.0
153
+ description: Api client for smsc.ru
154
+ email:
155
+ - ksapozhnikov@spbtv.com
156
+ executables: []
157
+ extensions: []
158
+ extra_rdoc_files: []
159
+ files:
160
+ - ".gitignore"
161
+ - ".rspec"
162
+ - ".rubocop.yml"
163
+ - CHANGELOG.md
164
+ - Gemfile
165
+ - LICENSE.txt
166
+ - README.md
167
+ - Rakefile
168
+ - bin/console
169
+ - bin/setup
170
+ - lib/faraday_middleware/http_logger.rb
171
+ - lib/faraday_middleware/raise_http_exception.rb
172
+ - lib/smsc.rb
173
+ - lib/smsc/api/balance.rb
174
+ - lib/smsc/api/send_sms.rb
175
+ - lib/smsc/api/status.rb
176
+ - lib/smsc/client.rb
177
+ - lib/smsc/config.rb
178
+ - lib/smsc/connection.rb
179
+ - lib/smsc/errors.rb
180
+ - lib/smsc/models/balance.rb
181
+ - lib/smsc/models/send_sms_status.rb
182
+ - lib/smsc/models/status.rb
183
+ - lib/smsc/request.rb
184
+ - lib/smsc/response.rb
185
+ - lib/smsc/version.rb
186
+ - lib/smsc_ru.rb
187
+ - smsc.gemspec
188
+ homepage: https://github.com/SPBTV/smsc_ru.git
189
+ licenses:
190
+ - Apache 2.0
191
+ metadata: {}
192
+ post_install_message:
193
+ rdoc_options: []
194
+ require_paths:
195
+ - lib
196
+ required_ruby_version: !ruby/object:Gem::Requirement
197
+ requirements:
198
+ - - ">="
199
+ - !ruby/object:Gem::Version
200
+ version: '0'
201
+ required_rubygems_version: !ruby/object:Gem::Requirement
202
+ requirements:
203
+ - - ">="
204
+ - !ruby/object:Gem::Version
205
+ version: '0'
206
+ requirements: []
207
+ rubyforge_project:
208
+ rubygems_version: 2.4.3
209
+ signing_key:
210
+ specification_version: 4
211
+ summary: Api client for smsc.ru
212
+ test_files: []