smart-mobile 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+cert/
+test/*.yml

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem "rake"
+# Specify your gem's dependencies in textile_editor_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,12 @@
+smart-mobile
+============
+
+Smart Mobile API
+
+## MIT Open Source License
+
+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,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/smart-mobile.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+require 'nokogiri'
+require 'net/https'
+require 'uri'
+require 'json'
+
+require_relative 'smart/support'
+require_relative 'smart/version'
+require_relative 'smart/rest/config'
+require_relative 'smart/rest/response'
+require_relative 'smart/rest/client'
+require_relative 'smart/rest/sms'

data/lib/smart/rest/client.rb

@@ -0,0 +1,81 @@
+module Smart
+  module REST
+    class Client
+      include ClassSupportMixin
+      include Smart::REST::Configuration
+      
+      HTTP_HEADERS = {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json', 
+        'Authorization' => 'WSSE realm="SDP",profile="UsernameToken"' 
+      }
+
+      set_attributes :host => 'npwifi.smart.com.ph',
+        :port => 443,
+        :timeout => 30,
+        :retry_limit => 1,
+        :sp_id => '',
+        :sp_password => '', 
+        :service_id => '',
+        :nonce => '',
+        :creation_time => '',
+        :trans_id => '',
+        :access_code => '',
+        :mobile_number => '',
+        :path_to_cert => '',
+        :mobile_number => '',
+        :message => ''
+
+      
+      attr_reader :sp_id, :sp_password, :sp_service_id, :nonce, :creation_time, :trans_id, :access_code, :mobile_number, :path_to_cert
+
+      def headers
+        HTTP_HEADERS.merge! ({
+          'X-WSSE' => %{ "UsernameToken Username="#{self.sp_id}",PasswordDigest="#{self.sp_password}",Nonce="#{self.nonce}", Created="#{self.creation_time}"}, 
+          'X-RequestHeader' => %{ "request TransId="",ServiceId="#{self.service_id}" }
+        })
+      end
+      
+      def send_sms(args = {})
+        request = setup_connection(args)
+        response = connect(request)
+      end
+      
+      private
+      
+      def setup_sms_outbound_endpoint
+        "https://#{self.host}/1/smsmessaging/outbound/#{self.access_code}/requests"
+      end
+      
+      def setup_connection(args)
+        uri = URI.parse(setup_sms_outbound_endpoint)
+        @http = Net::HTTP.new(uri.host, uri.port)
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @http.open_timeout = 3 # in seconds
+        @http.read_timeout = 3 # in seconds
+        
+        store = OpenSSL::X509::Store.new
+        store.add_cert(OpenSSL::X509::Certificate.new(File.read(self.path_to_cert)))
+        @http.cert_store = store
+        
+        request = Net::HTTP::Post.new(uri.request_uri, initheader = headers)
+        request.body = args.to_json
+        request
+      end
+      
+      def connect(request)
+        response = @http.request(request)
+        
+        if response.body and !response.body.empty?
+          object = JSON.parse(response.body)
+        end
+        if response.kind_of? Net::HTTPClientError
+          error = Smart::REST::Response.new(object["requestError"]["serviceException"]["messageId"])
+          raise error.to_s
+        end
+        response
+      end
+    end
+  end
+end

data/lib/smart/rest/config.rb

@@ -0,0 +1,22 @@
+module Smart
+  module REST
+    module Configuration
+      def self.included(base)
+        base.extend ClassMethods
+      end
+  
+      module ClassMethods
+        def configure(&block)
+          config = self.new
+          raise ArgumentError, "Please provide configuration block" unless block_given?
+          yield config
+      
+          [:sp_id, :sp_password, :service_id, :access_code, :path_to_cert].each do |required|
+            raise "#{required} is required" unless config.send(required)
+          end
+          config
+        end
+      end
+    end
+  end
+end

data/lib/smart/rest/response.rb

@@ -0,0 +1,95 @@
+module Smart
+  module REST
+    class Response
+      attr_reader :response_code
+      #TODO:
+      # Service Exception Extension	
+      # Policy Exceptions	
+      # Policy Exception Extension	    
+      @@error_map = {
+        :condition_not_met? => 304,
+        :invalid_request_parameters? => 400,
+        :authentication_failed? => 401,
+        :not_permitted? => 403,
+        :not_found? => 404,
+        :method_not_allowed? => 405,
+        :conflict? => 409,
+        :content_length_required? => 411,
+        :precondition_failed? => 412,
+        :request_body_too_large? => 413,
+        :invalid_range? => 416,
+        :internal_server_error? => 500,
+        :server_busy? => 503,
+        :service_error? => 'SVC0001',
+        :invalid_input_value? => 'SVC0002',
+        :invalid_input_value_with_valid_values? => 'SVC0003',
+        :no_valid_address? => 'SVC0004',
+        :duplicate_correlator? => 'SVC0005',
+        :invalid_group? => 'SVC0006',
+        :invalid_charging_info? => 'SVC0007',
+        :overlapping_criteria? => 'SVC0008',
+        :success? => 200,
+        :created? => 201,
+        :no_content? => 204,
+        :password_not_accepted? => 'SVC0901'
+      }
+      
+      @@status_messages = {
+        304 => "ConditionNotMet - Not Modified: The condition specified in the conditional header(s) was not met for a read operation.",
+        400 => "Invalid parameters in the request",
+        401 => "Authentication failure",
+        403 => "Application does not have permissions to access resource due to the policy constraints (request rate limit, etc)",
+        404 => "Not Found - The specified resource does not exist.",
+        405 => "Method not allowed by the resource",
+        409 => "Conflict",
+        411 => "Length Required: The Content-Length header was not specified.",
+        412 => "Precondition Failed: The condition specified in the conditional header(s) was not met for a write operation.",
+        413 => "RequestBodyTooLarge - Request Entity Too Large: The size of the request body exceeds the maximum size permitted.",
+        416 => "InvalidRange - Requested Range Not Satisfiable: The range specified is invalid for the current size of the resource.",
+        500 => "Internal server error",
+        503 => "ServerBusy - Service Unavailable: The server is currently unable to receive requests. Please retry your request.",
+        "SVC0001" => "Service Error",
+        "SVC0002" => "Invalid input value",
+        "SVC0003" => "Invalid input value with list of valid values",
+        "SVC0004" => "No valid addresses",
+        "SVC0005" => "Duplicate correlator",
+        "SVC0006" => "Invalid group",
+        "SVC0007" => "Invalid charging information",
+        "SVC0008" => "Overlapping Criteria",
+        "SVC0901" => "Sp password is not accepted!",
+        200 => "Success",
+        201 => "Created",
+        204 => "No Content"
+      }
+      
+      def initialize(code)
+        @response_code = code
+      end
+      
+      def valid?
+        [200, 201].include?(self.response_code)
+      end
+      
+      def to_s
+        #"#{self.response_code} - #{msg}"
+        msg
+      end
+      
+      def msg(code = self.response_code)
+        if msg = @@status_messages[code]
+          msg
+        else
+          raise ArgumentError, "#{code} - undefined response code"
+        end
+      end
+      
+      def method_missing(method_id)
+        if code = @@error_map[method_id.to_sym]
+          self.response_code == code
+        else
+          raise NoMethodError
+        end
+      end
+    end
+  end
+end

data/lib/smart/rest/sms.rb

@@ -0,0 +1,8 @@
+module Smart
+  module REST
+    class SMS
+      include ClassSupportMixin
+      set_attributes :mobile_number => nil, :message => nil, :access_code => nil
+    end
+  end
+end

data/lib/smart/support.rb

@@ -0,0 +1,30 @@
+module ClassSupportMixin
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def set_attributes(attrs)
+      attr_accessor *attrs.keys
+      define_method(:default_attributes) { attrs }
+    end
+  end
+  
+  module InstanceMethods
+    def initialize(options={})
+      init = if self.respond_to?(:default_attributes)
+        self.default_attributes.merge(options)
+      else
+        options
+      end
+      init.each { |k, v| self.send("#{k}=", v) if self.respond_to?(k) }
+    end
+    
+    def attributes
+      attrs = {}
+      self.default_attributes.keys.each {|k| attrs[k] = self.send(k) if self.respond_to?(k)}
+      attrs
+    end
+  end
+end

data/lib/smart/version.rb

@@ -0,0 +1,3 @@
+module Smart
+  VERSION = '0.0.1'
+end

data/smart-mobile.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'smart-mobile'
+  s.version     = '0.0.1'
+  s.date        = '2012-11-24'
+  s.email       = 'me@iantusil.com'
+  
+  s.summary     = "A gem for consuming Smart Mobile API"
+  s.description = "A gem for consuming Smart Mobile API (currently supports SMS only)."
+  s.author      = "Ian Bert Tusil"
+  s.homepage    = 'http://www.smart.com.ph/developer'
+  s.license     = 'MIT'
+
+  s.platform    = Gem::Platform::RUBY
+  s.require_paths = %w[lib]
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = Dir['test/*.rb']
+    
+  s.add_development_dependency 'minitest', '~> 4.3.3'
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/matchers'
+
+def config_file
+  config ||= YAML::load(File.open((File.join(File.dirname(__FILE__), 'config.yml'))))
+end

data/test/test_smart.rb

@@ -0,0 +1,52 @@
+require_relative 'test_helper'
+require_relative '../lib/smart-mobile'
+
+describe Smart do
+
+  before do
+    @sms = Smart::REST::SMS.new
+  end
+  
+  def valid_sms_data
+    {"outboundSMSMessageRequest" => 
+      {"address" => ["tel:+639176230655"], 
+        "senderAddress" => config_file['access_code'].to_s,
+        "outboundSMSTextMessage" => {
+          "message" => "Test Message"
+        }
+      }
+    }
+  end
+
+  def client
+    @client ||= initialize_rest_client 
+  end
+
+  def initialize_rest_client
+    Smart::REST::Client.configure do |config|
+      config.sp_id = config_file['sp_id']
+      config.sp_password = config_file['sp_password'].to_s
+      config.service_id = config_file['service_id']
+      config.access_code = config_file['access_code'].to_s
+      config.path_to_cert = config_file['path_to_cert']
+      config.creation_time = config_file['creation_time']
+      config.nonce = config_file['nonce']
+    end
+  end
+
+  it 'should not allow for invalid sp_password' do
+    begin
+      response = client.send_sms(valid_sms_data)
+    rescue Exception => e
+      e.message.must_equal Smart::REST::Response.new('SVC0901').to_s
+    end
+  end
+  
+  it 'should have a valid certificate' do
+
+  end
+  
+  it 'should try to retry up to the max number of retry limited' do
+  end
+  
+end

data/travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.2

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: smart-mobile
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Bert Tusil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &319130 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *319130
+description: A gem for consuming Smart Mobile API (currently supports SMS only).
+email: me@iantusil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/smart-mobile.rb
+- lib/smart/rest/client.rb
+- lib/smart/rest/config.rb
+- lib/smart/rest/response.rb
+- lib/smart/rest/sms.rb
+- lib/smart/support.rb
+- lib/smart/version.rb
+- smart-mobile.gemspec
+- test/.DS_Store
+- test/test_helper.rb
+- test/test_smart.rb
+- travis.yml
+homepage: http://www.smart.com.ph/developer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A gem for consuming Smart Mobile API
+test_files:
+- test/test_helper.rb
+- test/test_smart.rb