telstra-sms 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 110b3504af7e75bb48e0f5e038c14716d6a8d002
-  data.tar.gz: e035ebc7741e3091d56fa7161dc7e31c1c5a1999
+  metadata.gz: 019256ff8183ac685b46ce271a047f8aaab33fb3
+  data.tar.gz: f7727e4569af9915d7e145e971f2479ecea8d862
 SHA512:
-  metadata.gz: b360b15a603e47d0eb857e23d1e5250f2fed1d7d64b12c66af128611c9d6d360bb3b25155c99f7264f46d46db56e18ab9508e43caa1f999a54fb1a7d86bb5d6c
-  data.tar.gz: 9ee67ed53e305d23d3b32e0e07ae7bdc31088b2d0d21f2336b834dd928aff810d9ec547c71dcb5ff257417740b85dbf464b6dc10893f957b3eec867aeae85a34
+  metadata.gz: 540bbd6770905786a089cad43dce0c0bb4dd83d67ba54bebeed62760d164de69d3702c7547578fea9510224a3a1df5a5c6f5bb366c87703397c6c44bb55255e8
+  data.tar.gz: cf4e1cf91158d08c76abce8e2e42050621bae92250a71e6cec8c132e7ffac73c7e6b210e69a2335d318760306acaa86bed9c3fb0bba14d93ca450b900bebcb4d

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -1,3 +1,8 @@
+*This gem is currently in development and only has SMS send / status functionality right now*
+
+[![Code Climate](https://codeclimate.com/github/soccerbrain/telstra-sms/badges/gpa.svg)](https://codeclimate.com/github/soccerbrain/telstra-sms)
+[![Build Status](https://travis-ci.org/soccerbrain/telstra-sms.svg)](https://travis-ci.org/soccerbrain/telstra-sms)
+
 # Telstra::Sms
 
 Ruby gem for the Telstra SMS API at https://dev.telstra.com
@@ -22,7 +27,9 @@ Or install it yourself as:
 
 ```ruby
   t = Telstra::SMS.new(consumer_key, consumer_secret)
-  t.send("SMS Body", "04XX XXX XXXX")
+  t.send_sms("SMS Body", "04XX XXX XXXX")
+  t.get_message_status(message_id)
+  t.get_message_response(message_id)
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,7 @@
+require "rspec/core/rake_task"
 require "bundler/gem_tasks"
 
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/telstra/sms.rb

@@ -13,24 +13,48 @@ module Telstra
       @consumer_secret = consumer_secret
     end
 
-    #def call(url, params={})
-      #params = JSON.generate(params)
-      #curl "https://api.telstra.com/v1/oauth/token?client_id=#{@consumer_key}&client_secret=#{@consumer_secret}&grant_type=client_credentials&scope=SMS"
-    #end
-
+    # OAuth 2.0 Token. This will expire every hour.
     def generate_token
       response = HTTParty.get("https://api.telstra.com/v1/oauth/token?client_id=#{@consumer_key}&client_secret=#{@consumer_secret}&grant_type=client_credentials&scope=SMS")
       @token = JSON.parse(response.body)['access_token'] 
     end
 
-    def send(sms_body, sms_to)
+    # Receipient number should be in the format of 04xxxxxxxx where x is a digit.
+    # Authorization header value should be in the format of "Bearer xxx" where xxx
+    # is the access token returned from a token request.
+    def send_sms(sms_body, sms_to)
       generate_token
       options = { body: {
                     body: sms_body,
                     to: sms_to
                   }.to_json,
                   headers: { "Content-Type" => "application/json", "Authorization" => "Bearer #{@token}" }}
-      HTTParty.post("https://api.telstra.com/v1/sms/messages", options)
+      response = HTTParty.post("https://api.telstra.com/v1/sms/messages", options)
+      return response.body
+    end
+
+    # Get the status of a previously sent SMS message
+    # May return:
+    #
+    # PEND -> The message is pending and has not yet been sent
+    # SENT -> Message has been send, but not delivered
+    # DELIVRD -> Message has been delivered
+    # READ -> The message has been read by the intended recipeitn
+    #
+    # Note: Some responses are dependent on the phone network of the user. 
+    # Obviously, more info can be grabbed from those on the Telstra network.
+    def get_message_status(message_id)
+      generate_token
+      options = { headers: { "Authorization" => "Bearer #{@token}" } }
+      repsonse = HTTParty.post("https://api.telstra.com/v1/sms/messages/#{message_id}")
+      return response.body
+    end
+
+    def get_message_response(message_id)
+      generate_token
+      options = { headers: { "Authorization" => "Bearer #{@token}" } }
+      repsonse = HTTParty.post("https://api.telstra.com/v1/sms/messages/#{message_id}/response")
+      return response.body
     end
 
   end

data/lib/telstra/sms/version.rb

@@ -1,5 +1,5 @@
 module Telstra
   module Sms
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'telstra/sms'

data/spec/telstra/sms_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Telstra::SMS do
+
+  describe "Sending SMS" do
+    let(:telstra_api){ Telstra::SMS.new api_key: 'blah', api_secret: 'blah2' }
+    
+    describe "#get_token" do
+    end
+
+  end
+
+end

data/telstra-sms.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telstra-sms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Millar
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - paul@digitaldawn.com.au
@@ -60,12 +74,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/telstra/sms.rb
 - lib/telstra/sms/version.rb
+- spec/spec_helper.rb
+- spec/telstra/sms_spec.rb
 - telstra-sms.gemspec
 homepage: https://github.com/soccerbrain/telstra-sms
 licenses:
@@ -91,4 +108,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Send SMS through the Telstra SMS API
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/telstra/sms_spec.rb