ngp_van 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccb2039be63263fbefef7442a15d89a5a282955065e7f511b277f6568fcf93ec
-  data.tar.gz: e50582b396dd4820e85edb297a384887f720742bea7803c9fd8468d47391751f
+  metadata.gz: 6605b07f76aa3dff12a6b31bbe049cc8a54096059c8b4df97542fb15505f9a8f
+  data.tar.gz: 117da358bf89bbad7d26376aa7290e7b3e6918d023920764a9b723a082f22f46
 SHA512:
-  metadata.gz: d6879c125fe459db80cd6b349484b1440bb00b5de20939b54f63cd407f7a5d33f199dc7e5eb7baa4e513f6162e7dd81dbe9f93c2721cbba2f600e5d513d92fd9
-  data.tar.gz: 1a6f0f9a61b96f852cffdc2ed8c745e4538a6b64618bae4bb6dcda69f0ab01d9534189a721ac452f2398b274dbb1ab843c2f847dff2161f1c773f20df40c8f4b
+  metadata.gz: 8a5b21a769638e6f4bc20aa4ceff7fff922ff3772863f689569fb678aa3f119daa7f04fbdd9fd249b62698922b61ffb32e6d46e54cebf4ae2ae111ae73f2e49f
+  data.tar.gz: 4f9ed158ae0ee2aa141f630d3d5911f9203c9a2a1e311a90f951570546e9a9e5bfccf38ce392189116b255e362399c43c1ba536cb7bc4af3dd1f95d858053e3f

data.tar.gz.sig

@@ -1,3 +1 @@
-�i�eOj��v�1T�WUM0���~�:�0qQ?r�s���J3z}׼�7]�i'����h�Y���R�W�3w�_��Mt�Z��)�����	�3���]��%j��}Y�Ssh=�u<R=��`�7�DFҥ6y����}Ypw��%<M�]Y*
-��qxsJq5C�;��C��	�}��ص������@E�n�خ�����Kt�a����gq���;������d*��i�C7�#�ۀc��|+)�w?��	�X�:g~ֳ*�蠯!��=����-L����+Rߦ��h��)h�(��3�o����9ΰw,��i�ks�S�0�l�X�C7�p��.�I��)F�)�׌t
-�>���*��PH���"�6{��_+
++��������X3!���>[�>$[_�����b/�KV�D�WK�<f�~�

data/lib/ngp_van.rb

@@ -5,11 +5,11 @@ require 'ngp_van/configuration'
 require 'ngp_van/version'
 
 module NgpVan
-  class << self
-    # The NgpVan configuration object.
-    # @return [NgpVan::Configuration]
-    attr_reader :configuration
+  class Invalid < StandardError; end
+
+  class InvalidID < Invalid; end
 
+  class << self
     def client
       @client ||= NgpVan::Client.new
     end

data/lib/ngp_van/client.rb

@@ -23,7 +23,6 @@ require 'ngp_van/client/users'
 
 module NgpVan
   class Client
-
     def initialize(configuration = nil)
       @config = configuration
     end
@@ -32,6 +31,18 @@ module NgpVan
       @config || NgpVan.configuration
     end
 
+    def valid_id?(id)
+      id.to_s =~ /\A[a-z0-9\-:]+\z/i ? true : false
+    end
+
+    def verify_id(*ids)
+      ids.each do |id|
+        raise NgpVan::InvalidID unless valid_id?(id)
+      end
+      nil
+    end
+    alias_method :verify_ids, :verify_id
+
     include NgpVan::Connection
     include NgpVan::Request
     include NgpVan::Response

data/lib/ngp_van/client/activist_codes.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def activist_code(id:, params: {})
+        verify_id(id)
         get(path: "activistCodes/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/codes.rb

@@ -12,6 +12,7 @@ module NgpVan
       end
 
       def code(id:, params: {})
+        verify_id(id)
         get(path: "codes/#{id}", params: params)
       end
 
@@ -20,10 +21,12 @@ module NgpVan
       end
 
       def update_code(id:, body: {})
+        verify_id(id)
         put(path: "codes/#{id}", body: body)
       end
 
       def delete_code(id:)
+        verify_id(id)
         delete(path: "codes/#{id}")
       end
     end

data/lib/ngp_van/client/district_fields.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def district_field(id:)
+        verify_id(id)
         get(path: "districtFields/#{id}")
       end
     end

data/lib/ngp_van/client/event_types.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def event_type(id:, params: {})
+        verify_id(id)
         get(path: "events/types/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/events.rb

@@ -8,10 +8,12 @@ module NgpVan
       end
 
       def create_event_shift(id:, body: {})
+        verify_id(id)
         post(path: "events/#{id}/shifts", body: body)
       end
 
       def event(id:, params: {})
+        verify_id(id)
         get(path: "events/#{id}", params: params)
       end
 
@@ -20,10 +22,12 @@ module NgpVan
       end
 
       def update_event(id:, body: {})
+        verify_id(id)
         put(path: "events/#{id}", body: body)
       end
 
       def delete_event(id:)
+        verify_id(id)
         delete(path: "events/#{id}")
       end
     end

data/lib/ngp_van/client/locations.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def location(id:, params: {})
+        verify_id(id)
         get(path: "locations/#{id}", params: params)
       end
 
@@ -20,6 +21,7 @@ module NgpVan
       end
 
       def delete_location(id:)
+        verify_id(id)
         delete(path: "locations/#{id}")
       end
     end

data/lib/ngp_van/client/minivan_exports.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def minivan_export(id:, params: {})
+        verify_id(id)
         get(path: "minivanExports/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/notes.rb

@@ -12,6 +12,7 @@ module NgpVan
       end
 
       def note_category(id:, params: {})
+        verify_id(id)
         get(path: "notes/categories/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/people.rb

@@ -12,18 +12,22 @@ module NgpVan
       end
 
       def person(id:, params: {})
+        verify_id(id)
         get(path: "people/#{id}", params: params)
       end
 
       def person_by_type(id:, type:, params: {})
+        verify_ids(id, type)
         get(path: "people/#{type}:#{id}", params: params)
       end
 
       def create_canvass_responses_for_person(id:, body: {})
+        verify_id(id)
         post(path: "people/#{id}/canvassResponses", body: body)
       end
 
       def create_canvass_responses_for_person_by_type(id:, type:, body: {})
+        verify_ids(id, type)
         post(path: "people/#{type}:#{id}/canvassResponses", body: body)
       end
     end

data/lib/ngp_van/client/printed_lists.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def printed_list(id:, params: {})
+        verify_id(id)
         get(path: "printedLists/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/signups.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def signup(id:, params: {})
+        verify_id(id)
         get(path: "signups/#{id}", params: params)
       end
 
@@ -20,10 +21,12 @@ module NgpVan
       end
 
       def update_signup(id:, body: {})
+        verify_id(id)
         put(path: "signups/#{id}", body: body)
       end
 
       def delete_signup(id:)
+        verify_id(id)
         delete(path: "signups/#{id}")
       end
     end

data/lib/ngp_van/client/supporter_groups.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def supporter_group(id:, params: {})
+        verify_id(id)
         get(path: "supporterGroups/#{id}", params: params)
       end
 
@@ -16,10 +17,12 @@ module NgpVan
       end
 
       def add_person_to_supporter_group(supporter_group_id:, id:)
+        verify_ids(id, supporter_group_id)
         put(path: "supporterGroups/#{supporter_group_id}/people/#{id}")
       end
 
       def remove_person_from_supporter_group(supporter_group_id:, id:)
+        verify_ids(id, supporter_group_id)
         delete(path: "supporterGroups/#{supporter_group_id}/people/#{id}")
       end
     end

data/lib/ngp_van/client/survey_questions.rb

@@ -8,6 +8,7 @@ module NgpVan
       end
 
       def survey_question(id:, params: {})
+        verify_id(id)
         get(path: "surveyQuestions/#{id}", params: params)
       end
     end

data/lib/ngp_van/client/users.rb

@@ -4,14 +4,17 @@ module NgpVan
   class Client
     module Users
       def user_district_field_values(id:, params: {})
+        verify_id(id)
         get(path: "users/#{id}/districtFieldValues", params: params)
       end
 
       def create_user_district_field_values(id:, body: {})
+        verify_id(id)
         post(path: "users/#{id}/districtFieldValues", body: body)
       end
 
       def update_user_district_field_values(id:, body: {})
+        verify_id(id)
         put(path: "users/#{id}/districtFieldValues", body: body)
       end
     end

data/lib/ngp_van/request.rb

@@ -28,7 +28,7 @@ module NgpVan
 
     def request(method:, path:, params: {}, body: {})
       response = connection.send(method) do |request|
-        request.path = URI.encode(path)
+        request.path = path
         request.params = params
         request.body = ::JSON.generate(body) unless body.empty?
       end

data/lib/ngp_van/version.rb

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

data/spec/ngp_van/client_spec.rb

@@ -30,5 +30,62 @@ module NgpVan
         expect(client.config.user_agent).to eq('test agent')
       end
     end
+
+    describe '#valid_id?' do
+      let(:client) { NgpVan::Client.new }
+
+      context 'with a valid id' do
+        it 'returns true' do
+          expect(client.valid_id?(123)).to eq(true)
+          expect(client.valid_id?('abc')).to eq(true)
+          expect(client.valid_id?('abc-123')).to eq(true)
+          expect(client.valid_id?('onlineReferenceNumber:123')).to eq(true)
+        end
+      end
+
+      context 'with an invalid id' do
+        it 'returns false' do
+          expect(client.valid_id?('fu?evil=mode')).to eq(false)
+          expect(client.valid_id?('fu/bar')).to eq(false)
+          expect(client.valid_id?('%20')).to eq(false)
+        end
+      end
+    end
+
+    describe '#verify_id' do
+      let(:client) { NgpVan::Client.new }
+
+      context 'with a single id' do
+        context 'when valid' do
+          it 'returns nil' do
+            expect(client.verify_id(123)).to eq(nil)
+          end
+        end
+
+        context 'when invalid' do
+          it 'raises an error' do
+            expect {
+              client.verify_id('fu?evil=mode')
+            }.to raise_error(NgpVan::InvalidID)
+          end
+        end
+      end
+
+      context 'with a list of ids' do
+        context 'when valid' do
+          it 'returns nil' do
+            expect(client.verify_id('abc', 123, 'abc-123')).to eq(nil)
+          end
+        end
+
+        context 'when invalid' do
+          it 'raises an error' do
+            expect {
+              client.verify_id('abc', 'fu?evil=mode', 'abc-123')
+            }.to raise_error(NgpVan::InvalidID)
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngp_van
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Christopher Styles
@@ -36,7 +36,7 @@ cert_chain:
   uZ9aI1c3Tt/pkw9HxXwDo1m/+BQOZkAhEZu6LQQgBPAX8hlUyDw54SoJtfnFp0FI
   Hje6PutFGypAA8f9kmLl8X2Eu74D8PI9ywc=
   -----END CERTIFICATE-----
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday