firim 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d39d1821d49a34f9d7af9a64f19133cc57283e19
-  data.tar.gz: d7d4320c0338a98b906f1862db9e846aec8ae6fd
+  metadata.gz: 3d0731d7d2b35bf81f320244a6a7c62a947f6a67
+  data.tar.gz: 5dbebf6ca5a24c7db39816a3ae229a1cc8caeede
 SHA512:
-  metadata.gz: 383d4f5385981319ec76c884502ea01a5fe98eaee684ba59743522e87b53017b03600b3dd709ee8ce032102748d6137a4ab84d2be9753125d4f0e3c405caad8e
-  data.tar.gz: f8debf65fddc3f2aec18dc090f1f29f8e68d3d360109e5fbed518017172845364b618d250817101557f9e5b259a3c1521ed37fe6a5470b5727406b2fa7101868
+  metadata.gz: 851d13bbbdcf11e988d82eb972d130fe9c13874abdd2ffe058ade87ab5967673d307c4aa709d165f0848c1a4c294d661a0b58a980b4df4363a7f708da1506a56
+  data.tar.gz: 3a3c9dbbf0e6f9c438aafe4ad5de0283e69f42e350de429fcade6a795d0130b8e0f8ae517df49b429d979ace458661d1127d5da3ed7fc3fb00574d3466fed3f7

data/README.md

@@ -36,6 +36,17 @@ You can specify the app infomations in `Firimfile`, To get a list of available o
 Upload with icon ***NOTICE: Icon must be jpg format***
 
     firim -i [your_ipa_path] -l [your_icon_path]
+    
+# Assgin API Token
+
+There are three ways to assgin Firim API Token
+
+1. Set `FIRIM_TOKEN` environment variables
+2. Add `token` to `macOS Keychain`
+3. Set in `Firimfile`
+
+`Firim` will check the value from 1 to 3. Run `Firim` will add `token` to `keychain` in interactive shell. Also can use `firim addtoken` and `firim removetoken` to add or remove `token`.
+
 
 # Need help?
 

data/lib/firim/account_manager.rb

@@ -0,0 +1,98 @@
+require 'security'
+require 'highline/import' # to hide the entered password
+
+module Firim
+  class AccountManager
+    DEFAULT_PREFIX = "firim"
+    DEFAULT_USERNAME = "default"
+    # @param prefix [String] Very optional, is used for the 
+    # prefix on keychain
+    # @param note [String] An optional note that will be shown next
+    #   to the token and token prompt
+    def initialize(user: nil, token: nil, prefix: nil, note: nil)
+      @prefix = prefix || DEFAULT_PREFIX
+
+      @user = user
+      @token = token
+      @note = note
+    end
+
+    # Is the prefix default prefix "firim"
+    def default_prefix?
+      @prefix == DEFAULT_PREFIX
+    end
+
+    def fetch_token_from_env
+      ENV["FIRIM_TOKEN"]
+    end
+
+    def token(ask_if_missing: true)
+      @token ||= fetch_token_from_env
+
+      unless @token
+        item = Security::InternetPassword.find(server: server_name)
+        @token ||= item.password if item
+      end
+      ask_for_token while ask_if_missing && @token.to_s.length == 0
+      return @token
+    end
+
+    def add_to_keychain
+      Security::InternetPassword.add(server_name, @user, token)
+    end
+
+    def remove_from_keychain
+      Security::InternetPassword.delete(server: server_name)
+      @token = nil
+    end
+
+    def server_name
+      "#{@prefix}.#{user_or_defualt}"
+    end
+
+    def user_or_defualt
+      if @user.to_s.length == 0
+        return DEFAULT_USERNAME
+      end
+      @user
+    end
+
+    def ask_for_token
+      puts "-------------------------------------------------------------------------------------".green
+      puts "Please provide your Firim Token".green
+      puts "The Token you enter will be stored in your macOS Keychain".green
+      if default_prefix?
+        # We don't want to show this message, if we ask for the application specific token
+        # which has a different prefix
+        puts "You can also pass the token using the `FIRIM_TOKEN` environment variable".green
+      end
+      puts "Or fill in Firimfile `firim_api_token`".green
+      puts "-------------------------------------------------------------------------------------".green
+
+      if @user.to_s.length == 0
+        raise "running in non-interactive shell" if $stdout.isatty == false
+        prompt_text = "Username(not necessary)"
+        prompt_text += " (#{@note})" if @note
+        prompt_text += ": "
+        @user = ask(prompt_text)
+      end
+
+      while @token.to_s.length == 0
+        raise "Missing Token for #{user_or_defualt}, and running in non-interactive shell" if $stdout.isatty == false
+        note = @note + " " if @note
+        @token = ask("Token (#{note}for #{user_or_defualt}): ") { |q| q.echo = "*" }
+      end
+
+      return true if (/darwin/ =~ RUBY_PLATFORM).nil? # mac?, since we don't have access to the helper here
+
+      # Now we store this information in the keychain
+      if add_to_keychain
+        return true
+      else
+        puts "Could not store token in keychain".red
+        return false
+      end
+
+    end
+  end
+end

data/lib/firim/commands_generator.rb

@@ -19,7 +19,7 @@ module Firim
       program :version, Firim::VERSION
       program :description, 'fir.im command tool'
       program :help, 'Author', 'Hailong Wang <whlsxl+g@gmail.com>'
-      program :help, 'GitHub', 'https://github.com/fastlane/fastlane/tree/master/deliver'
+      program :help, 'GitHub', 'https://github.com/whlsxl/firim'
       program :help_formatter, :compact
 
       FastlaneCore::CommanderGenerator.new.generate(Firim::Options.available_options)
@@ -60,9 +60,58 @@ module Firim
         end
       end
 
+      command :addtoken do |c|
+        c.syntax = 'firim addtoken'
+        c.description = 'Add a firim api token to keychain. username is not necessary, Just a sign for multiple api token.'
+
+        c.option '--username username', String, 'Username to add(not necessary).'
+        c.option '--token token', String, 'API token to add'
+
+        c.action do |args, options|
+          username = options.username || ask('Username(not necessary): ')
+          token = options.token || ask('Password: ') { |q| q.echo = '*'}
+
+          add(username, token)
+
+          puts "Token #{username || '`default`'}: #{'*' * token.length} added to keychain."
+        end
+      end
+
+      # Command to remove credential from Keychain
+      command :removetoken do |c|
+        c.syntax = 'firim removetoken'
+        c.description = 'Removes a firim token from the keychain.'
+
+        c.option '--username username', String, 'Username to remove(or default).'
+
+        c.action do |args, options|
+          username = options.username || ask('Username: ')
+
+          remove(username)
+        end
+      end
+
       default_command :run
 
       run!
     end
+
+
+    private
+
+    # Add entry to Apple Keychain
+    def add(username, token)
+      Firim::AccountManager.new(
+        user: username,
+        token: token
+      ).add_to_keychain
+    end
+    
+    # Remove entry from Apple Keychain using AccountManager
+    def remove(username)
+      Firim::AccountManager.new(
+        user: username
+      ).remove_from_keychain
+    end
   end
 end

data/lib/firim/detect_values.rb

@@ -34,7 +34,14 @@ module Firim
     end
 
     def find_firim_api_token(options)
-      return if options[:firim_api_token]
+      option_token = options[:firim_api_token]
+      keychain_token = Firim::AccountManager.new(user: options[:firim_username])
+      token = keychain_token.token(ask_if_missing: option_token == nil)
+      if token
+        options[:firim_api_token] = token
+        return 
+      end
+
       options[:firim_api_token] ||= UI.input("The API Token of fir.im: ")
     end
   end

data/lib/firim/options.rb

@@ -8,7 +8,11 @@ module Firim
         # firim info
         FastlaneCore::ConfigItem.new(key: :firim_api_token,
                                      short_option: "-a",
+                                     optional: true,
                                      description: "fir.im user api token"),
+        FastlaneCore::ConfigItem.new(key: :firim_username,
+                                     optional: true,
+                                     description: "fir.im username, a sign for identify different token"),
 
         # Content path
         FastlaneCore::ConfigItem.new(key: :ipa,

data/lib/firim/runner.rb

@@ -51,7 +51,7 @@ module Firim
     end
 
     def validation_response response_data
-      error_code = response_data['errors']['code'].to_int rescue 0
+      error_code = response_data['code'].to_i rescue 0
       if error_code == 100020
         UI.user_error!("Firim API Token(#{options[:firim_api_token]}) not correct")
       end

data/lib/firim/version.rb

@@ -1,3 +1,3 @@
 module Firim
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/firim.rb

@@ -4,6 +4,7 @@ require 'firim/options'
 require 'firim/runner'
 require 'firim/setup'
 require "firim/version"
+require "firim/account_manager"
 
 require 'fastlane_core'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firim
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - whlsxl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane
@@ -114,6 +114,7 @@ files:
 - bin/firim
 - lib/assets/FirimfileDefault
 - lib/firim.rb
+- lib/firim/account_manager.rb
 - lib/firim/commands_generator.rb
 - lib/firim/detect_values.rb
 - lib/firim/options.rb