sms_manager 0.1.2 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4c603afa0deded30e5cb06376e840fc8abbb893
+  data.tar.gz: ac12ef1fa59399065cc9ed33bf65f6a5ab284779
+SHA512:
+  metadata.gz: 5e2c4942edc14ad882abb5a7373de45e7e984c062683250de7c554ec79d19ce674bc4c6057dc88a1a7938cccd32b18116a76a981b983c8d829ea3c093c78cfa7
+  data.tar.gz: 693bce49dc61dd1cb1342be6b8f4620340f4e06ad2d833bd6708a28977737956b78c74c940bfe1d4fb6a3e4943bd6e0f4194199062e1cf1bf675325f053614af

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -1,9 +1,9 @@
 *.gem
 *.rbc
+.rvmrc
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -0,0 +1,26 @@
+cache: bundler
+
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-head
+  - rbx-2
+  - ruby-head
+
+sudo: false
+
+bundler_args: --without development --retry=3 --jobs=3
+
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+  fast_finish: true

data/CHANGELOG.md

@@ -1,3 +1,13 @@
 0.1.0
 -----
 * Initial release
+
+0.2.0
+-----
+* backward incompatible change: renamed `send_message` to `send`
+* code refactor
+
+
+0.2.1
+-----
+* Add `send_message` back to keep backward compatibility

data/Gemfile

@@ -1,4 +1,10 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in foodie.gemspec
+gem "rake"
+gem "rspec"
+gem "webmock"
+gem "coveralls"
+gem "simplecov"
+
+# Specify your gem's dependencies in gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    sms_manager (0.2.1)
+      httpclient (~> 2.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    coveralls (0.8.10)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.2.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    httpclient (2.7.1)
+    json (1.8.3)
+    mime-types (2.99)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  rake
+  rspec
+  simplecov
+  sms_manager!
+  webmock
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,25 +1,24 @@
 # SmsManager
 
-A Ruby SDK for [smsmanager.cz](http://smsmanager.cz/) - SMS provider.
+[![Gem Version](https://badge.fury.io/rb/sms_manager.png)](http://badge.fury.io/rb/sms_manager)
+[![Build Status](https://travis-ci.org/dayweek/sms_manager.png?branch=master)](https://travis-ci.org/dayweek/sms_manager)
+[![Dependency Status](https://gemnasium.com/dayweek/sms_manager.png)](https://gemnasium.com/dayweek/sms_manager)
+[![Code Climate](https://codeclimate.com/github/dayweek/sms_manager.png)](https://codeclimate.com/github/dayweek/sms_manager)
+[![Coverage Status](https://coveralls.io/repos/dayweek/sms_manager/badge.svg?branch=master&service=github)](https://coveralls.io/github/dayweek/sms_manager?branch=master)
 
-## Installation
-    gem install sms_manager
-
-Add this line to your application's Gemfile:
+A Ruby SDK for [smsmanager.cz](http://smsmanager.cz/) - Czech SMS provider.
 
-    gem 'sms_manager'
-
-And then execute:
+## Installation
 
-    bundle
+`gem install sms_manager`
 
-Or install it yourself as:
+Or add to Gemfile:
 
-    gem install sms_manager
+`gem 'sms_manager'`
 
 ## Usage
 
-First you need to setup your credentials. This can be done only once:
+First you need to setup your credentials:
 
 ```ruby
 SmsManager.configure do |config|
@@ -38,32 +37,25 @@ Digest::SHA1.hexdigest 'password'
 That's all. Now you can send SMS messages.
 
 ```ruby
-SmsManager.send_message number: '+420123456789', message: 'Hello!'
+SmsManager.send 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_.
+You can pass all the parameters available at [SmsManager API](http://smsmanager.cz/api/http/). These additional parameters will be appended to the request:
 
 ```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!'
+SmsManager.send number: '+420123456789', message: 'Hello!', gateway: 'lowcost', time: '2013-01-01T23:59:59'
 ```
 
-## TODO
+If the service fails an exception is raised. The exception contains error code as well as error message.
 
-* add other params to send_message method
-* recognize error codes (only a single exception is raised)
+```ruby
+begin
+  SmsManager.send number: '+420123456789', message: 'Hello!'
+rescue SmsManager::SendingError => e
+  puts e.code # => 104
+  puts e.message # => Neplatný parametr gateway
+end
+```
 
 ## Copyright
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+desc "Runs rspec tests"
+task default: :spec

data/lib/sms_manager.rb

@@ -1,24 +1,28 @@
-require 'sms_manager/configurable'
-require "sms_manager/client"
+require 'sms_manager/error/sending_error'
+require 'httpclient'
 
 module SmsManager
   class << self
-    include Configurable
+    attr_writer :username, :hashed_password
 
-    # delegate calls to client
-    def client
-      return @client if instance_variable_defined?(:@client)
-      @client = SmsManager::Client.new
+    def configure
+      yield self
     end
 
-    def method_missing(method_name, *args, &block)
-      return super unless respond_to_missing?(method_name)
-      client.send(method_name, *args, &block)
+    # options should be { number: String, message: String }
+    def send(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
+      raise SendingError.new(options, body) unless body =~ /^OK/
     end
 
-    def respond_to_missing?(method_name, include_private=false)
-      client.respond_to?(method_name, include_private)
+    def send_message(options = {})
+      send options
     end
-
   end
 end

data/lib/sms_manager/error/sending_error.rb

@@ -1,3 +1,34 @@
 module SmsManager
-  class SendingError < ::Exception; end
+  class SendingError < StandardError
+    attr_reader :options, :code
+
+    def initialize(options, body)
+      @code = body.split('|').last.to_i
+      @options = options
+    end
+
+    def message
+      if code >= 900 && code <= 999
+        CODE_9XX
+      elsif CODES[code]
+        CODES[code]
+      else
+        'Neznámý chybový kód'
+      end
+    end
+
+    private
+
+    CODES = {
+      101 => 'Neexistující data požadavku (chybí XMLDATA parametr u XML API)',
+      102 => 'Metoda neexistuje',
+      103 => 'Neplatné uživatelské jméno nebo heslo',
+      104 => 'Neplatný parametr gateway',
+      105 => 'Nedostatek kreditu pro prepaid',
+      201 => 'Žádná platná telefonní čísla v požadavku',
+      202 => 'Text zprávy neexistuje nebo je příliš dlouhý',
+      203 => 'Neplatný parametr sender (odesílatele nejprve nastavte ve webovém rozhraní)'
+    }
+    CODE_9XX = 'Systémová chyba (informujte se na support@smsmanager.cz)'
+  end
 end

data/lib/sms_manager/version.rb

@@ -1,8 +1,8 @@
 module SmsManager
   class Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 2
+    MINOR = 2
+    PATCH = 1
 
     class << self
       def to_s

data/sms_manager.gemspec

@@ -6,15 +6,14 @@ require 'sms_manager/version'
 Gem::Specification.new do |gem|
   gem.name          = "sms_manager"
   gem.version       = SmsManager::Version
-  gem.date          = '2013-08-07'
+  gem.date          = '2016-01-16'
   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.add_dependency  "httpclient", "~> 2.3.4.0"
-  gem.add_development_dependency "bundler", "~> 1.3"
-  gem.add_development_dependency "rake"
+  gem.add_dependency  "httpclient", "~> 2.7.0"
+  gem.add_development_dependency "bundler"
   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)/})

data/spec/sms_manager_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper.rb'
+
+describe SmsManager do
+  it 'sets configuration vars' do
+    SmsManager.configure do |config|
+      config.username = 'U'
+      config.hashed_password = 'H'
+    end
+
+    expect(SmsManager.instance_variable_get(:@username)).to eq('U')
+    expect(SmsManager.instance_variable_get(:@hashed_password)).to eq('H')
+  end
+
+  describe 'send' do
+    before do
+      SmsManager.configure do |config|
+        config.username = 'david@example.com'
+        config.hashed_password = 'b4b976b7217ac3e336d9249ee15a3fc21fc69ce1'
+      end
+    end
+
+    it 'uses configuration vars and send params in request' do
+      stub_send.to_return body: 'OK'
+      SmsManager.send number: '+420123456789', message: 'Hello!'
+
+      expect(stub_send).to have_been_requested
+    end
+
+    it 'raises error with details if response body is not ok' do
+      stub_send.to_return body: 'ERROR|103'
+
+      expect { SmsManager.send number: '+420123456789', message: 'Hello!' }.to \
+        raise_error(SmsManager::SendingError) do |e|
+          expect(e.code).to eq(103)
+          expect(e.message).to eq('Neplatné uživatelské jméno nebo heslo')
+        end
+    end
+  end
+
+  describe 'send' do
+    before do
+      SmsManager.configure do |config|
+        config.username = 'david@example.com'
+        config.hashed_password = 'b4b976b7217ac3e336d9249ee15a3fc21fc69ce1'
+      end
+    end
+
+    it 'uses configuration vars and send params in request' do
+      stub_send.to_return body: 'OK'
+      SmsManager.send_message number: '+420123456789', message: 'Hello!'
+
+      expect(stub_send).to have_been_requested
+    end
+
+    it 'raises error with details if response body is not ok' do
+      stub_send.to_return body: 'ERROR|103'
+
+      expect { SmsManager.send_message number: '+420123456789', message: 'Hello!' }.to \
+        raise_error(SmsManager::SendingError) do |e|
+          expect(e.code).to eq(103)
+          expect(e.message).to eq('Neplatné uživatelské jméno nebo heslo')
+        end
+    end
+  end
+
+  def stub_send
+    stub_request(:get, 'http://http-api.smsmanager.cz/Send?message=Hello!&number=%2B420123456789&password=b4b976b7217ac3e336d9249ee15a3fc21fc69ce1&username=david@example.com')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'webmock/rspec'
+require 'simplecov'
+require 'coveralls'
+require 'sms_manager'
+
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.start
+
+WebMock.disable_net_connect!

metadata

@@ -1,62 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: sms_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - David Hrachovy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4.0
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4.0
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby SDK for smsmanager.cz API
@@ -66,42 +45,45 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
 - 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
+- spec/sms_manager_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/dayweek/sms_manager
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SmsManager is a Ruby library for sending SMS messages by smsmanager.cz provider
-test_files: []
+test_files:
+- spec/sms_manager_spec.rb
+- spec/spec_helper.rb

data/lib/sms_manager/client.rb

@@ -1,33 +0,0 @@
-require "sms_manager/error/sending_error"
-require "httpclient"
-
-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

@@ -1,30 +0,0 @@
-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

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