ngp_van 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986b916578056027f4a48d0697590e5b94a42fc1f19ce69064829eeebc307827
-  data.tar.gz: 2f101d57778b4d3e42178101d7a4fcf92f0ee8d3a730a8d7a994956a95987ccd
+  metadata.gz: e8135b5448157fb85dc8ca3a23c2fc51e7311bd6c66549ac79791d988a3d810d
+  data.tar.gz: f651d7a9410049e0d9c5afd297bc04f879431e9b45b5111113fe8a9cac2ac7df
 SHA512:
-  metadata.gz: 192aca1faea78289b8af83fdb77948ec925c453804a6d79e1eeb0afbce74d6f919c1f21e2d4b21fa64b0eee0fbf913cbd00b40e11ffe311c6c499eb03199fffc
-  data.tar.gz: e39e207c65d3421268d90c71d07efd2a3484e3070814b6c443aac940a39b14610838e79907de5d072fc4a25cc9890fdb320a4f09735746c7e15ba53953c9db21
+  metadata.gz: a7006b741d31057e106402da68e17363fb575f7f465b70667c9b97222e6e6e48774a8e46ed43a259827c8e2abd7a338a8f46705e355088e5313697978e02291e
+  data.tar.gz: c186787fde9edf7961e2aacd316ad2e2404f47537d10afaf0c85e97533f000ac8c2f86e94357a7502a47661c5a0d6bee73a30d4c262c78dbc0cb7f68a695db60

data/lib/ngp_van/client.rb

@@ -11,11 +11,14 @@ require 'ngp_van/client/district_fields'
 require 'ngp_van/client/echoes'
 require 'ngp_van/client/events'
 require 'ngp_van/client/event_types'
+require 'ngp_van/client/export_jobs'
 require 'ngp_van/client/locations'
 require 'ngp_van/client/notes'
 require 'ngp_van/client/people'
+require 'ngp_van/client/phones'
 require 'ngp_van/client/printed_lists'
 require 'ngp_van/client/minivan_exports'
+require 'ngp_van/client/saved_lists'
 require 'ngp_van/client/signups'
 require 'ngp_van/client/stories'
 require 'ngp_van/client/survey_questions'
@@ -55,11 +58,14 @@ module NgpVan
     include NgpVan::Client::Echoes
     include NgpVan::Client::Events
     include NgpVan::Client::EventTypes
+    include NgpVan::Client::ExportJobs
     include NgpVan::Client::Locations
     include NgpVan::Client::Notes
     include NgpVan::Client::People
+    include NgpVan::Client::Phones
     include NgpVan::Client::PrintedLists
     include NgpVan::Client::MinivanExports
+    include NgpVan::Client::SavedLists
     include NgpVan::Client::Signups
     include NgpVan::Client::Stories
     include NgpVan::Client::SupporterGroups

data/lib/ngp_van/client/export_jobs.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module ExportJobs
+      def create_export_job(body: {})
+        post(path: 'exportJobs', body: body)
+      end
+
+      def export_job(id:)
+        verify_id(id)
+        get(path: "exportJobs/#{id}")
+      end
+
+      def export_job_types
+        get(path: 'exportJobTypes')
+      end
+    end
+  end
+end

data/lib/ngp_van/client/people.rb

@@ -40,6 +40,26 @@ module NgpVan
         verify_ids(id, codeId)
         delete(path: "people/#{id}/codes/#{codeId}")
       end
+
+      def update_person_by_van_id(id:, body: {})
+        verify_id(id)
+        post(path: "people/#{id}", body: body)
+      end
+
+      def get_person_by_van_id(id:, params: {})
+        verify_id(id)
+        get(path: "people/#{id}", params: params)
+      end
+
+      def create_notes_for_person(id:, body: {})
+        verify_id(id)
+        post(path: "people/#{id}/notes", body: body)
+      end
+
+      def create_notes_for_person_by_type(id:, type:, body: {})
+        verify_ids(id, type)
+        post(path: "people/#{type}:#{id}/notes", body: body)
+      end
     end
   end
 end

data/lib/ngp_van/client/phones.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Phones
+      def is_cell_statuses
+        get(path: 'phones/isCellStatuses')
+      end
+    end
+  end
+end

data/lib/ngp_van/client/saved_lists.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module SavedLists
+      def saved_lists(params: {})
+        get(path: 'savedLists', params: params)
+      end
+
+      def saved_list(id:)
+        verify_id(id)
+        get(path: "savedLists/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/version.rb

@@ -7,7 +7,7 @@ module NgpVan
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 9
+  MINOR = 10
 
   # Current patch level.
   # @return [Integer]

data/spec/ngp_van/client/export_jobs_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  class Client
+    RSpec.describe ExportJobs do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#create_export_job' do
+        let(:body) do
+          JSON.parse(fixture('create_export_job.json').read)
+        end
+
+        let(:url) { build_url(client: client, path: 'exportJobs') }
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: '999888',
+              status: 201
+            )
+        end
+
+        it 'returns the correct resource' do
+          client.create_export_job(body: body)
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns the created id' do
+          expect(client.create_export_job(body: body)).to eq(999888)
+        end
+      end
+
+      describe '#get_export_job' do
+        let(:response) { fixture('export_job.json') }
+        let(:url) { build_url(client: client, path: 'exportJobs/999888') }
+
+        before do
+          stub_request(:get, url).to_return(body: response)
+        end
+
+        it 'requests the correct resource' do
+          client.export_job(id: 999888)
+          expect(a_request(:get, url)).to have_been_made
+        end
+
+        it 'returns an event object' do
+          export_job = client.export_job(id: 999888)
+          expect(export_job).to be_a(Hash)
+        end
+
+        it 'returns the requested export job' do
+          export_job = client.export_job(id: 999888)
+          expect(export_job['exportJobId']).to eq(999888)
+        end
+      end
+
+      describe '#get_export_job_types' do
+        let(:response) { fixture('export_job_types.json') }
+        let(:url) { build_url(client: client, path: 'exportJobTypes') }
+
+        before do
+          stub_request(:get, url).to_return(body: response)
+        end
+
+        it 'requests the correct resource' do
+          client.export_job_types
+          expect(a_request(:get, url)).to have_been_made
+        end
+
+        it 'returns an array of items' do
+          export_job_types = client.export_job_types
+          expect(export_job_types['items']).to be_a(Array)
+        end
+
+        it 'returns the request export job type' do
+          export_job_types = client.export_job_types
+          expect(export_job_types['items'].first['exportJobTypeId']).to eq(4)
+        end
+      end
+    end
+  end
+end

data/spec/ngp_van/client/people_spec.rb

@@ -271,6 +271,152 @@ module NgpVan
           ).to eq('')
         end
       end
+
+      describe '#update_person_by_van_id' do
+        let(:body) do
+          JSON.parse(fixture('match_candidate.json').read)
+        end
+        let(:response) { fixture('match_response.json') }
+        let(:url) { build_url(client: client, path: 'people/1234') }
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.update_person_by_van_id(id: 1234, body: body)
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns a person record when record is found' do
+          person = client.update_person_by_van_id(id: 1234, body: body)
+          expect(person).to be_a(Hash)
+        end
+
+        it 'returns the requested person when record is found' do
+          person = client.update_person_by_van_id(id: 1234, body: body)
+          expect(person['vanId']).to eq(1_264_324)
+        end
+      end
+
+      describe '#finds_person_by_van_id' do
+        let(:params) do
+          {
+            '$expand' => 'phones,emails,addresses'
+          }
+        end
+        let(:response) { fixture('person.json') }
+        let(:url) { build_url(client: client, path: 'people/215501') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.get_person_by_van_id(id: 215501, params: params)
+          expect(
+            a_request(:get, url)
+              .with(
+                query: params
+              )
+          ).to have_been_made
+        end
+
+        it 'returns a person record when record is found' do
+          person = client.get_person_by_van_id(id: 215501, params: params)
+          expect(person).to be_a(Hash)
+        end
+
+        it 'returns the requested person when record is found' do
+          person = client.get_person_by_van_id(id: 215501, params: params)
+          expect(person['vanId']).to eq(215501)
+        end
+      end
+
+      describe '#create_note_for_person' do
+        let(:body) do
+          JSON.parse(fixture('create_notes.json').read)
+        end
+
+        let(:url) { build_url(client: client, path: 'people/215501/notes') }
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: '',
+              status: 204
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.create_notes_for_person(id: 215_501, body: body)
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns an empty response' do
+          expect(
+            client.create_notes_for_person(id: 215_501, body: body)
+          ).to eq('')
+        end
+      end
+
+      describe '#create_note_for_person by type' do
+        let(:body) do
+          JSON.parse(fixture('create_notes.json').read)
+        end
+
+        let(:url) do
+          build_url(client: client, path: 'people/dwid:215501/notes')
+        end
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: '',
+              status: 204
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.create_notes_for_person_by_type(
+            id: 215_501, type: 'dwid', body: body
+          )
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns an empty response' do
+          expect(
+            client.create_notes_for_person_by_type(
+              id: 215_501, type: 'dwid', body: body
+            )
+          ).to eq('')
+        end
+      end
     end
   end
 end

data/spec/ngp_van/client/phones_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  class Client
+    RSpec.describe Phones do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#is_cell_statuses' do
+        let(:response) { fixture('phones.json') }
+        let(:url) { build_url(client: client, path: 'phones/isCellStatuses') }
+
+        before do
+          stub_request(:get, url)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.is_cell_statuses
+          expect(a_request(:get, url)).to have_been_made
+        end
+      end
+    end
+  end
+end

data/spec/ngp_van/client/saved_lists_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  class Client
+    RSpec.describe SavedLists do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#saved_lists' do
+        let(:params) do
+          {
+            folderId: '1234',
+            maxDoorCount: '1000',
+            maxPeopleCount: '2000'
+          }
+        end
+
+        let(:response) { fixture('saved_lists.json') }
+        let(:url) { build_url(client: client, path: 'savedLists') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          saved_lists = client.saved_lists(params: params)
+          expect(saved_lists['items']).to be_a(Array)
+        end
+
+        it 'returns the requested saved_lists' do
+          saved_lists = client.saved_lists(params: params)
+          expect(saved_lists['items'].first['savedListId']).to eq(999888777)
+        end
+      end
+
+      describe '#saved_list' do
+        let(:response) { fixture('saved_list.json') }
+        let(:url) { build_url(client: client, path: 'savedLists/999888777') }
+
+        before do
+          stub_request(:get, url).to_return(body: response)
+        end
+
+        it 'requests the correct resource' do
+          client.saved_list(id: 999888777)
+          expect(a_request(:get, url)).to have_been_made
+        end
+
+        it 'returns an event object' do
+          saved_list = client.saved_list(id: 999888777)
+          expect(saved_list).to be_a(Hash)
+        end
+
+        it 'returns the request saved_list' do
+          saved_list = client.saved_list(id: 999888777)
+          expect(saved_list['savedListId']).to eq(999888777)
+        end
+      end
+    end
+  end
+end

data/spec/support/fixtures/create_export_job.json

@@ -0,0 +1,5 @@
+{
+  "savedListId": 1234,
+  "type": 777,
+  "webhookUrl": "https://webhook.example.org/completedExportJobs"
+}

data/spec/support/fixtures/create_notes.json

@@ -0,0 +1,7 @@
+{
+  "text": "Great chat! This person will be able to volunteer next year.",
+  "isViewRestricted": false,
+  "category": {
+    "noteCategoryId": 99
+  }
+}

data/spec/support/fixtures/export_job.json

@@ -0,0 +1,15 @@
+{
+  "exportJobId": 999888,
+  "exportJobGuid": "7B623929-05DA-4356-BF30-EF7D1BB0248C",
+  "savedListId": 1234,
+  "webhookUrl": "https://webhook.example.org/completedExportJobs",
+  "downloadUrl": "https://ngpvan.blob.core.windows.net/completed-export-jobs/7B623929-05DA-4356-BF30-EF7D1BB0248C_2017-01-01T12:00:00.csv",
+  "status": "Completed",
+  "type": 777,
+  "dateExpired": "2017-01-04T12:00:00Z",
+  "errorCode": null,
+  "surveyQuestions": [ { "surveyQuestionId": 1234 } ],
+  "activistCodes": [ { "activistCodeId": 4567 } ],
+  "customFields": [ { "customFieldId": 5678 } ],
+  "districtFields": [ { "districtFieldId": 10 } ]
+}

data/spec/support/fixtures/export_job_types.json

@@ -0,0 +1,10 @@
+{
+  "items": [
+    {
+      "exportJobTypeId": 4,
+      "name": "SavedListExport"
+    }
+  ],
+  "nextPageLink": null,
+  "count": 1
+}

data/spec/support/fixtures/phones.json

@@ -0,0 +1,22 @@
+{
+  "items": [
+    {
+      "statusId": 1,
+      "statusName": "Verified Cell"
+    },
+    {
+      "statusId": 2,
+      "statusName": "Likely Cell"
+    },
+    {
+      "statusId": 3,
+      "statusName": "Likely Not a Cell"
+    },
+    {
+      "statusId": 4,
+      "statusName": "Not a Cell"
+    }
+  ],
+  "nextPageLink": null,
+  "count": 4
+}

data/spec/support/fixtures/saved_list.json

@@ -0,0 +1,7 @@
+{
+  "savedListId": 999888777,
+  "name": "GOTV list",
+  "description": "People we want to talk to for GOTV",
+  "listCount": 2000,
+  "doorCount": 987
+}

data/spec/support/fixtures/saved_lists.json

@@ -0,0 +1,11 @@
+{
+  "items": [
+    {
+      "savedListId": 999888777,
+      "name": "GOTV list",
+      "description": "People we want to talk to for GOTV",
+      "listCount": 2000,
+      "doorCount": 987
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngp_van
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Christopher Styles
@@ -35,7 +35,7 @@ cert_chain:
   39TOGM5UYCjPNfgN1phZsQZYAqt9izy3YK2+ih92vtsB+0z4Cs9UanhYj97Z4lj+
   cQFVep+b/7Dph1WPZLQM7aAX
   -----END CERTIFICATE-----
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -95,11 +95,14 @@ files:
 - lib/ngp_van/client/echoes.rb
 - lib/ngp_van/client/event_types.rb
 - lib/ngp_van/client/events.rb
+- lib/ngp_van/client/export_jobs.rb
 - lib/ngp_van/client/locations.rb
 - lib/ngp_van/client/minivan_exports.rb
 - lib/ngp_van/client/notes.rb
 - lib/ngp_van/client/people.rb
+- lib/ngp_van/client/phones.rb
 - lib/ngp_van/client/printed_lists.rb
+- lib/ngp_van/client/saved_lists.rb
 - lib/ngp_van/client/signups.rb
 - lib/ngp_van/client/stories.rb
 - lib/ngp_van/client/supporter_groups.rb
@@ -120,11 +123,14 @@ files:
 - spec/ngp_van/client/district_fields_spec.rb
 - spec/ngp_van/client/event_types_spec.rb
 - spec/ngp_van/client/events_spec.rb
+- spec/ngp_van/client/export_jobs_spec.rb
 - spec/ngp_van/client/locations_spec.rb
 - spec/ngp_van/client/minivan_exports_spec.rb
 - spec/ngp_van/client/notes_spec.rb
 - spec/ngp_van/client/people_spec.rb
+- spec/ngp_van/client/phones_spec.rb
 - spec/ngp_van/client/printed_lists_spec.rb
+- spec/ngp_van/client/saved_lists_spec.rb
 - spec/ngp_van/client/signups_spec.rb
 - spec/ngp_van/client/stories_spec.rb
 - spec/ngp_van/client/supporter_groups_spec.rb
@@ -147,7 +153,9 @@ files:
 - spec/support/fixtures/create_code.json
 - spec/support/fixtures/create_event.json
 - spec/support/fixtures/create_event_shift.json
+- spec/support/fixtures/create_export_job.json
 - spec/support/fixtures/create_location.json
+- spec/support/fixtures/create_notes.json
 - spec/support/fixtures/create_signup.json
 - spec/support/fixtures/create_story.json
 - spec/support/fixtures/create_supporter_group.json
@@ -158,6 +166,8 @@ files:
 - spec/support/fixtures/event_type.json
 - spec/support/fixtures/event_types.json
 - spec/support/fixtures/events.json
+- spec/support/fixtures/export_job.json
+- spec/support/fixtures/export_job_types.json
 - spec/support/fixtures/location.json
 - spec/support/fixtures/locations.json
 - spec/support/fixtures/match_candidate.json
@@ -168,6 +178,7 @@ files:
 - spec/support/fixtures/note_category.json
 - spec/support/fixtures/note_category_types.json
 - spec/support/fixtures/person.json
+- spec/support/fixtures/phones.json
 - spec/support/fixtures/printed_list.json
 - spec/support/fixtures/printed_lists.json
 - spec/support/fixtures/pronouns.json
@@ -176,6 +187,8 @@ files:
 - spec/support/fixtures/reported_language_preferences.json
 - spec/support/fixtures/reported_races.json
 - spec/support/fixtures/reported_sexual_orientations.json
+- spec/support/fixtures/saved_list.json
+- spec/support/fixtures/saved_lists.json
 - spec/support/fixtures/signup.json
 - spec/support/fixtures/signup_statuses.json
 - spec/support/fixtures/signups.json