fastlane-plugin-onesky 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f01209a76cfd86ee3fdde349cf23ce589c2c9414
+  data.tar.gz: 29f3e02daf777744c56c94b13fbbb6e3f58540ea
+SHA512:
+  metadata.gz: a18305dbeaa514607bad66a6ec8b833d5b59834b1493a8ba3f664ad2545f33d558d99eaad36a3e8303007cc0529cdce1781f3c404256e8dc7239e9f24a76eedb
+  data.tar.gz: fe0b9d70207231419ad32283efbcaa6fd3da8cc5de219790d224a011a4ee9739aabaaf435080cb28f50f8a5e8de6cb832021cd668e468e49103817731c47e529

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Kiedrowski <daniel@levire.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,105 @@
+# OneSky Fastlane Plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-onesky)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-onesky`, add it to your project by running:
+
+```bash
+fastlane add_plugin onesky
+```
+
+## About
+
+This fastlane plugin helps you to update the translations of your app using the OneSky service. You can upload your current base localization file with `onesky_upload` and download new translations with `onesky_download` from OneSky.
+
+OneSky is a translation service for to help ypu translate your iOS, Android, Websites and Software. TO find out more about the OneSky Service, please head over to http://www.oneskyapp.com.
+
+## Reference and Example
+
+The OneSky fastlane plugin provides two new actions: `onesky_upload` and `onesky_download`
+
+### `onesky_upload`
+
+Uploads a new translation file to the onesky service.
+
+````ruby
+onesky_upload(
+      public_key: "abc123abc123abc123abc123abc123abc",
+      secret_key: "xyz890xyz890xyz890xyz890xyz890xyz",
+      project_id: "1234",
+      strings_file_path: "./localizations/en.xliff",
+      strings_file_format: "XLIFF",
+      deprecate_missing: true
+    )
+````
+
+Parameter | Description
+--------- | -----------
+`public_key` | Your OneSky account public key. You retrive it by logging into your OneSky account, go to *Settings* and then *API Keys & Usages*.
+`private_key` | Your OneSky account private key. You retrive it by logging into your OneSky account, go to *Settings* and then *API Keys & Usages*.
+`project_id` | The ID of the project you want the tranlstions uploaded for. You retrive it, by logging into your OneSky account, navigate to your projects overview and copy the number behind the # in the brackets. (i.e. (#1234) -> `"1234"`)
+`strings_file_path` | The file path to the localization file you want to upload.
+`strings_file_format` | The format of localization file you want to upload. For more information about the available types head over to https://github.com/onesky/api-documentation-platform/blob/master/reference/format.md.
+`deprecate_missing` | *(optional)* Indicates whether the strings that aren't available in the new translation file should be marked as deprecated. Defaults to `false`.
+
+### `onesky_download`
+
+Uploads a new translation file to the onesky service.
+
+````ruby
+onesky_download(
+      public_key: "abc123abc123abc123abc123abc123abc",
+      secret_key: "xyz890xyz890xyz890xyz890xyz890xyz",
+      project_id: "1234",
+      locale: "de",
+      filename: "en.xliff",
+      destination: "./localizations/de.xliff"
+    )
+````
+
+Parameter | Description
+--------- | -----------
+`public_key` | Your OneSky account public key. You retrive it by logging into your OneSky account, go to *Settings* and then *API Keys & Usages*.
+`private_key` | Your OneSky account private key. You retrive it by logging into your OneSky account, go to *Settings* and then *API Keys & Usages*.
+`project_id` | The ID of the project you want the tranlstions downloaded for. You retrive it, by logging into your OneSky account, navigate to your projects overview and copy the number behind the # in the brackets. (i.e. (#1234) -> `"1234"`)
+`locale` | The locale your wnat to download the translation for.
+`filename` | The filename fo the file you want the translation for. It is the name of your original uploaded file.
+`destination` | Filepath of the file to write the translations to.
+
+## 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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+## Acknowledgements
+The code for the upload action is based on the fastlane plugin `upload_to_onesky` by [@joshrlesch](https://github.com/joshrlesch):
+https://github.com/joshrlesch/fastlane-plugin-upload_to_onesky
+
+
+This plugin was developed for and during the work on the [Youpooly iOS App](https://www.youpooly.com).

data/lib/fastlane/plugin/onesky.rb

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

data/lib/fastlane/plugin/onesky/actions/onesky_download_action.rb

@@ -0,0 +1,81 @@
+module Fastlane
+  module Actions
+    class OneskyDownloadAction < Action
+      def self.run(params)
+        Actions.verify_gem!('onesky-ruby')
+        require 'onesky'
+
+        client = ::Onesky::Client.new(params[:public_key], params[:secret_key])
+        project = client.project(params[:project_id])
+
+        UI.success "Downloading translation '#{params[:locale]}' of file '#{params[:filename]}' from OneSky to: '#{params[:destination]}'"
+        resp = project.export_translation(source_file_name: params[:filename], locale: params[:locale])
+        File.open(params[:destination], 'w') { |file| file.write(resp) }
+      end
+
+      def self.description
+        'Download a translation file from OneSky'
+      end
+
+      def self.authors
+        ['danielkiedrowski']
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :public_key,
+                                       env_name: 'ONESKY_PUBLIC_KEY',
+                                       description: 'Public key for OneSky',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No Public Key for OneSky given, pass using `public_key: 'token'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :secret_key,
+                                       env_name: 'ONESKY_SECRET_KEY',
+                                       description: 'Secret Key for OneSky',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No Secret Key for OneSky given, pass using `secret_key: 'token'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: 'ONESKY_PROJECT_ID',
+                                       description: 'Project Id to upload file to',
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No project id given, pass using `project_id: 'id'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :locale,
+                                       env_name: 'ONESKY_DOWNLOAD_LOCALE',
+                                       description: 'Locale to download the translation for',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise 'No locale for translation given'.red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :filename,
+                                       env_name: 'ONESKY_DOWNLOAD_FILENAME',
+                                       description: 'Name of the file to download the localization for',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No filename given. Please specify the filename of the file you want to download the translations for using `filename: 'filename'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :destination,
+                                       env_name: 'ONESKY_DOWNLOAD_DESTINATION',
+                                       description: 'Destination file to write the downloaded file to',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "Please specify the filename of the desrtination file you want to download the translations to using `destination: 'filename'`".red unless value and !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/onesky/actions/onesky_upload_action.rb

@@ -0,0 +1,89 @@
+module Fastlane
+  module Actions
+    class OneskyUploadAction < Action
+      def self.run(params)
+        Actions.verify_gem!('onesky-ruby')
+        require 'onesky'
+
+        client = ::Onesky::Client.new(params[:public_key], params[:secret_key])
+
+        project = client.project(params[:project_id])
+
+        UI.success 'Starting the upload to OneSky'
+        resp = project.upload_file(
+          file: params[:strings_file_path],
+          file_format: params[:strings_file_format],
+          is_keeping_all_strings: !params[:deprecate_missing]
+        )
+
+        if resp.code == 201
+          UI.success "#{File.basename params[:strings_file_path]} was successfully uploaded to project #{params[:project_id]} in OneSky"
+        else
+          UI.error "Error uploading file to OneSky, Status code is #{resp.code}"
+        end
+      end
+
+      def self.description
+        'Upload a strings file to OneSky'
+      end
+
+      def self.authors
+        ['JMoravec', 'joshrlesch', 'danielkiedrowski']
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :public_key,
+                                       env_name: 'ONESKY_PUBLIC_KEY',
+                                       description: 'Public key for OneSky',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No Public Key for OneSky given, pass using `public_key: 'token'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :secret_key,
+                                       env_name: 'ONESKY_SECRET_KEY',
+                                       description: 'Secret Key for OneSky',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No Secret Key for OneSky given, pass using `secret_key: 'token'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: 'ONESKY_PROJECT_ID',
+                                       description: 'Project Id to upload file to',
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "No project id given, pass using `project_id: 'id'`".red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :strings_file_path,
+                                       env_name: 'ONESKY_STRINGS_FILE_PATH',
+                                       description: 'Base file path for the strings file to upload',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise "Couldn't find file at path '#{value}'".red unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :strings_file_format,
+                                       env_name: 'ONESKY_STRINGS_FORMAT',
+                                       description: 'Format of the strings file: see https://github.com/onesky/api-documentation-platform/blob/master/reference/format.md',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         raise 'No file format given'.red unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :deprecate_missing,
+                                       env_name: 'ONESKY_DEPRECATE_MISSING',
+                                       description: 'Should missing phrases be marked as deprecated in OneSky?',
+                                       is_string: false,
+                                       optional: true,
+                                       default_value: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/onesky/helper/onesky_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class OneskyHelper
+      # class methods that you define here become available in your action
+      # as `Helper::OneskyHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the onesky plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Onesky
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-onesky
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Daniel Kiedrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onesky-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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: 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'
+  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: 1.105.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.105.3
+description: 
+email: daniel@levire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/onesky.rb
+- lib/fastlane/plugin/onesky/actions/onesky_download_action.rb
+- lib/fastlane/plugin/onesky/actions/onesky_upload_action.rb
+- lib/fastlane/plugin/onesky/helper/onesky_helper.rb
+- lib/fastlane/plugin/onesky/version.rb
+homepage: https://github.com/danielkiedrowski/fastlane-plugin-onesky
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Helps to update the translations of your app using the OneSky service.
+test_files: []