rtr_http_gateway 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7f3bb0c8755e7a4b896b99a52cbc9ab67f70b3b
-  data.tar.gz: 5567f951beb9d635933740ead8f3b5581effe205
+  metadata.gz: c7f479c6f6fe89084408a365d7f293c25168a9f8
+  data.tar.gz: 4df2e4f71a3d55c1c6713e5e5829e4ec154ddff6
 SHA512:
-  metadata.gz: 436f1b36f82154e821bd6a9ac826e9aa95d4578c655b83ac8cf23674822cc5aeb0e991831cd1d12b20f4315ef41484cb7f675e05146f564c053dcc4596b6c1e4
-  data.tar.gz: 5576fa9a713cd9cb92b8d768cf55a120b05a6d69dfd1d07053874125c93fa9b31d4bb00ccb0c33580ce40f17535c7c5598182263fabf3dc697da348e1655706b
+  metadata.gz: d0a5dafc74f3c20b86546f9c04ba85df7c2913352e3d3fa9e5d1a92ba9b543e4309f8585c018150417e7944775db9d479c2f9b15f8fa19c00e5dc3b95de36c64
+  data.tar.gz: fcc6b1303dd532a3a6b96ddd540569b053d58dfa7c624a635f123eb6581eac44fbc934e40af108deca3eedeaf2bf725c245d47ff50f25cc94661d136f7fd7f6c

data/lib/rtr_http_gateway.rb

@@ -6,6 +6,7 @@ module RtrHttpGateway
   class HttpGatewayException < StandardError
   end
 
+  # Represents The Delivery receipt status and reason code
   class DlrQueryResponse
     def initialize(status, reason_code, msg_id)
       @status = status
@@ -14,7 +15,7 @@ module RtrHttpGateway
     end
     attr_reader :status, :reason_code, :msg_id
   end
-	
+
   class HttpGatewayApi
     def initialize(username, password, service_key, url='https://connect.runthered.com:14004/public_api/sms/gateway/', dlr_url='https://connect.runthered.com:14004/public_api/sms/dlr/')
       @url = url
@@ -27,6 +28,7 @@ module RtrHttpGateway
     def do_post_request(url_string, values)
       uri = URI.parse(url_string)
       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.set_form_data(values)
       request.basic_auth @username, @password
@@ -37,12 +39,21 @@ module RtrHttpGateway
     def do_get_request(url_string)
       uri = URI.parse(url_string)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
       request = Net::HTTP::Get.new(uri.request_uri)
       request.basic_auth @username, @password
       response = http.request(request)
       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 billing_code [String] the billing code for the message, if required
+    # @param partner_reference [String] a client supplied reference string, if required
+    # @raise [HttpGatewayException] if a non 200 response is returned by Run The Red
+    # @return [String] the message id of the message created in Run The Red's system
     def push_message(message, to, from_number=nil, billing_code=nil, partner_reference=nil)
       values = {'message'=>message, 'to'=>to}
       unless from_number.nil?
@@ -58,9 +69,13 @@ module RtrHttpGateway
       if response.code != '200'
         raise HttpGatewayException, response.code
       end
-      return response
+      return response.body
     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
+    # @raise [HttpGatewayException] if a non 200 response is returned by Ru The Red
+    # @return [DlrQueryResponse] an object with the status, reason_code and msg_id as attributes		
     def query_dlr(msg_id)
       values = {'id' => msg_id}
       params = URI.encode_www_form(values)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtr_http_gateway
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Finn Colman
@@ -9,9 +9,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-09-14 00:00:00.000000000 Z
-dependencies: []
-description: Wrapper library for calling Run The Red's HTTP gateway from ruby. This
-  does the work of making the HTTP requests to Run The Red.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Wrapper library for calling Run The Red's HTTP gateway from ruby.
 email: finn.colman@runthered.com
 executables: []
 extensions: []
@@ -38,8 +79,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Wrapper library for calling Run The Red's HTTP gateway from ruby
+summary: Run The Red HTTP Gateway library
 test_files: []
+has_rdoc: