gds-api-adapters 36.0.1 → 36.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32b60409e9f3b162e8dbe7f8a34c45359de60cfd
-  data.tar.gz: d8521c663666103d7a84d67d52c750da6e989ff3
+  metadata.gz: bcbac32e46d147fa75d158358e3f43b858dc717f
+  data.tar.gz: f0085c380372ea653dbe604d12b956ce47cfb6c9
 SHA512:
-  metadata.gz: 5c318720e3148b537583771dc8aba4ef80f035e7ce24200fe1592e51aed0f46c5ad63d68ffc1f11abe921fa4e43daa319c2cb983b51517853da545d3e4819089
-  data.tar.gz: ded39f290c4f4c81cb3e30212e03c6ba049a4fec18c19fd49a0df7f60d806e7f5b452f8306d7ae9c59a761dd919afbbf9361c4533ab9b02ac4e4729dd3c300c5
+  metadata.gz: 777ae29ce2fd0b642452b4bf84c292a0aa2b198b1945ddccfce464841c6c119ac912e8308b228fd8dceee1ef4185e0809b7eeaf8ca6e2c155b4e8f6495724a35
+  data.tar.gz: 5a7182ee26869c0ee8da18208538a3032a5501980109974bea46f482ee5ab40d570dacfc1f0236cbd90f877ca20faef423fed7369b51db91370a7c63d7036f0d

data/lib/gds_api/support_api.rb

@@ -47,4 +47,75 @@ class GdsApi::SupportApi < GdsApi::Base
   def feedback_export_request(id)
     get_json!("#{endpoint}/anonymous-feedback/export-requests/#{id}")
   end
+
+  # Fetch a list of problem reports.
+  #
+  # Makes a +GET+ request.
+  #
+  # If no options are supplied, the first page of unreviewed feedback is returned.
+  #
+  # The results are ordered date descending.
+  #
+  # # ==== Options [+Hash+]
+  #
+  # * +:from_date+ - from date for list of reports.
+  # * +:to_date+ - to date for list of reports.
+  # * +:page+ - page number for reports.
+  # * +:include_reviewed+ - if true, includes reviewed reports in the list.
+  #
+  # # @example
+  #
+  #  support_api.problem_reports({ from_date: '2016-12-12', to_date: '2016-12-13', page: 1, include_reviewed: true }).to_h
+  #
+  #  #=> {
+  #    results: [
+  #      {
+  #        id: 1,
+  #        type: "problem-report",
+  #        what_wrong: "Yeti",
+  #        what_doing: "Skiing",
+  #        url: "http://www.dev.gov.uk/skiing",
+  #        referrer: "https://www.gov.uk/browse",
+  #        user_agent: "Safari",
+  #        path: "/skiing",
+  #        marked_as_spam: false,
+  #        reviewed: true,
+  #        created_at: "2015-01-01T16:00:00.000Z"
+  #      },
+  #      ...
+  #    ]
+  #    total_count: 1000,
+  #    current_page: 1,
+  #    pages: 50,
+  #    page_size: 50
+  #  }
+  def problem_reports(options = {})
+    uri = "#{endpoint}/anonymous-feedback/problem-reports" + query_string(options)
+    get_json!(uri)
+  end
+
+  # Update multiple problem reports as reviewed for spam.
+  #
+  # Makes a +PUT+ request.
+  #
+  # @param request_details [Hash] Containing keys that match IDs of Problem
+  #                               Reports mapped to a boolean value - true if
+  #                               that report is to be marked as spam, or false otherwise.
+  #
+  # # @example
+  #
+  #  support_api.mark_reviewed_for_spam({ "1" => false, "2" => true }).to_h
+  #
+  # #=> { "success" => true } (status: 200)
+  #
+  # # @example
+  #
+  # Where there is no problem report with ID of 1.
+  #
+  #  support_api.mark_reviewed_for_spam({ "1" => true }).to_h
+  #
+  # #=> { "success" =>  false} (status: 400)
+  def mark_reviewed_for_spam(request_details)
+    put_json!("#{endpoint}/anonymous-feedback/problem-reports/mark-reviewed-for-spam", { reviewed_problem_report_ids: request_details })
+  end
 end

data/lib/gds_api/test_helpers/support_api.rb

@@ -44,6 +44,18 @@ module GdsApi
         get_stub.to_return(response)
       end
 
+      def stub_support_problem_reports(params, response_body = {})
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports").
+          with(query: params).
+          to_return(status: 200, body: response_body.to_json)
+      end
+
+      def stub_support_mark_reviewed_for_spam(request_details = nil, response_body = {})
+        post_stub = stub_http_request(:put, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports/mark-reviewed-for-spam")
+        post_stub.with(:body => { reviewed_problem_report_ids: request_details}) unless request_details.nil?
+        post_stub.to_return(status: 200, body: response_body.to_json)
+      end
+
       def support_api_isnt_available
         stub_request(:post, /#{SUPPORT_API_ENDPOINT}\/.*/).to_return(:status => 503)
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '36.0.1'
+  VERSION = '36.1.0'
 end

data/test/support_api_test.rb

@@ -71,7 +71,7 @@ describe GdsApi::SupportApi do
         page: 55,
       )
 
-      result = @api.anonymous_feedback(
+      @api.anonymous_feedback(
         path_prefix: "/vat-rates",
         page: 55,
       )
@@ -112,7 +112,7 @@ describe GdsApi::SupportApi do
       assert_requested(stub_post)
     end
   end
-  
+
   describe "POST /anonymous-feedback/global-export-requests" do
     it "makes a POST request to the support API" do
       params = {from_date: "1 June 2016", to_date: "8 June 2016", notification_email: "foo@example.com"}
@@ -152,4 +152,27 @@ describe GdsApi::SupportApi do
       assert_requested(stub_get)
     end
   end
+
+  describe "GET /anonymous-feedback/problem-reports" do
+    it "fetches a list of problem reports" do
+      params = { from_date: '2016-12-12', to_date: '2016-12-13', page: 1, exclude_reviewed: true }
+      stub_get = stub_support_problem_reports(params)
+
+      @api.problem_reports(params)
+
+      assert_requested(stub_get)
+    end
+  end
+
+  describe "POST /anonymous-feedback/problem-reports/mark-reviewed-for-spam" do
+    it "makes a PUT request to the support API" do
+      params = { "1" => true, "2" => true }
+
+      stub_post = stub_support_mark_reviewed_for_spam(params)
+
+      @api.mark_reviewed_for_spam(params)
+
+      assert_requested(stub_post)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 36.0.1
+  version: 36.1.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek