smsapipl-client 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8eee56722cf4a5c59c853560d2c97286021e78fb8a947e8f1fb450c5b355b7ee
+  data.tar.gz: 5fa5d4cdc6e9e1b78cfb1c8626a8cfe7cbf5cffb1f1692e2045014bc049aee52
+SHA512:
+  metadata.gz: 12f89322b1edb33ba382815c921fae57deb68dabd1fa8fd5a2b13ced6854087afa6ebc0aa1c4597d6145b163f65faf53d26bdd1112ff27602d48c13e62a63910
+  data.tar.gz: 877629489b8e91d1088d7bea2d0d4ece7fd76669a7af2151b5a09c7fd06deca98ca48159d9c55c54b3abf7fa0b7b28a764105276f55261889826a01d2abc6d57

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2019-08-22
+### Changed
+- Added info about old authentication method to README
+- UTF-8 encoding added to default options
+
+## [1.0.0] - 2019-08-13
+### Added
+- Changelog.
+- Version tag.
+
+### Changed
+- Removed username/password auth in favor of OAuth2 token.
+- Moved version number to a separate file.
+- Moved main module outside of `smsapi` namespace.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smsapipl-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michal Musialik
+
+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,91 @@
+# Smsapi::Client
+
+Smsapi::Client is a Ruby implementation for SMSAPI.pl gateway created by [Ruby Logic](http://rubylogic.pl)
+Fork by Poltrax
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smsapipl-client', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smsapipl-client -v '~> 1.0'
+
+
+## Usage
+
+Be sure you have a token. You can obtain it on [SMSAPI.pl](http://smsapi.pl)
+
+```ruby
+# Include the library
+require 'smsapi'
+
+# Create the client
+
+client = Smsapi::Client.new('your_secret_token')
+
+# Get credits (account details)
+credits = client.credits
+credits.balance        # => 2.6600
+credits.pro_sms_limit  # => 16
+credits.eco_sms_limit  # => 38
+credits.mms_limit      # => 8
+credits.vms_gsm_limit  # => 26
+credits.vms_stac_limit # => 26
+
+# Send a single text message
+sms = client.send_single 500500500, 'Text Message'
+sms.status   # 'OK'
+sms.success? # => true
+sms.points   # => 0.12
+
+# When something goes wrong
+sms.status        # 'ERROR'
+sms.success?      # => false
+sms.error?        # => true
+sms.error_code    # => 101
+sms.error_message # => 'Bad Credentials'
+
+# Any additional options can be passed as last argument
+sms = client.send_single 500500500, 'Text Message', test: '1'
+
+# Sending a single PRO message. Remember to get authorisation for the name here: https://ssl.smsapi.pl/sms_settings/sendernames
+sms = client.send_single 500500500, 'Text Message', from: 'Ruby Logic'
+
+# Schedule a single message to be sent in the future
+when = DateTime.new(2015, 10, 10)
+sms = client.schedule_single 500500500, 'Text Message', when
+
+# Sending messages in bulk
+bulk = client.send_bulk [500500500, 600600600, 7007007], 'Text Message', test: '1'
+
+# Gives access to an array of sent messages
+bulk.sent
+bulk.sent.first.success? # => true
+
+# The api returns only statuses for successful messages. Since one of our
+# numbers was too short the array contains only 2 items.
+bulk.sent.count # => 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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 `smsapi.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/ruby-logic/smsapi-client/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smsapi/client"
+
+# 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

data/bin/setup

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

data/build.sh

@@ -0,0 +1 @@
+gem build *.gemspec -o pkg/smsapipl-client.gem

data/lib/smsapi/bulk_sms.rb

@@ -0,0 +1,36 @@
+module Smsapi
+  class BulkSMS
+    include Smsapi::Defaults
+
+    attr_reader :sent, :to, :message
+    def initialize(to, message, server, options = {})
+      @options = default_options.merge options
+      @to = to
+      @message = message
+      @server = server
+      @sent = []
+    end
+
+    def deliver
+      read_response @server.sms(server_params)
+      self
+    end
+
+    private
+
+    def server_params
+      @options.merge(
+        to: to.join(','),
+        message: message
+      )
+    end
+
+    def read_response(response)
+      response.each do |single_response|
+        sms = SMS.new(single_response.split(':').last, message, @server, @options)
+        sms.read_response(single_response)
+        @sent << sms
+      end
+    end
+  end
+end

data/lib/smsapi/client/version.rb

@@ -0,0 +1,3 @@
+module Smsapi
+  VERSION = '1.0.2'
+end

data/lib/smsapi/client.rb

@@ -0,0 +1,23 @@
+module Smsapi
+  class Client
+    def initialize(token)
+      @server = Smsapi::Server.new(token)
+    end
+
+    def credits(options = {})
+      Smsapi::Credits.new(@server, options).check
+    end
+
+    def send_single(to, message, options = {})
+      Smsapi::SMS.new(to, message, @server, options).deliver
+    end
+
+    def schedule_single(to, message, date, options = {})
+      Smsapi::SMS.new(to, message, @server, options).deliver_at(date)
+    end
+
+    def send_bulk(to, message, options = {})
+      Smsapi::BulkSMS.new(to, message, @server, options).deliver
+    end
+  end
+end

data/lib/smsapi/credits.rb

@@ -0,0 +1,61 @@
+module Smsapi
+  class Credits
+
+    attr_accessor :status, :error_code, :balance, :pro_sms_limit, :eco_sms_limit, :mms_limit, :vms_gsm_limit, :vms_stac_limit
+    def initialize(server, options = {})
+      @options = default_options.merge options
+      @server = server
+    end
+
+    def check
+      read_response @server.user(server_params).join(';')
+      self
+    end
+
+    def sent?
+      not self.status.nil?
+    end
+
+    def error?
+      self.status == 'ERROR'
+    end
+
+    def success?
+      self.status == 'Points'
+    end
+
+    def error_message
+      Smsapi::ERROR_MESSAGES[error_code]
+    end
+
+    def read_response(response)
+      response = response.split(':').map(&:strip)
+
+      self.status = response[0]
+      if status == 'ERROR'
+        self.error_code = response[1]
+      else
+        data = response[1].split(';')
+        self.balance        = data[0].to_f
+        self.pro_sms_limit  = data[1].to_i
+        self.eco_sms_limit  = data[2].to_i
+        self.mms_limit      = data[3].to_i
+        self.vms_gsm_limit  = data[4].to_i
+        self.vms_stac_limit = data[5].to_i
+      end
+    end
+
+    private
+
+    def default_options
+      {
+        credits: 1,
+        details: 1
+      }
+    end
+
+    def server_params
+      @options
+    end
+  end
+end

data/lib/smsapi/defaults.rb

@@ -0,0 +1,9 @@
+module Smsapi::Defaults
+  def default_options
+    {
+      from: 'Test',
+      test: '0',
+      encoding: 'utf-8'
+    }
+  end
+end

data/lib/smsapi/group_sms.rb

@@ -0,0 +1,7 @@
+module Smsapi
+  class GroupSMS < BulkSMS
+    def send
+      # read_response = server.send_group(server_params)
+    end
+  end
+end

data/lib/smsapi/server/connection.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+require 'openssl'
+
+module Smsapi
+  class Server
+    class Connection
+      def initialize(uri, port, token)
+        @http = Net::HTTP.new(uri, port)
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @token = token
+      end
+
+      def post(path, params)
+        @http.request post_request(path, params)
+      end
+
+      private
+
+      def post_request(path, params)
+        request = Net::HTTP::Post.new(path)
+        request.set_form_data(params)
+        request['Authorization'] = "Bearer #{@token}"
+        request
+      end
+    end
+  end
+end

data/lib/smsapi/server.rb

@@ -0,0 +1,32 @@
+module Smsapi
+  class Server
+    def initialize(token)
+      @token = token
+      @connection = setup_connection
+    end
+
+    def user(params = {})
+      api_response = make_request(Smsapi::API[:user_path], params)
+      api_response.split(';')
+    end
+
+    def sms(params = {})
+      api_response = make_request(Smsapi::API[:sms_path], params)
+      api_response.split(';')
+    end
+
+    private
+
+    def setup_connection
+      Smsapi::Server::Connection.new(
+        Smsapi::API[:uri],
+        Smsapi::API[:port],
+        @token
+      )
+    end
+
+    def make_request(path, params)
+      @connection.post(path, params).body
+    end
+  end
+end

data/lib/smsapi/sms.rb

@@ -0,0 +1,63 @@
+module Smsapi
+  class SMS
+    include Smsapi::Defaults
+
+    attr_accessor :to, :message, :id, :points, :status, :error_code, :date
+    def initialize(to, message, server, options = {})
+      @options = default_options.merge options
+      @to = to
+      @message = message
+      @server = server
+    end
+
+    def deliver
+      read_response @server.sms(server_params).first
+      self
+    end
+
+    def deliver_at(date)
+      @date = date
+      params = server_params.merge(date: date.to_time.to_i)
+
+      read_response @server.sms(params).first
+      self
+    end
+
+    def sent?
+      not self.status.nil?
+    end
+
+    def error?
+      self.status == 'ERROR'
+    end
+
+    def success?
+      self.status == 'SUCCESS'
+    end
+
+    def error_message
+      Smsapi::ERROR_MESSAGES[error_code]
+    end
+
+    def read_response(response)
+      response = response.split(':')
+
+      self.status = response[0]
+      if status == 'ERROR'
+        self.error_code = response[1]
+      else
+        self.id = response[1]
+        self.points = response[2]
+      end
+    end
+
+    private
+
+    def server_params
+      @options.merge(
+        to: to,
+        message: message
+      )
+    end
+  end
+end

data/lib/smsapi.rb

@@ -0,0 +1,26 @@
+require_relative 'smsapi/client/version'
+require 'smsapi/server'
+require 'smsapi/server/connection'
+require 'smsapi/client'
+require 'smsapi/defaults'
+require 'smsapi/credits'
+require 'smsapi/sms'
+require 'smsapi/bulk_sms'
+require 'smsapi/group_sms'
+
+module Smsapi
+  class Error < StandardError; end
+  class ServerError < Error; end
+
+  API = {
+    uri: 'ssl.smsapi.pl',
+    port: 443,
+    user_path: '/user.do',
+    sms_path: '/sms.do'
+  }
+
+  ERROR_MESSAGES = {
+    '101' => 'Bad Credentials',
+    '1001' => 'Bad Request Format'
+  }
+end

data/smsapipl-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smsapi'
+require 'smsapi/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smsapipl-client'
+  spec.version       = Smsapi::VERSION
+  spec.authors       = ['Staszek Zawadzki']
+  spec.email         = ['staszek@poltrax.live']
+
+  spec.summary       = 'SMSAPI.pl Ruby client - version 2024'
+  spec.description   = 'Fork of SMSAPI.pl Ruby client created by Ruby Logic S.C.'
+  spec.homepage      = 'https://github.com/Poltrax.live/smsapipl-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: smsapipl-client
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Staszek Zawadzki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Fork of SMSAPI.pl Ruby client created by Ruby Logic S.C.
+email:
+- staszek@poltrax.live
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- build.sh
+- lib/smsapi.rb
+- lib/smsapi/bulk_sms.rb
+- lib/smsapi/client.rb
+- lib/smsapi/client/version.rb
+- lib/smsapi/credits.rb
+- lib/smsapi/defaults.rb
+- lib/smsapi/group_sms.rb
+- lib/smsapi/server.rb
+- lib/smsapi/server/connection.rb
+- lib/smsapi/sms.rb
+- smsapipl-client.gemspec
+homepage: https://github.com/Poltrax.live/smsapipl-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: SMSAPI.pl Ruby client - version 2024
+test_files: []