textlocal-india 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85963f9553b1cae985f0b35ccd9b7a26d3fb6d9f
+  data.tar.gz: a1642b9e5259d8607a0ee3950499d6019cc38876
+SHA512:
+  metadata.gz: 8b747ef753db3157a1a0a21b2829d01117ecd1dbc119633082509ac0dfc266be8578206fe7bd00587feead8fbfe4b8d042ea7d12343c2988dbb5bc6c7d7a96dd
+  data.tar.gz: 37e233ecbfb71e6c7bb2ccf358f35b8f018195fdc9e8655837fd1cba0b4883d0aaf76d4244818b79360c46fea2778be0a749661756769ba313397229b9ce0b4c

data/.gitignore

@@ -0,0 +1,10 @@
+<<<<<<< HEAD
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Sajan
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 sajan
+
+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,92 @@
+# textlocal-india
+Unofficial Ruby wrapper for **textlocal.in** API.
+
+## Installation
+
+Add:
+`gem 'textlocal-india', :git => 'https://github.com/sajan45/textlocal-india'` 
+or `gem 'textlocal-india'` to your `Gemfile`
+
+or install from Rubygems:
+Run `gem install textlocal-india`
+
+## Usage
+
+Configure the default settings
+
+```
+Textlocal.config do |c|
+  c.sender = "MYAPP"
+  c.username = "textlocal_username"
+  c.api_hash = "textlocal_hash"
+  c.test = false
+end
+```
+In above configuration, set `c.test = true` if you want to use API in test mode. This will not send message, hence no deduction of credit.
+
+Alternative to above configuration, you can just set environment variables for Textlocal username and hash and you are ready to go.
+
+```
+TEXTLOCAL_USER_NAME = "textlocal_username"
+TEXTLOCAL_API_HASH  = "textlocal_api_hash"
+```
+
+Sending SMS:
+```
+sms = Textlocal.send_message(message, numbers, options)
+ # Textlocal.send_message('hello world', '9853xxxxxx')
+status = sms.response[:status]      # can be 'success' or 'failure'
+```
+or you can create message manually:
+```
+msg = Textlocal::Message.new
+msg.message = "your order is received successfully"
+msg.numbers = ["9853xxxxxx"]
+msg.send!
+```
+`message` is a string type argument.
+`numbers` argument can be `string`, `integer` or `array` of `strings` or `integers`
+
+All of the below can be valid for numbers argument:
+* '9853xxxxxx'
+* 9853xxxxxx
+* ['9853xxxxxx', '9856xxxxxx']
+* ['8894xxxxxx', 7504xxxxxx]
+
+Every individual **Number** should be at least 10 character long, containing all numeric character.
+Below are valid individual numbers irrespective of string or integer:
+* 9876543210
+* 919876543210
+* +919876543210
+
+But numbers like *987654321* (less than 10 digit) or *98765abcde* (containing non numeric character) is not valid.
+
+#### Options
+The third optional argument for `send_message` method is a Hash object.
+* **sender** : You can override sender by passing a `sender` option.
+  `Textlocal.send_message('message', '9538xxxxxx', 'sender' => 'MYAPPS')`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sajan45/textlocal.
+
+## TODO
+
+* Support for bulk send
+* Support for more options like schedule time
+* Specs for features
+
+## Credits
+
+This gem was originally insipired from [txtlocal UK](https://github.com/epigenesys/txtlocal) gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "textlocal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/textlocal.rb

@@ -0,0 +1,29 @@
+require 'textlocal/config'
+require 'textlocal/message'
+require "textlocal/version"
+
+module Textlocal
+
+  class << self
+
+    def config
+      @config ||= Config.new
+      if block_given?
+        yield @config
+      end
+      @config
+    end
+
+    def reset_config
+      @config = nil
+    end
+
+    def send_message(message, numbers, options={})
+      msg = Textlocal::Message.new(message, numbers, options)
+      msg.send!
+      msg
+    end
+
+  end
+
+end

data/lib/textlocal/config.rb

@@ -0,0 +1,27 @@
+module Textlocal
+  class Config
+
+    # this can be overridden on a per-message basis
+    attr_accessor :sender
+
+    # The username of the Textlocal account to use when accessing the API
+    attr_accessor :username
+
+    # The API hash of the Textlocal account to use when accessing the API
+    attr_accessor :api_hash
+
+    # Access the API in test mode
+    attr_accessor :test
+
+    def initialize
+      @test = false
+      @username = ENV['TEXTLOCAL_USER_NAME']
+      @api_hash = ENV['TEXTLOCAL_API_HASH']
+    end
+
+    def testing?
+      !!@test
+    end
+
+  end
+end

data/lib/textlocal/message.rb

@@ -0,0 +1,103 @@
+require 'net/https'
+require 'uri'
+require 'json'
+require 'cgi'
+
+module Textlocal
+  class Message
+
+    attr_accessor :message
+    attr_accessor :numbers
+    attr_accessor :sender
+
+    attr_accessor :response
+
+    SMS_ENDPOINT = URI.parse("https://api.textlocal.in/send/?")
+
+    def initialize(message=nil, numbers=nil, options=nil)
+      self.message = message if message
+      self.numbers = numbers if numbers
+      self.options = options if options
+    end
+
+    def message=(message)
+      @message = CGI.escape(message)
+    end
+
+    def numbers
+      @numbers ||= []
+    end
+
+    def numbers=(numbers)
+      @numbers = []
+      if numbers.is_a?Array
+        numbers.map!(&:to_s)
+      else
+        numbers = numbers.to_s.split(',')
+      end
+      numbers.each do |num|
+        add_recipient(num)
+      end
+    end
+
+    def add_recipient(number)
+      number = number.gsub(/\s/, '')
+      number = case number
+        when /^91\d{10}$/
+          number
+        when /^(?:\+91)(\d{10})$/
+          "91#{$1}"
+        when /^(\d{10})$/
+          "91#{$1}"
+        else
+          return
+      end
+      @numbers << number
+    end
+
+    def sender
+      self.sender = Textlocal.config.sender unless @sender
+      @sender
+    end
+
+    def sender=(sender)
+      @sender = sender.strip.gsub(/[^\w]/, '').to_s[0, 11] if sender
+      if @sender && @sender.length < 6
+        @sender = nil
+      end
+    end
+
+    def options=(options)
+      self.sender = options[:sender] if options.has_key?(:sender)
+    end
+
+    def response=(response)
+      unless response.body.empty?
+        @response = {}
+        data = JSON.parse(response.body)
+        data.each_pair do |k, v|
+          key = k.gsub(/\B[A-Z]+/, '_\0').downcase.to_sym
+          @response[key] = v
+        end
+      end
+    end
+
+    def send!
+      http = Net::HTTP.new(SMS_ENDPOINT.host, SMS_ENDPOINT.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      req = Net::HTTP::Post.new(SMS_ENDPOINT.path)
+      params = {'username'=> Textlocal.config.username,
+                'hash' => Textlocal.config.api_hash,
+                'numbers' => numbers.join(','),
+                'message' => self.message,
+                'test'    => Textlocal.config.testing? ? true : false
+               }
+      params['sender'] = sender if sender
+      req.set_form_data(params)
+      result = http.start { |http| http.request(req) }
+      self.response = result
+    end
+  end
+end

data/lib/textlocal/version.rb

@@ -0,0 +1,3 @@
+module Textlocal
+  VERSION = "0.1.1"
+end

data/textlocal.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textlocal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textlocal-india"
+  spec.version       = Textlocal::VERSION
+  spec.authors       = ["sajan"]
+  spec.email         = ["sajan.sahu@live.com"]
+
+  spec.summary       = %q{Unofficial wrapper for textlocal.in API.}
+  spec.homepage      = "https://github.com/sajan45/textlocal"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: textlocal-india
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- sajan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- sajan.sahu@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/textlocal.rb
+- lib/textlocal/config.rb
+- lib/textlocal/message.rb
+- lib/textlocal/version.rb
+- textlocal.gemspec
+homepage: https://github.com/sajan45/textlocal
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Unofficial wrapper for textlocal.in API.
+test_files: []