sms_candy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edc4fc03b0dcaf99dea9c019802f39ca54900491
+  data.tar.gz: 914cedaacb9ec271946bd4b518b5440798e26046
+SHA512:
+  metadata.gz: 592e6f9036008b2cb5b9b295010e3348feefc7a2f376eeccf6db0cd7950cb8b4b6864221701bfb72038fed405c29cee9e11d4e2a6f4a614f8fb8900a4541c14c
+  data.tar.gz: 565fa33a2b60336198036c8fcaff70d258a38ab7e40c21096bce5c2fc3ea56d7708b50de059e3959516e512d9190312bf09a971826ca7a4ed03111e3de554d6b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Hadi Badjian
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmsCandy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/sms_candy.rb

@@ -0,0 +1,16 @@
+require 'rest_client'
+require 'sms_candy/config'
+require 'sms_candy/authentication/strategies'
+require 'sms_candy/helpers/send_message_helper'
+require 'sms_candy/helpers/get_message_status_helper'
+require 'sms_candy/helpers/get_message_response_helper'
+require 'sms_candy/helpers/message_callback_renderer_helper'
+require 'sms_candy/manager'
+
+module SmsCandy
+  module Authentication
+    module Strategies
+      autoload :OAuth2, 'sms_candy/authentication/strategies/o_auth_2'
+    end
+  end
+end

data/lib/sms_candy/authentication/strategies.rb

@@ -0,0 +1,39 @@
+module SmsCandy
+
+  module Authentication
+
+    module Strategies
+
+      class << self
+
+        def add(label, strategy = nil)
+          strategy ||= SmsCandy::Authentication::Strategies::OAuth2.new
+
+          unless strategy.class.method_defined?(:authenticate!)
+            raise NoMethodError, "authenticate! is not declared in the #{label.inspect} strategy"
+          end
+
+          _strategies[label] = strategy
+        end
+
+        def clear!
+          _strategies.clear
+        end
+
+        def list
+          _strategies
+        end
+
+        private
+
+          def _strategies
+            @strategies ||= {}
+          end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/authentication/strategies/o_auth_2.rb

@@ -0,0 +1,44 @@
+module SmsCandy
+
+  module Authentication
+
+    module Strategies
+
+      class OAuth2
+        attr_reader :access_token
+        attr_reader :expires_at
+
+        #Obtain these keys from the Telstra Developer Portal
+        # APP_KEY="yourapikey"
+        # APP_SECRET="yourapisecret"
+
+        # curl "https://api.telstra.com/v1/oauth/token?client_id=$APP_KEY&client_secret=$APP_SECRET&grant_type=client_credentials&scope=SMS"
+        def authenticate!
+          response = RestClient.get(base_url, { params: authentication_params })
+
+          json_response = JSON.parse response.body
+          @expires_at = Time.zone.now + json_response["expires_in"].to_i
+          @access_token = json_response["access_token"]
+        end
+
+        private
+
+          def authentication_params
+            {
+              client_id: ENV["TELSTRA_SMS_CLIENT_ID"],
+              client_secret: ENV["TELSTRA_SMS_CLIENT_SECRET"],
+              grant_type: ENV["TELSTRA_SMS_GRANT_TYPE"],
+              scope: ENV["TELSTRA_SMS_SCOPE"]
+            }
+          end
+
+          def base_url
+            SmsCandy::Config.base_url + "oauth/token"
+          end
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/config.rb

@@ -0,0 +1,16 @@
+module SmsCandy
+
+  class Config
+
+    class << self
+
+      def base_url
+        "https://api.telstra.com/v1/"
+        # Rails.env.test? ? "https://staging.api.telstra.com/v1/" : "https://api.telstra.com/v1/"
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/helpers/get_message_response_helper.rb

@@ -0,0 +1,40 @@
+module SmsCandy
+
+  module Helpers
+
+    class GetMessageResponseHelper
+
+      class << self
+
+        # * MESSAGE_ID value is the value returned from a previous POST https://api.telstra.com/v1/sms/messages call
+        # * Authorization header value should be in the format of "Bearer xxx" where xxx is access token returned
+        #   from a previous GET https://api.telstra.com/v1/oauth/token request.
+        # MESSAGE_ID="6F0B6030D7309137"
+        # TOKEN=your_token
+
+        # curl -H "Authorization: Bearer $TOKEN" \
+        # "https://api.telstra.com/v1/sms/messages/$MESSAGE_ID/response"
+        def response(message_id, access_token)
+          headers =  {
+            "authorization" => "Bearer #{access_token}",
+            "Accept"        => "application/json"
+          }
+
+          response = RestClient.get(_base_url(message_id), headers)
+          json_response = JSON.parse response
+          json_response.map { |response| response.map { |l,v| { l.underscore.to_sym => v } }.inject(:merge) }
+        end
+
+        private
+
+          def _base_url(message_id)
+            SmsCandy::Config.base_url + "sms/messages/#{message_id}/response"
+          end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/helpers/get_message_status_helper.rb

@@ -0,0 +1,40 @@
+module SmsCandy
+
+  module Helpers
+
+    class GetMessageStatusHelper
+
+      class << self
+
+        # * MESSAGE_ID value is the value returned from a previous POST https://api.telstra.com/v1/sms/messages call
+        # * Authorization header value should be in the format of "Bearer xxx" where xxx is access token returned
+        #   from a previous GET https://api.telstra.com/v1/oauth/token request.
+        # MESSAGE_ID="6F0B6030D7309137"
+        # TOKEN=your_token
+
+        # curl -H "Authorization: Bearer $TOKEN" \
+        # "https://api.telstra.com/v1/sms/messages/$MESSAGE_ID"
+        def status(message_id, access_token)
+          headers =  {
+            "authorization" => "Bearer #{access_token}",
+            "Accept"        => "application/json"
+          }
+
+          response = RestClient.get(_base_url(message_id), headers)
+          json_response = JSON.parse response
+          json_response.map { |l,v| { l.underscore.to_sym => v } }.inject(:merge)
+        end
+
+        private
+
+          def _base_url(message_id)
+            SmsCandy::Config.base_url + "sms/messages/#{message_id}"
+          end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/helpers/message_callback_renderer_helper.rb

@@ -0,0 +1,20 @@
+module SmsCandy
+
+  module Helpers
+
+    class MessageCallbackRendererHelper
+
+      class << self
+
+        def render(message)
+          json_response = JSON.parse message
+          json_response.map { |l,v| { l.underscore.to_sym => v } }.inject(:merge)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/helpers/send_message_helper.rb

@@ -0,0 +1,43 @@
+module SmsCandy
+
+  module Helpers
+
+    class SendMessageHelper
+
+      class << self
+
+        # * Recipient 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 access token returned
+        #   from a previous GET https://api.telstra.com/v1/oauth/token request.
+        # RECIPIENT_NUMBER=your_number
+        # TOKEN=your_token
+
+        # curl -H "Content-Type: application/json" \
+        # -H "Authorization: Bearer $TOKEN" \
+        # -d "{\"to\":\"$RECIPIENT_NUMBER\", \"body\":\"Hello!\"}" \
+        # "https://api.telstra.com/v1/sms/messages"
+        def send_sms(number, message, access_token)
+          headers =  {
+            "authorization" => "Bearer #{access_token}",
+            "Content-Type"  => "application/json",
+            "Accept"        => "application/json"
+          }
+          data = { to: number, body: message }.to_json
+
+          response = RestClient.post(_base_url, data, headers)
+          JSON.parse(response)['messageId']
+        end
+
+        private
+
+          def _base_url
+            SmsCandy::Config.base_url + "sms/messages"
+          end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/manager.rb

@@ -0,0 +1,34 @@
+module SmsCandy
+
+  class Manager
+
+    class << self
+
+      def authenticate
+        SmsCandy::Authentication::Strategies.list.each do |label, strategy|
+          access_token = strategy.authenticate!
+          return access_token if access_token
+        end
+      end
+
+      def send_sms(number, message, access_token)
+        SmsCandy::Helpers::SendMessageHelper.send_sms(number, message, access_token)
+      end
+
+      def message_status(message_id, access_token)
+        SmsCandy::Helpers::GetMessageStatusHelper.status(message_id, access_token)
+      end
+
+      def message_response(message_id, access_token)
+        SmsCandy::Helpers::GetMessageResponseHelper.response(message_id, access_token)
+      end
+
+      def message_callback(message)
+        SmsCandy::Helpers::MessageCallbackRendererHelper.render(message)
+      end
+
+    end
+
+  end
+
+end

data/lib/sms_candy/version.rb

@@ -0,0 +1,3 @@
+module SmsCandy
+  VERSION = "0.0.1"
+end

data/lib/tasks/sms_candy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sms_candy do
+#   # Task goes here
+# end

data/spec/authentication/strategies/o_auth_2_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'authentication/strategies/strategy_behaviors'
+
+RSpec.describe SmsCandy::Authentication::Strategies::OAuth2 do
+
+  let(:subject) { SmsCandy::Authentication::Strategies::OAuth2.new }
+
+  it_behaves_like "an authentication strategy"
+
+end

data/spec/authentication/strategies/strategy_behaviors.rb

@@ -0,0 +1,32 @@
+shared_examples_for "an authentication strategy" do
+  let(:strategy) { described_class.new }
+
+  context "interface" do
+
+    it "should respond to authenticate!" do
+      expect(strategy).to respond_to(:authenticate!)
+    end
+
+    it "should have access_token reader" do
+      expect(strategy).to respond_to(:access_token)
+    end
+
+    it "should have expires_at reader" do
+      expect(strategy).to respond_to(:expires_at)
+    end
+
+    it "should not have access_token writer" do
+      expect {
+        strategy.access_token = ""
+      }.to raise_error
+    end
+
+    it "should not have expires_at writer" do
+      expect {
+        strategy.expires_at = Time.zone.now
+      }.to raise_error
+    end
+
+  end
+
+end

data/spec/authentication/strategies_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class InvalidStrategyWithoutAuthenticate
+end
+
+RSpec.describe SmsCandy::Authentication::Strategies do
+
+  let(:subject) { SmsCandy::Authentication::Strategies }
+  let(:strategy) { SmsCandy::Authentication::Strategies::OAuth2.new }
+
+  after(:each) do
+    SmsCandy::Authentication::Strategies.clear!
+  end
+
+  context "#add" do
+
+    it "should add new strategies" do
+      expect(subject.add :oauth2, strategy).to eql(strategy)
+    end
+
+    it "should fail adding a strategy without authenticate! method" do
+      expect {
+        subject.add :invalid_strategy, InvalidStrategyWithoutAuthenticate.new
+      }.to raise_error
+    end
+
+  end
+
+  context "#clear!" do
+
+    it "should be able to clear strategies" do
+      subject.add :oauth2, strategy
+      expect(subject.clear!).to eql({})
+    end
+
+  end
+
+end