messente-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54946d4694f6df2962df67f0e7fd47ff32dc6324
-  data.tar.gz: 3d5608bc4a6b381c96127e3295ff2bda6a3c928e
+  metadata.gz: fed9eacb2651c18ac8daae4e11416c0aaf9c98e7
+  data.tar.gz: dfac98f867b01dbbb3d5e3062e8daa52a1588d04
 SHA512:
-  metadata.gz: 6899f0992094856cc9d74b9d98b6d17c6aaf4bb5462cf35c53475b5e13389fc75d1c0b69d313f5736d2703b313ef6487ae51e45f8c783eade1149c7a36118da9
-  data.tar.gz: e772cf556ddd73f7541fb1e970b981fac314d40564d3d61378f868cd45a1ff12b459618e8926c11ce8e720f9cd81c94676e52ae9bbe000d2ecc2c3e0e0689ff0
+  metadata.gz: f7350cb9f4f555aa09bdacf14bcd12c2c40da263098f9322d23fd0498a72a8fc94197d1444f62f6908ff7c768719fa976a6822f1f660bfa9b2e37f5269c2097e
+  data.tar.gz: 216b3364ee404080ea0e804e4cb2c03e97ce61297e2468ece2098b875a31f1c9591496f62a655a73383e7595213b0160433443e75f4b6e34ccedabab3fe2cd86

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+before_install:
+  - gem install bundler
+rvm:
+  - 2.1.2
+gemfile:
+  - Gemfile
+notifications:
+  email: false

data/README.md

@@ -1,9 +1,14 @@
-# Messente::Rails
-
-Messente.com API wrapper for Rails (non official)
+# messente-rails
 
