Merge pull request #85 from beamkenya/feature/remove-headers

Feature/remove headers
beamkenya · Aug 14, 2020 · b5cf361 · b5cf361
2 parents dd11ec7 + 7265484
commit b5cf361
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -50,12 +50,12 @@ end
 - Add the **api key** in the `api_key:`value in the `config/dev.exs` created above.
 
 ## Example Configuration setup
+Below is an example configuration for `dev.exs` this is suitable for testing with the sandbox:
+
 ``` elixir
 config :at_ex,
-  api_key: "===INSERT AFRICAS_TALKING_API_KEY HERE ===",
-  content_type: "application/x-www-form-urlencoded",
-  accept: "application/json",
-  username: "sandbox", #change to live username for prod.ex
+  api_key: "===INSERT AFRICAS_TALKING_SANDBOX_API_KEY HERE ===",
+  username: "sandbox", #change to live username if you want to use the live endpoint while in development
   stk_product_name: "AtEx", #Add your specific product name.
   b2c_product_name: "AtEx",
   b2b_product_name: "AtEx",
@@ -66,6 +66,22 @@ config :at_ex,
   force_live_url: "NO"
 ```
 
+Below is an example configuration for `prod.exs` this is when you go live:
+
+
+``` elixir
+config :at_ex,
+  api_key: "===INSERT AFRICAS_TALKING_LIVE_API_KEY HERE ===",
+  username: "LIVE_USERNAME",
+  stk_product_name: "AtEx", #Add your specific product name.
+  b2c_product_name: "AtEx",
+  b2b_product_name: "AtEx",
+  bank_checkout_product_name: "AtEx",
+  bank_transfer_product_name: "AtEx",
+  card_checkout_product_name: "AtEx"
+
+```
+
 
 ## Documentation
 
@@ -76,7 +92,7 @@ The docs can be found at [https://hexdocs.pm/at_ex](https://hexdocs.pm/at_ex).
 #### Sending SMS
 
 ```elixir
-    iex> AtEx.Sms.send_sms(%{to: "+254728833181", message: "Howdy"})
+    iex> AtEx.Sms.send_sms(%{to: "+254722000000", message: "Howdy"})
     {:ok,
     %{
         "SMSMessageData" => %{
@@ -85,7 +101,7 @@ The docs can be found at [https://hexdocs.pm/at_ex](https://hexdocs.pm/at_ex).
         %{
             "cost" => "KES 0.8000",
             "messageId" => "ATXid_96e52a761a82c1bad58e885109224aad",
-            "number" => "+254728833181",
+            "number" => "+254722000000",
             "status" => "Success",
             "statusCode" => 101
         }

diff --git a/config/dev.sample.exs b/config/dev.sample.exs
@@ -4,8 +4,6 @@ use Mix.Config
 
 config :at_ex,
   api_key: "===INSERT AFRICAS_TALKING_API_KEY HERE ===",
-  content_type: "application/x-www-form-urlencoded",
-  accept: "application/json",
   username: "sandbox",
   stk_product_name: "AtEx",
   b2c_product_name: "AtEx",

diff --git a/lib/at_ex.ex b/lib/at_ex.ex
@@ -1,12 +1,26 @@
 defmodule AtEx do
   @moduledoc """
   AtEx is an Elixir Wrapper for the Africas Talking Api
+  Use this library to handle interaction with the Africas Talking API end points,
+  It is most useful for
+  - Consuming incoming events that have been parsed
+  - Building valid responses
+
+  Almost all of the endpoints have been implemented,these includes the following sections of the API:
+  - SMS
+  - USSD
+  - Airtime
+  - Application
+  - Voice
+  - Payment
+  - IoT
   """
   alias AtEx.Gateway.{
     Airtime,
     Application
   }
 
+  @spec send_airtime(%{recipients: [map]}) :: {:error, any} | {:ok, any}
   @doc """
     Sends airtime
 

diff --git a/lib/at_ex/gateway/base_http.ex b/lib/at_ex/gateway/base_http.ex
@@ -32,9 +32,9 @@ defmodule AtEx.Gateway.Base do
 
       @config unquote(opts)
 
-      @accept Application.get_env(:at_ex, :accept)
+      @accept "application/json"
+      @content_type "application/x-www-form-urlencoded"
       @key Application.get_env(:at_ex, :api_key)
-      @content_type Application.get_env(:at_ex, :content_type)
 
       plug(Tesla.Middleware.BaseUrl, @config[:url])