Class: Fastlane::Actions::OnesignalAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/onesignal.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, lane_context, method_missing, other_action, return_value, sample_return_value, sh, step_text

Class Method Details

.authors ⇒ Object 



118
119
120
 
# File 'lib/fastlane/actions/onesignal.rb', line 118

def self.authors
  ["timothybarraclough", "smartshowltd"]
end

.available_options ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/fastlane/actions/onesignal.rb', line 66

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :auth_token,
                                env_name: "ONE_SIGNAL_AUTH_KEY",
                                description: "OneSignal Authorization Key",
                                verify_block: proc do |value|
                                  unless value.to_s.length > 0
                                    UI.error("Please add 'ENV[\"ONE_SIGNAL_AUTH_KEY\"] = \"your token\"' to your Fastfile's `before_all` section.")
                                    UI.user_error!("No ONE_SIGNAL_AUTH_KEY given.")
                                  end
                                end),

    FastlaneCore::ConfigItem.new(key: :app_name,
                                 env_name: "ONE_SIGNAL_APP_NAME",
                                 description: "OneSignal App Name",
                                 verify_block: proc do |value|
                                   unless value.to_s.length > 0
                                     UI.error("Please add 'ENV[\"ONE_SIGNAL_APP_NAME\"] = \"Your app name\"' to your Fastfile's `before_all` section.")
                                     UI.user_error!("No ONE_SIGNAL_APP_NAME given.")
                                   end
                                 end),

    FastlaneCore::ConfigItem.new(key: :android_token,
                                 env_name: "ANDROID_TOKEN",
                                 description: "ANDROID GCM KEY",
                                 optional: true),

    FastlaneCore::ConfigItem.new(key: :apns_p12,
                                 env_name: "APNS_P12",
                                 description: "APNS P12 File (in .p12 format)",
                                 optional: true),

    FastlaneCore::ConfigItem.new(key: :apns_p12_password,
                                 env_name: "APNS_P12_PASSWORD",
                                 description: "APNS P12 password",
                                 optional: true),

    FastlaneCore::ConfigItem.new(key: :apns_env,
                                 env_name: "APNS_ENV",
                                 description: "APNS environment",
                                 optional: true,
                                 default_value: 'production')
  ]
end

.category ⇒ Object 



139
140
141
 
# File 'lib/fastlane/actions/onesignal.rb', line 139

def self.category
  :push
end

.check_response_code(response) ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/fastlane/actions/onesignal.rb', line 49

def self.check_response_code(response)
  case response.code.to_i
  when 200, 204
    puts "Succesfully created new OneSignal app".green
  else
    UI.user_error!("Unexpected #{response.code} with response: #{response.body}")
  end
end

.description ⇒ Object 



58
59
60
 
# File 'lib/fastlane/actions/onesignal.rb', line 58

def self.description
  "Create a new OneSignal application"
end

.details ⇒ Object 



62
63
64
 
# File 'lib/fastlane/actions/onesignal.rb', line 62

def self.details
  "You can use this action to automatically create a OneSignal application. You can also upload a .p12 with password, a GCM key, or both"
end

.example_code ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fastlane/actions/onesignal.rb', line 126

def self.example_code
  [
    'onesignal(
      auth_token: "Your OneSignal Auth Token",
      app_name: "Name for OneSignal App",
      android_token: "Your Android GCM key (optional)",
      apns_p12: "Path to Apple .p12 file (optional)",
      apns_p12_password: "Password for .p12 file (optional)",
      apns_env: "production/sandbox (defaults to production)"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/fastlane/actions/onesignal.rb', line 122

def self.is_supported?(platform)
  platform == :ios
end

.output ⇒ Object 



111
112
113
114
115
116
 
# File 'lib/fastlane/actions/onesignal.rb', line 111

def self.output
  [
    ['ONE_SIGNAL_APP_ID', 'The OneSignal app ID of the newly created app'],
    ['ONE_SIGNAL_APP_AUTH_KEY', 'The auth token for the newly created OneSignal app']
  ]
end

.run(params) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/fastlane/actions/onesignal.rb', line 9

def self.run(params)
  require 'net/http'
  require 'uri'
  require 'base64'

  UI.message("Parameter App name: #{params[:app_name]}")
  auth_token = params[:auth_token]
  app_name = params[:app_name]
  apns_p12_password = params[:apns_p12_password]
  android_token = params[:android_token]

  payload = {}
  payload['name'] = app_name

  unless params[:apns_p12].nil?
    data = File.read(params[:apns_p12])
    apns_p12 = Base64.encode64(data)
    payload["apns_env"] = params[:apns_env]
    payload["apns_p12"] = apns_p12
    # we need to have something for the p12 password, even if it's an empty string
    payload["apns_p12_password"] = apns_p12_password || ""
  end

  payload["gcm_key"] = android_token unless android_token.nil?

  # here's the actual lifting - POST to OneSignal

  json_headers = { 'Content-Type' => 'application/json', 'Authorization' => "Basic #{auth_token}" }
  uri = URI.parse('https://onesignal.com/api/v1/apps')
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  response = http.post(uri.path, payload.to_json, json_headers)
  response_body = JSON.parse(response.body)

  Actions.lane_context[SharedValues::ONE_SIGNAL_APP_ID] = response_body["id"]
  Actions.lane_context[SharedValues::ONE_SIGNAL_APP_AUTH_KEY] = response_body["basic_auth_key"]

  check_response_code(response)
end