fastlane-plugin-redmine_file_upload 4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6dbc95690f62ae965dd45f8a4877005e9c1a557bb84c65e60a58d0999c54b66
+  data.tar.gz: 12b576b8edce800a05f0feba612205f619181908de87ca06c50c25ad4778f758
+SHA512:
+  metadata.gz: ed648af7387316334c6233e8e208e8417d4e0f48fd44174c52a88656f19ae34b02ec953d0781bcb6888b0956c1c717eb8559a7d2670fb646729829998d386703
+  data.tar.gz: f62729b5b357a50dca54ab45ad4a749b854fedaa0a3342178cfb57cb4a291208f0c21c9e33b3a8bcad1a3eaaaa3be474b9aa039726ba4941bea21d8389f91333

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mattia Salvetti
+
+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,67 @@
+# redmine_file_upload plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-redmine_file_upload)
+
+## Forked From 
+
+This project is a Forked from [_This Archived Repo_](https://github.com/salmattia/fastlane-plugin-redmine_file_upload)
+
+Main reason is to use the functionality in new Ryby Version as the old repo only supports Ruby 2.x now the current supports 3.3 or more, as we have tested upto Ruby Version 3.3
+Pull Request are welcome. 
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-redmine_file_upload`, add it to your project by running:
+
+```bash
+fastlane add_plugin redmine_file_upload
+```
+
+You may use the below method too if you wish but not advised.
+
+For now to implement this you will have to add below like to your Pluginfile
+
+```bash
+gem "fastlane-plugin-redmine_file_upload", git: "https://github.com/pravindodia/fastlane-plugin-redmine_file_upload"
+```
+
+
+## About redmine_file_upload
+
+A fastlane plugin to upload file contents to Redmine
+
+This plugin uploads a content to a Redmine host by using POST /uploads.json API
+See http://www.redmine.org/projects/redmine/wiki/Rest_api#Attaching-files
+
+## 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`.
+
+## 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/redmine_file_upload/actions/redmine_file_post.rb

@@ -0,0 +1,156 @@
+module Fastlane
+  module Actions
+    class RedmineFilePostAction < Action
+      def self.run(params)
+        require 'net/http'
+        require 'uri'
+        require 'json'
+
+        redmine_url = params[:redmine_host]
+        api_key = params[:redmine_api_key]
+        redmine_use_sslhost = "true"
+        username = params[:redmine_username]
+        password = params[:redmine_password]
+        project = params[:redmine_project]
+        token =  params[:file_token]
+        file_name = params[:file_name]
+        file_version = params[:file_version]
+        file_description = params[:file_description]
+
+        unless redmine_use_sslhost.nil?
+          redmine_use_sslhost = params[:redmine_use_ssl]
+        end
+
+        upload_file_uri = URI.parse(redmine_url + "/projects/#{project}/files.json")
+        # prepare request with token previously got from upload
+        
+        json_content = {
+          "file" => {
+            "token" => token
+          }
+        }
+
+        if file_version != nil
+          json_content["file"]["version_id"] = file_version
+        end
+        if file_name != nil
+          json_content["file"]["filename"] = file_name
+        end
+        if file_description != nil
+          json_content["file"]["description"] = file_description
+        end
+            
+        file_body = JSON.pretty_generate(json_content)
+        UI.message("File post with content #{file_body}")
+
+        # Create the HTTP objects
+        http_file_post = Net::HTTP.new(upload_file_uri.host, upload_file_uri.port)
+        if redmine_use_sslhost == "true"
+          http_file_post.use_ssl = true
+          http_file_post.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        request_file = Net::HTTP::Post.new(upload_file_uri.request_uri)
+
+        request_file["Content-Type"] = "application/json"
+        unless api_key.nil?
+          request_file["X-Redmine-API-Key"] = api_key.to_s
+        end
+        unless username.nil? || password.nil?
+          request_file.basic_auth(username, password)
+        end
+
+        request_file.body = file_body
+          # Send the request
+        request_file = http_file_post.request(request_file)
+
+        case request_file
+        when Net::HTTPSuccess
+          UI.success("File uploaded successfully")
+        else
+          UI.error(request_file.value)
+        end
+      end
+
+      def self.description
+        "Uploads a file in a Redmine Files section of a given Redmine project"
+      end
+
+      def self.authors
+        ["Mattia Salvetti"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Uploads a file in a Redmine host under files section of specified Redmine project."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :redmine_host,
+                                   env_name: "REDMINE_HOST",
+                                description: "Redmine host where upload file. e.g. ",
+                                   optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_username,
+                                  env_name: "REDMINE_USERNAME",
+                               description: "Redmine username (optional). An API key can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_password,
+                                  env_name: "REDMINE_PASSWORD",
+                               description: "Redmine password (optional). An API key can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_api_key,
+                                  env_name: "REDMINE_API_KEY",
+                               description: "Redmine API key (optional). username and password can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_use_ssl,
+                                      env_name: "REDMINE_USE_SSL",
+                                   description: "Redmine USE_SSL key (optional). it use use plain http instead of https",
+                                      optional: true,
+                                          type: String),  
+          FastlaneCore::ConfigItem.new(key: :redmine_project,
+                                  env_name: "REDMINE_PROJECT",
+                               description: "Project of redmine",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :file_token,
+                                  env_name: "FILE_TOKEN",
+                               description: "Token of file previously released",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :file_name,
+                                  env_name: "FILE_NAME",
+                               description: "FIle name",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :file_version,
+                                  env_name: "FILE_VERSION",
+                               description: "Version of file",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :file_description,
+                                  env_name: "FILE_DESCRIPTION",
+                               description: "Description of file to upload",
+                                  optional: true,
+                                      type: String)
+
+        ]
+      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)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/redmine_file_upload/actions/redmine_file_upload_action.rb

