smsway_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09176d1235ea2f380396332d79a8df243b8ea598
+  data.tar.gz: 571f4da870f66092fb25d42f4ef2c05635ebeb5a
+SHA512:
+  metadata.gz: 2aa89c3222baaa899d4432c4c120afc63dfba66322f7edd77294278d3cae214f7bb039d7ee63789cdf90264682e1ec54cee426d255f7ce1e49cf1126cb61af88
+  data.tar.gz: 76ff8095fa0df5eafb4f8db85816b5b1087224d90156176506475a5d9f1b184a6d4942afbb7f30fef683665bf3e4799efc2ba0211aed109f513d7311d226eba0

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in smsway_api.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    smsway_api (0.1.0)
+      builder (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec (~> 2.14)
+  smsway_api!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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,16 @@
+## smsway_api [![Build Status](https://secure.travis-ci.org/kelion/smsway_api.png)](http://travis-ci.org/kelion/smsway_api) [![Gem Version](https://badge.fury.io/rb/smsway_api.png)](http://badge.fury.io/rb/smswy_api) [![Dependency Status](https://gemnasium.com/kelion/smsway_api.png)](https://gemnasium.com/kelion/smsway_api) [![Code Climate](https://codeclimate.com/github/kelion/smsway_api.png)](https://codeclimate.com/github/kelion/smsway_api)
+
+Ruby wrapper for smsway.ru xml api
+
+## Installation
+
+``` ruby
+# Gemfile
+gem 'smsway_api'
+```
+
+or just
+
+``` sh
+$ gem install smsway_api
+```

data/lib/generators/smsway_api/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Create a smsway_api config file in config/initializers/smsway_api.rb.

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

@@ -0,0 +1,9 @@
+# A rails generator `vkontakte:install`. It creates a config file in `config/initializers/vkontakte_api.rb`.
+class SmswayApi::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  # Creates the config file.
+  def create_initializer
+    copy_file 'initializer.rb', 'config/initializers/smsway_api.rb'
+  end
+end

data/lib/generators/smsway_api/install/templates/initializer.rb

@@ -0,0 +1,21 @@
+SmswayApi.configure do |config|
+  # Authorization parameters
+  # config.login = '123'
+  # config.password = 'AbCdE654'
+
+  # set this to have persistent sender through your application
+  # config.default_sender = 'SMSWAY'
+
+  # Logging parameters:
+  # log everything through the rails logger
+  config.logger = Rails.logger
+
+  # log requests' URLs
+  # config.log_requests = true
+
+  # log response JSON after errors
+  # config.log_errors = true
+
+  # log response JSON after successful responses
+  # config.log_responses = false
+end

data/lib/smsway_api.rb

@@ -0,0 +1,15 @@
+require 'builder'
+
+require 'smsway_api/configuration.rb'
+require 'smsway_api/api.rb'
+require 'smsway_api/message.rb'
+require 'smsway_api/method.rb'
+require 'smsway_api/message/sms.rb'
+require 'smsway_api/message/vcard.rb'
+require 'smsway_api/message/wap_push.rb'
+require 'smsway_api/method/send_message.rb'
+require 'smsway_api/method/balance.rb'
+
+module SmswayApi
+  extend SmswayApi::Configuration
+end

data/lib/smsway_api/api.rb

@@ -0,0 +1,36 @@
+module SmswayApi
+  module API
+    URL_PREFIX = 'http://my.smsway.ru/'
+    DEFAULT_HEADERS = {"Content-Type" => "text/xml; charset=utf-8"}
+
+    class << self
+      def call(method, options = {})
+        xml = build(method, options)
+        request({url: URL, headers: HEADERS, request: xml})
+      end
+
+      def request options
+        headers = options.delete(:headers) || {}
+
+        uri = URI.parse(URL_PREFIX+options.delete(:path))
+        http = Net::HTTP.new(uri.host, uri.port)
+
+        req = Net::HTTP::Post.new(uri.path, DEFAULT_HEADERS.merge(headers))
+        req.body = options.delete(:request)
+        http.request(req).body
+      end
+
+      def method_missing name, *args
+        api_method = "SmswayApi::Method::#{name.to_s.camelize}".constantize.new(*args)
+        api_method.build_xml
+        response = request({
+          path: api_method.uri,
+          request: api_method.build_xml
+        })
+        api_method.parse(response)
+      rescue NameError
+        super
+      end
+    end
+  end
+end

data/lib/smsway_api/client.rb

@@ -0,0 +1,17 @@
+module SmswayApi
+  class Client
+    URL = 'http://my.smsway.ru/xml/'
+
+    def send(request)
+      uri = URI.parse(URL)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, headers)
+      req.body = request
+      response = http.request(req)
+      response.body
+    end
+
+    def send_message(message, number, sender)
+    end
+  end
+end

