bookbindery 2.1.5 → 3.0.1

data/lib/bookbinder/commands/build_and_push_tarball.rb

@@ -1,6 +1,7 @@
-require_relative 'naming'
-require_relative 'bookbinder_command'
 require_relative '../archive'
+require_relative '../ingest/destination_directory'
+require_relative 'bookbinder_command'
+require_relative 'naming'
 
 module Bookbinder
   module Commands
@@ -21,10 +22,10 @@ module Bookbinder
       def run(_)
         raise MissingBuildNumber unless ENV['BUILD_NUMBER']
         config = configuration_fetcher.fetch_config
-        aws_credentials = config.aws_credentials
+        aws_credentials = configuration_fetcher.fetch_credentials[:aws]
         archive = Archive.new(logger: @logger, key: aws_credentials.access_key, secret: aws_credentials.secret_key)
         archive.create_and_upload_tarball(build_number: ENV['BUILD_NUMBER'], bucket: aws_credentials.green_builds_bucket,
-                                          namespace: GitHubRepository.new(logger: @logger, full_name: config.book_repo, git_accessor: Git).short_name)
+                                          namespace: Ingest::DestinationDirectory.new(config.book_repo, nil))
         0
       end
     end

data/lib/bookbinder/commands/push_from_local.rb

@@ -7,6 +7,10 @@ module Bookbinder
     class PushFromLocal
       include Commands::Naming
 
+      CredentialKeyError = Class.new(RuntimeError)
+      REQUIRED_AWS_KEYS = %w(access_key secret_key green_builds_bucket)
+      REQUIRED_CF_KEYS = %w(username password api_endpoint organization app_name)
+
       def initialize(logger, configuration_fetcher, environment)
         @logger = logger
         @configuration_fetcher = configuration_fetcher
@@ -19,6 +23,7 @@ module Bookbinder
       end
 
       def run(_)
+        validate
         Distributor.build(@logger, options).distribute
         0
       end
@@ -36,16 +41,65 @@ module Bookbinder
       end
 
       def options
+        credentials = configuration_fetcher.fetch_credentials(environment)
         {
             app_dir: './final_app',
             build_number: ENV['BUILD_NUMBER'],
 
-            aws_credentials: config.aws_credentials,
-            cf_credentials: config.cf_credentials(environment),
+            aws_credentials: credentials[:aws],
+            cf_credentials: credentials[:cloud_foundry],
 
             book_repo: config.book_repo,
         }
       end
+
+      def error_message
+        <<-ERROR
+Cannot locate a specific key in credentials.yml.
+Your credentials file should follow this format:
+
+aws:
+  access_key: <your_AWS_access_key>
+  secret_key: <your_AWS_secret_key>
+  green_builds_bucket: <your_AWS_bucket>
+
+cloud_foundry:
+  username: <your_CF_account>
+  password: <your_CF_password>
+  staging_space: <your_CF_staging_space_name>
+  staging_host: <your_CF_staging_host_name>
+    <your-domain.com>:
+      - <your_hostname>
+  production_space: <your_CF_production_space_name>
+  production_host: <your_CF_production_host_name>
+    <your-domain.com>:
+      - <your_hostname>
+  app_name: <your_app_name>
+  api_endpoint: <your_api_endpoint>
+  organization: <your_organization>
+        ERROR
+      end
+
+      def validate
+        missing_keys = []
+
+        creds = configuration_fetcher.fetch_credentials(environment)
+        aws_creds = creds[:aws]
+        cf_creds = creds[:cloud_foundry]
+
+        missing_keys << 'aws' unless aws_creds
+        missing_keys << 'cloud_foundry' unless cf_creds
+
+        REQUIRED_AWS_KEYS.map do |key|
+          missing_keys << key unless aws_creds.send(key)
+        end
+
+        REQUIRED_CF_KEYS.each do |key|
+          missing_keys << key unless cf_creds.send(key)
+        end
+
+        raise CredentialKeyError.new error_message if missing_keys.any?
+      end
     end
   end
 end

data/lib/bookbinder/commands/push_to_prod.rb

@@ -37,13 +37,17 @@ module Bookbinder
           app_dir: Dir.mktmpdir,
           build_number: arguments[0],
 
-          aws_credentials: config.aws_credentials,
-          cf_credentials: config.cf_credentials('production'),
+          aws_credentials: credentials[:aws],
+          cf_credentials: credentials[:cloud_foundry],
 
           book_repo: config.book_repo,
         }
       end
 
+      def credentials
+        configuration_fetcher.fetch_credentials('production')
+      end
+
       def config
         @config ||= configuration_fetcher.fetch_config
       end

data/lib/bookbinder/commands/tag.rb

@@ -1,14 +1,18 @@
 require_relative '../book'
-require_relative '../errors/cli_error'
 require_relative '../deprecated_logger'
-require_relative 'bookbinder_command'
+require_relative '../errors/cli_error'
 require_relative 'naming'
 
 module Bookbinder
   module Commands
-    class Tag < BookbinderCommand
+    class Tag
       include Commands::Naming
 
+      def initialize(logger, configuration_fetcher)
+        @logger = logger
+        @configuration_fetcher = configuration_fetcher
+      end
+
       def usage
         ["tag <git tag>", "Apply the specified <git tag> to your book and all sections of your book"]
       end
@@ -25,6 +29,14 @@ module Bookbinder
         @logger.log " #{book.full_name.yellow} and its sections were tagged with #{tag.blue}"
         0
       end
+
+      private
+
+      attr_reader :configuration_fetcher
+
+      def config
+        @config ||= configuration_fetcher.fetch_config
+      end
     end
   end
 end

data/lib/bookbinder/config/aws_credentials.rb

@@ -0,0 +1,21 @@
+module Bookbinder
+  module Config
+    class AwsCredentials
+      REQUIRED_KEYS = %w(access_key secret_key green_builds_bucket)
+
+      def initialize(aws_cred_hash)
+        @creds = aws_cred_hash
+      end
+
+      REQUIRED_KEYS.each do |method_name|
+        define_method(method_name) do
+          creds[method_name]
+        end
+      end
+
+      private
+
+      attr_reader :creds
+    end
+  end
+end

data/lib/bookbinder/config/cf_credentials.rb

@@ -0,0 +1,87 @@
+module Bookbinder
+  module Config
+    class CfCredentials
+      REQUIRED_KEYS = %w(username password api_endpoint organization app_name)
+      CredentialKeyError = Class.new(RuntimeError)
+
+      def initialize(cf_cred_hash, environment)
+        @creds = cf_cred_hash
+        @environment = environment
+      end
+
+      REQUIRED_KEYS.each do |method_name|
+        define_method(method_name) do
+          creds[method_name]
+        end
+      end
+
+      def ==(other)
+        [@creds, @environment] == [
+          other.instance_variable_get(:@creds),
+          other.instance_variable_get(:@environment)
+        ]
+      end
+
+      def download_archive_before_push?
+        production?
+      end
+
+      def push_warning
+        if production?
+          'Warning: You are pushing to CF Docs production. Be careful.'
+        end
+      end
+
+      def routes
+        fetch(host_key) if correctly_formatted_domain_and_routes?(host_key)
+      end
+
+      def flat_routes
+        routes.reduce([]) do |all_routes, domain_apps|
+          domain, apps = domain_apps
+          all_routes + apps.map { |app| [domain, app] }
+        end
+      end
+
+      def space
+        fetch(space_key)
+      end
+
+      private
+
+      attr_reader :creds, :environment
+
+      def production?
+        environment == 'production'
+      end
+
+      def fetch(key)
+        creds.fetch(key)
+      rescue KeyError => e
+        raise CredentialKeyError, e
+      end
+
+      def correctly_formatted_domain_and_routes?(deploy_environment)
+        routes_hash = fetch(deploy_environment)
+        domains = routes_hash.keys
+        domains.each { |domain| correctly_formatted_domain?(domain, routes_hash) }
+      end
+
+      def correctly_formatted_domain?(domain, routes_hash)
+        raise 'Each domain in credentials must be a single string.' unless domain.is_a? String
+        raise "Domain #{domain} in credentials must contain a web extension, e.g. '.com'." unless domain.include?('.')
+        raise "Did you mean to add a list of hosts for domain #{domain}? Check your credentials.yml." unless routes_hash[domain]
+        raise "Hosts in credentials must be nested as an array under the desired domain #{domain}." unless routes_hash[domain].is_a? Array
+        raise "Did you mean to provide a hostname for the domain #{domain}? Check your credentials.yml." if routes_hash[domain].any?(&:nil?)
+      end
+
+      def host_key
+        "#{environment}_host"
+      end
+
+      def space_key
+        "#{environment}_space"
+      end
+    end
+  end
+end

data/lib/bookbinder/configuration.rb

@@ -1,128 +1,10 @@
-require 'git'
-require_relative 'git_hub_repository'
-require_relative 'remote_yaml_credential_provider'
-
 module Bookbinder
   class Configuration
 
     CURRENT_SCHEMA_VERSION = '1.0.0'
     STARTING_SCHEMA_VERSION = '1.0.0'
 
-    CredentialKeyError = Class.new(StandardError)
-    ConfigSchemaUnsupportedError = Class.new(StandardError)
-
-    class AwsCredentials
-      REQUIRED_KEYS = %w(access_key secret_key green_builds_bucket)
-
-      def initialize(cred_hash)
-        @creds = cred_hash
-      end
-
-      REQUIRED_KEYS.each do |method_name|
-        define_method(method_name) do
-          begin
-            creds.fetch(method_name)
-          rescue KeyError => e
-            raise CredentialKeyError, e
-          end
-        end
-      end
-
-      private
-
-      attr_reader :creds
-    end
-
-    class CfCredentials
-      REQUIRED_KEYS = %w(api_endpoint organization app_name)
-
-      def initialize(cred_hash, environment)
-        @creds = cred_hash
-        @environment = environment
-      end
-
-      REQUIRED_KEYS.each do |method_name|
-        define_method(method_name) do
-          fetch(method_name)
-        end
-      end
-
-      def ==(other)
-        [@creds, @environment] == [
-          other.instance_variable_get(:@creds),
-          other.instance_variable_get(:@environment)
-        ]
-      end
-
-      def username
-        creds['username']
-      end
-
-      def password
-        creds['password']
-      end
-
-      def download_archive_before_push?
-        production?
-      end
-
-      def push_warning
-        if production?
-          'Warning: You are pushing to CF Docs production. Be careful.'
-        end
-      end
-
-      def routes
-        fetch(host_key) if correctly_formatted_domain_and_routes?(host_key)
-      end
-
-      def flat_routes
-        routes.reduce([]) do |all_routes, domain_apps|
-          domain, apps = domain_apps
-          all_routes + apps.map { |app| [domain, app] }
-        end
-      end
-
-      def space
-        fetch(space_key)
-      end
-
-      private
-
-      attr_reader :creds, :environment
-
-      def production?
-        environment == 'production'
-      end
-
-      def fetch(key)
-        creds.fetch(key)
-      rescue KeyError => e
-        raise CredentialKeyError, e
-      end
-
-      def correctly_formatted_domain_and_routes?(deploy_environment)
-        routes_hash = fetch(deploy_environment)
-        domains = routes_hash.keys
-        domains.each { |domain| correctly_formatted_domain?(domain, routes_hash) }
-      end
-
-      def correctly_formatted_domain?(domain, routes_hash)
-        raise 'Each domain in credentials must be a single string.' unless domain.is_a? String
-        raise "Domain #{domain} in credentials must contain a web extension, e.g. '.com'." unless domain.include?('.')
-        raise "Did you mean to add a list of hosts for domain #{domain}? Check your credentials.yml." unless routes_hash[domain]
-        raise "Hosts in credentials must be nested as an array under the desired domain #{domain}." unless routes_hash[domain].is_a? Array
-        raise "Did you mean to provide a hostname for the domain #{domain}? Check your credentials.yml." if routes_hash[domain].any?(&:nil?)
-      end
-
-      def host_key
-        "#{environment}_host"
-      end
-
-      def space_key
-        "#{environment}_space"
-      end
-    end
+    ConfigSchemaUnsupportedError = Class.new(RuntimeError)
 
     attr_reader :schema_version, :schema_major_version, :schema_minor_version, :schema_patch_version
 
@@ -132,7 +14,7 @@ module Bookbinder
     end
 
     CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
-    CONFIG_OPTIONAL_KEYS = %w(archive_menu layout_repo versions pdf_index cred_repo pdf)
+    CONFIG_OPTIONAL_KEYS = %w(archive_menu layout_repo versions cred_repo)
 
     CONFIG_REQUIRED_KEYS.each do |method_name|
       define_method(method_name) do
@@ -162,32 +44,14 @@ module Bookbinder
       config.fetch('template_variables', {})
     end
 
-    def aws_credentials
-      @aws_creds ||= AwsCredentials.new(credentials.fetch('aws'))
-    end
-
-    def cf_credentials(environment)
-      CfCredentials.new(credentials.fetch('cloud_foundry'), environment)
-    end
-
     def ==(o)
-      (o.class == self.class) && (o.config == self.config)
+      o.class == self.class && o.instance_variable_get(:@config) == @config
     end
 
     alias_method :eql?, :==
 
-    protected
-
-    attr_reader :config
-
     private
 
-    def credentials
-      @credentials ||= RemoteYamlCredentialProvider.new(@logger, credentials_repository).credentials
-    end
-
-    def credentials_repository
-      @credentials_repository ||= GitHubRepository.new(logger: @logger, full_name: cred_repo, git_accessor: Git)
-    end
+    attr_reader :config
   end
 end