runthered_ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ac272f58d08fa4bad33809573f6da3745c3d7d6
-  data.tar.gz: 69177fc41eb5c2d50faf1117f14865a876ba23de
+  metadata.gz: 1aae1d0961bc9734e056edd10441eb2b77b1e94f
+  data.tar.gz: 3643a3bf5c1710f5a499805d9aff760bc47d4a74
 SHA512:
-  metadata.gz: 63d8394cdb585e77f8361c093ffb98cedc998626bacc96e7e9201d18cb886b59eb57150860ad90842dce619f50e48988efd2ec50f4a5af4a7e469d2575708492
-  data.tar.gz: f673a734bd3af4afd174663764c6db2b0cfa5a1deac9bd67b8acf79ea3a54b506e98fac36534c0b1022907d7ef57849a29862c9b7a73c336d09507754115bb03
+  metadata.gz: b1eb73172503843a70e1b2f71f04a9442cef2f0cbef53b84634b4eab9e8f7afac8e6000a8ac248c408f5a4badec38191883549aee1e4b0685996bea897e7057c
+  data.tar.gz: 609b0d29198d53316653b1ea37f10d1a81e0155b46f3149ea83160191171e18fa3da1a3d1e1840bf7db8baf51709a5d1d0c38691f403b5d30808da689687a19f

data/lib/push_api/rtr_push_api.rb

@@ -0,0 +1,97 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+module RtrPushApi
+
+  # Represents The Push Api status and message id
+  class PushApiResponse
+    def initialize(status, msg_id, push_id)
+      @status = status
+      @msg_id = msg_id
+      @id = push_id
+    end
+    attr_reader :status, :msg_id, :id
+  end
+
+  # Represents The Delivery receipt status and reason code
+  class DlrQueryResponse
+    def initialize(status, reason_code, push_id)
+      @status = status
+      @reason_code = reason_code
+      @id = push_id
+    end
+    attr_reader :status, :reason_code, :id
+  end
+
+  class PushApiException < StandardError
+  end
+
+  class PushApi
+    def initialize(username, password, service_key, url='https://connect.runthered.com:10443/public_api/service')
+      @url = url
+      @username = username
+      @password = password
+      @service_key = service_key
+    end
+
+    def do_json_request(data)
+      uri = URI.parse(@url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = data.to_json
+      request.basic_auth @username, @password
+      response = http.request(request)
+      if response.code != '200'
+        raise PushApiException, response.body
+      else
+        data = JSON.parse response.body
+        if !data.has_key?("result")  
+          error = data['error']
+          message = error['message']
+          code = error['code']
+          raise PushApiException, message
+        end
+        return data
+      end
+      
+      return response	
+    end
+
+    # Send a message to Run The Red
+    # @param message [String] the message to send
+    # @param to [String] the mobile number to send to
+    # @param from_number [String] the shortcode the message will come from
+    # @param push_id [Integer] the push_id sent by the client to comply with the JSON-RPC 2.0 spec
+    # @return [PushApiResponse] a response object with the status, msg_id and id as attributes
+    def push_message(message, to, from_number=nil, push_id=1)
+      json_data = {"jsonrpc" => "2.0", "method" => "sendsms", "params" => {"service_key" => @service_key, "to" => to, "body" => message}, "id" => push_id}
+      unless from_number.nil?
+        json_data["params"]["frm"] = from_number
+      end
+      data = do_json_request(json_data)
+      push_id = data['id']
+      result = data['result']
+      status = result['status']
+      msg_id = result['msg_id']
+      return PushApiResponse.new(status, msg_id, push_id)
+    end
+
+    # Query a delivery receipt using the message id supplied by Run The Red
+    # @param msg_id [String] the message id of the message to check the delivery status of
+    # @param push_id [Integer] the push_id sent by the client to comply with the JSON-RPC 2.0 spec
+    # @return [DlrQueryResponse] an object with the status, reason_code and id as attributes		
+    def query_dlr(msg_id, push_id=1)
+      json_data = {"jsonrpc" => "2.0", "method" => "querydlr", "params" => {"service_key" => @service_key, "msg_id" => msg_id}, "id" => push_id}
+      data = do_json_request(json_data)
+      push_id = data['id']
+      result = data['result']
+      status = result['status']
+      reason_code = result['reason']
+      msg_id = result['msg_id']
+      return DlrQueryResponse.new(status, reason_code, push_id)
+    end
+  end
+end
+

data/lib/runthered_ruby.rb

@@ -1 +1,2 @@
 require 'http_gateway/rtr_http_gateway'
+require 'push_api/rtr_push_api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runthered_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Finn Colman
@@ -59,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/http_gateway/rtr_http_gateway.rb
+- lib/push_api/rtr_push_api.rb
 - lib/runthered_ruby.rb
 homepage: http://rubygems.org/gems/rtr_http_gateway
 licenses: