keystok 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b171c31a96eb431336e7ddfd324cbedc3721b2ea
-  data.tar.gz: 035f617aa25a7bf8408c4ed6f048463edfa1f4a3
+  metadata.gz: 96769d2e85b97bb6f18cca89c0274b40768df04c
+  data.tar.gz: ae029a049d8305e7f18002a951d3097c2b3b5368
 SHA512:
-  metadata.gz: e40957f85b6070b234332594758c3052a8a188343c01d7c4257c883fcc5eaee4d5e0f9d14db37cf5ba62b8ffc536cc1e2e37b5e52cd786fbb9349c5fa01ae456
-  data.tar.gz: bcdf6699966da5ba3f60d32fa08233d7e211a18c77dbddc717946c22abec0055c6a9c5355ae210452cd7975bb1548e66222054c8cef7bd35d39418ff8267696f
+  metadata.gz: b6eb31e54a784e0584b8b4849289b03e368233353056eb1638d446fbbaf139792c80c7a91c0906ad75a01aea36c3daea3a9eeca32e698557ca5706ed4a721b7a
+  data.tar.gz: 65c1b44253307c9d06a53b9f5e0614f9cc223440bb1fa8aadd9a1e69c4d5b4f4a3e3ac21b361044f5683549c74ea4209a59ab40fa03dced15d7d54f631c7b84c

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 1.2.0 (2014-05-07)
+
+### Changes
+* **connection_string** renamed to less confusing **access_token**.
+  Please note that **connection_string** is not deprecated in config files
+  and it will be still suppoerted except CLI long option name.
+  However it will not be mentioned in documentation anymore.
+
 ## 1.1.1 (2014-05-05)
 
 ### Bugfixes

data/README.md

@@ -12,7 +12,7 @@
     require 'yaml' # Config is then easier
     config = YAML.load_file('keystok.yml')
     # or config can be just hash:
-    # config = { connection_string: 'das21312312_connection_string',
+    # config = { access_token: 'das21312312_access_token',
     #            api_host: 'https://api_custom_domain.keystok.com'
     #          }
     keystok = Keystok::Client.new(config)
@@ -29,7 +29,7 @@ Add keystok to Gemfile:
 
 Keystok have generator that can create config, initializer and .gitignore entry for you
 
-    rails g keystok:install connection_string_value
+    rails g keystok:install access_token_value
 
 In Rails env Keystok will use Rails.logger. Without Rails it will default to logging to STDOUT.
 If you would like to define your own logger you can do it like:
@@ -42,9 +42,9 @@ If you would like to define your own logger you can do it like:
 
 Those values are not needed by default. It can be required if you are using separated Keystok servers
 
-### connection_string
+### access_token
 
-This value is visible in app page in Keystok service
+This value is visible in **API Access** app tab in Keystok.com
 
 ### eager_fetching
 
@@ -89,10 +89,10 @@ Get all keys with content in CSV format:
 
     $ keystok_rb -a dump
 
-By default **keystok_rb** search for file with connection string in *~/.keystok.yml*. File format is just:
+By default **keystok_rb** search for file with access token in *~/.keystok.yml*. File format is just:
 
     ---
-    :connection_string: connection_string_value
+    :access_token: access_token_value
 
 It's named keystok_rb to not interfere with other SDK's and you are free to create symlink or RVM wrapper with any name you want.
 
@@ -104,18 +104,18 @@ Possible values:
 * dump - get all keys with content and print output
 * get - print key content or list keys if **-k** is not used (default)
 
-#### -c --connection-string
+#### -c --access-token
 
-Specify connection string
+Specify access token
 
-#### -f --connection-string-file
+#### -f --access-token-file
 
-Specify connection string filepath (default is *~/.keystok.yml*)
+Specify access token filepath (default is *~/.keystok.yml*)
 Example file format:
 
     ---
-    :connection_string: connection_string_value
-   
+    :access_token: access_token_value
+
 NOTE: **-c** have higher precedence than **-f**
 
 #### -k --key-id

data/lib/generators/keystok/install_generator.rb

@@ -8,9 +8,9 @@ module Keystok
     # Generator that creates config file and initializer
     # It also add config file to .gitignore
     class InstallGenerator < Rails::Generators::Base
-      argument :connection_string,
+      argument :access_token,
                type: :string,
-               banner: 'connection_string'
+               banner: 'access_string'
 
       source_root File.expand_path('../templates', __FILE__)
 

data/lib/generators/keystok/templates/keystok.yml.erb

@@ -1,10 +1,10 @@
 ---
 :production:
-  :connection_string: <%= connection_string %>
+  :access_token: <%= access_token %>
   :tmp_dir: 'tmp'
 :development:
-  :connection_string: <%= connection_string %>
+  :access_token: <%= access_token %>
   :tmp_dir: 'tmp'
 :test:
-  :connection_string: <%= connection_string %>
+  :access_token: <%= access_token %>
   :tmp_dir: 'tmp'

data/lib/keystok/cli.rb

@@ -11,18 +11,15 @@ module Keystok
   class CLI
     def run(args = ARGV)
       options = parse(args)
-      if options.connection_string
-        connection_string = options.connection_string
+      access_token = options.access_token if options.access_token
+      if !access_token && options.access_token_filepath
+        access_token = YAML.load_file(options.access_token_filepath)
       end
-      if !connection_string && options.connection_string_filepath
-        connection_string = YAML.load_file(
-          options.connection_string_filepath)['connection_string']
-      end
-      if connection_string.nil?
+      if access_token.nil?
         puts 'You have to use -c or -f option'
         exit 1
       end
-      client = Keystok::Client.new(connection_string)
+      client = Keystok::Client.new(access_token)
       case options.command
       when :dump
         puts dump_data(client.keys, options.dump_format)
@@ -73,7 +70,7 @@ module Keystok
     def parse(args = [])
       options = OpenStruct.new
       options.command = :get
-      options.connection_string_filepath = File.expand_path('~/.keystok.yml')
+      options.access_token_filepath = File.expand_path('~/.keystok.yml')
       options.dump_format = :csv
       opts_parser = OptionParser.new do |opts|
         opts.banner = 'Usage: keystok_rb [options] COMMAND'
@@ -83,14 +80,14 @@ module Keystok
                 'Action to perform (dump, get, keys)') do |ext|
           options.command = ext
         end
-        opts.on('-c', '--connection-string [CONNECTION_STRING]',
-                'Use CONNECTION_STRING when contacting Keystok API') do |ext|
-          options.connection_string = ext
+        opts.on('-c', '--access-token [access_token]',
+                'Use access_token when contacting Keystok API') do |ext|
+          options.access_token = ext
         end
-        opts.on('-f', '--connection-string-file [FILE_PATH]',
-                'Use content of file at FILE_PATH as connection string',
+        opts.on('-f', '--access-token-file [FILE_PATH]',
+                'Use content of file at FILE_PATH as access token',
                 ' when contacting Keystok API') do |ext|
-          options.connection_string_filepath = ext
+          options.access_token_filepath = ext
         end
         opts.on('-k', '--key-id [KEY_ID]', 'When action is GET, fetch value',
                 ' for this KEY_ID') do |ext|

data/lib/keystok/client.rb

@@ -22,7 +22,7 @@ module Keystok
     REQUEST_TRY_COUNT = 3
 
     def initialize(config = {})
-      @config = DEFAULT_CONFIG.merge(keys_to_symbols(decode_config(config)))
+      @config = DEFAULT_CONFIG.merge(decode_config(config))
       @keys_store = {}
     end
 
@@ -82,44 +82,42 @@ module Keystok
                                   ssl: { verify: true })
     end
 
-    def decode_config(connection_string)
-      config_hash = connection_string
+    def decode_config(access_token)
+      config_hash = access_token
       case
-      when connection_string.kind_of?(Hash)
-      when connection_string.kind_of?(String)
-        config_hash = decode_string_config(connection_string)
+      when access_token.kind_of?(Hash)
+      when access_token.kind_of?(String)
+        config_hash = decode_string_config(access_token)
       else
         fail Error::ConfigError, 'Unknown config format'
       end
-      if config_hash[:connection_string]
-        decoded_hash = decode_string_config(config_hash[:connection_string])
-        config_hash.delete(:connection_string)
-        config_hash = decoded_hash.merge(config_hash)
-      end
+      config_hash = keys_to_symbols(config_hash)
+      config_hash = merge_access_token(config_hash, :connection_string)
+      config_hash = merge_access_token(config_hash)
       config_hash
     end
 
-    def decode_json_string_config(connection_string)
+    def decode_json_string_config(access_token)
       parsed_config = nil
       begin
-        parsed_config = JSON.parse(connection_string)
+        parsed_config = JSON.parse(access_token)
       # rubocop:disable HandleExceptions
       rescue JSON::ParserError
       # rubocop:enable HandleExceptions
         # Whatever may fail, we don't want to raise it.
       end
-      parsed_config
+      parsed_config ? keys_to_symbols(parsed_config) : parsed_config
     end
 
-    def decode_string_config(connection_string)
-      return {} if connection_string == ''
-      parsed_config = decode_json_string_config(connection_string)
+    def decode_string_config(access_token)
+      return {} if access_token == ''
+      parsed_config = decode_json_string_config(access_token)
       unless parsed_config
-        decoded_string = Base64.decode64(connection_string)
+        decoded_string = Base64.decode64(access_token)
         parsed_config = decode_json_string_config(decoded_string)
       end
       fail Error::ConfigError, 'Unknown config format' unless parsed_config
-      parsed_config
+      keys_to_symbols(parsed_config)
     end
 
     def fetch_data(key = nil)
@@ -189,6 +187,15 @@ module Keystok
       @keys_store
     end
 
+    def merge_access_token(config_hash, field = :access_token)
+      if config_hash[field]
+        decoded_hash = decode_string_config(config_hash[field])
+        config_hash.delete(field)
+        config_hash = decoded_hash.merge(config_hash)
+      end
+      config_hash
+    end
+
     def oauth_client
       @oauth_client ||= begin
         OAuth2::Client.new(nil, nil, site: @config[:auth_host] || AUTH_HOST)

data/lib/keystok/version.rb

@@ -5,5 +5,5 @@
 
 #:nodoc:
 module Keystok
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/fixtures/access_token_00.data

@@ -0,0 +1,2 @@
+---
+access_token: eyJkayI6Ijk2NTM5MWYyYmJhMzdiNDU4NjQzMWI4NjkwZDcwNDRkNWNkYzczYWRmN2RkYTUzOWY4ZGQzYTYwY2IzZTliMTIiLCJydCI6IjJjYjQ1ODNjZDhhMzk5ZjUxZGIxNWRhNTdkMDY3OTcwNmFlOTc1ZDJhYTlkM2M3MWY1ZmRkMDI1NWRkNmEwMjgiLCJpZCI6MX0=

data/spec/fixtures/access_token_01.data

@@ -0,0 +1,2 @@
+---
+access_token: eyJkayI6Ijk2NTM5MWYyYmJhMzdiNDU4NjQzMWI4NjkwZDcwNDRkNWNkYzczYWRmN2RkYTUzOWY4ZGQzYTYwY2IzZTliMTIiLCJydCI6IjJjYjQ1ODNjZDhhMzk5ZjUxZGIxNWRhNTdkMDY3OTcwNmFlOTc1ZDJhYTlkM2M3MWY1ZmRkMDI1NWRkNmEwMjgiLCJpZCI6Mn0=

data/spec/functional/cli_spec.rb

@@ -10,12 +10,12 @@ describe Keystok::CLI do
   let(:config) { { id: 1 } }
   let(:some_string) { Faker::Lorem.characters(20) }
 
-  def connection_string(id = '00')
-    YAML.load_file(connection_string_filepath(id))['connection_string']
+  def access_token(id = '00')
+    YAML.load_file(access_token_filepath(id))['access_token']
   end
 
-  def connection_string_filepath(id = '00')
-    File.expand_path("../../fixtures/connection_string_#{id}.data", __FILE__)
+  def access_token_filepath(id = '00')
+    File.expand_path("../../fixtures/access_token_#{id}.data", __FILE__)
   end
 
   def suppress_puts
@@ -48,23 +48,29 @@ describe Keystok::CLI do
       end
     end
 
-    it 'loads connection string from file when filepath is provided' do
-      expect_any_instance_of(Keystok::Client).to receive(:decode_config)
-        .with(connection_string).and_call_original
-      cli.run(["-f#{connection_string_filepath}"])
+    it 'loads access token from file when filepath is provided' do
+      expect_any_instance_of(Keystok::Client).to receive(:decode_string_config)
+        .with(access_token).and_call_original
+      cli.run(["-f#{access_token_filepath}"])
     end
 
-    it 'sets connection string if provided' do
-      expect_any_instance_of(Keystok::Client).to receive(:decode_config)
-        .with(connection_string).and_call_original
-      cli.run(["-c#{connection_string}"])
+    it "loads access token from legacy file with 'connection_string'" do
+      expect_any_instance_of(Keystok::Client).to receive(:decode_string_config)
+        .with(access_token).and_call_original
+      cli.run(["-f#{access_token_filepath('02')}"])
     end
 
-    it 'use connection string if both with filepath are provided' do
-      expect_any_instance_of(Keystok::Client).to receive(:decode_config)
-        .with(connection_string).and_call_original
-      cli.run(["-f#{connection_string_filepath('01')}",
-               "-c#{connection_string}"])
+    it 'sets access token if provided' do
+      expect_any_instance_of(Keystok::Client).to receive(:decode_string_config)
+        .with(access_token).and_call_original
+      cli.run(["-c#{access_token}"])
+    end
+
+    it 'use access token if both with filepath are provided' do
+      expect_any_instance_of(Keystok::Client).to receive(:decode_string_config)
+        .with(access_token).and_call_original
+      cli.run(["-f#{access_token_filepath('01')}",
+               "-c#{access_token}"])
     end
 
     it 'reports error when no -f or -c options are used' do
@@ -77,26 +83,26 @@ describe Keystok::CLI do
 
     it "execute 'dump_data' when command is 'dump'" do
       expect(cli).to receive(:dump_data).and_call_original
-      cli.run(["-c#{connection_string}", '-adump'])
+      cli.run(["-c#{access_token}", '-adump'])
     end
 
     it "execute 'get' on client when command is 'get' with '-k'" do
       expect_any_instance_of(Keystok::Client).to receive(:get)
         .and_call_original
-      cli.run(["-c#{connection_string}", '-aget', '-kmy_key'])
+      cli.run(["-c#{access_token}", '-aget', '-kmy_key'])
     end
 
     it "execute 'format_keys' when command is 'get' without key_id" do
       expect_any_instance_of(Keystok::Client).to receive(:keys)
         .and_call_original
       expect(cli).to receive(:format_keys_list)
-      cli.run(["-c#{connection_string}", '-aget'])
+      cli.run(["-c#{access_token}", '-aget'])
     end
 
     it "execute 'format_keys_list' when command is unknown" do
       expect($stdout).to receive(:puts).with('Unknown command: ')
       expect do
-        cli.run(["-c#{connection_string}", '-asomething_else'])
+        cli.run(["-c#{access_token}", '-asomething_else'])
       end.to raise_error { |error|
         expect(error).to be_a(SystemExit)
         expect(error.status).to eq(1)
@@ -181,7 +187,7 @@ describe Keystok::CLI do
     context 'default values' do
       [['command', :get],
        ['dump_format', :csv],
-       ['connection_string_filepath', File.expand_path('~/.keystok.yml')]
+       ['access_token_filepath', File.expand_path('~/.keystok.yml')]
        ].each do |property, value|
         it "for '#{property}' is '#{value.inspect}'" do
           expect(cli.send(:parse, []).send(property)).to eq(value)
@@ -213,8 +219,8 @@ describe Keystok::CLI do
       end
     end
 
-    [%w(connection-string c connection_string),
-     %w(connection-string-file f connection_string_filepath),
+    [%w(access-token c access_token),
+     %w(access-token-file f access_token_filepath),
      %w(key-id k key_id)].each do |full_name, short_name, property|
       context "--#{full_name}" do
         it "set '#{property}'" do

data/spec/functional/client_spec.rb

@@ -36,7 +36,7 @@ describe Keystok::Client do
   it 'allow initialization with empty config' do
     Keystok::Client.new
     Keystok::Client.new('')
-    Keystok::Client.new(connection_string: '', tmp_dir: 'tmp')
+    Keystok::Client.new(access_token: '', tmp_dir: 'tmp')
   end
 
   describe 'default for' do
@@ -247,26 +247,34 @@ describe Keystok::Client do
   end
 
   context 'config parsing' do
-    let(:config_hash) { { 'api_host' => 'http://dum.my', 'some_data' => 2 } }
+    let(:config_hash) { { api_host: 'http://dum.my', some_data: 2 } }
     describe 'decode_config' do
       it "returns input if it's a hash" do
         expect(client.send(:decode_config, config_hash)).to eq(config_hash)
       end
 
-      it 'decodes connection string and merges it to the config hash' do
-        config_with_connection_string = {
-          connection_string: Base64.urlsafe_encode64(config_hash.to_json)
+      it 'decodes access token and merges it to the config hash' do
+        config_with_access_token = {
+          access_token: Base64.urlsafe_encode64(config_hash.to_json)
         }
         expect(client.send(:decode_config,
-                           config_with_connection_string)).to eq(config_hash)
+                           config_with_access_token)).to eq(config_hash)
       end
 
-      it "raise ConfigError when connection string can't be decoded" do
-        config_with_connection_string = {
+      it "decodes access token when legacy 'connection_string' is used" do
+        config_with_access_token = {
           connection_string: Base64.urlsafe_encode64(config_hash.to_json)
         }
         expect(client.send(:decode_config,
-                           config_with_connection_string)).to eq(config_hash)
+                           config_with_access_token)).to eq(config_hash)
+      end
+
+      it "raise ConfigError when access token can't be decoded" do
+        config_with_access_token = {
+          access_token: Base64.urlsafe_encode64(config_hash.to_json)
+        }
+        expect(client.send(:decode_config,
+                           config_with_access_token)).to eq(config_hash)
       end
 
       it "returns hash if it's a JSON string" do

data/spec/integration/rails_integration_spec.rb

@@ -41,7 +41,7 @@ describe 'Rails integration' do
     end
 
     it 'creates initializer' do
-      Keystok::Generators::InstallGenerator.start(['connection_string'],
+      Keystok::Generators::InstallGenerator.start(['access_token'],
                                                   destination_root:
                                                     destination_dir)
       expect(File.size(File.join(destination_dir,
@@ -56,7 +56,7 @@ describe 'Rails integration' do
       end
 
       before do
-        Keystok::Generators::InstallGenerator.start(['connection_string'],
+        Keystok::Generators::InstallGenerator.start(['access_token'],
                                                     destination_root:
                                                       destination_dir)
       end
@@ -68,9 +68,9 @@ describe 'Rails integration' do
       end
 
       %w(production development test).map(&:to_sym).each do |env|
-        it "config file have :connection_string set in #{env} environment" do
-          expect(loaded_config[env][:connection_string])
-            .to eq('connection_string')
+        it "config file have :access_token set in #{env} environment" do
+          expect(loaded_config[env][:access_token])
+            .to eq('access_token')
         end
 
         it "config file have :tmp_dir set in #{env} environment" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keystok
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Piotr Sokolowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -208,8 +208,9 @@ files:
 - lib/keystok/errors.rb
 - lib/keystok/railtie.rb
 - lib/keystok/version.rb
-- spec/fixtures/connection_string_00.data
-- spec/fixtures/connection_string_01.data
+- spec/fixtures/access_token_00.data
+- spec/fixtures/access_token_01.data
+- spec/fixtures/access_token_02.data
 - spec/fixtures/encrypted_data_00.data
 - spec/fixtures/response_data_00.data
 - spec/functional/aes_crypto_spec.rb
@@ -245,8 +246,9 @@ signing_key:
 specification_version: 4
 summary: Keystok API client
 test_files:
-- spec/fixtures/connection_string_00.data
-- spec/fixtures/connection_string_01.data
+- spec/fixtures/access_token_00.data
+- spec/fixtures/access_token_01.data
+- spec/fixtures/access_token_02.data
 - spec/fixtures/encrypted_data_00.data
 - spec/fixtures/response_data_00.data
 - spec/functional/aes_crypto_spec.rb

data/spec/fixtures/connection_string_01.data

@@ -1,2 +0,0 @@
----
-connection_string: eyJkayI6Ijk2NTM5MWYyYmJhMzdiNDU4NjQzMWI4NjkwZDcwNDRkNWNkYzczYWRmN2RkYTUzOWY4ZGQzYTYwY2IzZTliMTIiLCJydCI6IjJjYjQ1ODNjZDhhMzk5ZjUxZGIxNWRhNTdkMDY3OTcwNmFlOTc1ZDJhYTlkM2M3MWY1ZmRkMDI1NWRkNmEwMjgiLCJpZCI6Mn0=