rahyab 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/Gemfile +4 -0
- data/README.md +33 -0
- data/Rakefile +1 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/lib/rahyab.rb +141 -0
- data/lib/rahyab/string.rb +10 -0
- data/lib/rahyab/version.rb +3 -0
- data/rahyab.gemspec +38 -0
- data/spec/sms_spec.rb +42 -0
- metadata +157 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8fc79c97f17192cbc62659a8e62ef32063437af4
|
4
|
+
data.tar.gz: 69649e0f1691fcc92f52f96bf716fdae9fa74210
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8064c6c3f5db36681688313103809a894f11e3d7c4041932a62d72710637b62efd797f1c5daaf22835e881b9feb777852e63e45dd97f8f3866b3813a3ecdfd05
|
7
|
+
data.tar.gz: a98c0b8a3e9d3ab341237aba67cec14109dd73f8724bf536c0cb2c865db6438b28f5e9d1098383c1dc3c8e19fab8f99582e7fd9fde0802f84e822923fdfa7513
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# Rahyab
|
2
|
+
|
3
|
+
Rahyab gem is Ruby implimentation of Rahyab SMS Service Gateway.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'rahyab'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install rahyab
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
TODO: Write usage instructions here
|
24
|
+
|
25
|
+
## Development
|
26
|
+
|
27
|
+
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.
|
28
|
+
|
29
|
+
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).
|
30
|
+
|
31
|
+
## Contributing
|
32
|
+
|
33
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/Yellowen/rahyab.
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "rahyab"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/lib/rahyab.rb
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
require "rahyab/version"
|
3
|
+
require "builder"
|
4
|
+
require 'net/http'
|
5
|
+
require 'xml'
|
6
|
+
require 'libxml_to_hash'
|
7
|
+
require 'pry'
|
8
|
+
|
9
|
+
module Rahyab
|
10
|
+
require 'rahyab/string'
|
11
|
+
|
12
|
+
class SMS
|
13
|
+
# Return Errors
|
14
|
+
attr_reader :errors
|
15
|
+
|
16
|
+
# Constructor of Rahyab SMS Gateway
|
17
|
+
def initialize(url, user, password, company)
|
18
|
+
@url = url
|
19
|
+
@user = user
|
20
|
+
@password = password
|
21
|
+
@company = company
|
22
|
+
end
|
23
|
+
|
24
|
+
# Will send one or more sms to specified numbers
|
25
|
+
def send_sms(sender, numbers, text, **params)
|
26
|
+
# Create the send XMLmarkup
|
27
|
+
if estimate_cost(numbers, text) < get_balance
|
28
|
+
identity = "#{Time.now.to_i}#{rand(1000000000..9999999999)}"
|
29
|
+
batchID = @company + "+" + identity
|
30
|
+
is_persian_text = is_persian(text)
|
31
|
+
msgClass = params["flash"] ? "0" : "1"
|
32
|
+
dcs = is_persian_text ? "8" : "0"
|
33
|
+
binary = is_persian_text ? "true" : "false"
|
34
|
+
text = text.to_h if is_persian_text
|
35
|
+
|
36
|
+
builder = Builder::XmlMarkup.new()
|
37
|
+
builder.instruct! :xml, version: "1.0", encoding: "UTF-8"
|
38
|
+
builder.declare! :DOCTYPE, :smsBatch, :PUBLIC, "-//PERVASIVE//DTD CPAS 1.0//EN", "http://www.ubicomp.ir/dtd/Cpas.dtd"
|
39
|
+
builder.smsBatch(company: @company, batchID: batchID) do |b|
|
40
|
+
b.sms(msgClass: msgClass, binary: binary, dcs: dcs) do |t|
|
41
|
+
numbers.each do |number|
|
42
|
+
t.destAddr() do |f|
|
43
|
+
f.declare! "[CDATA[%s]]" % number
|
44
|
+
end
|
45
|
+
end
|
46
|
+
t.origAddr() do |f|
|
47
|
+
f.declare! "[CDATA[%s]]" % sender
|
48
|
+
end
|
49
|
+
t.message() do |f|
|
50
|
+
f.declare! "[CDATA[#{text}]]"
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
out_xml = builder.target!
|
55
|
+
|
56
|
+
result = send_xml(out_xml)
|
57
|
+
source = XML::Parser.string(result)
|
58
|
+
content = source.parse
|
59
|
+
|
60
|
+
if content.find_first('ok')
|
61
|
+
if content.find_first('ok').content.include? 'CHECK_OK'
|
62
|
+
batchID
|
63
|
+
else
|
64
|
+
@errors = "Something going wrong"
|
65
|
+
nil
|
66
|
+
end
|
67
|
+
else
|
68
|
+
@errors = content.find_first('message').content.strip
|
69
|
+
nil
|
70
|
+
end
|
71
|
+
else
|
72
|
+
@errors = 'Not enough balance'
|
73
|
+
nil
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
|
78
|
+
def send_batch(sender, numbers, text)
|
79
|
+
end
|
80
|
+
|
81
|
+
# Check delivery status of several sms
|
82
|
+
def get_delivery(batchID)
|
83
|
+
builder = Builder::XmlMarkup.new(indent: 2)
|
84
|
+
builder.instruct! :xml, version: "1.0"
|
85
|
+
builder.declare! :DOCTYPE, :smsStatusPoll, :PUBLIC, "-//PERVASIVE//DTD CPAS 1.0//EN", "http://www.ubicomp.ir/dtd/Cpas.dtd"
|
86
|
+
builder.smsStatusPoll(company: @company) do |b|
|
87
|
+
b.batch(batchID: batchID)
|
88
|
+
end
|
89
|
+
out_xml = builder.target!
|
90
|
+
result = send_xml(out_xml)
|
91
|
+
Hash.from_libxml(result)
|
92
|
+
end
|
93
|
+
|
94
|
+
# Check the credit that how many sms can be send
|
95
|
+
def get_balance
|
96
|
+
builder = Builder::XmlMarkup.new(indent: 2)
|
97
|
+
builder.instruct! :xml, version: "1.0"
|
98
|
+
builder.getUserBalance(company: @company)
|
99
|
+
result = send_xml(builder.target!)
|
100
|
+
source = XML::Parser.string(result)
|
101
|
+
content = source.parse
|
102
|
+
return content.find_first('/userBalance').content.strip.to_f
|
103
|
+
end
|
104
|
+
|
105
|
+
private
|
106
|
+
|
107
|
+
# Check does the input contents Farsi Character
|
108
|
+
def is_persian(str)
|
109
|
+
str =~ /\p{Arabic}/
|
110
|
+
end
|
111
|
+
|
112
|
+
# Send XMLmarkup to Web Service
|
113
|
+
def send_xml(out_xml)
|
114
|
+
uri = URI.parse(@url)
|
115
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
116
|
+
request = Net::HTTP::Post.new(uri.request_uri)
|
117
|
+
request.basic_auth @user, @password
|
118
|
+
request.body = out_xml
|
119
|
+
response = http.request(request)
|
120
|
+
return response.body
|
121
|
+
end
|
122
|
+
|
123
|
+
# Cost estimates
|
124
|
+
def estimate_cost(numbers, text)
|
125
|
+
cost = 0
|
126
|
+
if is_persian(text)
|
127
|
+
sms_length = (text.length / 67.0).ceil
|
128
|
+
else
|
129
|
+
sms_length = (text.length / 157.0).ceil
|
130
|
+
end
|
131
|
+
numbers.each do |number|
|
132
|
+
if is_persian(text)
|
133
|
+
cost = cost + sms_length * 1.5
|
134
|
+
else
|
135
|
+
cost = cost + sms_length
|
136
|
+
end
|
137
|
+
end
|
138
|
+
cost
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
data/rahyab.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'rahyab/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "rahyab"
|
8
|
+
spec.version = Rahyab::VERSION
|
9
|
+
spec.authors = ["Behnam Ahmad Khan Beigi", "Sameer Rahmany"]
|
10
|
+
spec.email = ["yottanami@gnu.org", "lxsameer@gnu.org"]
|
11
|
+
|
12
|
+
spec.summary = "Ruby interface of Rahyab SMS service"
|
13
|
+
spec.description = "Ruby gem to use Rahyab SMS service"
|
14
|
+
spec.homepage = "http://www.yellowen.ir"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
|
17
|
+
# delete this section to allow pushing this gem to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata['allowed_push_host'] = "https://rubygems.org"
|
20
|
+
else
|
21
|
+
raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
|
22
|
+
end
|
23
|
+
spec.licenses = ['GPL-2']
|
24
|
+
spec.test_files = Dir['spec/*']
|
25
|
+
|
26
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
27
|
+
spec.bindir = "exe"
|
28
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
29
|
+
spec.require_paths = ["lib"]
|
30
|
+
|
31
|
+
spec.add_development_dependency "bundler", "~> 1.10"
|
32
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
33
|
+
spec.add_development_dependency "rspec"
|
34
|
+
spec.add_development_dependency "pry"
|
35
|
+
spec.add_dependency "builder"
|
36
|
+
spec.add_dependency "libxml-ruby"
|
37
|
+
spec.add_dependency "libxml-to-hash"
|
38
|
+
end
|
data/spec/sms_spec.rb
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
require_relative '../lib/rahyab'
|
3
|
+
|
4
|
+
describe Rahyab::SMS do
|
5
|
+
before :all do
|
6
|
+
@url = "http://193.104.22.14:2055/CPSMSService/Access"
|
7
|
+
@user = ENV['RAHYAB_USER']
|
8
|
+
@password = ENV['RAHYAB_PASS']
|
9
|
+
@company = ENV['RAHYAB_COMPANY']
|
10
|
+
@sender = ENV['RAHYAB_SENDER']
|
11
|
+
@numbers = ['+989125601735']
|
12
|
+
@sms = Rahyab::SMS.new(@url, @user, @password, @company)
|
13
|
+
@text = "sms"
|
14
|
+
@batchID = ENV['RAHYAB_BATCH_ID']
|
15
|
+
end
|
16
|
+
|
17
|
+
it "Sends sms and returns id" do
|
18
|
+
#sms = @sms.send_sms(@sender, @numbers, @text)
|
19
|
+
expect(sms.class).to be(String)
|
20
|
+
end
|
21
|
+
|
22
|
+
it "Sends batch sms and returns ids" do
|
23
|
+
sms = @sms.send_batch(@sender, @numbers, @text)
|
24
|
+
end
|
25
|
+
|
26
|
+
it "Checks sms derivered" do
|
27
|
+
delivery = @sms.get_delivery(@batchID)
|
28
|
+
puts delivery
|
29
|
+
expect(delivery.class).to be(Hash)
|
30
|
+
end
|
31
|
+
|
32
|
+
it "Checks user credit" do
|
33
|
+
balance = @sms.get_balance
|
34
|
+
expect(balance.class).to be(Float)
|
35
|
+
end
|
36
|
+
|
37
|
+
it "Estimate cost of sms" do
|
38
|
+
cost = @sms.send(:estimate_cost, @numbers, @text)
|
39
|
+
expect(cost.class).to be(Fixnum)
|
40
|
+
end
|
41
|
+
|
42
|
+
end
|
metadata
ADDED
@@ -0,0 +1,157 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rahyab
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Behnam Ahmad Khan Beigi
|
8
|
+
- Sameer Rahmany
|
9
|
+
autorequire:
|
10
|
+
bindir: exe
|
11
|
+
cert_chain: []
|
12
|
+
date: 2015-08-19 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - "~>"
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '1.10'
|
21
|
+
type: :development
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - "~>"
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '1.10'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: rake
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - "~>"
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '10.0'
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - "~>"
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '10.0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: rspec
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ">="
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ">="
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: pry
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: builder
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
type: :runtime
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ">="
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
- !ruby/object:Gem::Dependency
|
85
|
+
name: libxml-ruby
|
86
|
+
requirement: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
type: :runtime
|
92
|
+
prerelease: false
|
93
|
+
version_requirements: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - ">="
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
98
|
+
- !ruby/object:Gem::Dependency
|
99
|
+
name: libxml-to-hash
|
100
|
+
requirement: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
type: :runtime
|
106
|
+
prerelease: false
|
107
|
+
version_requirements: !ruby/object:Gem::Requirement
|
108
|
+
requirements:
|
109
|
+
- - ">="
|
110
|
+
- !ruby/object:Gem::Version
|
111
|
+
version: '0'
|
112
|
+
description: Ruby gem to use Rahyab SMS service
|
113
|
+
email:
|
114
|
+
- yottanami@gnu.org
|
115
|
+
- lxsameer@gnu.org
|
116
|
+
executables: []
|
117
|
+
extensions: []
|
118
|
+
extra_rdoc_files: []
|
119
|
+
files:
|
120
|
+
- ".gitignore"
|
121
|
+
- Gemfile
|
122
|
+
- README.md
|
123
|
+
- Rakefile
|
124
|
+
- bin/console
|
125
|
+
- bin/setup
|
126
|
+
- lib/rahyab.rb
|
127
|
+
- lib/rahyab/string.rb
|
128
|
+
- lib/rahyab/version.rb
|
129
|
+
- rahyab.gemspec
|
130
|
+
- spec/sms_spec.rb
|
131
|
+
homepage: http://www.yellowen.ir
|
132
|
+
licenses:
|
133
|
+
- GPL-2
|
134
|
+
metadata:
|
135
|
+
allowed_push_host: https://rubygems.org
|
136
|
+
post_install_message:
|
137
|
+
rdoc_options: []
|
138
|
+
require_paths:
|
139
|
+
- lib
|
140
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
141
|
+
requirements:
|
142
|
+
- - ">="
|
143
|
+
- !ruby/object:Gem::Version
|
144
|
+
version: '0'
|
145
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
146
|
+
requirements:
|
147
|
+
- - ">="
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: '0'
|
150
|
+
requirements: []
|
151
|
+
rubyforge_project:
|
152
|
+
rubygems_version: 2.4.5
|
153
|
+
signing_key:
|
154
|
+
specification_version: 4
|
155
|
+
summary: Ruby interface of Rahyab SMS service
|
156
|
+
test_files:
|
157
|
+
- spec/sms_spec.rb
|