puppet_forge 1.0.0

data/spec/fixtures/v3/users/puppetlabs.headers

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Mon, 06 Jan 2014 22:42:07 GMT
+Content-Type: application/json;charset=utf-8
+Content-Length: 285
+Connection: keep-alive
+Status: 200 OK
+X-Frame-Options: sameorigin
+X-XSS-Protection: 1; mode=block
+Cache-Control: public, must-revalidate
+Last-Modified: Mon, 12 Nov 2012 14:51:00 GMT
+X-Node: forgeapi02
+X-Revision: 49f66e061b0021c081fb58e754898cd928f61494
+

data/spec/fixtures/v3/users/puppetlabs.json

@@ -0,0 +1,10 @@
+{
+  "uri": "/v3/users/puppetlabs",
+  "gravatar_id": "fdd009b7c1ec96e088b389f773e87aec",
+  "username": "puppetlabs",
+  "display_name": "Puppet Labs",
+  "release_count": 422,
+  "module_count": 81,
+  "created_at": "2010-05-19 05:46:26 -0700",
+  "updated_at": "2012-11-12 06:51:00 -0800"
+}

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+PROJECT_ROOT = File.join(File.dirname(__FILE__), '..')
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+
+end
+
+require 'puppet_forge'
+
+module StubbingHer
+  def stub_api_for(klass)
+    klass.use_api begin
+      Her::API.new :url => "http://api.example.com" do |c|
+        c.use PuppetForge::Middleware::JSONForHer
+        c.adapter(:test) { |s| yield(s) }
+      end
+    end
+  end
+
+  def stub_fixture(api, method, path)
+    api.send(method, path) do |env|
+      load_fixture([ env[:url].path, env[:url].query ].compact.join('?'))
+    end
+  end
+
+  def load_fixture(path)
+    [ 404 ].tap do |response|
+      local = File.join(PROJECT_ROOT, 'spec', 'fixtures', path.to_s)
+
+      if File.exists?("#{local}.headers") && File.exists?("#{local}.json")
+        File.open("#{local}.headers") do |file|
+          response[0] = file.readline[/\d{3}/].to_i
+          response[1] = headers = {}
+          file.read.scan(/^([^:]+?):(.*)/) do |key, val|
+            headers[key] = val.strip
+          end
+        end
+
+        response << File.read("#{local}.json")
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include StubbingHer
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/forge/v3/base/paginated_collection_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe PuppetForge::V3::Base::PaginatedCollection do
+  let(:klass) do
+    Class.new do
+      def self.get_collection(url)
+        data = {
+          '/v3/collection'        => [ :A, :B, :C ],
+          '/v3/collection?page=2' => [ :D, :E, :F ],
+          '/v3/collection?page=3' => [ :G, :H ],
+        }
+
+        meta = {
+          '/v3/collection' => {
+            :limit    => 3,
+            :offset   => 0,
+            :first    => '/v3/collection',
+            :previous => nil,
+            :current  => '/v3/collection',
+            :next     => '/v3/collection?page=2',
+            :total    => 8,
+          },
+          '/v3/collection?page=2' => {
+            :limit    => 3,
+            :offset   => 0,
+            :first    => '/v3/collection',
+            :previous => '/v3/collection',
+            :current  => '/v3/collection?page=2',
+            :next     => '/v3/collection?page=3',
+            :total    => 8,
+          },
+          '/v3/collection?page=3' => {
+            :limit    => 3,
+            :offset   => 0,
+            :first    => '/v3/collection',
+            :previous => '/v3/collection?page=2',
+            :current  => '/v3/collection?page=3',
+            :next     => nil,
+            :total    => 8,
+          },
+        }
+
+        PuppetForge::V3::Base::PaginatedCollection.new(self, data[url], meta[url], {})
+      end
+    end
+  end
+
+  subject { klass.get_collection('/v3/collection') }
+
+  it 'maps to a single page of the collection' do
+    expect(subject.to_a).to eql([ :A, :B, :C ])
+  end
+
+  it 'knows the size of the entire collection' do
+    expect(subject.total).to be 8
+  end
+
+  it 'contains only a subset of the entire collection' do
+    expect(subject.size).to be 3
+  end
+
+  it 'enables page navigation' do
+    expect(subject.next).to_not be_empty
+    expect(subject.next.to_a).to_not eql(subject.to_a)
+    expect(subject.next.previous.to_a).to eql(subject.to_a)
+  end
+
+  it 'exposes the pagination metadata' do
+    expect(subject.metadata[:limit]).to be subject.size
+  end
+
+  it 'exposes previous_url and next_url' do
+    expected = subject.next_url
+    expect(subject.next.next.previous_url).to eql(expected)
+  end
+
+  describe '#unpaginated' do
+    it 'provides an iterator over the entire collection' do
+      expected = [ :A, :B, :C, :D, :E, :F, :G, :H ]
+      expect(subject.unpaginated.to_a).to eql(expected)
+    end
+
+    it "provides a full iterator regardless of which page it's started on" do
+      expected = [ :A, :B, :C, :D, :E, :F, :G, :H ]
+      expect(subject.next.next.unpaginated.to_a).to eql(expected)
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe PuppetForge::V3::Module do
+  before do
+    stub_api_for(PuppetForge::V3::Module) do |api|
+      stub_fixture(api, :get, '/v3/modules/puppetlabs-apache')
+      stub_fixture(api, :get, '/v3/modules/absent-apache')
+    end
+  end
+
+  describe '::find' do
+    let(:mod) { PuppetForge::V3::Module.find('puppetlabs-apache') }
+    let(:missing_mod) { PuppetForge::V3::Module.find('absent-apache') }
+
+    it 'can find modules that exist' do
+      mod.name.should == 'apache'
+    end
+
+    it 'returns nil for non-existent modules' do
+      missing_mod.should be_nil
+    end
+  end
+
+  describe '#owner' do
+    let(:mod) { PuppetForge::V3::Module.find('puppetlabs-apache') }
+
+    before do
+      stub_api_for(PuppetForge::V3::User) do |api|
+        stub_fixture(api, :get, '/v3/users/puppetlabs')
+      end
+    end
+
+    it 'exposes the related module as a property' do
+      expect(mod.owner).to_not be nil
+    end
+
+    it 'grants access to module attributes without an API call' do
+      PuppetForge::V3::User.should_not_receive(:request)
+      expect(mod.owner.username).to eql('puppetlabs')
+    end
+
+    it 'transparently makes API calls for other attributes' do
+      PuppetForge::V3::User.should_receive(:request).once.and_call_original
+      expect(mod.owner.created_at).to_not be nil
+    end
+  end
+
+  describe '#current_release' do
+    let(:mod) { PuppetForge::V3::Module.find('puppetlabs-apache') }
+
+    it 'exposes the current_release as a property' do
+      expect(mod.current_release).to_not be nil
+    end
+
+    it 'grants access to release attributes without an API call' do
+      PuppetForge::V3::Release.should_not_receive(:request)
+      expect(mod.current_release.version).to_not be nil
+    end
+
+    it 'transparently makes API calls for other attributes' do
+      stub_api_for(PuppetForge::V3::Release) do |api|
+        api.get(mod.current_release.uri) do
+          load_fixture('/v3/releases/puppetlabs-apache-0.0.1')
+        end
+      end
+
+      mod.attributes[:current_release].delete :created_at
+      expect(mod.current_release.created_at).to_not be nil
+    end
+  end
+
+  describe '#releases' do
+    let(:mod) { PuppetForge::V3::Module.find('puppetlabs-apache') }
+
+    before do
+      stub_api_for(PuppetForge::V3::Release) do |api|
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.1')
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.2')
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.3')
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.4')
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.1.1')
+        stub_fixture(api, :get, '/v3/releases?module=puppetlabs-apache')
+      end
+    end
+
+    it 'exposes the related releases as a property' do
+      expect(mod.releases).to be_an Array
+    end
+
+    it 'knows the size of the collection' do
+      expect(mod.releases).to_not be_empty
+    end
+
+    it 'grants access to release attributes without an API call' do
+      PuppetForge::V3::Release.should_not_receive(:request)
+      expect(mod.releases.map(&:version)).to_not include nil
+    end
+
+    it 'transparently makes API calls for other attributes' do
+      versions = %w[ 0.0.1 0.0.2 0.0.3 0.0.4 0.1.1 ]
+      releases = mod.releases.select { |x| versions.include? x.version }
+
+      PuppetForge::V3::Release.should_receive(:request) \
+                        .exactly(5).times \
+                        .and_call_original
+
+      expect(releases.map(&:created_at)).to_not include nil
+    end
+  end
+
+  describe 'instance properies' do
+    let(:mod) { PuppetForge::V3::Module.find('puppetlabs-apache') }
+
+    example 'are easily accessible' do
+      expect(mod.created_at).to_not be nil
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe PuppetForge::V3::Release do
+  before do
+    stub_api_for(PuppetForge::V3::Release) do |api|
+      stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.1')
+      stub_fixture(api, :get, '/v3/releases/absent-apache-0.0.1')
+    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')
+    end
+
+    it 'returns nil for non-existent releases' do
+      expect(missing_release).to be nil
+    end
+  end
+
+  describe '#module' do
+    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+
+    before do
+      stub_api_for(PuppetForge::V3::Module) do |api|
+        stub_fixture(api, :get, '/v3/modules/puppetlabs-apache')
+      end
+    end
+
+    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
+      PuppetForge::V3::Module.should_not_receive(:request)
+      expect(release.module.name).to eql('apache')
+    end
+
+    it 'transparently makes API calls for other attributes' do
+      PuppetForge::V3::Module.should_receive(:request).once.and_call_original
+      expect(release.module.created_at).to_not be nil
+    end
+  end
+
+  describe '#download_url' do
+    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+
+    before do
+      stub_api_for(PuppetForge::V3::Release) do |api|
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.1')
+      end
+    end
+
+    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'
+      expect(release.download_url).to eql(PuppetForge.host + '/v3/files/puppetlabs-apache-0.0.1.tar.gz')
+    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
+
+  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 do
+      stub_api_for(PuppetForge::V3::Release) do |api|
+        stub_fixture(api, :get, '/v3/releases/puppetlabs-apache-0.0.1')
+        stub_fixture(api, :get, '/v3/files/puppetlabs-apache-0.0.1.tar.gz')
+      end
+    end
+
+    it 'downloads the file to the specified location' do
+      expect(File.exist?(tarball)).to be false
+      release.download(tarball)
+      expect(File.exist?(tarball)).to be true
+    end
+  end
+
+  describe '#metadata' do
+    let(:release) { PuppetForge::V3::Release.find('puppetlabs-apache-0.0.1') }
+
+    before do
+      stub_api_for(PuppetForge::V3::Module) do |api|
+        stub_fixture(api, :get, '/v3/modules/puppetlabs-apache')
+      end
+    end
+
+    it 'is lazy and repeatable' do
+      3.times do
+        expect(release.module.releases.last.metadata).to_not be_nil
+      end
+    end
+  end
+
+  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
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe PuppetForge::V3::User do
+  before do
+    stub_api_for(PuppetForge::V3::User) do |api|
+      stub_fixture(api, :get, '/v3/users/puppetlabs')
+      stub_fixture(api, :get, '/v3/users/absent')
+    end
+  end
+
+  describe '::find' do
+    let(:user) { PuppetForge::V3::User.find('puppetlabs') }
+    let(:missing_user) { PuppetForge::V3::User.find('absent') }
+
+    it 'can find users that exist' do
+      user.username.should == 'puppetlabs'
+    end
+
+    it 'returns nil for non-existent users' do
+      missing_user.should be_nil
+    end
+  end
+
+  describe '#modules' do
+    before do
+      stub_api_for(PuppetForge::V3::Module) do |api|
+        stub_fixture(api, :get, '/v3/modules?owner=puppetlabs')
+      end
+    end
+
+    let(:user) { PuppetForge::V3::User.find('puppetlabs') }
+
+    it 'should return a PaginatedCollection' do
+      expect(user.modules).to be_a PuppetForge::V3::Base::PaginatedCollection
+    end
+
+    it 'should only return modules for the current user' do
+      module_owners = user.modules.map(&:owner)
+      expect(module_owners.group_by(&:username).keys).to eql(['puppetlabs'])
+    end
+  end
+
+  describe 'instance properies' do
+    let(:user) { PuppetForge::V3::User.find('puppetlabs') }
+
+    example 'are easily accessible' do
+      expect(user.created_at).to_not be nil
+    end
+  end
+end