supply 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf1ce6eea2f83d47a47cc8b7e4f8a93ad41f81ba
-  data.tar.gz: 0a8474cc4ac5867ce6175c63d2bbe174239e5d47
+  metadata.gz: 9697a1089d5497d72524a149bed1fef5891cea92
+  data.tar.gz: 21e4ebade53c3955817f1bc7c96181d3a68aa7c9
 SHA512:
-  metadata.gz: bf60276da8a2e62f38bc30c035d340b48d612d6a661f5d4fa8c4403d37cf88d439e86c394947ffd01e1c4a0540f4abaae5383b515fe421bc3b6e4d6eca3fb246
-  data.tar.gz: 02da6a2b8811fa77cab2a735c16ecc82ce4f4c70d4500ead0dfb8af971a35dfca12554c5b34dd60c8392601108af2cc77d067a70ab2c970d2d7938091a0dbd16
+  metadata.gz: 885050ae365c1dba5af3570cbeb641cf4836a8faa2404453be88b6c5cbdb5058a4181b9a5262c689ce1d6b8fd28c22f7618bba833b84fa8f371372813dfbd2b2
+  data.tar.gz: 558ce0fbcf00b10e29fbfa210ac8ce0e61b563931f234109b03deb913a2f5aa23f18dc941a5b668898d22799f255f4bd2a9d85e4aa04bc7de2af9865ce613e05

data/README.md

@@ -69,20 +69,34 @@ Install the gem
 
     sudo gem install supply
 
-## Setup a Google Developers Service Account
+## Setup
+
+Setup consists of setting up your Google Developers Service Account
 
 - Open the [Google Play Console](https://play.google.com/apps/publish/)
 - Select **Settings** tab, followed by the **API access** tab
 - Click the **Create Service Account** button and follow the **Google Developers Console** link in the dialog
 - Click **Add credentials** and select **Service account**
-- Select **P12** as the Key type and click **Create**
-- Make a note of the file name of the P12 file downloaded to your computer, and close the dialog
-- Make a note of the **Email address** under **Service accounts** - this is the issuer which you will need later
+- Select **JSON** as the Key type and click **Create**
+- Make a note of the file name of the JSON file downloaded to your computer, and close the dialog
+- Make a note of the **Email address** under **Service accounts** - this is the user which you will need later
 - Back on the Google Play developer console, click **Done** to close the dialog
 - Click on **Grant Access** for the newly added service account
 - In the **Invite a New User** dialog, paste the service account email address you noted earlier into the **Email address** field
 - Choose **Release Manager** from the **Role** dropdown and click **Send Invitation** to close the dialog
 
+### Migrating Google credential format (from .p12 key file to .json)
+
+In previous versions of supply, credentials to your Play Console were stored as `.p12` files. Since version 0.4.0, supply now supports the recommended `.json` key Service Account credential files. If you wish to upgrade:
+
+- follow the <a href="#setup">Setup</a> procedure once again to make sure you create the appropriate JSON file
+- update your fastlane configuration or your command line invocation to use the appropriate argument if necessary.
+  Note that you don't need to take note nor pass the `issuer` argument anymore.
+
+
+The previous p12 configuration is still currently supported.
+
+
 ## Quick Start
 
 - `cd [your_project_folder]`

data/lib/supply/client.rb

@@ -1,11 +1,13 @@
-require 'google/api_client'
+require 'googleauth'
+require 'google/apis/androidpublisher_v2'
+Androidpublisher = Google::Apis::AndroidpublisherV2
+CredentialsLoader = Google::Auth::CredentialsLoader
+
 require 'net/http'
 
 module Supply
   class Client
     # Connecting with Google
-    attr_accessor :auth_client
-    attr_accessor :api_client
     attr_accessor :android_publisher
 
     # Editing something
@@ -18,38 +20,43 @@ module Supply
     # @!group Login
     #####################################################
 
-    # Initializes the auth_client and api_client using the specified information
-    # @param path_to_key: The path to your p12 file
-    # @param issuer: Email addresss for oauth
-    # @param passphrase: Passphrase for the p12 file
-    def initialize(path_to_key: nil, issuer: nil, passphrase: nil)
-      passphrase ||= "notasecret"
+    # instanciate a client given the supplied configuration
+    def self.make_from_config
+      return Client.new(path_to_key: Supply.config[:key],
+                        issuer: Supply.config[:issuer],
+                        path_to_service_account_json: Supply.config[:json_key])
+    end
 
-      key = Google::APIClient::KeyUtils.load_from_pkcs12(File.expand_path(path_to_key), passphrase)
+    # Initializes the android_publisher and its auth_client using the specified information
+    # @param path_to_service_account_json: The path to your service account Json file
+    # @param path_to_key: The path to your p12 file (@deprecated)
+    # @param issuer: Email addresss for oauth (@deprecated)
+    def initialize(path_to_key: nil, issuer: nil, path_to_service_account_json: nil)
+      scope = Androidpublisher::AUTH_ANDROIDPUBLISHER
 
-      begin
-        self.auth_client = Signet::OAuth2::Client.new(
-          token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
-          audience: 'https://accounts.google.com/o/oauth2/token',
-          scope: 'https://www.googleapis.com/auth/androidpublisher',
-          issuer: issuer,
-          signing_key: key
-        )
-      rescue => ex
-        Helper.log.fatal ex
-        raise "Authentification unsuccessful, make sure to pass a valid key file".red
+      if path_to_service_account_json
+        key_io = File.open(File.expand_path(path_to_service_account_json))
+      else
+        require 'google/api_client/auth/key_utils'
+        key = Google::APIClient::KeyUtils.load_from_pkcs12(File.expand_path(path_to_key), 'notasecret')
+        cred_json = {
+          private_key: key.to_s,
+          client_email: issuer
+        }
+        key_io = StringIO.new(MultiJson.dump(cred_json))
       end
 
+      auth_client = Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: key_io, scope: scope)
+
       Helper.log.debug "Fetching a new access token from Google..."
 
