sms-club 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee180edc7573462755ea7b9a35023d45d640fc0f
+  data.tar.gz: cf79de88712737db09c92446fe4161786e0b346e
+SHA512:
+  metadata.gz: 92ebbc8cfc37d0321a0a34d3a988e8361d7864445b8432f87fae6c32d39959e0a8419369c25cd346362f524146360f922a9e8d443c6e0e181122170e70663bfe
+  data.tar.gz: 537ada97df65a11131ad1ffeb8c0aec5324c326e12b9c44cc570d2f17a7b9d876bef64d54d8dfd1df4fd3f1ced1b702712c704d35e615f0ad0108e64059d9ef1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    sms-club (0.2.1)
+      faraday (~> 0.9)
+      iconv (~> 1.0)
+      nokogiri (~> 1.6)
+      translit (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    iconv (1.0.4)
+    mini_portile (0.6.0)
+    mono_logger (1.1.0)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    redis (3.1.0)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    resque (1.25.2)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.3)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+    translit (0.1.5)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  resque
+  rspec (~> 3.0)
+  sms-club!
+  webmock (~> 1.18)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pavel Dotsulenko
+
+MIT License
+
+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,66 @@
+# SmsClub API Client
+
+Client for http://smsclub.mobi/ SMS gate. Allows you to send and retrieve status of sent SMS via XML API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sms-club'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms-club
+
+## Usage
+
+Create new client first. Constructor accepts your login, password for smsclub.mobi and optional default `from` argument
+
+```
+SmsClub::Client.new '380993123123', 'password', from: 'CoolCompany'
+#=> #<SmsClub::Client:0x000000051f9320 @user_name="380993123123", @password="password", @from="CoolCompany", @transliterate=false>
+```
+You can also turn on transliteration option by default
+
+```
+client = SmsClub::Client.new '380993123123', 'password', transliterate: true
+#=> #<SmsClub::Client:0x000000051b14d0 @user_name="380993123123", @password="password", @from=nil, @transliterate=true>
+```
+
+Sending SMS to multiple numbers at once
+
+```
+client.send 'test', to: ['+380664018206', '+380666018203', '+380666018202']
+#=> ["ID_1", "ID_2", "ID_N"]
+
+```
+
+Send sms to one number
+```
+client.send_one 'test', to: '+380666128206'
+#=> "ID_1"
+```
+
+Get status of SMS
+
+```
+client.status_for 'ID_1'
+#=> :delivrd
+
+client.statuses_for ['ID_1', 'ID_2']
+#=> { 'ID_1' => :delivrd }, { 'ID_2' => :delivrd }
+```
+
+For more info please see original api docs http://smsclub.mobi/en/pages/show/api#xml
+
+## Contributing
+
+1. Fork it ( https://github.com/pavel-d/sms-club/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/lib/sms-club.rb

@@ -0,0 +1,5 @@
+%w(
+  version
+  client
+  errors
+).each { |file| require File.join(File.dirname(__FILE__), 'sms-club', file) }

data/lib/sms-club/async.rb

@@ -0,0 +1,31 @@
+require 'sms-club'
+begin
+  require 'resque'
+rescue LoadError => e
+  raise "You need to install resque to use async sms client"
+end unless defined?(Resque)
+
+module SmsClub
+  class AsyncClient < Client
+    attr_accessor :queue
+
+    def initialize(*args)
+      @init_args = args
+      @queue = 'sms_club'
+      super
+    end
+
+    def send_async(message, options = {})
+      begin
+        Resque.enqueue(self, @init_args, message, options)
+      rescue Redis::CannotConnectError => e
+        warn e
+        warn 'Can not connect to redis server. Falling back to synchronous mode.'
+      end
+    end
+
+    def self.perform(init_args, message, options)
+      client = self.new(init_args).send_many(message, options)
+    end
+  end
+end

data/lib/sms-club/client.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'nokogiri'
+require 'translit'
+
+module SmsClub
+  # API documentation http://smsclub.mobi/en/pages/show/api#xml
+  class Client
+    attr_accessor :user_name, :password, :from, :transliterate
+
+    def initialize(user_name, password, from: nil, transliterate: false)
+      @user_name = user_name
+      @password = password
+      @from = from
+      @transliterate = transliterate
+    end
+
+    def send_one(message, options = {})
+      send_many(message, options).first
+    end
+
+    def send_many(message, options = {})
+      fail ArgumentError, 'Recepient is not defined' unless options[:to]
+
+      to = options[:to]
+      to = to.map(&:to_s).join(';') if to.is_a? Array
+
+      message = translit_message message if transliterate || options[:transliterate]
+      msg_from = options[:from] || from
+
+      payload = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.request_sendsms do
+          xml.username { xml.cdata @user_name }
+          xml.password { xml.cdata @password }
+          xml.from { xml.cdata msg_from }
+          xml.to { xml.cdata to }
+          xml.text_ { xml.cdata message }
+        end
+      end
+
+      response = connection.post '/hfw_smpp_addon/xmlsendsmspost.php', xmlrequest: payload.to_xml
+      doc = Nokogiri::XML(response.body)
+
+      raise SmsClubError, response_error(doc) if response_failed?(doc)
+
+      doc.xpath('//mess').map(&:content)
+    end
+
+    def status_for(smscid)
+      statuses_for(smscid).first[smscid]
+    end
+
+    def statuses_for(smscid)
+      smscid = smscid.map(&:to_s).join(';') if smscid.is_a? Array
+
+      payload = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.request_getstate do
+          xml.username { xml.cdata @user_name }
+          xml.password { xml.cdata @password }
+          xml.smscid { xml.cdata smscid }
+        end
+      end
+
+      response = connection.post '/hfw_smpp_addon/xmlgetsmsstatepost.php', xmlrequest: payload.to_xml
+
+      doc = Nokogiri::XML(response.body)
+
+      raise SmsClubError, response_error(doc) if response_failed?(doc)
+
+      doc.xpath('//entry').map do |entry|
+        { entry.xpath('smscid').text => entry.xpath('state').text.downcase.to_sym }
+      end
+    end
+
+    protected
+
+    def connection
+      @connection ||= Faraday.new(url: 'https://gate.smsclub.mobi/') do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def translit_message(message)
+      Translit.convert message
+    end
+
+    def response_failed?(xml_doc)
+      xml_doc.xpath('//status').text != 'OK'
+    end
+
+    def response_error(xml_doc)
+      xml_doc.xpath('//text').text
+    end
+  end
+end

data/lib/sms-club/errors.rb

@@ -0,0 +1,3 @@
+module SmsClub
+  class SmsClubError < RuntimeError; end
+end

data/lib/sms-club/version.rb

@@ -0,0 +1,5 @@
+module Sms
+  module Club
+    VERSION = "0.3.1"
+  end
+end

data/sms-club.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms-club/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sms-club'
+  spec.version       = Sms::Club::VERSION
+  spec.authors       = ['Pavel Dotsulenko']
+  spec.email         = ['paul@live.ru']
+  spec.summary       = 'Client for http://smsclub.mobi/ SMS gate'
+  spec.description   = 'Client for http://smsclub.mobi/ SMS gate. Allows you to send and retrieve status of sent SMS via XML API. Supports Resque for asynchronous sending.'
+  spec.homepage      = 'https://github.com/pavel-d/sms-club'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/\{^bin\/}/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/\{^(test|spec|features)\/}/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'resque'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'translit', '~> 0.1'
+  spec.add_runtime_dependency 'iconv', '~> 1.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+end

data/spec/async_client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'webmock/rspec'
+require 'uri'
+require 'sms-club/async'
+require 'resque'
+
+describe SmsClub::AsyncClient do
+  let(:client) { SmsClub::AsyncClient.new '380993123123', 'password', from: 'KupiChehol' }
+
+  describe '#send' do
+    before do
+      stub_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+         .to_return(status: 200, body: File.open('./spec/fixtures/xmlsendsmspost.xml'), headers: {})
+    end
+
+    it 'should send sms asynchronously' do
+      client.send_async 'test', to: '+380666128206'
+    end
+    it 'should fallback to synchronous mode' do
+      Resque.redis = Redis.new(host: 'localhost', port: 9999)
+      client.send_async 'test', to: '+380666128206'
+      Resque.redis = Redis.new(host: 'localhost', port: 6379)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'webmock/rspec'
+require 'uri'
+require 'sms-club/async'
+
+describe SmsClub::Client do
+  let(:client) { SmsClub::Client.new '380993123123', 'password', from: 'KupiChehol' }
+
+  describe '#send' do
+    before do
+      stub_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+         .to_return(status: 200, body: File.open('./spec/fixtures/xmlsendsmspost.xml'), headers: {})
+    end
+
+    it 'should send message one recipient' do
+      result = client.send_one 'test', to: '+380666128206'
+
+      expect(result).to be_a String
+      expect(result).to eq 'ID_1'
+    end
+
+    it 'should send messages to multiple recipients' do
+      result = client.send_many'test', to: ['+380664018206', '+380666018203', '+380666018202']
+
+      expect(result).to be_an Array
+      expect(result.length).to eq 3
+    end
+
+    describe 'an POST HTTP request' do
+      it 'should include phone number' do
+        client.send_one 'test', to: '+380666128206'
+
+        expect(a_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+          .with { |req| URI.decode(req.body) =~ /\+380666128206/ })
+          .to have_been_made
+      end
+
+      it 'should include multiple phone numbers' do
+        client.send_many'test', to: ['+380664018206', '+380666018203', '+380666018202']
+
+        expect(a_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+            .with { |req| URI.decode(req.body) =~ /\+380664018206;\+380666018203;\+380666018202/ })
+            .to have_been_made
+      end
+    end
+
+    it 'should throw error if send failed' do
+      stub_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+         .to_return(status: 200, body: File.open('./spec/fixtures/xmlsendsmspost.failed.xml'), headers: {})
+      expect { client.send_many'test', to: ['+380664018206', '+380666018203', '+380666018202'] }.to raise_error
+    end
+
+    it 'should transliterate message when tranliterate: true' do
+      client.send_one 'привет', to: '+380666128206', transliterate: true
+      expect(a_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlsendsmspost.php')
+            .with { |req| req.body =~ /privet/ }).to have_been_made
+    end
+  end
+
+  describe '#status_for' do
+    before do
+      stub_request(:post, 'https://gate.smsclub.mobi/hfw_smpp_addon/xmlgetsmsstatepost.php')
+         .to_return(status: 200, body: File.open('./spec/fixtures/xmlgetsmsstatepost.xml'), headers: {})
+    end
+    it 'should return status symbol' do
+      result = client.status_for 'ID_1'
+      expect(result).to eq :delivrd
+    end
+
+    it 'should return hash of message statuses' do
+      result = client.statuses_for ['ID_1', 'ID_2']
+      expect(result).to eq [{ 'ID_1' => :delivrd }, { 'ID_2' => :delivrd }]
+    end
+  end
+end

data/spec/fixtures/xmlgetsmsstatepost.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response>
+  <status>OK</status>
+  <text></text>
+  <entries>
+    <entry>
+      <smscid>ID_1</smscid>
+      <state>delivrd</state>
+    </entry>
+    <entry>
+      <smscid>ID_2</smscid>
+      <state>delivrd</state>
+    </entry>
+  </entries>
+</response>

data/spec/fixtures/xmlsendsmspost.failed.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response>
+  <status>ERROR</status>
+  <text>An error description</text>
+  <ids>
+    <mess>ID_1</mess>
+    <mess>ID_2</mess>
+    <mess>ID_N</mess>
+  </ids>
+</response>

data/spec/fixtures/xmlsendsmspost.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response>
+  <status>OK</status>
+  <text>RESULT_TEXT</text>
+  <ids>
+    <mess>ID_1</mess>
+    <mess>ID_2</mess>
+    <mess>ID_N</mess>
+  </ids>
+</response>

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'sms-club'
+
+require 'rspec'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: sms-club
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Pavel Dotsulenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: translit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: iconv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Client for http://smsclub.mobi/ SMS gate. Allows you to send and retrieve
+  status of sent SMS via XML API. Supports Resque for asynchronous sending.
+email:
+- paul@live.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sms-club.rb
+- lib/sms-club/async.rb
+- lib/sms-club/client.rb
+- lib/sms-club/errors.rb
+- lib/sms-club/version.rb
+- sms-club.gemspec
+- spec/async_client_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/xmlgetsmsstatepost.xml
+- spec/fixtures/xmlsendsmspost.failed.xml
+- spec/fixtures/xmlsendsmspost.xml
+- spec/spec_helper.rb
+homepage: https://github.com/pavel-d/sms-club
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Client for http://smsclub.mobi/ SMS gate
+test_files: []