telstra-sms 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 019256ff8183ac685b46ce271a047f8aaab33fb3
-  data.tar.gz: f7727e4569af9915d7e145e971f2479ecea8d862
+  metadata.gz: f3139c2e4630b89f026e68ac905feadccc4b117e
+  data.tar.gz: d8e1ff33021793396c1f66e9e1efc2fdead31926
 SHA512:
-  metadata.gz: 540bbd6770905786a089cad43dce0c0bb4dd83d67ba54bebeed62760d164de69d3702c7547578fea9510224a3a1df5a5c6f5bb366c87703397c6c44bb55255e8
-  data.tar.gz: cf4e1cf91158d08c76abce8e2e42050621bae92250a71e6cec8c132e7ffac73c7e6b210e69a2335d318760306acaa86bed9c3fb0bba14d93ca450b900bebcb4d
+  metadata.gz: 9f8fdfe2ae94b47f74af44a1a349403f96263e69847f0d8fd57d8f942f8a26931e2cf99398b8d1b4ea0867f0b409223e564f902837f162f17d10e13650670b17
+  data.tar.gz: 0170d289f09f778bb7faa0fbb1cf606a8bc5b8b8d295929733dca8a0b9788e84461299b8348b988d0ce1eddedfa6e143d13a4960b13ddc14a97e26626b919cf8

data/.gitignore

@@ -6,6 +6,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/fixtures/*.yml
 /tmp/
 *.bundle
 *.so

data/README.md

@@ -1,4 +1,5 @@
-*This gem is currently in development and only has SMS send / status functionality right now*
+*This gem is currently in development*
+TODO: Add error handling.
 
 [![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)
@@ -27,7 +28,7 @@ Or install it yourself as:
 
 ```ruby
   t = Telstra::SMS.new(consumer_key, consumer_secret)
-  t.send_sms("SMS Body", "04XX XXX XXXX")
+  t.send_sms(to: "04XX XXX XXXX", body: 'Hello from Telstra!')
   t.get_message_status(message_id)
   t.get_message_response(message_id)
 ```

data/lib/telstra/sms.rb

@@ -5,32 +5,33 @@ require "telstra/sms/version"
 module Telstra
   class SMS
 
-    attr_accessor :consumer_key, :consumer_secret, :token
+    attr_accessor :api_key, :api_secret, :token
     
     # Initialize API Keys
-    def initialize(consumer_key, consumer_secret)
-      @consumer_key = consumer_key
-      @consumer_secret = consumer_secret
+    def initialize(api_key, api_secret)
+      @api_key = api_key
+      @api_secret = api_secret
     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")
+      response = HTTParty.get("https://api.telstra.com/v1/oauth/token?client_id=#{@api_key}&client_secret=#{@api_secret}&grant_type=client_credentials&scope=SMS")
       @token = JSON.parse(response.body)['access_token'] 
     end
 
     # 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)
+    def send_sms(to: sms_to, body: sms_body)
+      [to, body]
       generate_token
       options = { body: {
-                    body: sms_body,
-                    to: sms_to
+                    body: body,
+                    to: to
                   }.to_json,
                   headers: { "Content-Type" => "application/json", "Authorization" => "Bearer #{@token}" }}
       response = HTTParty.post("https://api.telstra.com/v1/sms/messages", options)
-      return response.body
+      return JSON.parse(response.body)
     end
 
     # Get the status of a previously sent SMS message
@@ -45,16 +46,16 @@ module Telstra
     # 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
+      options = { body: {}, headers: { "Authorization" => "Bearer #{@token}" } }
+      response = HTTParty.get("https://api.telstra.com/v1/sms/messages/#{message_id}", options)
+      return JSON.parse(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
+      options = { body: {}, headers: { "Authorization" => "Bearer #{@token}" } }
+      response = HTTParty.get("https://api.telstra.com/v1/sms/messages/#{message_id}/response", options)
+      return JSON.parse(response.body)
     end
 
   end

data/lib/telstra/sms/version.rb

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

data/spec/spec_helper.rb

@@ -1 +1,8 @@
 require 'telstra/sms'
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures"
+  c.hook_into :webmock
+end

data/spec/telstra/sms_spec.rb

@@ -3,9 +3,58 @@ require 'spec_helper'
 describe Telstra::SMS do
 
   describe "Sending SMS" do
-    let(:telstra_api){ Telstra::SMS.new api_key: 'blah', api_secret: 'blah2' }
+    let(:telstra_api){ Telstra::SMS.new(ENV['TELSTRA_API'], ENV['TELSTRA_SECRET']) }
     
-    describe "#get_token" do
+    describe "#generate_token" do
+      it 'returns token' do
+        VCR.use_cassette('generate_token') do
+          response = telstra_api.generate_token
+          expect(response).kind_of?(String)
+        end
+      end
+    end
+
+    describe "#send_sms" do
+      it 'returns a success' do
+        VCR.use_cassette('send_sms') do
+          response = telstra_api.send_sms(to: '0425616397', body: 'Hello from Telstra!')
+          expect(response).kind_of?(Hash)
+          expect(response.has_key?('messageId')).to eq true
+        end
+      end
+    end
+
+    describe "get_message_status" do
+      it 'returns message status' do
+        VCR.use_cassette('get_message_status') do
+          sms_response = telstra_api.send_sms(to: '0425616397', body: 'Hello from Telstra!')
+          message_id = sms_response['messageId']
+          response = telstra_api.get_message_status(message_id)
+
+          expect(response).kind_of?(Hash)
+          expect(response.has_key?('to')).to eq true
+          expect(response.has_key?('receivedTimestamp')).to eq true
+          expect(response.has_key?('sentTimestamp')).to eq true
+          expect(response.has_key?('status')).to eq true
+        end
+      end
+    end
+
+    describe "#get_message_response" do
+      ## Can a response be simulated?
+      it 'returns message response' do
+        VCR.use_cassette('get_message_response') do
+          sms_response = telstra_api.send_sms(to: '0425616397', body: 'Hello from Telstra!')
+          message_id = sms_response['messageId']
+          response = telstra_api.get_message_response(message_id)
+
+          expect(response).kind_of?(Array)
+
+          expect(response[0].has_key?('from')).to eq true
+          expect(response[0].has_key?('acknowledgedTimestamp')).to eq true
+          expect(response[0].has_key?('content')).to eq true
+        end
+      end
     end
 
   end

data/telstra-sms.gemspec

@@ -22,4 +22,6 @@ 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"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telstra-sms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Millar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - paul@digitaldawn.com.au
@@ -81,6 +109,7 @@ files:
 - Rakefile
 - lib/telstra/sms.rb
 - lib/telstra/sms/version.rb
+- spec/fixtures/.gitkeep
 - spec/spec_helper.rb
 - spec/telstra/sms_spec.rb
 - telstra-sms.gemspec
@@ -109,5 +138,6 @@ signing_key:
 specification_version: 4
 summary: Send SMS through the Telstra SMS API
 test_files:
+- spec/fixtures/.gitkeep
 - spec/spec_helper.rb
 - spec/telstra/sms_spec.rb