instasent 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73250272bd955b58b58dc7a74b6dab0b7b67bcf9
-  data.tar.gz: 5f72ad17b1421bfaf73b62a15460692e2c53c70c
+SHA256:
+  metadata.gz: 41a7baee0294e847f4f457a6b769392c6208741cda1527d002924a37770c926c
+  data.tar.gz: 7127f7615384e50ae81586788933bee837ea15aee941271b3b57b985fe0bc7ef
 SHA512:
-  metadata.gz: f2cea5ccd28ead6b018475eee63081ee9cebb9b6cb63956ceeae2fd51af96e049e98e3984430c35dd04f12f747f3abd28fef13cfcd91dd6aa378539f038a2f4a
-  data.tar.gz: 65028063d25f52b59f9b6a0afad92e285c7f5d625c7e7f64369307cde7525e9ebbd927edad27bc6ed74d28d08ee7fd6fd3461c72247024594c02a04822b40d3f
+  metadata.gz: 7fdbcd4f9c187b81060c0e9f522666f619a6ff8614a310cff57faf789ccf43f277abcad9eb236cf207bb4f884769c47a392548d51a155764ee6fe208a370a93a
+  data.tar.gz: ceba25db1469eb4b8c9aac8c1e666545efa9d86c28bb055c7ebb768907a2a03c9c705b6f726de03c6a5e0ee79f04cdb9c9dc69f40fabd06bfed22400018be844

data/README.md

@@ -1,47 +1,61 @@
-Welcome to __Instasent Ruby SDK__. This repository contains Instasent's Python SDK and samples for REST API.
+Welcome to __Instasent Ruby SDK__. This repository contains Ruby SDK for Instasent's REST API.
+
+# Notice!
+
+> **Verify** product is currently deprecated and will be removed in the next release. The same functionality can be easily implemented by sending an SMS. If you need help migrating please contact usage
 
 ## Installation
 
-The easiest way to install the instasent package is either via command line:
+The easiest way to install the SDK is via gem:
 
 ```
-$ gem install instasent
+gem install instasent
 ```
+
 And then execute:
 
-    $ bundle
+```
+bundle
+```
+
 or including the following in your Gemfile:
 
 ```
 gem 'instasent'
 ```
 
-## Example
-### Send an SMS
-You can check 'examples/send-sms.rb' file.
+# Usage
+
+Check the [examples directory](https://github.com/instasent/instasent-ruby-lib/tree/master/examples) to see working examples of this SDK usage
+
+### Sending an SMS
+
 ```ruby
 require 'instasent'
 
 client = Instasent::Client.new('my-token')
 
-response = client.send_sms('My company', '+34666666666', 'test message')
+response = client.send_sms('Company', '+34666666666', 'test message')
 
 puts response['response_code']
 puts response['response_body']
 ```
-## Available functions
+
+If you want to send an Unicode SMS (i.e with 😀 emoji) you only need to replace `send_sms` call to `send_sms_unicode`
+
+```ruby
+response = client.send_sms_unicode('Company', '+34666666666', 'Unicode test: ña éáíóú 😀')
+```
+
+## Available actions
+
 ```
 SMS
 client.send_sms(sender, to, text)
+client.send_sms_unicode(sender, to, text)
 client.get_sms(page, per_page)
 client.get_sms_by_id(message_id)
 
-VERIFY
-client.request_verify(sender, to, text); // text must include %token% string
-client.check_verify(id, token)
-client.get_verify_by_id(id)
-client.get_verify(page, per_page)
-
 LOOKUP
 client.do_lookup(to)
 client.get_lookup_by_id(id)
@@ -50,11 +64,13 @@ client.get_lookups(page, per_page)
 ACCOUNT
 client.get_account_balance()
 ```
-## Documentation
-Complete documentation at :
-[http://docs.instasent.com/](http://docs.instasent.com/).
+
+# Full documentation
+
+Full documentation of the API can be found at http://docs.instasent.com/
 
 # Getting help
 
-If you need help installing or using the library, please contact Instasent Support at support@instasent.com first.
-If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
+If you need help installing or using the SDK, please contact Instasent Support at support@instasent.com
+
+If you've instead found a bug in the library or have a feature request, go ahead and open an issue or pull request!

data/lib/instasent.rb

@@ -1,94 +1,55 @@
+# frozen_string_literal: true
+
 require "instasent/version"
 require "net/https"
 require "json"
 
 module Instasent
   class Client
+    @@secureChannel = "https://api.instasent.com/"
 
-    @@rootEndpoint = "http://api.instasent.com/"
-    @@secureChannel = "https://api.instasent.cdfom/"
-    @@use_secure_channel = TRUE
-
-    def initialize(token, use_secure_channel=true)
+    def initialize(token)
       @@token = token
-      @@use_secure_channel = use_secure_channel
     end
 
     def send_sms(sender, to, text, client_id='')
-
-      if @use_secure_channel
-        url = @@secureChannel + "sms/"
-      else
-        url = @@rootEndpoint + "sms/"
-      end
+      url = @@secureChannel + "sms/"
 
       http_method = 'POST'
 
       data = {'from' => sender, 'to' => to, 'text' => text}
 
-      response = self.execute_request(url, http_method, data)
-
-      return response
-
+      execute_request(url, http_method, data)
     end
 
-    def get_sms(page=1, per_page=10)
-
-      if @use_secure_channel
-        url = @@secureChannel + "sms/?page=" + page.to_s + "per_page=" + per_page.to_s
-      else
-        url = @@rootEndpoint + "sms/?page=" + page.to_s + "per_page=" + per_page.to_s
-      end
+    def send_sms_unicode(sender, to, text, client_id='')
+      url = @@secureChannel + "sms/"
 
-      http_method = 'GET'
-
-      response = self.execute_request(url, http_method)
+      http_method = 'POST'
 
-      return response
+      data = {'from' => sender, 'to' => to, 'text' => text, 'allowUnicode' => 'true'}
 
+      execute_request(url, http_method, data)
     end
 
-    def get_sms_by_id(id)
-
-      if @@use_secure_channel
-        url = @@secureChannel + 'sms/' + id
-      else
-        url = @@rootEndpoint + 'sms/' + id
-      end
+    def get_sms(page=1, per_page=10)
+      url = @@secureChannel + "sms/?page=" + page.to_s + "per_page=" + per_page.to_s
 
       http_method = 'GET'
 
-      response = self.execute_request(url, http_method)
-
-      return response
-
+      execute_request(url, http_method)
     end
 
-    def send_sms(sender, to, text, client_id='')
-
-      if @use_secure_channel
-        url = @@secureChannel + "sms/"
-      else
-        url = @@rootEndpoint + "sms/"
-      end
-
-      http_method = 'POST'
-
-      data = {'from' => sender, 'to' => to, 'text' => text}
-
-      response = self.execute_request(url, http_method, data)
+    def get_sms_by_id(id)
+      url = @@secureChannel + 'sms/' + id
 
-      return response
+      http_method = 'GET'
 
+      execute_request(url, http_method)
     end
 
     def request_verify(sender, to, text, token_length = '', timeout = '', client_id='')
-
-      if @@use_secure_channel
-        url = @@secureChannel + "verify/"
-      else
-        url = @@rootEndpoint + "verify/"
-      end
+      url = @@secureChannel + "verify/"
 
       http_method = 'POST'
       data = {'sms' => {'from' => sender, 'to' => to, 'text' => text}}
@@ -105,110 +66,64 @@ module Instasent
       #   data['clientId'] =  client_id
       # end
 
-      response = self.execute_request(url, http_method, data)
-
-      return response
-
+      execute_request(url, http_method, data)
     end
 
     def check_verify(id, token)
-
-      if @@use_secure_channel
-        url = @@secureChannel + 'verify/' + id + '?token=' + token
-      else
-        url = @@rootEndpoint + 'verify/' + id + '?token=' + token
-      end
+      url = @@secureChannel + 'verify/' + id + '?token=' + token
 
       http_method = 'GET'
 
-      response = self.execute_request(url, http_method, {})
-
-      return response
-
+      execute_request(url, http_method, {})
     end
 
     def get_verify_by_id(id)
-
-      if @@use_secure_channel
-        url = @@secureChannel + 'verify/' + id
-      else
-        url = @@rootEndpoint + 'verify/' + id
-      end
+      url = @@secureChannel + 'verify/' + id
 
       http_method = 'GET'
 
-      response = self.execute_request(url, http_method, {})
-
-      return response
-
+      execute_request(url, http_method, {})
     end
 
     def get_verify(page=1, per_page=10)
-
-      if @use_secure_channel
-        url = @@secureChannel + 'verify/?page=' + page.to_s + 'per_page=' + per_page.to_s
-      else
-        url = @@rootEndpoint + 'verify/?page=' + page.to_s + 'per_page=' + per_page.to_s
-      end
+      url = @@secureChannel + 'verify/?page=' + page.to_s + 'per_page=' + per_page.to_s
 
       http_method = 'GET'
 
-      response = self.execute_request(url, http_method)
-
-      return response
-
+      execute_request(url, http_method)
     end
 
     def do_lookup(to)
-
-      url =  if @use_secure_channel then @@secureChannel + 'lookup/' else @@rootEndpoint + 'lookup/' end
+      url =  @@secureChannel + 'lookup/'
       http_method = 'POST'
       data = {'to' => to}
 
-      response = self.execute_request(url, http_method, data)
-
-      return response
-
+      execute_request(url, http_method, data)
     end
 
     def get_lookup_by_id(id)
-
-      url =  if @use_secure_channel then @@secureChannel + 'lookup/' + id else @@rootEndpoint + 'lookup/' + id end
+      url =  @@secureChannel + 'lookup/' + id
       http_method = 'GET'
-      response = self.execute_request(url, http_method, {})
-
-      return response
-
+      execute_request(url, http_method, {})
     end
 
     def get_lookups(page=1, per_page=10)
-
-      if @use_secure_channel
-        url = @@secureChannel + 'lookup/?page=' + page.to_s + 'per_page=' + per_page.to_s
-      else
-        url = @@rootEndpoint + 'lookup/?page=' + page.to_s + 'per_page=' + per_page.to_s
-      end
+      url = @@secureChannel + 'lookup/?page=' + page.to_s + 'per_page=' + per_page.to_s
 
       http_method = 'GET'
 
-      response = self.execute_request(url, http_method)
-
-      return response
-
+      execute_request(url, http_method)
     end
 
     def get_account_balance
-
-      url =  if @use_secure_channel then @@secureChannel + 'organization/account/' else @@rootEndpoint + 'organization/account/' end
+      url =  @@secureChannel + 'organization/account/'
       http_method = 'GET'
-      response = self.execute_request(url, http_method, {})
-
-      return response
-
+      execute_request(url, http_method, {})
     end
 
-    def execute_request(url='', http_method='', data='')
+    private
 
+    def execute_request(url='', http_method='', data='')
       url_parsed = URI.parse(url)
 
       if http_method=='GET'
@@ -222,15 +137,11 @@ module Instasent
       req.add_field("Accept", "application/json")
       req.add_field("Content-Type", "application/json")
 
-      res = Net::HTTP.start(url_parsed.host, url_parsed.port) { |http|
+      res = Net::HTTP.start(url_parsed.host, url_parsed.port, use_ssl: true) { |http|
         http.request(req)
       }
 
-      return {'response_body' => res.body, 'response_code' => res.code}
-
+      {'response_body' => res.body, 'response_code' => res.code}
     end
-
   end
-
-
 end

data/lib/instasent/version.rb

@@ -1,3 +1,3 @@
 module Instasent
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: instasent
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Instasent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2021-02-02 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'
 description: Implementation of the Instasent SMS lib for Ruby
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -59,10 +59,7 @@ files:
 - examples/sms/get_sms.rb
 - examples/sms/get_sms_by_id.rb
 - examples/sms/send_sms.rb
-- examples/verify/check_verify.rb
-- examples/verify/get_verify.rb
-- examples/verify/get_verify_by_id.rb
-- examples/verify/request_verify.rb
+- instasent-0.1.4.gem
 - instasent.gemspec
 - lib/instasent.rb
 - lib/instasent/version.rb
@@ -76,17 +73,16 @@ 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.0.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Implementation of the Instasent SMS lib for Ruby

data/examples/verify/check_verify.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH << '.'
-require 'instasent'
-
-client = Instasent::Client.new('my-token')
-response = client.check_verify('id', 'token')
-
-puts response['response_body']
-puts response['response_code']

data/examples/verify/get_verify.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH << '.'
-require 'instasent'
-
-client = Instasent::Client.new('my-token')
-response = client.get_verify(1, 10)
-
-puts response['response_body']
-puts response['response_code']

data/examples/verify/get_verify_by_id.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH << '.'
-require 'instasent'
-
-client = Instasent::Client.new('my-token')
-response = client.get_verify_by_id('id')
-
-puts response['response_body']
-puts response['response_code']

data/examples/verify/request_verify.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH << '.'
-require 'instasent'
-
-client = Instasent::Client.new('my-token')
-response = client.request_verify('My company', '+346666666666', 'Your code is %token%')
-
-puts response['response_body']
-puts response['response_code']