bbc-cosmos-tools-config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e8874cee85d4fd53b2c33173a143864e7298dde
+  data.tar.gz: 4b2d5c3aaa545245153ff264b2a69c69de18621d
+SHA512:
+  metadata.gz: da91f4582bc46f8bb59c3a94b87bbe30ca7cef8489988f05978a7be74162b51c4dea25e64cf3e833e872f5e0a8309d3e521707ec5e99c4ffce0089a62ea6a6b6
+  data.tar.gz: 3d5f3d24ccd3c241e6077679aa93682fdfca4e3126e41adfe1b8343ca973cd0233d4f23dfb45072d64795ca9546933198f6d11bafcb0f432d98e9a42b21039cc

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bbc-cosmos-config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steven Jack
+
+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,126 @@
+# BBC::Cosmos::Tools::Config
+
+This gem provides functionality to generate and push config to the cosmos platform.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bbc-cosmos-tools-config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bbc-cosmos-tools-config
+
+## Usage
+
+The gem expects a certain folder structure for the config files:
+
+#### Folder structure
+
+```bash
+ ├── configs
+ │   ├── {env_name (int/test/stage/live)}
+ │   │   ├── {project_name}.yaml
+ │   ├── app_config.yaml
+```
+
+an example of this would be:
+
+```bash
+ ├── configs
+ │   ├── int
+ │   │   ├── my_project.yaml
+ │   ├── test
+ │   │   ├── my_project.yaml
+ │   ├── stage
+ │   │   ├── my_project.yaml
+ │   ├── live
+ │   │   ├── my_project.yaml
+ │   ├── app_config.yaml
+```
+
+#### Project Config structure
+
+All of the configs are in yaml format, the project yaml has the following format:
+
+```yaml
+
+components:
+  "component_id":
+    a_config_key: "it's value"
+	another_key: "Another value"
+
+shared:
+  shared_key: "shared_value"
+
+```
+
+The config has a number of components under a project, and the shared key allows you to
+have shared config for the components. The config is built up from the shared data with
+the component config merged in afterwards.
+
+#### Application config
+
+There's also an application config that stores data used by the app, at the moment this
+is only the api endpoints.
+
+```yaml
+bbc:
+  cosmos:
+    api: "https://www.my.api.com"
+	endpoint: "/some/restful/endpoint"
+```
+
+The gem is a cli application and currently has two functions:
+
+### Generating config
+
+```bash
+bbc-cosmos-tools-config generate {project_name} [{component_id = nil, environment = 'int' --cosmos_format]
+```
+
+`project_name`
+The project name is required, the other parameters are optional.
+
+`component_id`
+This is the id of the component in the components block of the project config. If you omit the component id then all components for the project are output.
+
+`environment`
+This maps to the folder underneath the configs directory, is omitted `int` is chosen as default.
+
+`--cosmos_output`
+As the cosmos API requires a slightly different JSON structure, you can have it formatted this way by passing this flag.
+
+### Pushing config
+
+```bash
+bbc-cosmos-tools-config push {project_name} [{cert_path = nil, component_id = nil, environment = 'int' --force]
+```
+
+`project_name`
+The project name is required, the other parameters are optional.
+
+`cert_path`
+This is the path to a valid client cert that can authenticate with the supplied API.
+
+`component_id`
+This is the id of the component in the components block of the project config. If you omit the component id then all components for the project have their configs updated.
+
+`environment`
+This maps to the folder underneath the configs directory, is omitted `int` is chosen as default.
+
+`--force`
+By default, before pushing changes to the API you're asked to confirm the action - This flag removes that confirmation.
+
+## 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 @@
+require "bundler/gem_tasks"

