movile_sms 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d424ce4e29e7b818da4f0e14cfda93db5440d4a
-  data.tar.gz: f382473f308d0148730f7877431bc7e642ccdfcf
+  metadata.gz: 4b0bdfbdc5cfcfa2aa5977de9e7b793f70d21466
+  data.tar.gz: a85ffdca3d575afa798f23bb7a1486494ff407c6
 SHA512:
-  metadata.gz: 6eb2395522b34e7ba0a925755fac3c211fdf615a55a6259691efd0d2ed52057b65dffc375c84cd2cbb66da0b5254071e1e824adc641a5deff0570ae100b069c3
-  data.tar.gz: 3ef9a1edb44ebd718bc6d1ea264b2fdde0149f3f6b9cf683de60913b02ba171f856e5beae8a76be3517377fd7de6e29fb75d27b92abc7bd996a5aa7590e5991b
+  metadata.gz: 7fead189d170801fb1eb6eb8f8fd6a316f2ccb5588a22f908fcac9d2231dc56b10f1c3fa5bf1654a684863266113377df129a5afc6ddc4eef0cbfc859ea88a7c
+  data.tar.gz: 0c3b3f987ab668a353607e37c5bd8885787f995541adb8759fa796bb13f7cb34fb999bf3773872d59d34a85f1b2d8dd772452a21d6eebd5417c5a88ed18bebf6

data/.gitignore

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

data/README.md

@@ -20,13 +20,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installing the gem and registering with the movile API, instantiate the Sms class by passing its UserName and AuthenticationToken credentials.
 
