cocoapods-keys 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5cc6251eb10bbe87ceee4a1f3643dfe4b7506da
-  data.tar.gz: c243d7584efda5c4c4693c090ba4b50bd7228857
+  metadata.gz: 52a2e9e5a65b7647780f3f3bb143293366a86120
+  data.tar.gz: a2c043948ff253e77f4b4defaaaf17a9fb35f9fe
 SHA512:
-  metadata.gz: 252122f84b76036ad1ad0ec68ae54673f8e76d3c2b02d7305b0a63ffcb4729ade9f8f6736441f8b29635975d82941291b0215f86430ddd47ce6173ffc190a139
-  data.tar.gz: e46843504016015797d39a682b6a23fb53ccbb1b2e330f07bd0481b9b2e86e833e7ac61752d9b0845e451f81acd027a7f3c12c7f1ee40741e5e36cc49cdddefb
+  metadata.gz: 9aa97fd504108cfce1a9442f45ea009dcce868a0371e258c7992f432da6b66507021e8b03e0a4c94eb1bdea5b5cadc46e658b0d6d322b55504d653e5de787416
+  data.tar.gz: 695c2710be5f212f3685f065c316eacbe07ef01dcaceca057935a4014d0bff4d3dc3a400e6e42d6e9c2a5ac8a862a550659c753bd44a4155fa3a8b4dba0b4772

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Master
 
+## 1.5.0
+
+* Minor error handling improvements [orta]
+* Don't create a shared scheme for Keys [orta]
+
 ## 1.4.0
 
 * Adds support for ENV VAR based keys, this makes CI much easier to work with [alloy, orta]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-keys (1.4.0)
+    cocoapods-keys (1.5.0)
       osx_keychain
 
 GEM
@@ -102,4 +102,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/SWIFT_PROJECTS.md

@@ -3,20 +3,9 @@
 Once you've followed the setup instructions described in the [Usage](/orta/cocoapods-keys#usage)
 section of the README, you have two choices.
 
-## Using the bridge header
-
-If you want to make your keys available to your whole project:
-
-1. Make sure you have a [bridging header](https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html) already setup.
-2. In the bridging header, import the generated key file:
-```objectivec
-#import <Keys/MyApplicationKeys.h>
-```
-
 ## Importing the framework
 
-If you've added the `use_frameworks!` and only want your Keys to be available in
-specific files, simply use Swift's `import` statement. The name of the generated
+Use Swift's `import` statement. The name of the generated
 module is `Keys`.
 
 ```swift

data/lib/cocoapods_keys.rb

@@ -1,3 +1,3 @@
 module CocoaPodsKeys
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/key_master.rb

@@ -11,6 +11,9 @@ module CocoaPodsKeys
       @time = time
       @keys = keyring.camel_cased_keys
       @name = keyring.code_name.capitalize + 'Keys'
+      if /^\d/.match(@name)
+        @name = '_' + @name
+      end
 
       @used_indexes = Set.new
       @indexed_keys = {}

data/lib/keyring.rb

@@ -6,7 +6,7 @@ module CocoaPodsKeys
 
     def initialize(name, path, keys = [])
       @name = name.to_s
-      @path = path
+      @path = path.to_s
       @keys = keys
     end
 
@@ -26,18 +26,36 @@ module CocoaPodsKeys
       'cocoapods-keys-'
     end
 
+    def keychain
+      @keychain ||= OSXKeychain.new
+    end
+
     def save(key, value)
-      keychain = OSXKeychain.new
       keychain[self.class.keychain_prefix + name, key] = value
     end
 
     def keychain_data
-      keychain = OSXKeychain.new
       Hash[
-        @keys.map { |key| [key, ENV[key] || keychain[self.class.keychain_prefix + name, key]] }
+        @keys.map { |key| [key, keychain_value(key)] }
       ]
     end
 
+    def keychain_has_key?(key)
+      has_key = !keychain_value(key).nil?
+
+      if has_key && !@keys.include?(key)
+        @keys << key
+      elsif !has_key && @keys.include?(key)
+        @keys.delete(key)
+      end
+
+      has_key
+    end
+
+    def keychain_value(key)
+      ENV[key] || keychain[self.class.keychain_prefix + name, key]
+    end
+
     def camel_cased_keys
       Hash[keychain_data.map { |(key, value)| [key[0].downcase + key[1..-1], value] }]
     end

data/lib/keyring_liberator.rb

@@ -24,9 +24,30 @@ module CocoaPodsKeys
       get_all_keyrings.find { |k| k.name == name }
     end
 
+    def self.get_current_keyring(name, cwd)
+      found_by_name = name && get_all_keyrings.find { |k| k.name == name && k.path == cwd.to_s }
+      found_by_name || KeyringLiberator.get_keyring(cwd)
+    end
+
+    def self.get_all_keyrings_named(name)
+      get_all_keyrings.find_all { |k| k.name == name }
+    end
+
+    def self.prompt_if_already_existing(keyring)
+      keyrings = get_all_keyrings_named(keyring.name)
+      already_exists = File.exist?(yaml_path_for_path(keyring.path))
+      if !already_exists && keyrings.any? { |existing_keyring| File.exist?(yaml_path_for_path(existing_keyring.path)) }
+        ui = Pod::UserInterface
+        ui.puts "About to create a duplicate keyring file for project #{keyring.name.green}"
+        ui.puts 'Entries in your Apple Keychain will be shared between both projects.'
+        ui.puts "\nPress enter to continue, or `ctrl + c` to cancel"
+        ui.gets
+      end
+    end
+
     def self.save_keyring(keyring)
       keys_dir.mkpath
-
+      prompt_if_already_existing(keyring)
       yaml_path_for_path(keyring.path).open('w') { |f| f.write(YAML.dump(keyring.to_hash)) }
     end
 

data/lib/name_whisperer.rb

@@ -21,12 +21,13 @@ module CocoaPodsKeys
 
     def self.search_folders_for_xcodeproj
       ui = Pod::UserInterface
-      xcodeprojects = Pathname.glob('**/*.xcodeproj')
+      xcodeprojects = Pathname.glob('**/*.xcodeproj').reject { |path| path.to_s.start_with?('Pods/') }
       if xcodeprojects.length == 1
         Pathname(xcodeprojects.first).basename('.xcodeproj')
       else
         error_message = (xcodeprojects.length > 1) ? 'found too many' : "couldn't find any"
-        ui.puts 'CocoaPods-Keys ' + error_message + ' Xcode projects. Please give a name for this project.'
+        projects = xcodeprojects.map(&:basename).join(' ')
+        ui.puts 'CocoaPods-Keys ' + error_message + ' Xcode projects (' + projects + '). Please give a name for this project.'
 
         answer = ''
         loop do

data/lib/plugin.rb

@@ -25,8 +25,7 @@ module CocoaPodsKeys
       local_user_options = user_options || {}
       project = local_user_options.fetch('project') { CocoaPodsKeys::NameWhisperer.get_project_name }
 
-      keyring = KeyringLiberator.get_keyring_named(project) ||
-        KeyringLiberator.get_keyring(Dir.getwd) ||
+      keyring = KeyringLiberator.get_current_keyring(project, Dir.getwd) ||
         Keyring.new(project, Dir.getwd, local_user_options['keys'])
 
       raise Pod::Informative, 'Could not load keyring' unless keyring
@@ -41,6 +40,13 @@ module CocoaPodsKeys
 
       # Add our template podspec
       add_keys_to_pods(keys_path.relative_path_from(installation_root), user_options)
+
+      # Remove the shared scheme for this pod
+      Pod::HooksManager.register('cocoapods-keys', :post_install) do |context, user_options|
+        shared_scheme_path = "Pods/Pods.xcodeproj/xcshareddata/xcschemes/Keys.xcscheme"
+        FileUtils.rm(shared_scheme_path) if File.exist?(shared_scheme_path)
+      end
+
     end
 
     def add_keys_to_pods(keys_path, options)

data/lib/pod/command/keys.rb

@@ -16,6 +16,18 @@ module Pod
 
       self.abstract_command = true
       self.default_subcommand = 'list'
+
+      def create_keyring
+        current_dir = Pathname.pwd
+        name = @project_name || CocoaPodsKeys::NameWhisperer.get_project_name
+        CocoaPodsKeys::Keyring.new(name, current_dir, [])
+      end
+
+      def get_current_keyring
+        current_dir = Pathname.pwd
+        project = @project_name || CocoaPodsKeys::NameWhisperer.get_project_name
+        CocoaPodsKeys::KeyringLiberator.get_current_keyring(project, current_dir)
+      end
     end
   end
 end

data/lib/pod/command/keys/get.rb

@@ -35,21 +35,12 @@ module Pod
           end
 
           if keyring.keys.include? @key_name
-            data = keyring.keychain_data
-            UI.puts data[@key_name]
+            data = keyring.keychain_value(@key_name)
+            UI.puts data
           else
             raise Informative, 'Could not find value'
           end
         end
-
-        def get_current_keyring
-          current_dir = Pathname.pwd
-          keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
-          if !keyring && @project_name
-            return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
-          end
-          keyring
-        end
       end
     end
   end

data/lib/pod/command/keys/list.rb

@@ -14,13 +14,12 @@ module Pod
 
         def run
           # List all settings for current app
-          this_keyring = CocoaPodsKeys::KeyringLiberator.get_keyring(Pathname.pwd)
+          this_keyring = get_current_keyring
           if this_keyring
             display_current_keyring this_keyring
           end
 
           # List all known bundle ids
-
           all_keyrings = CocoaPodsKeys::KeyringLiberator.get_all_keyrings
           all_keyrings.each do |keyring|
             display_keyring(keyring) if !this_keyring || keyring.path != this_keyring.path

data/lib/pod/command/keys/rm.rb

@@ -55,15 +55,6 @@ module Pod
             raise Informative, "Could not find key named #{@key_name}."
           end
         end
-
-        def get_current_keyring
-          current_dir = Pathname.pwd
-          keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
-          if !keyring && @project_name
-            return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
-          end
-          keyring
-        end
       end
     end
   end

data/lib/pod/command/keys/set.rb

@@ -38,7 +38,7 @@ module Pod
           # set a key to a folder id in ~/.cocoapods/keys
           # info "Saving into the keychain."
 
-          keyring = current_keyring
+          keyring = get_current_keyring || create_keyring
           keyring.keys << @key_name.tr('-', '_')
           CocoaPodsKeys::KeyringLiberator.save_keyring keyring
 
@@ -46,18 +46,6 @@ module Pod
 
           UI.puts "Saved #{@key_name} to #{keyring.name}." unless config.silent?
         end
-
-        def current_keyring
-          current_dir = Pathname.pwd
-          keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
-
-          unless keyring
-            name = @project_name || CocoaPodsKeys::NameWhisperer.get_project_name
-            keyring = CocoaPodsKeys::Keyring.new(name, current_dir, [])
-          end
-
-          keyring
-        end
       end
     end
   end

data/lib/preinstaller.rb

@@ -17,16 +17,20 @@ module CocoaPodsKeys
       options = @user_options || {}
       current_dir = Pathname.pwd
       project = options.fetch('project') { CocoaPodsKeys::NameWhisperer.get_project_name }
-      keyring = KeyringLiberator.get_keyring_named(project) || KeyringLiberator.get_keyring(current_dir)
+
+      keyring = KeyringLiberator.get_current_keyring(project, current_dir)
+
+      unless keyring
+        check_for_multiple_keyrings(project, current_dir)
+      end
 
       existing_keyring = !keyring.nil?
       keyring = CocoaPodsKeys::Keyring.new(project, current_dir, []) unless keyring
 
-      data = keyring.keychain_data
       has_shown_intro = false
       keys = options.fetch('keys', [])
       keys.each do |key|
-        unless ENV[key] || data.keys.include?(key)
+        unless keyring.keychain_has_key?(key)
           unless has_shown_intro
             ui.puts "\n CocoaPods-Keys has detected a keys mismatch for your setup."
             has_shown_intro = true
@@ -46,8 +50,23 @@ module CocoaPodsKeys
           setter.run
         end
       end
+      CocoaPodsKeys::KeyringLiberator.save_keyring(keyring)
 
       existing_keyring || !keys.empty?
     end
+
+    def check_for_multiple_keyrings(project, current_dir)
+      ui = Pod::UserInterface
+      keyrings = KeyringLiberator.get_all_keyrings_named(project)
+      if keyrings.count > 1
+        ui.puts "Found multiple keyrings for project #{project.inspect}, but"
+        ui.puts "no match found for current path (#{current_dir}):"
+        keyrings.each do |found_keyring|
+          ui.puts "- #{found_keyring.path}"
+        end
+        ui.puts "\nPress enter to create a new keyring, or `ctrl + c` to cancel"
+        ui.gets
+      end
+    end
   end
 end

data/spec/functional_spec.rb

@@ -29,6 +29,13 @@ describe 'CocoaPodsKeys functional tests' do
     end
   end
 
+  after :all do
+    KeyringLiberator.get_all_keyrings_named('TestProject').each do |keyring|
+      file = KeyringLiberator.yaml_path_for_path(keyring.path)
+      FileUtils.rm(file) if File.exist?(file)
+    end
+  end
+
   it 'does not directly encode the keys into the implementation file' do
     source = File.read(File.join(@tmpdir, 'Pods/CocoaPodsKeys/TestProjectKeys.m'))
     expect(source).to_not include('such-data')

data/spec/key_master_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
+require 'keyring'
 require 'key_master'
 require 'tmpdir'
 
+include CocoaPodsKeys
+
 describe CocoaPodsKeys::KeyMaster do
   # Previous tests operated under assumption that
   # empty keychains were OK. See for more info:
@@ -23,4 +26,19 @@ describe CocoaPodsKeys::KeyMaster do
       system(`xcrun --sdk macosx --find clang`.strip, '-fsyntax-only', m_file)
     end
   end
+
+  describe '#name' do
+    it 'takes keyring with name that starts with number returns augmented the name with underscore' do
+      keyring = Keyring.new('500px', '/', ['ARMyKey'])
+      keyring.instance_variable_set(:@keychain, FakeKeychain.new('ARMyKey' => 'secretkey'))
+      key_master = KeyMaster.new(keyring)
+      expect(key_master.name).to eq('_500pxKeys')
+    end
+    it 'takes keyring with proper name returns proper Keys file' do
+      keyring = Keyring.new('Artsy', '/', ['ARMyKey'])
+      keyring.instance_variable_set(:@keychain, FakeKeychain.new('ARMyKey' => 'secretkey'))
+      key_master = KeyMaster.new(keyring)
+      expect(key_master.name).to eq('ArtsyKeys')
+    end
+  end
 end

data/spec/keyring_liberator_spec.rb

@@ -21,6 +21,13 @@ describe KeyringLiberator do
     expect(KeyringLiberator.get_keyring_named('test')).to equal(keyring)
   end
 
+  it 'should find many by name' do
+    keyring1 = Keyring.from_hash('name' => 'test', 'path' => 'testpath1', 'keys' => [])
+    keyring2 = Keyring.from_hash('name' => 'test', 'path' => 'testpath2', 'keys' => [])
+    allow(KeyringLiberator).to receive(:get_all_keyrings).and_return([keyring1, keyring2])
+    expect(KeyringLiberator.get_all_keyrings_named('test')).to eq([keyring1, keyring2])
+  end
+
   it 'should be nil if nothing found find by name' do
     keyring = Keyring.from_hash('name' => 'test', 'path' => 'testpath', 'keys' => [])
     allow(KeyringLiberator).to receive(:get_all_keyrings).and_return([keyring])

data/spec/keyring_spec.rb

@@ -16,4 +16,35 @@ describe KeyringLiberator do
     keyring = Keyring.new('test', '/', ['ARMyKey'])
     expect(keyring.keychain_data).to eq('ARMyKey' => 'Hello')
   end
+
+  it 'looks up keys from the OSXKeychain' do
+    keyring = Keyring.new('test', '/', ['ARMyKey'])
+    keyring.instance_variable_set(:@keychain, FakeKeychain.new('KeychainKey' => 'abcde'))
+    expect(keyring.keychain_has_key?('KeychainKey')).to be_truthy
+    expect(keyring.keychain_value('KeychainKey')).to eq('abcde')
+    expect(keyring.keychain_has_key?('NotMyKey')).to be_falsey
+  end
+
+  it 'looks up keys from ENV' do
+    keyring = Keyring.new('test', '/', ['ARMyKey'])
+    ENV['EnvKey'] = '12345'
+    keyring.instance_variable_set(:@keychain, FakeKeychain.new('KeychainKey' => 'abcde'))
+    expect(keyring.keychain_has_key?('EnvKey')).to be_truthy
+    expect(keyring.keychain_value('EnvKey')).to eq('12345')
+    expect(keyring.keychain_has_key?('NotMyKey')).to be_falsey
+  end
+
+  it 'updates its list of keys' do
+    keyring = Keyring.new('test', '/', ['NotMyKey'])
+    ENV['EnvKey'] = '12345'
+    keyring.instance_variable_set(:@keychain, FakeKeychain.new('KeychainKey' => 'abcde'))
+
+    keyring.keychain_has_key?('KeychainKey')
+    keyring.keychain_has_key?('EnvKey')
+    keyring.keychain_has_key?('NotMyKey')
+
+    expect(keyring.keys.include?('KeychainKey')).to be_truthy
+    expect(keyring.keys.include?('EnvKey')).to be_truthy
+    expect(keyring.keys.include?('NotMyKey')).to be_falsey
+  end
 end

data/spec/spec_helper.rb

@@ -15,3 +15,13 @@ RSpec.configure do |c|
 
   c.color = true
 end
+
+class FakeKeychain
+  def initialize(data)
+    @data = data
+  end
+
+  def [](_, key)
+    @data[key]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-keys
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: osx_keychain