data/bbc-cosmos-tools-config.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bbc/cosmos/tools/config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbc-cosmos-tools-config"
+  spec.version       = Bbc::Cosmos::Tools::Config::VERSION
+  spec.authors       = ["Steven Jack"]
+  spec.email         = ["stevenmajack@gmail.com"]
+  spec.description   = %q{Tool for generating and pushing config to BBC Cosmos platform}
+  spec.summary       = %q{Tool for generating and pushing config to BBC Cosmos platform}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   << 'bbc-cosmos-tools-config'
+  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_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'faraday'
+end

data/bin/bbc-cosmos-tools-config

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+root        = Pathname.new(__FILE__).dirname.parent
+lib_path    = (root + 'lib').realdirpath
+config_path = root + 'configs'
+
+$LOAD_PATH.unshift(lib_path)
+
+require 'bbc/cosmos/tools/config/app'
+include BBC::Cosmos::Tools::Config
+
+App.start

data/lib/bbc/cosmos/tools/config.rb

@@ -0,0 +1,9 @@
+require "bbc/cosmos/config/version"
+
+module Bbc
+  module Cosmos
+    module Config
+      # Your code goes here...
+    end
+  end
+end

data/lib/bbc/cosmos/tools/config/api.rb

@@ -0,0 +1,40 @@
+require 'pathname'
+require 'faraday'
+require 'openssl'
+
+module BBC
+  module Cosmos
+    module Tools
+      module Config
+        class API
+
+          def initialize(host, key_path)
+            @connection = Faraday.new host, :ssl => {:client_key => client_key(key_path), :client_cert  => client_cert(key_path), :verify => false }
+          end
+
+          def client_key(path)
+            OpenSSL::PKey::RSA.new(File.read path)
+          end
+
+          def client_cert(path)
+            OpenSSL::X509::Certificate.new(File.read path)
+          end
+
+          def get(path)
+            @connection.get path
+          end
+
+          def put(path, payload, content_type = 'application/json')
+            content_type_from content_type
+            @connection.put path, payload
+          end
+
+          def content_type_from(type)
+            @connection.headers[:content_type] = type
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/config/app.rb

@@ -0,0 +1,117 @@
+require "thor"
+require "json"
+require "bbc/cosmos/tools/config/project_config"
+require "bbc/cosmos/tools/config/configuration"
+require "bbc/cosmos/tools/config/api"
+require "pathname"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Config
+        class App < Thor
+          include Thor::Actions
+
+          def initialize(args = [], local_options = {}, config = {})
+            super(args, local_options, config)
+          end
+
+          package_name "BBC Cosmos config tool"
+
+          desc "generate PROJECT COMPONENT_ID (--cosmos_format, --env", "Generates the cosmos config for a given component id"
+          method_options :cosmos_format => :boolean, :config => :string
+          method_option :env, :type => :string, :default => 'int'
+          def generate(project, component_id)
+            begin
+              config_base(options[:config])
+              config = config_from(project, options[:env])
+
+              say "\nComponent: #{component_id}\nProject: #{project}\nEnvironement: #{options[:env]}\n", :green
+              if options[:cosmos_format]
+                say JSON.pretty_generate(config.generate_cosmos component_id)
+              else
+                say JSON.pretty_generate(config.generate component_id)
+              end
+            rescue Exception => e
+              error e.message
+            end
+
+          end
+
+          desc "list PROJECT (--config, --env)", "Lists all components for a given project"
+          method_options :config => :string
+          method_option :env, :type => :string, :default => 'int'
+          def list(project)
+            begin
+              config_base(options[:config])
+              config = config_from(project, options[:env])
+
+              say "\nComponents: \n", :green
+              config.components.each do |component_id|
+                say "#{component_id}", :blue
+              end
+            rescue Exception => e
+              error e.message
+            end
+
+          end
+
+          desc "push PROJECT KEY_PATH = nil COMPONENT = nil (--force, --config, --env)", "Push config for a component to the cosmos API"
+          method_options :force => :boolean, :config => :string
+          method_option :env, :type => :string, :default => 'int'
+          def push(project, key_path = nil, component_id = nil)
+            begin
+              config_base(options[:config])
+              config = config_from(project, options[:env])
+              components = component_id.nil? ? config.components : [component_id]
+
+              reply = yes?("Are you sure you want to push changes for #{components.length} components(s) to #{options[:env]}?", :blue) unless options[:force]
+              if reply || reply.nil?
+
+                components.each do |id|
+                  cosmos_config = JSON.generate(config.generate_cosmos id)
+
+                  @api = BBC::Cosmos::Tools::Config::API.new(app_config['api'], key_path)
+                  response = @api.put sprintf(app_config['endpoint'], options[:env], id), cosmos_config
+
+                  if response.success?
+                    say "Configuration for component '#{id}' successfully saved", :green
+                  else
+                    say "There was an error saving your config: #{response.body}", :red
+                  end
+                end
+
+              else
+                say "Action cancelled", :red
+              end
+
+            rescue Exception => e
+              error e.message
+            end
+          end
+
+          private
+
+          def error(message)
+            say message, :red
+            exit 1
+          end
+
+          def config_from(project, env)
+            BBC::Cosmos::Tools::Config::ProjectConfig.new(@config_base, project, env)
+          end
+
+          def app_config
+            @app_config ||= BBC::Cosmos::Tools::Config::Configuration::get(@config_base)['bbc']['cosmos']
+          end
+
+          def config_base(override = nil)
+            @config_base = !override.nil? && File.directory?(override) ? Pathname.new(override) : Pathname.pwd.join('configs')
+            raise("Config directory doesn't exist") unless File.directory?(@config_base)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/config/configuration.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+module BBC
+  module Cosmos
+    module Tools
+      module Config
+        class Configuration
+
+          def self.get(config_base)
+            config_path = config_base.join('app.yaml')
+            raise('Invalid application config path') unless File.exists? config_path
+            YAML::load(File.open(config_path).read)
+          end
+
+        end
+      end
+    end
+  end
+end
+
+

data/lib/bbc/cosmos/tools/config/project_config.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+require 'yaml'
+
+module BBC
+  module Cosmos
+    module Tools
+      module Config
+        class ProjectConfig
+
+          def initialize(config_path, project, env = 'int')
+            @project = project
+            @env = env
+            @config_path = config_path
+          end
+
+          def components
+            config['components'].keys
+          end
+
+          def generate(id)
+            component_config id
+          end
+
+          def generate_cosmos(id)
+            generate(id).reduce([]) do |object, (key, value)|
+              object.tap { |o| o << {:value => value, :key => key} }
+            end
+          end
+
+          private
+
+          def environment_exists?
+            File.directory? File.join(@config_path, @env)
+          end
+
+          def config_path
+            if environment_exists?
+              path = File.join(@config_path, @env, "#{@project}.yaml")
+              if File.exist? path
+                File.open(path).read
+              else
+                raise("#{@project} isn't a valid project")
+              end
+            else
+              raise("#{@env} is an invalid environment")
+            end
+          end
+
+          def config
+            @config ||= YAML::load(config_path)
+          end
+
+          def component_config(id)
+            raise('Invalid component id') if config['components'][id].nil?
+            config['components'][id]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/config/version.rb

@@ -0,0 +1,9 @@
+module Bbc
+  module Cosmos
+    module Tools
+      module Config
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bbc-cosmos-tools-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Jack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tool for generating and pushing config to BBC Cosmos platform
+email:
+- stevenmajack@gmail.com
+executables:
+- bbc-cosmos-tools-config
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbc-cosmos-tools-config.gemspec
+- bin/bbc-cosmos-tools-config
+- lib/bbc/cosmos/tools/config.rb
+- lib/bbc/cosmos/tools/config/api.rb
+- lib/bbc/cosmos/tools/config/app.rb
+- lib/bbc/cosmos/tools/config/configuration.rb
+- lib/bbc/cosmos/tools/config/project_config.rb
+- lib/bbc/cosmos/tools/config/version.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Tool for generating and pushing config to BBC Cosmos platform
+test_files: []