-      self.auth_client.fetch_access_token!
+      auth_client.fetch_access_token!
 
-      self.api_client = Google::APIClient.new(
-        application_name: "fastlane - supply",
-        application_version: Supply::VERSION
-      )
+      Google::Apis::ClientOptions.default.application_name = "fastlane - supply"
+      Google::Apis::ClientOptions.default.application_version = Supply::VERSION
 
-      self.android_publisher = api_client.discovered_api('androidpublisher', 'v2')
+      self.android_publisher = Androidpublisher::AndroidPublisherService.new
+      self.android_publisher.authorization = auth_client
     end
 
     #####################################################
@@ -60,17 +67,7 @@ module Supply
     def begin_edit(package_name: nil)
       raise "You currently have an active edit" if @current_edit
 
-      self.current_edit = api_client.execute(
-        api_method: android_publisher.edits.insert,
-        parameters: { 'packageName' => package_name },
-        authorization: auth_client
-      )
-
-      if current_edit.error?
-        error_message = current_edit.error_message
-        self.current_edit = nil
-        raise error_message
-      end
+      self.current_edit = android_publisher.insert_edit(package_name)
 
       self.current_package_name = package_name
     end
@@ -79,16 +76,7 @@ module Supply
     def abort_current_edit
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.delete,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name
-        },
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error?
+      android_publisher.delete_edit(current_package_name, current_edit.id)
 
       self.current_edit = nil
       self.current_package_name = nil
@@ -98,16 +86,7 @@ module Supply
     def commit_current_edit!
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.commit,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name
-        },
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error?
+      android_publisher.commit_edit(current_package_name, current_edit.id)
 
       self.current_edit = nil
       self.current_package_name = nil
@@ -122,18 +101,9 @@ module Supply
     def listings
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.listings.list,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name
-        },
-        authorization: auth_client
-      )
+      result = android_publisher.list_listings(current_package_name, current_edit.id)
 
-      raise result.error_message.red if result.error? && result.status != 404
-
-      return result.data.listings.collect do |row|
+      return result.listings.map do |row|
         Listing.new(self, row.language, row)
       end
     end