@@ -0,0 +1,147 @@
+require 'fastlane/action'
+require_relative '../helper/redmine_file_upload_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      REDMINE_UPLOAD_FILE_TOKEN = :REDMINE_UPLOAD_FILE_TOKEN
+      REDMINE_UPLOAD_FILE_NAME = :REDMINE_UPLOAD_FILE_NAME
+    end
+    class RedmineFileUploadAction < Action
+      def self.run(params)
+        require 'net/http'
+        require 'net/http/uploadprogress'
+        require 'uri'
+        require 'json'
+
+        # getting parameters
+        file_path = params[:file_path]
+        file_name = File.basename(file_path) unless file_path.nil?
+
+        Actions.lane_context[SharedValues::REDMINE_UPLOAD_FILE_NAME] = file_name
+
+        redmine_url = params[:redmine_host]
+        api_key = params[:redmine_api_key]
+        redmine_use_sslhost = "true"
+        username = params[:redmine_username]
+        password = params[:redmine_password]
+
+        unless redmine_use_sslhost.nil?
+          redmine_use_sslhost = params[:redmine_use_ssl]
+        end
+
+        upload_content_uri = URI.parse(redmine_url + '/uploads.json'+'?filename='+file_name)
+        UI.message("Start file upload \"#{file_name}\" to Redmine API #{upload_content_uri}")
+
+        token = nil
+        response_upload_content = nil
+        File.open(file_path, 'rb') do |io|
+          # Create the HTTP objects
+          http_upload_content = Net::HTTP.new(upload_content_uri.host, upload_content_uri.port)
+
+          if redmine_use_sslhost == "true"
+            http_upload_content.use_ssl = true
+            http_upload_content.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+
+          request_upload_content = Net::HTTP::Post.new(upload_content_uri.request_uri)
+          UI.message("Request upload content #{upload_content_uri.port}")
+          request_upload_content["Content-Type"] = "application/octet-stream"
+          unless api_key.nil?
+            request_upload_content["X-Redmine-API-Key"] = api_key.to_s
+          end
+          unless username.nil? || password.nil?
+            request_upload_content.basic_auth(username, password)
+          end
+
+          request_upload_content.content_length = io.size
+          request_upload_content.body_stream = io
+          # print upload progress
+          Net::HTTP::UploadProgress.new(request_upload_content) do |progress|
+             printf("\rUploading \"#{file_name}\"...  #{100 * progress.upload_size / io.size}%%")
+          end
+          # Send the request
+          response_upload_content = http_upload_content.request(request_upload_content)
+          printf("\n")
+        end
+        case response_upload_content
+        when Net::HTTPSuccess
+          # get token from upload content response
+          token = JSON.parse(response_upload_content.body)['upload']['token']
+          UI.success("Content uploaded! File token released: #{token}")
+          Actions.lane_context[SharedValues::REDMINE_UPLOAD_FILE_TOKEN] = token
+        else
+          UI.error(response_upload_content.to_s)
+        end
+      end
+
+      def self.description
+        "A fastlane plugin to upload file contents to Redmine"
+      end
+
+      def self.authors
+        ["Mattia Salvetti"]
+      end
+
+      def self.output
+        [
+          ['REDMINE_UPLOAD_FILE_TOKEN', 'Token release as response of redmine POST /uploads.json'],
+          ['REDMINE_UPLOAD_FILE_NAME', 'Uploading file name']
+        ]
+      end
+
+      def self.return_value
+        "Returns a token released from redmine http POST to /uploads.json."
+      end
+
+      def self.details
+        # Optional:
+        "This plugin uses Redmine REST API to attach a generic file and release a token to use for attachment binding to any Redmine entity. It makes a http request to a redmine host POST /uploads.json
+        See APIs documentations at http://www.redmine.org/projects/redmine/wiki/Rest_api"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :redmine_host,
+                                  env_name: "REDMINE_HOST",
+                               description: "Redmine host where upload file. e.g. ",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_username,
+                                  env_name: "REDMINE_USERNAME",
+                               description: "Redmine username (optional). An API key can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_password,
+                                  env_name: "REDMINE_PASSWORD",
+                               description: "Redmine password (optional). An API key can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_api_key,
+                                  env_name: "REDMINE_API_KEY",
+                               description: "Redmine API key (optional). username and password can be provided instead",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :redmine_use_ssl,
+                                      env_name: "REDMINE_USE_SSL",
+                                   description: "Redmine USE_SSL key (optional). it use use plain http instead of https",
+                                      optional: true,
+                                          type: String),  
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                  env_name: "FILE_PATH",
+                               description: "Local path of file to upload to redmine",
+                                  optional: false,
+                                      type: String)
+        ]
+      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)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/redmine_file_upload/helper/redmine_file_upload_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RedmineFileUpload
+    VERSION = "4.0.1"
+  end
+end

data/lib/fastlane/plugin/redmine_file_upload.rb

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

data/lib/net/http/uploadprogress.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+require 'tempfile'
+require 'securerandom'
+
+class Net::HTTP::UploadProgress
+  attr_reader :upload_size
+
+  def initialize(req, &block)
+    @req = req
+    @callback = block
+    @upload_size = 0
+    if req.body_stream
+      @io = req.body_stream
+      req.body_stream = self
+    elsif req.instance_variable_get(:@body_data)
+      raise NotImplementedError if req.chunked?
+      raise NotImplementedError if /\Amultipart\/form-data\z/i !~ req.content_type
+      opt = req.instance_variable_get(:@form_option).dup
+      opt[:boundary] ||= SecureRandom.urlsafe_base64(40)
+      req.set_content_type(req.content_type, boundary: opt[:boundary])
+      file = Tempfile.new('multipart')
+      file.binmode
+      req.send(:encode_multipart_form_data, file, req.instance_variable_get(:@body_data), opt)
+      file.rewind
+      req.content_length = file.size
+      @io = file
+      req.body_stream = self
+    else
+      raise NotImplementedError
+    end
+  end
+
+  def readpartial(maxlen, outbuf)
+    begin
+      str = @io.readpartial(maxlen, outbuf)
+    ensure
+      @callback.call(self) unless @upload_size.zero?
+    end
+    @upload_size += str.length
+    str
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-redmine_file_upload
+version: !ruby/object:Gem::Version
+  version: 4.0.1
+platform: ruby
+authors:
+- Pravin Dodia
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-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.104.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.104.0
+description:
+email: pravindodia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/redmine_file_upload.rb
+- lib/fastlane/plugin/redmine_file_upload/actions/redmine_file_post.rb
+- lib/fastlane/plugin/redmine_file_upload/actions/redmine_file_upload_action.rb
+- lib/fastlane/plugin/redmine_file_upload/helper/redmine_file_upload_helper.rb
+- lib/fastlane/plugin/redmine_file_upload/version.rb
+- lib/net/http/uploadprogress.rb
+homepage: https://github.com/pravindodia/fastlane-plugin-redmine_file_upload
+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.5.11
+signing_key:
+specification_version: 4
+summary: A fastlane plugin to upload file contents to Redmine
+test_files: []