terrasms_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34659603519006956e2ba6da3947c0930b8690fc7c5085b2fd7b0aee93b78ae1
-  data.tar.gz: 8311cf5c84f1cd1db0c02c5794fc57bf9359d59a504279b0863c3918069a5639
+  metadata.gz: 8c3ffbfb465a7b101aa4f52890cb34214e16c761a444f0cef3546fc14fb8bf3e
+  data.tar.gz: eea11615bac5451fe348d3ee912f6154dcec2c67fcb46545597a4dee7273dddb
 SHA512:
-  metadata.gz: 05b5f7c1685f45455ccc6c6fe6623563b7a2eccafc059221056bfcb0aee7b44d5c2280da80b745d25083faebf78127d6dcf908bb93d466191ebe02831492a389
-  data.tar.gz: 042d09d9e936fb16dd23e3f0de35c0c2bdaba5ed6dc865b526300ffafe28f14b1bdc4e35721e309ef2847294d6f53c33988997002c300246ef07f4f4644f3cff
+  metadata.gz: 8524154c242a51d06b1b0ee34da52b061debbb6131e886cd5e6bfa415b496df785de41ceb0c99a9d1d2fd35faacae2462ada0eba18430592872b1f89689b20aa
+  data.tar.gz: e71edda8f5da5b928c357932c02438339181a3e8033768d00d17b02ec39c847218d026bf7b00971ce692de04845043de62e1c62b80ebd0ba9902d404961c9bc1

data/README.md

@@ -1 +1,88 @@
-# terrasms_api
+# TerrasmsApi
+
+Ruby client for Terrasms API | Библиотека для API провайдера Terrasms
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Quick Demo](#quick-demo)
+  - [Exceptions](#exceptions)
+- [Contributing](#contributing)
+- [License](#license)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terrasms_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install terrasms_api
+
+## Usage
+
+### Quick demo
+
+```ruby
+require 'terrasms_api'
+```
+
+First, create client using your access token:
+
+```ruby
+client = TerrasmsApi.new(access_token: 'your.token')
+```
+After that simply do some request.
+
+```ruby
+# send sms
+# mandatory_attributes for mostly all requests:
+# - login: your login for Terrasms auth
+# - target: phone or email
+# - sender: public name
+# - message: sms body
+
+client.post('send', mandatory_attributes)
+```
+
+## Exceptions
+
+```ruby
+def send_sms
+  client.post('send', attrs)
+rescue TerrasmsApi::RequestError, TerrasmsApi::ConnectionError => e
+  puts e.message, e.backtrace
+end
+```
+
+Name | Description 
+---|---
+ `TerrasmsApi::RequestError` | Request didn't succeed
+ `TerrasmsApi::ConnectionError` | Connection didn't succeed
+
+## Testing
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/terrasms_api/error.rb

@@ -1,7 +1,12 @@
 class TerrasmsApi
   class Error
     def self.call
-      yield
+      result = yield
+      if result.to_i&.negative?
+        raise "Internal error: #{result} see https://terasms.ru/documentation/api/http/errors"
+      else
+        result
+      end
     rescue RestClient::Exception, RestClient::ExceptionWithResponse => e
       raise TerrasmsApi::RequestError, e
     rescue SocketError => e

data/lib/terrasms_api/version.rb

@@ -1,3 +1,3 @@
 class TerrasmsApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/terrasms_api.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json', '~> 2.2'
   spec.add_runtime_dependency 'rest-client', '~> 2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"
   spec.add_development_dependency "rspec-json_expectations", "~>2.2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terrasms_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - wowinter13
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Terra SMS HTTPS API Wrapper