rahyab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fc79c97f17192cbc62659a8e62ef32063437af4
+  data.tar.gz: 69649e0f1691fcc92f52f96bf716fdae9fa74210
+SHA512:
+  metadata.gz: 8064c6c3f5db36681688313103809a894f11e3d7c4041932a62d72710637b62efd797f1c5daaf22835e881b9feb777852e63e45dd97f8f3866b3813a3ecdfd05
+  data.tar.gz: a98c0b8a3e9d3ab341237aba67cec14109dd73f8724bf536c0cb2c865db6438b28f5e9d1098383c1dc3c8e19fab8f99582e7fd9fde0802f84e822923fdfa7513

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# Rahyab
+
+Rahyab gem is Ruby implimentation of Rahyab SMS Service Gateway.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rahyab'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rahyab
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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 at https://github.com/Yellowen/rahyab.

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,141 @@
+# coding: utf-8
+require "rahyab/version"
+require "builder"
+require 'net/http'
+require 'xml'
+require 'libxml_to_hash'
+require 'pry'
+
+module Rahyab
+  require 'rahyab/string'
+
+  class SMS
+    # Return Errors
+    attr_reader :errors
+
+    # Constructor of Rahyab SMS Gateway
+    def initialize(url, user, password, company)
+      @url = url
+      @user = user
+      @password = password
+      @company = company
+    end
+
+    # Will send one or more sms to specified numbers
+    def send_sms(sender, numbers, text, **params)
+      # Create the send XMLmarkup
+      if estimate_cost(numbers, text) < get_balance
+        identity         = "#{Time.now.to_i}#{rand(1000000000..9999999999)}"
+        batchID          = @company + "+" + identity
+        is_persian_text  = is_persian(text)
+        msgClass         = params["flash"] ? "0" : "1"
+        dcs              = is_persian_text ? "8" : "0"
+        binary           = is_persian_text ? "true" : "false"
+        text             = text.to_h if is_persian_text
+
+        builder          = Builder::XmlMarkup.new()
+        builder.instruct! :xml, version: "1.0", encoding: "UTF-8"
+        builder.declare! :DOCTYPE, :smsBatch, :PUBLIC, "-//PERVASIVE//DTD CPAS 1.0//EN", "http://www.ubicomp.ir/dtd/Cpas.dtd"
+        builder.smsBatch(company: @company, batchID: batchID) do |b|
+          b.sms(msgClass: msgClass, binary: binary, dcs: dcs) do |t|
+            numbers.each do |number|
+              t.destAddr() do |f|
+                f.declare! "[CDATA[%s]]" % number
+              end
+            end
+            t.origAddr() do |f|
+              f.declare! "[CDATA[%s]]" % sender
+            end
+            t.message() do |f|
+              f.declare! "[CDATA[#{text}]]"
+            end
+          end
+        end
+        out_xml = builder.target!
+
+        result = send_xml(out_xml)
+        source = XML::Parser.string(result)
+        content = source.parse
+
+        if content.find_first('ok')
+          if  content.find_first('ok').content.include? 'CHECK_OK'
+            batchID
+          else
+            @errors = "Something going wrong"
+            nil
+          end
+        else
+          @errors = content.find_first('message').content.strip
+          nil
+        end
+      else
+        @errors = 'Not enough balance'
+        nil
+      end
+    end
+
+
+    def send_batch(sender, numbers, text)
+    end
+
+    # Check delivery status of several sms
+    def get_delivery(batchID)
+      builder = Builder::XmlMarkup.new(indent: 2)
+      builder.instruct! :xml, version: "1.0"
+      builder.declare! :DOCTYPE, :smsStatusPoll, :PUBLIC, "-//PERVASIVE//DTD CPAS 1.0//EN", "http://www.ubicomp.ir/dtd/Cpas.dtd"
+      builder.smsStatusPoll(company: @company) do |b|
+        b.batch(batchID: batchID)
+      end
+      out_xml = builder.target!
+      result = send_xml(out_xml)
+      Hash.from_libxml(result)
+    end
+
+    # Check the credit that how many sms can be send
+    def get_balance
+      builder = Builder::XmlMarkup.new(indent: 2)
+      builder.instruct! :xml, version: "1.0"
+      builder.getUserBalance(company: @company)
+      result = send_xml(builder.target!)
+      source = XML::Parser.string(result)
+      content = source.parse
+      return content.find_first('/userBalance').content.strip.to_f
+    end
+
+    private
+
+    # Check does the input contents Farsi Character
+    def is_persian(str)
+      str =~ /\p{Arabic}/
+    end
+
+    # Send XMLmarkup to Web Service
+    def send_xml(out_xml)
+      uri = URI.parse(@url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.basic_auth @user, @password
+      request.body = out_xml
+      response = http.request(request)
+      return response.body
+    end
+
+    # Cost estimates
+    def estimate_cost(numbers, text)
+      cost = 0
+      if is_persian(text)
+        sms_length = (text.length / 67.0).ceil
+      else
+        sms_length = (text.length / 157.0).ceil
+      end
+      numbers.each do |number|
+        if is_persian(text)
+          cost = cost + sms_length * 1.5
+        else
+          cost = cost + sms_length
+        end
+      end
+      cost
+    end
+  end
+end

data/lib/rahyab/string.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+class String
+  # Return String in HEX
+  def to_h
+    codepoints = self.codepoints
+    codepoints = codepoints.map {  |n| format('%04x', n) }
+    return codepoints.join
+  end
+end

data/lib/rahyab/version.rb

@@ -0,0 +1,3 @@
+module Rahyab
+  VERSION = "0.1.0"
+end

data/rahyab.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rahyab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rahyab"
+  spec.version       = Rahyab::VERSION
+  spec.authors       = ["Behnam Ahmad Khan Beigi", "Sameer Rahmany"]
+  spec.email         = ["yottanami@gnu.org", "lxsameer@gnu.org"]
+
+  spec.summary       = "Ruby interface of Rahyab SMS service"
+  spec.description   = "Ruby gem to use Rahyab SMS service"
+  spec.homepage      = "http://www.yellowen.ir"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+  spec.licenses = ['GPL-2']
+  spec.test_files = Dir['spec/*']
+
+  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.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "builder"
+  spec.add_dependency "libxml-ruby"
+  spec.add_dependency "libxml-to-hash"
+end

data/spec/sms_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+require_relative '../lib/rahyab'
+
+describe Rahyab::SMS do
+  before :all do
+    @url = "http://193.104.22.14:2055/CPSMSService/Access"
+    @user = ENV['RAHYAB_USER']
+    @password = ENV['RAHYAB_PASS']
+    @company = ENV['RAHYAB_COMPANY']
+    @sender = ENV['RAHYAB_SENDER']
+    @numbers = ['+989125601735']
+    @sms = Rahyab::SMS.new(@url, @user, @password, @company)
+    @text = "sms"
+    @batchID = ENV['RAHYAB_BATCH_ID']
+  end
+
+  it "Sends sms and returns id" do
+    #sms = @sms.send_sms(@sender, @numbers, @text)
+    expect(sms.class).to be(String)
+  end
+
+  it "Sends batch sms and returns ids" do
+    sms = @sms.send_batch(@sender, @numbers, @text)
+  end
+
+  it "Checks sms derivered" do
+    delivery = @sms.get_delivery(@batchID)
+    puts delivery
+    expect(delivery.class).to be(Hash)
+  end
+
+  it "Checks user credit" do
+    balance = @sms.get_balance
+    expect(balance.class).to be(Float)
+  end
+
+  it "Estimate cost of sms" do
+    cost = @sms.send(:estimate_cost, @numbers, @text)
+    expect(cost.class).to be(Fixnum)
+  end
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: rahyab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Behnam Ahmad Khan Beigi
+- Sameer Rahmany
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxml-to-hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem to use Rahyab SMS service
+email:
+- yottanami@gnu.org
+- lxsameer@gnu.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rahyab.rb
+- lib/rahyab/string.rb
+- lib/rahyab/version.rb
+- rahyab.gemspec
+- spec/sms_spec.rb
+homepage: http://www.yellowen.ir
+licenses:
+- GPL-2
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby interface of Rahyab SMS service
+test_files:
+- spec/sms_spec.rb