@@ -142,22 +112,16 @@ module Supply
     def listing_for_language(language)
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.listings.get,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'language' => language
-        },
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error? && result.status != 404
-
-      if result.status == 404
-        return Listing.new(self, language) # create a new empty listing
-      else
-        return Listing.new(self, language, result.data)
+      begin
+        result = android_publisher.get_listing(
+          current_package_name,
+          current_edit.id,
+          language)
+
+        return Listing.new(self, language, result)
+      rescue Google::Apis::ClientError => e
+        return Listing.new(self, language) if e.status_code == 404 # create a new empty listing
+        raise
       end
     end
 
@@ -165,38 +129,22 @@ module Supply
     def apks_version_codes
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.apks.list,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name
-        },
-        authorization: auth_client
-      )
+      result = android_publisher.list_apks(current_package_name, current_edit.id)
 
-      raise result.error_message.red if result.error? && result.status != 404
-
-      return result.data.apks.collect(&:versionCode)
+      return result.apks.map(&:version_code)
     end
 
     # Get a list of all apk listings (changelogs) - returns the list
     def apk_listings(apk_version_code)
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.apklistings.list,
-        parameters: {
-          'apkVersionCode' => apk_version_code,
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name
-        },
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error? && result.status != 404
+      result = android_publisher.list_apk_listings(
+        current_package_name,
+        current_edit.id,
+        apk_version_code)
 
-      return result.data.listings.collect do |row|
-        ApkListing.new(row.recentChanges, row.language, apk_version_code)
+      return (result.listings || []).map do |row|
+        ApkListing.new(row.recent_changes, row.language, apk_version_code)
       end
     end
 
@@ -208,90 +156,62 @@ module Supply
     def update_listing_for_language(language: nil, title: nil, short_description: nil, full_description: nil, video: nil)
       ensure_active_edit!
 
-      listing = {
-        'language' => language,
-        'title' => title,
-        'fullDescription' => full_description,
-        'shortDescription' => short_description,
-        'video' => video
-      }
-
-      result = api_client.execute(
-        api_method: android_publisher.edits.listings.update,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'language' => language
-        },
-        body_object: listing,
-        authorization: auth_client
-      )
-      raise result.error_message.red if result.error?
+      listing = Androidpublisher::Listing.new({
+        language: language,
+        title: title,
+        full_description: full_description,
+        short_description: short_description,
+        video: video
+      })
+
+      android_publisher.update_listing(
+        current_package_name,
+        current_edit.id,
+        language,
+        listing)
     end
 
     def upload_apk(path_to_apk)
       ensure_active_edit!
 
-      apk = Google::APIClient::UploadIO.new(File.expand_path(path_to_apk), 'application/vnd.android.package-archive')
-      result_upload = api_client.execute(
-        api_method: android_publisher.edits.apks.upload,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'uploadType' => 'media'
-        },
-        media: apk,
-        authorization: auth_client
-      )
-
-      raise result_upload.error_message.red if result_upload.error?
-
-      return result_upload.data.versionCode
+      result_upload = android_publisher.upload_apk(
+        current_package_name,
+        current_edit.id,
+        upload_source: path_to_apk)
+
+      return result_upload.version_code
     end
 
     def update_track(track, rollout, apk_version_code)
       ensure_active_edit!
 
-      track_body = {
-        'track' => track,
-        'userFraction' => rollout,
-        'versionCodes' => [apk_version_code]
-      }
-
-      result_update = api_client.execute(
-        api_method: android_publisher.edits.tracks.update,
-        parameters:
-          {
-            'editId' => current_edit.data.id,
-            'packageName' => current_package_name,
-            'track' => track
-          },
-        body_object: track_body,
-        authorization: auth_client)
-
-      raise result_update.error_message.red if result_update.error?
+      track_body = Androidpublisher::Track.new({
+        track: track,
+        user_fraction: rollout,
+        version_codes: [apk_version_code]
+      })
+
+      android_publisher.update_track(
+        current_package_name,
+        current_edit.id,
+        track,
+        track_body)
     end
 
     def update_apk_listing_for_language(apk_listing)
       ensure_active_edit!
 
