messente-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54946d4694f6df2962df67f0e7fd47ff32dc6324
+  data.tar.gz: 3d5608bc4a6b381c96127e3295ff2bda6a3c928e
+SHA512:
+  metadata.gz: 6899f0992094856cc9d74b9d98b6d17c6aaf4bb5462cf35c53475b5e13389fc75d1c0b69d313f5736d2703b313ef6487ae51e45f8c783eade1149c7a36118da9
+  data.tar.gz: e772cf556ddd73f7541fb1e970b981fac314d40564d3d61378f868cd45a1ff12b459618e8926c11ce8e720f9cd81c94676e52ae9bbe000d2ecc2c3e0e0689ff0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Vjatseslav Gedrovits
+
+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,41 @@
+# Messente::Rails
+
+Messente.com API wrapper for Rails (non official)
+
+Original API documentation: [https://messente.com/docs/api/rest/](https://messente.com/docs/api/rest/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'messente-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install messente-rails
+
+Then you should run install generator:
+
+    $ rails g messente_rails:install
+    
+You should review the generated file and at least insert your credentials.
+
+NB! Don't forget to restart server after configuration.
+
+## Usage
+
+Methods from original documentation as is, but only synchronous sending is supported for now.
+
+Original API documentation: [https://messente.com/docs/api/rest/](https://messente.com/docs/api/rest/)
+
+## Contributing
+
+1. Fork it ( https://github.com/Gedrovits/messente-rails/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/generators/messente_rails/install_generator.rb

@@ -0,0 +1,12 @@
+module MessenteRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Copies messente.rb into config/initializers directory'
+
+      def copy_initializer
+        template 'messente.rb.erb', File.join(Rails.root, 'config', 'initializers', 'messente.rb')
+      end
+    end
+  end
+end

data/lib/generators/messente_rails/templates/messente.rb.erb

@@ -0,0 +1,8 @@
+# You can configure messente-rails within this file
+MessenteRails.configure do |config|
+  ## Messente.com API credentials
+  #
+  config.username = <% if ::Rails::VERSION::MAJOR == 4 %>Rails.application.secrets.messente_username<% else %>Rails.env.development? ? 'dev' : 'prod'<% end %>
+  #
+  config.password = <% if ::Rails::VERSION::MAJOR == 4 %>Rails.application.secrets.messente_password<% else %>Rails.env.development? ? 'dev' : 'prod'<% end %>
+end

data/lib/messente-rails/configuration.rb

@@ -0,0 +1,17 @@
+module MessenteRails
+  module Configuration
+
+    def configure
+      yield self
+    end
+
+    # Configurable parameters
+
+    mattr_accessor :username
+    @@username = nil
+
+    mattr_accessor :password
+    @@password = nil
+
+  end
+end

data/lib/messente-rails/messente.rb

@@ -0,0 +1,138 @@
+require 'httparty'
+
+class Messente
+  include HTTParty
+  base_uri 'api2.messente.com'
+
+  ERROR_101  = 'Access is restricted, wrong credentials. Check username and password values.'
+  ERROR_102  = 'Parameters are wrong or missing. Check that all required parameters are present.'
+  ERROR_103  = 'Invalid IP address. The IP address you made the request from, is not in the API settings whitelist.'
+  ERROR_111  = 'Sender parameter "from" is invalid. You have not activated this sender name from Messente.com'
+  FAILED_209 = 'Server failure, try again after a few seconds or try api3.messente.com backup server.'
+
+  class << self
+    # https://messente.com/docs/api/rest/sms/
+    def send_sms(mobile, message, backup_uri = false)
+      action = '/send_sms/'
+      query  = credentials.merge({ to: mobile, text: message })
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: query })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 101'  then ERROR_101
+        when 'ERROR 102'  then ERROR_102
+        when 'ERROR 103'  then ERROR_103
+        when 'ERROR 111'  then ERROR_111
+        when 'FAILED 209' then backup_uri ? false : send_sms(mobile, message, true)
+        else
+          # TODO: Should we save somewhere unique SMS ID?
+          # unique_sms_id = response.parsed_response.split(' ').second
+          true
+      end
+    end
+
+    # https://messente.com/docs/api/rest/delivery-request/sync/
+    def get_dlr_response(sms_unique_id, backup_uri = false)
+      action = '/get_dlr_response/'
+      query  = credentials.merge({ sms_unique_id: sms_unique_id })
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: query })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 101'  then ERROR_101
+        when 'ERROR 102'  then ERROR_102
+        when 'FAILED 209' then backup_uri ? false : get_dlr_response(sms_unique_id, true)
+        else response.parsed_response.split(' ').second.downcase
+      end
+    end
+
+    # https://messente.com/docs/api/rest/cancel-sms/
+    def cancel_sms(sms_unique_id, backup_uri = false)
+      action = '/cancel_sms/'
+      query  = credentials.merge({ sms_unique_id: sms_unique_id })
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: query })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 107'  then 'Could not find message with sms_unique_id.'
+        when 'FAILED 209' then backup_uri ? false : cancel_sms(sms_unique_id, true)
+        else true
+      end
+    end
+
+    # https://messente.com/docs/api/rest/balance/
+    def get_balance(backup_uri = false)
+      action = '/get_balance/'
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: credentials })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 101'  then ERROR_101
+        when 'ERROR 102'  then ERROR_102
+        when 'FAILED 209' then backup_uri ? false : get_balance(true)
+        else response.parsed_response.split(' ').second
+      end
+    end
+
+    # https://messente.com/docs/api/rest/prices/
+    def prices(country, format = 'json', backup_uri = false)
+      action = '/prices/'
+      query  = credentials.merge({ country: country, format: format })
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: query })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 101'  then ERROR_101
+        when 'ERROR 102'  then ERROR_102
+        when 'ERROR 103'  then 'IP address not allowed.'
+        when 'ERROR 104'  then 'Country was not found.'
+        when 'ERROR 105'  then 'This country is not supported.'
+        when 'ERROR 106'  then 'Invalid format provided. Only json or xml is allowed.'
+        when 'FAILED 209' then backup_uri ? false : prices(country, 'json', true)
+        else response.parsed_response
+      end
+    end
+
+    # https://messente.com/docs/api/rest/full-pricelist/
+    def pricelist(backup_uri = false)
+      action = '/pricelist/'
+      url    = backup_uri ? self.backup_uri + action : action
+
+      response = get(url, { query: credentials })
+      return false unless ok? response
+
+      case response.parsed_response
+        when 'ERROR 101'  then ERROR_101
+        when 'ERROR 102'  then ERROR_102
+        when 'ERROR 103'  then 'IP address not allowed.'
+        when 'FAILED 209' then backup_uri ? false : pricelist(true)
+        else response.parsed_response
+      end
+    end
+
+    private
+
+    def credentials
+      { username: MessenteRails::Configuration.username,
+        password: MessenteRails::Configuration.password }
+    end
+
+    def backup_uri
+      base_uri.gsub('api2', 'api3')
+    end
+
+    def ok?(response)
+      response.code == 200
+    end
+  end
+end

data/lib/messente-rails/version.rb

@@ -0,0 +1,3 @@
+module MessenteRails
+  VERSION = '0.1.0'
+end

data/lib/messente-rails.rb

@@ -0,0 +1,7 @@
+require 'messente-rails/messente'
+require 'messente-rails/version'
+require 'messente-rails/configuration'
+
+module MessenteRails
+  extend Configuration
+end

data/messente-rails.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'messente-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'messente-rails'
+  spec.version       = MessenteRails::VERSION
+  spec.authors       = ['Vjatseslav Gedrovits']
+  spec.email         = ['vjatseslav.gedrovits@gmail.com']
+  spec.summary       = %q{Messente.com API wrapper for Rails}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/Gedrovits/messente-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # 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_runtime_dependency 'httparty', '~> 0.13'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rails', '~> 4.1'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: messente-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vjatseslav Gedrovits
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Messente.com API wrapper for Rails
+email:
+- vjatseslav.gedrovits@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/messente_rails/install_generator.rb
+- lib/generators/messente_rails/templates/messente.rb.erb
+- lib/messente-rails.rb
+- lib/messente-rails/configuration.rb
+- lib/messente-rails/messente.rb
+- lib/messente-rails/version.rb
+- messente-rails.gemspec
+homepage: https://github.com/Gedrovits/messente-rails
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Messente.com API wrapper for Rails
+test_files: []