keystok 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96769d2e85b97bb6f18cca89c0274b40768df04c
-  data.tar.gz: ae029a049d8305e7f18002a951d3097c2b3b5368
+  metadata.gz: 3a0cf5afc5c143742229147e90b3e1684e79d508
+  data.tar.gz: b660ce697b8ff1ff45c5350c2dd9414ecb765b61
 SHA512:
-  metadata.gz: b6eb31e54a784e0584b8b4849289b03e368233353056eb1638d446fbbaf139792c80c7a91c0906ad75a01aea36c3daea3a9eeca32e698557ca5706ed4a721b7a
-  data.tar.gz: 65c1b44253307c9d06a53b9f5e0614f9cc223440bb1fa8aadd9a1e69c4d5b4f4a3e3ac21b361044f5683549c74ea4209a59ab40fa03dced15d7d54f631c7b84c
+  metadata.gz: 4d7194ef6cb5b2cdd58fceb899d56e23c5128e60a5cb2587b62051b964e22ecc23523054f5de2f62be571df810102e9cc2521d24e1397aa17fa2c6177b5d3a31
+  data.tar.gz: e24946c959246fb8bf0ecf392870007688660cae2b856e30295cef159dbba492b4d0f72f4c0d22420968617244337b387eba74b30a5d7dc5c614426dcd595628

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 1.3.0 (2014-05-12)
+
+### Changes
+* **--init-token-file** added to eliminate a need of creating manually ~/.keystok.yml
+  Now it can be created along with executing normal keystok command
+
 ## 1.2.0 (2014-05-07)
 
 ### Changes

data/README.md

@@ -1,5 +1,6 @@
 # Keystok
 
+## Tests status
 ![Build status](https://www.codeship.io/projects/65218fa0-9e09-0131-3f96-16b8a84518ac/status)
 
 ## Installation
@@ -10,14 +11,15 @@
 
     require 'keystok'
     require 'yaml' # Config is then easier
-    config = YAML.load_file('keystok.yml')
-    # or config can be just hash:
-    # config = { access_token: 'das21312312_access_token',
-    #            api_host: 'https://api_custom_domain.keystok.com'
-    #          }
-    keystok = Keystok::Client.new(config)
+
+    keystok = Keystok::Client.new('das21312312_access_token')
+    # or config can be loaded from file:
+    # config = YAML.load_file('keystok.yml')
+    # keystok = Keystok::Client.new(config)
+
     # get hash with all keys
     keystok.keys
+
     # get one key
     keystok.get(key_id)
 
@@ -27,7 +29,7 @@ Add keystok to Gemfile:
 
     gem 'keystok'
 
-Keystok have generator that can create config, initializer and .gitignore entry for you
+Keystok have generator that can create config and initializer for you
 
     rails g keystok:install access_token_value
 
@@ -38,40 +40,40 @@ If you would like to define your own logger you can do it like:
 
 ## Config options description
 
-### api_host, auth_host
+### **api_host**, **auth_host**
 
 Those values are not needed by default. It can be required if you are using separated Keystok servers
 
-### access_token
+### **access_token**
 
 This value is visible in **API Access** app tab in Keystok.com
 
-### eager_fetching
+### **eager_fetching**
 
-When *true* client will fetch all keys from API even when one was requested. This will save time
+When **true**, client will fetch all keys from API even when one was requested. This will save time
 when another key will be requested, because client will not have to fetch it from API.
-However in some cases like huge amount of keys or when *volatile* is set,
-this option should be set to *false*. Default value is *true*
+However in some cases like huge amount of keys or when **volatile** is set,
+this option should be set to **false**. Default value is **true**
 
-### no_cache
+### **no_cache**
 
-If you don't want to use cache functionality, you can disable cache writing by setting *no_cache* to *true* in config
+If you don't want to use cache functionality, you can disable cache writing by setting **no_cache** to **true** in config
 
-### tmp_dir
+### **tmp_dir**
 
 This dir will be used to store encrypted cache which can be used when API can't be contacted
 
-### volatile
+### **volatile**
 
 Normally when asking about key that is in local store, SDK will not perform API request to provide quicker response.
-Request can be forced on per method call basis by second parameter set to *true* (default is *false*)
+Request can be forced on per method call basis by second parameter set to **true** (default is **false**)
 
     keystok.get('this_can_change_often', true)
 
-However if you want SDK to make request on every request without adding *true* to every *get* or *keys*,
-you can set *volatile* to *true* in config. This will force SDK to ask API on every request.
+However if you want SDK to make request on every request without adding **true** to every **get** or **keys**,
+you can set **volatile** to **true** in config. This will force SDK to ask API on every request.
 Please note that this will may decrese performance of you app since it will require API request
-and cache writing on every *get* and *keys* call
+and cache writing on every **get** and **keys** call
 
 ## CLI client (since v1.1.0)
 
@@ -89,7 +91,7 @@ Get all keys with content in CSV format:
 
     $ keystok_rb -a dump
 
-By default **keystok_rb** search for file with access token in *~/.keystok.yml*. File format is just:
+By default **keystok_rb** search for file with access token in **~/.keystok.yml**. File format is just:
 
     ---
     :access_token: access_token_value
@@ -98,19 +100,19 @@ It's named keystok_rb to not interfere with other SDK's and you are free to crea
 
 ### Options
 
-#### -a --action
+#### **-a** **--action**
 
 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 --access-token
+#### **-c** **--access-token**
 
 Specify access token
 
-#### -f --access-token-file
+#### **-f** **--access-token-file**
 
-Specify access token filepath (default is *~/.keystok.yml*)
+Specify access token filepath (default is **~/.keystok.yml**)
 Example file format:
 
     ---
@@ -118,11 +120,16 @@ Example file format:
 
 NOTE: **-c** have higher precedence than **-f**
 
-#### -k --key-id
+#### **-i** **--init-token-file**
+
+When used with **-c** it creates token config file. It's an easy way to create config file while executing first command.
+Please note that **-f** have effect on this.
+
+#### **-k** **--key-id**
 
 Specify which key should be fetched when action is **get**
 
-#### -t --dump-format-type
+#### **-t** **--dump-format-type**
 
 Possible values:
 * csv (default)
@@ -131,6 +138,6 @@ Possible values:
 
 Prints all keys with their content in specified format
 
-#### -h --help
+#### **-h** **--help**
 
 Print help and exit

data/keystok.gemspec

@@ -25,6 +25,7 @@ EOS
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'hashie'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rails', '>= 3.0'
   spec.add_development_dependency 'rake'

data/lib/keystok/cli.rb

@@ -11,10 +11,7 @@ module Keystok
   class CLI
     def run(args = ARGV)
       options = parse(args)
-      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
+      access_token = choose_access_token(options)
       if access_token.nil?
         puts 'You have to use -c or -f option'
         exit 1
@@ -33,10 +30,22 @@ module Keystok
         puts "Unknown command: #{options.command}"
         exit 1
       end
+      if options.init_token_file && options.access_token &&
+         options.access_token_filepath
+        init_token_file(access_token, options.access_token_filepath)
+      end
     end
 
     private
 
+    def choose_access_token(options)
+      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
+      access_token
+    end
+
     def dump_data(keys, format = 'csv')
       unless %w(csv json yaml).include?(format.to_s)
         puts "Unknown dump format: #{format}"
@@ -66,6 +75,13 @@ module Keystok
       keys.keys.sort.join("\n")
     end
 
+    def init_token_file(access_token, filepath)
+      config = {}
+      config = YAML.load_file(filepath) || {} if File.exist?(filepath)
+      config[:access_token] = access_token
+      File.open(filepath, 'w') { |file| file.write(config.to_yaml) }
+    end
+
     # rubocop:disable MethodLength
     def parse(args = [])
       options = OpenStruct.new
@@ -89,6 +105,10 @@ module Keystok
                 ' when contacting Keystok API') do |ext|
           options.access_token_filepath = ext
         end
+        opts.on('-i', '--init-token-file', 'Create/update access token file',
+                'with value of \'-c\' option') do |_|
+          options.init_token_file = true
+        end
         opts.on('-k', '--key-id [KEY_ID]', 'When action is GET, fetch value',
                 ' for this KEY_ID') do |ext|
           options.key_id = ext || ''

data/lib/keystok/version.rb

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

data/spec/functional/cli_spec.rb

@@ -4,6 +4,7 @@
 # for details.
 
 require 'spec_helper'
+require 'hashie'
 
 describe Keystok::CLI do
   let(:cli) { Keystok::CLI.new }
@@ -108,6 +109,48 @@ describe Keystok::CLI do
         expect(error.status).to eq(1)
       }
     end
+
+    context 'launch init_token_file' do
+      let(:tmp_access_token_filepath) do
+        access_token_file = Tempfile.new('keystok_tests')
+        FileUtils.cp(access_token_filepath, access_token_file.path)
+        access_token_file.path
+      end
+
+      it "when 'init_token_file', 'access_token' is supplied" do
+        expect(cli).to receive(:init_token_file).and_call_original
+        cli.run(["-f#{tmp_access_token_filepath}", "-c#{access_token}", '-i'])
+      end
+
+      it "don't run when 'init_token_file' is not set" do
+        expect(cli).to_not receive(:init_token_file)
+        cli.run(["-f#{tmp_access_token_filepath}", "-c#{access_token}"])
+      end
+
+      it "don't run when 'access_token' is not supplied" do
+        expect(cli).to_not receive(:init_token_file)
+        cli.run(["-f#{tmp_access_token_filepath}", '-i'])
+      end
+    end
+  end
+
+  describe 'choose_access_token' do
+    it "return access token passed as 'options.access_token'" do
+      options = Hashie::Mash.new(access_token: 'dummy_token')
+      expect(cli.send(:choose_access_token, options)).to eq('dummy_token')
+    end
+
+    it "return access token passed as 'options.access_token_filepath'" do
+      options = Hashie::Mash.new(access_token_filepath: access_token_filepath)
+      config_hash = YAML.load_file(access_token_filepath)
+      expect(cli.send(:choose_access_token, options)).to eq(config_hash)
+    end
+
+    it "preffer 'options.access_token' over 'options.access_token_filepath'" do
+      options = Hashie::Mash.new(access_token: 'dummy_token',
+                                 access_token_filepath: access_token_filepath)
+      expect(cli.send(:choose_access_token, options)).to eq('dummy_token')
+    end
   end
 
   describe 'dump_data' do
@@ -183,6 +226,39 @@ describe Keystok::CLI do
     end
   end
 
+  describe 'init_token_file' do
+    let(:tmp_filepath) { Tempfile.new('keystok_tests') }
+
+    it 'writes config file' do
+      cli.send(:init_token_file, some_string, "#{tmp_filepath.path}_new")
+      loaded_file = YAML.load_file("#{tmp_filepath.path}_new")
+      expect(loaded_file[:access_token]).to eq(some_string)
+    end
+
+    it 'writes config file even when file is empty' do
+      cli.send(:init_token_file, some_string, tmp_filepath.path)
+      loaded_file = YAML.load_file(tmp_filepath.path)
+      expect(loaded_file[:access_token]).to eq(some_string)
+    end
+
+    it 'updates existing config file' do
+      tmp_filepath.write({ access_token: 'dummy' }.to_yaml)
+      tmp_filepath.rewind
+      cli.send(:init_token_file, some_string, tmp_filepath.path)
+      loaded_file = YAML.load_file(tmp_filepath.path)
+      expect(loaded_file[:access_token]).to eq(some_string)
+    end
+
+    it "don't change other keys in updated config file" do
+      tmp_filepath.write({ my_another_key: 'dummy' }.to_yaml)
+      tmp_filepath.rewind
+      cli.send(:init_token_file, some_string, tmp_filepath.path)
+      loaded_file = YAML.load_file(tmp_filepath.path)
+      expect(loaded_file[:access_token]).to eq(some_string)
+      expect(loaded_file[:my_another_key]).to eq('dummy')
+    end
+  end
+
   describe 'parse' do
     context 'default values' do
       [['command', :get],
@@ -235,6 +311,17 @@ describe Keystok::CLI do
       end
     end
 
+    context '--init-token-file' do
+      it "set 'init_token_file'" do
+        expect(cli.send(:parse, %w(--init-token-file)).init_token_file)
+          .to eq(true)
+      end
+
+      it "recognize '-i'" do
+        expect(cli.send(:parse, ['-i']).init_token_file).to eq(true)
+      end
+    end
+
     context '--dump-format-type' do
       it "set 'dump_format'" do
         expect(cli.send(:parse, %w(--dump-format-type yaml)).dump_format)

data/test_all_rubies.sh

@@ -0,0 +1,21 @@
+#!/bin/bash -e
+
+versions=("1.9.3" "2.0.0-p353" "2.0.0-p451" "2.1.0" "2.1.1" "ruby-head")
+echo "================"
+echo "Installing dependencies:"
+echo "================"
+for version in "${versions[@]}"
+do
+echo "================"
+  echo "$version:"
+  rvm $version exec bundle install
+done
+echo "================"
+echo "Running tests:"
+echo "================"
+for version in "${versions[@]}"
+do
+echo "================"
+  echo "$version:"
+  rvm $version exec bundle exec rspec spec
+done

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keystok
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Piotr Sokolowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,7 @@ files:
 - spec/integration/rails_integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/webmock_helpers.rb
+- test_all_rubies.sh
 homepage: https://keystok.com
 licenses:
 - GitDock Oy