smscru 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fac96bea6cf766f3752d88786250e69ed4a88cbc
+  data.tar.gz: 9210a76cece445a1859f1c4be7d3d4471028793d
+SHA512:
+  metadata.gz: 2b697a4695957fa18ad272a1ee82ab4ce9dc8a2d11920fd000658f1225edf95482608897697e4457bb646e78435a9c7623a22c4d9f6a00daf41ae2f014a8b431
+  data.tar.gz: 72d7b1bb3e325630a676666d3da466a7840385890cbff0ae4afdf27ec3c4a82c2b30cacf5058bba7ea825b7d70015df51731f3e790a6964dbc77a5233afd48a7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Nartimov
+
+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,101 @@
+# Smscru
+
+A Ruby interface to the [smsc.ru](http://smsc.ru/) SMS gateway service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smscru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smscru
+
+## Usage
+
+Global configuration:
+
+```ruby
+Smscru.configure do |config|
+  config.login    = 'smscuser'    # Your login
+  config.password = 'passwordmd5' # MD5 of your password
+  config.secret   = 'smscsecret'  # Secret for receiving messages
+end
+```
+
+Or:
+
+```ruby
+Smscru.configure(login: 'smscuser', password: 'passwordmd5', secret: 'smscsecret')
+```
+
+### Sending messages
+
+```ruby
+client = Smscru::Client.new
+client.send_message('Hello world!', '+1234567890')
+client.send_message('Hello world!', '+1234567890', id: 456)
+client.send_message('Hello world!', '+1234567890', sender: 'TestSender')
+client.send_message('Hello world!', ['+1234567890', '+1234567891'])
+```
+
+It's also possible to specify client configuration options:
+
+```ruby
+Smscru::Client.new(login: 'smscuser', password: 'passwordmd5')
+```
+
+### Receiving messages and status updates
+
+URL in settings:
+
+```
+http://example.com/smscru?charset=utf-8&sha1=smscsecret
+```
+
+Use your custom secret instead of `smscsecret`.
+
+Routes:
+
+```ruby
+post 'smscru' => 'smscru#callback'
+```
+
+Controller:
+
+```ruby
+require 'smscru'
+
+class SmscruController < ActionController::Base
+  def callback
+    callback = Smscru::Callback.new
+
+    callback.on_message do |params|
+      p params # incoming message
+    end
+
+    callback.on_status do |params|
+      p params # outgoing message status update
+    end
+
+    callback.run(params)
+
+    render nothing: true
+  end
+end
+```
+
+You can use [proxylocal](http://proxylocal.com/) or [ngrok](https://ngrok.com/) to test your callback handler on local machine.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/smscru.rb

@@ -0,0 +1,18 @@
+require 'smscru/version'
+require 'smscru/configuration'
+require 'smscru/client'
+require 'smscru/callback'
+
+module Smscru
+  class << self
+    attr_reader :config
+
+    def configure(options={}, &block)
+      @config = Configuration.new
+      @config.update(options)
+      yield @config if block_given?
+    end
+  end
+
+  configure
+end

data/lib/smscru/callback.rb

@@ -0,0 +1,42 @@
+require 'digest/sha1'
+
+module Smscru
+  class Callback
+    attr_reader :config
+
+    def initialize(options)
+      @config = Smscru.config.dup
+      @config.update(options)
+    end
+
+    def run(params)
+      return if params['sha1'] != signature(params)
+
+      if params['mes']
+        @on_message.call(params)
+      else
+        @on_status.call(params)
+      end
+    end
+
+    def on_message(&block)
+      @on_message = block
+    end
+
+    def on_status(&block)
+      @on_status = block
+    end
+
+    def signature(params)
+      keys = if params['mes']
+        %w(phone mes to)
+      else
+        %w(id phone status)
+      end
+
+      values = params.values_at(*keys) << config.secret
+
+      Digest::SHA1.hexdigest(values.join(':'))
+    end
+  end
+end

data/lib/smscru/client.rb

@@ -0,0 +1,26 @@
+module Smscru
+  class Client
+    attr_reader :config
+
+    def initialize(options)
+      @config = Smscru.config.dup
+      @config.update(options)
+    end
+
+    def send_message(text, phones, options={})
+      params = {
+        mes:     text,
+        phones:  Array(phones),
+        login:   config.login,
+        psw:     config.password,
+        charset: 'utf-8',
+        fmt:     3
+      }
+
+      uri = URI.parse('http://smsc.ru/sys/send.php')
+      response = Net::HTTP.post_form(uri, params.merge(options))
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/smscru/configuration.rb

@@ -0,0 +1,14 @@
+module Smscru
+  class Configuration
+    attr_accessor :login, :password, :secret
+
+    def update(options={})
+      options.each_pair do |name, value|
+        setter = "#{name}="
+        if respond_to?(setter)
+          public_send(setter, value)
+        end
+      end
+    end
+  end
+end

data/lib/smscru/version.rb

@@ -0,0 +1,3 @@
+module Smscru
+  VERSION = "0.0.1"
+end

data/smscru.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smscru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smscru'
+  spec.version       = Smscru::VERSION
+  spec.authors       = ['Sergey Nartimov']
+  spec.email         = ['just.lest@gmail.com']
+  spec.description   = %q{Ruby interface to the smsc.ru SMS gateway service.}
+  spec.summary       = %q{Ruby interface to the smsc.ru SMS gateway service.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0.8'
+end

data/test/callback_test.rb

@@ -0,0 +1,35 @@
+require_relative 'test_helper'
+
+class CallbackTest < Minitest::Test
+  attr_reader :callback, :message_params
+
+  def setup
+    @callback = Smscru::Callback.new(secret: 'zxc')
+    @message_params = {
+      'phone' => '123',
+      'mes'   => 'text',
+      'to'    => '234',
+      'sha1'  => 'b6f768ce7614d7858cc4a6116f8ffd0dc236a3cd'
+    }
+  end
+
+  def test_valid_signature
+    verified = false
+    callback.on_message { verified = true }
+
+    callback.run(message_params)
+
+    assert verified
+  end
+
+  def test_invalid_signature
+    message_params['sha1'] = 'xxx'
+
+    verified = false
+    callback.on_message { verified = true }
+
+    callback.run(message_params)
+
+    refute verified
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,11 @@
+require_relative 'test_helper'
+
+class ClientTest < Minitest::Test
+  def test_dont_override_global_configuration
+    Smscru.configure(login: 'qwe')
+    client = Smscru::Client.new(login: 'asd')
+
+    assert_equal 'qwe', Smscru.config.login
+    assert_equal 'asd', client.config.login
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+
+$VERBOSE = true
+
+require 'smscru'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: smscru
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Nartimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+description: Ruby interface to the smsc.ru SMS gateway service.
+email:
+- just.lest@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smscru.rb
+- lib/smscru/callback.rb
+- lib/smscru/client.rb
+- lib/smscru/configuration.rb
+- lib/smscru/version.rb
+- smscru.gemspec
+- test/callback_test.rb
+- test/client_test.rb
+- test/test_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby interface to the smsc.ru SMS gateway service.
+test_files:
+- test/callback_test.rb
+- test/client_test.rb
+- test/test_helper.rb