Update README.

linjunpop · Apr 29, 2016 · 2e6ea34 · 2e6ea34
1 parent 3850ab6
commit 2e6ea34
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # ReceiptVerifier
 
-**TODO: Add description**
+Verify iTunes receipt.
 
 ## Installation
 
@@ -18,3 +18,45 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed
           [applications: [:receipt_verifier]]
         end
 
+## Usage
+
+```elixir
+{:ok, receipt} = ReceiptVerifier.verify(base64_encoded_receipt_data)
+
+receipt = %{"adam_id" => 0, "app_item_id" => 0, "application_version" => "1241",
+  "bundle_id" => "com.sumiapp.GridDiary", "download_id" => 0,
+  "in_app" => [%{"is_trial_period" => "false",
+     "original_purchase_date" => "2014-08-04 06:24:51 Etc/GMT",
+     "original_purchase_date_ms" => "1407133491000",
+     "original_purchase_date_pst" => "2014-08-03 23:24:51 America/Los_Angeles",
+     "original_transaction_id" => "1000000118990828",
+     "product_id" => "com.sumiapp.GridDiary.pro",
+     "purchase_date" => "2014-09-02 03:29:06 Etc/GMT",
+     "purchase_date_ms" => "1409628546000",
+     "purchase_date_pst" => "2014-09-01 20:29:06 America/Los_Angeles",
+     "quantity" => "1", "transaction_id" => "1000000118990828"},
+   %{"is_trial_period" => "false",
+     "original_purchase_date" => "2014-09-02 03:29:06 Etc/GMT",
+     "original_purchase_date_ms" => "1409628546000",
+     "original_purchase_date_pst" => "2014-09-01 20:29:06 America/Los_Angeles",
+     "original_transaction_id" => "1000000122102348",
+     "product_id" => "com.sumiapp.griddiary.test",
+     "purchase_date" => "2014-09-02 03:29:06 Etc/GMT",
+     "purchase_date_ms" => "1409628546000",
+     "purchase_date_pst" => "2014-09-01 20:29:06 America/Los_Angeles",
+     "quantity" => "1", "transaction_id" => "1000000122102348"}],
+  "original_application_version" => "1.0",
+  "original_purchase_date" => "2013-08-01 07:00:00 Etc/GMT",
+  "original_purchase_date_ms" => "1375340400000",
+  "original_purchase_date_pst" => "2013-08-01 00:00:00 America/Los_Angeles",
+  "receipt_creation_date" => "2014-09-02 03:29:06 Etc/GMT",
+  "receipt_creation_date_ms" => "1409628546000",
+  "receipt_creation_date_pst" => "2014-09-01 20:29:06 America/Los_Angeles",
+  "receipt_type" => "ProductionSandbox",
+  "request_date" => "2016-04-29 07:52:28 Etc/GMT",
+  "request_date_ms" => "1461916348197",
+  "request_date_pst" => "2016-04-29 00:52:28 America/Los_Angeles",
+  "version_external_identifier" => 0}
+
+```
+
diff --git a/test/receipt_verifier_test.exs b/test/receipt_verifier_test.exs
@@ -4,14 +4,13 @@ defmodule ReceiptVerifierTest do
 
   test "the truth" do
     receipt_file_path = "test/fixtures/receipt"
-    receipt =
+    base64_receipt =
       receipt_file_path
       |> File.read!
       |> String.replace("\n", "")
 
-    result = ReceiptVerifier.verify(receipt)
-    {:ok, %{"application_version" => version}} = result
+    {:ok, receipt} = ReceiptVerifier.verify(base64_receipt)
 
-    assert "1241", version
+    assert "1241", receipt["application_version"]
   end
 end