smsc-ar 0.0.1 → 1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b10b8a052dd82bbc9170a55c50eddc17ff1f4a
-  data.tar.gz: 0e4d92b3043a23fe69dc6448ba036a664045d246
+  metadata.gz: 2533f62ee9b3bb68e1ebd28dc868e57a999ad69c
+  data.tar.gz: 71859f691402a3090c214b818d0c2dac241e0184
 SHA512:
-  metadata.gz: 2dd468c1b1827476e6c47f4aaf68ca51b2fe3f436d81945a23b03979f305d5329c87ee866ce33200e7420e35d7d8c6e6eedce16819f6ac381d5e5f0e3a937678
-  data.tar.gz: d8b6dc2366cb787bb447cada6399d4382ef2e24d27e186de9e45787303d6204c0282c78174833f2d3b071c658d55484eb20a5d0b337d8d628b5bde0991b561c5
+  metadata.gz: ff11b8b99efc7992f9a867659d889b02beb841712480a9b05a4c29adb3220a3e204a03dafe1fb912303a362c5815d062bedc6ab25104a0c50e83d5ae49bc0220
+  data.tar.gz: e55a2fabed3132dcb2eea93307ccdc8c759898280884bace7570a2036336ed97f1df2211e5970b29684ee7271a9bc47bec35a40fe4870c855c1decaf39d3428b

data/README.md

@@ -1,15 +1,13 @@
-# Smsc::Rails
+# Smsc-ar
 
-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
+Welcome to smc-ar the gem to send sms via (www.smsc.com.ar).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'smsc-ar'
+gem 'smsc-ar', '~> 0.0.1'
 ```
 
 And then execute:
@@ -22,7 +20,79 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a instance
+```ruby
+sms = Smsc.new("your_alias", "your_apikey")
+```
+And then..
+Check if the service is active
+```ruby
+sms.active?
+
+# => true
+```
+Check the service status 
+```ruby
+sms.status
+
+# => {:code=>200, :message=>""}
+```
+Check your account balance
+```ruby
+sms.balance
+
+# => 557
+```
+Check the messages received
+```ruby
+sms.received
+
+# => {:id=>"8324966", :date=>"2017-07-19T02:01:02Z", :message=>"#14691 message test", :from=>"0", :phone=>"0"}
+```
+Check the messages sent
+```ruby
+sms.sent
+
+# => {:id=>"8889563", :date=>"2017-08-09T00:51:52Z", :message=>"#14691 message test", :recipients=>[{:code_area=>"3584", :phone=>"316256", :status=>"Entregado"}]}
+```
+Send a SMS
+```ruby
+sms.send("your_phone_number", "your_message") # Example sms.send("0358-154316256","Hey, Casper, Are you there?")
+
+# => true
+```
+See the messages enqueued to send later
+```ruby
+# priority 0:all 1:low 2:mid 3:hight
+
+sms.enqueued(0)
+
+# => 7234
+```
+Check if the number is valid to send a sms
+```ruby
+sms.valid_phone?('0358-154316256')
+
+# => true
+```
+Cancel all messages enqueued
+```ruby
+sms.cancel_queue
+
+# => true
+```
+Check if the last action have errors
+```ruby
+sms.errors?
+
+# => false
+```
+Retrieve the errors of the last action
+```ruby
+sms.errors
+
+# => "Unauthorized access"
+```
 
 ## Development
 

data/lib/smsc.rb

@@ -1,12 +1,11 @@
 require 'open-uri'
 
 class Smsc
-  attr_reader :errors
+  include ActiveModel::Model
 
   def initialize(account, apiKey)
     @alias = account
     @apiKey = apiKey
-    @errors = []
   end
 
   ##
@@ -14,8 +13,8 @@ class Smsc
   # Return true if is a valid phone number
   ##
   def valid_phone?(number)
+    response = run('evalnumero', nil, number)
     begin
-      response = run('evalnumero', nil, number)
       response["data"]["estado"]
     rescue => e
       error(response["code"])
@@ -27,13 +26,13 @@ class Smsc
   # 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
+    response = run('estado')
+    success = response["code"] == 200
+    raise 'NoSuccessCode' if !success
+    success
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
@@ -43,13 +42,11 @@ class Smsc
   # 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
+    response = run('estado')
+    { code: response["code"], message: response["message"] }
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
@@ -57,26 +54,24 @@ class 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
+    response = run('saldo')
+    response["data"]["mensajes"]
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
   # Cancel all messages enqueued
   ##
   def cancel_queue
-    begin
-      response = run('cancelqueue')
-      response["code"] == 200
-    rescue => e
-      error(response["code"])
-      false
-    end
+    response = run('cancelqueue')
+    success = response["code"] == 200
+    raise 'NoSuccessCode' if !success
+    success
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
@@ -86,13 +81,11 @@ class Smsc
   # 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
+    response = run('encolados', nil, nil, nil, nil, priority)
+    response["data"]["mensajes"]
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
@@ -103,7 +96,7 @@ class Smsc
   ##
   # 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 
+  #   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
@@ -113,13 +106,13 @@ class Smsc
   #   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
+    response = run('enviar', nil, num, msj, time)
+    success = response["code"] == 200
+    raise 'NoSuccessCode' if !success
+    success
+  rescue => e
+    error(response["code"])
+    false
   end
 
   ##
@@ -129,63 +122,59 @@ class Smsc
   #
   ##
   # 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 
-  # 
+  # 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
+    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
 
   ##
   # 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
+    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
 
   def errors?
-    @errors.any?
+    errors.any?
   end
 
   private
@@ -222,26 +211,25 @@ class Smsc
   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"
+      when 400
+        errors.add(:base, "Parameter not specified")
+      when 401
+        errors.add(:base, "Unauthorized access")
+      when 402
+        errors.add(:base, "Unrecognized command")
+      when 403
+        errors.add(:base, "Wrong number")
+      when 404
+        errors.add(:base, "You must specify at least one valid number")
+      when 405
+        errors.add(:base, "You don't have balance in your account")
+      when 406
+        errors.add(:base, "You have exceeded the daily sms limit")
+      when 499
+        errors.add(:base, "Unknown error")
       else
-        @errors << "Server error"
+        errors.add(:base, "Server error")
     end
   end
 end

data/smsc-ar.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "smsc-ar"
-  spec.version       = "0.0.1"
+  spec.version       = "1"
   spec.authors       = ["Ezequiel Depetris"]
   spec.email         = ["ezedepetris@gmail.com"]
 
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ruby", "~> 2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smsc-ar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '1'
 platform: ruby
 authors:
 - Ezequiel Depetris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: A library to send/receive sms Argentina using the app smsc (www.smsc.com.ar)
 email:
 - ezedepetris@gmail.com
@@ -91,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A library to send/receive sms on Argentina.