clickatellsend 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 031142ea4bcf72b0265e386b0423cfbd72ed2a11
+  data.tar.gz: 32cb1fd34e7c9c152ca8ffdf8705cb2412feddbf
+SHA512:
+  metadata.gz: a1131a1afbb1d3efb1530d80004c77672212287460f4170fe6605fdef919f3a1cee5c5a49dfafef5b26a468e65c065cb4f9f1d05819ef63848fe065e69f8fae8
+  data.tar.gz: ca7bb1c6b567563550dc9e7fd1456f4becb87611cd208fefe79e04a9dd8a6db2dbaf72e23274216a98e1f4d07124900d7f91abf82d66f42ef38d3502a99347f3

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at humber.m23@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clickatellsend.gemspec
+gemspec
+gem 'rest-client'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 xploshioOn
+
+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,126 @@
+# Clickatellsend
+
+To use this gem you need to be registered in www.clicktell.com, and get an API ID. You can use almost every function of the clickatell API in a simple way,
+
+TODO: Create parser for the callbacks of the clickatell API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clickatellsend'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clickatellsend
+
+then run the generator:
+
+    $ rails g clickatellsend
+
+and go to config/initializers/clickatellsend.rb and fill with your credentials
+
+```ruby
+require 'clickatellsend'
+CLICKATELL_URL = "http://api.clickatell.com/"
+CLICKATELL_USER = ENV['clickatell_user']
+CLICKATELL_PASSWORD = ENV['clickatell_password']
+CLICKATELL_API_ID = ENV['clickatell_api_id']
+```
+
+## Usage
+
+we can use of the methods of the API in this way, perform a new request and receive the result in a json format
+
+## Get a session ID
+if you later don't want to send the messages with user and password
+```ruby
+request = Clickatellsend::Request.new
+session = request.auth
+
+message = request.send_msg(:to => 584141571411, :text => "I don't know", :session_id => session["OK"])
+```
+
+## Prevent the session expiring
+```ruby
+request = Clickatellsend::Request.new
+session = request.auth
+
+ping = request.prevent_expiring(:session_id => session["OK"])
+```
+
+## Send Message
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => 584141571411, :text => "I don't know")
+```
+
+## Send Message with delay
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => 584141571411, :text => "I don't know", :deliv_time => 15) #15 minutes
+```
+
+## Send Message to multiple recipients
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => "584141571411,1234,22234535456", :text => "I don't know")
+```
+
+## Get balance
+```ruby
+request = Clickatellsend::Request.new
+balance = request.get_balance
+```
+
+## Get message charge
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => 584141571411, :text => "I don't know")
+
+charge = request.get_msg_charge(:apimsgid => message["ID"])
+```
+
+## Route coverage
+```ruby
+request = Clickatellsend::Request.new
+coverage = request.route_coverage(:msisdn => 584141571411)
+```
+
+## Get message status
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => 584141571411, :text => "I don't know")
+
+status = request.get_msg_status(:apimsgid => message["ID"])
+```
+
+## Stop a message
+```ruby
+request = Clickatellsend::Request.new
+message = request.send_msg(:to => 584141571411, :text => "I don't know", :deliv_time => 15) #15 minutes
+
+stop = request.stop_msg(:apimsgid => message["ID"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xploshioOn/clickatellsend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clickatellsend"
+
+# 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/clickatellsend.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clickatellsend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clickatellsend"
+  spec.version       = Clickatellsend::VERSION
+  spec.authors       = ["xploshioOn"]
+  spec.email         = ["humber.m23@gmail.com"]
+
+  spec.summary       = %q{Gem to work with Clickatell SMS Gateway API}
+  spec.description   = %q{You can use almost every function of the clickatell API in a simple way}
+  spec.homepage      = "https://github.com/xploshioOn/clickatellsend"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "rest-client", "~> 1.6"
+end

data/lib/clickatellsend/clickatell_request.rb

@@ -0,0 +1,71 @@
+module Clickatellsend
+	class Request
+
+	  def initialize()
+	    @url = CLICKATELL_URL
+		  @user = CLICKATELL_USER
+		  @password = CLICKATELL_PASSWORD
+		  @api_id = CLICKATELL_API_ID
+	  end
+
+	  # :to, :text, :deliv_time
+	  def send_msg(params)
+			response(RestClient.get "#{@url}http/sendmsg", {:params => options(params)})
+	  end
+
+	  def get_balance
+	  	response(RestClient.get "#{@url}http/getbalance", {:params => options({})})
+	  end
+
+	  # :apimsgid
+	  def get_msg_charge(params)
+	  	response(RestClient.get "#{@url}http/getmsgcharge", {:params => options(params)})
+	  end
+
+	  # :msisdn
+	  def route_coverage(params)
+	  	response(RestClient.get "#{@url}utils/routecoverage", {:params => options(params)})
+	  end
+
+	  # :apimsgid
+	  def get_msg_status(params)
+	  	response(RestClient.get "#{@url}http/querymsg", {:params => options(params)})
+	  end
+
+	  # :apimsgid
+	  def stop_msg(params)
+	  	response(RestClient.get "#{@url}http/delmsg", {:params => options(params)})
+	  end
+
+	  def auth
+	  	response(RestClient.get "#{@url}http/auth", {:params => options({})})
+	  end
+
+	  # :session_id
+	  def prevent_expiring(params)
+	  	response(RestClient.get "#{@url}http/ping", {:params => params})
+	  end
+
+	  private
+
+	  	def options(params)
+	  		if params[:session_id]
+	  			params.merge({:api_id => @api_id})
+	  		else
+	  			params.merge({:user => @user, :password => @password, :api_id => @api_id})
+	  		end
+	  	end
+
+	  	def response(request)
+	  		if request.code == 200
+		  			response = request.split("\n").map{|l| l.scan /(\w+):\s($|[\w, \d.]+)(?:\s|$)/}.map &:to_h
+		  			if response.size == 1
+		  				response[0]
+		  			end
+		  	else
+		  		{:ERR => "Could not connect to the API, double check your settings and internet connection"}
+		  	end
+	  	end
+
+	end
+end

data/lib/clickatellsend/version.rb

@@ -0,0 +1,3 @@
+module Clickatellsend
+  VERSION = "1.0.0"
+end

data/lib/clickatellsend.rb

@@ -0,0 +1,4 @@
+require "clickatellsend/version"
+require "rest-client"
+
+require "clickatellsend/clickatell_request"

data/lib/generators/clickatellsend_generator.rb

@@ -0,0 +1,6 @@
+class ClickatellsendGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  def create_initializer_file
+    copy_file "clickatellsend.rb", "config/initializers/clickatellsend.rb"
+  end
+end

data/lib/generators/templates/clickatellsend.rb

@@ -0,0 +1,5 @@
+require 'clickatellsend'
+CLICKATELL_URL = "http://api.clickatell.com/"
+CLICKATELL_USER = "your user"
+CLICKATELL_PASSWORD = "your password"
+CLICKATELL_API_ID = "your api id"

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: clickatellsend
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- xploshioOn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-06 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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: You can use almost every function of the clickatell API in a simple way
+email:
+- humber.m23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clickatellsend.gemspec
+- lib/clickatellsend.rb
+- lib/clickatellsend/clickatell_request.rb
+- lib/clickatellsend/version.rb
+- lib/generators/clickatellsend_generator.rb
+- lib/generators/templates/clickatellsend.rb
+homepage: https://github.com/xploshioOn/clickatellsend
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem to work with Clickatell SMS Gateway API
+test_files: []