notifications-ruby-client 2.4.0 → 2.5.0

data/bin/generate_docker_env.sh

@@ -20,6 +20,8 @@ env_vars=(
     LETTER_TEMPLATE_ID
     EMAIL_REPLY_TO_ID
     SMS_SENDER_ID
+    API_SENDING_KEY
+    INBOUND_SMS_QUERY_KEY
 )
 
 for env_var in "${env_vars[@]}"; do

data/bin/test_client.rb

@@ -15,6 +15,7 @@ def main
   test_get_notification_by_id_endpoint(client, sms_notification.id, 'sms')
   test_get_notification_by_id_endpoint(client, letter_notification.id, 'letter')
   test_get_all_notifications(client)
+  test_get_received_texts
   p 'ruby client integration tests pass'
   exit 0
 end
@@ -310,6 +311,15 @@ def expected_fields_in_template
      uri)
 end
 
+def expected_fields_in_received_text_response
+  %w(id
+     created_at
+     content
+     notify_number
+     service_id
+     user_number)
+end
+
 def test_get_all_notifications(client)
   notifications = client.get_notifications
   unless notifications.is_a?(Notifications::Client::NotificationsCollection)
@@ -319,6 +329,34 @@ def test_get_all_notifications(client)
   field_should_not_be_nil(expected_fields_for_get_all_notifications, notifications, 'get_notifications')
 end
 
+def test_get_received_texts
+  client = Notifications::Client.new(ENV['INBOUND_SMS_QUERY_KEY'], ENV['NOTIFY_API_URL'])
+  response = client.get_received_texts
+  unless response.is_a?(Notifications::Client::ReceivedTextCollection)
+    p 'failed test_get_received_texts response is not a Notifications::Client::ReceivedTextCollection'
+    exit 1
+  end
+  unless response.collection.length >= 0
+    p 'failed test_get_received_texts, expected at least 1 received text returned.'
+    exit 1
+  end
+  test_received_text_response(response.collection[0], 'test_received_text_response')
+  test_received_text_response(response.collection[1], 'test_received_text_response')
+  test_received_text_response(response.collection[2], 'test_received_text_response')
+end
+
+def test_received_text_response(response, test_method)
+  unless response.is_a?(Notifications::Client::ReceivedText)
+    p 'failed test_get_received_texts response is not a Notifications::Client::ReceivedText'
+    exit 1
+  end
+  unless response.id.is_a?(String)
+    p 'failed received text id is not a String'
+    exit 1
+  end
+  field_should_not_be_nil(expected_fields_in_received_text_response, response, test_method)
+end
+
 def expected_fields_for_get_all_notifications
   %W(links
      collection)

data/docker/Dockerfile

@@ -9,6 +9,7 @@ RUN \
 	&& ([ -z "$HTTP_PROXY" ] || echo "Acquire::http::Proxy \"${HTTP_PROXY}\";" > /etc/apt/apt.conf.d/99HttpProxy) \
 	&& apt-get update \
 	&& apt-get install -y --no-install-recommends \
+		gcc \
 		make \
 		curl \
 		git \

data/lib/notifications/client.rb

@@ -3,6 +3,8 @@ require_relative "client/speaker"
 require_relative "client/notification"
 require_relative "client/response_notification"
 require_relative "client/notifications_collection"
+require_relative "client/received_text"
+require_relative "client/received_text_collection"
 require_relative "client/response_template"
 require_relative "client/template_collection"
 require_relative "client/template_preview"
@@ -69,7 +71,7 @@ module Notifications
     #   temporarily failed, or technical failure
     # @option options [String] :reference
     #   your reference for the notification
-    # @option options [String] :olderThanId
+    # @option options [String] :older_than
     #   notification id to return notificaitons that are older than this id.
     # @see Notifications::Client::Speaker#get
     # @return [NotificationsCollection]
@@ -121,5 +123,16 @@ module Notifications
         speaker.post_with_url(path, options)
       )
     end
+
+    ##
+    # @option options [String] :older_than
+    #   received text id to return received texts that are older than this id.
+    # @return [ReceivedTextCollection]
+    def get_received_texts(options = {})
+      path = "/v2/received-text-messages"
+      ReceivedTextCollection.new(
+        speaker.get_with_url(path, options)
+      )
+    end
   end
 end

data/lib/notifications/client/notification.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Notifications
   class Client
     class Notification
@@ -40,7 +42,7 @@ module Notifications
           begin
             value = instance_variable_get(:"@#{field}")
             Time.parse value
-          rescue
+          rescue StandardError
             value
           end
         end

data/lib/notifications/client/received_text.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+module Notifications
+  class Client
+    class ReceivedText
+      FIELDS = %i(
+        id
+        created_at
+        content
+        notify_number
+        service_id
+        user_number
+      ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(received_text)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", received_text.fetch(field.to_s, nil))
+        end
+      end
+
+      def created_at
+        value = instance_variable_get(:@created_at)
+        Time.parse(value)
+      rescue StandardError
+        value
+      end
+    end
+  end
+end

data/lib/notifications/client/received_text_collection.rb

@@ -0,0 +1,18 @@
+module Notifications
+  class Client
+    class ReceivedTextCollection
+      attr_reader :links, :collection
+
+      def initialize(response)
+        @links = response["links"]
+        @collection = collection_from(response["received_text_messages"])
+      end
+
+      def collection_from(received_texts)
+        received_texts.map do |received_text|
+          ReceivedText.new(received_text)
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/response_template.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Notifications
   class Client
     class Template
@@ -28,7 +30,7 @@ module Notifications
           begin
             value = instance_variable_get(:"@#{field}")
             Time.parse value
-          rescue
+          rescue StandardError
             value
           end
         end

data/lib/notifications/client/version.rb

@@ -9,6 +9,6 @@
 
 module Notifications
   class Client
-    VERSION = "2.4.0".freeze
+    VERSION = "2.5.0".freeze
   end
 end

data/notifications-ruby-client.gemspec

@@ -23,8 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "jwt", "~> 2.1"
 
   spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 12.1"
-  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "webmock", "~> 3.1"
   spec.add_development_dependency "factory_bot", "~> 4.8"
+  spec.add_development_dependency "govuk-lint", "~> 3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk
@@ -104,6 +118,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -119,6 +134,8 @@ files:
 - lib/notifications/client.rb
 - lib/notifications/client/notification.rb
 - lib/notifications/client/notifications_collection.rb
+- lib/notifications/client/received_text.rb
+- lib/notifications/client/received_text_collection.rb
 - lib/notifications/client/request_error.rb
 - lib/notifications/client/response_notification.rb
 - lib/notifications/client/response_template.rb
@@ -146,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API