+Non-official [Messente.com](https://messente.com) SMS gateway API wrapper for Rails.
 Original API documentation: [https://messente.com/docs/api/rest/](https://messente.com/docs/api/rest/)
 
+[![Gem Version](https://badge.fury.io/rb/messente-rails.svg)](http://badge.fury.io/rb/messente-rails)
+[![Build Status](https://travis-ci.org/Gedrovits/messente-rails.svg)](https://travis-ci.org/Gedrovits/messente-rails)
+[![Dependency Status](https://gemnasium.com/Gedrovits/messente-rails.svg)](https://gemnasium.com/Gedrovits/messente-rails)
+[![Code Climate](https://codeclimate.com/github/Gedrovits/messente-rails.png)](https://codeclimate.com/github/Gedrovits/messente-rails)
+[![Inline docs](http://inch-ci.org/github/Gedrovits/messente-rails.png?branch=master)](http://inch-ci.org/github/Gedrovits/messente-rails)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,10 +33,28 @@ 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/)
 
+Idea was to leave original API names intact, so methods and parameters from API are same in gem.
+
+So for example to send SMS with generated initializer it's simply as that:
+
+    $ messente = Messente.new
+    $ messente.send_sms(text: 'Message', to: '+000000000')
+
+OR alternative way
+
+    $ Messente.send_sms(text: 'Message', to: '+000000000')
+
+This way you can pass in required and optional parameters and use official documentation as manual.
+
+    $ Messente.prices(country: 'GB', format: 'xml')
+    
+NB! Be warned about non-ruby like attribute names and pass them as strings. 
+For now there is only one parameter like this 'dlr-url'. Please if you need it send it like that:
+
+    $ Messente.send_sms(text: 'Message', to: '+000000000', 'dlr-url' => 'http://example.com/callback')
+
 ## Contributing
 
 1. Fork it ( https://github.com/Gedrovits/messente-rails/fork )

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

@@ -1,8 +1,15 @@
 # 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 %>
+  # API username
+  config.username = Rails.application.secrets.messente_username
+  # API password
+  config.password = Rails.application.secrets.messente_password
+
+  ## Options
+  # Return Messente.com stringified response as is without any special parsing
+  config.response_as_is = false
+  # Retry with backup Messente.com server on failed response
+  # This works only if :response_as_is === false
+  config.retry_on_fail = true
 end

data/lib/messente-rails/configuration.rb

@@ -13,5 +13,11 @@ module MessenteRails
     mattr_accessor :password
     @@password = nil
 
+    mattr_accessor :response_as_is
+    @@response_as_is = true
+
+    mattr_accessor :retry_on_fail
+    @@retry_on_fail = true
+
   end
 end

data/lib/messente-rails/messente.rb

@@ -4,135 +4,136 @@ class Messente
   include HTTParty
   base_uri 'api2.messente.com'
 
+  SUPPORTED_METHODS = [:send_sms, :get_dlr_response, :cancel_sms, :get_balance, :prices, :pricelist]
+
   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_104  = 'Country was not found.'
+  ERROR_105  = 'This country is not supported.'
+  ERROR_106  = 'Invalid format provided. Only json or xml is allowed.'
+  ERROR_107  = 'Could not find message with sms_unique_id.'
   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
+  attr_accessor :defaults, :credentials, :use_backup_uri, :current_params
+
+  def initialize(username = nil, password = nil)
+    self.defaults = {
+      response_as_is: MessenteRails::Configuration.response_as_is,
+      retry_on_fail:  MessenteRails::Configuration.retry_on_fail
+    }
+    self.credentials = {
+      username: username || MessenteRails::Configuration.username,
+      password: password || MessenteRails::Configuration.password
+    }
+  end
 
-      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/sms/
+  # :text, :to, :time_to_send, :from, 'dlr-url', :charset, :autoconvert, :udh
+  def send_sms(params)
+    self.current_params = params
+    response = send_request(params)
+    smart_response(response.parsed_response)
+  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
+  # https://messente.com/docs/api/rest/delivery-request/sync/
+  # :sms_unique_id
+  def get_dlr_response(params)
+    self.current_params = params
+    response = send_request(params)
+    smart_response(response.parsed_response)
+  end
 
-      response = get(url, { query: query })
-      return false unless ok? response
+  # https://messente.com/docs/api/rest/cancel-sms/
+  # :sms_unique_id
+  def cancel_sms(params)
+    self.current_params = params
+    response = send_request(params)
+    smart_response(response.parsed_response)
+  end
 
-      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
+    response = send_request
+    smart_response(response.parsed_response)
+  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
+  # https://messente.com/docs/api/rest/prices/
+  # :country, :format
+  def prices(params)
+    self.current_params = params
+    response = send_request(params)
+    smart_response(response.parsed_response)
+  end
 
-      response = get(url, { query: credentials })
-      return false unless ok? response
+  # https://messente.com/docs/api/rest/full-pricelist/
+  def pricelist
+    response = send_request
+    smart_response(response.parsed_response)
+  end
 
-      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
+  # Methods below allows us to make all calls above as class methods
+  # DRY so we don't need to define all methods again with calling instance from inside
 
-    # 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
+  def self.method_missing(method_name, *arguments, &block)
+    if SUPPORTED_METHODS.include? method_name
+      self.new.send(method_name, *arguments, &block)
+    else
+      super
     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
+  def self.respond_to_missing?(method_name, include_private = false)
+    SUPPORTED_METHODS.include? method_name || super
+  end
 
-      response = get(url, { query: credentials })
-      return false unless ok? response
+  private
+
+  def send_request(query = nil)
+    action = caller[0].split('`').pop.gsub('\'', '')
+    safe_query = query ? credentials.merge(query) : credentials
+    url = if use_backup_uri === true
+            self.use_backup_uri = false
+            "#{ self.class.base_uri.gsub('api2', 'api3') }/#{ action }/"
+          else
+            "/#{ action }/"
+          end
+    self.class.post(url, { query: safe_query })
+  end
 
-      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
+  def smart_response(response)
+    if response_as_is?
+      response
+    else
+      case response.split(' ').first
+      when 'ERROR'
+        [false, human_readable_error(response)]
+      when 'FAILED'
+        if retry_on_fail? && use_backup_uri != false
+          self.use_backup_uri = true
+          method_name = caller[0].split('`').pop.gsub('\'', '').to_sym
+          current_params.blank? ? send(method_name) : send(method_name, current_params)
+        else
+          self.use_backup_uri = nil
+        end
+        [false, human_readable_error(response)]
+      else
+        [true, response]
       end
     end
+  end
 
-    private
-
-    def credentials
-      { username: MessenteRails::Configuration.username,
-        password: MessenteRails::Configuration.password }
-    end
+  def human_readable_error(error)
+    safe_error = error.gsub(' ', '_')
+    self.class.const_defined?(safe_error) ? self.class.const_get(safe_error) : "#{error} not defined."
+  end
 
-    def backup_uri
-      base_uri.gsub('api2', 'api3')
-    end
+  def response_as_is?
+    defaults && defaults[:response_as_is]
+  end
 
-    def ok?(response)
-      response.code == 200
-    end
+  def retry_on_fail?
+    defaults && defaults[:retry_on_fail]
   end
 end

data/lib/messente-rails/version.rb

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

data/messente-rails.gemspec

@@ -6,6 +6,7 @@ require 'messente-rails/version'
 Gem::Specification.new do |spec|
   spec.name          = 'messente-rails'
   spec.version       = MessenteRails::VERSION
+  spec.platform      = Gem::Platform::RUBY
   spec.authors       = ['Vjatseslav Gedrovits']
   spec.email         = ['vjatseslav.gedrovits@gmail.com']
   spec.summary       = %q{Messente.com API wrapper for Rails}
@@ -22,5 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rails', '~> 4.1'
+  spec.add_development_dependency 'rails', '>= 4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messente-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vjatseslav Gedrovits
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,14 +56,14 @@ dependencies:
   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
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md