-      body_object = {
-        'language' => apk_listing.language,
-        'recentChanges' => apk_listing.recent_changes
-      }
-
-      result = api_client.execute(
-        api_method: android_publisher.edits.apklistings.update,
-        parameters: {
-          'apkVersionCode' => apk_listing.apk_version_code,
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'language' => apk_listing.language
-        },
-        body_object: body_object,
-        authorization: auth_client
-      )
-      raise result.error_message.red if result.error?
+      apk_listing_object = Androidpublisher::ApkListing.new({
+        language: apk_listing.language,
+        recent_changes: apk_listing.recent_changes
+      })
+
+      android_publisher.update_apk_listing(
+        current_package_name,
+        current_edit.id,
+        apk_listing.apk_version_code,
+        apk_listing.language,
+        apk_listing_object)
     end
 
     #####################################################
@@ -301,58 +221,36 @@ module Supply
     def fetch_images(image_type: nil, language: nil)
       ensure_active_edit!
 
-      result = api_client.execute(
-        api_method: android_publisher.edits.images.list,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'language' => language,
-          'imageType' => image_type
-        },
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error?
+      result = android_publisher.list_images(
+        current_package_name,
+        current_edit.id,
+        language,
+        image_type)
 
-      result.data.images.collect(&:url)
+      (result.images || []).map(&:url)
     end
 
     # @param image_type (e.g. phoneScreenshots, sevenInchScreenshots, ...)
     def upload_image(image_path: nil, image_type: nil, language: nil)
       ensure_active_edit!
 
-      image = Google::APIClient::UploadIO.new(image_path, 'image/*')
-      result = api_client.execute(
-        api_method: android_publisher.edits.images.upload,
-        parameters: {
-          'editId' => current_edit.data.id,
-          'packageName' => current_package_name,
-          'language' => language,
-          'imageType' => image_type,
-          'uploadType' => 'media'
-        },
-        media: image,
-        authorization: auth_client
-      )
-
-      raise result.error_message.red if result.error?
+      android_publisher.upload_image(
+        current_package_name,
+        current_edit.id,
+        language,
+        image_type,
+        upload_source: image_path,
+        content_type: 'image/*')
     end
 
     def clear_screenshots(image_type: nil, language: nil)
       ensure_active_edit!
 
-      result = @api_client.execute(
-        api_method: @android_publisher.edits.images.deleteall,
-        parameters: {
-            'editId' => current_edit.data.id,
-            'packageName' => current_package_name,
-            'language' => language,
-            'imageType' => image_type
-          },
-        authorization: auth_client
-      )
-
-      raise result.error_message if result.error?
+      android_publisher.delete_all_images(
+        current_package_name,
+        current_edit.id,
+        language,
+        image_type)
     end
 
     private

data/lib/supply/options.rb

@@ -17,7 +17,7 @@ module Supply
                                      default_value: 'production',
                                      verify_block: proc do |value|
                                        available = %w(production beta alpha rollout)
-                                       raise "Invalid value '#{value}', must be #{available.join(', ')}".red unless available.include? value
+                                       UI.user_error! "Invalid value '#{value}', must be #{available.join(', ')}" unless available.include? value
                                      end),
         FastlaneCore::ConfigItem.new(key: :rollout,
                                      short_option: "-r",
@@ -25,7 +25,7 @@ module Supply
                                      default_value: '1.0',
                                      verify_block: proc do |value|
                                        available = %w(0.005 0.01 0.05 0.1 0.2 0.5 1.0)
-                                       raise "Invalid value '#{value}', must be #{available.join(', ')}".red unless available.include? value
+                                       UI.user_error! "Invalid value '#{value}', must be #{available.join(', ')}" unless available.include? value
                                      end),
         FastlaneCore::ConfigItem.new(key: :metadata_path,
                                      env_name: "SUPPLY_METADATA_PATH",
@@ -36,16 +36,34 @@ module Supply
         FastlaneCore::ConfigItem.new(key: :key,
                                      env_name: "SUPPLY_KEY",
                                      short_option: "-k",
+                                     conflicting_options: [:json_key],
+                                     optional: true, # deprecated
                                      description: "The p12 File used to authenticate with Google",
                                      default_value: Dir["*.p12"].first || CredentialsManager::AppfileConfig.try_fetch_value(:keyfile),
                                      verify_block: proc do |value|
-                                       raise "Could not find p12 file at path '#{File.expand_path(value)}'".red unless File.exist?(File.expand_path(value))
+                                       UI.important("DEPRECATED --key OPTION. Use --json_key instead")
+                                       UI.user_error! "Could not find p12 file at path '#{File.expand_path(value)}'" unless File.exist?(File.expand_path(value))
                                      end),
         FastlaneCore::ConfigItem.new(key: :issuer,
-                                     short_option: "-i",
                                      env_name: "SUPPLY_ISSUER",
+                                     short_option: "-i",
+                                     conflicting_options: [:json_key],
+                                     optional: true, # deprecated
                                      description: "The issuer of the p12 file (email address of the service account)",
-                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:issuer)),
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:issuer),
+                                     verify_block: proc do |value|
+                                       UI.important("DEPRECATED --issuer OPTION. Use --json_key instead")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :json_key,
+                                     env_name: "SUPPLY_JSON_KEY",
+                                     short_option: "-j",
+                                     conflicting_options: [:issuer, :key],
+                                     optional: true, # this is shouldn't be optional but is until --key and --issuer are completely removed
+                                     description: "The service account json file used to authenticate with Google",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:json_key_file),
+                                     verify_block: proc do |value|
+                                       UI.user_error! "Could not find service account json file at path '#{File.expand_path(value)}'" unless File.exist?(File.expand_path(value))
+                                     end),
         FastlaneCore::ConfigItem.new(key: :apk,
                                      env_name: "SUPPLY_APK",
                                      description: "Path to the APK file to upload",
@@ -53,8 +71,8 @@ module Supply
                                      default_value: Dir["*.apk"].last || Dir[File.join("app", "build", "outputs", "apk", "app-Release.apk")].last,
                                      optional: true,
                                      verify_block: proc do |value|
-                                       raise "Could not find apk file at path '#{value}'".red unless File.exist?(value)
-                                       raise "apk file is not an apk".red unless value.end_with?(value)
+                                       UI.user_error! "Could not find apk file at path '#{value}'" unless File.exist?(value)
+                                       UI.user_error! "apk file is not an apk" unless value.end_with?(value)
                                      end),
         FastlaneCore::ConfigItem.new(key: :skip_upload_apk,
                                      env_name: "SUPPLY_SKIP_UPLOAD_APK",

data/lib/supply/setup.rb

@@ -96,8 +96,7 @@ module Supply
     end
 
     def client
-      @client ||= Client.new(path_to_key: Supply.config[:key],
-                                  issuer: Supply.config[:issuer])
+      @client ||= Client.make_from_config
     end
   end
 end

data/lib/supply/uploader.rb

@@ -8,7 +8,7 @@ module Supply
       raise "No local metadata found, make sure to run `supply init` to setup supply".red unless metadata_path || Supply.config[:apk]
 
       if metadata_path
-        raise "Could not find folder".red unless File.directory? metadata_path
+        UI.user_error!("Could not find folder #{metadata_path}") unless File.directory? metadata_path
 
         Dir.foreach(metadata_path) do |language|
           next if language.start_with?('.') # e.g. . or .. or hidden folders
@@ -111,8 +111,7 @@ module Supply
     private
 
     def client
-      @client ||= Client.new(path_to_key: Supply.config[:key],
-                                   issuer: Supply.config[:issuer])
+      @client ||= Client.make_from_config
     end
 
     def metadata_path

data/lib/supply/version.rb

@@ -1,4 +1,4 @@
 module Supply
-  VERSION = "0.3.1".freeze
+  VERSION = "0.4.0".freeze
   DESCRIPTION = "Command line tool for updating Android apps and their metadata on the Google Play Store"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supply
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: fastlane_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.35.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: credentials_manager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Command line tool for updating Android apps and their metadata on the Google