fastlane-plugin-mackerel_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbe5875464d547d2277a5e03c38b604814bad5b1ed029d94e884c2ee854f48cf
+  data.tar.gz: d3e855c46a80244909a0b34a835e4e0de369c9ef373598b0feaff400fd693f1d
+SHA512:
+  metadata.gz: b1c0f9796dce60017b6b7829006744f9f08c043bcf599ca26a60941a0de5817dc811a65d737b1352493fbd341923e1d6c812b26963928569d85dcc47322ee75d
+  data.tar.gz: 6a067fb6a499b732ea5a2c2ea4ffab4d493641063848f95036f463733537d87e389b51983b85b1da115e41f6a345706d89c5c1cdbb23a74707c3e5a446c145bb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 yutailang0119 <muta.yutaro@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,85 @@
+# mackerel_api plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-mackerel_api)
+![Test](https://github.com/yutailang0119/fastlane-plugin-mackerel_api/workflows/Test/badge.svg)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-mackerel_api`, add it to your project by running:
+
+```bash
+fastlane add_plugin mackerel_api
+```
+
+## About mackerel_api
+
+Call a [Mackerel](https://mackerel.io) API endpoint and get the resulting JSON response.
+
+Documentation: [Mackerel API Documents](https://mackerel.io/api-docs).
+
+## 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`.
+
+
+### Usage
+
+```ruby
+result = mackerel_api(
+  server_url: "https://api.mackerelio.com",
+  api_key: ENV["MACKEREL_API_KEY"],
+  http_method: "POST",
+  path: "api/v0/services",
+  body: { "name": "ExampleService", "memo": "This is an example." }
+)
+```
+
+```ruby
+# Alternatively call directly with optional error handling or block usage
+MackerelApiAction.run(
+  server_url: "https://api.mackerelio.com",
+  api_key: ENV["MACKEREL_API_KEY"],
+  http_method: "POST",
+  path: "api/v0/services",
+  body: { "name": "ExampleService", "memo": "This is an example." },
+  error_handlers: {
+    404 => proc do |result|
+      UI.message("Something went wrong - I couldn\'t find it...")
+    end,
+    '*' => proc do |result|
+      UI.message("Handle all error codes other than 404")
+    end
+  }
+) do |result|
+    UI.message("JSON returned: #{result[:json]}")
+end
+```
+
+## 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/mackerel_api/actions/mackerel_api_action.rb

@@ -0,0 +1,201 @@
+require 'fastlane/action'
+require_relative '../helper/mackerel_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      MACKEREL_API_STATUS_CODE = :MACKEREL_API_STATUS_CODE
+      MACKEREL_API_RESPONSE = :MACKEREL_API_RESPONSE
+      MACKEREL_API_JSON = :MACKEREL_API_JSON
+    end
+
+    class MackerelApiAction < Action
+      def self.run(params)
+        require 'json'
+
+        http_method = (params[:http_method] || 'GET').to_s.upcase
+        url = Helper::MackerelApiHelper.construct_url(params[:server_url], params[:path], params[:url])
+        headers = Helper::MackerelApiHelper.construct_headers(params[:api_key], params[:headers])
+        payload = Helper::MackerelApiHelper.construct_body(params[:body], params[:raw_body])
+        error_handlers = params[:error_handlers] || {}
+        secure = params[:secure]
+
+        response = Helper::MackerelApiHelper.call_endpoint(
+          url,
+          http_method,
+          headers,
+          payload,
+          secure
+        )
+
+        status_code = response[:status]
+        result = {
+          status: status_code,
+          body: response.body || "",
+          json: Helper::MackerelApiHelper.parse_json(response.body) || {}
+        }
+
+        if status_code.between?(200, 299)
+          UI.verbose("Response:")
+          UI.verbose(response.body)
+          UI.verbose("---")
+          yield(result) if block_given?
+        else
+          handled_error = error_handlers[status_code] || error_handlers['*']
+          if handled_error
+            handled_error.call(result)
+          else
+            UI.error("---")
+            UI.error("Request failed:\n#{http_method}: #{url}")
+            UI.error("Headers:\n#{headers}")
+            UI.error("---")
+            UI.error("Response:")
+            UI.error(response.body)
+            UI.user_error!("Mackerel responded with #{status_code}\n---\n#{response.body}")
+          end
+        end
+
+        Actions.lane_context[SharedValues::MACKEREL_API_STATUS_CODE] = result[:status]
+        Actions.lane_context[SharedValues::MACKEREL_API_RESPONSE] = result[:body]
+        Actions.lane_context[SharedValues::MACKEREL_API_JSON] = result[:json]
+
+        return result
+      end
+
+      def self.description
+        "Call a Mackerel API endpoint and get the resulting JSON response"
+      end
+
+      def self.details
+        [
+          "Call a [Mackerel](https://mackerel.io) API endpoint and get the resulting JSON response.",
+          "You must provide your Mackerel API key (get one from [Dashboard](https://mackerel.io/my?tab=apikeys)).",
+          "Documentation: [Mackerel API Documents](https://mackerel.io/api-docs)."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :server_url,
+                                       env_name: "FL_MACKEREL_API_SERVER_URL",
+                                       description: "The server url. e.g. 'https://api.mackerelio.com'",
+                                       default_value: "https://api.mackerelio.com",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please include the protocol in the server url, e.g. https://api.mackerelio.com") unless value.include?("//")
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "FL_MACKEREL_API_KEY",
+                                       description: "API key for Mackerel - generate one at https://mackerel.io/my?tab=apikeys",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :http_method,
+                                       env_name: "FL_MACKEREL_API_HTTP_METHOD",
+                                       description: "The HTTP method. e.g. GET / POST",
+                                       default_value: "GET",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         unless %w(GET POST PUT DELETE HEAD CONNECT PATCH).include?(value.to_s.upcase)
+                                           UI.user_error!("Unrecognised HTTP method")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :body,
+                                       env_name: "FL_MACKEREL_API_REQUEST_BODY",
+                                       description: "The request body in JSON or hash format",
+                                       is_string: false,
+                                       default_value: {},
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :raw_body,
+                                       env_name: "FL_MACKEREL_API_REQUEST_RAW_BODY",
+                                       description: "The request body taken verbatim instead of as JSON, useful for file uploads",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "FL_MACKEREL_API_PATH",
+                                       description: "The endpoint path. e.g. '/api/v0/hosts/<hostId>/metadata/<namespace>'",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_MACKEREL_API_URL",
+                                       description: "The complete full url - used instead of path. e.g. 'https://api.mackerelio.com/api/v0/services'",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please include the protocol in the url, e.g. https://api.mackerelio.com") unless value.include?("//")
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :error_handlers,
+                                       description: "Optional error handling hash based on status code, or pass '*' to handle all errors",
+                                       is_string: false,
+                                       default_value: {},
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :headers,
+                                       description: "Optional headers to apply",
+                                       is_string: false,
+                                       default_value: {},
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :secure,
+                                       env_name: "FL_MACKEREL_API_SECURE",
+                                       description: "Optionally disable secure requests (ssl_verify_peer)",
+                                       type: Boolean,
+                                       default_value: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['MACKEREL_API_STATUS_CODE', 'The status code returned from the request'],
+          ['MACKEREL_API_RESPONSE', 'The full response body'],
+          ['MACKEREL_API_JSON', 'The parsed json returned from Mackerel']
+        ]
+      end
+
+      def self.return_value
+        "A hash including the HTTP status code (:status), the response body (:body), and if valid JSON has been returned the parsed JSON (:json)."
+      end
+
+      def example_code
+        [
+          'result = mackerel_api(
+          server_url: "https://api.mackerelio.com",
+          api_key: ENV["MACKEREL_API_KEY"],
+          http_method: "POST",
+          path: "api/v0/services",
+          body: { "name": "ExampleService", "memo": "This is an example." }
+        )',
+          '# Alternatively call directly with optional error handling or block usage
+          MackerelApiAction.run(
+            server_url: "https://api.mackerelio.com",
+            api_key: ENV["MACKEREL_API_KEY"],
+            http_method: "POST",
+            path: "api/v0/services",
+            error_handlers: {
+              404 => proc do |result|
+                UI.message("Something went wrong - I couldn\'t find it...")
+              end,
+              \'*\' => proc do |result|
+                UI.message("Handle all error codes other than 404")
+              end
+            }
+          ) do |result|
+            UI.message("JSON returned: #{result[:json]}")
+          end
+        '
+        ]
+      end
+
+      def self.authors
+        ["yutailang0119"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def category
+        :source_control
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/mackerel_api/helper/mackerel_api_helper.rb

@@ -0,0 +1,53 @@
+module Fastlane
+  module Helper
+    class MackerelApiHelper
+      def self.construct_headers(api_key, overrides)
+        headers = { 'User-Agent' => 'fastlane-mackerel_api' }
+        headers['X-Api-Key'] = api_key if api_key
+        headers.merge(overrides || {})
+      end
+
+      def self.construct_url(server_url, path, url)
+        return_url = (server_url && path) ? File.join(server_url, path) : url
+        UI.user_error!("Please provide either `server_url` (e.g. https://api.mackerelio.com) and 'path' or full 'url' for Mackerel API endpoint") unless return_url
+        return_url
+      end
+
+      def self.construct_body(body, raw_body)
+        body ||= {}
+        if raw_body
+          raw_body
+        elsif body.kind_of?(Hash)
+          body.to_json
+        elsif body.kind_of?(Array)
+          body.to_json
+        else
+          UI.user_error!("Please provide valid JSON, or a hash as request body") unless parse_json(body)
+          body
+        end
+      end
+
+      def self.parse_json(value)
+        JSON.parse(value)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def self.call_endpoint(url, http_method, headers, body, secure)
+        require 'excon'
+        Excon.defaults[:ssl_verify_peer] = secure
+        middlewares = Excon.defaults[:middlewares] + [Excon::Middleware::RedirectFollower] # allow redirect in case of repo renames
+        UI.verbose("#{http_method} : #{url}")
+        connection = Excon.new(url)
+        connection.request(
+          method: http_method,
+          headers: headers,
+          middlewares: middlewares,
+          body: body,
+          debug_request: FastlaneCore::Globals.verbose?,
+          debug_response: FastlaneCore::Globals.verbose?
+        )
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/mackerel_api.rb

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-mackerel_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yutailang0119
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-06 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.146.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.146.1
+description: 
+email: muta.yutaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/mackerel_api.rb
+- lib/fastlane/plugin/mackerel_api/actions/mackerel_api_action.rb
+- lib/fastlane/plugin/mackerel_api/helper/mackerel_api_helper.rb
+- lib/fastlane/plugin/mackerel_api/version.rb
+homepage: https://github.com/yutailang0119/fastlane-plugin-mackerel_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Call a Mackerel API endpoint and get the resulting JSON response
+test_files: []