mainsms_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cbb84cce368569930e3fd8fca82bf42177b6b44
+  data.tar.gz: 27e4bc23e5663d9307d5fdc7cb900eaf567b68bb
+SHA512:
+  metadata.gz: 65ecba59c6374101caf3e08fc84c03458827344df47c5f0db439dcac23dff13d1c7e666d55ec5beae4fe4cf05bd05400803cbb468ae685dd3cebd9f729cfc063
+  data.tar.gz: 938409e6f58a09ec8c78b5d7a6510038324ac72ecbbb8262dfbaf7eaca92e7123dcdadcfe891f45421dac124ba3f81c57d956a9a34977c5309789d7ea564257f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,83 @@
+## Использование
+
+Добавить в Gemfile:
+```ruby
+gem 'mainsms_api', :git => 'git://github.com/evserykh/mainsms_api.git'
+```
+
+### Настройка
+При использовании в Rails приложении запустить генератор
+```ruby
+bundle exec rails g mainsms_api:install
+```
+и указать настройки в __config/mainsms.yml__
+
+Если gem используется не в Rails приложении, то можно задать настройки следующим образом:
+
+```ruby
+MainsmsApi::Configuration.setup project: 'PROJECT', api_key: 'SECRET'
+```
+
+### Отправка сообщения
+```ruby
+message = MainsmsApi::Message.new(sender: 'SENDER', message: 'MESSAGE', recipients: ['89112223344'])
+response = message.deliver
+```
+Параметры:
+* __sender__ - имя отправителя
+* __message__ - текст сообщения
+* __recipients__ - массив с номерами получателей
+* __run_at__ - время отправки
+* __test__ - тестовый режим ('1' для включения)
+
+Объект _response_ является экземпляром класса [Hashie::Mash](https://github.com/intridea/hashie#mash). Для него доступны методы, возвращаемые в ответе сервера. Например, обработать статус ответа можно так:
+```ruby
+if response.status == 'success'
+  #code
+end
+```
+или
+```ruby
+if response['status'] == 'success'
+  #code
+end
+```
+Подробнее об ответе сервера можно прочитать [тут](http://mainsms.ru/home/mainapi#send_api)
+
+### Запрос статуса сообщения
+```ruby
+status = MainsmsApi::Status.new(:message_ids => ['1', '2'])
+response = status.check
+```
+Параметры:
+* __message_ids__ - идентификаторы сообщений
+
+Подробнее [тут](http://mainsms.ru/home/mainapi#status_api)
+
+### Определение цены
+```ruby
+price = MainsmsApi::Price.new(:message => 'MESSAGE', :recipients => ['89112223344'])
+response = price.calculate
+```
+Параметры:
+* __message__ - текст сообщения
+* __recipients__ - массив с номерами получателей
+
+Подробнее [тут](http://mainsms.ru/home/mainapi#price_api)
+
+### Запрос баланса
+```ruby
+balance = MainsmsApi::Balance.new
+response = balance.check
+```
+Подробнее [тут](http://mainsms.ru/home/mainapi#balance_api)
+
+### Запрос информации о номерах
+```ruby
+info = MainsmsApi::Info.new(:phones => ['89112223344'])
+response = info.get
+```
+Параметры:
+* __phones__ - массив номеров
+
+Подробнее [тут](http://mainsms.ru/home/mainapi#info_api)

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MainsmsApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/mainsms_api/install/install_generator.rb

@@ -0,0 +1,12 @@
+module MainsmsApi
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_config_file
+        copy_file 'mainsms.yml', 'config/mainsms.yml'
+        copy_file 'mainsms_api.rb', 'config/initializers/mainsms_api.rb'
+      end
+    end
+  end
+end

data/lib/generators/mainsms_api/install/templates/mainsms.yml

@@ -0,0 +1,3 @@
+mainsms:
+  project: PROJECT
+  api_key: SECRET 

data/lib/generators/mainsms_api/install/templates/mainsms_api.rb

@@ -0,0 +1 @@
+MainsmsApi::Configuration.setup YAML.load_file(Rails.root.join('config', 'mainsms.yml'))['mainsms']

data/lib/mainsms_api.rb

@@ -0,0 +1,16 @@
+require 'active_attr'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/string'
+require 'hashie'
+require 'httparty'
+
+require 'mainsms_api/configuration'
+require 'mainsms_api/common'
+require 'mainsms_api/message'
+require 'mainsms_api/status'
+require 'mainsms_api/price'
+require 'mainsms_api/balance'
+require 'mainsms_api/info'
+ 
+module MainsmsApi
+end

data/lib/mainsms_api/balance.rb

@@ -0,0 +1,22 @@
+module MainsmsApi
+  class Balance
+    include ActiveAttr::MassAssignment
+    include Common
+
+    def initialize(args = {})
+      super(args)
+    end
+
+    alias_method :check, :response
+
+    private
+
+    def params
+      { project: project }
+    end
+
+    def path
+      'api/mainsms/message/balance'
+    end
+  end
+end

data/lib/mainsms_api/common.rb

@@ -0,0 +1,55 @@
+module MainsmsApi
+  module Common
+    def response
+      @response ||= Hashie::Mash.new(JSON.parse(response_body))
+    end
+
+    private
+
+    def project
+      MainsmsApi::Configuration.project
+    end
+
+    def api_key
+      MainsmsApi::Configuration.api_key
+    end
+
+    def used_params
+      params.select { |k, v| v.present? }
+    end
+
+    def sorted_params
+      used_params.values.map(&:to_s).sort
+    end
+
+    def sign
+      sha1 = Digest::SHA1.hexdigest((sorted_params + [api_key]).join(';'))
+
+      md5 = Digest::MD5.hexdigest(sha1)
+    end
+
+    def query
+      used_params.merge(sign: sign).to_query
+    end
+
+    def protocol
+      'http'
+    end
+
+    def host
+      'mainsms.ru'
+    end
+
+    def url
+      "#{protocol}://#{host}/#{path}?#{query}"
+    end
+
+    def request
+      @request ||= HTTParty.get(url)
+    end
+
+    def response_body
+      @response_body ||= request.body
+    end
+  end
+end

data/lib/mainsms_api/configuration.rb

@@ -0,0 +1,19 @@
+require 'hashie'
+
+module MainsmsApi
+  class Configuration
+
+    def self.api_key
+      @settings.api_key
+    end
+
+    def self.project
+      @settings.project
+    end
+
+    def self.setup(options)
+      @settings ||= Hashie::Mash.new(options)
+    end
+  end
+end
+

data/lib/mainsms_api/info.rb

@@ -0,0 +1,28 @@
+module MainsmsApi
+  class Info
+    include ActiveAttr::MassAssignment
+    include Common
+
+    attr_accessor :phones 
+
+    def initialize(args = {})
+      super(args)
+    end
+
+    alias_method :get, :response
+
+    private
+
+    def phones_string
+      phones.try(:join, ',')
+    end
+
+    def params
+      { project: project, phones: phones_string }
+    end
+
+    def path
+      'api/mainsms/message/info'
+    end
+  end
+end

data/lib/mainsms_api/message.rb

@@ -0,0 +1,28 @@
+module MainsmsApi
+  class Message
+    include ActiveAttr::MassAssignment
+    include Common
+
+    attr_accessor :sender, :message, :recipients, :run_at, :test
+
+    def initialize(args = {})
+      super(args)
+    end
+
+    alias_method :deliver, :response
+
+    private
+
+    def recipients_string
+      recipients.try(:join, ',')
+    end
+
+    def params
+      { project: project, sender: sender , message: message, recipients: recipients_string, run_at: run_at, test: test }
+    end
+
+    def path
+      'api/mainsms/message/send'
+    end
+  end
+end

data/lib/mainsms_api/price.rb

@@ -0,0 +1,28 @@
+module MainsmsApi
+  class Price
+    include ActiveAttr::MassAssignment
+    include Common
+
+    attr_accessor :recipients, :message
+
+    def initialize(args = {})
+      super(args)
+    end
+
+    alias_method :calculate, :response
+
+    private
+
+    def recipients_string
+      recipients.try(:join, ',')
+    end
+
+    def params
+      { project: project, message: message, recipients: recipients_string }
+    end
+
+    def path
+      'api/mainsms/message/price'
+    end
+  end
+end

data/lib/mainsms_api/status.rb

@@ -0,0 +1,28 @@
+module MainsmsApi
+  class Status
+    include ActiveAttr::MassAssignment
+    include Common
+
+    attr_accessor :message_ids
+
+    def initialize(args = {})
+      super(args)
+    end
+
+    alias_method :check, :response
+
+    private
+
+    def message_ids_string
+      message_ids.try(:join, ',')
+    end
+
+    def params
+      { project: project, messages_id: message_ids_string }
+    end
+
+    def path
+      'api/mainsms/message/status'
+    end
+  end
+end

data/lib/mainsms_api/version.rb

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

data/lib/tasks/mainsms_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mainsms_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mainsms_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evgeniy Serykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: mainsms.ru API
+email:
+- e.v.serykh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/mainsms_api/install/install_generator.rb
+- lib/generators/mainsms_api/install/templates/mainsms.yml
+- lib/generators/mainsms_api/install/templates/mainsms_api.rb
+- lib/mainsms_api/balance.rb
+- lib/mainsms_api/common.rb
+- lib/mainsms_api/configuration.rb
+- lib/mainsms_api/info.rb
+- lib/mainsms_api/message.rb
+- lib/mainsms_api/price.rb
+- lib/mainsms_api/status.rb
+- lib/mainsms_api/version.rb
+- lib/mainsms_api.rb
+- lib/tasks/mainsms_api_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/evserykh/mainsms_api
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: mainsms.ru API
+test_files: []