greensms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9f0683de25ff0c40f5ed19b27a8e7d0997a7218e1151a39002f688e8b508827
+  data.tar.gz: c04d47dc7606f116bf7007697bed9e26b76d3c01822a0ad19188a322de58b177
+SHA512:
+  metadata.gz: 7b98db04817d0e0d7f59466179dd1cf72ff77a4c8003d0246cb42607ee622d37490d1b28b51e2aabf7f3a2a6018b64670c2ac2a71e21896643d45fc8e7f03d42
+  data.tar.gz: 6276b86e31157afa79854d98d0707f1e0b87b3f0edaacbc841051124d338897dad262b769b3a518fe4e4e5cd392cd5410684990662413b12734f4884c9e8ae78

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        #uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.gem/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [support@greensms.ru](mailto:support@greensms.ru). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in greensms.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    greensms (0.1.0)
+      faraday
+      json-schema
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    ruby2_keywords (0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  greensms!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Manan Jadhav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# greensms-ruby
+
+## Documentation
+
+The documentation for the GREENSMS API can be found [here][apidocs].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greensms'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install greensms
+```
+
+## Sample Usage
+
+Check out these [code examples](examples) to get up and running quickly.
+
+```ruby
+
+require "greensms"
+
+# Register at my.greeensms.ru first
+@client = GreenSMS::GreenSMSClient.new(user: "test", pass: "test")
+
+response = @client.sms.send(to: '71231234567', txt: 'Message to deliver')
+puts response["request_id"]
+
+
+```
+
+### Environment Variables
+
+`greensms-ruby` supports credential storage in environment variables. If no credentials are provided following env vars will be used: `GREENSMS_USER`/`GREENSMS_PASS` OR `GREENSMS_TOKEN`
+
+### Token Auth
+
+```ruby
+
+require "greensms"
+
+# Register at my.greeensms.ru first
+@client = GreenSMS::GreenSMSClient.new(token: "Your Auth Token comes here")
+
+response = @client.account.balance
+puts response["balance"]
+
+
+```
+
+## Compatibility
+
+`greensms-ruby` is compatible with Ruby 2.4+ onwards until the latest version
+
+## Methods
+
+- You can either use username/password combination or auth token to create an object with constructor
+- All methods support named keyword arguments `(to: "", extended: true)`
+- Each API Function is available as `MODULE.FUNCTION()`
+- Parameters for each API can be referred from [here][apidocs]
+- Response keys can be used as hash keys `response['key']`
+- Response keys by default are available in `snake_case`. If you want to use `camelCase`, then pass `camel_case_response: true`, in the constructor
+
+## Handling Exceptions
+
+- Exceptions for all APIs are thrown with `RestError` class. It extends the default Ruby StandardError class.
+- Each error, will have `error`, `code`, `message`, `errorType` fields.
+- In case of _Validation Error_, additional params are available to show field-wise rule failures. Can be accessed by `e.params` property on the error object
+
+## Getting help
+
+If you need help installing or using the library, please contact us: [support@greensms.ru](mailto:support@greensms.ru).
+
+If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub [here](https://github.com/greensms-ru/greensms-ruby). If you're not familiar with the GitHub pull request/contribution process, [this is a nice tutorial](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[apidocs]: https://api.greensms.ru/

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "greensms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/account.rb

@@ -0,0 +1,12 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "Account Balance"
+puts @client.account.balance
+
+puts "Access Token"
+puts @client.account.token(token: 100)
+
+puts "Tariff"
+puts @client.account.tariff

data/examples/call.rb

@@ -0,0 +1,11 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "Call Send"
+resp = @client.call.send(to: "79260000112")
+puts resp
+
+sleep(3)
+puts "Call Status"
+puts @client.call.status(id: resp["request_id"])

data/examples/env.rb

@@ -0,0 +1,13 @@
+require_relative "init"
+
+puts "Set Env Variables"
+ENV["GREENSMS_USER"] = "test"
+ENV["GREENSMS_PASS"] = "test"
+
+puts "\nExecute Client Example"
+@env_client = GreenSMS::GreenSMSClient.new
+puts @env_client.account.balance
+
+puts "\nDelete Env Variables"
+ENV.delete("GREENSMS_USER")
+ENV.delete("GREENSMS_PASS")

data/examples/general.rb

@@ -0,0 +1,6 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "Server Status"
+puts @client.status

data/examples/hlr.rb

@@ -0,0 +1,11 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "HLR Send"
+resp = @client.hlr.send(to: "79260000121", txt: "1221")
+puts resp
+
+sleep(3)
+puts "HLR Status"
+puts @client.hlr.status(id: resp["request_id"], to: "79260000121")

data/examples/init.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "greensms"
+
+module Example
+  CLIENT = GreenSMS::GreenSMSClient.new(user: "test", pass: "test")
+end

data/examples/pay.rb

@@ -0,0 +1,11 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "Pay Send"
+resp = @client.pay.send(to: "79260000121", amount: 10)
+puts resp
+
+sleep(3)
+puts "Pay Status"
+puts @client.pay.status(id: resp["request_id"])

data/examples/sms.rb

@@ -0,0 +1,11 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "SMS Send"
+resp = @client.sms.send(to: "79260000121", txt: "Hello Message Content")
+puts resp
+
+sleep(3)
+puts "SMS Status"
+puts @client.sms.status(id: resp["request_id"])

data/examples/social.rb

@@ -0,0 +1,11 @@
+require_relative "init"
+
+@client = Example::CLIENT
+
+puts "Social Send"
+resp = @client.social.send(to: "79260000121", txt: "Hello Message Content", from: "GreenSMS")
+puts resp
+
+sleep(3)
+puts "Social Status"
+puts @client.social.status(id: resp["request_id"])