fastlane-plugin-latest_appcenter_build_number 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b7def746559ab3c5c1c68a9c2c0f434cd3a2358
-  data.tar.gz: 6f422d0d3a409ff63721271f61933348b6a8724e
+SHA256:
+  metadata.gz: f9b2555a719cd267f2ab535d3aaa65d52b20756b1c629a25c29403c35ceae36e
+  data.tar.gz: 286400c56c2068ff07cf0060b607363773cbd29f23c0ae5650204f8500c45db7
 SHA512:
-  metadata.gz: 9ba6658a09bb7a56487c61e113573a64f3e5df561ff1c11d15dd194336cc44611aa0ffd0756630510eb8a5542fcaf24d1eabd8b50b370e321768b0a4f002e27b
-  data.tar.gz: 4bc277a6053c09384c23b0936d70bc6f7080e7c9fd3f65b95a86f6b22408ecb12acfbaa6dfd3095b44ac6ca99ef81ab85178af59306bddf2cc922c4889b723f6
+  metadata.gz: 2869a4a6cdbad6a559dbb3342f426051695ac504a7dccd8c80a228a4d90a19ca9dfda46ef96689f10a326933f004c58c6dddcf613aa2560ede272a0310adbf1f
+  data.tar.gz: a9006f753b7b648a629466a8238685f5a8ba1bdfac72506371abcf1ddd9067e986fb14e9ac373e729df561b5251db1eace391b8eaa35d1a6b96afaef3d23324d

data/README.md

@@ -1,6 +1,7 @@
 # latest_appcenter_build_number plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-latest_appcenter_build_number)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-latest_appcenter_build_number.svg)](https://badge.fury.io/rb/fastlane-plugin-latest_appcenter_build_number)
 
 ## Getting Started
 
@@ -14,13 +15,44 @@ fastlane add_plugin latest_appcenter_build_number
 
 Use AppCenter API to get the latest version and build number for an App Center app
 
-**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`.
+You can fetch the latest version for a given app with the following command in your Fastfile:
+
+```ruby
+version_number = latest_appcenter_build_number
+```
+this will use the environment variable `APPCENTER_API_TOKEN` to fetch the list of apps for a given owner account, and then prompt you for which one to use. This can also be specified as a parameter, e.g.:
+```ruby
+version_number = latest_appcenter_build_number(api_token: "my-APPCENTER-api-token")
+```
+ The parameters `owner_name` and `app_name`, or environment variables `APPCENTER_OWNER_NAME`, and `APPCENTER_APP_NAME`, can also be set:
+```ruby
+version_number = latest_appcenter_build_number(
+  api_token: "my-APPCENTER-api-token", # note that this will need to be generated from here: https://appcenter.ms/settings/apitokens
+  owner_name: "owner-name",
+  app_name: "My-Awesome-App"
+)
+```
+You can then use `version_number` for whatever purpose you required, including updating the shortVersion or buildNumber of your Xcode project.
+
+## Replacing latest_hockey_build_number
+
+If you're using this as a direct replacement for the old `latest_hockey_build_number` having migrated your apps to AppCenter, you should change instances of this:
+```ruby
+latest_hockey_build_number(api_token: "my-HOCKEY-api-token", bundle_id: "com.example.my-awesome-app")
+```
+to this:
+```ruby
+latest_appcenter_build_number(
+  api_token: "my-APPCENTER-api-token", # note that this will need to be generated from here: https://appcenter.ms/settings/apitokens
+  owner_name: "owner-name",
+  app_name: "My-Awesome-App"
+)
+```
+To find out your `app_name` correctly, head to https://appcenter.ms/apps?os=All. Your `app_name` will most likely be what's listed under the 'Name' column but with hyphens instead of whitespace.
 
-**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)
+To find out your `owner_name` correctly, head to https://appcenter.ms/settings/profile. Your `owner_name` will most likely be what's listed under the 'username' field.
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/latest_appcenter_build_number/actions/latest_appcenter_build_number_action.rb

@@ -1,20 +1,36 @@
 require 'json'
 require 'net/http'
+require 'fastlane_core/ui/ui'
 
 module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
   module Actions
     class LatestAppcenterBuildNumberAction < Action
       def self.run(config)
+        app_name = config[:app_name]
+        owner_name = config[:owner_name]
+        if app_name.nil? || owner_name.nil?
+          owner_and_app_name = get_owner_and_app_name(config[:api_token])
+          app_name = owner_and_app_name[0]
+          owner_name = owner_and_app_name[1]
+        end
+
         host_uri = URI.parse('https://api.appcenter.ms')
         http = Net::HTTP.new(host_uri.host, host_uri.port)
         http.use_ssl = true
-        list_request = Net::HTTP::Get.new("/v0.1/apps/#{config[:owner_name]}/#{config[:app_name]}/releases")
+        list_request = Net::HTTP::Get.new("/v0.1/apps/#{owner_name}/#{app_name}/releases")
         list_request['X-API-Token'] = config[:api_token]
         list_response = http.request(list_request)
-        releases = JSON.parse(list_response.body)
 
+        if list_response.kind_of?(Net::HTTPForbidden)
+          UI.error("API Key not valid for #{owner_name}. This will be because either the API Key or the owner_name are incorrect")
+          return nil
+        end
+
+        releases = JSON.parse(list_response.body)
         if releases.nil?
-          UI.error "No versions found for #{config[:app_name]} owned by #{config[:owner_name]}"
+          UI.error("No versions found for #{app_name} owned by #{owner_name}")
           return nil
         end
 
@@ -22,7 +38,7 @@ module Fastlane
         latest_build = releases.first
 
         if latest_build.nil?
-          UI.error "The app has no versions yet"
+          UI.error("The app has no versions yet")
           return nil
         end
 
@@ -43,25 +59,49 @@ module Fastlane
                                        env_name: "APPCENTER_API_TOKEN",
                                        description: "API Token for AppCenter Access",
                                        verify_block: proc do |value|
-                                         UI.user_error!("No API token for AppCenter given, pass using `api_token: 'token'`") unless value and !value.empty?
+                                         UI.user_error!("No API token for AppCenter given, pass using `api_token: 'token'`") unless value && !value.empty?
                                        end),
           FastlaneCore::ConfigItem.new(key: :owner_name,
                                        env_name: "APPCENTER_OWNER_NAME",
+                                       optional: true,
                                        description: "Name of the owner of the application on AppCenter",
                                        verify_block: proc do |value|
-                                         UI.user_error!("No owner name for AppCenter given, pass using `owner_name: 'owner name'`") unless value and !value.empty?
+                                         UI.user_error!("No owner name for AppCenter given, pass using `owner_name: 'owner name'`") unless value && !value.empty?
                                        end),
           FastlaneCore::ConfigItem.new(key: :app_name,
                                        env_name: "APPCENTER_APP_NAME",
+                                       optional: true,
                                        description: "Name of the application on AppCenter",
                                        verify_block: proc do |value|
-                                         UI.user_error!("No app name for AppCenter given, pass using `app_name: 'app name'`") unless value and !value.empty?
-                                       end),
+                                         UI.user_error!("No app name for AppCenter given, pass using `app_name: 'app name'`") unless value && !value.empty?
+                                       end)
         ]
       end
 
       def self.is_supported?(platform)
-        [:ios, :android].include? platform
+        [:ios, :android].include?(platform)
+      end
+
+      def self.get_owner_and_app_name(api_token)
+        apps = get_apps(api_token)
+        app_names = apps.map { |app| app['name'] }.sort
+        selected_app_name = UI.select("Select your project: ", app_names)
+        selected_app = apps.select { |app| app['name'] == selected_app_name }.first
+
+        name = selected_app['name'].to_s
+        owner = selected_app['owner']['name'].to_s
+        return name, owner
+      end
+
+      def self.get_apps(api_token)
+        host_uri = URI.parse('https://api.appcenter.ms')
+        http = Net::HTTP.new(host_uri.host, host_uri.port)
+        http.use_ssl = true
+        apps_request = Net::HTTP::Get.new("/v0.1/apps")
+        apps_request['X-API-Token'] = api_token
+        apps_response = http.request(apps_request)
+        apps = JSON.parse(apps_response.body)
+        return apps
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module LatestAppcenterBuildNumber
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-latest_appcenter_build_number
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jack Spargo
@@ -167,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Use AppCenter API to get the latest version and build number for an App Center