meta_sms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80961d4503e372186a20a6d562bf239e52b1c96f
+  data.tar.gz: c32ae42928d4cfd813fbfe29698ce7bd06f34b05
+SHA512:
+  metadata.gz: 0a66906b88fdc4638d1c5159937a2d95eff6a5efb0eeb901d735dba5a162defc463b2a42695e459b544d4b2175be83b5f0156b5f43ebefead2869bef981e25f7
+  data.tar.gz: b19ec1ad55cd053ae44a6913af2ced49173f2432b9f3ae37d15692244db32fd0771781d61deffe6307fbd31bd9bc388a488bcb9cd6cc9ea4c04155a4075f4068

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Shobhit Dixit
+
+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.rdoc

@@ -0,0 +1,3 @@
+= MetaSms
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

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

data/lib/generators/meta_sms/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module MetaSms
+
+
+    # This creates MetaSms initializer for your application
+    # It will copy the config file template in config/initializers/meta_sms.rb
+    # 
+    # @author Shobhit Dixit
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Creates MetaSms initializer for your application"
+
+      def copy_initializer
+        template "meta_sms_initializer.rb", "config/initializers/meta_sms.rb"
+      end
+
+    end
+
+end

data/lib/generators/meta_sms/migrations_for_logger_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module MetaSms
+
+    # This is a generator for SmsLogging migration
+    # It Generates (but does not run) a migration to add a sms_loggings table
+    #
+    # @author Shobhit Dixit
+    class MigrationsForLoggerGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      source_root File.expand_path("../templates/migrations", __FILE__)
+      desc "Generates (but does not run) a migration to add a sms_loggings table"
+
+      def create_migration_file
+        migration_template 'create_sms_loggings.rb', 'db/migrate/create_sms_loggings.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+    end
+
+end

data/lib/generators/meta_sms/templates/meta_sms_initializer.rb

@@ -0,0 +1,19 @@
+MetaSms.configure do |config|
+
+  # This gem is a wrapper to use smsbox api in rails to send sms.
+
+
+  # make this true if logging is required
+  # also run 'rails g meta_sms:migrations_for_logger' in order to add migrations for sms logger
+  # currently this gem supports only pg adapter for database
+  config.logging = false
+
+  # config.sms_provider_name = :smsbox
+  # config.smsbox_user_name = ''
+  # config.smsbox_key = ''
+  # config.route = 'Transactional'
+  # config.from = 'tpohub'
+  # config.type = 'TextSMS'
+
+
+end

data/lib/generators/meta_sms/templates/migrations/create_sms_loggings.rb

@@ -0,0 +1,13 @@
+class CreateSmsLoggings < ActiveRecord::Migration
+  def change
+    create_table :sms_loggings do |t|
+      t.string :message_text
+      t.string :mobile_number
+      t.string :error_message
+      t.json :metadata
+
+      t.timestamps
+    end
+  end
+
+end

data/lib/meta_sms/configuration.rb

@@ -0,0 +1,25 @@
+module MetaSms
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  # TODO: write dynamic attr_accessor. as currently it is written only for smsbox
+  class Config
+    attr_accessor :sms_provider_name,:logging, :smsbox_user_name, :smsbox_key, :route,:from,:type
+
+    def initialize
+      @logging = false
+      @type = 'TextSMS'
+      @sms_provider_name = nil
+      @smsbox_user_name = nil
+      @smsbox_key = nil
+      @route = nil
+      @from = nil
+    end
+  end
+end

data/lib/meta_sms/meta_sms_error.rb

@@ -0,0 +1,15 @@
+module MetaSms
+
+  # This is a class for custom error in meta_sms.
+  # This method will be used to raise exceptions regarding meta_sms gem.
+  #
+  # @author Shobhit Dixit
+  class MetaSmsError < StandardError
+
+    def initialize(msg="")
+      super
+    end
+
+  end
+
+end

data/lib/meta_sms/providers/i_sms_provider.rb

