smsc-ar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2b10b8a052dd82bbc9170a55c50eddc17ff1f4a
+  data.tar.gz: 0e4d92b3043a23fe69dc6448ba036a664045d246
+SHA512:
+  metadata.gz: 2dd468c1b1827476e6c47f4aaf68ca51b2fe3f436d81945a23b03979f305d5329c87ee866ce33200e7420e35d7d8c6e6eedce16819f6ac381d5e5f0e3a937678
+  data.tar.gz: d8b6dc2366cb787bb447cada6399d4382ef2e24d27e186de9e45787303d6204c0282c78174833f2d3b071c658d55484eb20a5d0b337d8d628b5bde0991b561c5

data/.gitignore

@@ -0,0 +1,9 @@
+/.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.2.1
+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 ezedepetris@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smsc-ar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ezequiel
+
+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 @@
+# Smsc::Rails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smsc/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smsc-ar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smsc-ar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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`, 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/ezedepetris/smsc-ar. 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,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 "smsc/rails"
+
+# 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/smsc.rb

@@ -0,0 +1,247 @@
+require 'open-uri'
+
+class Smsc
+  attr_reader :errors
+
+  def initialize(account, apiKey)
+    @alias = account
+    @apiKey = apiKey
+    @errors = []
+  end
+
+  ##
+  # Valid the phone number
+  # Return true if is a valid phone number
+  ##
+  def valid_phone?(number)
+    begin
+      response = run('evalnumero', nil, number)
+      response["data"]["estado"]
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Check the server status, return true if it's active, false in other case
+  ##
+  def active?
+    begin
+      response = run('estado')
+      response["code"] == 200
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Check the server status
+  # Return hash with the keys :code, :message
+  # code: is the status of the server response, 200 its oky!
+  # message: is the message if the query to the serve has problems
+  ##
+  def status
+    begin
+      response = run('estado')
+      { code: response["code"], message: response["message"] }
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Check the balanca on Smsc
+  # return the value balance or false in case of error
+  ##
+  def balance
+    begin
+      response = run('saldo')
+      response["data"]["mensajes"]
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Cancel all messages enqueued
+  ##
+  def cancel_queue
+    begin
+      response = run('cancelqueue')
+      response["code"] == 200
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Chek the messages enqueued to send later
+  # by default the parameter is 0
+  # param priority 0:all 1:low 2:middle 3:high
+  # return an array with all messages enqueued with te priority specified
+  ##
+  def enqueued(priority=0)
+    begin
+      response = run('encolados', nil, nil, nil, nil, priority)
+      response["data"]["mensajes"]
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # ###########################################
+  # ########   Method to send a SMS   #########
+  # ###########################################
+  #
+  ##
+  # take 3 params, num, msj time
+  # num: is the phone number with code area included by the fault the api of Sms
+  #   require the phone number on format xxxx-xxxxxxxxx, but, if you have other 
+  #   format, you can check it with the method valid_phone?(phone_number)
+  # msj: is a string with the message to send, a message has "180(CHECK)"
+  #   characters, if you include more characters, so you're sending two messages
+  # time: this by default is nil, in case you specified this parameter
+  #   the message will be enqueue at the datetime specified
+  #   with the format "YYYY-MM-DD HH:MM:SS"
+  #   Return true if the message was sended, false in other case
+  ##
+  def send(num, msj, time=nil)
+    begin
+      response = run('enviar', nil, num, msj, time)
+      response["code"] == 200
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # ###############################################
+  # ########  Methods for making queries   ########
+  # ###############################################
+  #
+  ##
+  # Return the lastest 30 messages received
+  # 
+  # You can specified an URL on https://www.smsc.com.ar/usuario/api/ then the
+  # App will make a get to the url specified, that means you receive a new 
+  # message 
+  # 
+  # you can add a paramater 'lastId' by default none, and you can check all
+  # messages recevided from the id specified.
+  ##
+  def received(lastId=nil)
+    begin
+      response = run('recibidos', lastId)
+      response["data"].map do |message|
+        {
+          id: message["id"],
+          date: message["fechahora"],
+          message: message["mensaje"],
+          from: message["de"],
+          phone: message["linea"]
+        }
+      end
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  ##
+  # Return the lastest 30 smsc messages sent
+  # 
+  # you can add a paramater 'lastId' by default none, and you can check all
+  # messages sent from the id specified.
+  ##
+  def sent(lastId=nil)
+    begin
+      response = run('enviados', lastId)
+      response["data"].map do |message|
+        {
+          id: message["id"],
+          date: message["fechahora"],
+          message: message["mensaje"],
+          recipients: message["destinatarios"].map do |recipient|
+            { 
+              code_area: recipient["prefijo"],
+              phone: recipient["fijo"],
+              status: recipient["enviado"]["estado_desc"]
+            }
+          end
+        }
+      end
+    rescue => e
+      error(response["code"])
+      false
+    end
+  end
+
+  def errors?
+    @errors.any?
+  end
+
+  private
+
+  def run(cmd=nil, lastId=nil, num=nil, msj=nil, time=nil, priority=nil)
+    query = "https://www.smsc.com.ar/api/0.3/?alias=#{@alias}&apikey=#{@apiKey}&cmd=#{cmd}"
+    options = []
+    if msj.present?
+      options << "msj=#{msj}"
+    end
+
+    if num.present?
+      options << "num=#{num}"
+    end
+
+    if lastId.present?
+      options << "ultimoid=#{lastId}"
+    end
+
+    if priority.present?
+      options << "prioridad=#{priority}"
+    end
+
+    if time.present?
+      options << "time=#{time}"
+    end
+    query += "&#{options.join('&')}" if options.present?
+
+    begin
+      JSON.parse open(query).read
+    rescue => e
+      { code: 500 }
+    end
+  end
+
+  def error(code)
+    @errors = []
+    case code.to_i
+      when 400 
+        @errors << "Parameter not specified"
+      when 401 
+        @errors << "Unauthorized access"
+      when 402 
+        @errors << "Unrecognized command"
+      when 403 
+        @errors << "Wrong number"
+      when 404 
+        @errors << "You must specify at least one valid number"
+      when 405 
+        @errors << "You don't have balance in your account"
+      when 406 
+        @errors << "You have exceeded the daily sms limit"
+      when 499 
+        @errors << "Unknown error"
+      else
+        @errors << "Server error"
+    end
+  end
+end

data/smsc-ar.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "smsc-ar"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Ezequiel Depetris"]
+  spec.email         = ["ezedepetris@gmail.com"]
+
+  spec.homepage      = "https://github.com/ezedepetris/smsc-ar"
+  spec.summary       = "A library to send/receive sms on Argentina."
+  spec.description   = "A library to send/receive sms Argentina using the app smsc (www.smsc.com.ar)"
+  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_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: smsc-ar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ezequiel Depetris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 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: A library to send/receive sms Argentina using the app smsc (www.smsc.com.ar)
+email:
+- ezedepetris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smsc.rb
+- smsc-ar.gemspec
+homepage: https://github.com/ezedepetris/smsc-ar
+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.6
+signing_key: 
+specification_version: 4
+summary: A library to send/receive sms on Argentina.
+test_files: []