fastlane-plugin-json_auth 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91c38fcdde0bd67232329e0f29d9d37893e0c233248e2ce95f24c2cd9d70dc89
+  data.tar.gz: c0aea0900efb7cd4169ba38378123436fa0c4c2023acfe228b69fb825d0d4779
+SHA512:
+  metadata.gz: f4b708fa05c25a1eeeb134c554567203470e142c8b4c03eb003113cdf57cbd690155863f3874651c308c1fe77d7c3dc7cc38a209570656e5fb57543965e8ba94
+  data.tar.gz: b2cb866f1df76cb4867b4022b4759e7bf754d23f43e2fa9b1f73cc36beed297b6ff89c3294f440e82f3ed60e147fc13e1e235ac8d58b3c99c5f16501f4e0eb4e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Martin Gonzalez <gonzalez.martin90@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# Fastlane Json plugin <!-- omit in toc -->
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-json) ![Gem Version](https://badge.fury.io/rb/fastlane-plugin-json.svg) ![](https://ruby-gem-downloads-badge.herokuapp.com/fastlane-plugin-json) [![YourActionName Actions Status](https://github.com/MartinGonzalez/fastlane-plugin-json/workflows/Test-Build-Publish/badge.svg)](https://github.com/MartinGonzalez/fastlane-plugin-json/actions)
+
+- [Getting Started](#getting-started)
+- [Actions](#actions)
+    - [read_json](#read_json)
+    - [download_json](#download_json)
+    - [write_json](#write_json)
+    - [merge_jsons](#merge_jsons)
+- [Example](#example)
+- [Run tests for this plugin](#run-tests-for-this-plugin)
+- [Issues and Feedback](#issues-and-feedback)
+- [Troubleshooting](#troubleshooting)
+- [Using _fastlane_ Plugins](#using-fastlane-plugins)
+- [About _fastlane_](#about-fastlane)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-json`,
+add it to your project by running:
+
+```bash
+fastlane add_plugin json
+```
+
+## Actions
+
+This plugin provide several actions that will allow you to manipulate and create json files.
+
+### read_json
+
+| Key       | Description       | Env Var | Default |
+|-----------|-------------------|---------|---------|
+| json_path | Path to json file |         |         |
+| verbose   | verbose           |         |  false  |
+
+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
+
+| Key      | Description                     | Env Var | Default |
+|----------|---------------------------------|---------|---------|
+| json_url | Url to json file                |         |         |
+| username | Basic auth username to download |         |         |
+| password | Basic auth password to download |         |         |
+| verbose  | verbose                         |         |  false  |
+
+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",
+  username: "admin",
+  password: "admin123"
+)
+
+puts my_json[:name]
+# "Martin Gonzalez"
+puts my_json[:gender]
+# "male"
+puts my_json[:isDev]
+# true
+```
+
+### write_json
+
+| Key       | Description                               | Env Var | Default |
+|-----------|-------------------------------------------|---------|---------|
+| hash      | Hash that you want to save as a json file |         |         |
+| file_path | Path where you want to save your json     |         |         |
+| verbose   | verbose                                   |         |  false  |
+
+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"
+  ]
+}
+```
+
+### merge_jsons
+
+| Key         | Description                               | Env Var | Default |
+|-------------|-------------------------------------------|---------|---------|
+| jsons_paths | Array of json files paths                 |         |         |
+| output_path | Output path where result will be saved    |         |         |
+| verbose     | verbose                                   |         |  false  |
+
+Merges several json files into one hash as output. Also you can set the `output_path` to save the merged hash into a
+json file.
+
+Having this files:
+
+`example.json`
+
+```json
+{
+  "name": "Martin",
+  "age": 30
+}
+```
+
+`example2.json`
+
+```json
+{
+  "lastName": "Gonzalez",
+  "age": 40,
+  "isDev": true
+}
+```
+
+```ruby
+output_path = "#{__dir__}/tmp/merged.json"
+
+merged_hash = merge_jsons(
+  jsons_paths: [
+    "path/to/example.json",
+    "path/to/example2.json"
+  ],
+  output_path: output_path
+)
+
+# {:name=>"Martin", :age=>40, :lastName=>"Gonzalez", :isDev=>true}
+```
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo,
+running `fastlane install_plugins` and `bundle exec fastlane all`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out
+the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out
+the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more,
+check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/json/actions/download_json_action.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module Fastlane
+  module Actions
+    class DownloadJsonAction < Action
+      def self.run(params)
+        json_url = params[:json_url]
+        @is_verbose = params[:verbose]
+
+        uri = URI(json_url)
+        request = Net::HTTP::Get.new uri.request_uri
+        request.basic_auth params[:username], params[:password]
+
+        print_params(params) if @is_verbose
+        puts("Downloading json from #{uri}") if @is_verbose
+
+        begin
+          response = http.request request
+          JSON.parse(response.body, symbolize_names: true)
+        rescue JSON::ParserError
+          puts_error!("Downloaded json has invalid content ❌")
+        rescue => exception
+          puts_error!("Failed to download json. Message: #{exception.message} ❌")
+        end
+      end
+
+      def self.puts_error!(message)
+        UI.user_error!(message)
+        raise StandardError, message
+      end
+
+      def self.description
+        "Downloads a json file and expose a hash with symbolized names as result"
+      end
+
+      def self.details
+        "Use this action to download a json file and access to it as Hash with symbolized names"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :json_url,
+                                       description: "Url to json file",
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("You must set json_url pointing to a json file") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: "verbose",
+                                       optional: true,
+                                       type: Boolean,
+                                       default_value: false)
+
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for download_json #{Fastlane::Json::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              hide_keys: [],
+                                              title: table_title)
+      end
+
+      def self.return_value
+        "Hash"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/json/actions/merge_jsons_action.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Fastlane
+  module Actions
+    class MergeJsonsAction < Action
+      def self.run(params)
+        jsons_paths = params[:jsons_paths]
+        output_path = params[:output_path]
+        @is_verbose = params[:verbose]
+
+        print_params(params) if @is_verbose
+        put_error!("jsons_path cannot be empty ❌") if jsons_paths.empty?
+
+        hashes = jsons_paths.map do |json_path|
+          put_error!("json_path: #{json_path} is not valid ❌") unless File.exist?(json_path)
+          json_content = File.read(File.expand_path(json_path))
+          begin
+            JSON.parse(json_content, symbolize_names: true)
+          rescue
+            put_error!("File at path #{json_path} has invalid content. ❌")
+          end
+        end
+
+        merged_hash = hashes.reduce({}, :merge)
+
+        write_hash_at(output_path, merged_hash) unless output_path.to_s.empty?
+
+        merged_hash
+      end
+
+      def self.write_hash_at(output_path, hash)
+        file_path_expanded = File.expand_path(output_path)
+        file_dir = File.dirname(file_path_expanded)
+        Dir.mkdir(file_dir) unless File.directory?(file_dir)
+
+        begin
+          File.open(output_path, "w") { |f| f.write(JSON.pretty_generate(hash)) }
+        rescue
+          put_error!("Failed to write json at #{output_path}. ❌")
+        end
+      end
+
+      def self.put_error!(message)
+        UI.user_error!(message)
+        raise StandardError, message
+      end
+
+      def self.description
+        "Merge a group of jsons files and expose a hash with symbolized names as result. Last json predominate over the rest"
+      end
+
+      def self.details
+        "Use this action to merge jsons files and access to it as Hash with symbolized names. Also you can set the output_path to save the result"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :jsons_paths,
+                                       description: "Array of json files paths",
+                                       type: Array,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("You must set jsons_paths") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       description: "Output path where result will be saved",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: "verbose",
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean)
+
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for merge_json #{Fastlane::Json::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              hide_keys: [],
+                                              title: table_title)
+      end
+
+      def self.return_value
+        "Hash"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/json/actions/read_json_action.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Fastlane
+  module Actions
+    class ReadJsonAction < Action
+      def self.run(params)
+        json_path = params[:json_path]
+        json_string = params[:json_string]
+        @is_verbose = params[:verbose]
+
+        if json_path.nil? && json_string.nil?
+          put_error!("You need to provide a json_path (file to path) or json_string (json as string) ❌")
+          return nil
+        end
+
+        print_params(params) if @is_verbose
+
+        json_content = json_string
+
+        unless json_path.nil?
+          unless File.file?(json_path)
+            put_error!("File at path #{json_path} does not exist. Verify that the path is correct ❌")
+            return nil
+          end
+
+          json_content = File.read(json_path)
+        end
+
+        begin
+          JSON.parse(json_content, symbolize_names: true)
+        rescue
+          put_error!("File at path #{json_path} has invalid content. ❌")
+        end
+      end
+
+      def self.put_error!(message)
+        UI.user_error!(message)
+        raise StandardError, message
+      end
+
+      def self.description
+        "Read a json file and expose a hash with symbolized names as result"
+      end
+
+      def self.details
+        "Use this action to read a json file and access to it as Hash with symbolized names"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :json_path,
+                                       description: "Path to json file",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :json_string,
+                                       description: "A json as string",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: "verbose",
+                                       optional: true,
+                                       type: Boolean)
+
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for read_json #{Fastlane::Json::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              hide_keys: [],
+                                              title: table_title)
+      end
+
+      def self.return_value
+        "Hash"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/json/actions/write_json_action.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Fastlane
+  module Actions
+    class WriteJsonAction < Action
+      def self.run(params)
+        hash = params[:hash]
+        file_path = params[:file_path]
+        @is_verbose = params[:verbose]
+        print_params(params) if @is_verbose
+
+        put_error!("file_path: value cannot be nil or empty") if file_path.nil? || file_path.empty?
+        put_error!("hash: value cannot be nil") if hash.nil?
+
+        file_path_expanded = File.expand_path(file_path)
+        file_dir = File.dirname(file_path_expanded)
+        Dir.mkdir(file_dir) unless File.directory?(file_dir)
+
+        begin
+          File.open(file_path, "w") do |f|
+            f.write(JSON.pretty_generate(hash))
+          end
+        rescue
+          put_error!("File at path #{json_path} has invalid content. ❌")
+        end
+      end
+
+      def self.put_error!(message)
+        UI.user_error!(message)
+        raise StandardError, message
+      end
+
+      def self.description
+        "Write a json file from a hash at the provided path"
+      end
+
+      def self.details
+        "Use this action to serialize a hash into a json file in a provided path."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :hash,
+                                       description: "Hash that you want to save as a json file",
+                                       optional: false,
+                                       type: Hash,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("You must set hash: parameter") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       description: "Path where you want to save your json",
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("You must set file_path: parameter") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: "verbose",
+                                       optional: true,
+                                       type: Boolean)
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for write_json #{Fastlane::Json::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              hide_keys: [],
+                                              title: table_title)
+      end
+
+      def self.return_value
+        "Nothing"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/json/helper/json_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class JsonHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JsonHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the json plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Json
+    VERSION = "1.2.1"
+  end
+end

data/lib/fastlane/plugin/json.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/json/version'
+
+module Fastlane
+  module Json
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Json.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-json_auth
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Martin Gonzalez
+- Thang Nguyen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.151.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.151.2
+description:
+email:
+- gonzalez.martin90@gmail.com
+- thang.nguyencao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/json.rb
+- lib/fastlane/plugin/json/actions/download_json_action.rb
+- lib/fastlane/plugin/json/actions/merge_jsons_action.rb
+- lib/fastlane/plugin/json/actions/read_json_action.rb
+- lib/fastlane/plugin/json/actions/write_json_action.rb
+- lib/fastlane/plugin/json/helper/json_helper.rb
+- lib/fastlane/plugin/json/version.rb
+homepage: https://github.com/thangnc/fastlane-plugin-json_auth
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: actions related to json files
+test_files: []