puppet_forge 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f48d6266af226aa37df713b0e1e3f72d44dc574e
-  data.tar.gz: 70d063373704bfed1c60455cc305a67daa61bb23
+  metadata.gz: 4c540e2e0483e80b517b23ef6a5160d30173e302
+  data.tar.gz: 0d5de65b3c5654e78459d03efdf33368834848dd
 SHA512:
-  metadata.gz: a23339d6b315cd7415c5b7421a16df9aaee54c4dc3940f5b803cc8a6896356bf984a8c01ce4cda19bd25ad94d08683569f50420837cb052478cbd0afd22b20ae
-  data.tar.gz: f13dc0acd460860e8d9f94d99206c93305abce3a87bebaaf60845a423d4a173018da8a813e39aa0f40bbfbf728fbe4d08ab7c0a04f77dcb4e9378afe62b7fb30
+  metadata.gz: 8662c9f01abfd72337a3b0bea60157b7d33487b8de862be41e705de6f343d05eb8477432a827fcf99688b9a32ce5a6cf850a9362601c7211d6cf808652f9f1f5
+  data.tar.gz: f91538968a8fa53c87236b54d029f6dd549d68887c6fdc3e1bd1468ee7f9ac66789e4ffc6a64bea29a72d842abe39953d00b80c459f32cb20af024d57c3efcfc

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 Starting with v2.0.0, all notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## v2.1.5 - 2016-04-13
+
+### Added
+
+* PuppetForge::Connection now has .proxy and .proxy= class methods providing a more reliable way of configuring an HTTP proxy.
+
+### Changed
+
+* Cached connection objects will now be automatically discarded when proxy or authorization config has changed.
+
 ## v2.1.4 - 2016-04-01
 
 ### Changed

data/lib/puppet_forge/connection.rb

@@ -28,18 +28,37 @@ module PuppetForge
 
     def self.authorization=(token)
       @authorization = token
+
+      # RK-229 Specific Workaround
+      # Capture instance specific proxy setting if defined.
+      if defined?(PuppetForge::V3::Base)
+        if old_conn = PuppetForge::V3::Base.instance_variable_get(:@conn)
+          self.proxy = old_conn.proxy.uri.to_s if old_conn.proxy
+        end
+      end
     end
 
     def self.authorization
       @authorization
     end
 
+    def self.proxy=(url)
+      @proxy = url
+    end
+
+    def self.proxy
+      @proxy
+    end
+
     # @param reset_connection [Boolean] flag to create a new connection every time this is called
     # @param opts [Hash] Hash of connection options for Faraday
     # @return [Faraday::Connection] An existing Faraday connection if one was
     #   already set, otherwise a new Faraday connection.
     def conn(reset_connection = nil, opts = {})
-      if reset_connection
+      new_auth = @conn && @conn.headers['Authorization'] != PuppetForge::Connection.authorization
+      new_proxy = @conn && ((@conn.proxy.nil? && PuppetForge::Connection.proxy) || (@conn.proxy && @conn.proxy.uri.to_s != PuppetForge::Connection.proxy))
+
+      if new_auth || new_proxy || reset_connection
         default_connection(opts)
       else
         @conn ||= default_connection(opts)
@@ -75,6 +94,10 @@ module PuppetForge
         options[:headers][:authorization] = token
       end
 
+      if proxy = PuppetForge::Connection.proxy
+        options[:proxy] = proxy
+      end
+
       Faraday.new(url, options) do |builder|
         builder.use PuppetForge::Middleware::SymbolifyJson
         builder.response(:json, :content_type => /\bjson$/)

data/lib/puppet_forge/version.rb

@@ -1,3 +1,3 @@
 module PuppetForge
-  VERSION = '2.1.4' # Library version
+  VERSION = '2.1.5' # Library version
 end

data/spec/unit/forge/v3/base_spec.rb

@@ -1,6 +1,45 @@
 require 'spec_helper'
 
 describe PuppetForge::V3::Base do
