Class: AssetSync::Config
- Inherits:
-
Object
- Object
- AssetSync::Config
- Includes:
- ActiveModel::Validations
- Defined in:
- lib/asset_sync/config.rb
Defined Under Namespace
Classes: FileExtToMimeTypeOverrides, FogPublicValue, Invalid
Instance Attribute Summary collapse
-
#always_upload ⇒ Object
Returns the value of attribute always_upload.
-
#aws_access_key_id ⇒ Object
Amazon AWS.
-
#aws_iam_roles ⇒ Object
Amazon AWS.
-
#aws_reduced_redundancy ⇒ Object
Amazon AWS.
-
#aws_secret_access_key ⇒ Object
Amazon AWS.
-
#aws_session_token ⇒ Object
Amazon AWS.
-
#aws_signature_version ⇒ Object
Amazon AWS.
-
#azure_storage_access_key ⇒ Object
Returns the value of attribute azure_storage_access_key.
-
#azure_storage_account_name ⇒ Object
Azure Blob with Fog::AzureRM.
-
#cache_asset_regexps ⇒ Object
Returns the value of attribute cache_asset_regexps.
-
#cdn_distribution_id ⇒ Object
Returns the value of attribute cdn_distribution_id.
-
#concurrent_uploads ⇒ Object
Returns the value of attribute concurrent_uploads.
-
#concurrent_uploads_max_threads ⇒ Object
Returns the value of attribute concurrent_uploads_max_threads.
-
#custom_headers ⇒ Object
Returns the value of attribute custom_headers.
-
#enabled ⇒ Object
Returns the value of attribute enabled.
-
#existing_remote_files ⇒ Object
AssetSync.
-
#fail_silently ⇒ Object
Returns the value of attribute fail_silently.
-
#fog_directory ⇒ Object
e.g.
-
#fog_host ⇒ Object
e.g.
-
#fog_path_style ⇒ Object
e.g.
-
#fog_port ⇒ Object
e.g.
-
#fog_provider ⇒ Object
FOG configuration.
-
#fog_public ⇒ Object
e.g.
-
#fog_region ⇒ Object
e.g.
-
#fog_scheme ⇒ Object
e.g.
-
#google_json_key_location ⇒ Object
when using service accounts.
-
#google_project ⇒ Object
when using service accounts.
-
#google_storage_access_key_id ⇒ Object
Google Storage.
-
#google_storage_secret_access_key ⇒ Object
Google Storage.
-
#gzip_compression ⇒ Object
Returns the value of attribute gzip_compression.
-
#ignored_files ⇒ Object
Returns the value of attribute ignored_files.
-
#include_manifest ⇒ Object
Returns the value of attribute include_manifest.
-
#invalidate ⇒ Object
Returns the value of attribute invalidate.
-
#log_silently ⇒ Object
Returns the value of attribute log_silently.
-
#manifest ⇒ Object
Returns the value of attribute manifest.
-
#prefix ⇒ Object
Returns the value of attribute prefix.
-
#rackspace_api_key ⇒ Object
Rackspace.
-
#rackspace_auth_url ⇒ Object
Rackspace.
-
#rackspace_username ⇒ Object
Rackspace.
-
#remote_file_list_cache_file_path ⇒ Object
Returns the value of attribute remote_file_list_cache_file_path.
-
#run_on_precompile ⇒ Object
Returns the value of attribute run_on_precompile.
Instance Method Summary collapse
- #add_local_file_paths(&block) ⇒ Object
- #additional_local_file_paths ⇒ Object
- #assets_prefix ⇒ Object
- #aws? ⇒ Boolean
- #aws_iam? ⇒ Boolean
- #aws_rrs? ⇒ Boolean
- #azure_rm? ⇒ Boolean
- #cache_asset_regexp=(cache_asset_regexp) ⇒ Object
- #enabled? ⇒ Boolean
- #existing_remote_files? ⇒ Boolean
- #fail_silently? ⇒ Boolean
- #file_ext_to_mime_type_overrides ⇒ Object
- #fog_options ⇒ Object
- #google? ⇒ Boolean
- #google_interop? ⇒ Boolean
- #google_service_account? ⇒ Boolean
- #gzip? ⇒ Boolean
-
#initialize ⇒ Config
constructor
A new instance of Config.
- #load_yml! ⇒ Object
- #log_silently? ⇒ Boolean
- #manifest_path ⇒ Object
- #public_path ⇒ Object
- #public_path=(path) ⇒ Object
- #rackspace? ⇒ Boolean
- #yml ⇒ Object
- #yml_exists? ⇒ Boolean
- #yml_path ⇒ Object
Constructor Details
#initialize ⇒ Config
Returns a new instance of Config.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/asset_sync/config.rb', line 73 def initialize self.fog_region = nil self.fog_public = true self.existing_remote_files = 'keep' self.gzip_compression = false self.manifest = false self.fail_silently = false self.log_silently = true self.always_upload = [] self.ignored_files = [] self.custom_headers = {} self.enabled = true self.run_on_precompile = true self.cdn_distribution_id = nil self.invalidate = [] self.cache_asset_regexps = [] self.include_manifest = false self.concurrent_uploads = false self.concurrent_uploads_max_threads = 10 self.remote_file_list_cache_file_path = nil @additional_local_file_paths_procs = [] load_yml! if defined?(::Rails) && yml_exists? end |
Instance Attribute Details
#always_upload ⇒ Object
Returns the value of attribute always_upload.
19 20 21 |
# File 'lib/asset_sync/config.rb', line 19 def always_upload @always_upload end |
#aws_access_key_id ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_access_key_id @aws_access_key_id end |
#aws_iam_roles ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_iam_roles @aws_iam_roles end |
#aws_reduced_redundancy ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_reduced_redundancy @aws_reduced_redundancy end |
#aws_secret_access_key ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_secret_access_key @aws_secret_access_key end |
#aws_session_token ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_session_token @aws_session_token end |
#aws_signature_version ⇒ Object
Amazon AWS
40 41 42 |
# File 'lib/asset_sync/config.rb', line 40 def aws_signature_version @aws_signature_version end |
#azure_storage_access_key ⇒ Object
Returns the value of attribute azure_storage_access_key.
56 57 58 |
# File 'lib/asset_sync/config.rb', line 56 def azure_storage_access_key @azure_storage_access_key end |
#azure_storage_account_name ⇒ Object
Azure Blob with Fog::AzureRM
55 56 57 |
# File 'lib/asset_sync/config.rb', line 55 def azure_storage_account_name @azure_storage_account_name end |
#cache_asset_regexps ⇒ Object
Returns the value of attribute cache_asset_regexps.
27 28 29 |
# File 'lib/asset_sync/config.rb', line 27 def cache_asset_regexps @cache_asset_regexps end |
#cdn_distribution_id ⇒ Object
Returns the value of attribute cdn_distribution_id.
26 27 28 |
# File 'lib/asset_sync/config.rb', line 26 def cdn_distribution_id @cdn_distribution_id end |
#concurrent_uploads ⇒ Object
Returns the value of attribute concurrent_uploads.
29 30 31 |
# File 'lib/asset_sync/config.rb', line 29 def concurrent_uploads @concurrent_uploads end |
#concurrent_uploads_max_threads ⇒ Object
Returns the value of attribute concurrent_uploads_max_threads.
30 31 32 |
# File 'lib/asset_sync/config.rb', line 30 def concurrent_uploads_max_threads @concurrent_uploads_max_threads end |
#custom_headers ⇒ Object
Returns the value of attribute custom_headers.
23 24 25 |
# File 'lib/asset_sync/config.rb', line 23 def custom_headers @custom_headers end |
#enabled ⇒ Object
Returns the value of attribute enabled.
22 23 24 |
# File 'lib/asset_sync/config.rb', line 22 def enabled @enabled end |
#existing_remote_files ⇒ Object
AssetSync
14 15 16 |
# File 'lib/asset_sync/config.rb', line 14 def existing_remote_files @existing_remote_files end |
#fail_silently ⇒ Object
Returns the value of attribute fail_silently.
17 18 19 |
# File 'lib/asset_sync/config.rb', line 17 def fail_silently @fail_silently end |
#fog_directory ⇒ Object
e.g. ‘the-bucket-name’
35 36 37 |
# File 'lib/asset_sync/config.rb', line 35 def fog_directory @fog_directory end |
#fog_host ⇒ Object
e.g. ‘s3.amazonaws.com’
41 42 43 |
# File 'lib/asset_sync/config.rb', line 41 def fog_host @fog_host end |
#fog_path_style ⇒ Object
e.g. true
43 44 45 |
# File 'lib/asset_sync/config.rb', line 43 def fog_path_style @fog_path_style end |
#fog_port ⇒ Object
e.g. ‘9000’
42 43 44 |
# File 'lib/asset_sync/config.rb', line 42 def fog_port @fog_port end |
#fog_provider ⇒ Object
FOG configuration
34 35 36 |
# File 'lib/asset_sync/config.rb', line 34 def fog_provider @fog_provider end |
#fog_public ⇒ Object
e.g. true, false, “default”
37 38 39 |
# File 'lib/asset_sync/config.rb', line 37 def fog_public @fog_public end |
#fog_region ⇒ Object
e.g. ‘eu-west-1’
36 37 38 |
# File 'lib/asset_sync/config.rb', line 36 def fog_region @fog_region end |
#fog_scheme ⇒ Object
e.g. ‘http’
44 45 46 |
# File 'lib/asset_sync/config.rb', line 44 def fog_scheme @fog_scheme end |
#google_json_key_location ⇒ Object
when using service accounts
51 52 53 |
# File 'lib/asset_sync/config.rb', line 51 def google_json_key_location @google_json_key_location end |
#google_project ⇒ Object
when using service accounts
52 53 54 |
# File 'lib/asset_sync/config.rb', line 52 def google_project @google_project end |
#google_storage_access_key_id ⇒ Object
Google Storage
50 51 52 |
# File 'lib/asset_sync/config.rb', line 50 def google_storage_access_key_id @google_storage_access_key_id end |
#google_storage_secret_access_key ⇒ Object
Google Storage
50 51 52 |
# File 'lib/asset_sync/config.rb', line 50 def google_storage_secret_access_key @google_storage_secret_access_key end |
#gzip_compression ⇒ Object
Returns the value of attribute gzip_compression.
15 16 17 |
# File 'lib/asset_sync/config.rb', line 15 def gzip_compression @gzip_compression end |
#ignored_files ⇒ Object
Returns the value of attribute ignored_files.
20 21 22 |
# File 'lib/asset_sync/config.rb', line 20 def ignored_files @ignored_files end |
#include_manifest ⇒ Object
Returns the value of attribute include_manifest.
28 29 30 |
# File 'lib/asset_sync/config.rb', line 28 def include_manifest @include_manifest end |
#invalidate ⇒ Object
Returns the value of attribute invalidate.
25 26 27 |
# File 'lib/asset_sync/config.rb', line 25 def invalidate @invalidate end |
#log_silently ⇒ Object
Returns the value of attribute log_silently.
18 19 20 |
# File 'lib/asset_sync/config.rb', line 18 def log_silently @log_silently end |
#manifest ⇒ Object
Returns the value of attribute manifest.
16 17 18 |
# File 'lib/asset_sync/config.rb', line 16 def manifest @manifest end |
#prefix ⇒ Object
Returns the value of attribute prefix.
21 22 23 |
# File 'lib/asset_sync/config.rb', line 21 def prefix @prefix end |
#rackspace_api_key ⇒ Object
Rackspace
47 48 49 |
# File 'lib/asset_sync/config.rb', line 47 def rackspace_api_key @rackspace_api_key end |
#rackspace_auth_url ⇒ Object
Rackspace
47 48 49 |
# File 'lib/asset_sync/config.rb', line 47 def rackspace_auth_url @rackspace_auth_url end |
#rackspace_username ⇒ Object
Rackspace
47 48 49 |
# File 'lib/asset_sync/config.rb', line 47 def rackspace_username @rackspace_username end |
#remote_file_list_cache_file_path ⇒ Object
Returns the value of attribute remote_file_list_cache_file_path.
31 32 33 |
# File 'lib/asset_sync/config.rb', line 31 def remote_file_list_cache_file_path @remote_file_list_cache_file_path end |
#run_on_precompile ⇒ Object
Returns the value of attribute run_on_precompile.
24 25 26 |
# File 'lib/asset_sync/config.rb', line 24 def run_on_precompile @run_on_precompile end |
Instance Method Details
#add_local_file_paths(&block) ⇒ Object
304 305 306 307 |
# File 'lib/asset_sync/config.rb', line 304 def add_local_file_paths(&block) @additional_local_file_paths_procs = additional_local_file_paths_procs + [block] end |
#additional_local_file_paths ⇒ Object
312 313 314 315 316 317 318 319 |
# File 'lib/asset_sync/config.rb', line 312 def additional_local_file_paths return [] if additional_local_file_paths_procs.empty? # Using `Array()` to ensure it works when single value is returned additional_local_file_paths_procs.each_with_object([]) do |proc, paths| paths.concat(Array(proc.call)) end end |
#assets_prefix ⇒ Object
172 173 174 175 |
# File 'lib/asset_sync/config.rb', line 172 def assets_prefix # Fix for Issue #38 when Rails.config.assets.prefix starts with a slash self.prefix || ::Rails.application.config.assets.prefix.sub(/^\//, '') end |
#aws? ⇒ Boolean
112 113 114 |
# File 'lib/asset_sync/config.rb', line 112 def aws? fog_provider =~ /aws/i end |
#aws_iam? ⇒ Boolean
120 121 122 |
# File 'lib/asset_sync/config.rb', line 120 def aws_iam? aws_iam_roles == true end |
#aws_rrs? ⇒ Boolean
116 117 118 |
# File 'lib/asset_sync/config.rb', line 116 def aws_rrs? aws_reduced_redundancy == true end |
#azure_rm? ⇒ Boolean
152 153 154 |
# File 'lib/asset_sync/config.rb', line 152 def azure_rm? fog_provider =~ /azurerm/i end |
#cache_asset_regexp=(cache_asset_regexp) ⇒ Object
156 157 158 |
# File 'lib/asset_sync/config.rb', line 156 def cache_asset_regexp=(cache_asset_regexp) self.cache_asset_regexps = [cache_asset_regexp] end |
#enabled? ⇒ Boolean
132 133 134 |
# File 'lib/asset_sync/config.rb', line 132 def enabled? enabled == true end |
#existing_remote_files? ⇒ Boolean
108 109 110 |
# File 'lib/asset_sync/config.rb', line 108 def existing_remote_files? ['keep', 'ignore'].include?(self.existing_remote_files) end |
#fail_silently? ⇒ Boolean
124 125 126 |
# File 'lib/asset_sync/config.rb', line 124 def fail_silently? fail_silently || !enabled? end |
#file_ext_to_mime_type_overrides ⇒ Object
322 323 324 |
# File 'lib/asset_sync/config.rb', line 322 def file_ext_to_mime_type_overrides @file_ext_to_mime_type_overrides ||= FileExtToMimeTypeOverrides.new end |
#fog_options ⇒ Object
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/asset_sync/config.rb', line 252 def = { :provider => fog_provider } if aws? if aws_iam? .merge!({ :use_iam_profile => true }) else .merge!({ :aws_access_key_id => aws_access_key_id, :aws_secret_access_key => aws_secret_access_key }) .merge!({:aws_session_token => aws_session_token}) if aws_session_token end .merge!({:host => fog_host}) if fog_host .merge!({:port => fog_port}) if fog_port .merge!({:scheme => fog_scheme}) if fog_scheme .merge!({:aws_signature_version => aws_signature_version}) if aws_signature_version .merge!({:path_style => fog_path_style}) if fog_path_style .merge!({:region => fog_region}) if fog_region elsif rackspace? .merge!({ :rackspace_username => rackspace_username, :rackspace_api_key => rackspace_api_key }) .merge!({ :rackspace_region => fog_region }) if fog_region .merge!({ :rackspace_auth_url => rackspace_auth_url }) if rackspace_auth_url elsif google? if google_json_key_location .merge!({:google_json_key_location => google_json_key_location, :google_project => google_project}) else .merge!({ :google_storage_secret_access_key => google_storage_secret_access_key, :google_storage_access_key_id => google_storage_access_key_id }) end .merge!({:region => fog_region}) if fog_region elsif azure_rm? require 'fog/azurerm' .merge!({ :azure_storage_account_name => azure_storage_account_name, :azure_storage_access_key => azure_storage_access_key, }) .merge!({:environment => fog_region}) if fog_region else raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS, Rackspace and Google are supported currently." end end |
#google? ⇒ Boolean
140 141 142 |
# File 'lib/asset_sync/config.rb', line 140 def google? fog_provider =~ /google/i end |
#google_interop? ⇒ Boolean
144 145 146 |
# File 'lib/asset_sync/config.rb', line 144 def google_interop? google? && google_json_key_location.nil? end |
#google_service_account? ⇒ Boolean
148 149 150 |
# File 'lib/asset_sync/config.rb', line 148 def google_service_account? google? && google_json_key_location end |
#gzip? ⇒ Boolean
104 105 106 |
# File 'lib/asset_sync/config.rb', line 104 def gzip? self.gzip_compression end |
#load_yml! ⇒ Object
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/asset_sync/config.rb', line 194 def load_yml! self.enabled = yml["enabled"] if yml.has_key?('enabled') self.fog_provider = yml["fog_provider"] self.fog_host = yml["fog_host"] self.fog_port = yml["fog_port"] self.fog_directory = yml["fog_directory"] self.fog_region = yml["fog_region"] self.fog_public = yml["fog_public"] if yml.has_key?("fog_public") self.fog_path_style = yml["fog_path_style"] self.fog_scheme = yml["fog_scheme"] self.aws_access_key_id = yml["aws_access_key_id"] self.aws_secret_access_key = yml["aws_secret_access_key"] self.aws_session_token = yml["aws_session_token"] if yml.has_key?("aws_session_token") self.aws_reduced_redundancy = yml["aws_reduced_redundancy"] self.aws_iam_roles = yml["aws_iam_roles"] self.aws_signature_version = yml["aws_signature_version"] self.rackspace_username = yml["rackspace_username"] self.rackspace_auth_url = yml["rackspace_auth_url"] if yml.has_key?("rackspace_auth_url") self.rackspace_api_key = yml["rackspace_api_key"] self.google_json_key_location = yml["google_json_key_location"] if yml.has_key?("google_json_key_location") self.google_project = yml["google_project"] if yml.has_key?("google_project") self.google_storage_secret_access_key = yml["google_storage_secret_access_key"] if yml.has_key?("google_storage_secret_access_key") self.google_storage_access_key_id = yml["google_storage_access_key_id"] if yml.has_key?("google_storage_access_key_id") self.existing_remote_files = yml["existing_remote_files"] if yml.has_key?("existing_remote_files") self.gzip_compression = yml["gzip_compression"] if yml.has_key?("gzip_compression") self.manifest = yml["manifest"] if yml.has_key?("manifest") self.fail_silently = yml["fail_silently"] if yml.has_key?("fail_silently") self.always_upload = yml["always_upload"] if yml.has_key?("always_upload") self.ignored_files = yml["ignored_files"] if yml.has_key?("ignored_files") self.custom_headers = yml["custom_headers"] if yml.has_key?("custom_headers") self.run_on_precompile = yml["run_on_precompile"] if yml.has_key?("run_on_precompile") self.invalidate = yml["invalidate"] if yml.has_key?("invalidate") self.cdn_distribution_id = yml['cdn_distribution_id'] if yml.has_key?("cdn_distribution_id") self.cache_asset_regexps = yml['cache_asset_regexps'] if yml.has_key?("cache_asset_regexps") self.include_manifest = yml['include_manifest'] if yml.has_key?("include_manifest") self.concurrent_uploads = yml['concurrent_uploads'] if yml.has_key?('concurrent_uploads') self.concurrent_uploads_max_threads = yml['concurrent_uploads_max_threads'] if yml.has_key?('concurrent_uploads_max_threads') self.remote_file_list_cache_file_path = yml['remote_file_list_cache_file_path'] if yml.has_key?('remote_file_list_cache_file_path') self.azure_storage_account_name = yml['azure_storage_account_name'] if yml.has_key?("azure_storage_account_name") self.azure_storage_access_key = yml['azure_storage_access_key'] if yml.has_key?("azure_storage_access_key") # TODO deprecate the other old style config settings. FML. self.aws_access_key_id = yml["aws_access_key"] if yml.has_key?("aws_access_key") self.aws_secret_access_key = yml["aws_access_secret"] if yml.has_key?("aws_access_secret") self.fog_directory = yml["aws_bucket"] if yml.has_key?("aws_bucket") self.fog_region = yml["aws_region"] if yml.has_key?("aws_region") # TODO deprecate old style config settings self.aws_access_key_id = yml["access_key_id"] if yml.has_key?("access_key_id") self.aws_secret_access_key = yml["secret_access_key"] if yml.has_key?("secret_access_key") self.fog_directory = yml["bucket"] if yml.has_key?("bucket") self.fog_region = yml["region"] if yml.has_key?("region") self.public_path = yml["public_path"] if yml.has_key?("public_path") end |
#log_silently? ⇒ Boolean
128 129 130 |
# File 'lib/asset_sync/config.rb', line 128 def log_silently? !!self.log_silently end |
#manifest_path ⇒ Object
98 99 100 101 102 |
# File 'lib/asset_sync/config.rb', line 98 def manifest_path directory = ::Rails.application.config.assets.manifest || default_manifest_directory File.join(directory, "manifest.yml") end |
#public_path ⇒ Object
177 178 179 |
# File 'lib/asset_sync/config.rb', line 177 def public_path @public_path || ::Rails.public_path end |
#public_path=(path) ⇒ Object
181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/asset_sync/config.rb', line 181 def public_path=(path) # Generate absolute path even when relative path passed in # Required for generating relative sprockets manifest path pathname = Pathname(path) @public_path = if pathname.absolute? pathname elsif defined?(::Rails.root) ::Rails.root.join(pathname) else Pathname(::Dir.pwd).join(pathname) end end |
#rackspace? ⇒ Boolean
136 137 138 |
# File 'lib/asset_sync/config.rb', line 136 def rackspace? fog_provider =~ /rackspace/i end |
#yml ⇒ Object
164 165 166 |
# File 'lib/asset_sync/config.rb', line 164 def yml @yml ||= ::YAML.load(::ERB.new(IO.read(yml_path)).result)[::Rails.env] || {} end |
#yml_exists? ⇒ Boolean
160 161 162 |
# File 'lib/asset_sync/config.rb', line 160 def yml_exists? defined?(::Rails.root) ? File.exist?(self.yml_path) : false end |
#yml_path ⇒ Object
168 169 170 |
# File 'lib/asset_sync/config.rb', line 168 def yml_path ::Rails.root.join("config", "asset_sync.yml").to_s end |