fastlane-plugin-json 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 323cfd72fd33cce1d3b951791dea2d295d409973be79a47cce17edbd5b1359a8
-  data.tar.gz: 4f09f1851f2aa9a822ed25591ea2f968407fe0de35f7d7a3cdcf97ae406ecddb
+  metadata.gz: 7a322af1714b480f2e163f6b1fbd7cc1ed54e07852e0db684abffb526a888cdc
+  data.tar.gz: bff1e8ed76220e6a7e4ce6ae5eedaf91973ac8d52d5dbe6b42f787184b29e25c
 SHA512:
-  metadata.gz: c7d8ef2e4b3bfe1eb1754b82c61657c84a65119e0a8b1a2bcdd58aa36b1f7bf6feded0ec44f6b36eb5b0a50d4230b32649c70f9aa664196c1a6a726ac396bf89
-  data.tar.gz: 49ed4ce1b6225d8ab188dcbdd6a228adec63931fbcfda6a2d8b5c7dd33c93035cf2e16a61fa21fb415434764b6e5684dffebeba4b4073e5bd5237acacb449b59
+  metadata.gz: 65df970c792ec75c1e41baaa9a3f3a815e6138c96e2ad8dd0f9f79d690c8473b40967f5b112bd337cebc0ff5164f4452e9a19b9f5912a7b5ba2b0dab613a3017
+  data.tar.gz: 33b204d134516933c17c1318ebcb9bc32938933b92b2c066e78d18876c1d2757c3e92097ad65b1fe2eb77ce3bad3f156cbdf4d7479a3eef8b062682503daf338

data/README.md

@@ -1,4 +1,4 @@
-# json plugin
+# Fastlane Json plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-json)
 
@@ -12,9 +12,81 @@ fastlane add_plugin json
 
 ## About json
 
-actions related to json files
+This plugin provide several actions that will allow you to manipulate and create json files.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+### read_json
+
+Read a json file at specific path as a hash object.
+
+_Having a json file at `path/to/my.json` with the following content:_
+
+```json
+{
+    "name": "Martin",
+    "age": 30
+}
+```
+
+```ruby
+my_json = read_json(
+    json_path: "path/to/my.json"
+)
+
+puts my_json[:name]
+# "Martin"
+puts my_json[:age]
+# 30
+```
+
+### download_json
+
+Downloads a json file from server and convert it to a hash object.
+
+```ruby
+my_json = download_json(
+    json_url: "https://gist.githubusercontent.com/MartinGonzalez/77b28af666fc2ee844c96cf6c8c221a2/raw/d23feabf25abe39c9c7243fd23f92efa7f50a3fd/someExample.json"
+)
+
+puts my_json[:name]
+# "Martin Gonzalez"
+puts my_json[:gender]
+# "male"
+puts my_json[:isDev]
+# true
+```
+
+### write_json
+
+Creates a json file from a hash.
+
+```ruby
+hash_value = {
+      name: "Martin",
+      age: 30,
+      languages: [
+        "English",
+        "Spanish"
+      ]
+    }
+
+write_json(
+    file_path: "#{__dir__}/my_json.json",
+    hash: hash_value
+)
+```
+
+Will create a my_json.json file with the following content:
+
+```json
+{
+  "name": "Martin",
+  "age": 30,
+  "languages": [
+    "English",
+    "Spanish"
+  ]
+}
+```
 
 ## Example
 

data/lib/fastlane/plugin/json/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Json
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Martin Gonzalez
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: actions related to json files