ruby-transmitsms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a57bb0ebf7930c2ac2fd718e3a3ccd572f2ff0
+  data.tar.gz: a4c9a879eac1ba693eb96215c0a8902350c306e3
+SHA512:
+  metadata.gz: cd01db9ee1fd885abd5ca591e5d396b662b8b84d1cf26f39585b716f52a7cea084e5b8bdb0d3546196dc05a35645ff70ef682e0b5c37c06d202c035f4b2e57c0
+  data.tar.gz: 4107f3a9ad7090c6ca9d7aebe188dacbf5d37de50b89def5e10b65293934f842b7ee5db3e7b27ea792ba3c85e80c6deb62413264c397386ab1f6d47817daa24f

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify dependencies in swagger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    ruby-transmitsms (0.0.1)
+      addressable (>= 2.2.4)
+      json (>= 1.4.6)
+      typhoeus (>= 0.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ethon (0.7.3)
+      ffi (>= 1.3.0)
+    ffi (1.9.8)
+    json (1.8.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    typhoeus (0.7.1)
+      ethon (>= 0.7.1)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (>= 2.5.0)
+  rspec-mocks
+  ruby-transmitsms!
+  vcr (>= 2.9.3)
+  webmock (>= 1.21.0)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Transmitsms
+
+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,62 @@
+ruby-transmitsms
+================
+
+Ruby gem to easily access TransmitSMS RESTful APIs
+
+### Sample Usage
+```ruby
+require 'ruby-transmitsms'
+
+# Create new Sms instance
+sms = Sms.new("15eg266c832fb23c4d90f01055aef355", "bluebird")
+
+# Send a message
+response = sms.send("Hello, world", "61455123456")
+
+# Show the result
+puts response.code
+puts response.body
+```
+
+### Installation
+```sh
+gem install ruby-transmitsms
+```
+
+### Installation with `bundler`'s Gemfile
+gem "ruby-transmitsms"
+
+## Development
+
+### To install the required gems:
+```sh
+$ ./setup.sh
+```
+
+### To run  the tests:
+```sh
+$ ./runtest.sh
+```
+## API
+
+### Sms
+
+**initialize**(api_key, api_secret) - Sms object constructor.
+
+params:
+* `api_key`
+* `api_secret`
+
+**send**(message, to, from, send_at, list_id, dlr_callback, reply_callback, validity, replies_to_email, from_shared) - Send sms to the given `to` param or `list_id` param.
+
+params:
+* `message`
+* `to`
+* `from`
+* `send_at`
+* `list_id`
+* `dlr_callback`
+* `reply_callback`
+* `validity`
+* `replies_to_email`
+* `from_shared`

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'swagger'
+
+RSpec::Core::RakeTask.new('spec')

data/fixtures/vcr_cassettes/account_api_get_balance.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/get-balance.json
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 06:58:09 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"balance":496227.614,"currency":"SGD","error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 06:58:09 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/email_sms_api_add_email.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/add-email.json?email=test@email.com
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 05:52:05 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"success":true,"error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 05:52:05 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/email_sms_api_delete_email.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/delete-email.json?email=test@email.com
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 06:07:55 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"success":true,"error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 06:07:55 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/keywords_api_add_keyword.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/add-keyword.json?keyword=NEWS&number=61422222222
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 07:10:59 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"keyword":"NEWS","reference":"","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2015-05-28","error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 07:10:59 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/keywords_api_edit_keyword.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/edit-keyword.json?keyword=NEWS&number=61422222222
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 07:15:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"keyword":"NEWS","reference":"","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2015-05-28","error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 07:15:37 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/keywords_api_get_keywords.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/get-keywords.json?number=61422222222
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Tue, 28 Apr 2015 07:18:06 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.39-1+deb.sury.org~precise+2
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"page":{"count":1,"number":1},"keywords_total":6,"keywords":[{"keyword":"","reference":"wefwefwefwef","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2014-12-19"},{"keyword":"","reference":"23r23r23r23r","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2014-12-19"},{"keyword":"FWEFWEFWEF","reference":"wefwefwefwef","number":61422222222,"list_id":55214,"welcome_message":"wefwefwef","member_message":"wefwefwe","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2014-12-19"},{"keyword":"MOOSE","reference":"moosey3","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2014-12-19"},{"keyword":"MOOSE
+        MOOSE","reference":"MOOSE","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2014-12-19"},{"keyword":"NEWS","reference":"","number":61422222222,"list_id":0,"welcome_message":"","member_message":"","forward_url":"","forward_sms":"","forward_email":"","status":"open","billing_date":"2015-05-28"}],"error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 28 Apr 2015 07:18:06 GMT
+recorded_with: VCR 2.9.3