telcosms 0.0.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0afe24f55d0a12aa9f4e19969a02bf83585aa228
-  data.tar.gz: 856779e9152c010379b8f6fe44f5e1b288afce40
+SHA256:
+  metadata.gz: 85d45dffa2b0a552ca474e0862a3411ad1465735157def71773025e7be443661
+  data.tar.gz: 85a5277888a400b5ea8ca5e77d9dcf73dd2a43147a22675d7e150f76f19efe7a
 SHA512:
-  metadata.gz: ca204fb28128dd035dd48e96ca55c9142c1b95f99ef1b69b98bb7d3007c202bc300b1cb2932b3c6e95d4efede3566aed46b49da1fdbd817e69598609923e3535
-  data.tar.gz: e306246dc2a7370ce2321bf5fa9bd25106fc7fdcdb42c0199659b03e2c30245c5b309b84a0f615c8b6bed1bab68eab45f7f7b6f60aa422767df96557b03a9f93
+  metadata.gz: 9dc01a28245e470c770da62d425810ddb714624017bdf6ff9fbe7a4eea18844b9cc2039654ddcdee7727d4b678d6533a9e654bdc55e4dc3b22cc1dfca8dca92a
+  data.tar.gz: 3c7afd6e6c5c8435bfd5c7a20af13f30faddad413496ba1c75d96c6424de6153a480811b7f66a381fb1f94e0daa079b731264fb242a7abcf4cc1ddcc55db5401

data/README.md

@@ -1,6 +1,6 @@
 # Telcosms
 
-A ruby gem createb by [SmartTechys](http://www.smarttechys.co.ao) for the [TelcoSMS](http://telcosms.co.ao) API that allows your application to send sms to Angolan Numbers.
+A ruby gem created by [Sergio Maziano](http://github.com/smaziano) for the [TelcoSMS](http://telcosms.co.ao) API that allows your application to send sms to Angolan Numbers.
 
 ## Installation
 
@@ -19,28 +19,32 @@ Or install it yourself as:
     $ gem install telcosms
 
 ## Setup
-Make sure you have access to your username and password that can be requested to the TelcoSMS crew.
+Make sure you have access to your username and password (can be requested to the TelcoSMS team)
+and setup as your environment variables.
 
-## Usage
+### Environment variables
+|Env Variable|Value|
+|-|-|
+|TELCOSMS_USERNAME| The username provided by TelcoSMS|
+|TELCOSMS_PASSWORD| The password provided by TelcoSMS|
 
+## Usage
+You need to pass 3 arguments to make it work (number, message, service).
 ```ruby
-## Use the class methods to get it going
-
-# New Message
-## You need to pass 5 arguments to make it work (numbers, message, username, password, servico)
-
-Telcosms.new_sms(numbers, message, username, password, servico)
-
-## numbers is an array of the numbers you want to send the sms.
-## message is a string os characters that contain the message.
-## username is a string with username given by the Telcosms crew(as best practive, use environment variable).
-## password is a string with password given by the Telcosms crew(as best practive, use environment variable).
-## servico is a string with the text that will show up as contact sender.
+telco = Telcosms.new
+telco.send(number: '+244923456789', message: 'Hello World\nNext line', service: 'TelcoSMS')
+```
+## Schema
+|field |type|notes|
+|-|-|-|
+|number|string|number with or without a country code|
+|message|string|the message content|
+|service|string|sender identifier |
 
 ## Help and Docs
 
 - [TelcoSMS](http://telcosms.co.ao)
-- [RDOC](http://www.rubydoc.info/gems/telcosms/0.0.4)
+- [RDOC](http://www.rubydoc.info/gems/telcosms/1.0.1)
 
 ## Development
 
@@ -58,5 +62,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/smazia
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/telcosms/version.rb

@@ -1,3 +1,3 @@
-module Telcosms
-  VERSION = "0.0.4"
+module TelcosmsModule
+  VERSION = "1.0.1"
 end

data/lib/telcosms.rb

@@ -1,14 +1,19 @@
-require "telcosms/version"
-require "httparty"
-
-module Telcosms
-	include HTTParty
-	base_uri "196.216.53.194:9501"
-  
-  # send a message
-  def self.new_sms(numbers, message, username, password, servico)
-  	numbers.each do |number|
-  		post("/api?action=sendmessage&username=#{username}&password=#{password}&recipient=#{number}&messagetype=SMS:TEXT&messagedata=#{message}&originator=#{servico}", :headers => {'Content-Type' => 'application/json'}).parsed_response
-		end
-  end	
-end
+require_relative "telcosms_module"
+
+class Telcosms
+  include TelcosmsModule
+
+  def initialize(username: set_username, password: set_password, service: nil)
+    @username = username
+    @password = password
+  end
+
+  private
+    def set_username
+      ENV.fetch('TELCOSMS_USERNAME')
+    end
+
+    def set_password
+      ENV.fetch('TELCOSMS_PASSWORD')
+    end
+end

data/lib/telcosms_module.rb

@@ -0,0 +1,28 @@
+require "telcosms/version"
+require "httparty"
+
+module TelcosmsModule
+  class Error < StandardError; end
+	include HTTParty
+  follow_redirects false
+	base_uri "196.216.53.194:9501"
+  
+  def send(number:, message:, service:)
+    content = set_headers
+    text = URI::Parser.new
+    request = HTTParty.post("#{host}/api?action=sendmessage&username=#{@username}&password=#{@password}&recipient=#{number}&messagetype=SMS:TEXT&messagedata=#{text.escape(message)}&originator=#{service}", content)
+    return request
+  end
+
+  private
+    def set_headers
+      content = {}
+      headers = {'Content-Type' => "application/json"}
+      content[:headers] = headers
+      content
+    end
+
+    def host
+      "http://196.216.53.194:9501"
+    end
+end

data/telcosms.gemspec

@@ -1,31 +1,27 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'telcosms/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "telcosms"
-  spec.version       = Telcosms::VERSION
+  spec.version       = TelcosmsModule::VERSION
   spec.authors       = ["Sergio Maziano"]
   spec.email         = ["sergio.maziano@gmail.com"]
 
-  spec.summary       = %q{A Ruby gem for TelcoSMS API(http://telcosms.co.ao) made by SmartTechys(http://www.smarttechys.co.ao)}
-  spec.description   = %q{A Ruby gem to connect your application with the TelcoSMS API(http://telcosms.co.ao) to allow your application to send sms through Angolan numbers}
+  spec.summary       = %q{A Ruby gem for TelcoSMS API(http://telcosms.co.ao) made by Sergio Maziano(http://github.com/smaziano)}
+  spec.description   = %q{A Ruby gem to connect your application with the TelcoSMS API's (http://telcosms.co.ao) to allow your application to send sms through Angolan numbers}
   spec.homepage      = "https://github.com/smaziano/telcosms"
   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"
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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_dependency 'httparty', "~> 0.13.7"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_dependency 'httparty', "~> 0.18.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telcosms
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Sergio Maziano
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,29 +30,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.7
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.7
-description: A Ruby gem to connect your application with the TelcoSMS API(http://telcosms.co.ao)
+        version: 0.18.1
+description: A Ruby gem to connect your application with the TelcoSMS API's (http://telcosms.co.ao)
   to allow your application to send sms through Angolan numbers
 email:
 - sergio.maziano@gmail.com
@@ -70,15 +70,13 @@ files:
 - bin/setup
 - lib/telcosms.rb
 - lib/telcosms/version.rb
-- telcosms-0.0.2.gem
-- telcosms-0.0.3.gem
+- lib/telcosms_module.rb
 - telcosms.gemspec
 homepage: https://github.com/smaziano/telcosms
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: A Ruby gem for TelcoSMS API(http://telcosms.co.ao) made by SmartTechys(http://www.smarttechys.co.ao)
+summary: A Ruby gem for TelcoSMS API(http://telcosms.co.ao) made by Sergio Maziano(http://github.com/smaziano)
 test_files: []