add some params/endpoints, include parameters in response struct

Author: jgautsch

.iex.exs

@@ -14,7 +14,7 @@ Supervisor.start_link(children, opts)
 
 defmodule ReplHelpers do
   def search(term) do
-    with {:ok, %{data: %{"results" => results}}} when length(results) > 0 <- Ribbonex.search_insurances(search: term) do
+    with {:ok, %{data: %{"results" => results}}} when results != [] > 0 <- Ribbonex.search_insurances(search: term) do
       results
       |> Enum.sort_by(& &1["confidence"])
       |> Enum.reverse()

lib/insurances.ex

@@ -5,7 +5,13 @@ defmodule Ribbonex.Insurances do
   [Ribbon Docs](https://ribbon.readme.io/docs/insurances-reference-endpoint)
   """
 
+  def get_insurance(uuid, params \\ []) when is_binary(uuid) do
+    path = "/v1/custom/insurances/#{uuid}"
+    Ribbonex.Client.authd_get(path, params: params)
+  end
+
   @insurances_search_params [
+    page: [type: :non_neg_integer],
     search: [
       type: :string,
       doc: "Fuzzy search across all information within an insurance object."

lib/locations.ex

@@ -0,0 +1,20 @@
+defmodule Ribbonex.Locations do
+  @location_search_params [
+    page: [type: :non_neg_integer],
+    name: [
+      type: :string,
+      doc: "Fuzzy search on name."
+    ],
+    fields: [
+      type: {:list, :string},
+      doc: "Fields to include in response."
+    ]
+  ]
+
+  def search(params \\ []) do
+    with {:ok, params} <- NimbleOptions.validate(Enum.into(params, []), @location_search_params) do
+      path = "/v1/custom/locations"
+      Ribbonex.Client.authd_get(path, params: params)
+    end
+  end
+end

lib/providers.ex

@@ -19,6 +19,15 @@ defmodule Ribbonex.Providers do
   """
 
   @provider_search_params [
+    page: [type: :non_neg_integer],
+    npi: [
+      type: :string,
+      doc: ""
+    ],
+    name: [
+      type: :string,
+      doc: "String input of a full, first, last, or partial name."
+    ],
     address: [
       type: :string,
       doc: "String input of an address that will be interpreted and geocoded in real time."
@@ -33,13 +42,17 @@ defmodule Ribbonex.Providers do
       doc:
         "Comma separated list of desired specialty uuids. See all providers who specialize in the given specialties."
     ],
+    insurance_ids: [
+      type: {:list, :string},
+      doc: "List of desired insurance uuids. See all providers who accept a given insurance(s)."
+    ],
     fields: [
       type: {:list, :string},
-      doc: "Fields to include"
+      doc: "Fields to include in response."
     ],
     _excl_fields: [
       type: {:list, :string},
-      doc: "Fields to exclude"
+      doc: "Fields to exclude in response."
     ]
   ]
 
@@ -50,8 +63,8 @@ defmodule Ribbonex.Providers do
     end
   end
 
-  def get_provider(npi) when is_binary(npi) do
+  def get_provider(npi, params \\ []) when is_binary(npi) do
     path = "/v1/custom/providers/" <> npi
-    Ribbonex.Client.authd_get(path)
+    Ribbonex.Client.authd_get(path, params: params)
   end
 end

lib/response.ex

@@ -2,7 +2,9 @@ defmodule Ribbonex.Response do
   defstruct [
     :status,
     :http_response,
+    :parameters,
     :data,
+    :end_of_list,
     :request,
     :additional_properties
   ]
@@ -21,8 +23,14 @@ defmodule Ribbonex.Response do
   def parse({:ok, http_response}, additional_properties) do
     body = decode(http_response)
     data = extract_data(body)
+    parameters = extract_parameters(body)
 
-    {:ok, build_response(http_response, data, additional_properties)}
+    response =
+      build_response(http_response, data, additional_properties)
+      |> Map.put(:parameters, parameters)
+      |> Map.put(:end_of_list, end_of_list?(parameters))
+
+    {:ok, response}
   end
 
   defp decode(%Finch.Response{body: ""}), do: nil
@@ -31,6 +39,9 @@ defmodule Ribbonex.Response do
   defp extract_data(%{"data" => data}), do: data
   defp extract_data(data), do: data
 
+  defp extract_parameters(%{"parameters" => parameters}), do: parameters
+  defp extract_parameters(_), do: nil
+
   defp build_response(http_response, data, additional_properties) do
     _headers = Enum.into(http_response.headers, %{})
     additional_properties = Enum.into(additional_properties, %{})
@@ -48,4 +59,15 @@ defmodule Ribbonex.Response do
   defp json_decode!(nil), do: nil
   defp json_decode!(%{} = body), do: body
   defp json_decode!(body) when is_binary(body), do: Jason.decode!(body)
+
+  defp end_of_list?(nil), do: true
+  defp end_of_list?(%{"total_count" => 0}), do: true
+
+  defp end_of_list?(parameters) when is_map(parameters) do
+    page = Map.get(parameters, "page", 1)
+    page_size = Map.get(parameters, "page_size", 25)
+    total_count = Map.get(parameters, "total_count", 0)
+
+    page * page_size >= total_count
+  end
 end

lib/ribbonex.ex

@@ -3,13 +3,16 @@ defmodule Ribbonex do
     to: Ribbonex.Providers,
     as: :search
 
-  defdelegate get_provider(npi),
+  defdelegate get_provider(npi, params \\ []),
     to: Ribbonex.Providers
 
   defdelegate search_specialties(params \\ []),
     to: Ribbonex.Specialties,
     as: :search
 
+  defdelegate get_insurance(uuid, params \\ []),
+    to: Ribbonex.Insurances
+
   defdelegate search_insurances(params \\ []),
     to: Ribbonex.Insurances,
     as: :search

lib/specialties.ex

@@ -16,6 +16,7 @@ defmodule Ribbonex.Specialties do
   """
 
   @specialties_search_params [
+    page: [type: :non_neg_integer],
     search: [
       type: :string,
       doc: "String input for fuzzy matching specialties"