ngp_van 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee6f60a0fa52aab7fcf11ea63ccd58d41378b91e40e62015f436d4c1b7c4ed0
-  data.tar.gz: 0256afd4cc5a4cfb32623fdb59d31031a06aafd82f99970bc0a5274f01fd3d95
+  metadata.gz: 56d7e5c4dead43ca39fae5067a833f1e0b02fbe3d0368063070a97b6ca1506dc
+  data.tar.gz: b0199579935ae12dc660c011300e97629deccd9732ec3c83661b7b4e5435e668
 SHA512:
-  metadata.gz: 43bcb317b64329e93ffce5cb311595067cd208e01c71b1437edecb8c6fdcdf28ade008b5e8b34c726113777073ec8ab38848b1e5445795278fbdc3f13646ffb7
-  data.tar.gz: c5cebd2d17c3e929d8f8732d2fe20c8d307bfd3f114b8f09ec945c5c1fe279a2fcb203deee37df22d41f713cae010024c214dbe7b1358bfb4749e248902c01e2
+  metadata.gz: 0eb470d707c3bca33acb265209723bdc840993164ae2cb34fde4faf78d6e04799ee0f0f1c9be70754bb40121d3a1d69be11b217deb634df8dd5ab3bd2e3a1217
+  data.tar.gz: '0859eacce369cb8361feaa8455dfec4e9d51ba23a4cb214509f097e2fc9b879eb19f2423d506a690205f0f4f88b583ac498ea4001fb08468c48a65412067386d'

data/lib/ngp_van/client.rb

@@ -17,6 +17,7 @@ require 'ngp_van/client/printed_lists'
 require 'ngp_van/client/minivan_exports'
 require 'ngp_van/client/signups'
 require 'ngp_van/client/survey_questions'
+require 'ngp_van/client/supporter_groups'
 require 'ngp_van/client/users'
 
 module NgpVan
@@ -46,6 +47,7 @@ module NgpVan
     include NgpVan::Client::PrintedLists
     include NgpVan::Client::MinivanExports
     include NgpVan::Client::Signups
+    include NgpVan::Client::SupporterGroups
     include NgpVan::Client::SurveyQuestions
     include NgpVan::Client::Users
   end

