ngp_van 0.1.1

data/lib/ngp_van/client/printed_lists.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module PrintedLists
+      def printed_lists(params: {})
+        get(path: 'printedLists', params: params)
+      end
+
+      def printed_list(id:, params: {})
+        get(path: "printedLists/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/signups.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Signups
+      def signup_statuses(params: {})
+        get(path: 'signups/statuses', params: params)
+      end
+
+      def signup(id:, params: {})
+        get(path: "signups/#{id}", params: params)
+      end
+
+      def signups(params: {})
+        get(path: 'signups', params: params)
+      end
+
+      def create_signup(body: {})
+        post(path: 'signups', body: body)
+      end
+
+      def update_signup(id:, body: {})
+        put(path: "signups/#{id}", body: body)
+      end
+
+      def delete_signup(id:)
+        delete(path: "signups/#{id}")
+      end
+    end
+  end
+end

data/lib/ngp_van/client/survey_questions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module SurveyQuestions
+      def survey_questions(params: {})
+        get(path: 'surveyQuestions', params: params)
+      end
+
+      def survey_question(id:, params: {})
+        get(path: "surveyQuestions/#{id}", params: params)
+      end
+    end
+  end
+end

data/lib/ngp_van/client/users.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NgpVan
+  class Client
+    module Users
+      def user_district_field_values(id:, params: {})
+        get(path: "users/#{id}/districtFieldValues", params: params)
+      end
+
+      def create_user_district_field_values(id:, body: {})
+        post(path: "users/#{id}/districtFieldValues", body: body)
+      end
+
+      def update_user_district_field_values(id:, body: {})
+        put(path: "users/#{id}/districtFieldValues", body: body)
+      end
+    end
+  end
+end

data/lib/ngp_van/configuration.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'ngp_van/default'
+require 'ngp_van/version'
+
+module NgpVan
+  class Configuration
+    # The Application Name in the NGP VAN system. A short string that identifies
+    # your application (e.g., acmeCrmProduct)
+    #
+    # The `application_name` setting is used for authenticating requests.
+    #
+    # @return [String, nil]
+    attr_accessor :application_name
+
+    # The API Key acquired from NGP VAN. The API Key resembles the concatenation
+    # of a GUID, a | and a 0 or 1 (e.g.,
+    # bc7b6578-5619-4e8f-92ab-829208e1a511|1).
+    #
+    # The `api_key` setting is used for authenticating requests.
+    #
+    # @return [String, nil]
+    attr_accessor :api_key
+
+    # The API Endpoint url. Which endpoint you should use is determined by which
+    # VAN client with which you're working.
+    # @note See http://developers.ngpvan.com/van-api#van-endpoints
+    # @return [String]
+    attr_accessor :api_endpoint
+
+    # The User-Agent sent to the API endpoint. This defaults to the gem name,
+    # suffixed with the current version number.
+    # @return [String]
+    attr_accessor :user_agent
+
+    def initialize
+      setup
+    end
+
+    # Reset all configuration to default values.
+    # @return [NgpVan::Configuration]
+    def reset!
+      @application_name = NgpVan::Default.application_name
+      @api_key = NgpVan::Default.api_key
+      @api_endpoint = NgpVan::Default.api_endpoint
+      @user_agent = NgpVan::Default.user_agent
+      self
+    end
+
+    alias setup reset!
+
+    # Inspect the configuration object, masking private values.
+    # @return [String]
+    def inspect
+      inspected = super
+
+      if NgpVan.configuration.api_key
+        filter_value!(inspected, NgpVan.configuration.api_key)
+      end
+
+      if NgpVan.configuration.application_name
+        filter_value!(inspected, NgpVan.configuration.application_name)
+      end
+
+      inspected
+    end
+
+    private
+
+    def filter_value!(source, str)
+      source.gsub!(str, '[FILTERED]')
+    end
+  end
+end

data/lib/ngp_van/connection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'ngp_van/response/raise_error'
+require 'faraday_middleware'
+
+module NgpVan
+  module Connection
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def connection
+      options = {
+        url: NgpVan.configuration.api_endpoint,
+        headers: {
+          'Accept' => 'application/json; charset=utf-8',
+          'User-Agent' => NgpVan.configuration.user_agent
+        }
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.basic_auth(
+          NgpVan.configuration.application_name,
+          NgpVan.configuration.api_key
+        )
+
+        connection.request(:json)
+        connection.use NgpVan::Response::RaiseError
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/ngp_van/default.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'ngp_van/version'
+
+module NgpVan
+  module Default
+    APPLICATION_NAME = nil
+
+    API_KEY = nil
+
+    API_ENDPOINT = 'https://api.securevan.com/v4/'
+
+    USER_AGENT = "NGP VAN Ruby Gem #{NgpVan::VERSION}"
+
+    class << self
+      # Default Application Name from {APPLICATION_NAME}
+      # @return [String]
+      def application_name
+        APPLICATION_NAME
+      end
+
+      # Default API Key from {API_KEY}
+      # @return [String]
+      def api_key
+        API_KEY
+      end
+
+      # Default API Endpoint from {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        API_ENDPOINT
+      end
+
+      # Default User Agent from {USER_AGENT}
+      # @return [String]
+      def user_agent
+        USER_AGENT
+      end
+    end
+  end
+end

data/lib/ngp_van/error.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module NgpVan
+  # Custom error class for rescuing from NgpVan errors.
+  class Error < StandardError
+    attr_reader :body, :response, :status
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize,
+    # rubocop:disable Style/CyclomaticComplexity
+    # Returns a NgpVan::Error subclass, depending on status and
+    # response message.
+    #
+    # @param [Hash] response HTTP response
+    # @return [NgpVan::Error]
+    def self.from_response(response)
+      status = response[:status].to_i
+
+      error_klass =
+        case status
+        when 400 then NgpVan::BadRequest
+        when 401 then NgpVan::Unauthorized
+        when 403 then NgpVan::Forbidden
+        when 405 then NgpVan::MethodNotAllowed
+        when 406 then NgpVan::NotAcceptable
+        when 408 then NgpVan::RequestTimeout
+        when 409 then NgpVan::Conflict
+        when 413 then NgpVan::RequestEntityTooLarge
+        when 415 then NgpVan::UnsupportedMediaType
+        when 422 then NgpVan::UnprocessableEntity
+        when 429 then NgpVan::TooManyRequests
+        when 404 then NgpVan::NotFound
+        when 400..499 then NgpVan::ClientError
+        when 500 then NgpVan::InternalServerError
+        when 501 then NgpVan::NotImplemented
+        when 502 then NgpVan::BadGateway
+        when 503 then NgpVan::ServiceUnavailable
+        when 504 then NgpVan::GatewayTimeout
+        when 500..599 then NgpVan::ServerError
+        end
+
+      error_klass.new(response) if error_klass
+    end
+
+    def initialize(response = nil)
+      @response = response
+      @body = ::JSON.parse(response[:body])
+      @status = response[:status]
+
+      super(build_error)
+    end
+
+    private
+
+    def errors
+      body.delete('errors')
+    end
+
+    def build_error
+      return nil if response.nil?
+
+      {
+        status: status,
+        errors: errors
+      }
+    end
+  end
+
+  # Errors in the 400-499 range
+  class ClientError < Error; end
+
+  # 400 Bad request
+  class BadRequest < ClientError; end
+
+  # 401 Unauthorized
+  class Unauthorized < ClientError; end
+
+  # 403 Forbidden
+  class Forbidden < ClientError; end
+
+  # 404 Not found
+  class NotFound < ClientError; end
+
+  # 405 Method not allowed
+  class MethodNotAllowed < ClientError; end
+
+  # 406 Not acceptable
+  class NotAcceptable < ClientError; end
+
+  # 408 Request timeout
+  class RequestTimeout < ClientError; end
+
+  # 409 Conflict
+  class Conflict < ClientError; end
+
+  # 413 Request entity too large
+  class RequestEntityTooLarge < ClientError; end
+
+  # 415 Unsupported media type
+  class UnsupportedMediaType < ClientError; end
+
+  # 422 Unprocessable entity
+  class UnprocessableEntity < ClientError; end
+
+  # 429 Too many requests
+  class TooManyRequests < ClientError; end
+
+  # Errors in the 500-599 range
+  class ServerError < Error; end
+
+  # 500 Internal server error
+  class InternalServerError < ServerError; end
+
+  # 501 Not implemented
+  class NotImplemented < ServerError; end
+
+  # 502 Bad gateway
+  class BadGateway < ServerError; end
+
+  # 503 Service unavailable
+  class ServiceUnavailable < ServerError; end
+
+  # 504 Gateway timeout
+  class GatewayTimeout < ServerError; end
+end

data/lib/ngp_van/request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module NgpVan
+  module Request
+    # Perform an HTTP DELETE request
+    def delete(path:, params: {})
+      request(method: :delete, path: path, params: params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path:, params: {})
+      request(method: :get, path: path, params: params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path:, body: {})
+      request(method: :post, path: path, body: body)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path:, body: {})
+      request(method: :put, path: path, body: body)
+    end
+
+    private
+
+    def request(method:, path:, params: {}, body: {})
+      response = connection.send(method) do |request|
+        request.path = URI.encode(path)
+        request.params = params
+        request.body = ::JSON.generate(body) unless body.empty?
+      end
+
+      Response.create(response.body)
+    end
+  end
+end

data/lib/ngp_van/response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NgpVan
+  module Response
+    def self.create(body)
+      JSON.parse(body)
+    # The VAN API does not always return JSON. For example, when creating a new
+    # code, you post to /codes. The return is the integer ID of the newly
+    # created code, not a json representation of it. For cases like this, we
+    # will just return the body un-parsed.
+    rescue JSON::ParserError
+      body
+    end
+  end
+end

data/lib/ngp_van/response/raise_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ngp_van/error'
+require 'faraday'
+
+module NgpVan
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        error = NgpVan::Error.from_response(response)
+        raise error if error
+      end
+    end
+  end
+end

data/lib/ngp_van/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NgpVan
+  # Current major release.
+  # @return [Integer]
+  MAJOR = 0
+
+  # Current minor release.
+  # @return [Integer]
+  MINOR = 1
+
+  # Current patch level.
+  # @return [Integer]
+  PATCH = 1
+
+  # Full release version.
+  # @return [String]
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end