sms_manager 0.1.0

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+*~
+.bundle
+.rvmrc
+.yardoc
+coverage/*
+doc/*
+Gemfile.lock
+log/*
+pkg/*
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.1.0
+-----
+* Initial release

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Hrachovy
+
+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,73 @@
+# SmsManager
+
+A Ruby SDK for smsmanager.cz - SMS provider.
+
+## Installation
+    gem install sms_manager
+
+Add this line to your application's Gemfile:
+
+    gem 'sms_manager'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install sms_manager
+
+## Usage
+
+First you need to setup your credentials. This can be done only once:
+
+```ruby
+SmsManager.configure do |config|
+  config.username = YOUR_USERNAME
+  config.hashed_password = HASHED_PASSWORD
+end
+```
+
+Create the password hash with SHA-1 in console and then put the string into the configuration block:
+
+```ruby
+require 'digest/sha1'
+Digest::SHA1.hexdigest 'password'
+```
+
+That's all. Now you can send SMS messages.
+
+```ruby
+SmsManager.send_message number: '+420123456789', message: 'Hello!'
+```
+
+## Background call
+
+If you do not want to block your app you can use sucker_punch to deleagte the method call to a pool of workers. Note that any raised exception is not propagated to you, it's _fire and forget_.
+
+```ruby
+module SmsManager
+  class Client
+    include SuckerPunch::Job
+  end
+end
+
+SmsManager.configure do |config|
+  config.username = YOUR_USERNAME
+  config.hashed_password = HASHED_PASSWORD
+end
+
+SmsManager.async.send_message number: '+420123456789', message: 'Hello!'
+```
+
+## TODO
+
+* add other params to send_message method
+* recognize error codes (only a single exception is raised)
+
+## Copyright
+
+Copyright (c) 2013 David Hrachovy
+See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/lib/sms_manager/client.rb

@@ -0,0 +1,32 @@
+require "sms_manager/error/sending_error"
+
+module SmsManager
+
+  class Client
+    # options should be { number: String, message: String }
+    def send_message(options = {})
+      validate_send_message_options! options
+      options = {
+        username: SmsManager.instance_variable_get(:@username),
+        password: SmsManager.instance_variable_get(:@hashed_password),
+        number: options[:number],
+        message: options[:message]
+      }
+      body = HTTPClient.get('http://http-api.smsmanager.cz/Send', options).body
+      unless body =~ /^OK/
+        raise SendingError, "Sending text '#{options[:message]}' to phone '#{options[:number]}' failed"
+      end
+      nil
+    end
+
+    private
+
+    def validate_send_message_options!(options)
+      options.each do |option, value|
+        unless value.is_a?(String)
+          raise ArgumentError, "Invalid #{option} specified: #{value} must be a string."
+        end
+      end
+    end
+  end
+end

data/lib/sms_manager/configurable.rb

@@ -0,0 +1,30 @@
+require "sms_manager/error/configuration_error"
+
+module SmsManager
+  module Configurable
+    attr_writer :username, :hashed_password
+
+    def configure
+      yield self
+      validate_credential_type!
+      self
+    end
+
+    private
+
+    def credentials
+      {
+        :username    => @username,
+        :hashed_password => @hashed_password,
+      }
+    end
+
+    def validate_credential_type!
+      credentials.each do |credential, value|
+        unless value.is_a?(String)
+          raise ConfigurationError, "Invalid #{credential} specified: #{value} must be a string."
+        end
+      end
+    end
+  end
+end

data/lib/sms_manager/error/configuration_error.rb

@@ -0,0 +1,3 @@
+module SmsManager
+  class ConfigurationError < ::ArgumentError; end
+end

data/lib/sms_manager/error/sending_error.rb

@@ -0,0 +1,3 @@
+module SmsManager
+  class SendingError < ::Exception; end
+end

data/lib/sms_manager/version.rb

@@ -0,0 +1,13 @@
+module SmsManager
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+    end
+  end
+end

data/lib/sms_manager.rb

@@ -0,0 +1,24 @@
+require 'sms_manager/configurable'
+require "sms_manager/client"
+
+module SmsManager
+  class << self
+    include Configurable
+
+    # delegate calls to client
+    def client
+      return @client if instance_variable_defined?(:@client)
+      @client = SmsManager::Client.new
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless respond_to_missing?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private)
+    end
+
+  end
+end

data/sms_manager.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms_manager/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sms_manager"
+  gem.version       = SmsManager::Version
+  gem.date          = '2013-08-07'
+  gem.authors       = ["David Hrachovy"]
+  gem.email         = ["david.hrachovy@gmail.com"]
+  gem.description   = %q{Ruby SDK for smsmanager.cz API}
+  gem.summary       = %q{SmsManager is a Ruby library for sending SMS messages by smsmanager.cz provider}
+  gem.homepage      = "https://github.com/dayweek/sms_manager"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: sms_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Hrachovy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for smsmanager.cz API
+email:
+- david.hrachovy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/sms_manager.rb
+- lib/sms_manager/client.rb
+- lib/sms_manager/configurable.rb
+- lib/sms_manager/error/configuration_error.rb
+- lib/sms_manager/error/sending_error.rb
+- lib/sms_manager/version.rb
+- sms_manager.gemspec
+homepage: https://github.com/dayweek/sms_manager
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SmsManager is a Ruby library for sending SMS messages by smsmanager.cz provider
+test_files: []