cocoapods-keys 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01550ce3823c499d612ad044e7eccb8001c95d6a
-  data.tar.gz: 0f29cceb83d5fc37e5329f4b55dd1fd5c78e8e9a
+  metadata.gz: 4c88307c98c867a040758ccf5582540e2276f0e0
+  data.tar.gz: 55c7512d49714f0cef4f0c52b6a72023ac8a64da
 SHA512:
-  metadata.gz: 619e1ec349b1f16bf56b1cdc4dfc88b5e12d7b2a90419e442a1b6c95ff09ec0af0e98733d48dbe1103fb1bba2abb06d8bfd12b5add0b332b215d43c369281954
-  data.tar.gz: 7dcef234103aa256f9cb7213cdc0871f4791e9ef8da761489ba0f0ad65914285d8bce82c386e38f7ecda119b600def9bf4ad7264e0bb225b70dfe487938a7987
+  metadata.gz: 0b1749bcd84c5a2a9aa9062ddf5047a17fa6966b670e28e830444ff843377bba9a75e6405a7e319ea45bd6f4d27795c435040ca415704750bd598c72cc1ad2e8
+  data.tar.gz: 7fc660c836254817e188fc44d59f8307a221dd5756d106c164fc65f4227809cbf5793ca93792cfa3810281592f6078a3047081a87c7f48f596caf6384d21cdb0

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from:
+ - .rubocop_cocoapods.yml
+ - .rubocop_todo.yml
+
+#- cocoapods-keys -------------------------------------------------------------
+
+Style/FileName:
+  Exclude:
+    - bin/*
+    - Rakefile

data/.rubocop_cocoapods.yml

@@ -0,0 +1,116 @@
+AllCops:
+  Include:
+    - ./Rakefile
+    - ./Gemfile
+    - ./*.gemspec
+  Exclude:
+    - ./spec/fixtures/**/*
+
+# At the moment not ready to be used
+# https://github.com/bbatsov/rubocop/issues/947
+Documentation:
+  Enabled: false
+
+#- CocoaPods -----------------------------------------------------------------#
+
+# We adopted raise instead of fail.
+SignalException:
+  EnforcedStyle: only_raise
+
+# They are idiomatic
+AssignmentInCondition:
+  Enabled: false
+
+# Allow backticks
+AsciiComments:
+  Enabled: false
+
+# Indentation clarifies logic branches in implementations
+IfUnlessModifier:
+  Enabled: false
+
+# No enforced convention here.
+SingleLineBlockParams:
+  Enabled: false
+
+# We only add the comment when needed.
+Encoding:
+  Enabled: false
+
+# Having these make it easier to *not* forget to add one when adding a new
+# value and you can simply copy the previous line.
+TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Clashes with CLAide Command#validate!
+GuardClause:
+  Enabled: false
+
+# Not always desirable: lib/claide/command/plugins_helper.rb:12:15
+Next:
+  Enabled: false
+
+# Arbitrary max lengths for classes simply do not work and enabling this will
+# lead to a never ending stream of annoyance and changes.
+Metrics/ClassLength:
+  Enabled: false
+
+# Arbitrary max lengths for methods simply do not work and enabling this will
+# lead to a never ending stream of annoyance and changes.
+Metrics/MethodLength:
+  Enabled: false
+
+# No enforced convention here.
+Metrics/BlockNesting:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/AbcSize:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+#- CocoaPods support for Ruby 1.8.7 ------------------------------------------#
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Lambda:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+EachWithObject:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+#- CocoaPods specs -----------------------------------------------------------#
+
+# Allow for `should.match /regexp/`.
+AmbiguousRegexpLiteral:
+  Exclude:
+    - spec/**/*
+
+# Allow `object.should == object` syntax.
+Void:
+  Exclude:
+    - spec/**/*
+
+ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*
+
+UselessComparison:
+  Exclude:
+    - spec/**/*
+

data/.rubocop_todo.yml

@@ -0,0 +1,39 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-05-15 23:41:41 -0700 using RuboCop version 0.31.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Offense count: 1
+Lint/UselessAccessModifier:
+  Enabled: false
+
+# Offense count: 1
+Lint/UselessSetterCall:
+  Enabled: false
+
+# Offense count: 2
+Lint/Void:
+  Enabled: false
+
+# Offense count: 38
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 173
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 4
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 1
+Style/RescueModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Master
 