-## Development
+```
+  sms =  Movile::SMS.new(username: 'Your User Name', access_token: 'Your Access Token')
+
+```
+
+After instantiating the Sms class by passing the authentication parameters, call the send_message method by passing the number and text parameters.
+
+Ps: It is mandatory to pass the country and state code before the number.
+
+```
+  sms.send_message('5511999999999', 'this is my message from movile_sms gem!')
+
+```
+
+To check the status of your message, you will need to invoke the status_message (uuid) method, passing the uuid returned in the send_message send method.
+
+```
+  sms.status_message('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
+
+```
+
+The following return must be displayed if the uuid is valid.
+
+```
+{
+  "id":"f9c100ff-aed0-4456-898c-e57d754c439c",
+  "correlationId":"client-id",
+  "carrierId":1,
+  "carrierName":"VIVO",
+  "destination":"5511900009999",
+  "sentStatusCode":2,
+  "sentStatus":"SENT_SUCCESS",
+  "sentAt":1266660300000,
+  "sentDate":"2010-02-20T10:05:00Z",
+  "campaignId":"64",
+  "extraInfo":"",
+}
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. 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
 

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
-task :default => :spec
-
+require 'bundler/gem_tasks'
+task default: :spec
 
 task :console do
-  exec "irb -r movile_sms -I ./lib"
-end
+  exec 'irb -r movile -I ./lib'
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "movile_sms"
+require 'bundler/setup'
+require 'movile_sms'
 
 # 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.
@@ -10,5 +10,5 @@ require "movile_sms"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/movile.rb

@@ -0,0 +1,8 @@
+require 'httparty'
+require 'json'
+require 'movile_sms/version'
+require 'movile_sms/sms'
+
+# movile/movile
+module Movile
+end

data/lib/movile_sms/sms.rb

@@ -1,30 +1,35 @@
-#require 'byebug'
-
-class Sms
+# lib/movile_sms/sms.rb
+class SMS
   include HTTParty
 
-  BASE_API_URL = 'https://api-messaging.movile.com/v1/send-sms'
+  BASE_API_URL = 'https://api-messaging.movile.com/v1/send-sms'.freeze
+
+  REPORT_API_URL = 'https://api-messaging.movile.com/v1/sms-status?id='.freeze
 
   def initialize(attributes)
-    @options = { 'UserName' => attributes[:username], 'AuthenticationToken' => attributes[:access_token], 'Content-Type' => 'application/json' }
+    @options['UserName'] = attributes[:username]
+    @options['AuthenticationToken'] = attributes[:access_token]
+    @options['Content-Type'] = 'application/json'
   end
 
   def send_message(number, text)
-    if valid_number?(number) and text_size(text)
-      body = { "destination" => number.to_s, "messageText" => text.to_s }.to_json
-      response = self.class.post(BASE_API_URL, headers: @options, body: body )
-    else
-      raise "Check if the imputed number #{number} is valid or if the text has a maximum of 162 characters
-"
-    end
+    raise 'Not Valid' unless numeric?(number) && valid_text?(text)
+    body = { 'destination' => number, 'messageText' => text }.to_json
+    response = self.class.post(BASE_API_URL, headers: @options, body: body)
+    response['id']
   end
 
-  def valid_number?(number)
-    true if Float(number) rescue false
+  def status_message(uuid)
+    response = self.class.get(REPORT_API_URL + uuid, headers: @options)
+    JSON.parse(response.body)
   end
 
-  def text_size(text)
-    text.size <= 162
+  # Return false if the value isn't a numeric value
+  def numeric?(number)
+    Float(number) ? true : false
   end
 
-end
+  def valid_text?(text)
+    text.size <= 160
+  end
+end

data/lib/movile_sms/version.rb

@@ -1,3 +1,3 @@
 module MovileSms
-  VERSION = "0.1.1"
+  VERSION = '0.1.3'.freeze
 end

data/movile_sms.gemspec

@@ -1,35 +1,35 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'movile_sms/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "movile_sms"
+  spec.name          = 'movile_sms'
   spec.version       = MovileSms::VERSION
-  spec.authors       = ["Leandro"]
-  spec.email         = ["lndr.figueredo@gmail.com"]
-  spec.summary       = %q{Send sms messages with Movile API.}
-  spec.description   = %q{Simple way to integrate and send messages with movile API}
-  spec.homepage      = ""
+  spec.authors       = ['Leandro']
+  spec.email         = ['lndr.figueredo@gmail.com']
+  spec.summary       = %('Send sms messages with Movile API.')
+  spec.description   = %('Simple integrate and send messages with movile API')
+  spec.homepage      = ''
 
-  # 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"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_dependency "httparty"
-  spec.add_dependency "json"
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'json'
+  spec.add_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: movile_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Leandro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,21 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple way to integrate and send messages with movile API
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "'Simple integrate and send messages with movile API'"
 email:
 - lndr.figueredo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/movile_sms.rb
+- lib/movile.rb
 - lib/movile_sms/sms.rb
 - lib/movile_sms/version.rb
 - movile_sms.gemspec
@@ -121,5 +134,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Send sms messages with Movile API.
+summary: "'Send sms messages with Movile API.'"
 test_files: []

data/.byebug_history

@@ -1,63 +0,0 @@
-exit
-File.expand_path File.dirname(__FILE__)
-Dir.now
-Dir
-require './lib/movile_sms'
-ls
-pwd
-exit
-next
-body.to_json
-body
-exit
-body.to_json
-body = {:destination => number, :messageText => text }
-body =  body: {:destination => number, :messageText => text }
-body =  body: { 'destination' => number, 'messageText' => text }
-body: body: { 'destination' => number, 'messageText' => text }
-body
-number
-self.class.post(BASE_API_URL, body: { 'destination' => number, 'messageText' => text }.to_json, headers: @options)
-self.class
-exit
-attributes[:username]
-attributes
-attrubutes
-continue
-@options
-@options.is_a? Hash
-exit
-@options.is_a? Array
-@options.is_a? Hash
-@options
-continue
-response
-continue
-next
-response
-next
-response
-next
-@options
-continue
-HTTParty.post(BASE_API_URL, @options)
-BASE_API_URL
-@options
-continue
-@options
-exit
-@options
-@options[:query]
-@options
-@@options
-@options
-exit
-#{base_api_url}
-Sms::base_api_url
-base_api_url
-continue
-@username
-next
-exit
-attributes[0]
-attributes

data/lib/movile_sms.rb

@@ -1,10 +0,0 @@
-require 'httparty'
-require 'json'
-require "movile_sms/version"
-require "movile_sms/sms"
-
-module MovileSms
-
-
-
-end