cred_hubble 0.0.1.pre → 0.1.0.pre

data/spec/cred_hubble/resources/rsa_credential_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe CredHubble::Resources::RsaCredential do
+  let(:json_response) do
+    '{
+      "id": "15811465-8538-460d-9682-5514d44439fd",
+      "name": "/rsa-key-1",
+      "type": "rsa",
+      "value": {
+        "public_key": "-----BEGIN PUBLIC KEY-----\n... PUBLIC KEY ...\n-----END PUBLIC KEY-----",
+        "private_key": "-----BEGIN RSA PRIVATE KEY-----\n... RSA PRIVATE KEY ...\n-----END RSA PRIVATE KEY-----"
+      },
+      "version_created_at": "1990-05-18T01:01:01Z"
+    }'
+  end
+
+  describe '.from_json' do
+    subject { CredHubble::Resources::RsaCredential }
+
+    context 'when the JSON includes the required attributes' do
+      it 'instantiates a new RsaCredential object' do
+        credential = subject.from_json(json_response)
+
+        expect(credential).to be_a(CredHubble::Resources::RsaCredential)
+        expect(credential.value.public_key)
+          .to eq("-----BEGIN PUBLIC KEY-----\n... PUBLIC KEY ...\n-----END PUBLIC KEY-----")
+        expect(credential.value.private_key)
+          .to eq("-----BEGIN RSA PRIVATE KEY-----\n... RSA PRIVATE KEY ...\n-----END RSA PRIVATE KEY-----")
+      end
+    end
+
+    it_behaves_like 'a Credential resource'
+    it_behaves_like 'a JSON deserializing resource'
+  end
+
+  describe '#type' do
+    it 'returns "rsa"' do
+      subject.type = 'attempting-to-overwrite'
+      expect(subject.type).to eq('rsa')
+    end
+  end
+
+  describe '#to_json' do
+    it_behaves_like 'a JSON serializing resource'
+  end
+end

data/spec/cred_hubble/resources/ssh_credential_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+RSpec.describe CredHubble::Resources::SshCredential do
+  let(:json_response) do
+    '{
+      "id": "15811465-8538-460d-9682-5514d44439fd",
+      "name": "/ssh-key-1",
+      "type": "ssh",
+      "value": {
+        "public_key": "ssh-rsa AAAAB3NzaC1y...",
+        "private_key": "-----BEGIN RSA PRIVATE KEY-----\n... RSA PRIVATE KEY ...\n-----END RSA PRIVATE KEY-----",
+        "public_key_fingerprint": "9db6ee01f7963db4e8c9966f3c425fd3feeadc148f37b428ddce2a458bd50da6"
+      },
+      "version_created_at": "1990-05-16T01:01:01Z"
+    }'
+  end
+
+  describe '.from_json' do
+    subject { CredHubble::Resources::SshCredential }
+
+    context 'when the JSON includes the required attributes' do
+      it 'instantiates a new SshCredential object' do
+        credential = subject.from_json(json_response)
+
+        expect(credential).to be_a(CredHubble::Resources::SshCredential)
+        expect(credential.value.public_key).to eq('ssh-rsa AAAAB3NzaC1y...')
+        expect(credential.value.private_key)
+          .to eq("-----BEGIN RSA PRIVATE KEY-----\n... RSA PRIVATE KEY ...\n-----END RSA PRIVATE KEY-----")
+        expect(credential.value.public_key_fingerprint)
+          .to eq('9db6ee01f7963db4e8c9966f3c425fd3feeadc148f37b428ddce2a458bd50da6')
+      end
+    end
+
+    it_behaves_like 'a Credential resource'
+    it_behaves_like 'a JSON deserializing resource'
+  end
+
+  describe '#type' do
+    it 'returns "ssh"' do
+      subject.type = 'attempting-to-overwrite'
+      expect(subject.type).to eq('ssh')
+    end
+  end
+
+  describe '#to_json' do
+    it_behaves_like 'a JSON serializing resource'
+  end
+
+  describe '#attributes_for_put' do
+    context 'when value is present' do
+      it 'does not include the public_key_fingerprint' do
+        credential = CredHubble::Resources::SshCredential.from_json(json_response)
+        expect(credential.attributes_for_put[:value]).to_not have_key(:public_key_fingerprint)
+      end
+    end
+
+    context 'when value is not present' do
+      let(:json_response) do
+        '{
+          "id": "15811465-8538-460d-9682-5514d44439fd",
+          "name": "/root-ssh-user",
+          "type": "ssh",
+          "version_created_at": "1990-03-29T01:07:01Z"
+        }'
+      end
+
+      it 'does not include a value' do
+        credential = CredHubble::Resources::SshCredential.from_json(json_response)
+        expect(credential.attributes_for_put[:value]).to be_nil
+      end
+    end
+  end
+end

data/spec/cred_hubble/resources/user_credential_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+RSpec.describe CredHubble::Resources::UserCredential do
+  let(:json_response) do
+    '{
+      "id": "15811465-8538-460d-9682-5514d44439fd",
+      "name": "/admin-user",
+      "type": "user",
+      "value": {
+        "username": "admin",
+        "password": "2582aaf15ec84e3fa3ba682152663a52",
+        "password_hash": "8efbef4cec28f228fa948daaf4893ac3638fbae81358ff9020be1d7a9a509fc6:1234"
+      },
+      "version_created_at": "1990-05-18T01:01:01Z"
+    }'
+  end
+
+  describe '.from_json' do
+    subject { CredHubble::Resources::UserCredential }
+
+    context 'when the JSON includes the required attributes' do
+      it 'instantiates a new UserCredential object' do
+        credential = subject.from_json(json_response)
+
+        expect(credential).to be_a(CredHubble::Resources::UserCredential)
+        expect(credential.value.username).to eq('admin')
+        expect(credential.value.password).to eq('2582aaf15ec84e3fa3ba682152663a52')
+        expect(credential.value.password_hash)
+          .to eq('8efbef4cec28f228fa948daaf4893ac3638fbae81358ff9020be1d7a9a509fc6:1234')
+      end
+    end
+
+    it_behaves_like 'a Credential resource'
+    it_behaves_like 'a JSON deserializing resource'
+  end
+
+  describe '#type' do
+    it 'returns "user"' do
+      subject.type = 'attempting-to-overwrite'
+      expect(subject.type).to eq('user')
+    end
+  end
+
+  describe '#to_json' do
+    it_behaves_like 'a JSON serializing resource'
+  end
+
+  describe '#attributes_for_put' do
+    context 'when value is present' do
+      it 'does not include the password_hash' do
+        credential = CredHubble::Resources::UserCredential.from_json(json_response)
+        expect(credential.attributes_for_put[:value]).to_not have_key(:password_hash)
+      end
+    end
+
+    context 'when value is not present' do
+      let(:json_response) do
+        '{
+          "id": "15811465-8538-460d-9682-5514d44439fd",
+          "name": "/admin-user",
+          "type": "user",
+          "version_created_at": "1990-05-18T01:01:01Z"
+        }'
+      end
+
+      it 'does not a value' do
+        credential = CredHubble::Resources::UserCredential.from_json(json_response)
+        expect(credential.attributes_for_put[:value]).to be_nil
+      end
+    end
+  end
+end

data/spec/cred_hubble/resources/value_credential_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe CredHubble::Resources::ValueCredential do
+  subject { CredHubble::Resources::ValueCredential.new }
+
+  let(:json_response) do
+    '{
+      "id": "cdbb371a-cc03-4a6f-aa21-c6461d66ed96",
+      "name": "/the-grid",
+      "type": "value",
+      "value": "biodigital-jazz-man",
+      "version_created_at": "1985-01-01T01:01:01Z"
+    }'
+  end
+
+  describe '.from_json' do
+    subject { CredHubble::Resources::ValueCredential }
+
+    context 'when the JSON includes the required attributes' do
+      it 'instantiates a new ValueCredential object' do
+        credential = subject.from_json(json_response)
+
+        expect(credential).to be_a(CredHubble::Resources::ValueCredential)
+        expect(credential.value).to eq('biodigital-jazz-man')
+      end
+    end
+
+    it_behaves_like 'a Credential resource'
+    it_behaves_like 'a JSON deserializing resource'
+  end
+
+  describe '#type' do
+    it 'returns "value"' do
+      subject.type = 'attempting-to-overwrite'
+      expect(subject.type).to eq('value')
+    end
+  end
+
+  describe '#to_json' do
+    it_behaves_like 'a JSON serializing resource'
+  end
+end

data/spec/support/shared_examples/resource_examples.rb

@@ -13,3 +13,52 @@ RSpec.shared_examples 'a JSON deserializing resource' do
     end
   end
 end
+
+RSpec.shared_examples 'a JSON serializing resource' do
+  describe '#to_json' do
+    it 'correctly serializes complex attributes as JSON' do
+      expect(JSON.parse(described_class.from_json(json_response).to_json)).to eq(JSON.parse(json_response))
+    end
+  end
+end
+
+RSpec.shared_examples 'a Credential resource' do
+  describe '.from_json' do
+    context 'when the JSON includes the required attributes' do
+      let(:json_response) do
+        '{
+          "id": "cdbb371a-cc03-4a6f-aa21-c6461d66ed96",
+          "name": "/the-grid",
+          "type": "value",
+          "version_created_at": "1985-01-01T01:01:01Z"
+        }'
+      end
+
+      it 'instantiates a new Credential object with the correct values' do
+        credential = subject.from_json(json_response)
+
+        expect(credential).to be_a(CredHubble::Resources::Credential)
+        expect(credential.id).to eq('cdbb371a-cc03-4a6f-aa21-c6461d66ed96')
+        expect(credential.name).to eq('/the-grid')
+        expect(credential.version_created_at).to eq('1985-01-01T01:01:01Z')
+      end
+    end
+
+    describe '#attributes_for_put' do
+      let(:json_response) do
+        '{
+          "id": "cdbb371a-cc03-4a6f-aa21-c6461d66ed96",
+          "name": "/the-grid",
+          "type": "value",
+          "version_created_at": "1985-01-01T01:01:01Z"
+        }'
+      end
+
+      it 'returns only the attributes that can be updated with CredHub' do
+        credential = subject.from_json(json_response)
+        expect(credential.attributes_for_put.keys).to_not include :id
+        expect(credential.attributes_for_put.keys).to_not include :version_created_at
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cred_hubble
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Tim Downey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,15 +159,41 @@ files:
 - lib/cred_hubble/exceptions/error.rb
 - lib/cred_hubble/http/client.rb
 - lib/cred_hubble/http/errors.rb
-- lib/cred_hubble/resources/base_resource.rb
+- lib/cred_hubble/resources/certificate_credential.rb
+- lib/cred_hubble/resources/credential.rb
+- lib/cred_hubble/resources/credential_collection.rb
+- lib/cred_hubble/resources/credential_factory.rb
 - lib/cred_hubble/resources/health.rb
 - lib/cred_hubble/resources/immutable_resource.rb
 - lib/cred_hubble/resources/info.rb
+- lib/cred_hubble/resources/json_credential.rb
+- lib/cred_hubble/resources/password_credential.rb
+- lib/cred_hubble/resources/permission.rb
+- lib/cred_hubble/resources/permission_collection.rb
+- lib/cred_hubble/resources/resource.rb
+- lib/cred_hubble/resources/resources.rb
+- lib/cred_hubble/resources/rest_resource.rb
+- lib/cred_hubble/resources/rsa_credential.rb
+- lib/cred_hubble/resources/ssh_credential.rb
+- lib/cred_hubble/resources/user_credential.rb
+- lib/cred_hubble/resources/value_credential.rb
 - lib/cred_hubble/version.rb
 - spec/cred_hubble/client_spec.rb
 - spec/cred_hubble/http/client_spec.rb
+- spec/cred_hubble/resources/certificate_credential_spec.rb
+- spec/cred_hubble/resources/credential_collection_spec.rb
+- spec/cred_hubble/resources/credential_factory_spec.rb
+- spec/cred_hubble/resources/credential_spec.rb
 - spec/cred_hubble/resources/health_spec.rb
 - spec/cred_hubble/resources/info_spec.rb
+- spec/cred_hubble/resources/json_credential_spec.rb
+- spec/cred_hubble/resources/password_credential_spec.rb
+- spec/cred_hubble/resources/permission_collection_spec.rb
+- spec/cred_hubble/resources/permission_spec.rb
+- spec/cred_hubble/resources/rsa_credential_spec.rb
+- spec/cred_hubble/resources/ssh_credential_spec.rb
+- spec/cred_hubble/resources/user_credential_spec.rb
+- spec/cred_hubble/resources/value_credential_spec.rb
 - spec/cred_hubble_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/resource_examples.rb
@@ -167,9 +207,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -185,8 +225,20 @@ summary: Unofficial Ruby Client for interacting with the Cloud Foundry CredHub c
 test_files:
 - spec/cred_hubble/client_spec.rb
 - spec/cred_hubble/http/client_spec.rb
+- spec/cred_hubble/resources/certificate_credential_spec.rb
+- spec/cred_hubble/resources/credential_collection_spec.rb
+- spec/cred_hubble/resources/credential_factory_spec.rb
+- spec/cred_hubble/resources/credential_spec.rb
 - spec/cred_hubble/resources/health_spec.rb
 - spec/cred_hubble/resources/info_spec.rb
+- spec/cred_hubble/resources/json_credential_spec.rb
+- spec/cred_hubble/resources/password_credential_spec.rb
+- spec/cred_hubble/resources/permission_collection_spec.rb
+- spec/cred_hubble/resources/permission_spec.rb
+- spec/cred_hubble/resources/rsa_credential_spec.rb
+- spec/cred_hubble/resources/ssh_credential_spec.rb
+- spec/cred_hubble/resources/user_credential_spec.rb
+- spec/cred_hubble/resources/value_credential_spec.rb
 - spec/cred_hubble_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/resource_examples.rb