data/lib/smsway_api/configuration.rb

@@ -0,0 +1,60 @@
+require 'logger'
+
+module SmswayApi
+  # General configuration module.
+  #
+  # @note `SmswayApi::Configuration` extends `Smsway` so these methods should be called from the latter.
+  module Configuration
+    # Available options.
+    OPTION_NAMES = [
+      :login,
+      :password,
+      :default_sender,
+      :logger,
+      :log_requests,
+      :log_errors,
+      :log_responses
+    ]
+
+    attr_accessor *OPTION_NAMES
+
+    alias_method :log_requests?,  :log_requests
+    alias_method :log_errors?,    :log_errors
+    alias_method :log_responses?, :log_responses
+
+    # Default max retries count.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Logger default options.
+    DEFAULT_LOGGER_OPTIONS = {
+      requests:  true,
+      errors:    true,
+      responses: false
+    }
+
+    # A global configuration set via the block.
+    # @example
+    #   SmswayApi.configure do |config|
+    #     config.adapter = :net_http
+    #     config.logger  = Rails.logger
+    #   end
+    def configure
+      yield self if block_given?
+      self
+    end
+
+    # Reset all configuration options to defaults.
+    def reset
+      @max_retries     = DEFAULT_MAX_RETRIES
+      @logger          = ::Logger.new(STDOUT)
+      @log_requests    = DEFAULT_LOGGER_OPTIONS[:requests]
+      @log_errors      = DEFAULT_LOGGER_OPTIONS[:errors]
+      @log_responses   = DEFAULT_LOGGER_OPTIONS[:responses]
+    end
+
+    # When this module is extended, set all configuration options to their default values.
+    def self.extended(base)
+      base.reset
+    end
+  end
+end

data/lib/smsway_api/message.rb

@@ -0,0 +1,54 @@
+module SmswayApi
+  class Message
+    attr_accessor :sender
+
+    attr_reader :recepients
+    attr_reader :type
+
+    TYPES = [:flashsms, :sms, :vcard, :wappush]
+
+    def initialize(type = :sms)
+      self.type = type
+      @sender = SmswayApi.default_sender
+      @recepients = []
+    end
+
+    def type=(type)
+      @type = type if TYPES.include?(type)
+    end
+
+    def build(xml, start_index = 0)
+      xml.message(type: @type) do
+        xml.sender @sender
+        yield(xml)
+        @recepients.each.with_index do |r, index|
+          xml.abonent(r.merge(number_sms: start_index + index))
+        end
+      end
+    end
+
+    # add recepient
+    # recepient (Hash or String) options for recipient
+    # allowed options are:
+    #   phone: phone number
+    #   client_id: sms id in your system
+    #   time_send: Time of sms sending
+    #   validity_period: Date of
+    # if String is given than it means only phone
+    def add_recipient(recepient = {})
+      if recepient.is_a?(String)
+        # convert string value to correct hash
+        recepient = {phone: recepient}
+      end
+      recepient[:phone] = format_phone(recepient[:phone])
+      @recepients.push(recepient)
+      # time-send format: YYYY-MM-DD HH:MM
+      # validity_period format: YYYY-MM-DD HH:MM
+    end
+
+    private
+    def format_phone phone
+      phone.gsub(/\A(\+7|8)/, '7').gsub(/[^\d]/, '')
+    end
+  end
+end

data/lib/smsway_api/message/sms.rb

@@ -0,0 +1,16 @@
+module SmswayApi
+  class Message::Sms < Message
+    attr_accessor :message
+
+    def initialize(message= nil)
+      super(:sms)
+      @message = message
+    end
+
+    def build(xml, start_index = 0)
+      super do |xml|
+        xml.text @message
+      end
+    end
+  end
+end

data/lib/smsway_api/message/vcard.rb

@@ -0,0 +1,36 @@
+module SmswayApi
+  class Message::Vcard < Message
+  # allowed options:
+  #   url
+  #   name
+  #   phone
+  #     cell
+  #     work
+  #     fax
+  #   email
+  #   position
+  #   organization
+  #   address
+  #      post_office_box
+  #      street
+  #      city
+  #      region
+  #      postal_code
+  #      country
+  #   additional
+  def initialize(vcard = {})
+    super(:vcard)
+    @vcard = vcard
+  end
+
+  def build(xml, start_index = 0)
+    super do |xml|
+      [:url, :name, :email, :position, :organization, :additional, :phone, :address].each do |key|
+        if @vcard.has_key?(key)
+          xml.tag!(key, @vcard[key])
+        end
+      end
+    end
+  end
+  end
+end

data/lib/smsway_api/message/wap_push.rb

@@ -0,0 +1,16 @@
+module SmswayApi
+  class Message::WapPush < Message
+    attr_accessor :url
+
+    def initialize(url = nil)
+      super(:wappush)
+      @url = url
+    end
+
+    def build(xml, start_index = 0)
+      super do |xml|
+        xml.url @url
+      end
+    end
+  end
+end

data/lib/smsway_api/method.rb

@@ -0,0 +1,30 @@
+module SmswayApi
+  class Method
+
+    def build_xml
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.request do
+        yield(xml) if block_given?
+        xml.security do
+          xml.login(value: SmswayApi.login)
+          xml.password(value:  SmswayApi.password)
+        end
+      end
+      xml.target!
+    end
+
+    def parse_response response
+      raise 'not implemented'
+    end
+
+    def uri
+      ''
+    end
+
+    def http_verb
+      :post
+    end
+
+  end
+end

data/lib/smsway_api/method/balance.rb

@@ -0,0 +1,11 @@
+module SmswayApi
+  class Method::Balance < SmswayApi::Method
+    def uri
+      'xml/balance.php'
+    end
+
+    def parse response
+      Hash.from_xml(response)
+    end
+  end
+end

data/lib/smsway_api/method/send_message.rb

@@ -0,0 +1,34 @@
+module SmswayApi
+  class Method::SendMessage < SmswayApi::Method
+    def initialize *args
+      if args.first.is_a?(SmswayApi::Message)
+        @messages = args
+      elsif args.length == 2 && args.first.is_a?(String)
+        @messages = []
+        sms = SmswayApi::Message::Sms.new(args.first)
+        sms.add_recipient(args.last)
+        @messages << sms
+      else
+        @messages = Array.wrap(args.first)
+      end
+    end
+
+    def build_xml
+      super do |xml|
+        abonents = 1
+        @messages.each do |m|
+          m.build(xml, abonents)
+          abonents += m.recepients.size
+        end
+      end
+    end
+
+    def uri
+      'xml/index.php'
+    end
+
+    def parse response
+      Hash.from_xml(response)
+    end
+  end
+end

data/lib/smsway_api/version.rb

@@ -0,0 +1,3 @@
+module SmswayApi
+  VERSION = "0.1.0"
+end

data/smsway_api.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "smsway_api/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "smsway_api"
+  s.version     = SmswayApi::VERSION
+  s.authors     = ["Alexandr Subbotin"]
+  s.email       = ["kelionweb@gmail.com"]
+  s.homepage    = "https://github.com/KELiON/smsway_api"
+  s.summary     = "Ruby wrapper for smsway.ru xml API"
+  s.description = "Simple ruby wrapper for smsway.ru XML API. Provides simples methods for sending sms, flash sms, vcard and wappushes, check balance."
+
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'builder', '~> 3.2'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.14'
+
+end

data/spec/smsway_api/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class Configurable
+  extend SmswayApi::Configuration
+end
+
+describe SmswayApi::Configuration do
+  describe "#configure" do
+    it "yields self" do
+      Configurable.should_receive(:some_method)
+      Configurable.configure do |config|
+        config.some_method
+      end
+    end
+
+    it "returns self" do
+      Configurable.configure.should == Configurable
+    end
+  end
+end

data/spec/smsway_api/message/sms_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe SmswayApi::Message::Sms do
+  let(:sms) { SmswayApi::Message::Sms.new }
+
+  describe ".initialize" do
+    it "should have sms type" do
+      expect(sms.type).to eq(:sms)
+    end
+
+    it "should have message" do
+      expect(SmswayApi::Message::Sms.new('test').message).to eq('test')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require './lib/smsway_api.rb'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: smsway_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandr Subbotin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Simple ruby wrapper for smsway.ru XML API. Provides simples methods for
+  sending sms, flash sms, vcard and wappushes, check balance.
+email:
+- kelionweb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- lib/generators/smsway_api/install/USAGE
+- lib/generators/smsway_api/install/install_generator.rb
+- lib/generators/smsway_api/install/templates/initializer.rb
+- lib/smsway_api.rb
+- lib/smsway_api/api.rb
+- lib/smsway_api/client.rb
+- lib/smsway_api/configuration.rb
+- lib/smsway_api/message.rb
+- lib/smsway_api/message/sms.rb
+- lib/smsway_api/message/vcard.rb
+- lib/smsway_api/message/wap_push.rb
+- lib/smsway_api/method.rb
+- lib/smsway_api/method/balance.rb
+- lib/smsway_api/method/send_message.rb
+- lib/smsway_api/version.rb
+- smsway_api.gemspec
+- spec/smsway_api/configuration_spec.rb
+- spec/smsway_api/message/sms_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/KELiON/smsway_api
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for smsway.ru xml API
+test_files:
+- spec/smsway_api/configuration_spec.rb
+- spec/smsway_api/message/sms_spec.rb
+- spec/spec_helper.rb
+has_rdoc: