voice_com 0.0.1.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tmpv
+
+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,79 @@
+# VoiceCom
+
+TODO: Write a gem description
+
+This is a simple API for working with the bulgarian VoiceCom AD service.
+
+At this moment only usable with Rails.
+
+Add this line to your application's Gemfile:
+
+    gem 'voice_com'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voice_com
+
+## Usage
+
+After installing the gem. You have to create a configuration config/voicecom_config.yml.
+
+A template is give in the gem's repository in templates/voicecom_config.yml.
+
+## Request 
+  
+  Creating a request object:
+
+    request = VoiceCom::Request.new request_attr
+
+  Attribute accepted by a request object:
+
+  smsid*   : Unique id of the sms **message
+
+  phone*   : Phone number of the receiver
+
+  text*    : The sort text message of the request
+
+  op       : Mobile operator, if none given it will be determined by the phone number
+
+  priority : 1 - height priority / 2 - lower priority
+
+  validity : Sets the short message validity period, default 24 hours
+
+  ** VoiceCom gem builds in an ActiveRecord instance method, with gives an unique sms id,
+  created from the records 'database id column' and prefixed with the uppercase letter in the ActiveRecord Class name.
+
+  The config file accepts and an addition value(sms_uniq_id_column). If given the 'uniq_sms_id' return the value in this column.
+
+  Sending the message:
+
+    request.send_message
+
+  The method returns a response string, check VoiceCom documentation for more details.
+
+  Creating a response object:
+
+    response = VoiceCom::Response.new response_attr
+
+  Attributes for creating a response object:
+    :sid, :dlr, :answer, :to, :from, :ts, :smsID, :voicecom_id
+
+  For more information see VoiceCom documentation.
+
+
+
+## Response
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/voice_com/model_helpers.rb

@@ -0,0 +1,20 @@
+module VoiceCom
+  module ModelHelpers
+    def uniq_sms_id
+      
+      if uniq_column_id
+        send(uniq_column_id)
+      else
+        self.class.name.gsub(/[a-z]/, "").downcase + id.to_s
+      end
+
+    end
+
+    def uniq_column_id
+      #custome column for the uniq sms id, given in the config file
+      #when non given uses the first 2 upcase letter of the model  + 'id' column in the database 
+
+      VoiceCom.config["sms_uniq_id_column"]
+    end
+  end
+end

data/lib/voice_com/railtie.rb

@@ -0,0 +1,11 @@
+module VoiceCom
+  class Railtie < Rails::Railtie
+    initializer "voice_com.model_helpers" do
+      ActiveRecord::Base.send :include, ModelHelpers
+    end
+
+    initializer "voice_com.config_initialize" do
+      VoiceCom.config = YAML.load_file Rails.root.join('config', 'voicecom_config.yml').to_s
+    end
+  end
+end

data/lib/voice_com/request.rb

@@ -0,0 +1,45 @@
+require 'net/http'
+
+module VoiceCom
+  class Request
+
+    attr_accessor :smsid, :phone, :text, :op, :priority, :validity
+
+    def initialize(args = {})
+
+      @main_url = VoiceCom.config["service_url"]
+      @sid      = VoiceCom.config["sid"]
+
+      args.each {|k,v| instance_variable_set("@#{k}", v) unless k.blank?} 
+      yield self if block_given?
+      validate!
+    end
+
+    def send_message
+      build_uri
+      responce = Net::HTTP.get URI(@request_uri)
+    end
+
+    def build_uri
+      url_string = "http://#{@main_url}?serviceID=#{@sid}&id=#{smsid}&msisdn=#{phone}&msg=#{text}"
+      # url_string = "http://#{@main_url}?sid=#{@sid}&id=#{smsid}&msisdn=#{phone}&text=#{text}"
+      url_str    = addition_attr_to_uri url_string
+
+      @request_uri = URI.encode url_str
+    end
+
+
+    private
+
+    def addition_attr_to_uri(str)
+      str + "&" + ["op", "priority", "validity"].select{|x| instance_variable_get("@#{x}")}.map{|x| "#{x}" + "=" + instance_variable_get("@#{x}")}.join("&")
+    end
+
+    def validate!
+      [:smsid, :phone, :text].each do |sym|
+        raise ArgumentError, "Required attribute #{sym}" if send(sym).blank?
+      end
+      
+    end
+  end
+end

data/lib/voice_com/response.rb

@@ -0,0 +1,42 @@
+module VoiceCom
+  class Response
+    
+    attr_accessor :sid, :dlr, :answer, :to, :from, :ts, :smsID, :voicecom_id
+    attr_reader :answer_hash
+
+    def initialize(args = {})
+      args.each {|k,v| instance_variable_set("@#{k}", v)}
+      yield self if block_given?
+      validate!
+      parse_answer
+    end
+
+    def sms_id
+      @dlr
+    end
+
+    def parse_answer
+      @answer_hash = get_answer
+    end
+
+    def get_answer
+      Hash[@answer.split("+").map{|x| x.split(":")}]
+    end
+
+
+    def success?
+      
+      #in que to be implemented
+      true 
+
+    end
+
+    private
+
+    def validate!
+      [:sid, :dlr, :answer, :to, :from, :ts, :smsID, :voicecom_id].each do |x|
+        raise ArgumentError, "Request attribute #{x}" if instance_variable_get("@#{x}").blank?
+      end
+    end
+  end
+end

data/lib/voice_com/templates/voicecom_config.yml

@@ -0,0 +1,12 @@
+development:
+  service_url: url/given/by/the/service/provider
+  sid: ID/given/by/the/service/provider
+  sms_uniq_id_column: this is an optional configuration/see uniq_sms_id method for more details
+production:
+  service_url: url/given/by/the/service/provider
+  sid: ID/given/by/the/service/provider
+  sms_uniq_id_column: this is an optional configuration/see uniq_sms_id method for more details
+test:
+  service_url: url/given/by/the/service/provider
+  sid: ID/given/by/the/service/provider
+  sms_uniq_id_column: this is an optional configuration/see uniq_sms_id method for more details

data/lib/voice_com/version.rb

@@ -0,0 +1,3 @@
+module VoiceCom
+  VERSION = "0.0.1.1"
+end

data/lib/voice_com.rb

@@ -0,0 +1,23 @@
+require "voice_com/version"
+require "voice_com/request"
+require "voice_com/response"
+require "voice_com/model_helpers"
+
+require 'voice_com/railtie' if defined? Rails
+
+module VoiceCom
+  class << self
+
+    def config=(conf)
+      @@config = conf
+    end
+    
+    def config
+      @@config[Rails.env]
+    end
+
+    def uri_query_string_to_hash(uri)
+      Hash[uri.query.split('&').map{|x| URI.decode(x).split('=')}].symbolize_keys
+    end
+  end
+end

data/voice_com.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voice_com/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voice_com"
+  spec.version       = VoiceCom::VERSION
+  spec.authors       = ["Toma"]
+  spec.email         = ["t0ma.popov.90@gmail.com"]
+  spec.description   = %q{API for sending sms-s}
+  spec.summary       = %q{Simple API for working with the VoiceCom sms sending service}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: voice_com
+version: !ruby/object:Gem::Version
+  version: 0.0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Toma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !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: API for sending sms-s
+email:
+- t0ma.popov.90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/voice_com.rb
+- lib/voice_com/model_helpers.rb
+- lib/voice_com/railtie.rb
+- lib/voice_com/request.rb
+- lib/voice_com/response.rb
+- lib/voice_com/templates/voicecom_config.yml
+- lib/voice_com/version.rb
+- voice_com.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -137348665721630467
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -137348665721630467
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple API for working with the VoiceCom sms sending service
+test_files: []