RubyGems - fastlane-plugin-execute_api - Versions diffs - 0.1.0 - Mend

fastlane-plugin-execute_api 0.1.0

Files changed (8) hide show

checksums.yaml +7 -0
data/LICENSE +21 -0
data/README.md +52 -0
data/lib/fastlane/plugin/execute_api/actions/execute_api_action.rb +149 -0
data/lib/fastlane/plugin/execute_api/helper/execute_api_helper.rb +16 -0
data/lib/fastlane/plugin/execute_api/version.rb +5 -0
data/lib/fastlane/plugin/execute_api.rb +16 -0
metadata +202 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0d2d79f45d0a9f8fa98186c201e24668428706a6229d3bfc6de73519affb4a0
+  data.tar.gz: 5235b059fcdb396d48691a4f6e9a2652fa2689d71c4ea240b3723d6d1b5fdf36
+SHA512:
+  metadata.gz: e78b5190e23a7ffaeb341d6638bf76d56e0d8b844a4c7cc20ff8c0a598e91f3b56d696408e7cbb8f4661b381b71b5f1736450072c84f8e503a9450bf02d37798
+  data.tar.gz: a38e692e15b902701d1cb7f4b06a2d10a1d6c6ab7a2e1fc8fac3de2503d7846b2088d9229d97d5a30c67f1072ebf636a740069b6c46a1c9261f151e427ae83a9

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2022 Pasan Eramusugoda <pasan.eramusugoda@axienta.lk>
+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 ADDED Viewed

@@ -0,0 +1,52 @@
+# execute_api plugin
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-execute_api)
+## Getting Started
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-execute_api`, add it to your project by running:
+```bash
+fastlane add_plugin execute_api
+```
+## About execute_api
+This plugin will be used to execute an api
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+## 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 test`.
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+## 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/execute_api/actions/execute_api_action.rb ADDED Viewed

@@ -0,0 +1,149 @@
+require 'fastlane/action'
+require 'rest-client'
+require_relative '../helper/execute_api_helper'
+module Fastlane
+  module Actions
+    class ExecuteApiAction < Action
+      def self.run(config)
+        params = {}
+        # extract parms from config received from fastlane
+        params[:uploadArtifacts] = config[:uploadArtifacts]
+        params[:endPoint] = config[:endPoint]
+        params[:apk] = config[:apk]
+        params[:ipa] = config[:ipa]
+        params[:file] = config[:file]
+        params[:method] = config[:method]
+        params[:multipartPayload] = config[:multipartPayload]
+        params[:headers] = config[:headers]
+        upload_artifacts = params[:uploadArtifacts]
+        apk_file = params[:apk]
+        ipa_file = params[:ipa]
+        custom_file = params[:file]
+        end_point = params[:endPoint]
+        UI.user_error!("No endPoint given, pass using endPoint: 'endpoint'") if end_point.to_s.length == 0 && end_point.to_s.length == 0
+        UI.user_error!("No IPA or APK or a file path given, pass using `ipa: 'ipa path'` or `apk: 'apk path' or file:`") if upload_artifacts && ipa_file.to_s.length == 0 && apk_file.to_s.length == 0 && custom_file.to_s.length == 0
+        UI.user_error!("Please only give IPA path or APK path (not both)") if upload_artifacts && ipa_file.to_s.length > 0 && apk_file.to_s.length > 0
+        if upload_artifacts
+          upload_custom_file(params, apk_file) if apk_file.to_s.length > 0
+          upload_custom_file(params, ipa_file) if ipa_file.to_s.length > 0
+          upload_custom_file(params, custom_file) if custom_file.to_s.length > 0
+        else
+          multipart_payload = params[:multipartPayload]
+          multipart_payload[:multipart] = false
+          upload_request(params, multipart_payload)
+        end
+      end
+      def self.upload_custom_file(params, custom_file)
+        multipart_payload = params[:multipartPayload]
+        multipart_payload[:multipart] = true
+        if multipart_payload[:fileFormFieldName]
+          key = multipart_payload[:fileFormFieldName]
+          multipart_payload["#{key}"] = File.new(custom_file, 'rb')
+        else
+          multipart_payload[:file] = File.new(custom_file, 'rb')
+        end
+      UI.message multipart_payload
+      upload_request(params, multipart_payload)
+      end
+      def self.upload_request(params, multipart_payload)
+        request = RestClient::Request.new(
+          method: params[:method],
+          url: params[:endPoint],
+          payload: multipart_payload,
+          headers: params[:headers],
+          log: Logger.new(STDOUT)
+        )
+        response = request.execute
+        UI.message(response)
+        if params[:uploadArtifacts]
+          UI.success("Successfully finished uploading the fille") if response.code == 200 || response.code == 201
+        else
+          UI.success("Successfully finished executing the request") if response.code == 200 || response.code == 201
+        end
+      end
+      def self.description
+        "This plugin will be used to execute an api"
+      end
+      def self.authors
+        ["Pasan Eramusugoda"]
+      end
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+      def self.details
+        # Optional:
+        "Plugin can be used to execute an api or file upload, which will be usefull when need to notify your self hosted backend"
+      end
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :uploadArtifacts,
+                                  env_name: "",
+                                  description: "uploading any file or not",
+                                  optional: true,
+                                  default_value: false,
+                                  type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :apk,
+                                  env_name: "",
+                                  description: ".apk file for the build",
+                                  optional: true,
+                                  default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH]),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                  env_name: "",
+                                  description: ".ipa file for the build ",
+                                  optional: true,
+                                  default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]),
+          FastlaneCore::ConfigItem.new(key: :file,
+                                  env_name: "",
+                                  description: "file to be uploaded to the server",
+                                  optional: true),
+          FastlaneCore::ConfigItem.new(key: :multipartPayload,
+                                  env_name: "",
+                                  description: "payload for the multipart request ",
+                                  optional: true,
+                                  type: Hash),
+          FastlaneCore::ConfigItem.new(key: :headers,
+                                    env_name: "",
+                                    description: "headers of the request ",
+                                    optional: true,
+                                    type: Hash),
+          FastlaneCore::ConfigItem.new(key: :endPoint,
+                                  env_name: "",
+                                  description: "file upload request url",
+                                  optional: false,
+                                  default_value: "",
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :method,
+                                  env_name: "",
+                                  description: "request method",
+                                  optional: true,
+                                  default_value: :post,
+                                  type: Symbol)
+        ]
+      end
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        platform == :ios || platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/execute_api/helper/execute_api_helper.rb ADDED Viewed

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

data/lib/fastlane/plugin/execute_api/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Fastlane
+  module ExecuteApi
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/execute_api.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/execute_api/version'
+module Fastlane
+  module ExecuteApi
+    # 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::ExecuteApi.all_classes.each do |current|
+  require current
+end

metadata ADDED Viewed

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-execute_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pasan Eramusugoda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0.rc1
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.200.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.200.0
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description:
+email: vaprera91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/execute_api.rb
+- lib/fastlane/plugin/execute_api/actions/execute_api_action.rb
+- lib/fastlane/plugin/execute_api/helper/execute_api_helper.rb
+- lib/fastlane/plugin/execute_api/version.rb
+homepage: https://github.com/pasaneramusugoda/fastlane-plugin-execute_api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: This plugin will be used to execute an api
+test_files: []