+## 1.3.0
+
+* Support for not including keys in Podfile [ashfurrow]
+
 ## 1.2.0
 
 * Support for correctly scoping Keys to a target [orta]
@@ -13,4 +17,4 @@
 
 * Support both :key and "key" in user settings [alloy]
 * Use ERB templates for the .m & .h [lyricsboy]
-* Frameworks support [ashfurrow]
+* Frameworks support [ashfurrow]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-keys (1.2.1)
+    cocoapods-keys (1.3.0)
       osx_keychain
 
 GEM
@@ -16,6 +16,9 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     claide (0.8.1)
     cocoapods (0.36.3)
       activesupport (>= 3.2.15)
@@ -55,6 +58,10 @@ GEM
     open4 (1.3.4)
     osx_keychain (1.0.1)
       RubyInline (~> 3)
+    parser (2.2.2.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
     rake (10.3.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
@@ -69,6 +76,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    rubocop (0.31.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -85,3 +99,7 @@ DEPENDENCIES
   cocoapods-keys!
   rake
   rspec
+  rubocop
+
+BUNDLED WITH
+   1.10.0

data/README.md

@@ -20,6 +20,26 @@ The generated Objective-C classes are stored in the `Pods/Keys` directory, so if
 
 ## Usage
 
+Using the new Plugin API in CocoaPods we can automate a lot of the fiddly bits away. You define what keys you want inside your [Podfile](https://github.com/artsy/eidolon/blob/0a9f5947914eb637fd4abf364fa3532b56da3c52/Podfile#L6-L21) and Keys will detect what keys are not yet set. If you need to specify a different project name from the target name, use the key `:target` to specify it.
+
+```
+plugin 'cocoapods-keys', {
+  :project => "Eidolon",
+  :keys => [
+    "ArtsyAPIClientSecret",
+    "ArtsyAPIClientKey",
+    "HockeyProductionSecret",
+    "HockeyBetaSecret",
+    "MixpanelProductionAPIClientKey",
+    ...
+  ]}
+```
+
+Then running `pod install` will prompt for the keys not yet set and you can ensure everyone has the same setup.
+
+
+## Alternative Usage
+
 You can save keys on a per-project basis by running the command:
 
     $ pod keys set KEY VALUE
@@ -47,7 +67,7 @@ For example:
    └ redditAPIToken & mixpanelAPIToken
 ```
 
-After the next `pod install` or `pod update` keys will add a new `Keys` pod to your Pods project, supporting both static libraries and frameworks. This provides an API to your keys from Cocoa code. For example the application code above would look like:
+After the next `pod install` or `pod update` keys will add a new `Keys` pod to your Pods project, supporting both static libraries and frameworks. *Note* you have to include `plugin 'cocoapods-keys'` in the Podfile for Keys to register that it should work. This provides an API to your keys from Cocoa code. For example the application code above would look like:
 
 ``` objc
 
@@ -69,24 +89,7 @@ After the next `pod install` or `pod update` keys will add a new `Keys` pod to y
 
 ```
 
-## Usage via CocoaPods 0.36
-
-Using the new Plugin API in CocoaPods we can automate a lot of the fiddly bits away. You define what keys you want inside your [Podfile](https://github.com/artsy/eidolon/blob/0a9f5947914eb637fd4abf364fa3532b56da3c52/Podfile#L6-L21) and Keys will detect what keys are not yet set. If you need to specify a different project name from the target name, use the key `:target` to specify it. 
-
-```
-plugin 'cocoapods-keys', {
-  :project => "Eidolon",
-  :keys => [
-    "ArtsyAPIClientSecret",
-    "ArtsyAPIClientKey",
-    "HockeyProductionSecret",
-    "HockeyBetaSecret",
-    "MixpanelProductionAPIClientKey",
-    ...
-  ]}
-```
-
-Then running `pod install` will prompt for the keys not yet set and you can ensure everyone has the same setup.
+Some documentation is also available to [use cocoapods-keys in Swift projects](SWIFT_PROJECTS.md).
 
 #### Other commands
 

data/Rakefile

@@ -6,9 +6,10 @@ file dump_keys_tool => dump_keys_source_file do
   sh "xcrun clang -framework Foundation #{dump_keys_source_file} -o #{dump_keys_tool}"
 end
 
-desc "Run tests"
+desc 'Run tests'
 task :spec => dump_keys_tool do
-  sh "bundle exec rspec spec/*_spec.rb"
+  sh 'bundle exec rspec spec/*_spec.rb'
+  sh 'bundle exec rubocop lib spec Rakefile'
 end
 
 task :default => :spec

data/SWIFT_PROJECTS.md

@@ -0,0 +1,31 @@
+# Using Cocoapods-Keys in Swift projects
+
+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
+module is `Keys`.
+
+```swift
+import Keys
+```
+
+## Usage
+
+```swift
+let keys = MyApplicationKeys()
+ARAnalytics.setupWithAnalytics(keys.analyticsToken)
+```

data/cocoapods_keys.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
 end

data/lib/cocoapods_keys.rb

@@ -1,3 +1,3 @@
 module CocoaPodsKeys
-  VERSION = "1.2.1"
+  VERSION = '1.3.0'
 end

data/lib/cocoapods_plugin.rb

@@ -1,3 +1,3 @@
-require "keyring"
+require 'keyring'
 require 'pod/command/keys'
 require 'plugin'

data/lib/key_master.rb

@@ -1,13 +1,13 @@
 require 'set'
 require 'erb'
 require 'digest'
+require 'securerandom'
 
 module CocoaPodsKeys
   class KeyMaster
-
     attr_accessor :name, :interface, :implementation
 
-    def initialize(keyring, time=Time.now)
+    def initialize(keyring, time = Time.now)
       @time = time
       @keys = Hash[keyring.keychain_data.map { |(key, value)| [key[0].downcase + key[1..-1], value] }]
       @name = keyring.code_name + 'Keys'
@@ -19,13 +19,15 @@ module CocoaPodsKeys
     end
 
     def generate_data
+      # guard method; raises error if something in application keychain
+      # is nil. provides for better error message.
+      verify_keychain_integrity
 
-      return nil if @keys.empty?
       # Generate a base64 hash string that is ~25 times the length of all keys
 
       @data_length = @keys.values.map(&:length).reduce(:+) * (20 + rand(10))
-      data = `head -c #{@data_length} /dev/random | base64 | head -c #{@data_length}`
-      data = data + '\\"'
+      data = SecureRandom.base64(@data_length)
+      data += '\\"'
       @data_length = data.length
 
       # Swap the characters within the hashed string with the characters from
@@ -36,13 +38,12 @@ module CocoaPodsKeys
 
         value.chars.each_with_index do |char, char_index|
           loop do
-
             if char == '"'
               index = data.delete('\\').length - 1
               @indexed_keys[key][char_index] = index
               break
             else
-              index = rand data.length
+              index = SecureRandom.random_number data.length
               unless @used_indexes.include?(index)
                 data[index] = char
 
@@ -59,23 +60,28 @@ module CocoaPodsKeys
     end
 
     def generate_interface
-      render_erb("Keys.h.erb")
+      render_erb('Keys.h.erb')
     end
 
     def generate_implementation
-      render_erb("Keys.m.erb")
+      render_erb('Keys.m.erb')
     end
 
-    :private
-    
+    def verify_keychain_integrity
+      if @keys.values.any?.nil? || @keys.any?.nil?
+        raise 'A key/value pair in the application keychain is nil.'
+      end
+    end
+
+    private
+
     def render_erb(erb_template)
-      erb = IO.read(File.join(__dir__, "../templates", erb_template))
+      erb = (Pathname(__dir__).parent + 'templates' + erb_template).read
       ERB.new(erb, nil, '-').result(binding)
     end
 
     def key_data_arrays
-      Hash[@indexed_keys.map {|key, value| [key, value.map { |i| name + "Data[#{i}]" }.join(', ')]}]
+      Hash[@indexed_keys.map { |key, value| [key, value.map { |i| name + "Data[#{i}]" }.join(', ')] }]
     end
-
   end
 end