fastlane-plugin-redmine_upload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8466b95d920a50c4882fd22369a596494934aa3d
+  data.tar.gz: 5b35df0458b5e8a1ac15bf5ac67ebd9fd2b7ee27
+SHA512:
+  metadata.gz: c6a8c5cc03a317f7fc0364d7482578c568a880feb474f2706444dcb00ef268f952effa4233c40c9a29367636e413c7c0f5e36f6a7555244e75fbc7af460d9c69
+  data.tar.gz: cfe23f4aaeab20951a9ab38eccafe7c0041fe8638be77e7882f4f2d5591898c6928937276bb6d2e3803187463eab9d94f091e4e5b2bf05480c18691c07d4327d

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,51 @@
+# redmine_upload plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-redmine_upload)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-redmine_upload`, add it to your project by running:
+
+```bash
+fastlane add_plugin redmine_upload
+```
+
+## About redmine_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_upload.rb

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

data/lib/fastlane/plugin/redmine_upload/actions/redmine_upload_action.rb

@@ -0,0 +1,131 @@
+require 'fastlane/action'
+require_relative '../helper/redmine_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 RedmineUploadAction < 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]
+        username = params[:redmine_username]
+        password = params[:redmine_password]
+
+        upload_content_uri = URI.parse(redmine_url+'/uploads.json')
+        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)
+          request_upload_content = Net::HTTP::Post.new(upload_content_uri.request_uri)
+
+          request_upload_content["Content-Type"] = "application/octet-stream"
+          unless api_key == nil 
+            request_upload_content["X-Redmine-API-Key"] = "#{api_key}"
+          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.value)
+          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: :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_upload/helper/redmine_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 RedmineUploadHelper
+      # class methods that you define here become available in your action
+      # as `Helper::RedmineUploadHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the redmine_upload plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-redmine_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Salvetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-14 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: mattia.salvetti3@gmail.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/redmine_upload.rb
+- lib/fastlane/plugin/redmine_upload/actions/redmine_upload_action.rb
+- lib/fastlane/plugin/redmine_upload/helper/redmine_upload_helper.rb
+- lib/fastlane/plugin/redmine_upload/version.rb
+homepage: https://github.com/salmattia/fastlane-plugin-redmine_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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: A fastlane plugin to upload file contents to Redmine
+test_files: []