@@ -0,0 +1,56 @@
+require 'meta_sms/providers/provider_utility'
+
+module MetaSms
+
+  # ISmsProvider acts as an interface for all sms providers in this gem.
+  # It has a method send_sms, which every sms provider class must override or else error will be thrown.
+  # There is a constant REQUIRED_OPTIONS, which represents the required options in order to send message.
+  # for now, message_text and mobile_number is the only options that are required.
+  # 
+  #
+  # => 'Sms provider class' refers to the class which is a sms service provider and which inherits ISmsProvider. eg: providers/sms_box.rb
+  # @author Shobhit Dixit
+  class ISmsProvider
+
+    REQUIRED_OPTIONS = [:message_text, :mobile_number]
+
+    # Initialize options
+    #
+    # @param [Hash] options
+    # @example {:message_text* => "Some text message", :mobile_number* => 7894561237, :logging => boolean, :metadata =>json }
+    # @note here message_text and mobile_number are required params and others are optional
+    # @author Shobhit Dixit
+    def initialize(options)
+      @options = options
+    end
+
+    # Method to overide in every sms provider class in order to send sms
+    #
+    # @raise NotImplementedError
+    # @author Shobhit Dixit
+    def send_sms
+      raise NotImplementedError, "send_sms"
+    end
+
+    # This method checks the presence of the value of the required options key
+    # This is called in sms provider class.
+    #
+    # @param [Symbol] required_option_key one of the keys of @options whose presence needs to be checked.
+    # @return [Object] returned object can be string or object depending upon the value of the key in @options.
+    # @author Shobhit Dixit
+    def check_required_option(required_option_key)
+      value = @options[required_option_key]
+      if value.blank?
+        ProviderUtility.raise_error_for_blank_value(required_option_key)
+      else
+        value
+      end
+    end
+
+    def check_for_valid_mobile_number(mobile_number)
+      mobile_number
+    end
+
+  end
+
+end

data/lib/meta_sms/providers/provider_utility.rb

@@ -0,0 +1,59 @@
+require "meta_sms/meta_sms_error"
+
+module MetaSms
+
+  # This is a utility class for sms providers. This encapsulates some common class methods as
+  # => raise_low_balance_exception
+  #    This method will be used to raise an exception if the balance in sms service provider account is low.
+  #    This method can be called in the respective sms provider class. eg: sms_box.rb.
+  # => raise_error_for_blank_value
+  #    This method is used to raise ArgumentError. This can be called in the sms_provider_interface (i_sms_provider) in order to raise the exception is value of any
+  #    required option is blank.
+  # => check_required_config_param
+  #    This method is used to check presence of required config variables. It can be called in the respective sms provider class. eg: sms_box.rb.
+  #
+  # @author Shobhit Dixit
+  class ProviderUtility
+
+    # This method is used to check presence of required config variables
+    #
+    # @param [String/Symbol] config_param parameters define in config file
+    # @raise ArgumentError if the value of the config param is blank
+    # @return [Object] Value can be string or an object depending upon the value config variable
+    # @author Shobhit Dixit
+    def self.check_required_config_param(config_param)
+      value = eval "MetaSms.config.#{config_param}"
+      if value.blank?
+        raise ArgumentError.new "Property #{config_param} is not found. Please check required parameters in initializer file (config/initializers/meta_sms.rb)."
+      end
+      value
+    end
+
+    # This method will raise ArgumentError
+    #
+    # @param [Symbol/String] key of the @options in i_sms_provider
+    # @raise ArgumentError
+    # @author Shobhit Dixit
+    def self.raise_error_for_blank_value(key)
+      raise ArgumentError.new "No #{key} found."
+    end
+
+    # This method will raise low balance error
+    #
+    # @raise StandardError
+    # @author Shobhit Dixit
+    def self.raise_low_balance_exception
+      raise MetaSmsError.new "Your balance is low for sending message."
+    end
+
+    # This method will raise authentication error
+    #
+    # @raise SecurityError
+    # @author Shobhit Dixit
+    def self.authentication_error
+      raise SecurityError.new 'Authentication Failed. Please Try Again.'
+    end
+
+  end
+
+end

