ifree-sms 0.1.0 → 0.1.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+platforms :ruby do
+  gem 'curb', '~> 0.7.15'
+  gem 'nokogiri'
+  gem 'activemodel'
+end

data/README.rdoc

@@ -34,22 +34,20 @@ Initialize IfreeSms and set its configurations.
     end
   end
   
-Send sms answer to user (asynchronous)
+Send sms message to user (asynchronous)
   
- * phone format => 380971606179
- * text length => 160 Latin or 70 Unicode
- * sms_id - unique sms id
+ * phone - format => 380971606179
+ * text - length => 160 Latin or 70 Unicode (encoding utf-8)
+ * from - sender title, max length: 11
   
-  IfreeSms.send_sms(phone, text, sms_id)
+  smsdirect = IfreeSms::SMSDirectAPI.new(login, password)
+  
+  smsdirect.submit_message(phone, text, from)
   
 or
 
   IfreeSms::Message.first.send_answer("some text")
   
-If you want to send sms to custom user, don't put sms_id (Paid action)
-  
-  IfreeSms.send_sms(phone, text)
-  
 == Dependences
 
 * {curb}[https://github.com/taf2/curb]

data/Rakefile

@@ -2,7 +2,6 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require File.join(File.dirname(__FILE__), 'lib', 'ifree_sms', 'version')
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -23,22 +22,3 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "ifree-sms"
-    s.version = IfreeSms::VERSION.dup
-    s.summary = "The IfreeSms gem for i-free sms provider"
-    s.description = "The IfreeSms gem for i-free sms provider"
-    s.email = "superp1987@gmail.com"
-    s.homepage = "https://github.com/superp/ifree-sms"
-    s.authors = ["Igor Galeta", "Pavlo Galeta"]
-    s.files =  FileList["[A-Z]*", "{app,lib}/**/*"] - ["Gemfile"]
-    #s.extra_rdoc_files = FileList["[A-Z]*"]
-  end
-  
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end

data/lib/generators/ifree_sms/templates/config/ifree_sms.rb

@@ -5,6 +5,8 @@ if Object.const_defined?("IfreeSms")
     config.secret_key = ""
     config.project_name = ""
     config.service_number = ""
+    config.login = ""
+    config.password = ""
     config.debug = true
   end
 

data/lib/ifree_sms.rb

@@ -8,45 +8,77 @@ module IfreeSms
   autoload :Manager,   'ifree_sms/manager'
   autoload :Config,    'ifree_sms/config'
   autoload :Callbacks, 'ifree_sms/callbacks'
+  autoload :Response,  'ifree_sms/response'
+  autoload :SMSDirectAPIMethods, 'ifree_sms/smsdirect_api'
   
   mattr_accessor :config
   @@config = Config.new
   
+  class API
+    # initialize with an access token
+    def initialize(login = nil, pass = nil)
+      @login = login || IfreeSms.config.login
+      @pass = pass || IfreeSms.config.password
+    end
+    attr_reader :access_token
+
+    def api(path, args = {}, verb = "get", options = {}, &error_checking_block)
+      # Fetches the given path in the Graph API.
+      args["login"] = @login
+      args["pass"] = @pass
+      
+      # add a leading /
+      path = "/#{path}" unless path =~ /^(\/|http|https|ftp)/
+
+      # make the request via the provided service
+      result = IfreeSms.make_request(path, args, verb, options)
+
+      # Check for any 500 errors before parsing the body
+      # since we're not guaranteed that the body is valid JSON
+      # in the case of a server error
+      raise APIError.new({"type"=>"HTTP #{result.status.to_s}", "message"=>"Response body: #{result.body}"}) if result.status >= 500
+      
+      body = result.body
+      yield body if error_checking_block
+
+      # if we want a component other than the body (e.g. redirect header for images), return that
+      options[:http_component] ? result.send(options[:http_component]) : body
+    end
+  end
+  
+  class APIError < StandardError
+    attr_accessor :sms_error_type
+    def initialize(details = {})
+      self.sms_error_type = details["type"]
+      super("#{sms_error_type}: #{details["message"]}")
+    end
+  end
+  
+  # APIs
+  
+  class SMSDirectAPI < API
+    include SMSDirectAPIMethods
+  end
+  
+  # Class methods
+  
   def self.setup(&block)
     yield config
   end
   
   def self.log(message)
     if IfreeSms.config.debug
-      Rails.logger.info("[IfreeSms] #{message}")
+      Rails.logger.info("[Ifree #{Time.now.strftime('%d.%m.%Y %H:%M')}] #{message}")
     end
   end
   
   def self.table_name_prefix
     'ifree_sms_'
   end
- 
-  # Send sms message
-  # Sample request:
-  # http://srv1.com.ua/mcdonalds/second.php?smsId=noID&phone=380971606179&serviceNumber=3533&smsText=test-message&md5key=f920c72547012ece62861938b7731415&now=20110527160613
-  #
-  def self.send_sms(phone, text, sms_id='noID')
-    now = Time.now.utc.strftime("%Y%m%d%H%M%S")
-    
-    params = {}
-    params[:smsId] = sms_id
-    params[:phone] = phone
-    params[:serviceNumber] = config.service_number
-    params[:smsText] = Base64.encode64(text)
-    params[:now] = now
-    params[:md5key] = calc_digest(config.service_number, params[:smsText], now)
-    
-    get(params)
-  end
   
-  def self.get(params)
+  def self.make_request(path, params, verb, options = {})
     query = Rack::Utils.build_query(params)
-    url = [config.url, query].join('?')
+    url = [path, query].join('?')
     
     log("request: #{url}")
     
@@ -55,7 +87,7 @@ module IfreeSms
     
     log("response: #{http.body_str}")
     
-    http.body_str
+    Response.new(http.response_code, http.body_str, http.headers)
   end
   
   def self.calc_digest(number, text, now)

data/lib/ifree_sms/config.rb

@@ -25,7 +25,7 @@ module IfreeSms
       end
     end
     
-    hash_accessor :routes, :secret_key, :service_number, :project_name, :debug
+    hash_accessor :routes, :secret_key, :service_number, :project_name, :login, :password, :debug
     
     def initialize(other={})
       merge!(other)
@@ -33,6 +33,8 @@ module IfreeSms
       self[:secret_key] ||= "some_very_secret_key_given_ifree"
       self[:service_number] ||= "some_service_number"
       self[:project_name] ||= "project_name"
+      self[:login] ||= "demo"
+      self[:password] ||= "demo"
       self[:debug] ||= false
     end
     

data/lib/ifree_sms/response.rb

@@ -0,0 +1,10 @@
+module IfreeSms
+  class Response
+    attr_reader :status, :body, :headers
+    def initialize(status, body, headers)
+      @status = status
+      @body = body
+      @headers = headers
+    end
+  end
+end

data/lib/ifree_sms/smsdirect_api.rb

@@ -0,0 +1,95 @@
+module IfreeSms
+  module SMSDirectAPIMethods
+    SMSDIRECT_SERVER = "https://www.smsdirect.ru"
+  
+    # Send SMS message
+    # Sample request:
+    #  GET /submit_message?login=demo&pass=demo&from=test&to=380503332211&text=smsdirect_submit_sm
+    #
+    def submit_message(phone, text, from = 'test')
+      call("submit_message", {:from => from, :to => phone, :text => text})
+    end
+    
+    # Получение статуса сообщения
+    # Параметры запроса:
+    # mid - ID сообщения полученный с помощью вызова submit_message
+    #
+    def status_message(message_id)
+      call("status_message", {:mid => message_id})
+    end
+    
+    # Создание/обновление базы абонентов
+    # Параметры запроса: 
+    # id - ID базы (может быть пустым при создании новой базы); 
+    # lname - название базы (может быть пустым);
+    # qfile - список записей разделенных переводом строк, со следующими полями (поля разделяются знаком ;):
+    # msisdn;name;secondname;lastname;city;date;sex
+    # поле msisdn - номер телефона абонента;
+    # поля name;secondname;lastname;city;sex - текстовые, по указанным именам их можно использовать в п.8 в поле mess, для      подстановки значений (при указании поля pattern = 1);
+    # поле date - дата в формате ДД-ММ-ГГГГ;
+    # 
+    def submit_db(uid, qfile, name = '')
+      call("submit_db", {:id => uid, :qfile => qfile, :lname => name})
+    end
+    
+    # Удаление записей из базы абонентов
+    # Параметры запроса: 
+    # id - ID базы;
+    # msisdn - список номеров телефонов подлежащих удалению, разделенные запятой (,).
+    #
+    def edit_db(uid, phones)
+      call('edit_db', {:id => uid, :msisdn => phones.join(',')})
+    end
+
+    # Получение статуса базы
+    # Параметры запроса: 
+    # id - ID базы; 
+    #
+    def status_db(uid)
+      call('status_db', {:id => uid})
+    end
+    
+    # Получение списка созданных баз
+    #
+    def get_db
+      call("get_db")  
+    end
+    
+    # Удаление базы
+    # Параметры запроса: 
+    # id - ID базы подлежащей удалению;
+    #
+    def delete_db(uid)
+      call("delete_db", {:id => uid})
+    end
+    
+    # Отправка смс-рассылки по созданной базе пользователей
+    # Параметры запроса: 
+    # typelist – тип данных (значения: 1 - база, 2 - список телефонов)
+    # list - ID базы\выборки;
+    # msisdn - список телефонов через запятую “,”
+    # mess - текст сообщения, в случае если параметр pattern=1, название полей для последующей подстановки, 
+    #  необходимо использовать в виде %ИМЯ ПОЛЯ%. Например, подстановка поля name будет выглядеть следующим образом: 
+    #  «Уважаемый %name% поздравляем Вас с днём рождения.»;
+    # isurl - признак wap-push (значения: 0 - отправлять как обычное сообщение, 1 - отправлять сообщения как push);
+    # wappushheader - заголовок wap-push (в случае если тип isurl = 1);
+    # max_mess - максимальное количество сообщений в день, оставить пустым, если не ограничено;
+    # max_mess_per_hour - максимальное количество сообщений в час, оставить пустым, если не ограничено;
+    def submit_dispatch(params = {})
+      call('submit_dispatch', params)
+    end
+      
+    protected
+    
+      def call(method_name, args = {}, options = {}, verb = "get")
+        options = options.merge!(:smsdirect_api => true)
+
+        api("#{SMSDIRECT_SERVER}/#{method_name}", args, verb, options) do |response|
+          # check for REST API-specific errors
+          if response.is_a?(Hash) && response["error_code"]
+            raise APIError.new("type" => response["error_code"], "message" => response["error_msg"])
+          end
+        end
+      end
+  end
+end

data/lib/ifree_sms/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module IfreeSms
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ifree-sms
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Igor Galeta
@@ -16,11 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 +03:00
+date: 2011-09-16 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: curb
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -32,27 +33,25 @@ dependencies:
         - 7
         - 15
         version: 0.7.15
-  name: curb
+  type: :runtime
   version_requirements: *id001
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: nokogiri
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
-  name: nokogiri
+        - 0
+        version: "0"
+  type: :runtime
   version_requirements: *id002
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: activemodel
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -62,9 +61,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: activemodel
+  type: :runtime
   version_requirements: *id003
-  prerelease: false
 description: The IfreeSms gem for i-free sms provider
 email: superp1987@gmail.com
 executables: []
@@ -72,25 +70,27 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
 files: 
-- LICENSE
-- README.rdoc
-- Rakefile
 - app/models/ifree_sms/message.rb
+- lib/ifree_sms.rb
 - lib/generators/ifree_sms/USAGE
-- lib/generators/ifree_sms/install_generator.rb
-- lib/generators/ifree_sms/templates/config/ifree_sms.rb
 - lib/generators/ifree_sms/templates/migrate/create_messages.rb
+- lib/generators/ifree_sms/templates/config/ifree_sms.rb
+- lib/generators/ifree_sms/install_generator.rb
 - lib/ifree-sms.rb
-- lib/ifree_sms.rb
-- lib/ifree_sms/callbacks.rb
-- lib/ifree_sms/config.rb
+- lib/ifree_sms/smsdirect_api.rb
 - lib/ifree_sms/engine.rb
-- lib/ifree_sms/manager.rb
 - lib/ifree_sms/smsing.rb
+- lib/ifree_sms/config.rb
+- lib/ifree_sms/response.rb
+- lib/ifree_sms/callbacks.rb
 - lib/ifree_sms/version.rb
+- lib/ifree_sms/manager.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
 has_rdoc: true
 homepage: https://github.com/superp/ifree-sms
 licenses: []
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: ifree-sms
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3