sis_ruby 1.0.0

data/spec-writing/hiera.json

@@ -0,0 +1,58 @@
+{
+  "type": "hiera",
+  "id_field": "name",
+  "valid_items": [
+    {
+      "name": "hiera1",
+      "owner": "hiera_owner",
+      "hieradata": {
+        "key1": "data1",
+        "key2": "data2"
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "hiera2",
+      "owner": "hiera_owner",
+      "hieradata": {
+        "key3": "data1",
+        "key4": "data2"
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    }
+  ],
+  "invalid_items": [
+    {
+      "name": "hiera1",
+      "owner": "hiera_owner",
+      "hieradata": {
+        "key3": "data1",
+        "key4": "data2"
+      }
+    },
+    {
+      "name": "hiera3",
+      "hieradata": {
+        "key3": "data1",
+        "key4": "data2"
+      }
+    },
+    {
+      "name": "hiera_no_data"
+    },
+    {
+      "name": "hiera_empty_data",
+      "hieradata": {
+      }
+    },
+    {
+      "hieradata": {
+        "no": "name"
+      }
+    }
+  ]
+}

data/spec-writing/hook.json

@@ -0,0 +1,64 @@
+{
+  "type": "hooks",
+  "id_field": "name",
+  "valid_items": [
+    {
+      "name": "hook1",
+      "entity_type": "some_entity",
+      "owner": "hook_owner",
+      "target": {
+        "action": "POST",
+        "url": "http=>//my.hook.endpoint/endpoint"
+      },
+      "events": [
+        "update",
+        "insert"
+      ],
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "hook2",
+      "entity_type": "some_other_entity",
+      "owner": "hook_owner",
+      "target": {
+        "action": "PUT",
+        "url": "http=>//my.hook.endpoint/endpoint"
+      },
+      "events": [
+        "insert"
+      ],
+      "_sis": {
+        "owner": "test"
+      }
+    }
+  ],
+  "invalid_items": [
+    {
+      "name": "hook3",
+      "entity_type": "random",
+      "events": [
+        "update"
+      ],
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "hook2",
+      "entity_type": "some_other_entity",
+      "owner": "hook_owner",
+      "target": {
+        "action": "PUT",
+        "url": "http=>//my.hook.endpoint/endpoint"
+      },
+      "events": [
+        "insert"
+      ],
+      "_sis": {
+        "owner": "test"
+      }
+    }
+  ]
+}

data/spec-writing/schema.json

@@ -0,0 +1,131 @@
+{
+  "type": "schemas",
+  "id_field": "name",
+  "valid_items": [
+    {
+      "name": "schema1",
+      "owner": "schema_owner",
+      "definition": {
+        "requiredField": {
+          "type": "String",
+          "required": true
+        },
+        "uniqueNumberField": {
+          "type": "Number",
+          "unique": true
+        },
+        "stringField": "String",
+        "numberField": "Number",
+        "nestedDocument": {
+          "nestedString": "String",
+          "nestedBoolean": "Boolean"
+        },
+        "anythingField": {
+          "type": "Mixed"
+        }
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "schema2",
+      "owner": "schema_owner",
+      "definition": {
+        "stringField": {
+          "type": "String",
+          "required": true
+        },
+        "numberField": "Number"
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    }
+  ],
+  "invalid_items": [
+    {
+      "name": "schema1",
+      "owner": "schema_owner",
+      "definition": {
+        "requiredField": {
+          "type": "String",
+          "required": true
+        },
+        "uniqueNumberField": {
+          "type": "Number",
+          "unique": true
+        },
+        "stringField": "String",
+        "numberField": "Number",
+        "nestedDocument": {
+          "nestedString": "String",
+          "nestedBoolean": "Boolean"
+        },
+        "anythingField": {
+          "type": "Mixed"
+        }
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "no_owner_schema",
+      "definition": {
+        "requiredField": {
+          "type": "String",
+          "required": true
+        },
+        "uniqueNumberField": {
+          "type": "Number",
+          "unique": true
+        },
+        "stringField": "String",
+        "numberField": "Number",
+        "nestedDocument": {
+          "nestedString": "String",
+          "nestedBoolean": "Boolean"
+        },
+        "anythingField": {
+          "type": "Mixed"
+        }
+      }
+    },
+    {
+      "owner": "no_name_schema",
+      "definition": {
+        "requiredField": {
+          "type": "String",
+          "required": true
+        },
+        "uniqueNumberField": {
+          "type": "Number",
+          "unique": true
+        },
+        "stringField": "String",
+        "numberField": "Number",
+        "nestedDocument": {
+          "nestedString": "String",
+          "nestedBoolean": "Boolean"
+        },
+        "anythingField": {
+          "type": "Mixed"
+        }
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    },
+    {
+      "name": "bad_definition_schema",
+      "owner": "owner",
+      "definition": {
+        "whats_up": "bad_type"
+      },
+      "_sis": {
+        "owner": "test"
+      }
+    }
+  ]
+}

data/spec-writing/write_spec.rb

@@ -0,0 +1,105 @@
+require 'ostruct'
+require 'rspec'
+require_relative '../lib/sis_ruby/client'
+
+# TODO Add tests for invalid items
+
+TEST_SERVER_URL = 'http://localhost:3000'
+
+def describe_test(test_name, source_data)
+
+  # Note that although real world servers should use https,
+  # this server only works with http when installed and configured
+  # with the instructions at https://github.com/sis-cmdb/sis-api
+
+  client = SisRuby::Client.new(TEST_SERVER_URL)
+  data = OpenStruct.new(source_data)
+  id_field = data.id_field
+  endpoint = data.entity_type ? client.entities(data.entity_type) : client.send(data.type)
+
+  describe test_name do
+
+    before(:all) do
+      client.authenticate('test', 'abc123')
+      if data.required_schema
+        client.schemas.create(data.required_schema)
+      end
+    end
+
+    if data.required_schema
+      after(:all) do
+        client.schemas.delete(data.required_schema)
+      end
+    end
+
+    valid_items = data.valid_items || []
+    valid_items.each_with_index do |item, index|
+
+      it "should create, get, list, and delete valid item #{index}" do
+
+        # Test creation ................................................
+        result = endpoint.create(item)
+        expect(result).to be, 'Result returned by create was nil.'
+        id = result[id_field]
+        name = result['name']
+
+        expect(id).to be, 'Id on create was nil, or record not created.'
+
+        # Test retrieval with get.......................................
+        result = endpoint.get(id)
+
+        if data.type == 'hiera' # special type of data, extract inner data structure for test
+          expected = { id => item['hieradata'] }
+          expect(result).to eq(expected)
+        else
+          actual_id = result[id_field]
+          expect(actual_id).to eq(id), "Get error; expected id '#{id}' but got '#{actual_id}'"
+        end
+
+        # Test retrieval with list.......................................
+        expect(endpoint.list.any?).to eq(true), 'List returned no records.'
+
+        # Test deletion - result will be the deleted record..............
+        result = endpoint.delete(id)
+        actual_name = result['name']
+        actual_id = result[id_field]
+        expect(actual_id).to eq(id), "After delete, expected id '#{id}' but got '#{actual_id}'"
+        expect(actual_name).to eq(name), "After delete, expected name '#{name}' but got '#{actual_name}'"
+
+        # Ensure that the get fails since we just deleted the record
+        expect { endpoint.get(id) }.to raise_error(SisRuby::BadResponseError)
+      end
+    end
+  end
+end
+
+
+# Generates test expectations for the specified data type.
+# Assumes that:
+#
+# 1) the file containing the specified type of data contains JSON text
+# 2) the file is in the same directory as this test file
+# 3) the file is named: type + '.json'
+def process_test_data(type)
+  filespec = File.join(File.dirname(__FILE__), type + '.json')
+  data = JSON.parse(File.read(filespec))
+  describe_test(type, data)
+end
+
+
+describe 'Authentication Error Handling' do
+  it 'should raise a Client::AuthenticationError with bad credentials' do
+    client = SisRuby::Client.new(TEST_SERVER_URL)
+    expect { client.authenticate('test', 'bad-password') }.to \
+        raise_error(SisRuby::Client::AuthenticationError, /HTTP\/1.1 401/)
+  end
+end
+
+
+def main
+  %w(entity hiera hook schema).each { |type| process_test_data(type) }
+end
+
+
+main
+

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: sis_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Keith Bennett
+- Neel Goyal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trick_bag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client for SIS web service (https://github.com/sis-cmdb/sis-api)
+email:
+- keithrbennett@gmail.com
+- sis-dev@verisign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- RELEASE_NOTES.md
+- Rakefile
+- lib/sis_ruby.rb
+- lib/sis_ruby/client.rb
+- lib/sis_ruby/common.rb
+- lib/sis_ruby/endpoint.rb
+- lib/sis_ruby/exceptions/bad_response_error.rb
+- lib/sis_ruby/exceptions/missing_id_error.rb
+- lib/sis_ruby/get_helper.rb
+- lib/sis_ruby/hash_builder.rb
+- lib/sis_ruby/params.rb
+- lib/sis_ruby/result_enumerable.rb
+- lib/sis_ruby/version.rb
+- samples/sample-1.rb
+- samples/sample-2.rb
+- sis_ruby.gemspec
+- spec-writing/entity.json
+- spec-writing/hiera.json
+- spec-writing/hook.json
+- spec-writing/schema.json
+- spec-writing/write_spec.rb
+- spec/client_spec.rb
+- spec/endpoint_spec.rb
+- spec/hash_builder_spec.rb
+- spec/params_spec.rb
+- spec/setup/drop-db.js
+- spec/setup/recreate-db.sh
+- spec/setup/test-user.json
+- spec/spec_helper.rb
+homepage: https://github.com/keithrbennett/sis_ruby
+licenses:
+- BSD 3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: SIS Ruby Client
+test_files: []