data/lib/meta_sms/providers/smsbox.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+
+module MetaSms
+
+  # This is a sms provider class which inherits ISmsProvider.
+  #
+  # @author Shobhit Dixit
+  class Smsbox < ISmsProvider
+
+    SMSBOX_PUBLIC_API_URI = "http://smsbox.in/SecureApi.aspx?"
+
+    # Smsbox required config params = smsbox_user_name, smsbox_key, route, from
+    # Smsbox optional config params = type, logging
+
+    REQ_CONFIG_PARAMS = [:smsbox_user_name, :smsbox_key, :route, :from]
+
+    # Description of method
+    # @overide
+    # @return [Type] description of returned object
+    # @author Shobhit Dixit
+    def send_sms
+      res = Net::HTTP.get parsed_uri
+      case res
+      when "Error : Authentication Failed. Please Try Again"
+        ProviderUtility.authentication_error
+      when "Error : Your balance is low for sending message."
+        ProviderUtility.raise_low_balance_exception
+      end
+      res
+    end
+
+    def parsed_uri
+      URI.parse(URI.encode(api_url.strip))
+    end
+
+    # This method will make an api url
+    #
+    # @return [String] api_url
+    # @author Shobhit Dixit
+    def api_url
+      "#{SMSBOX_PUBLIC_API_URI}usr=#{smsbox_user_name}&key=#{smsbox_key}&smstype=#{MetaSms.config.type}&to=#{mobile_number}&msg=#{message_text}&rout=#{route}&from=#{from}"
+    end
+
+
+    # This will dynamically generate methods at run time. Method name will be same as the REQ_CONFIG_PARAMS key.
+    # These methods are used in .api_url
+    #
+    # @see ProviderUtility.check_required_config_param
+    # @author Shobhit Dixit
+    REQ_CONFIG_PARAMS.each do |param|
+      define_method "#{param}" do
+        ProviderUtility.check_required_config_param param
+      end
+    end
+
+    # This will dynamically generate methods. Method name will be same as the REQUIRED_OPTIONS key.
+    # These methods are used in .api_url
+    #
+    # @see .check_required_option
+    # @author Shobhit Dixit
+    REQUIRED_OPTIONS.each do |option|
+      define_method "#{option}" do
+        check_required_option option
+      end
+    end
+
+  end
+end

data/lib/meta_sms/sms_logging.rb

@@ -0,0 +1,35 @@
+module MetaSms
+
+  # This is an ActiveRecord class. It is used to save sms log in db.
+  #
+  # @author Shobhit Dixit
+  class SmsLogging < ActiveRecord::Base
+
+    # Description of method
+    #
+    # @param [String] result of .send_sms method in provider class
+    # @param [Hash] options provided in ISmsProvider
+    # @param [Error] error raised by .send_sms method in provider class
+    # @author Shobhit Dixit
+    def self.log_sms(result, options, error)
+      if ActiveRecord::Base.connection.table_exists? self.table_name
+        SmsLogging.create( SmsLogging.get_sms_logging_object(result, options, error) )
+      else
+        raise StandardError.new "No table exists. Please run 'rails g meta_sms:migrations_for_logger' and then run 'rake db:migrate'. To disable this warning, make config.logging=false, in config/initializers/meta_sms.rb."
+      end
+    end
+
+    def self.get_sms_logging_object(result, options, error)
+      sms_logging_object = {
+        message_text: options[:message_text],
+        mobile_number: options[:mobile_number],
+        error_message: error.try(:message)
+      }
+      metadata = options[:metadata]
+      sms_logging_object[:metadata] = {:response => result}.as_json
+      sms_logging_object[:metadata].merge(metadata) if metadata.present?
+      sms_logging_object
+    end
+
+  end
+end

data/lib/meta_sms/sms_provider_selector.rb

@@ -0,0 +1,32 @@
+module MetaSms
+
+  # This class is to select sms service provider. Requiring of the provider class is also done dynamically.
+  # Selection and dynamic require is done on the basis of config variable MetaSms.config.sms_provider_name.
+  #
+  # @author Shobhit Dixit
+  class SmsProviderSelector
+
+    # constant to keep track of sms providers
+    # naming convention: keys of SMS_PROVIDERS shall be used in config of meta_sms.rb initializer
+    # and value should be same as the name of the class of sms provider.
+    # also, the name of the class will be snake cased to require the class file
+    # for eg, for smsbox, there is a file named smsbox.rb in providers folder and the name of the class is Smsbox.
+    # @author Shobhit Dixit
+    SMS_PROVIDERS = {
+      :smsbox => "Smsbox"
+    }
+
+    #
+    # @author Shobhit Dixit
+    def initialize
+      @sms_provider_class_name = SMS_PROVIDERS[MetaSms.config.sms_provider_name]
+      raise ArgumentError.new 'No or wrong provider found. Please add a correct provider name in config/initializers/meta_sms.rb' if @sms_provider_class_name.blank?
+      require "meta_sms/providers/#{@sms_provider_class_name.underscore}"
+    end
+
+    def provider_class
+      (eval @sms_provider_class_name)
+    end
+
+  end
+end

data/lib/meta_sms/utility.rb

@@ -0,0 +1,18 @@
+module MetaSms
+
+  # This is a utility class for meta_sms. This encapsulates some common class methods as
+  #    #logging?
+  #    This method will be used to check whether logging of sms is required or not.
+  #
+  # @author Shobhit Dixit
+  class Utility
+
+    # @return [Boolean] true if logging is true in config initializer or in @options, else false
+    # @author Shobhit Dixit
+    def self.logging?(logging=nil)
+      logging == true || MetaSms.config.logging == true
+    end
+
+  end
+
+end

data/lib/meta_sms/version.rb

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

data/lib/meta_sms.rb

@@ -0,0 +1,67 @@
+require 'meta_sms/sms_provider_selector'
+require 'meta_sms/providers/i_sms_provider'
+require 'meta_sms/providers/smsbox'
+require 'meta_sms/configuration'
+require 'meta_sms/sms_logging'
+require 'meta_sms/utility'
+
+# This module is use to send sms through sms providers as sms box.
+# It contains a class method #send_sms which takes a hash as argument.
+# #send_sms will send sms, log sms if logging is enabled ((in options or config.logging) and migrations_for_logger is generated and migrated.)
+# Some inportant classes of module MetaSms are:
+# => Config
+# Config is for containg the config variables required in the process of sending sms and logging results in db.
+# => SmsProviderSelector
+# MetaSms#send_sms uses SmsProviderSelector class to select the provider from the given lists of provider in the gem
+# on the basis of the configuration variable, sms_provider_name.
+# => ISmsProvider
+# It acts as an interface for all the providers. So, in order to use sms provider class, we shall create an object
+# of sms provider, which in turn use the constructor of ISmsProvider. This constructor takes options as an argument.
+# options is a hash in which :message_text and :mobile_number is the required keys. Other optional keys can be
+# :logging, :metadata. Here, :message_text will be the message sen to the user with mobile number as :mobile_number.
+# :logging represents whether logging of this message is required in the database or not. There is a config variable
+# logging, which also determines the same. So, logging will be true, if any of these value is true. :metadata can be
+# any json data that client wants to save in the db along with the log.
+# => Smsbox
+# Smsbox is the sms provider class. It will have a method send_sms, which overrides the method of its parent class, ISmsProvider.
+# Smsbox.send_sms will send message if required options and required configuration variable are present else, it will
+# raise error. MetaSms#send_sms will rescue the error, write the log and then throw the rescued error.
+# @note Here error from sms_logging is not handled.
+# => SmsLogging
+# This is an active record responsible to log data into database. It will save the sms log into a sms_loggings table.
+# SmsLogging#log_sms is the method which does saving job. This method will raise StandardError if
+# config.logging or options[:logging] is true and you have not executed, 'rails g meta_sms:migrations_for_logger'.
+#
+#
+# @author Shobhit Dixit
+module MetaSms
+
+  # This class method is use to send sms through this gem.
+  #
+  # @param [Hash] options
+  # @example {:message_text* => "Some text message", :mobile_number* => 7894561237, :logging => boolean, :metadata =>json }
+  # @note here message_text and mobile_number are required params and others are optional
+  #
+  # @raise MetaSmsError (for now, only-if balance is low)
+  # @raise SecurityError (for when service provider Authentication Failed)
+  # @raise StandardError (for when logging is true but no table for sms_loggings)
+  # @return [Type] description of returned object
+  # @author Shobhit Dixit
+  def self.send_sms(options)
+    provider_class = SmsProviderSelector.new.provider_class
+    pc = provider_class.new(options)
+    error = nil
+    begin
+      result = pc.send_sms
+    rescue MetaSmsError => meta_sms_error
+      error = meta_sms_error
+    rescue SecurityError => security_error
+      error = security_error
+    end
+    # This will raise an standard error if no table is present and logging is true.
+    SmsLogging.log_sms(result, options, error) if Utility.logging?(options[:logging])
+    raise error if error.present?
+    result
+  end
+
+end

data/lib/tasks/meta_sms_tasks.rake

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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: meta_sms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shobhit Dixit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+description: Description of MetaSms.
+email:
+- shobhit.dixit@metacube.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/meta_sms/install_generator.rb
+- lib/generators/meta_sms/migrations_for_logger_generator.rb
+- lib/generators/meta_sms/templates/meta_sms_initializer.rb
+- lib/generators/meta_sms/templates/migrations/create_sms_loggings.rb
+- lib/meta_sms.rb
+- lib/meta_sms/configuration.rb
+- lib/meta_sms/meta_sms_error.rb
+- lib/meta_sms/providers/i_sms_provider.rb
+- lib/meta_sms/providers/provider_utility.rb
+- lib/meta_sms/providers/smsbox.rb
+- lib/meta_sms/sms_logging.rb
+- lib/meta_sms/sms_provider_selector.rb
+- lib/meta_sms/utility.rb
+- lib/meta_sms/version.rb
+- lib/tasks/meta_sms_tasks.rake
+homepage: https://github.com/shobhit-m/meta_sms
+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.6.12
+signing_key: 
+specification_version: 4
+summary: MetaSms is a gem used to send sms via rails application.
+test_files: []