Class: Fastlane::Actions::DownloadHockyBuildAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb

Class Method Summary collapse

Class Method Details

.authorsObject



125
126
127
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 125

def self.authors
  ["Anton Morozov"]
end

.available_optionsObject



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 133

def self.available_options
  [
    # FastlaneCore::ConfigItem.new(key: :your_option,
    #                         env_name: "DOWNLOAD_HOCKY_BUILD_YOUR_OPTION",
    #                      description: "A description of your option",
    #                         optional: false,
    #                             type: String)

      FastlaneCore::ConfigItem.new(key: :api_token,
                                   env_name: "DOWNLOAD_HOCKY_BUILD_API_TOKEN",
                                   description: "API Token for Hockey Access",
                                   optional: false,
                                   type: String,
                                   verify_block: proc do |value|
                                   UI.user_error!("No API token for Hockey given, pass using `api_token: 'token'`") if value.to_s.length == 0
                                   end),

      FastlaneCore::ConfigItem.new(key: :app_id,
                                   env_name: "DOWNLOAD_HOCKY_BUILD_APP_ID",
                                   description: "Application identifier of the app you want to download",
                                   optional: false,
                                   type: String,
                                   verify_block: proc do |value|
                                   UI.user_error!("No app_id is given, pass using `app_id: 'id'`") if value.to_s.length == 0
                                   end),

      FastlaneCore::ConfigItem.new(key: :output_directory,
                                   env_name: "DOWNLOAD_HOCKY_BUILD_DIRECTORY",
                                   description: "Path to download folder",
                                   optional: false,
                                   type: String,
                                   default_value: File.expand_path('.')),

      FastlaneCore::ConfigItem.new(key: :output_file,
                                   env_name: "DOWNLOAD_HOCKY_BUILD_PATH",
                                   description: "Path to your symbols file",
                                   optional: false,
                                   type: String,
                                   default_value: File.expand_path('.')),

      FastlaneCore::ConfigItem.new(key: :output_info_file,
                                   env_name: "DOWNLOAD_HOCKY_BUILD_INFO_PATH",
                                   description: "Path to your symbols info file",
                                   optional: false,
                                   type: String,
                                   default_value: File.expand_path('.'))
                  ]
end

.connection(api_token) ⇒ Object



28
29
30
31
32
33
34
35
36
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 28

def self.connection(api_token)
    host_url = 'https://rink.hockeyapp.net'
    Faraday.new(:url => host_url) do |faraday|
        faraday.request  :multipart
        faraday.request  :url_encoded
        faraday.adapter  Faraday.default_adapter
        faraday.headers['X-HockeyAppToken'] = api_token
    end
end

.descriptionObject



121
122
123
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 121

def self.description
  "Download newest build from HockeyApp (iOS & Android)"
end

.download_build(build_url, output_directory, output_file) ⇒ Object



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 101

def self.download_build(build_url, output_directory, output_file)

    if build_url.nil?
        UI.user_error!("URL to download the build is empty!")
        false
    end

    UI.success "Start to download the build file, which may take a minute"

    FileUtils.mkdir_p(output_directory) unless File.exist?(output_directory)
    path = File.join(output_directory, output_file)
    File.open(path, "wb") do |saved_file|
        open(build_url, "rb") do |read_file|
            saved_file.write(read_file.read)
        end
    end
    UI.success "Successfully downloaded build 🍺"
end

.get_first_version(api_token, app_id, output_directory, output_file, output_info_file) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 39

def self.get_first_version(api_token, app_id, output_directory, output_file, output_info_file)

    conn = self.connection(api_token)
    response = conn.get do |req|
        req.url("/api/2/apps/#{app_id}/app_versions/")
    end

    if response.status == 200
        UI.message("Got app_versions successfully!")
        versions_json = JSON.parse(response.body)
        
        first_version = versions_json['app_versions'].first
        download_url = first_version['download_url']

        if download_url
            UI.message("Got download_url: #{download_url} successfully!")
        else
            UI.user_error!("Unable to parse build info. Status code is #{response.status}")
            false
        end
        
        self.parse_build_url(download_url, api_token, app_id, output_directory, output_file, output_info_file)
    else
        UI.user_error!("Something went wrong with API request. Failed to get app_versions. Status code is #{response.status}")
        false
    end
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


182
183
184
185
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 182

def self.is_supported?(platform)
   [:ios, :mac, :android].include?(platform)
  true
end

.parse_build_url(url, api_token, app_id, output_directory, output_file, output_info_file) ⇒ Object



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 68

def self.parse_build_url(url, api_token, app_id, output_directory, output_file, output_info_file)

    conn = self.connection(api_token)
    response = conn.get do |req|
        req.url("/api/2/apps/#{app_id}/app_versions?include_build_urls=true&build_url=#{url}")
    end

    if response.status == 200
        versions_json = JSON.parse(response.body)
        if versions_json
            first_version = versions_json['app_versions'].first
            storeBuildInfo(first_version, output_directory, output_info_file)
            build_url = first_version["build_url"]
            self.download_build(build_url, output_directory, output_file)
        else
            UI.user_error!("Unable to get app_versions json")
            false
        end
    else
        UI.user_error!("Something went wrong with API request. Status code is #{response.status}")
    end
end

.return_valueObject



129
130
131
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 129

def self.return_value
  # If your method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object



16
17
18
19
20
21
22
23
24
25
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 16

def self.run(params)
    UI.message("The download_hocky_build plugin is working!")
    api_token = params[:api_token]
    app_id = params[:app_id]
    output_directory = params[:output_directory]
    output_file = params[:output_file]
    output_info_file = params[:output_info_file]

    self.get_first_version(api_token, app_id, output_directory, output_file, output_info_file)
end

.storeBuildInfo(version, output_directory, output_info_file) ⇒ Object



92
93
94
95
96
97
98
# File 'lib/fastlane/plugin/download_hocky_build/actions/download_hocky_build_action.rb', line 92

def self.storeBuildInfo(version, output_directory, output_info_file)
    FileUtils.mkdir_p(output_directory) unless File.exist?(output_directory)
    path = File.join(output_directory, output_info_file)
    File.open(path,"w") do |f|
        f.write(version)
    end
end