fastlane-plugin-apperian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1be9ef0603b008d48bbcf707f7efce8ec8302b5d
+  data.tar.gz: 705fdc53a30f314b4e7606df45ce5a6e018c46d5
+SHA512:
+  metadata.gz: 6dae633c76aac30a70829e09788158037ed05fce50284f2d6bef2f03aa2b1704d435f8c39319b5a4ad594706cfb5b8d1205603a1850778ead0d7af01540b1921
+  data.tar.gz: 27e9e28ab6af951c7f8775c348a3830764bd428bb0b30a65309ca9364cfab32c397f45f0869060b07fca67208d967fb22198867d308e291c7494de3e2b53f451

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 tomiblank
+
+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,52 @@
+# apperian plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-apperian)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-apperian`, add it to your project by running:
+
+```bash
+fastlane add_plugin apperian
+```
+
+## About apperian
+
+Allows to upload your app file to Apperian
+
+**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://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 beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/apperian.rb

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

data/lib/fastlane/plugin/apperian/actions/apperian_action.rb

@@ -0,0 +1,408 @@
+module Fastlane
+  module Actions
+    class ApperianAction < Action
+      $is_debug = false
+
+      def self.run(params)
+        # check if debug is enabled
+        $is_debug = params[:debug]
+
+        if debug
+          UI.message("---------------------------------")
+          UI.message("Apperian plugin debug information")
+          UI.message("---------------------------------")
+          UI.message(" api_url: #{params[:api_url]}")
+          UI.message(" email: #{params[:email]}")
+          UI.message(" password: #{params[:password]}")
+          UI.message(" app_identifier: #{params[:app_identifier]}")
+          UI.message(" ipa: #{params[:ipa]}")
+          UI.message(" app_name: #{params[:app_name]}")
+          UI.message(" author: #{params[:author]}")
+          UI.message(" short_description: #{params[:short_description]}")
+          UI.message(" long_description: #{params[:long_description]}")
+          UI.message(" version: #{params[:version]}")
+          UI.message(" version_notes: #{params[:version_notes]}")
+          UI.message("---------------------------------")
+        end
+
+        api_url = params[:api_url]
+        email = params[:email]
+        password = params[:password]
+        app_identifier = params[:app_identifier]
+        ipa = params[:ipa]
+        app_name = params[:app_name]
+        author = params[:author]
+        short_description = params[:short_description]
+        long_description = params[:long_description]
+        version = params[:version]
+        version_notes = params[:version_notes]
+
+        # step 1: authenticate
+        UI.message("1. Authenticate")
+        token = authenticate(api_url, email, password)
+
+        # step 2: find app
+        UI.message("2. Find app")
+        appID = find_app(api_url, app_identifier, token)
+        if debug
+          UI.message("Found app:")
+          UI.message(appID)
+        end
+        
+        # step 3: create or update app
+        transactionID = ""
+        fileUploadURL = ""
+
+        if appID == "" then
+          # step 3a: create app
+          UI.message("3a. Create app")
+          result = create_app(api_url, token) # return array [0] = transactionID, [1] = fileUploadURL
+          transactionID = result[0]
+          fileUploadURL = result[1]
+        else 
+          # step 3b: update app
+          UI.message("3b. Update app")
+          result = update_app(api_url, appID, token) # return array [0] = transactionID, [1] = fileUploadURL
+          transactionID = result[0]
+          fileUploadURL = result[1]
+        end
+
+        # step 4: upload file
+        UI.message("4. Upload file")
+        fileID = upload_file(fileUploadURL, ipa)
+
+        # step 5: publish app
+        UI.message("5. Publish app")
+        result = publish_app(api_url, fileID, token, transactionID, app_name, author, short_description, long_description, version, version_notes)
+        
+      end
+
+
+      def self.authenticate(api_url, email, password)
+        require 'rest-client'
+        require 'json'
+
+        body = {
+          "id" => 1,
+          "apiVersion" => "1.0",
+          "jsonrpc" => "2.0",
+          "method" => "com.apperian.eas.user.authenticateuser",
+          "params" => {
+            "email" => email,
+            "password" => password
+          }
+        }
+        
+        response = RestClient.post(api_url, body.to_json, {content_type: :json, accept: :json})
+        
+        if debug 
+          UI.message(response.code)
+          UI.message(response.body)        
+        end
+        
+        json = JSON.parse(response.body)
+        token = json["result"]["token"]
+        return token
+      end
+
+      def self.find_app(api_url, app_identifier, token)
+        # get the list of apps 
+        data = list_apps(api_url, token)
+        result = ""
+
+        data['result']['applications'].each do |app|
+          if app['bundleId'] == app_identifier
+            result = app['ID']
+            break
+          end
+        end
+
+        return result
+      end
+
+      def self.list_apps(api_url, token)
+        require 'rest-client'
+        require 'json'
+
+        body = {
+          "id" => 1,
+          "apiVersion" => "1.0",
+          "jsonrpc" => "2.0",
+          "method" => "com.apperian.eas.apps.getlist",
+          "params" => {
+            "token" => token
+          }
+        }
+        
+        response = RestClient.post(api_url, body.to_json, {content_type: :json, accept: :json})
+
+        if debug
+          UI.message(response.code)
+          UI.message(response.body)
+        end
+
+        json = JSON.parse(response.body)
+        return json
+      end
+
+      def self.create_app(api_url, token)
+        require 'rest-client'
+        require 'json'
+
+        body = {
+          "id" => 1,
+          "apiVersion" => "1.0",
+          "jsonrpc" => "2.0",
+          "method" => "com.apperian.eas.apps.create",
+          "params" => {
+            "token" => token
+          }
+        }
+        
+        response = RestClient.post(api_url, body.to_json, {content_type: :json, accept: :json})
+
+        if debug
+          UI.message(response.code)
+          UI.message(response.body)
+        end
+
+        json = JSON.parse(response.body)
+        transactionID = json["result"]["transactionID"]
+        fileUploadURL = json["result"]["fileUploadURL"]
+        return transactionID, fileUploadURL
+      end
+
+      def self.update_app(api_url, appID, token)
+        require 'rest-client'
+        require 'json'
+
+        body = {
+          "id" => 1,
+          "apiVersion" => "1.0",
+          "jsonrpc" => "2.0",
+          "method" => "com.apperian.eas.apps.update",
+          "params" => {
+            "appID" => appID,
+            "token" => token
+          }
+        }
+        
+        response = RestClient.post(api_url, body.to_json, {content_type: :json, accept: :json})
+
+        if debug
+          UI.message(response.code)
+          UI.message(response.body)
+        end
+
+        json = JSON.parse(response.body)
+        transactionID = json["result"]["transactionID"]
+        fileUploadURL = json["result"]["fileUploadURL"]
+        return transactionID, fileUploadURL
+      end
+
+      def self.publish_app(api_url, fileID, token, transactionID, app_name, author, short_description, long_description, version, version_notes)
+        require 'rest-client'
+        require 'json'
+
+        body = {
+          "id" => 1,
+          "apiVersion" => "1.0",
+          "jsonrpc" => "2.0",
+          "method" => "com.apperian.eas.apps.publish",
+          "params" => {
+            "EASEmetadata" => {
+              "author" => author,
+              "name" => app_name,
+              "shortdescription" => short_description,
+              "longdescription" => long_description,
+              "version" => version,
+              "versionNotes" => version_notes
+            },
+            "files" => {
+              "application" => fileID
+            },
+            "token" => token,
+            "transactionID" => transactionID
+          }
+        }
+        
+        response = RestClient.post(api_url, body.to_json, {content_type: :json, accept: :json})
+
+        if debug
+          UI.message(response.code)
+          UI.message(response.body)
+        end
+
+        json = JSON.parse(response.body)
+        status = json["result"]["status"]
+        appID = json["result"]["appID"]
+        return status, appID
+      end
+
+      def self.upload_file(upload_url, file_path)
+        require 'rest-client'
+        require 'json'
+
+        response = RestClient.post upload_url, :LUuploadFile => File.new(file_path, 'rb')
+
+        if debug
+          UI.message(response.code)
+          UI.message(response.body)
+        end
+
+        json = JSON.parse(response.body)
+        fileID = json["fileID"]
+        return fileID
+
+      end
+
+      def self.description
+        "Allows to upload your app file to Apperian"
+      end
+
+      def self.authors
+        ["Thomas Blank"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Detailled description will follow soon"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_url,
+                                  env_name: "APPERIAN_API_URL",
+                               description: "The API URL to the Apperian API host",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No Apperian API URl given, check https://help.apperian.com/display/pub/Using+the+Publishing+API for options and pass using `api_url: 'https://easesvc.apperian.com/ease.interface.php'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :email,
+                                  env_name: "APPERIAN_EMAIL",
+                               description: "Your email address to authenticate yourself with the Apperian API host",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No email for Apperian authentication given, pass using `email: 'me@example.com'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :password,
+                                  env_name: "APPERIAN_PASSWORD",
+                               description: "Your password to authenticate yourself with the Apperian API host",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No password for Apperian authentication given, pass using `password: 'secret'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                  env_name: "APPERIAN_APP_IDENTIFIER",
+                               description: "The identifier of your app",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No app identifier given, pass using `app_identifier: 'com.example.app'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                  env_name: "APPERIAN_IPA",
+                               description: "The path to your IPA file",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Could not find IPA file, pass using `ipa: '/path/to/file.ipa'`") unless File.exist?(value)
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :app_name,
+                                  env_name: "APPERIAN_APP_NAME",
+                               description: "The name of your app",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No app name given, pass using `app_name: 'My sample app'`") unless value and !value.empty?
+                                              UI.user_error!("app_name: maximum characters allowed: 30") unless value.length <= 30
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :author,
+                                  env_name: "APPERIAN_AUTHOR",
+                               description: "Author of the app",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No author given, pass using `author: 'Bob'`") unless value and !value.empty?
+                                              UI.user_error!("author: maximum characters allowed: 150") unless value.length <= 150
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :short_description,
+                                  env_name: "APPERIAN_SHORT_DESCRIPTION",
+                               description: "Short description",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No short description given, pass using `short_description: 'This is what my app does'`") unless value and !value.empty?
+                                              UI.user_error!("short_description: maximum characters allowed: 100") unless value.length <= 100
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :long_description,
+                                  env_name: "APPERIAN_LONG_DESCRIPTION",
+                               description: "Long description",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No long description given, pass using `long_description: 'Detailled description of my app'`") unless value and !value.empty?
+                                              UI.user_error!("long_description: maximum characters allowed: 10'000'") unless value.length <= 10000  
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :version,
+                                  env_name: "APPERIAN_VERSION",
+                               description: "Version number",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No version given, pass using `version: '1.0.2'`") unless value and !value.empty?
+                                              UI.user_error!("version: maximum characters allowed: 21") unless value.length <= 21
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :version_notes,
+                                  env_name: "APPERIAN_VERSION_NOTES",
+                               description: "Version notes",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No version notes given, pass using `version_notes: 'New version available'`") unless value and !value.empty?
+                                              UI.user_error!("version_notes: maximum characters allowed: 1500") unless value.length <= 1500
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :debug,
+                                  env_name: "APPERIAN_DEBUG",
+                               description: "Debug flag, set to true to show extended output. default: false",
+                                  optional: true,
+                                 is_string: false,
+                             default_value: false)
+
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
+
+        [:ios].include?(platform)
+      end
+
+      # helpers
+      
+      def self.debug
+        $is_debug
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/apperian/helper/apperian_helper.rb

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

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

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-apperian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomi Blank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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.106.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.106.2
+description: 
+email: tomiblank@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/apperian.rb
+- lib/fastlane/plugin/apperian/actions/apperian_action.rb
+- lib/fastlane/plugin/apperian/helper/apperian_helper.rb
+- lib/fastlane/plugin/apperian/version.rb
+homepage: https://github.com/tomiblank/fastlane-plugin-apperian
+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.1
+signing_key: 
+specification_version: 4
+summary: Allows to upload your IPA file to Apperian
+test_files: []