ngp_van 0.1.1

data/spec/ngp_van/client/survey_questions_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  class Client
+    RSpec.describe SurveyQuestions do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#survey_questions' do
+        let(:params) do
+          {
+            statuses: 'Active,Archived',
+            cycle: '2010',
+            type: 'Candidate'
+          }
+        end
+
+        let(:response) { fixture('survey_questions.json') }
+        let(:url) { build_url(client: client, path: 'surveyQuestions') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.survey_questions(params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns an array of items' do
+          survey_questions = client.survey_questions(params: params)
+          expect(survey_questions['items']).to be_a(Array)
+        end
+
+        it 'returns the requested survey_questions' do
+          survey_questions = client.survey_questions(params: params)
+          expect(survey_questions['items'].first['surveyQuestionId'])
+            .to eq(54_945)
+        end
+      end
+
+      describe '#survey_question' do
+        let(:params) { Hash.new }
+        let(:response) { fixture('survey_question.json') }
+        let(:url) { build_url(client: client, path: 'surveyQuestions/54949') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.survey_question(id: 54_949, params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns a survey_question object' do
+          survey_question = client.survey_question(id: 54_949, params: params)
+          expect(survey_question).to be_a(Hash)
+        end
+
+        it 'returns the requested survey_question' do
+          survey_question = client.survey_question(id: 54_949, params: params)
+          expect(survey_question['surveyQuestionId']).to eq(54_949)
+        end
+      end
+    end
+  end
+end

data/spec/ngp_van/client/users_spec.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  class Client
+    RSpec.describe Users do
+      let(:client) { NgpVan::Client.new }
+
+      describe '#user_district_field_values' do
+        let(:params) { Hash.new }
+        let(:response) { fixture('user_district_field_values.json') }
+
+        let(:url) do
+          build_url(client: client, path: 'users/1234/districtFieldValues')
+        end
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.user_district_field_values(id: 1234, params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns district field values for a user' do
+          results = client.user_district_field_values(id: 1234, params: params)
+          expect(results).to be_a(Hash)
+        end
+
+        it 'returns the requested district field values' do
+          results = client.user_district_field_values(id: 1234, params: params)
+          expect(results['districtFieldValues'].first).to eq('W1P2')
+        end
+      end
+
+      describe '#create_user_district_field_values' do
+        let(:body) do
+          JSON.parse(
+            File.read(fixture_path + '/create_user_district_field_values.json')
+          )
+        end
+
+        let(:response) { fixture('user_district_field_values.json') }
+
+        let(:url) do
+          build_url(client: client, path: 'users/12345/districtFieldValues')
+        end
+
+        before do
+          stub_request(:post, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.create_user_district_field_values(id: 12_345, body: body)
+          expect(
+            a_request(:post, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns the user district field value assignments' do
+          results = client.create_user_district_field_values(id: 12_345,
+                                                             body: body)
+          expect(results['districtFieldValues'].first).to eq('W1P2')
+        end
+      end
+
+      describe '#update_user_district_field_values' do
+        let(:body) do
+          JSON.parse(
+            File.read(fixture_path + '/update_user_district_field_values.json')
+          )
+        end
+
+        let(:response) { fixture('user_district_field_values.json') }
+
+        let(:url) do
+          build_url(client: client, path: 'users/12345/districtFieldValues')
+        end
+
+        before do
+          stub_request(:put, url)
+            .with(body: JSON.generate(body))
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.update_user_district_field_values(id: 12_345, body: body)
+          expect(
+            a_request(:put, url)
+              .with(
+                body: body
+              )
+          ).to have_been_made
+        end
+
+        it 'returns the user district field value assignments' do
+          results = client.update_user_district_field_values(id: 12_345,
+                                                             body: body)
+          expect(results['districtFieldValues'].first).to eq('W1P2')
+        end
+      end
+    end
+  end
+end

data/spec/ngp_van/configuration_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module NgpVan
+  RSpec.describe Configuration do
+    before(:each) { NgpVan.configuration.reset! }
+    after(:each) { NgpVan.configuration.reset! }
+
+    describe '#api_endpoint' do
+      context 'when no api_endpoint is specified' do
+        it 'sets a default value' do
+          expect(NgpVan.configuration.api_endpoint)
+            .to eq(NgpVan::Default.api_endpoint)
+        end
+      end
+
+      context 'when a custom value is specified' do
+        let(:url) { Faker::Internet.url }
+
+        before do
+          NgpVan.configure do |config|
+            config.api_endpoint = url
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(NgpVan.configuration.api_endpoint).to eq(url)
+        end
+      end
+    end
+
+    describe '#api_key' do
+      context 'when no api_key is specified' do
+        it 'sets a default value' do
+          expect(NgpVan.configuration.api_key)
+            .to eq(NgpVan::Default.api_key)
+        end
+      end
+
+      context 'when a custom value is specified' do
+        let(:key) { Faker::Internet.password }
+
+        before do
+          NgpVan.configure do |config|
+            config.api_key = key
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(NgpVan.configuration.api_key).to eq(key)
+        end
+      end
+    end
+
+    describe '#application_name' do
+      context 'when no application name is specified' do
+        it 'sets a default value' do
+          expect(NgpVan.configuration.application_name)
+            .to eq(NgpVan::Default.application_name)
+        end
+      end
+
+      context 'when a custom value is specified' do
+        let(:name) { Faker::Company.name }
+
+        before do
+          NgpVan.configure do |config|
+            config.application_name = name
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(NgpVan.configuration.application_name).to eq(name)
+        end
+      end
+    end
+
+    describe '#inspect' do
+      it 'masks the application name' do
+        application_name = Faker::Company.name
+        NgpVan.configuration.application_name = application_name
+        expect(NgpVan.configuration.inspect).to_not include(application_name)
+      end
+
+      it 'masks the api key' do
+        api_key = Faker::Internet.password
+        NgpVan.configuration.api_key = api_key
+        expect(NgpVan.configuration.inspect).to_not include(api_key)
+      end
+    end
+
+    describe '#user_agent' do
+      context 'when no user_agent is specified' do
+        it 'sets a default value' do
+          expect(NgpVan.configuration.user_agent)
+            .to eq(NgpVan::Default.user_agent)
+        end
+      end
+
+      context 'when a custom value is specified' do
+        let(:agent) { 'Web Spider v123' }
+
+        before do
+          NgpVan.configure do |config|
+            config.user_agent = agent
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(NgpVan.configuration.user_agent).to eq(agent)
+        end
+      end
+    end
+  end
+end

data/spec/ngp_van/request_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:disable Metrics/ModuleLength
+module NgpVan
+  RSpec.describe Request do
+    let(:client) { NgpVan::Client.new }
+    let(:params) { { id: 2 } }
+
+    describe '#delete' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+
+      context 'when making a request' do
+        before do
+          stub_request(:delete, url)
+        end
+
+        it 'makes a DELETE request' do
+          NgpVan.delete(path: '/some/resource')
+          expect(a_request(:delete, url)).to have_been_made
+        end
+      end
+
+      context 'when passing parameters to the request' do
+        before do
+          stub_request(:delete, url).with(query: params)
+        end
+
+        it 'passes params to the request' do
+          NgpVan.delete(path: '/some/resource', params: params)
+
+          expect(a_request(:delete, url).with(query: params))
+            .to have_been_made
+        end
+      end
+    end
+
+    describe '#get' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+
+      context 'when making a request' do
+        before do
+          stub_request(:get, url)
+        end
+
+        it 'makes a get request' do
+          NgpVan.get(path: '/some/resource')
+          expect(a_request(:get, url)).to have_been_made
+        end
+      end
+
+      context 'when passing parameters to the request' do
+        before do
+          stub_request(:get, url).with(query: params)
+        end
+
+        it 'passes params to the request' do
+          NgpVan.get(path: '/some/resource', params: params)
+
+          expect(a_request(:get, url).with(query: params))
+            .to have_been_made
+        end
+      end
+    end
+
+    describe '#post' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+      let(:body) do
+        {
+          name: 'Neighbors Calling Neighbors',
+          shortName: 'NeighborCall',
+          description: 'Come help get the word out about our great campaign.'
+        }
+      end
+
+      context 'when making a request' do
+        before do
+          stub_request(:post, url)
+        end
+
+        it 'makes a post request' do
+          NgpVan.post(path: '/some/resource')
+          expect(a_request(:post, url)).to have_been_made
+        end
+      end
+
+      context 'when passing a body to the request' do
+        before do
+          stub_request(:post, url).with(body: JSON.generate(body))
+        end
+
+        it 'passes body to the request' do
+          NgpVan.post(path: '/some/resource', body: body)
+
+          expect(a_request(:post, url).with(body: JSON.generate(body)))
+            .to have_been_made
+        end
+      end
+    end
+
+    describe '#put' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+      let(:body) do
+        {
+          name: 'Neighbors Calling Neighbors',
+          shortName: 'NeighborCall',
+          description: 'Come help get the word out about our great campaign.'
+        }
+      end
+
+      context 'when making a request' do
+        before do
+          stub_request(:put, url)
+        end
+
+        it 'makes a put request' do
+          NgpVan.put(path: '/some/resource')
+          expect(a_request(:put, url)).to have_been_made
+        end
+      end
+
+      context 'when passing a body to the request' do
+        before do
+          stub_request(:put, url).with(body: JSON.generate(body))
+        end
+
+        it 'passes body to the request' do
+          NgpVan.put(path: '/some/resource', body: body)
+
+          expect(a_request(:put, url).with(body: JSON.generate(body)))
+            .to have_been_made
+        end
+      end
+    end
+  end
+end