ngp_van 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e359a5f0de2f78b1f404d7262d0adfb63f24ac87
+  data.tar.gz: 8edf31e879a2a1ee69e6fc75b50777614e102db4
+SHA512:
+  metadata.gz: 0497e399cb50d0ef22fe6b9d9c6adfa599decf5f7a36120f5bc004978a4b922906859403d7c196e285b4b46cac59732e6fa340cbacab389f750d17736ac6156d
+  data.tar.gz: 19dd59a120151cfd9ac3eec9c1de5e67edb851a55249b74fc018f62a25ba80b7fce089ee0943239e82bddeeeb327cea36f2c3e4436e0e6d9a2b82b0714f15ca2

data.tar.gz.sig

@@ -0,0 +1 @@
+���l��������"���zWC�e&�Τ���1�����B��A��;�iW��~u�g�;7�ת��&Lnu��+t"�����:"��zb8IT�z�(d�����e;����Yhd�̛����*A���`)eM�XV��^uC�}�����06[dm�0�E�8�4�r%�qP��`*�饄42't�f)��D�.����K�da�][H�`����Wv�O>�qҗ�S�lR�x}�U�/��Y`�w�ܣHF

data/README.md

@@ -0,0 +1,117 @@
+# The NGP VAN Ruby Gem
+
+[![Circle CI](https://circleci.com/gh/christopherstyles/ngp_van.svg?style=svg&circle-token=410c1ce6c4fd70b078726dffb0497bda82cbb983)](https://circleci.com/gh/christopherstyles/ngp_van) [![Test Coverage](https://codeclimate.com/github/christopherstyles/ngp_van/badges/coverage.svg)](https://codeclimate.com/github/christopherstyles/ngp_van/coverage) [![Code Climate](https://codeclimate.com/github/christopherstyles/ngp_van/badges/gpa.svg)](https://codeclimate.com/github/christopherstyles/ngp_van) [![Inline docs](http://inch-ci.org/github/christopherstyles/ngp_van.svg?branch=master)](http://inch-ci.org/github/christopherstyles/ngp_van)
+
+An unofficial Ruby wrapper for the [NGP VAN](http://developers.everyaction.com/) RESTful API.
+
+## Quick start
+
+Install via Rubygems:
+
+```ruby
+gem install ngp_van
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'ngp_van'
+```
+
+`ngp_van` is cryptographically signed. To be sure the gem you install hasn’t been tampered with, add my public key as a trusted certificate:
+
+    gem cert --add <(curl -Ls https://raw.github.com/christopherstyles/ngp_van/master/certs/christopherstyles.pem)
+
+Then install with:
+
+    gem install ngp_van -P MediumSecurity
+
+or if using bundler:
+
+    bundle install --trust-policy MediumSecurity
+
+The `MediumSecurity` trust profile will verify signed gems, but allow the installation of unsigned dependencies.
+
+This is necessary because not all of `ngp_van`s dependencies are signed, so we cannot use `HighSecurity`.
+
+## Configuration
+
+NGP VAN can be configured using a block:
+
+```ruby
+NgpVan.configure do |config|
+  config.application_name = 'MyCampaignApp'
+
+  # See http://developers.everyaction.com/van-api#van-authentication
+  config.api_key = 'de286a1a-f2e7-421a-91b8-f8cc8201558f|1'
+
+  # Defaults to "https://api.securevan.com/v4/"
+  config.api_endpoint = 'https://intlapi.securevan.com/v4'
+
+  # Defaults to "NGP VAN Ruby Gem #{NgpVan::VERSION}"
+  config.user_agent = 'CustomUserAgent'
+end
+```
+
+Options can also be set on the configuration object:
+
+```ruby
+% NgpVan.configuration.api_key = 'de286a1a-f2e7-421a-91b8-f8cc8201558f|1'
+# => "de286a1a-f2e7-421a-91b8-f8cc8201558f|1"
+```
+
+## Making requests
+
+API Methods can be called as module methods or as instance methods on the client.
+
+```ruby
+NgpVan.district_fields
+# => [
+#      {"districtFieldId"=>1, "name"=>"State", "parentFieldId"=>nil...},
+#      {"districtFieldId"=>4, "name"=>"County", "parentFieldId"=>1...}
+#    ]
+```
+
+or
+
+```ruby
+client = NpgVan.client
+client.district_fields
+# => [
+#      {"districtFieldId"=>1, "name"=>"State", "parentFieldId"=>nil...},
+#      {"districtFieldId"=>4, "name"=>"County", "parentFieldId"=>1...}
+#    ]
+```
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests.
+
+A console task has also been provided to automatically load the NGP VAN environment. Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+```ruby
+% bin/console
+[1] pry(main)> NgpVan::VERSION
+# => "x.x.x"
+[2] pry(main)> NgpVan.configuration.application_name = 'MyCampaignApplication'
+# => "MyCampaignApplication"
+[3] pry(main)> NgpVan.configuration.api_key = 'de286a1a-f2e7-421a-91b8-f8cc8201558f|1'
+# => "de286a1a-f2e7-421a-91b8-f8cc8201558f|1"
+[4] pry(main)> NgpVan.district_fields
+# => [
+#      {"districtFieldId"=>1, "name"=>"State", "parentFieldId"=>nil...,
+#      {"districtFieldId"=>2, "name"=>"County", "parentFieldId"=>1...
+#    ]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/christopherstyles/ngp_van/issues.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/ngp_van.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'ngp_van/client'
+require 'ngp_van/configuration'
+require 'ngp_van/version'
+
+module NgpVan
+  class << self
+    # The NgpVan configuration object.
+    # @return [NgpVan::Configuration]
+    attr_reader :configuration
+
+    def client
+      @client ||= NgpVan::Client.new
+    end
+
+    # Delegate methods called on NgpVan to the client.
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+
+  # The current configuration.
+  # @return [NgpVan::Configuration]
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Set new configuration
+  # @param config [NgpVan::Configuration]
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Modify the current configuration
+  # @yieldparam [NgpVan::Configuration] config The current NgpVan config
+  # ```
+  # NgpVan.configure do |config|
+  #   config.application_name = 'CroninAndSons'
+  #   config.api_key = 'af263f2a-86fd-443b-a1b6-f5b7bce8db30|1'
+  # end
+  # ```
+  def self.configure
+    yield configuration
+  end
+end

data/lib/ngp_van/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'ngp_van/connection'
+require 'ngp_van/request'
+require 'ngp_van/response'
+require 'ngp_van/client/activist_codes'
+require 'ngp_van/client/canvass_responses'
+require 'ngp_van/client/codes'
+require 'ngp_van/client/district_fields'
+require 'ngp_van/client/events'
+require 'ngp_van/client/event_types'
+require 'ngp_van/client/locations'
+require 'ngp_van/client/notes'
+require 'ngp_van/client/people'
+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/users'
+
+module NgpVan
+  class Client
+    include NgpVan::Connection
+    include NgpVan::Request
+    include NgpVan::Response
+    include NgpVan::Client::ActivistCodes
+    include NgpVan::Client::CanvassResponses
+    include NgpVan::Client::Codes
+    include NgpVan::Client::DistrictFields
+    include NgpVan::Client::Events
+    include NgpVan::Client::EventTypes
+    include NgpVan::Client::Locations
+    include NgpVan::Client::Notes
+    include NgpVan::Client::People
+    include NgpVan::Client::PrintedLists
+    include NgpVan::Client::MinivanExports
+    include NgpVan::Client::Signups
+    include NgpVan::Client::SurveyQuestions
+    include NgpVan::Client::Users
+  end
+end

data/lib/ngp_van/client/activist_codes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module ActivistCodes
+      def activist_codes(params: {})
+        get(path: 'activistCodes', params: params)
+      end
+
+      def activist_code(id:, params: {})
+        get(path: "activistCodes/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/canvass_responses.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module CanvassResponses
+      def canvass_responses_contact_types(params: {})
+        get(path: 'canvassResponses/contactTypes', params: params)
+      end
+
+      def canvass_responses_input_types(params: {})
+        get(path: 'canvassResponses/inputTypes', params: params)
+      end
+
+      def canvass_responses_result_codes(params: {})
+        get(path: 'canvassResponses/resultCodes', params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/codes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Codes
+      def code_supported_entities(params: {})
+        get(path: 'codes/supportedEntities', params: params)
+      end
+
+      def codes(params: {})
+        get(path: 'codes', params: params)
+      end
+
+      def code(id:, params: {})
+        get(path: "codes/#{id}", params: params)
+      end
+
+      def create_code(body: {})
+        post(path: 'codes', body: body)
+      end
+
+      def update_code(id:, body: {})
+        put(path: "codes/#{id}", body: body)
+      end
+
+      def delete_code(id:)
+        delete(path: "codes/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/client/district_fields.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module DistrictFields
+      def district_fields(params: {})
+        get(path: 'districtFields', params: params)
+      end
+
+      def district_field(id:)
+        get(path: "districtFields/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/client/event_types.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module EventTypes
+      def event_types(params: {})
+        get(path: 'events/types', params: params)
+      end
+
+      def event_type(id:, params: {})
+        get(path: "events/types/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/events.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Events
+      def create_event(body: {})
+        post(path: 'events', body: body)
+      end
+
+      def create_event_shift(id:, body: {})
+        post(path: "events/#{id}/shifts", body: body)
+      end
+
+      def event(id:, params: {})
+        get(path: "events/#{id}", params: params)
+      end
+
+      def events(params: {})
+        get(path: 'events', params: params)
+      end
+
+      def update_event(id:, body: {})
+        put(path: "events/#{id}", body: body)
+      end
+
+      def delete_event(id:)
+        delete(path: "events/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/client/locations.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Locations
+      def locations(params: {})
+        get(path: 'locations', params: params)
+      end
+
+      def location(id:, params: {})
+        get(path: "locations/#{id}", params: params)
+      end
+
+      def find_or_create_location(body: {})
+        post(path: 'locations/findOrCreate', body: body)
+      end
+
+      def create_location(body: {})
+        post(path: 'locations', body: body)
+      end
+
+      def delete_location(id:)
+        delete(path: "locations/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/client/minivan_exports.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module MinivanExports
+      def minivan_exports(params: {})
+        get(path: 'minivanExports', params: params)
+      end
+
+      def minivan_export(id:, params: {})
+        get(path: "minivanExports/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/notes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Notes
+      def note_category_types(params: {})
+        get(path: 'notes/categoryTypes', params: params)
+      end
+
+      def note_categories(params: {})
+        get(path: 'notes/categories', params: params)
+      end
+
+      def note_category(id:, params: {})
+        get(path: "notes/categories/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/people.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module People
+      def find_person(body: {})
+        post(path: 'people/find', body: body)
+      end
+
+      def find_or_create_person(body: {})
+        post(path: 'people/findOrCreate', body: body)
+      end
+
+      def person(id:, params: {})
+        get(path: "people/#{id}", params: params)
+      end
+
+      def person_by_type(id:, type:, params: {})
+        get(path: "people/#{type}:#{id}", params: params)
+      end
+
+      def create_canvass_responses_for_person(id:, body: {})
+        post(path: "people/#{id}/canvassResponses", body: body)
+      end
+
+      def create_canvass_responses_for_person_by_type(id:, type:, body: {})
+        post(path: "people/#{type}:#{id}/canvassResponses", body: body)
+      end
+    end
+  end
+end