data/lib/ngp_van/client/supporter_groups.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module SupporterGroups
+      def create_supporter_group(body: {})
+        post(path: 'supporterGroups', body: body)
+      end
+
+      def supporter_group(id:, params: {})
+        get(path: "supporterGroups/#{id}", params: params)
+      end
+
+      def supporter_groups(params: {})
+        get(path: 'supporterGroups', params: params)
+      end
+
+      def add_person_to_supporter_group(supporter_group_id:, id:)
+        put(path: "supporterGroups/#{supporter_group_id}/people/#{id}")
+      end
+
+      def remove_person_from_supporter_group(supporter_group_id:, id:)
+        delete(path: "supporterGroups/#{supporter_group_id}/people/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/version.rb

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

data/spec/ngp_van/client/supporter_groups_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  # rubocop:disable Metrics/ClassLength
+  class Client
+    RSpec.describe SupporterGroups do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#create_supporter_group' do
+        let(:body) do
+          JSON.parse(fixture('create_supporter_group.json').read)
+        end
+
+        let(:url) { build_url(client: client, path: 'supporterGroups') }
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: '1122',
+              status: 201,
+              headers: {
+                'Location' => build_url(client: client, path: '/supporterGroups/1122')
+              }
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.create_supporter_group(body: body)
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns the created id' do
+          expect(client.create_supporter_group(body: body)).to eq(1122)
+        end
+      end
+
+      describe '#supporter_group' do
+        let(:response) { fixture('supporter_group.json') }
+        let(:url) { build_url(client: client, path: 'supporterGroups/1122') }
+
+        before do
+          stub_request(:get, url).to_return(body: response)
+        end
+
+        it 'requests the correct resource' do
+          client.supporter_group(id: 1122)
+          expect(a_request(:get, url)).to have_been_made
+        end
+
+        it 'returns a event object' do
+          supporter_group = client.supporter_group(id: 1122)
+          expect(supporter_group).to be_a(Hash)
+        end
+
+        it 'returns the requested supporter group' do
+          supporter_group = client.supporter_group(id: 1122)
+          expect(supporter_group['id']).to eq(1122)
+        end
+      end
+
+      describe '#supporter_groups' do
+        let(:params) do
+          {
+            '$top' => 2
+          }
+        end
+
+        let(:response) { fixture('supporter_groups.json') }
+        let(:url) { build_url(client: client, path: 'supporterGroups') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.supporter_groups(params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns an array of items' do
+          supporter_groups = client.supporter_groups(params: params)
+          expect(supporter_groups['items']).to be_a(Array)
+        end
+
+        it 'returns the requested supporter groups' do
+          supporter_groups = client.supporter_groups(params: params)
+          expect(supporter_groups['items'].first['id']).to eq(1122)
+        end
+      end
+
+      describe '#add_person_to_supporter_group' do
+        let(:url) { build_url(client: client, path: 'supporterGroups/1122/people/3344') }
+
+        before do
+          stub_request(:put, url).to_return(status: 204)
+        end
+
+        it 'requests the correct resource' do
+          client.add_person_to_supporter_group(supporter_group_id: 1122, id: 3344)
+          expect(a_request(:put, url)).to have_been_made
+        end
+      end
+
+      describe '#remove_person_from_supporter_group' do
+        let(:url) { build_url(client: client, path: 'supporterGroups/1122/people/3344') }
+
+        before do
+          stub_request(:delete, url).to_return(status: 204)
+
+          it 'requests the correct resource' do
+            client.add_person_to_supporter_group(supporter_group_id: 1122, id: 3344)
+            expect(a_request(:delete, url)).to have_been_made
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/fixtures/create_supporter_group.json

@@ -0,0 +1,4 @@
+{
+    "name": "North End Volunteers",
+    "description": "Volunteers from the North End that help out frequently"
+}

data/spec/support/fixtures/supporter_group.json

@@ -0,0 +1,5 @@
+{
+    "id": 1122,
+    "name": "North End Volunteers",
+    "description": "Volunteers from the North End that help out frequently"
+}

data/spec/support/fixtures/supporter_groups.json

@@ -0,0 +1,16 @@
+{
+  "items": [
+    {
+      "id": 1122,
+      "name": "North End Volunteers",
+      "description": "Volunteers from the North End that help out frequently"
+    },
+    {
+      "id": 1123,
+      "name": "South End Volunteers",
+      "description": "Volunteers from the South End that help out not so frequently"
+    }
+  ],
+  "nextPageLink": "https://api.securevan.com:443/v4/supporterGroups?$top=2&$skip=2",
+  "count": 5
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngp_van
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Christopher Styles
@@ -36,7 +36,7 @@ cert_chain:
   uZ9aI1c3Tt/pkw9HxXwDo1m/+BQOZkAhEZu6LQQgBPAX8hlUyDw54SoJtfnFp0FI
   Hje6PutFGypAA8f9kmLl8X2Eu74D8PI9ywc=
   -----END CERTIFICATE-----
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -101,6 +101,7 @@ files:
 - lib/ngp_van/client/people.rb
 - lib/ngp_van/client/printed_lists.rb
 - lib/ngp_van/client/signups.rb
+- lib/ngp_van/client/supporter_groups.rb
 - lib/ngp_van/client/survey_questions.rb
 - lib/ngp_van/client/users.rb
 - lib/ngp_van/configuration.rb
@@ -123,6 +124,7 @@ files:
 - spec/ngp_van/client/people_spec.rb
 - spec/ngp_van/client/printed_lists_spec.rb
 - spec/ngp_van/client/signups_spec.rb
+- spec/ngp_van/client/supporter_groups_spec.rb
 - spec/ngp_van/client/survey_questions_spec.rb
 - spec/ngp_van/client/users_spec.rb
 - spec/ngp_van/client_spec.rb
@@ -144,6 +146,7 @@ files:
 - spec/support/fixtures/create_event_shift.json
 - spec/support/fixtures/create_location.json
 - spec/support/fixtures/create_signup.json
+- spec/support/fixtures/create_supporter_group.json
 - spec/support/fixtures/create_user_district_field_values.json
 - spec/support/fixtures/district_field.json
 - spec/support/fixtures/district_fields.json
@@ -166,6 +169,8 @@ files:
 - spec/support/fixtures/signup.json
 - spec/support/fixtures/signup_statuses.json
 - spec/support/fixtures/signups.json
+- spec/support/fixtures/supporter_group.json
+- spec/support/fixtures/supporter_groups.json
 - spec/support/fixtures/survey_question.json
 - spec/support/fixtures/survey_questions.json
 - spec/support/fixtures/update_code.json