puppet-blacksmith 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 359eca2b13c47203990a6471f9186a503ad9760a
-  data.tar.gz: ac8ca97a230403ef8977a91b5110449aae669a47
+  metadata.gz: 067263620b3ecaa64fcd67b770345766d46f2728
+  data.tar.gz: 87c4bc41babc57dd308dca7307af27ce25e994dd
 SHA512:
-  metadata.gz: be24419c31bf14b66ad41808d0c4cc55fe00998f1ba469e19aa43ff337a99174e17bd7dc79af925cfa15de56291a3f0a490a13d313c65de71a6171f630c8d5aa
-  data.tar.gz: b6ae24c1cc384e790040617d5c4a3e60f76a890fd654bf702da530f859601b17112a3df3d415ac42ba522b7211e470c40e7bdbe2fa2a063f0d78fd53a47f830d
+  metadata.gz: d7a3db4d6999ab0ea7ee416b9fbc8b6f93c40e95bb8bf904fa91766b7a45f8abf87a1a2f7aba226a5710705c50026ef8181330a31f6113e95ba440dcc352d137
+  data.tar.gz: f3514d2f03b03b182aaa6c826e5e01ab5b525456761d13d2fb08f97608bda1754b1f74af99917dc9a4b77615aaf18df88e6a0145342cd9400d9257257df1bfd1

data/lib/puppet_blacksmith/forge.rb

@@ -6,16 +6,18 @@ module Blacksmith
   class Forge
 
     PUPPETLABS_FORGE = "https://forgeapi.puppetlabs.com"
+    CREDENTIALS_FILE_HOME = "~/.puppetforge.yml"
+    CREDENTIALS_FILE_PROJECT = '.puppetforge.yml'
+    DEFAULT_CREDENTIALS = { 'url' => PUPPETLABS_FORGE }
     HEADERS = { 'User-Agent' => "Blacksmith/#{Blacksmith::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE}; #{RUBY_PLATFORM})" }
 
-    attr_accessor :username, :password, :client_id, :client_secret
-    attr_writer :url
+    attr_accessor :username, :password, :url, :client_id, :client_secret
 
     def initialize(username = nil, password = nil, url = nil)
       self.username = username
       self.password = password
       RestClient.proxy = ENV['http_proxy']
-      load_credentials_from_file if username.nil?
+      load_credentials
       load_client_credentials_from_file
       self.url = url unless url.nil?
       if self.url =~ %r{http(s)?://forge.puppetlabs.com}
@@ -24,10 +26,6 @@ module Blacksmith
       end
     end
 
-    def url
-      @url || PUPPETLABS_FORGE
-    end
-
     def push!(name, package = nil)
       unless package
         regex = /^#{username}-#{name}-.*\.tar\.gz$/
@@ -65,27 +63,76 @@ module Blacksmith
 
     private
 
-    def load_credentials_from_file
-      credentials_file = File.expand_path("~/.puppetforge.yml")
-      unless File.exists?(credentials_file)
+    def load_credentials
+      file_credentials = load_credentials_from_file
+      env_credentials = load_credentials_from_env
+
+      credentials = DEFAULT_CREDENTIALS.merge file_credentials
+      credentials = credentials.merge env_credentials
+
+      self.username = credentials['username'] if credentials['username']
+      self.password = credentials['password'] if credentials['password']
+      if credentials['forge']
+        # deprecated
+        puts "'forge' entry is deprecated in .puppetforge.yml, use 'url'"
+        self.url = credentials['forge']
+      end
+      self.url = credentials['url'] if credentials['url']
+
+      unless self.username && self.password
         raise Blacksmith::Error, <<-eos
-Could not find Puppet Forge credentials file '#{credentials_file}'
-Please create it
+Could not find Puppet Forge credentials!
+
+Please set the environment variables
+BLACKSMITH_FORGE_URL
+BLACKSMITH_FORGE_USERNAME
+BLACKSMITH_FORGE_PASSWORD
+
+or create the file '#{CREDENTIALS_FILE_PROJECT}' or '#{CREDENTIALS_FILE_HOME}'
+with content similiar to:
+
 ---
 url: https://forgeapi.puppetlabs.com
 username: myuser
 password: mypassword
+
     eos
       end
-      credentials = YAML.load_file(credentials_file)
-      self.username = credentials['username']
-      self.password = credentials['password']
-      if credentials['forge']
-        # deprecated
-        puts "'forge' entry is deprecated in .puppetforge.yml, use 'url'"
-        self.url = credentials['forge']
+    end
+
+    def load_credentials_from_file
+      credentials_file = [
+          File.join(Dir.pwd, CREDENTIALS_FILE_PROJECT),
+          File.expand_path(CREDENTIALS_FILE_HOME)
+      ]
+                             .select { |file| File.exists?(file) }
+                             .first
+
+      if credentials_file
+        credentials = YAML.load_file(credentials_file)
+      else
+        credentials = Hash.new
       end
-      self.url = credentials['url'] if credentials['url']
+
+      return credentials
+    end
+
+    def load_credentials_from_env
+      credentials = Hash.new
+
+      if ENV['BLACKSMITH_FORGE_USERNAME']
+        credentials['username'] = ENV['BLACKSMITH_FORGE_USERNAME']
+      end
+
+      if ENV['BLACKSMITH_FORGE_PASSWORD']
+        credentials['password'] = ENV['BLACKSMITH_FORGE_PASSWORD']
+      end
+
+      if ENV['BLACKSMITH_FORGE_URL']
+        credentials['url'] = ENV['BLACKSMITH_FORGE_URL']
+      end
+
+      return credentials
     end
 
     def load_client_credentials_from_file

data/lib/puppet_blacksmith/modulefile.rb

@@ -60,7 +60,7 @@ module Blacksmith
       new_version
     end
 
-    [:major, :minor, :patch].each do |level|
+    [:major, :minor, :patch, :full].each do |level|
       define_method("bump_#{level}!") { bump!(level) }
     end
 

data/lib/puppet_blacksmith/rake_tasks.rb

@@ -24,8 +24,18 @@ module Blacksmith
         'bump:major',
         'bump:minor',
         'bump:patch',
+        'bump:full',
         :tag,
+        :version,
+        'version:next',
+        'version:next:major',
+        'version:next:minor',
+        'version:next:patch',
         :bump_commit,
+        'bump_commit:major',
+        'bump_commit:minor',
+        'bump_commit:patch',
+        'bump_commit:full',
         :push,
         :clean,
         :release,
@@ -37,7 +47,7 @@ module Blacksmith
       namespace :module do
 
         namespace :bump do
-          [:major, :minor, :patch].each do |level|
+          [:major, :minor, :patch, :full].each do |level|
             desc "Bump module version to the next #{level.upcase} version"
             task level do
               m = Blacksmith::Modulefile.new
@@ -62,6 +72,38 @@ module Blacksmith
           git.tag!(m.version)
         end
 
+        namespace :version do
+          desc "Get next module version"
+          task :next do
+            m = Blacksmith::Modulefile.new
+            puts m.increase_version(m.version, 'patch')
+          end
+
+          [:major, :minor, :patch].each do |level|
+            desc "Get the next #{level.upcase} version"
+            task "next:#{level}".to_sym do
+              m = Blacksmith::Modulefile.new
+              puts m.increase_version(m.version, level)
+            end
+          end
+        end
+
+        desc "Get current module version"
+        task :version do
+          m = Blacksmith::Modulefile.new
+          puts m.version
+        end
+
+        namespace :bump_commit do
+          [:major, :minor, :patch, :full].each do |level|
+            desc "Bump module version to the next #{level.upcase} version and git commit"
+            task level => "bump:#{level}".to_sym do
+              m = Blacksmith::Modulefile.new
+              Blacksmith::Git.new.commit_modulefile!(m.version)
+            end
+          end
+        end
+
         desc "Bump version and git commit"
         task :bump_commit => :bump do
           m = Blacksmith::Modulefile.new

data/lib/puppet_blacksmith/version.rb

@@ -1,3 +1,3 @@
 module Blacksmith
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end

data/lib/puppet_blacksmith/version_helper.rb

@@ -104,6 +104,15 @@ module Blacksmith
         define_method("#{term}!") { increment!(term) }
       end
 
+      def full!
+        env_var = "BLACKSMITH_FULL_VERSION"
+        begin
+          ENV.fetch env_var
+        rescue KeyError
+          raise Exception, "Setting the full version requires setting the #{env_var} environment variable to the new version"
+        end
+      end
+
       def increment!(term)
         new_version = clone
         new_value = send(term) + 1

data/spec/puppet_blacksmith/forge_spec.rb

@@ -6,21 +6,67 @@ require 'webmock/rspec'
 describe 'Blacksmith::Forge' do
   include_context 'forge'
 
-  describe 'missing credentials file' do
+  describe 'resolving credentials' do
     before do
-      allow(File).to receive(:expand_path) { '/home/mr_puppet/.puppetforge.yml' }
+      allow(Dir).to receive(:pwd) { '/home/mr_puppet/puppet-some-module' }
+      allow(File).to receive(:expand_path).with('~/.puppetforge.yml') { '/home/mr_puppet/.puppetforge.yml' }
+      allow(File).to receive(:expand_path).with(/credentials.yml/) { '/home/mr_puppet/puppet-blacksmith/credentials.yml' }
+      allow(YAML).to receive(:load_file).with('/home/mr_puppet/puppet-blacksmith/credentials.yml') { {
+          "client_id" => "b93eb708fd942cfc7b4ed71db6ce219b814954619dbe537ddfd208584e8cff8d",
+          "client_secret" => "216648059ad4afec3e4d77bd9e67817c095b2dcf94cdec18ac3d00584f863180",
+      } }
     end
 
-    context "when the credentials file is missing" do
-      before do
-
-      end
+    it 'prefers env vars to file values' do
+      stubbed_forge_password = 'asdf1234'
+
+      allow(File).to receive(:exists?).
+                      with('/home/mr_puppet/puppet-some-module/.puppetforge.yml').
+                      and_return(false)
+      allow(File).to receive(:exists?).
+                      with('/home/mr_puppet/.puppetforge.yml').
+                      and_return(true)
+      allow(YAML).to receive(:load_file).
+                      with('/home/mr_puppet/.puppetforge.yml').
+                      and_return({'username' => username,
+                                  'password' => password})
+      allow(ENV).to receive(:[]).
+                      with(any_args)
+      allow(ENV).to receive(:[]).
+                      with('BLACKSMITH_FORGE_PASSWORD').
+                      and_return(stubbed_forge_password)
+
+      forge = Blacksmith::Forge.new()
+
+      expect(forge.url).to eq(Blacksmith::Forge::PUPPETLABS_FORGE)
+      expect(forge.password).to eq(stubbed_forge_password)
+      expect(forge.username).to eq(username)
+    end
 
+    context 'when the credentials values are unset' do
       it "should raise an error" do
-        expect { foo = Blacksmith::Forge.new(nil, password, forge) }.to raise_error(/Could not find Puppet Forge credentials file '\/home\/mr\_puppet\/.puppetforge.yml'\s*Please create it\s*---\s*url: https:\/\/forgeapi.puppetlabs.com\s*username: myuser\s*password: mypassword/)
+        expect { foo = Blacksmith::Forge.new(nil, password, forge) }.to raise_error(/Could not find Puppet Forge credentials/)
       end
     end
 
+    it 'loads credentials from home dir' do
+      allow(File).to receive(:exists?).with('/home/mr_puppet/puppet-some-module/.puppetforge.yml') { false }
+      allow(File).to receive(:exists?).with('/home/mr_puppet/.puppetforge.yml') { true }
+      allow(YAML).to receive(:load_file).with('/home/mr_puppet/.puppetforge.yml') { {'username'=> 'puppet-user'} }
+
+      subject = Blacksmith::Forge.new(nil, password, forge)
+      expect(subject.username).to eq('puppet-user')
+    end
+
+    it 'loads credentials from project dir' do
+      allow(File).to receive(:exists?).with('/home/mr_puppet/puppet-some-module/.puppetforge.yml') { true }
+      allow(File).to receive(:exists?).with('/home/mr_puppet/.puppetforge.yml') { true }
+      allow(YAML).to receive(:load_file).with('/home/mr_puppet/puppet-some-module/.puppetforge.yml') { {'username'=> 'puppet-other-user'} }
+
+      subject = Blacksmith::Forge.new(nil, password, forge)
+      expect(subject.username).to eq('puppet-other-user')
+    end
+
   end
 
   describe 'push' do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puppet-blacksmith
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - MaestroDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.23.0
 description: Puppet module tools for development and Puppet Forge management
 email:
 - info@maestrodev.com
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Tasks to manage Puppet module builds