+  context 'connection management' do
+    before(:each) do
+      PuppetForge::Connection.authorization = nil
+      PuppetForge::Connection.proxy = nil
+      described_class.conn = nil
+    end
+
+    after(:each) do
+      PuppetForge::Connection.authorization = nil
+      PuppetForge::Connection.proxy = nil
+      described_class.conn = nil
+    end
+
+    describe 'setting authorization value after a connection is created' do
+      it 'should reset connection' do
+        old_conn = described_class.conn
+
+        PuppetForge::Connection.authorization = 'post-init auth value'
+        new_conn = described_class.conn
+
+        expect(new_conn).to_not eq(old_conn)
+        expect(new_conn.headers).to include(:authorization => 'post-init auth value')
+      end
+    end
+
+    describe 'setting proxy value after a connection is created' do
+      it 'should reset connection' do
+        old_conn = described_class.conn
+
+        PuppetForge::Connection.proxy = 'http://proxy.example.com:8888'
+        new_conn = described_class.conn
+
+        expect(new_conn).to_not eq(old_conn)
+        expect(new_conn.proxy).to_not be_nil
+        expect(new_conn.proxy.uri.to_s).to eq('http://proxy.example.com:8888')
+      end
+    end
+  end
+
   describe '::new_collection' do
     it 'should handle responses with no results' do
       response_data = { data: {}, errors: "Something bad happened!" }

data/spec/unit/forge/v3/release_spec.rb

@@ -2,91 +2,132 @@ require 'spec_helper'
 require 'fileutils'
 
 describe PuppetForge::V3::Release do
-  before do
-    stub_api_for(PuppetForge::V3::Base) do |stubs|
-      stub_fixture(stubs, :get, '/v3/releases/puppetlabs-apache-0.0.1')
-      stub_fixture(stubs, :get, '/v3/releases/absent-apache-0.0.1')
-      stub_fixture(stubs, :get, '/v3/files/puppetlabs-apache-0.0.1.tar.gz')
-      stub_fixture(stubs, :get, '/v3/modules/puppetlabs-apache')
-      stub_fixture(stubs, :get, '/v3/releases?module=puppetlabs-apache')
+  context 'connection management' do
+    before(:each) do
+      PuppetForge::Connection.authorization = nil
+      PuppetForge::Connection.proxy = nil
+      described_class.conn = PuppetForge::V3::Base.conn(true)
     end
-  end
-
-  describe '::find' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
-    let(:missing_release) { PuppetForge::V3::Release.find('absent-apache-0.0.1') }
 
-    it 'can find releases that exist' do
-      expect(release.version).to eql('0.0.1')
+    after(:each) do
+      PuppetForge::Connection.authorization = nil
+      PuppetForge::Connection.proxy = nil
+      described_class.conn = nil
     end
 
-    it 'raises Faraday::ResourceNotFound for non-existent releases' do
-      expect { missing_release }.to raise_error(Faraday::ResourceNotFound)
+    describe 'setting authorization value after a connection is created' do
+      it 'should reset connection' do
+        old_conn = described_class.conn
+
+        PuppetForge::Connection.authorization = 'post-init auth value'
+        new_conn = described_class.conn
+
+        expect(new_conn).to_not eq(old_conn)
+        expect(new_conn.headers).to include(:authorization => 'post-init auth value')
+      end
     end
-  end
 
-  describe '#module' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+    describe 'setting proxy value after a connection is created' do
+      it 'should reset connection' do
+        old_conn = described_class.conn
 
-    it 'exposes the related module as a property' do
-      expect(release.module).to_not be nil
+        PuppetForge::Connection.proxy = 'http://proxy.example.com:8888'
+        new_conn = described_class.conn
+
+        expect(new_conn).to_not eq(old_conn)
+        expect(new_conn.proxy).to_not be_nil
+        expect(new_conn.proxy.uri.to_s).to eq('http://proxy.example.com:8888')
+      end
     end
+  end
 
-    it 'grants access to module attributes without an API call' do
-      expect(PuppetForge::V3::Module).not_to receive(:request)
-      expect(release.module.name).to eql('apache')
+  context 'with stubbed connection' do
+    before do
+      stub_api_for(PuppetForge::V3::Base) do |stubs|
+        stub_fixture(stubs, :get, '/v3/releases/puppetlabs-apache-0.0.1')
+        stub_fixture(stubs, :get, '/v3/releases/absent-apache-0.0.1')
+        stub_fixture(stubs, :get, '/v3/files/puppetlabs-apache-0.0.1.tar.gz')
+        stub_fixture(stubs, :get, '/v3/modules/puppetlabs-apache')
+        stub_fixture(stubs, :get, '/v3/releases?module=puppetlabs-apache')
+      end
     end
 
-    it 'transparently makes API calls for other attributes' do
-      expect(PuppetForge::V3::Module).to receive(:request).once.and_call_original
-      expect(release.module.created_at).to_not be nil
+    describe '::find' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+      let(:missing_release) { PuppetForge::V3::Release.find('absent-apache-0.0.1') }
+
+      it 'can find releases that exist' do
+        expect(release.version).to eql('0.0.1')
+      end
+
+      it 'raises Faraday::ResourceNotFound for non-existent releases' do
+        expect { missing_release }.to raise_error(Faraday::ResourceNotFound)
+      end
     end
-  end
 
-  describe '#download_url' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+    describe '#module' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
 
-    it 'handles an API response that does not include a scheme and host' do
-      release.file_uri = '/v3/files/puppetlabs-apache-0.0.1.tar.gz'
-      uri_with_host = URI.join(PuppetForge.host, '/v3/files/puppetlabs-apache-0.0.1.tar.gz').to_s
-      expect(release.download_url).to eql(uri_with_host)
+      it 'exposes the related module as a property' do
+        expect(release.module).to_not be nil
+      end
+
+      it 'grants access to module attributes without an API call' do
+        expect(PuppetForge::V3::Module).not_to receive(:request)
+        expect(release.module.name).to eql('apache')
+      end
+
+      it 'transparently makes API calls for other attributes' do
+        expect(PuppetForge::V3::Module).to receive(:request).once.and_call_original
+        expect(release.module.created_at).to_not be nil
+      end
     end
 
-    it 'handles an API response that includes a scheme and host' do
-      release.file_uri = 'https://example.com/v3/files/puppetlabs-apache-0.0.1.tar.gz'
-      expect(release.download_url).to eql('https://example.com/v3/files/puppetlabs-apache-0.0.1.tar.gz')
+    describe '#download_url' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+
+      it 'handles an API response that does not include a scheme and host' do
+        release.file_uri = '/v3/files/puppetlabs-apache-0.0.1.tar.gz'
+        uri_with_host = URI.join(PuppetForge.host, '/v3/files/puppetlabs-apache-0.0.1.tar.gz').to_s
+        expect(release.download_url).to eql(uri_with_host)
+      end
+
+      it 'handles an API response that includes a scheme and host' do
+        release.file_uri = 'https://example.com/v3/files/puppetlabs-apache-0.0.1.tar.gz'
+        expect(release.download_url).to eql('https://example.com/v3/files/puppetlabs-apache-0.0.1.tar.gz')
+      end
     end
-  end
 
-  describe '#download' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
-    let(:tarball) { "#{PROJECT_ROOT}/spec/tmp/module.tgz" }
+    describe '#download' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+      let(:tarball) { "#{PROJECT_ROOT}/spec/tmp/module.tgz" }
 
-    before { FileUtils.rm tarball rescue nil }
-    after  { FileUtils.rm tarball rescue nil }
+      before { FileUtils.rm tarball rescue nil }
+      after  { FileUtils.rm tarball rescue nil }
 
-    it 'downloads the file to the specified location' do
-      expect(File.exist?(tarball)).to be false
-      release.download(Pathname.new(tarball))
-      expect(File.exist?(tarball)).to be true
+      it 'downloads the file to the specified location' do
+        expect(File.exist?(tarball)).to be false
+        release.download(Pathname.new(tarball))
+        expect(File.exist?(tarball)).to be true
+      end
     end
-  end
 
-  describe '#metadata' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+    describe '#metadata' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
 
-    it 'is lazy and repeatable' do
-      3.times do
-        expect(release.module.releases.last.metadata).to_not be_nil
+      it 'is lazy and repeatable' do
+        3.times do
+          expect(release.module.releases.last.metadata).to_not be_nil
+        end
       end
     end
-  end
 
-  describe 'instance properies' do
-    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+    describe 'instance properies' do
+      let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
 
-    example 'are easily accessible' do
-      expect(release.created_at).to_not be nil
+      example 'are easily accessible' do
+        expect(release.created_at).to_not be nil
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_forge
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -269,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Access the Puppet Forge API from Ruby for resource information and to download
@@ -320,3 +320,4 @@ test_files:
 - spec/unit/forge/v3/module_spec.rb
 - spec/unit/forge/v3/release_spec.rb
 - spec/unit/forge/v3/user_spec.rb
+has_rdoc: