magti 0.1.0.beta1

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/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>magti</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dimitri Kurashvili
+
+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,27 @@
+# Magti 
+
+Magti is a gem for sending SMS messages through [Magticom](http://www.magticom.ge/) gateway.
+
+You need access to Magticom's gateway server, also they provide you with user/password parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'magti'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install magti
+
+## Usage
+
+TODO: Comming soon
+
+## Additional resources
+
+Protocol description which is used by this gem, can be found in `refs` subdirectory.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/magti.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+require 'magti/version'
+require 'magti/config'
+require 'magti/sms'
+
+module Magti
+end

data/lib/magti/config.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+
+module Magti
+  # URL for sending SMS.
+  SMS_SEND_URL  = 'http://81.95.160.47/mt/sendsms'
+
+  # URL for tracking SMS status.
+  SMS_TRACK_URL = 'http://81.95.160.47/bi/track.php'
+
+  # Maximum size of individual SMS message.
+  MAX_SIZE = 160
+
+  # Service configuration class.
+  #
+  # Access it, using <code>Magti.config</code>.
+  class Config
+    include Singleton
+
+    # user name
+    attr_accessor :username
+    # password
+    attr_accessor :password
+    # client
+    attr_accessor :client
+    # service
+    attr_accessor :service
+
+    def initialize
+      self.service = 1
+    end
+
+    # Returns security options hash.
+    def security_options
+      { :username => self.username, :password => self.password, :client_id => self.client, :service_id => self.service }
+    end
+  end
+
+  def self.config(params = {})
+    params.each do |k, v|
+      Magti::Config.instance.send "#{k}=".to_sym, v
+    end
+    Magti::Config.instance
+  end
+end

data/lib/magti/sms.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+require 'set'
+require 'cgi'
+require 'httparty'
+
+module Magti
+  # Response object.
+  # It contains information on response code and message id.
+  class Response
+    attr_accessor :id
+    attr_accessor :code
+  end
+
+  # Sending SMS.
+  #
+  # @param mobile mobile number
+  # @param text text to be sent
+  # @return Response object with response code and message ID
+  def self.send_sms(mobile, text)
+    raise ArgumentError, 'illegal mobile number' unless C12.correct_mobile?(mobile)
+    raise ArgumentError, 'max size exceeded' if text.length > Magti::MAX_SIZE
+    options = Magti.config.security_options
+    if options.nil? or options.empty? or !Set.new(options.keys).proper_subset?(Set[:username, :password, :client, :service])
+      raise ArgumentError, 'specify Magti.config(options) with :username, :password, :client and :service keys'
+    end
+    options = options.merge(:to => "995#{mobile}", :text => text)
+    resp = HTTParty.get(Magti::SMS_SEND_URL, options)
+    resp = Response.new
+    resp.code, resp.id = resp.split(' - ')
+    resp
+  end
+
+end

data/lib/magti/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module Magti
+  VERSION = "0.1.0.beta1"
+end

data/magti.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/magti/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dimitri Kurashvili"]
+  gem.email         = ["dimitri@c12.ge"]
+  gem.description   = %q{Magti SMS gateway}
+  gem.summary       = %q{Gem for sending SMS using MagtiGSM.ge gateway}
+  gem.homepage      = "http://github.com/dimakura/magti"
+
+  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.name          = "magti"
+  gem.require_paths = ["lib"]
+  gem.version       = Magti::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2'
+
+  gem.add_runtime_dependency 'c12-commons'
+  gem.add_runtime_dependency 'httparty', '~> 0.8'
+end

data/spec/config_spec.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe 'Test config' do
+  before(:all) do
+    Magti.config.username = 'dimitri'
+    Magti.config.password = 'secret'
+    Magti.config.client   = 10
+    Magti.config.service  = 100
+  end
+  context 'options for sending SMS' do
+    subject { Magti.config.security_options }
+    it { should be_instance_of Hash }
+    specify { subject[:username].should == 'dimitri' }
+    specify { subject[:password].should == 'secret' }
+    specify { subject[:client_id].should == 10 }
+    specify { subject[:service_id].should == 100 }
+  end
+end
+
+describe 'Test config assignment using hash' do
+  before(:all) do
+    Magti.config({:username => 'dk', :password => 'password', :client => 99, :service => 66})
+  end
+  context 'options for sending SMS' do
+    subject { Magti.config.security_options }
+    it { should be_instance_of Hash }
+    specify { subject[:username].should == 'dk' }
+    specify { subject[:password].should == 'password' }
+    specify { subject[:client_id].should == 99 }
+    specify { subject[:service_id].should == 66 }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+require 'rspec'
+require 'magti'
+
+RSpec.configure do |config|
+  config.include(RSpec::Matchers)
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: magti
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- Dimitri Kurashvili
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: c12-commons
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Magti SMS gateway
+email:
+- dimitri@c12.ge
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .project
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/magti.rb
+- lib/magti/config.rb
+- lib/magti/sms.rb
+- lib/magti/version.rb
+- magti.gemspec
+- refs/magti_protocol.pdf
+- spec/config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dimakura/magti
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Gem for sending SMS using MagtiGSM.ge gateway
+test_files:
+- spec/config_spec.rb
+- spec/spec_helper.rb
+has_rdoc: