aws_config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90a1710b76b6e09202d4bc95b4ea77801ee6a865
+  data.tar.gz: c6af0011cc599b646c641d1ad93d877cd14d8ceb
+SHA512:
+  metadata.gz: 4e8e3e64cb3a746c0526f7db46ce3f79e5eedc079af10569ebe07fbc15f18137f1b056b0b4cf00c0153cc9f392b56b04dd64f364152d900125a0636ecd618b71
+  data.tar.gz: 5cd3f06e02c3115842a0729f16cc0bc0a2708614aa171e077cf9299a6c9f162299dc0831e4a7dea7adc06724bdbb5445092792ac77632d0299c14edae6a641d9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Masato Ikeda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# AWSConfig
+
+AWSConfig is a parser for AWS_CONFIG_FILE used in [aws-cli](https://github.com/aws/aws-cli).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aws_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aws_config
+
+## Usage
+
+It parses `~/.aws/config` by default.
+
+If you put a config file like:
+
+    [default]
+    aws_access_key_id=DefaultAccessKey01
+    aws_secret_access_key=Default/Secret/Access/Key/02
+    # Optional, to define default region for this profile.
+    region=us-west-1
+
+    [profile testing]
+    aws_access_key_id=TestingAccessKey03
+    aws_secret_access_key=Testing/Secret/Access/Key/04
+    region=us-west-2
+
+you can access it like:
+
+    require "aws_config"
+    
+    puts AWSConfig.default.aws_access_key_id    #=> DefaultAccessKey01
+    puts AWSConfig.default.region               #=> Default/Secret/Access/Key/02
+
+also you can do like hashes:
+
+    puts AWSConfig["default"]["aws_access_key_id"]  #=> DefaultAccessKey01
+    puts AWSConfig["default"]["region"]             #=> Default/Secret/Access/Key/02
+
+If you want to use with aws-sdk-ruby, you can configure like:
+
+    AWS.config(AWSConfig.default.config_hash)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+ 
+task :default => :spec
+ 
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)

data/aws_config.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aws_config"
+  spec.version       = AWSConfig::VERSION
+  spec.authors       = ["Masato Ikeda"]
+  spec.email         = ["masato.ikeda@gmail.com"]
+  spec.description   = %q{AWSConfig is a parser for AWS_CONFIG_FILE used in aws-cli.}
+  spec.summary       = %q{AWSConfig is a parser for AWS_CONFIG_FILE used in aws-cli.}
+  spec.homepage      = "https://github.com/a2ikm/aws_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/aws_config/parser.rb

@@ -0,0 +1,71 @@
+require "strscan"
+require "aws_config/profile"
+
+module AWSConfig
+  class Parser
+    def self.parse(string)
+      new.parse(string)
+    end
+
+    def parse(string)
+      wrap(build(tokenize(string)))
+    end
+
+    private
+      
+      def tokenize(string)
+        s = StringScanner.new(string)
+        tokens  = []
+
+        until s.eos?
+          if s.scan(/\[\s*([^\]]+)\s*\]/)
+            if s[1] == "default"
+              tokens << [:profile, "default"]
+            elsif m = s[1].match(/profile\s+([^\s]+)$/)
+              tokens << [:profile, m[1]]
+            else
+              raise "Invalid profile sectioning"
+            end
+          elsif s.scan(/([^\s=#]+)\s*=\s*([^\s#]+)/)
+            tokens << [:key_value, s[1], s[2]]
+          elsif s.scan(/#[^\n]*/)
+          elsif s.scan(/\s+/)
+          elsif s.scan(/\n+/)
+          else
+            s.scan(/./)
+            raise "Invalid token `#{s[0]}` as #{s.pos}"
+          end
+        end
+
+        tokens
+      end
+
+      def build(tokens)
+        tokens = tokens.dup
+        profiles = {}
+        profile = nil
+
+        while values = tokens.shift
+          head = values.shift
+
+          case head
+          when :profile
+            profile = profiles[values[0]] ||= {}
+          when :key_value
+            if profile
+              profile[values[0]] = values[1]
+            end
+          end
+        end
+
+        profiles
+      end
+
+      def wrap(profiles)
+        profiles.inject({}) do |s, (name, properties)|
+          s[name] = Profile.new(name, properties)
+          s
+        end
+      end
+  end
+end

data/lib/aws_config/profile.rb

@@ -0,0 +1,44 @@
+module AWSConfig
+  class Profile
+    attr_reader :name, :entries
+
+    def initialize(name, entries)
+      @name    = name.to_s
+      @entries = entries
+    end
+
+    def [](key)
+      key = key.to_s
+      if entries.has_key?(key)
+        entries[key]
+      else
+        nil
+      end
+    end
+
+    def has_key?(key)
+      key = key.to_s
+      entries.has_key?(key)
+    end
+
+    def respond_to?(id, include_all = false)
+      has_key?(id) || super
+    end
+
+    def method_missing(id, *args)
+      if has_key?(id)
+        self[id]
+      else
+        super
+      end
+    end
+
+    def config_hash
+      {
+        access_key_id:      entries["aws_access_key_id"],
+        secret_access_key:  entries["aws_secret_access_key"],
+        region:             entries["region"]
+      }
+    end
+  end
+end

data/lib/aws_config/store.rb

@@ -0,0 +1,38 @@
+module AWSConfig
+  module Store
+    def profiles
+      @profiles ||= begin
+        Parser.parse(File.read(config_file))
+      end
+    end
+
+    def config_file
+      @config_file || ENV["AWS_CONFIG_FILE"] || File.join(ENV["HOME"], ".aws/config")
+    end
+
+    def config_file=(path)
+      @config_file = path
+      @profiles = nil
+    end
+
+    def [](profile)
+      profiles[profile.to_s]
+    end
+
+    def has_profile?(profile)
+      profiles.has_key?(profile.to_s)
+    end
+
+    def respond_to?(id, include_all = false)
+      has_profile?(id) || super
+    end
+
+    def method_missing(id, *args)
+      if has_profile?(id)
+        self[id]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/aws_config/version.rb

@@ -0,0 +1,3 @@
+module AWSConfig
+  VERSION = "0.0.1"
+end

data/lib/aws_config.rb

@@ -0,0 +1,7 @@
+require "aws_config/version"
+require "aws_config/parser"
+require "aws_config/store"
+
+module AWSConfig
+  extend Store
+end

data/spec/lib/aws_config/parser_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+
+describe AWSConfig::Parser do
+  describe "#tokenize" do
+    subject { described_class.new.send(:tokenize, string) }
+
+    context "only default profile" do
+      let(:string) { <<-EOC }
+[default]
+aws_access_key_id=DefaultAccessKey01
+aws_secret_access_key=Default/Secret/Access/Key/02
+region=us-west-1
+      EOC
+      it { should eq [
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",      "DefaultAccessKey01"],
+        [:key_value,  "aws_secret_access_key",  "Default/Secret/Access/Key/02"],
+        [:key_value,  "region",                 "us-west-1"]
+      ] }
+    end
+
+    context "default and named profiles" do
+      let(:string) { <<-EOC }
+[default]
+aws_access_key_id=DefaultAccessKey01
+
+[profile testing]
+aws_access_key_id=TestingAccessKey03
+      EOC
+      it { should eq [
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",  "DefaultAccessKey01"],
+        [:profile,    "testing"],
+        [:key_value,  "aws_access_key_id",  "TestingAccessKey03"],
+      ] }
+
+      context "Comment line" do
+        let(:string) { <<-EOC }
+[default]
+# THIS IS COMMENT #
+aws_access_key_id=DefaultAccessKey01
+        EOC
+        it { should eq [
+          [:profile,    "default"],
+          [:key_value,  "aws_access_key_id",  "DefaultAccessKey01"]
+        ] }
+      end
+
+      context "Blank line" do
+        let(:string) { <<-EOC }
+[default]
+
+
+aws_access_key_id=DefaultAccessKey01
+        EOC
+        it { should eq [
+          [:profile,    "default"],
+          [:key_value,  "aws_access_key_id",  "DefaultAccessKey01"]
+        ] }
+      end
+    end
+  end
+
+  describe "#build" do
+    subject { described_class.new.send(:build, tokens) }
+
+    context "Single profile" do
+      let(:tokens) { [
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",      "DefaultAccessKey01"], 
+        [:key_value,  "aws_secret_access_key",  "Default/Secret/Access/Key/02"],
+        [:key_value,  "region",                 "us-west-1"]
+      ] }
+      it { should eq({
+        "default" => {
+          "aws_access_key_id"     => "DefaultAccessKey01",
+          "aws_secret_access_key" => "Default/Secret/Access/Key/02",
+          "region"                => "us-west-1"
+        }
+      }) }
+    end
+
+    context "Multi profiles" do
+      let(:tokens) { [
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",  "DefaultAccessKey01"], 
+        [:profile,    "testing"],
+        [:key_value,  "aws_access_key_id",  "TestingAccessKey02"], 
+      ] }
+      it { should eq({
+        "default" => { "aws_access_key_id" => "DefaultAccessKey01" },
+        "testing" => { "aws_access_key_id" => "TestingAccessKey02" }
+      }) }
+    end
+
+    context "Twice-defined single profile" do
+      let(:tokens) { [
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",      "DefaultAccessKey01"], 
+        [:key_value,  "region",                 "us-west-1"],
+        [:profile,    "default"],
+        [:key_value,  "aws_access_key_id",      "DefaultAccessKey01_ANOTHER"], 
+        [:key_value,  "aws_secret_access_key",  "Default/Secret/Access/Key/01"], 
+      ] }
+      it { should eq({
+        "default" => {
+          "aws_access_key_id"     => "DefaultAccessKey01_ANOTHER",
+          "aws_secret_access_key" => "Default/Secret/Access/Key/01",
+          "region"                => "us-west-1"
+        }
+      }) }
+    end
+  end
+
+  describe "#wrap" do
+    subject { described_class.new.send(:wrap, profiles) }
+
+    context "Single profile" do
+      let(:profiles) {
+        {
+          "default" => {
+            "aws_access_key_id"     => "DefaultAccessKey01",
+            "aws_secret_access_key" => "Default/Secret/Access/Key/02",
+            "region"                => "us-west-1"
+          }
+        }
+      }
+      it { should be_a Hash }
+      it { should have_key "default" }
+      it "should have AWSConfig::Profile as value" do
+        expect(subject["default"]).to be_a AWSConfig::Profile
+      end
+    end
+  end
+end

data/spec/lib/aws_config/profile_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe AWSConfig::Profile do
+  subject {
+    AWSConfig::Profile.new(
+      "default",
+      "aws_access_key_id"     => "DefaultAccessKey01",
+      "aws_secret_access_key" => "Default/Secret/Access/Key/02",
+      "region"                => "us-west-1"
+    )
+  }
+
+  it "should return given name via method" do
+    expect(subject.name).to eq "default"
+  end
+
+  it "should respond to methods whose names are same as given entries" do
+    expect(subject).to respond_to :aws_access_key_id
+    expect(subject).to respond_to :aws_secret_access_key
+    expect(subject).to respond_to :region
+  end
+
+  it "should return given entries via methods" do
+    expect(subject.aws_access_key_id).to eq "DefaultAccessKey01"
+    expect(subject.aws_secret_access_key).to eq "Default/Secret/Access/Key/02"
+    expect(subject.region).to eq "us-west-1"
+  end
+
+  it "should return given entries via hash-like methods" do
+    expect(subject[:aws_access_key_id]).to eq "DefaultAccessKey01"
+    expect(subject[:aws_secret_access_key]).to eq "Default/Secret/Access/Key/02"
+    expect(subject[:region]).to eq "us-west-1"
+  end
+
+  it "should raise exceptions if unknown entry is called via methods" do
+    expect { subject.unknown_method }.to raise_error NoMethodError
+  end
+
+  it "should return a hash for aws-sdk-ruby's configuration format" do
+    expect(subject.config_hash).to eq({
+      access_key_id:      "DefaultAccessKey01",
+      secret_access_key:  "Default/Secret/Access/Key/02",
+      region:             "us-west-1"
+    })
+  end
+end

data/spec/lib/aws_config_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe AWSConfig do
+  let(:sample_config_file) { File.expand_path("../../samples/config.txt", __FILE__) }
+  before { AWSConfig.config_file = sample_config_file }
+
+  it "should return an entry in a profile via method" do
+    expect(described_class.default.aws_access_key_id).to eq "DefaultAccessKey01"
+    expect(described_class.default.region).to eq "us-west-1"
+  end
+
+  it "should return an entry in a profile like hashes" do
+    expect(described_class["default"]["aws_access_key_id"]).to eq "DefaultAccessKey01"
+    expect(described_class["default"]["region"]).to eq "us-west-1"
+  end
+end

data/spec/samples/config.txt

@@ -0,0 +1,10 @@
+[default]
+aws_access_key_id=DefaultAccessKey01
+aws_secret_access_key=Default/Secret/Access/Key/02
+# Optional, to define default region for this profile.
+region=us-west-1
+
+[profile testing]
+aws_access_key_id=TestingAccessKey03
+aws_secret_access_key=Testing/Secret/Access/Key/04
+region=us-west-2

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "aws_config"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: aws_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masato Ikeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
+description: AWSConfig is a parser for AWS_CONFIG_FILE used in aws-cli.
+email:
+- masato.ikeda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws_config.gemspec
+- lib/aws_config.rb
+- lib/aws_config/parser.rb
+- lib/aws_config/profile.rb
+- lib/aws_config/store.rb
+- lib/aws_config/version.rb
+- spec/lib/aws_config/parser_spec.rb
+- spec/lib/aws_config/profile_spec.rb
+- spec/lib/aws_config_spec.rb
+- spec/samples/config.txt
+- spec/spec_helper.rb
+homepage: https://github.com/a2ikm/aws_config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: AWSConfig is a parser for AWS_CONFIG_FILE used in aws-cli.
+test_files:
+- spec/lib/aws_config/parser_spec.rb
+- spec/lib/aws_config/profile_spec.rb
+- spec/lib/aws_config_spec.rb
+- spec/samples/config.txt
+- spec/spec_helper.rb