server_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83912df73bcdbd70f0ce5eac116555996c082697
+  data.tar.gz: e97bd645bf4c53a24337a0765ffcba5f47fdf40c
+SHA512:
+  metadata.gz: 2b1f4bcd7f69204e9a62b910797c2aa2b0a58cf75ae9f9580633ffc726bdf28d5969a50d8be07926817e05cfba88c8dc2914d0525b8f2cafea12d774153b0af6
+  data.tar.gz: 09993ce27d7bc5c793a18c2d34a183dc997e64f19724655e34a75268401c8d8143d00d54a3a480f19054a20556785568c7b3577cd53bb2b1adcf64db6a3a4bb0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Change Log
+
+## [v0.0.7](https://github.com/monsterstrike/server_settings/tree/v0.0.7) (2015-07-28)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.6...v0.0.7)
+
+**Merged pull requests:**
+
+- Support capistrano3 [\#18](https://github.com/monsterstrike/server_settings/pull/18) ([hirocaster](https://github.com/hirocaster))
+
+## [v0.0.6](https://github.com/monsterstrike/server_settings/tree/v0.0.6) (2015-06-18)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.5...v0.0.6)
+
+**Merged pull requests:**
+
+- Add ServerSettings::Database and db iterator [\#16](https://github.com/monsterstrike/server_settings/pull/16) ([osamu](https://github.com/osamu))
+
+- Raise error duplicate role [\#12](https://github.com/monsterstrike/server_settings/pull/12) ([osamu](https://github.com/osamu))
+
+## [v0.0.5](https://github.com/monsterstrike/server_settings/tree/v0.0.5) (2015-06-03)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.4...v0.0.5)
+
+**Merged pull requests:**
+
+- Add hosts exception [\#15](https://github.com/monsterstrike/server_settings/pull/15) ([osamu](https://github.com/osamu))
+
+## [v0.0.4](https://github.com/monsterstrike/server_settings/tree/v0.0.4) (2015-05-25)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.3...v0.0.4)
+
+**Closed issues:**
+
+- Rendering YAML using ERB [\#9](https://github.com/monsterstrike/server_settings/issues/9)
+
+**Merged pull requests:**
+
+- Add yaml erb rendering [\#10](https://github.com/monsterstrike/server_settings/pull/10) ([osamu](https://github.com/osamu))
+
+## [v0.0.3](https://github.com/monsterstrike/server_settings/tree/v0.0.3) (2015-05-19)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.2...v0.0.3)
+
+**Merged pull requests:**
+
+- Fix cap role definition for ServerSettings::HostCollection [\#8](https://github.com/monsterstrike/server_settings/pull/8) ([osamu](https://github.com/osamu))
+
+- Capistrano server loader task can load from directory pattern [\#7](https://github.com/monsterstrike/server_settings/pull/7) ([osamu](https://github.com/osamu))
+
+- Fix spec filename [\#6](https://github.com/monsterstrike/server_settings/pull/6) ([osamu](https://github.com/osamu))
+
+## [v0.0.2](https://github.com/monsterstrike/server_settings/tree/v0.0.2) (2015-05-14)
+
+[Full Changelog](https://github.com/monsterstrike/server_settings/compare/v0.0.1...v0.0.2)
+
+**Closed issues:**
+
+- compliant with naming rules for rubygems [\#4](https://github.com/monsterstrike/server_settings/issues/4)
+
+**Merged pull requests:**
+
+- Rename gem package server\_settings [\#5](https://github.com/monsterstrike/server_settings/pull/5) ([osamu](https://github.com/osamu))
+
+- \[Fix\]  Rename gemspec [\#3](https://github.com/monsterstrike/server_settings/pull/3) ([osamu](https://github.com/osamu))
+
+- Split files for each module [\#2](https://github.com/monsterstrike/server_settings/pull/2) ([osamu](https://github.com/osamu))
+
+## [v0.0.1](https://github.com/monsterstrike/server_settings/tree/v0.0.1) (2015-05-14)
+
+**Merged pull requests:**
+
+- Add availability azone [\#1](https://github.com/monsterstrike/server_settings/pull/1) ([osamu](https://github.com/osamu))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Osamu MATSUMOTO
+
+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,202 @@
+# ServerSettings
+
+ServerSettings is useful configuration scheme for any where.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'server_settings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install server_settings
+
+## Usage
+
+### Prepare
+First of all, you must define servers and role in YAML
+
+```yaml
+(rolename):
+  (option_param): (option_value)
+  (...)
+  hosts:
+    - host1
+    - host2
+```
+Then, You can load yaml files.
+
+```ruby
+require 'server_settings'
+
+ServerSettings.load_config("path/to/yaml")
+```
+
+#### Load from directory
+If you have many roles and servers, you can split yaml file and put
+into directory.
+
+```ruby
+
+ServerSettings.load_config_dir("path/to/yamls-dir/*.yml")
+```
+
+### Render YAML with ERB
+When your server configuration has dynamic parameter, you can use ERB
+syntax in yaml.
+
+`load_config_dir()` will rendering  ERB template every time.
+Or  `load_from_yaml_erb()` also rendering ERB for yaml content
+
+### For Dalli
+
+```yaml
+memcached_servers:
+  port: 11211
+  hosts:
+    - 192.168.100.1
+    - 192.168.100.2
+```
+
+```ruby
+ServerSettings.load_config("config/production/server-config.yaml")
+
+ActiveSupport::Cache::DalliStore.new ServerSettings.memcached_servers.with_format("%host:%port"), options
+
+```
+
+### For Resque host
+```yaml
+redis_endpoint:
+  port: 6379
+  hosts:
+   - 192.168.100.1
+```
+When hosts have single record, host accessor return string value
+instend of Array.
+```
+Resque.redis = ServerSettings.redis_endpoint.with_format("%host:%port")
+
+```
+### For DB
+
+```yaml
+databases:
+  :adapter: mysql2
+  :encoding: utf8
+  :reconnect: true
+  :database: app
+  :pool: 10
+  :username: db_user1
+  :password: db_pass1
+  :master: 192.168.30.86
+  :backup: 192.168.30.85
+  db1:
+    :database: app_db1
+    :master: 192.168.30.86
+    :backup: 192.168.30.85
+    :slaves: [  192.168.30.87, 192.168.30.88 ]
+  group1:
+    db2:
+      :master: 192.168.30.86
+      :backup: 192.168.30.85
+```
+#### Access DB configuration
+```ruby
+ServerSettings.load_config("config/production/server-config.yaml")
+
+ServerSettings.databases.find("db1").config(:master)
+# => {:adapter=>"mysql2", :encoding=>"utf8", :reconnect=>true, :database=>"app_db1", :pool=>10, :username=>"db_user1", :password=>"db_pass1", :host=>"192.168.30.86"}
+ServerSettings.databases.find("db1").config(:backup)
+# => {:adapter=>"mysql2", :encoding=>"utf8", :reconnect=>true, :database=>"app_db1", :pool=>10, :username=>"db_user1", :password=>"db_pass1", :host=>"192.168.30.85"}
+ServerSettings.databases.find("db1").config(:slaves)
+# =>[ {:adapter=>"mysql2", :encoding=>"utf8", :reconnect=>true, :database=>"app_db1", :pool=>10, :username=>"db_user1", :password=>"db_pass1", :host=>"192.168.30.87"},
+# {:adapter=>"mysql2", :encoding=>"utf8", :reconnect=>true, :database=>"app_db1", :pool=>10, :username=>"db_user1", :password=>"db_pass1", :host=>"192.168.30.88"}]
+```
+#### Iterator for all db config
+```ruby
+ServerSettings.load_config("config/production/server-config.yaml")
+
+ServerSettings.databases.each do |db|
+  db.master      # => 192.168.30.86
+  db.backup      # => 192.168.30.85
+  db.slaves      # => [ 192.168.30.87, 192.168.30.88 ]
+  db.has_slave?  # => true
+  db.settings    # => {:adapter=>"mysql2", :encoding=>"utf8", :reconnect=>true, :database=>"app_db1", :pool=>10, :username=>"db_user1", :password=>"db_pass1"}
+end
+```
+
+#### Tasks for mysql
+
+If you use Rails, ServerSettings define following tasks.
+
+```ruby
+rake server_settings:db:create:execute  # Confirm and execute CREATE DATABASE for each new database
+rake server_settings:db:create:status   # Show status of new databases not created yet
+rake server_settings:db:drop            # Confirm and execute Drop DATABASE for all database
+```
+
+If not use Rails, you writes in `Rakefile` as follows, define tasks.
+
+```ruby
+require 'server_settings/tasks'
+```
+
+### For Rails
+
+When use Rails, place yaml file in the following pattern.
+
+ServerSettings autoload this yaml file and define roles.
+
+`#{Rails.root}/config/servers/#{Rails.env}/*.yml`
+
+### For Capistrano2
+```ruby
+require  'server_settings/capistrano'
+
+load_servers("config/production/*.yaml")
+
+```
+
+### For Capistrano3
+
+in Capfile
+
+```ruby
+require "capistrano/server_settings"
+```
+
+in deploy.rb
+
+```ruby
+load_servers("config/production/*.yaml")
+```
+
+## For other application configuration
+
+```ruby
+ServerSettings.load_config("config/production/server-config.yaml")
+ServerSettings.each_role do |role, config|
+  puts "#{role}, #{config.hosts}"
+end
+```
+
+```ruby
+puts ServerSettings.memcached_servers.to_a
+
+```
+## Contributing
+
+1. Fork it ( https://github.com/monsterstrike/server_settings/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/sample.rb

@@ -0,0 +1,53 @@
+require 'server_settings'
+require 'pp'
+
+yaml =<<EOF
+redis:
+  port: 6379
+  hosts:
+   - 192.168.100.1
+
+app:
+  protocol: http
+  user: hogehoge
+  port: 8080
+  hosts:
+   - 192.168.100.1
+   - 192.168.100.2
+   - 192.168.100.3:8000
+
+database:
+  :adapter: mysql2
+  :encoding: utf8
+  :reconnect: true
+  :database: dbname-master
+  :pool: 1
+  :username: user
+  :password: pass
+  :host: 192.168.100.1
+  master:
+    :host: 192.168.100.2
+  user:
+    :database: dbname-user
+    :host: 192.168.100.3
+EOF
+
+# Load Configuration
+ServerSettings.load_from_yaml(yaml)
+
+# Define Host format
+#ServerSettings.host_format[:default] = "%host:%port"
+#ServerSettings.host_format[:redis] = "redis://%host:%port"
+
+# Role and Host accessor
+p ServerSettings.app.hosts
+p ServerSettings.app.hosts.with_format("%protocol://%user@%host:%port")
+
+# Role Iterator
+ServerSettings.each_role do |role, role_config|
+  puts "#{role}"
+  puts role_config
+end
+
+# Database Configuration
+p ServerSettings.database.hosts

data/lib/capistrano/server_settings.rb

@@ -0,0 +1,8 @@
+require 'server_settings'
+
+def load_servers(pattern)
+  ServerSettings.load_config_dir(pattern)
+  ServerSettings.each_role do |role, hosts|
+    role role.to_sym, hosts.map(&:host)
+  end
+end

data/lib/server_settings.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+require 'yaml'
+require 'erb'
+require "server_settings/version"
+require "server_settings/host"
+require "server_settings/host_collection"
+require "server_settings/role"
+require "server_settings/role_db"
+require "server_settings/database"
+require "server_settings/database_config"
+require "server_settings/railtie" if defined? Rails
+
+class ServerSettings
+  attr_accessor :roles
+
+  ## Exceptions
+  class DuplicateRole < StandardError; end
+
+  def initialize
+    @roles = {}
+  end
+
+  def << (role)
+    raise DuplicateRole, "`#{role.name}' already defined" if @roles.has_key?(role.name)
+    @roles[role.name] = role
+  end
+
+  def each
+    @roles.each do |name, role|
+      yield(name, role)
+    end
+  end
+
+  def has_key?(role)
+    @roles.has_key?(role)
+  end
+
+  def method_missing(name, *args, &block)
+    key = name.to_s
+    return nil  unless has_key? key
+    @roles[key]
+  end
+
+  class << self
+
+    def load_config(file)
+      @loaded_files ||= {}
+      load_from_yaml_erb(IO.read(file))
+      @loaded_files[file] = File.mtime(file)
+    end
+
+    def load_config_dir(pattern)
+      Dir.glob(pattern) do |file|
+        load_config(file)
+      end
+    end
+
+    def load_from_yaml(yaml)
+      config = YAML.load(yaml)
+      config.each do |role, config|
+        instance << role_klass(config).new(role, config)
+      end
+    end
+
+    def load_from_yaml_erb(yaml, erb_binding: binding)
+      yaml =  ERB.new(yaml).result(erb_binding)
+      load_from_yaml(yaml)
+    end
+
+    def reload
+      @loaded_files.each do |file, updated_at|
+        if File.mtime(file) > updated_at
+          load_config(file)
+        end
+      end
+    end
+
+    def roles
+      instance.roles
+    end
+
+    def each_role
+      roles.each do |role, config|
+        yield(role, config.hosts)
+      end
+    end
+
+    def role_klass(config)
+      if config.has_key?("hosts")
+        Role
+      else
+        RoleDB
+      end
+    end
+
+    def destroy
+      @servers_config = nil
+      @loaded_files = nil
+    end
+
+    private
+
+    def instance
+      return @servers_config if @servers_config
+      @servers_config = self.new
+      return @servers_config
+    end
+
+    def method_missing(name, *args, &block)
+      instance.send(name, *args, &block)
+    end
+  end
+end