Class: Fastlane::Actions::PodioItemAction
- Inherits:
-
Fastlane::Action
- Object
- Fastlane::Action
- Fastlane::Actions::PodioItemAction
- Defined in:
- lib/fastlane/actions/podio_item.rb
Constant Summary collapse
- AUTH_URL =
'https://podio.com/oauth/token'
- BASE_URL =
'https://api.podio.com'
Constants inherited from Fastlane::Action
Fastlane::Action::AVAILABLE_CATEGORIES
Documentation collapse
- .authors ⇒ Object
- .available_options ⇒ Object
- .description ⇒ Object
- .details ⇒ Object
- .is_supported?(_platform) ⇒ Boolean
- .output ⇒ Object
Logic collapse
- .authenticate(client_id, client_secret, app_id, app_token) ⇒ Object
- .category ⇒ Object
- .create_item(auth_config, identifying_field, identifying_value, app_id) ⇒ Object
- .example_code ⇒ Object
- .get_embed_id(auth_config, url) ⇒ Object
- .get_existing_item(auth_config, identifying_value, app_id) ⇒ Object
- .get_item(auth_config, identifying_field, identifying_value, app_id) ⇒ Object
- .post_item(options) ⇒ Object
- .update_item(auth_config, item_id, fields) ⇒ Object
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
.authenticate(client_id, client_secret, app_id, app_token) ⇒ Object
128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/fastlane/actions/podio_item.rb', line 128 def self.authenticate(client_id, client_secret, app_id, app_token) auth_response = RestClient.post AUTH_URL, grant_type: 'app', app_id: app_id, app_token: app_token, client_id: client_id, client_secret: client_secret UI.user_error!("Failed to authenticate with Podio API") if auth_response.code != 200 auth_response_dictionary = JSON.parse(auth_response.body) access_token = auth_response_dictionary['access_token'] { Authorization: "OAuth2 #{access_token}", content_type: :json, accept: :json } end |
.authors ⇒ Object
91 92 93 |
# File 'lib/fastlane/actions/podio_item.rb', line 91 def self. ['pprochazka72', 'laugejepsen'] end |
.available_options ⇒ Object
35 36 37 38 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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/fastlane/actions/podio_item.rb', line 35 def self. [ FastlaneCore::ConfigItem.new(key: :client_id, env_name: 'PODIO_ITEM_CLIENT_ID', description: 'Client ID for Podio API (see https://developers.podio.com/api-key)', is_string: true, verify_block: proc do |value| UI.user_error!("No Client ID for Podio given, pass using `client_id: 'id'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :client_secret, env_name: 'PODIO_ITEM_CLIENT_SECRET', description: 'Client secret for Podio API (see https://developers.podio.com/api-key)', is_string: true, verify_block: proc do |value| UI.user_error!("No Client Secret for Podio given, pass using `client_secret: 'secret'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :app_id, env_name: 'PODIO_ITEM_APP_ID', description: 'App ID of the app you intend to authenticate with (see https://developers.podio.com/authentication/app_auth)', is_string: true, verify_block: proc do |value| UI.user_error!("No App ID for Podio given, pass using `app_id: 'id'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :app_token, env_name: 'PODIO_ITEM_APP_TOKEN', description: 'App token of the app you intend to authenticate with (see https://developers.podio.com/authentication/app_auth)', is_string: true, verify_block: proc do |value| UI.user_error!("No App token for Podio given, pass using `app_token: 'token'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :identifying_field, env_name: 'PODIO_ITEM_IDENTIFYING_FIELD', description: 'String specifying the field key used for identification of an item', is_string: true, verify_block: proc do |value| UI.user_error!("No Identifying field given, pass using `identifying_field: 'field name'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :identifying_value, description: 'String uniquely specifying an item within the app', is_string: true, verify_block: proc do |value| UI.user_error!("No Identifying value given, pass using `identifying_value: 'unique value'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :other_fields, description: 'Dictionary of your app fields. Podio supports several field types, see https://developers.podio.com/doc/items', is_string: false, optional: true) ] end |
.category ⇒ Object
209 210 211 |
# File 'lib/fastlane/actions/podio_item.rb', line 209 def self.category :beta end |
.create_item(auth_config, identifying_field, identifying_value, app_id) ⇒ Object
171 172 173 174 175 176 177 178 |
# File 'lib/fastlane/actions/podio_item.rb', line 171 def self.create_item(auth_config, , , app_id) item_request_body = { fields: { => } }.to_json item_response = RestClient.post "#{BASE_URL}/item/app/#{app_id}", item_request_body, auth_config UI.user_error!("Failed to create item \"#{}\"") if item_response.code != 200 item_response_dictionary = JSON.parse(item_response.body) [item_response_dictionary['item_id'], item_response_dictionary['link']] end |
.description ⇒ Object
23 24 25 |
# File 'lib/fastlane/actions/podio_item.rb', line 23 def self.description 'Creates or updates an item within your Podio app' end |
.details ⇒ Object
27 28 29 30 31 32 33 |
# File 'lib/fastlane/actions/podio_item.rb', line 27 def self.details "Use this action to create or update an item within your Podio app (see https://help.podio.com/hc/en-us/articles/201019278-Creating-apps-). Pass in dictionary with field keys and their values. Field key is located under Modify app -> Advanced -> Developer -> External ID (see https://developers.podio.com/examples/items)" end |
.example_code ⇒ Object
197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/fastlane/actions/podio_item.rb', line 197 def self.example_code [ 'podio_item( identifying_value: "Your unique value", other_fields: { "field1" => "fieldValue", "field2" => "fieldValue2" } )' ] end |
.get_embed_id(auth_config, url) ⇒ Object
188 189 190 191 192 193 194 195 |
# File 'lib/fastlane/actions/podio_item.rb', line 188 def self.(auth_config, url) = { url: url }.to_json = RestClient.post "#{BASE_URL}/embed/", , auth_config UI.user_error!("Failed to create embed for link #{link}") if .code != 200 = JSON.parse(.body) ['embed_id'] end |
.get_existing_item(auth_config, identifying_value, app_id) ⇒ Object
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/fastlane/actions/podio_item.rb', line 152 def self.get_existing_item(auth_config, , app_id) filter_request_body = { query: , limit: 1, ref_type: 'item' }.to_json filter_response = RestClient.post "#{BASE_URL}/search/app/#{app_id}/", filter_request_body, auth_config UI.user_error!("Failed to search for already existing item #{}") if filter_response.code != 200 existing_items = JSON.parse(filter_response.body) existing_item_id = nil existing_item_url = nil if existing_items.length > 0 existing_item = existing_items[0] if existing_item['title'] == existing_item_id = existing_item['id'] existing_item_url = existing_item['link'] end end [existing_item_id, existing_item_url] end |
.get_item(auth_config, identifying_field, identifying_value, app_id) ⇒ Object
142 143 144 145 146 147 148 149 150 |
# File 'lib/fastlane/actions/podio_item.rb', line 142 def self.get_item(auth_config, , , app_id) item_id, item_url = get_existing_item(auth_config, , app_id) unless item_id item_id, item_url = create_item(auth_config, , , app_id) end [item_id, item_url] end |
.is_supported?(_platform) ⇒ Boolean
95 96 97 |
# File 'lib/fastlane/actions/podio_item.rb', line 95 def self.is_supported?(_platform) true end |
.output ⇒ Object
85 86 87 88 89 |
# File 'lib/fastlane/actions/podio_item.rb', line 85 def self.output [ ['PODIO_ITEM_URL', 'URL to newly created (or updated) Podio item'] ] end |
.post_item(options) ⇒ Object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/fastlane/actions/podio_item.rb', line 103 def self.post_item() auth_config = authenticate([:client_id], [:client_secret], [:app_id], [:app_token]) item_id, item_url = get_item(auth_config, [:identifying_field], [:identifying_value], [:app_id]) unless [:other_fields].nil? [:other_fields].each do |key, value| uri = URI.parse(value) if uri.kind_of?(URI::HTTP) = (auth_config, uri) [:other_fields].merge!(key => ) end end update_item(auth_config, item_id, [:other_fields]) end Actions.lane_context[SharedValues::PODIO_ITEM_URL] = item_url end |
.run(params) ⇒ Object
11 12 13 14 15 16 17 |
# File 'lib/fastlane/actions/podio_item.rb', line 11 def self.run(params) require 'rest_client' require 'json' require 'uri' post_item(params) end |
.update_item(auth_config, item_id, fields) ⇒ Object
180 181 182 183 184 185 186 |
# File 'lib/fastlane/actions/podio_item.rb', line 180 def self.update_item(auth_config, item_id, fields) if fields.length > 0 item_request_body = { fields: fields }.to_json item_response = RestClient.put "#{BASE_URL}/item/#{item_id}", item_request_body, auth_config UI.user_error!("Failed to update item values \"#{fields}\"") unless item_response.code != 200 || item_response.code != 204 end end |